lightning 5.5.0 → 5.6.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.6.0
+
+- `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
+
 ## 5.5.0
 
 - `partiallySignPsbt`: Add method to partially sign a PSBT

package/lnd_methods/offchain/pay_via_routes.d.ts

@@ -27,6 +27,12 @@ export type PayViaRoutesArgs = AuthenticatedLightningArgs<{
       forward: number;
       /** Forward Millitokens */
       forward_mtokens: string;
+      messages?: {
+        /** Message Type number */
+        type: string;
+        /** Message Raw Value Hex Encoded */
+        value: string;
+      }[];
       /** Public Key Hex */
       public_key?: string;
       /** Timeout Block Height */

package/lnd_methods/offchain/pay_via_routes.js

@@ -29,6 +29,10 @@ const notFound = -1;
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         [public_key]: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_methods/offchain/subscribe_to_pay_via_routes.js

@@ -43,6 +43,10 @@ const unknownWireError = 'unknown wire error';
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         public_key: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_requests/rpc_hop_from_hop.js

@@ -1,5 +1,6 @@
 const {chanNumber} = require('bolt07');
 
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const isNumber = n => !isNaN(n);
 const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
 
@@ -12,6 +13,10 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     fee_mtokens: <Fee Millitokens String>
     forward: <Forward Tokens Number>
     forward_mtokens: <Forward Millitokens String>
+    [messages]: [{
+      type: <Message Type Number String>
+      value: <Message Raw Value Hex Encoded String>
+    }]
     [public_key]: <Forward Edge Public Key Hex String>
     timeout: <Timeout Block Height Number>
   }
@@ -25,10 +30,12 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     amt_to_forward_msat: <Millitokens to Forward String>
     chan_id: <Numeric Format Channel Id String>
     chan_capacity: <Channel Capacity Number>
+    [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
     expiry: <Timeout Chain Height Number>
     fee: <Fee in Tokens Number>
     fee_msat: <Fee in Millitokens String>
     [pub_key]: <Next Hop Public Key Hex String>
+    [tlv_payload]: <Has Extra TLV Data Bool>
   }
 */
 module.exports = args => {
@@ -44,7 +51,7 @@ module.exports = args => {
     throw new Error('ExpectedFeeMillitokensToMapRpcHopFromHop');
   }
 
-  return {
+  const hop = {
     amt_to_forward: millitokensAsTokens(args.forward_mtokens).toString(),
     amt_to_forward_msat: args.forward_mtokens,
     chan_id: chanNumber({channel: args.channel}).number,
@@ -54,4 +61,21 @@ module.exports = args => {
     fee_msat: args.fee_mtokens,
     pub_key: args.public_key,
   };
+
+  // Exit early when there are no messages to encode in this hop
+  if (!args.messages || !args.messages.length) {
+    return hop;
+  }
+
+  // Set custom TLV payload records for this hop
+  hop.tlv_payload = true;
+
+  hop.custom_records = args.messages.reduce((tlv, n) => {
+    tlv[n.type] = hexAsBuffer(n.value);
+
+    return tlv;
+  },
+  {});
+
+  return hop;
 };

package/lnd_requests/rpc_route_from_route.js

@@ -14,6 +14,10 @@ const isNumber = n => !isNaN(n);
       fee_mtokens: <Fee Millitokens String>
       forward: <Forward Tokens Number>
       forward_mtokens: <Forward Millitokens String>
+      [messages]: [{
+        type: <Message Type Number String>
+        value: <Message Raw Value Hex Encoded String>
+      }]
       [public_key]: <Forward Edge Public Key Hex String>
       timeout: <Timeout Block Height Number>
     }]
@@ -38,6 +42,7 @@ const isNumber = n => !isNaN(n);
       amt_to_forward_msat: <Millitokens to Forward String>
       chan_id: <Numeric Format Channel Id String>
       chan_capacity: <Channel Capacity Number>
+      [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
       expiry: <Timeout Chain Height Number>
       fee: <Fee in Tokens Number>
       fee_msat: <Fee in Millitokens Number>
@@ -79,7 +84,7 @@ module.exports = args => {
     };
   }
 
-  // Set custom TLV payload records
+  // Set custom TLV payload records on the final hop
   if (!!args.messages && !!args.messages.length) {
     hops[finalHopIndex].tlv_payload = true;
 
@@ -88,7 +93,7 @@ module.exports = args => {
 
       return tlv;
     },
-    {});
+    hops[finalHopIndex].custom_records || {});
   }
 
   return {

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.3",
+    "@grpc/grpc-js": "1.5.4",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.13",
+    "@types/node": "17.0.14",
     "@types/request": "2.48.8",
     "@types/ws": "8.2.2",
     "async": "3.2.3",
@@ -24,7 +24,7 @@
     "express": "4.17.2",
     "invoices": "2.0.3",
     "psbt": "1.1.11",
-    "type-fest": "2.11.0"
+    "type-fest": "2.11.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -57,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.5.0"
+  "version": "5.6.0"
 }

package/test/lnd_requests/test_rpc_hop_from_hop.js

@@ -41,6 +41,32 @@ const tests = [
       pub_key: 'public_key',
     },
   },
+  {
+    args: {
+      channel: '0x0x1',
+      channel_capacity: 1,
+      fee: 1,
+      fee_mtokens: '1000',
+      forward: '1',
+      forward_mtokens: '1000',
+      messages: [{type: '12', value: '34'}],
+      public_key: 'public_key',
+      timeout: 1,
+    },
+    description: 'Hop is mapped to RPC hop',
+    expected: {
+      amt_to_forward: '1',
+      amt_to_forward_msat: '1000',
+      chan_id: '1',
+      chan_capacity: '1',
+      custom_records: {'12': Buffer.from('34', 'hex')},
+      expiry: 1,
+      fee: '1',
+      fee_msat: '1000',
+      pub_key: 'public_key',
+      tlv_payload: true,
+    },
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {