ln-service 56.8.2 → 56.10.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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
+
 ## 56.8.2
 
 - `subscribeToForwards`: Cancel subscription when there are no event listeners

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>
     }
 
@@ -3724,6 +3738,7 @@ Requires `offchain:write`, `onchain:write`, `peers:write` permissions
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
       [is_private]: <Channel is Private Bool> // Defaults to false
+      [is_trusted_funding]: <Accept Funding as Trusted Bool>
       lnd: <Authenticated LND API Object>
       local_tokens: <Total Channel Capacity Tokens Number>
       [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "3.0.0",
-    "lightning": "9.8.2",
+    "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.8.2"
+  "version": "56.10.0"
 }

package/test/integration/test_trusted_open.js

@@ -0,0 +1,94 @@
+const {deepEqual} = require('node:assert').strict;
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {addPeer} = require('./../../');
+const {getEphemeralChannelIds} = require('./../../');
+const {openChannel} = require('./../../');
+const {openChannels} = require('./../../');
+const {subscribeToChannels} = require('./../../');
+const {subscribeToOpenRequests} = require('./../../');
+
+const capacity = 1e6;
+const interval = 10;
+const maturity = 100;
+const size = 2;
+const times = 4000;
+
+// Opening an unconfirmed channel should in an immediate channel opening
+test(`Open an unconfirmed channel`, async () => {
+  // Unconfirmed channels are not supported on LND 0.15.0 and below
+  {
+    const {kill, nodes} = await spawnLightningCluster({});
+
+    const [{lnd}] = nodes;
+
+    try {
+      await getEphemeralChannelIds({lnd});
+
+      await kill({});
+    } catch (err) {
+      deepEqual(err, [501, 'ListAliasesMethodNotSupported']);
+
+      await kill({});
+
+      return;
+    }
+  }
+
+  const {kill, nodes} = await spawnLightningCluster({
+    size,
+    lnd_configuration: [
+      '--maxpendingchannels=10',
+      '--protocol.option-scid-alias',
+      '--protocol.zero-conf',
+    ],
+  });
+
+  const [{generate, lnd}, target] = nodes;
+
+  try {
+    await generate({count: maturity});
+
+    // Connect to the peer
+    await addPeer({lnd, public_key: target.id, socket: target.socket});
+
+    // Wait for channel to be receptive to opens
+    await asyncRetry({interval, times}, async () => {
+      return await openChannels({
+        lnd,
+        channels: [{capacity, partner_public_key: target.id}],
+      });
+    });
+
+    const acceptSub = subscribeToOpenRequests({lnd: target.lnd});
+
+    acceptSub.on('channel_request', request => {
+      equal(request.is_trusted_funding, true, 'Request is trusted funding');
+
+      return request.accept({is_trusted_funding: true});
+    });
+
+    // Propose the channel to the peer
+    const pending = await asyncRetry({interval, times}, async () => {
+      return await openChannel({
+        lnd,
+        is_trusted_funding: true,
+        local_tokens: capacity,
+        partner_public_key: target.id,
+      });
+    });
+
+    equal(pending.transaction_id.length, 64, 'Got transaction id');
+    equal(pending.transaction_vout, 0, 'Got transaction output index');
+  } catch (err) {
+    equal(err, null, 'No more error reported');
+  }
+
+  await kill({});
+
+  return;
+});

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;
+});