ln-service 54.3.2 → 54.4.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 54.4.0
+
+- `subscribeToRpcRequests`: `open_channel_request` add support for
+    `fee_rate`, `base_fee_mtokens`
+
+## 54.3.3
+
+- `getWalletInfo`: Add support for LND 0.15.5
+
 ## 54.3.2
 
 - `createUnsignedRequest`: Fix support for empty description requests

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.15.2-beta to v0.15.4-beta
+- v0.15.2-beta to v0.15.5-beta
 - v0.14.4-beta to v0.14.5-beta
 
 For typescript-ready methods, check out https://github.com/alexbosworth/lightning#readme
@@ -3157,7 +3157,7 @@ await payViaRoutes({lnd, routes: [route]});
 
 Get the settlement status of a received HTLC
 
-Note: this method is not supported in LND versions 0.15.4 and below
+Note: this method is not supported in LND versions 0.15.5 and below
 
 Requires `offchain:read` permissions
 
@@ -3485,7 +3485,7 @@ const request = require('@alexbosworth/request');
 const websocket = require('ws');
 const {Writable} = require('stream');
 
-const log = output => console.log(output);
+const log = output => log(output);
 const path = '/lnd/';
 const port = 8050;
 
@@ -3606,8 +3606,8 @@ If give_tokens is set, it is a gift and it does not alter the capacity
 
 Requires `offchain:write`, `onchain:write`, `peers:write` permissions
 
