ln-service 56.9.0 → 56.10.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 56.10.0
+
+- `createInvoice`, `createHodlInvoice`: Add `routes` to customize the hop hints
+
 ## 56.9.0
 
 - `openChannel`: Add `is_trusted_funding` to support skipping confirmation wait

package/README.md

@@ -641,6 +641,13 @@ Requires `address:write`, `invoices:write` permission
       [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>
     }
 
@@ -707,6 +714,13 @@ Requires `address:write`, `invoices:write` permission
       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>
     }
 

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "3.0.0",
-    "lightning": "9.9.0",
+    "lightning": "9.10.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.13.0"
@@ -69,5 +69,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && node test/runner"
   },
-  "version": "56.9.0"
+  "version": "56.10.0"
 }

package/test/invoicesrpc-integration/test_create_hinted_invoice.js

@@ -0,0 +1,91 @@
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {setupChannel} = require('ln-docker-daemons');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {cancelHodlInvoice} = require('./../../');
+const {createHodlInvoice} = require('./../../');
+const {createInvoice} = require('./../../');
+const {parsePaymentRequest} = require('./../../');
+
+const interval = 10;
+const size = 3;
+const times = 1000;
+const tokens = 100;
+
+// createInvoice should result in a created invoice with hop hints
+test(`Create an invoice with hop hints`, async t => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  t.after(async () => await kill({}));
+
+  const [{generate, lnd}, target, remote] = nodes;
+
+  const channel = await setupChannel({generate, lnd, to: target});
+
+  const remoteChannel = await setupChannel({
+    generate: target.generate,
+    is_private: true,
+    lnd: target.lnd,
+    to: remote,
+  });
+
+  const specialRoutes = [[
+    {
+      public_key: target.id,
+    },
+    {
+      base_fee_mtokens: '123456',
+      channel: remoteChannel.id,
+      cltv_delta: 200,
+      fee_rate: 123456,
+      public_key: remote.id,
+    },
+  ]];
+
+  const invoice = await asyncRetry({interval, times}, async () => {
+    const invoice = await createInvoice({
+      tokens,
+      is_including_private_channels: true,
+      lnd: remote.lnd,
+      routes: specialRoutes,
+    });
+
+    const hodlInvoice = await createHodlInvoice({
+      tokens,
+      is_including_private_channels: true,
+      lnd: remote.lnd,
+      routes: specialRoutes,
+    });
+
+    const {routes} = parsePaymentRequest({request: invoice.request});
+
+    // Wait for private routes to get picked up
+    if (!routes) {
+      await cancelHodlInvoice({id: invoice.id, lnd: remote.lnd});
+
+      throw new Error('ExpectedRouteForInvoice');
+    }
+
+    const hodl = parsePaymentRequest({request: hodlInvoice.request});
+
+    // Wait for private routes to get picked up
+    if (!hodl.routes) {
+      await cancelHodlInvoice({id: hodl.id, lnd: remote.lnd});
+
+      throw new Error('ExpectedRouteForHodlInvoice');
+    }
+
+    return {
+      normal_routes: routes,
+      hodl_routes: hodl.routes,
+    };
+  });
+
+  deepEqual(invoice.normal_routes, specialRoutes, 'Got expected routes');
+  deepEqual(invoice.hodl_routes, specialRoutes, 'Got expected hodl routes');
+
+  return;
+});