Skip to content

Latest commit

 

History

History

paymentrequest

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
tests
tests
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsup.config.ts
tsup.config.ts
 
 

README.md

Monero Payment Request Protocol

An easy way to create/decode Monero Payment Requests using JavaScript.

Installation

$ npm install -S @monerorequest-js/paymentrequest

Usage

Encoding Monero Payment Requests

import {MoneroPaymentRequestEncoder, MoneroPaymentRequestPayload} from "@monerorequest-js/paymentrequest";

const data: MoneroPaymentRequestPayload = {
  "amount": "19.99",
  "change_indicator_url": "www.example.com/api/monero-request",
  "currency": "USD",
  "custom_label": "My Subscription",
  "days_per_billing_cycle": 30,
  "number_of_payments": 0,
  "payment_id": "9fc88080d1d5dc09",
  "sellers_wallet": "4At3X5rvVypTofgmueN9s9QtrzdRe5BueFrskAZi17BoYbhzysozzoMFB6zWnTKdGC6AxEAbEE5czFR3hbEEJbsm4hCeX2S",
  "start_date": "2023-04-26T13:45:33Z"
}

console.log(MoneroPaymentRequestEncoder.fromJson(data, 1));
// monero-request:1:H8KLCAAAAAAAAgMtT8OZTsODMBDDvBXDpMOnHjlLwpPCt8K0wrRIwqAiw5EWKH3CsRx7w5tYw7gIPmgTw4TCv8OjIMKedndmdnbDpxsRwqnCvXLCqERxMSkKNELCtCHDqgzCmCvDhilxw5pgb0TCoC/Cl8OLBMKuRMK2AiZUw4spacO5VGoFRsKPDXx6wrBuw5jDtcOGwoDCol3DkMK/w6zDrsO+AMOrwrTDhMKCw5QwwphswrrCm8Kdwq8tNcK8dVzCqyBgwqTCs8K4BcKDay4EV2dMOyoAwpVpNELDisOLOjDDusKEW8OSSVDDjsKiMsOAw78Dw6YsOBYnOsKfR8OzwojDhSxnNBoCWBACwozDhRcSw6rCkCzCq1x6w4jDjcOXa8OXw67DtcOpLD08FcK2eHbCpmdbw4gXHsOWw4Z+VEcew58uw7R7w53DtMKdw5V9wq83w6vDhcKsf1PDu0d2wr/CnFXDl1VVwq9WOcOtw5fDm8K0CcOdQ21lw5Ysw6HCkMOswobCk8KOGMKHGXHDoXPClERJOsKOwrJxMsObw4dpwpnDpWXCmh7DkcOPL8Oyw6lYwolqAQAA

Decoding Monero Payment Requests

import {MoneroPaymentRequestDecoder,} from "@monerorequest-js/paymentrequest";

console.log(MoneroPaymentRequestDecoder.fromCode("monero-request:1:H8KLCAAAAAAAAgMtT8OZTsODMBDDvBXDpMOnHjlLwpPCt8K0wrRIwqAiw5EWKH3CsRx7w5tYw7gIPmgTw4TCv8OjIMKedndmdnbDpxsRwqnCvXLCqERxMSkKNELCtCHDqgzCmCvDhilxw5pgb0TCoC/Cl8OLBMKuRMK2AiZUw4spacO5VGoFRsKPDXx6wrBuw5jDtcOGwoDCol3DkMK/w6zDrsO+AMOrwrTDhMKCw5QwwphswrrCm8Kdwq8tNcK8dVzCqyBgwqTCs8K4BcKDay4EV2dMOyoAwpVpNELDisOLOjDDusKEW8OSSVDDjsKiMsOAw78Dw6YsOBYnOsKfR8OzwojDhSxnNBoCWBACwozDhRcSw6rCkCzCq1x6w4jDjcOXa8OXw67DtcOpLD08FcK2eHbCpmdbw4gXHsOWw4Z+VEcew58uw7R7w53DtMKdw5V9wq83w6vDhcKsf1PDu0d2wr/CnFXDl1VVwq9WOcOtw5fDm8K0CcOdQ21lw5Ysw6HCkMOswobCk8KOGMKHGXHDoXPClERJOsKOwrJxMsObw4dpwpnDpWXCmh7DkcOPL8Oyw6lYwolqAQAA"));

/*
{
  "amount": "19.99",
  "change_indicator_url": "www.example.com/api/monero-request",
  "currency": "USD",
  "custom_label": "My Subscription",
  "days_per_billing_cycle": 30,
  "number_of_payments": 0,
  "payment_id": "9fc88080d1d5dc09",
  "sellers_wallet": "4At3X5rvVypTofgmueN9s9QtrzdRe5BueFrskAZi17BoYbhzysozzoMFB6zWnTKdGC6AxEAbEE5czFR3hbEEJbsm4hCeX2S",
  "start_date": "2023-04-26T13:45:33Z"
}
*/

Validations

Validations can be checked using MoneroPaymentRequestValidator static methods.

Simple API documentation

A simple documentation generated by typedocs can be found here

More protocol information

More information about the protocol can be found at https://github.com/lukeprofits/Monero_Payment_Request_Standard