lightning 9.9.0 → 9.10.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## 9.9.0
+## 9.10.0
+
+- `createInvoice`, `createHodlInvoice`: Add `routes` to customize the hop hints
+
+## 9.9.1
 
 - `openChannel`: Add `is_trusted_funding` to support skipping confirmation wait
 

package/README.md

@@ -22,6 +22,8 @@ Methods for working with the Lightning Network
     https://github.com/lnmarkets/umbrel
 - [LNPingBot](https://github.com/swissrouting/lnpingbot) -
     https://github.com/swissrouting/lnpingbot
+- [MutinyWallet faucet](https://github.com/MutinyWallet/mutinynet-faucet) -
+    https://www.mutinywallet.com/
 - [p2plnbot](https://telegram.me/lnp2pbot) - https://github.com/grunch/p2plnbot
 - [rekr](https://rekr.app/) - https://github.com/ryan-lingle/rekr
 - [stackernews](https://stacker.news/) -

package/lnd_methods/info/get_route_to_destination.js

@@ -221,7 +221,7 @@ module.exports = (args, cbk) => {
         }
 
         const hints = args.routes.map(route => {
-          return {hop_hints: routeHintFromRoute({route}).hops}
+          return {hop_hints: routeHintFromRoute({route}).hops};
         });
 
         return cbk(null, hints);

package/lnd_methods/invoices/create_hodl_invoice.js

@@ -7,6 +7,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {createChainAddress} = require('./../address');
 const {isLnd} = require('./../../lnd_requests');
+const {routeHintFromRoute} = require('./../../lnd_requests');
 
 const hexAsBuffer = hex => !!hex ? Buffer.from(hex, 'hex') : undefined;
 const {isArray} = Array;
@@ -41,6 +42,13 @@ const type = 'invoices';
     [is_including_private_channels]: <Invoice Includes Private Channels Bool>
     lnd: <Authenticated LND API Object>
     [mtokens]: <Millitokens String>
+    [routes]: [[{
+      [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
+      [channel]: <Standard Format Channel Id String>
+      [cltv_delta]: <CLTV Blocks Delta Number>
+      [fee_rate]: <Fee Rate In Millitokens Per Million Number>
+      public_key: <Forward Edge Public Key Hex String>
+    }]]
     [tokens]: <Tokens Number>
   }
 
@@ -65,6 +73,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedInvoicesLndToCreateHodlInvoice']);
         }
 
+        if (!!args.routes && !isArray(args.routes)) {
+          return cbk([400, 'ExpectedArrayOfHopHintPathsForRoutes']);
+        }
+
         return cbk();
       },
 
@@ -80,6 +92,20 @@ module.exports = (args, cbk) => {
         return createChainAddress({format, lnd: args.lnd}, cbk);
       }],
 
+      // Determine the route hints
+      hints: ['validate', ({}, cbk) => {
+        // Exit early when there are no route hints for the invoice
+        if (!args.routes) {
+          return cbk();
+        }
+
+        const hints = args.routes.map(route => {
+          return {hop_hints: routeHintFromRoute({route}).hops};
+        });
+
+        return cbk(null, hints);
+      }],
+
       // Generate id if needed
       invoiceId: ['validate', ({}, cbk) => {
         if (!!args.id) {
@@ -97,8 +123,9 @@ module.exports = (args, cbk) => {
       // Add invoice
       addInvoice: [
         'addAddress',
+        'hints',
         'invoiceId',
-        ({addAddress, invoiceId}, cbk) =>
+        ({addAddress, hints, invoiceId}, cbk) =>
       {
         const fallbackAddress = !addAddress ? undefined : addAddress.address;
         const createdAt = new Date();
@@ -117,6 +144,7 @@ module.exports = (args, cbk) => {
           hash: Buffer.from(invoiceId.id, 'hex'),
           memo: args.description,
           private: !!args.is_including_private_channels,
+          route_hints: hints || undefined,
           value: args.tokens || undefined,
           value_msat: args.mtokens || undefined,
         },

package/lnd_methods/invoices/create_invoice.js

@@ -6,6 +6,7 @@ const {createChainAddress} = require('./../address');
 const getInvoice = require('./get_invoice');
 const {isLnd} = require('./../../lnd_requests');
 const {mtokensAmount} = require('./../../bolt00');
+const {routeHintFromRoute} = require('./../../lnd_requests');
 
 const defaultExpirySec = 60 * 60 * 3;
 const hexAsBuffer = hex => !!hex ? Buffer.from(hex, 'hex') : undefined;
@@ -36,6 +37,13 @@ const type = 'default';
     lnd: <Authenticated LND API Object>
     [secret]: <Payment Preimage Hex String>
     [mtokens]: <Millitokens String>
+    [routes]: [[{
+      [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
+      [channel]: <Standard Format Channel Id String>
+      [cltv_delta]: <CLTV Blocks Delta Number>
+      [fee_rate]: <Fee Rate In Millitokens Per Million Number>
+      public_key: <Forward Edge Public Key Hex String>
+    }]]
     [tokens]: <Tokens Number>
   }
 
@@ -86,6 +94,10 @@ module.exports = (args, cbk) => {
           }
         }
 
+        if (!!args.routes && !isArray(args.routes)) {
+          return cbk([400, 'ExpectedArrayOfHopHintPathsForRoutes']);
+        }
+
         return cbk();
       },
 
@@ -101,6 +113,20 @@ module.exports = (args, cbk) => {
         return createChainAddress({format, lnd: args.lnd}, cbk);
       }],
 
+      // Determine the route hints
+      hints: ['validate', ({}, cbk) => {
+        // Exit early when there are no route hints for the invoice
+        if (!args.routes) {
+          return cbk();
+        }
+
+        const hints = args.routes.map(route => {
+          return {hop_hints: routeHintFromRoute({route}).hops};
+        });
+
+        return cbk(null, hints);
+      }],
+
       // Determine the value of the invoice
       mtokens: ['validate', ({}, cbk) => {
         // Exit early when there are no mtokens
@@ -119,9 +145,10 @@ module.exports = (args, cbk) => {
       // Add invoice
       addInvoice: [
         'addAddress',
+        'hints',
         'mtokens',
         'preimage',
-        ({addAddress, mtokens, preimage}, cbk) =>
+        ({addAddress, hints, mtokens, preimage}, cbk) =>
       {
         const fallbackAddress = !addAddress ? String() : addAddress.address;
         const createdAt = new Date();
@@ -137,6 +164,7 @@ module.exports = (args, cbk) => {
           memo: args.description,
           private: !!args.is_including_private_channels,
           r_preimage: preimage || undefined,
+          route_hints: hints || undefined,
           value_msat: mtokens,
         },
         (err, response) => {

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.18",
+    "@grpc/grpc-js": "1.8.21",
     "@grpc/proto-loader": "0.7.8",
     "@types/express": "4.17.17",
-    "@types/node": "20.4.2",
+    "@types/node": "20.4.5",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.5",
     "async": "3.2.4",
@@ -20,13 +20,13 @@
     "body-parser": "1.20.2",
     "bolt07": "1.8.4",
     "bolt09": "1.0.0",
-    "cbor": "9.0.0",
+    "cbor": "9.0.1",
     "ecpair": "2.1.0",
     "express": "4.18.2",
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.0.0"
+    "type-fest": "4.1.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -58,5 +58,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.9.0"
+  "version": "9.10.0"
 }