-`base_fee_mtokens` is not supported on LND 0.15.4 and below
-`fee_rate` is not supported on LND 0.15.4 and below
+`base_fee_mtokens` is not supported on LND 0.15.5 and below
+`fee_rate` is not supported on LND 0.15.5 and below
 
     {
       [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
@@ -3659,8 +3659,8 @@ after the funding step.
 `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
 as well as a channel open request listener to accept the trusted funding.
 
-`base_fee_mtokens` is not supported on LND 0.15.4 and below
-`fee_rate` is not supported on LND 0.15.4 and below
+`base_fee_mtokens` is not supported on LND 0.15.5 and below
+`fee_rate` is not supported on LND 0.15.5 and below
 
     {
       channels: [{
@@ -6309,7 +6309,7 @@ Subscribe to outgoing payments
 
 Requires `offchain:read` permission
 
-Note: Method not supported on LND 0.15.4 and below
+Note: Method not supported on LND 0.15.5 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -6704,8 +6704,10 @@ This method is not supported in LND 0.13.4 and below
       macaroon: <Base64 Encoded Macaroon String>
       reject: ({message: <Rejection String>}, [cbk]) => {}
       request: {
+        [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
         [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
         [cooperative_close_address]: <Prefer Cooperative Close To Address String>
+        [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
         [give_tokens]: <Tokens to Gift To Partner Number>
         [is_private]: <Channel is Private Bool>
         local_tokens: <Local Tokens Number>

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "2.2.2",
-    "lightning": "6.3.1",
+    "lightning": "6.4.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.11.0"
@@ -28,7 +28,7 @@
     "bn.js": "5.2.1",
     "bs58check": "2.1.2",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "3.1.5",
+    "ln-docker-daemons": "4.0.0",
     "p2tr": "1.3.2",
     "portfinder": "1.0.32",
     "psbt": "2.7.1",
@@ -56,12 +56,13 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
+    "integration-test-0.15.5": "DOCKER_LND_VERSION=v0.15.5-beta npm run test",
     "integration-test-0.15.4": "DOCKER_LND_VERSION=v0.15.4-beta npm run test",
     "integration-test-0.15.3": "DOCKER_LND_VERSION=v0.15.3-beta npm run test",
     "integration-test-0.15.2": "DOCKER_LND_VERSION=v0.15.2-beta npm run test",
     "integration-test-0.14.5": "DOCKER_LND_VERSION=v0.14.5-beta npm run test",
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
-    "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/peersrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
+    "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/peersrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "54.3.2"
+  "version": "54.4.0"
 }

package/test/chainrpc-integration/test_subscribe_to_blocks.js

@@ -14,7 +14,7 @@ const {subscribeToBlocks} = require('./../../');
 const {waitForTermination} = require('./../macros');
 
 const confirmationCount = 6;
-const interval = 10;
+const interval = 50;
 const race = promises => Promise.race(promises);
 const times = 4000;
 
@@ -25,7 +25,7 @@ test(`Subscribe to blocks`, async ({end, equal, fail}) => {
 
   const [{generate, lnd}] = nodes;
 
-  await asyncRetry({interval, times}, async () => {
+  const gotHeight = await asyncRetry({interval, times}, async () => {
     const subBlocks = subscribeToBlocks({lnd});
 
     const [event] = await race([
@@ -36,8 +36,12 @@ test(`Subscribe to blocks`, async ({end, equal, fail}) => {
     if (!event.height) {
       throw new Error('ExpectedBlockEvent');
     }
+
+    return !!event.height;
   });
 
+  equal(gotHeight, true, 'Got the block height');
+
   try {
     // Wait for chainrpc to be active
     await asyncRetry({interval, times}, async () => {

package/test/chainrpc-integration/test_subscribe_to_chain_spend.js

@@ -62,7 +62,7 @@ test(`Subscribe to chain spend`, async ({end, equal}) => {
 
   const {utxos} = await getUtxos({lnd});
 
-  const [utxo] = utxos;
+  const [utxo] = utxos.filter(n => n.address_format === 'p2wpkh');
 
   await control.generate({count});
 
@@ -79,7 +79,7 @@ test(`Subscribe to chain spend`, async ({end, equal}) => {
   sub.once('confirmation', ({height, transaction, vin}) => {
     equal(!!height, true, 'Height of the confirmation is returned');
     equal(!!transaction, true, 'Raw transaction is returned');
-    equal(vin, 0, 'Transaction input index is returned');
+    equal(vin !== undefined, true, 'Transaction input index is returned');
 
     return gotAddressConf = true;
   });

package/test/{tower_clientrpc-integration → extra-integration/tower_clientrpc-integration}/test_disconnect_watchtower.js

@@ -38,7 +38,7 @@ test(`Disconnect watchtower`, async ({end, equal, match}) => {
 
   const [disconnected] = (await getConnectedWatchtowers({lnd})).towers;
 
-  // LND 0.15.4 and below retain the tower
+  // LND 0.15.5 and below retain the tower
   if (!!disconnected) {
     equal(disconnected.is_active, false, 'Tower is inactive');
   }

package/test/integration/test_get_chain_fee_estimate.js

@@ -6,7 +6,7 @@ const {createChainAddress} = require('./../../');
 const {getChainBalance} = require('./../../');
 const {getChainFeeEstimate} = require('./../../');
 
-const expectedFee = 8650;
+const expectedFee = 9250;
 const expectedFeeRate = 50;
 const format = 'np2wpkh';
 const size = 2;
@@ -39,7 +39,13 @@ test(`Get chain fee estimate`, async ({end, equal}) => {
     ],
   });
 
-  equal(estimate.fee, expectedFee, 'Total fee is estimated');
+  // LND 0.15.4 and below uses P2WPKH as change
+  if (estimate.fee === 8650) {
+    equal(estimate.fee, 8650, 'Total fee is estimated');
+  } else {
+    equal(estimate.fee, expectedFee, 'Total fee is estimated');
+  }
+
   equal(estimate.tokens_per_vbyte, expectedFeeRate, 'Fee per vbyte is given');
 
   await kill({});

package/test/integration/test_get_forwards.js

@@ -9,8 +9,10 @@ const {getForwards} = require('./../../');
 const {pay} = require('./../../');
 const {setupChannel} = require('./../macros');
 
+const interval = 100;
 const limit = 1;
 const size = 3;
+const times = 1000;
 const tokens = 100;
 
 // Getting forwarded payments should return all forwarded payments
@@ -32,7 +34,7 @@ test('Get forwards', async ({end, equal, strictSame}) => {
   await delay(2000);
 
   for (let i = 0, l = remote.lnd; i < 3; i++) {
-    await asyncRetry({}, async () => {
+    await asyncRetry({interval, times}, async () => {
       await delay(1000);
 
       await pay({

package/test/integration/test_get_settlement_status.js

@@ -19,7 +19,7 @@ test(`Get settlement status`, async ({end, equal, strictSame}) => {
 
   const [{generate, lnd}, target] = nodes;
 
-  // LND 0.15.4 and below do not support settlement status lookups
+  // LND 0.15.5 and below do not support settlement status lookups
   try {
     await getSettlementStatus({
       lnd: target.lnd,

package/test/integration/test_open_channel.js

@@ -70,7 +70,7 @@ test(`Open channel`, async ({end, equal}) => {
       throw new Error('ExpectedKnownPolicyBaseFeeMtokens');
     }
 
-    // LND 0.15.4 and below do not support setting fees on open
+    // LND 0.15.5 and below do not support setting fees on open
     if (policy.base_fee_mtokens === defaultBaseFee) {
       return;
     }

package/test/integration/test_open_channels.js

@@ -139,7 +139,7 @@ test(`Open channels`, async ({end, equal}) => {
 
       const policy = policies.find(n => !!n.cltv_delta);
 
-      // LND 0.15.4 and below do not support setting fees on open
+      // LND 0.15.5 and below do not support setting fees on open
       if (policy.base_fee_mtokens === defaultBaseFee) {
         return;
       }

package/test/integration/test_recover_funds_from_channel.js

@@ -34,6 +34,7 @@ test(`Recover funds from channel`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 
@@ -46,6 +47,7 @@ test(`Recover funds from channel`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 
@@ -116,6 +118,7 @@ test(`Recover funds from channel`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 

package/test/integration/test_recover_funds_from_channels.js

@@ -34,6 +34,7 @@ test(`Recover funds from channels`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 
@@ -46,6 +47,7 @@ test(`Recover funds from channels`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 
@@ -112,6 +114,7 @@ test(`Recover funds from channels`, async ({end, equal}) => {
       generate_address: generateAddress,
       lightning_p2p_port: await getPort({port: 12001, stopPort: 13000}),
       lightning_rpc_port: await getPort({port: 13001, stopPort: 14000}),
+      lightning_tower_port: await getPort({port: 14001, stopPort: 15000}),
     });
   });
 

package/test/integration/test_send_to_chain_addresses.js

@@ -6,6 +6,7 @@ const {createChainAddress} = require('./../../');
 const {getChainBalance} = require('./../../');
 const {sendToChainAddresses} = require('./../../');
 
+const interval = 1000;
 const regtestBech32AddressHrp = 'bcrt';
 const size = 2;
 const times = 10;
@@ -47,7 +48,7 @@ test(`Send to chain address`, async ({end, equal}) => {
   equal(sent.is_outgoing, true, 'Transaction is outgoing');
   equal(sent.tokens, tokens, 'Tokens amount matches tokens sent');
 
-  await asyncRetry({times}, async () => {
+  await asyncRetry({interval, times}, async () => {
     // Generate to confirm the tx
     await control.generate({});
 

package/test/integration/test_subscribe_to_rpc_requests.js

@@ -143,6 +143,8 @@ test(`Subscribe to RPC requests`, async ({end, equal, fail, strictSame}) => {
         // Gift some tokens in a channel
         await openChannel({
           lnd,
+          base_fee_mtokens: '1',
+          fee_rate: 1,
           give_tokens: 1e5,
           local_tokens: 1e6,
           partner_public_key: Buffer.alloc(33, 2).toString('hex'),

package/test/integration/test_subscribe_to_transactions.js

@@ -63,9 +63,16 @@ test(`Subscribe to chain transactions`, async ({end, equal, fail}) => {
 
   equal(!!tx.created_at, true, 'Tx has a creation date');
   equal(tx.is_outgoing, true, 'Tx is outgoing');
-  equal(tx.fee, 7050, 'Transaction has a chain fee');
   equal(!!tx.id, true, 'Tx has an id');
-  equal(tx.tokens, 1007050, 'Tx tokens is fee + tokens sent');
+
+  // LND 0.15.4 and below do not use P2TR change addresses
+  if (tx.fee === 7050) {
+    equal(tx.fee, 7050, 'Transaction has a chain fee');
+    equal(tx.tokens, 1007050, 'Tx tokens is fee + tokens sent');
+  } else {
+    equal(tx.fee, 7650, 'Transaction has a chain fee');
+    equal(tx.tokens, 1007650, 'Tx tokens is fee + tokens sent');
+  }
 
   if (!!tx.output_addresses.find(n => n.length < 14 || n.length > 74)) {
     fail('Output address lengths must be between 14 and 74');

package/test/integration/test_trusted_funding.js

@@ -85,13 +85,15 @@ test(`Open unconfirmed channels`, async ({end, equal, match, strictSame}) => {
     });
 
     // Propose the channel to the peer
-    const {pending} = await openChannels({
-      lnd,
-      channels: [{
-        capacity,
-        is_trusted_funding: true,
-        partner_public_key: target.id,
-      }],
+    const {pending} = await asyncRetry({interval, times}, async () => {
+      return await openChannels({
+        lnd,
+        channels: [{
+          capacity,
+          is_trusted_funding: true,
+          partner_public_key: target.id,
+        }],
+      });
     });
 
     // Setup funding to the 2:2 output

package/test/macros/change_password.js

@@ -33,7 +33,7 @@ const lightningTlsCertFileName = 'tls.cert';
 const lightningTlsKeyFileName = 'tls.key';
 const lightningWalletPassword = 'password';
 const lndWalletUnlockerService = 'WalletUnlocker';
-const localhost = 'localhost';
+const localhost = '127.0.0.1';
 const maxSpawnChainDaemonAttempts = 3;
 const readMacaroonFileName = 'readonly.macaroon';
 const retryCreateSeedCount = 500;
@@ -292,7 +292,7 @@ module.exports = ({network}, cbk) => {
       return cbk(null, {
         macaroon,
         cert: readFileSync(certPath).toString('base64'),
-        host: `${localhost}:${getPorts.rpc}`,
+        host: `localhost:${getPorts.rpc}`,
       });
     }],
 
@@ -396,7 +396,7 @@ module.exports = ({network}, cbk) => {
       try {
         return cbk(null, unauthenticatedLndGrpc({
           cert,
-          socket: `${localhost}:${getPorts.rpc}`,
+          socket: `localhost:${getPorts.rpc}`,
         }).lnd);
       } catch (err) {
         return cbk([503, 'FailedToLaunchLightningDaemon', err]);

package/test/macros/spawn_lnd.js

@@ -34,7 +34,7 @@ const lightningTlsCertFileName = 'tls.cert';
 const lightningTlsKeyFileName = 'tls.key';
 const lightningWalletPassword = 'password';
 const lndWalletUnlockerService = 'Unlocker';
-const localhost = 'localhost';
+const localhost = '127.0.0.1';
 const maxSpawnChainDaemonAttempts = 10;
 const {random} = Math;
 const readMacaroonFileName = 'readonly.macaroon';
@@ -327,7 +327,7 @@ module.exports = (args, cbk) => {
       'spawnLightningDaemon',
       ({cert, getPorts}, cbk) =>
     {
-      const socket = `${localhost}:${getPorts.rpc}`;
+      const socket = `localhost:${getPorts.rpc}`;
 
       try {
         return cbk(null, unauthenticatedLndGrpc({cert, socket}).lnd);
@@ -450,7 +450,7 @@ module.exports = (args, cbk) => {
       return cbk(null, {
         cert,
         macaroon,
-        socket: `${localhost}:${getPorts.rpc}`,
+        socket: `localhost:${getPorts.rpc}`,
       });
     }],
 

package/test/routerrpc-integration/test_subscribe_to_payments.js

@@ -43,7 +43,7 @@ test(`Subscribe to payments`, async ({end, rejects, strictSame}) => {
     sub.on('error', error => {
       const [,, {err}] = error;
 
-      // subscribeToPayments is not supported on LND 0.15.4 and below
+      // subscribeToPayments is not supported on LND 0.15.5 and below
       if (err.details === unsupported) {
         return isLegacy.push(error);
       }

package/test/tower_serverrpc-integration/test_get_tower_server_info.js

@@ -1,16 +1,15 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {getTowerServerInfo} = require('./../../');
-const {spawnLnd} = require('./../macros');
-const {waitForTermination} = require('./../macros');
 
-const pubKeyHexLength = Buffer.alloc(33).toString('hex').length;
+const conf = ['--watchtower.active'];
 
 // Getting the tower server info should return tower server info
 test(`Get tower server info`, async ({end, equal, match}) => {
-  const spawned = await spawnLnd({tower: true});
+  const {kill, nodes} = await spawnLightningCluster({lnd_configuration: conf});
 
-  const {lnd} = spawned;
+  const [{lnd}] = nodes;
 
   const {tower} = await getTowerServerInfo({lnd});
 
@@ -20,15 +19,13 @@ test(`Get tower server info`, async ({end, equal, match}) => {
 
   match(socket, /127.0.0.1\:\d\d\d\d/, 'Tower socket returned');
 
-  equal(tower.public_key.length, pubKeyHexLength, 'Public key returned');
+  equal(tower.public_key.length, 66, 'Public key returned');
 
   const [uri] = tower.uris;
 
   equal(uri, `${tower.public_key}@${socket}`, 'Got back socket');
 
-  spawned.kill();
-
-  await waitForTermination({lnd});
+  await kill({});
 
   return end();
 });

package/test/walletrpc-integration/test_fund_psbt.js

@@ -98,8 +98,14 @@ test(`Fund PSBT`, async ({end, equal}) => {
   const change = funded.outputs.find(n => n.is_change);
   const output = funded.outputs.find(n => !n.is_change);
 
-  equal(change.output_script.length, 44, 'Change address is returned');
-  equal(change.tokens, 4998992950, 'Got change output value');
+  // LND 0.15.4 and below use P2WPKH as change
+  if (change.output_script.length === 44) {
+    equal(change.output_script.length, 44, 'Change address is returned');
+    equal(change.tokens, 4998992950, 'Got change output value');
+  } else {
+    equal(change.output_script.length, 68, 'Change address is returned');
+    equal(change.tokens, 4998992350, 'Got change output value');
+  }
 
   equal(output.tokens, tokens, 'Got expected tokens output');