invoices - npm Package Compare versions

Comparing version 1.1.7 to 1.2.0

bolt11/index.js

@@ -0,1 +1,3 @@
+const byteDecodeRequest = require('./byte_decode_request');
+const byteEncodeRequest = require('./byte_encode_request');
 const createSignedRequest = require('./create_signed_request');
@@ -6,2 +8,4 @@ const createUnsignedRequest = require('./create_unsigned_request');
 module.exports = {
+  byteDecodeRequest,
+  byteEncodeRequest,
   createSignedRequest,
@@ -8,0 +12,0 @@ createUnsignedRequest,

CHANGELOG.md

 # Versions
 
+## 1.2.0
+
+- `byteDecodeRequest`: Add method to derive a payment request from request bytes
+- `byteEncodeRequest`: Add method to derive bytes from a payment request
+
 ## 1.1.7
@@ -4,0 +9,0 @@

index.js

@@ -0,1 +1,3 @@
+const {byteDecodeRequest} = require('./bolt11');
+const {byteEncodeRequest} = require('./bolt11');
 const {createSignedRequest} = require('./bolt11');
@@ -6,2 +8,4 @@ const {createUnsignedRequest} = require('./bolt11');
 module.exports = {
+  byteDecodeRequest,
+  byteEncodeRequest,
   createSignedRequest,
@@ -8,0 +12,0 @@ createUnsignedRequest,

package.json

@@ -16,3 +16,3 @@ {
   "devDependencies": {
-    "tap": "15.0.1"
+    "tap": "15.0.2"
   },
@@ -39,3 +39,3 @@ "engines": {
   },
-  "version": "1.1.7"
+  "version": "1.2.0"
 }

README.md

@@ -8,2 +8,62 @@ # Invoices
 
+### byteDecodeRequest
+
+Derive a payment request from request data.
+
+    {
+      encoded: <Payment Request Details Hex String>
+      mtokens: <Millitokens Number String>
+      network: <Network Name String>
+    }
+
+    @throws
+    <Error>
+
+    @returns
+    {
+      request: <BOLT 11 Encoded Payment Request String>
+    }
+
+Example:
+
+```node
+const {byteDecodeRequest} = require('invoices');
+
+// Get a BOLT 11 payment request for this invoice data
+const {request} = byteDecodeRequest({
+  encoded: paymentRequestDetailsHexString,
+  mtokens: '0',
+  network: 'bitcoin',
+});
+```
+
+### byteEncodeRequest
+
+Derive bytes for payment request details
+
+    {
+      request: <BOLT 11 Encoded Payment Request String>
+    }
+
+    @throws
+    <Error>
+
+    @returns
+    {
+      encoded: <Payment Request Details Hex String>
+      mtokens: <Millitokens Number String>
+      network: <Network Name String>
+    }
+
+Example:
+
+```node
+const {byteEncodeRequest} = require('invoices');
+
+// Get the bytes for a payment request
+const {encoded, mtokens, network} = byteEncodeRequest({
+  request: bolt11EncodedPaymentRequestString,
+});
+```
+
 ### createSignedRequest
@@ -10,0 +70,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

92531

increased by11.23%

Number of package files

53

increased by10.42%

Lines of code

2377

increased by10.87%

Number of lines in readme file

201

increased by42.55%

No dependency changes