ln-service 52.16.0 → 53.1.0

package/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Versions
 
-## 52.16.0
+## 53.1.0
+
+- Add support for LND 0.14.1
+- `openChannels`: Add `is_avoiding_broadcast` to avoid all funding broadcast
+
+## 53.0.1
+
+- Removed support for determining the type of channel to support LND 0.14.0.
+
+- `createChainAddress`: Make address format optional and add p2wpkh as default
+- `sendToChainOutputScripts`: Fix specification of `fee_tokens_per_vbyte`
+
+### Breaking Changes
+
+- `getChannels`, `getPendingChannels`, `subscribeToChannels`: Remove
+    attributes `is_anchor`, `is_static_remote_key`, `is_variable_remote_key`.
+
+## 52.16.1
 
 - `subscribeToPayViaDetails`, `subscribeToPayViaRequest`: Add `paying`,  and
     `routing_failure` events to follow in-flight attempts and encountered routing failures

package/README.md

@@ -9,6 +9,7 @@ through npm.
 
 Supported LND versions:
 
+- v0.14.0-beta
 - v0.13.0-beta to v0.13.4-beta
 - v0.12.0-beta to v0.12.1-beta
 - v0.11.0-beta to v0.11.1-beta
@@ -248,9 +249,13 @@ for `unlocker` methods.
 - [bolt07](https://npmjs.com/package/bolt07) - bolt07 channel gossip utilities
 - [bolt09](https://npmjs.com/package/bolt09) - bolt09 feature flag utilities
 - [invoices](https://npmjs.com/package/invoices) - bolt11 request utilities
-- [lightning](https://npmjs.com/package/lightning) - general lightning utilities
+- [lightning](https://npmjs.com/package/lightning) - methods with typescript
+    typing support
 - [ln-accounting](https://npmjs.com/package/ln-accounting) - accounting records
-- [ln-pathfinding](https://npmjs.com/package/ln-accounting) - pathfinding utilities
+- [ln-docker-daemons](https://github.com/alexbosworth/ln-docker-daemons)
+    - run regtest integration tests
+- [ln-pathfinding](https://npmjs.com/package/ln-accounting) - pathfinding
+    utilities
 - [probing](https://npmjs.com/package/probing) - payment probing utilities
 - [psbt](https://www.npmjs.com/package/psbt) - BIP 174 PSBT utilities
 
@@ -490,7 +495,7 @@ Create a new receive address.
 Requires `address:write` permission
 
     {
-      format: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+      [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
       [is_unused]: <Get As-Yet Unused Address Bool>
       lnd: <Authenticated LND API Object>
     }
@@ -1452,13 +1457,10 @@ Requires `offchain:read` permission
         [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
         id: <Standard Format Channel Id String>
         is_active: <Channel Active Bool>
-        is_anchor: <Channel Supports Anchor Outputs Bool>
         is_closing: <Channel Is Closing Bool>
         is_opening: <Channel Is Opening Bool>
         is_partner_initiated: <Channel Partner Opened Channel Bool>
         is_private: <Channel Is Private Bool>
-        is_static_remote_key: <Remote Key Is Static Bool>
-        is_variable_remote_key: <Remote Key Is Variable Bool>
         local_balance: <Local Balance Tokens Number>
         [local_csv]: <Local CSV Blocks Delay Number>
         [local_dust]: <Remote Non-Enforceable Amount Tokens Number>
@@ -2535,7 +2537,6 @@ Requires `offchain:read` permission
       pending_channels: [{
         [close_transaction_id]: <Channel Closing Transaction Id String>
         is_active: <Channel Is Active Bool>
-        is_anchor: <Channel Is Anchor Channel Type Bool>
         is_closing: <Channel Is Closing Bool>
         is_opening: <Channel Is Opening Bool>
         [is_partner_initiated]: <Channel Partner Initiated Channel Bool>
@@ -3239,6 +3240,9 @@ minutes to fund the channels.
 If you do not fund the channels, be sure to `cancelPendingChannel`s on each
 channel that was not funded.
 
+Use `is_avoiding_broadcast` only when self-publishing the raw transaction
+after the funding step.
+
     {
       channels: [{
         capacity: <Channel Capacity Tokens Number>
@@ -3250,6 +3254,7 @@ channel that was not funded.
         [partner_csv_delay]: <Peer Output CSV Delay Number>
         [partner_socket]: <Peer Connection Host:Port String>
       }]
+      is_avoiding_broadcast: <Avoid Broadcast of All Channels Bool>
       lnd: <Authenticated LND API Object>
     }
 
@@ -4656,13 +4661,10 @@ Requires `offchain:read` permission
       [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
       id: <Standard Format Channel Id String>
       is_active: <Channel Active Bool>
-      is_anchor: <Channel Supports Anchor Outputs Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Opened Channel Bool>
       is_private: <Channel Is Private Bool>
-      is_static_remote_key: <Remote Key Is Static Bool>
-      is_variable_remote_key: <Remote Key Is Variable Bool>
       local_balance: <Local Balance Tokens Number>
       [local_given]: <Local Initially Pushed Tokens Number>
       local_reserve: <Local Reserved Tokens Number>

package/package.json

@@ -11,10 +11,10 @@
     "cors": "2.8.5",
     "express": "4.17.1",
     "invoices": "2.0.2",
-    "lightning": "4.14.3",
+    "lightning": "5.1.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
-    "ws": "8.2.3"
+    "ws": "8.3.0"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
@@ -23,9 +23,10 @@
     "async": "3.2.2",
     "asyncjs-util": "1.2.7",
     "bip66": "1.1.5",
-    "bitcoinjs-lib": "6.0.0",
+    "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "ecpair": "1.0.1",
+    "ln-docker-daemons": "2.1.0",
     "portfinder": "1.0.28",
     "psbt": "1.1.10",
     "rimraf": "3.0.2",
@@ -51,16 +52,7 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
-    "autopilot-integration-tests": "tap --no-coverage -t 90 test/autopilotrpc-integration/*.js",
-    "chain-integration-tests": "tap --no-coverage -t 90 test/chainrpc-integration/*.js",
-    "integration-tests": "tap --no-coverage -t 120 -j 1 test/grpc-integration/*.js test/integration/*.js",
-    "invoices-integration-tests": "tap --no-coverage -t 90 test/invoicesrpc-integration/*.js",
-    "router-integration-tests": "tap --no-coverage -j 2 -t 90 test/routerrpc-integration/*.js",
-    "signer-integration-tests": "tap --no-coverage test/signerrpc-integration/*.js",
-    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -j 1 -t 150 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/routerrpc-integration/*.js test/routers-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js",
-    "tower_client-integration-tests": "tap --no-coverage test/tower_clientrpc-integration/*.js",
-    "tower_server-integration-tests": "tap --no-coverage test/tower_serverrpc-integration/*.js",
-    "wallet-integration-tests": "tap --no-coverage 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/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "52.16.0"
+  "version": "53.1.0"
 }

package/test/autopilotrpc-integration/test_autopilot.js

@@ -1,35 +1,29 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {addPeer} = require('./../../');
-const {createChainAddress} = require('./../../');
-const {createCluster} = require('./../macros');
 const {delay} = require('./../macros');
-const {generateBlocks} = require('./../macros');
-const {getNetworkGraph} = require('./../../');
 const {getAutopilot} = require('./../../');
-const {openChannel} = require('./../../');
 const {setAutopilot} = require('./../../');
 const {setupChannel} = require('./../macros');
-const {spawnLnd} = require('./../macros');
-const {waitForChannel} = require('./../macros');
-const {waitForPendingChannel} = require('./../macros');
 
 const avg = array => array.reduce((a, b) => a + b) / array.length;
-const channelCapacityTokens = 1e6;
 const confirmationCount = 6;
-const defaultFee = 1e3;
 const maxScore = 1e8;
 const score = 50000000;
+const size = 2;
 
 // Adjusting autopilot should result in changed autopilot status
 test(`Autopilot`, async ({end, equal}) => {
-  const cluster = await createCluster({is_remote_skipped: true});
+  const {kill, nodes} = await spawnLightningCluster({size});
 
-  const {kill} = cluster;
+  const [control, target] = nodes;
+
+  const cluster = {control, target};
 
   const {lnd} = cluster.control;
 
-  await setupChannel({lnd, generate: cluster.generate, to: cluster.target});
+  await setupChannel({lnd, generate: control.generate, to: cluster.target});
 
   equal((await getAutopilot({lnd})).is_enabled, false, 'Autopilot starts off');
 
@@ -41,7 +35,7 @@ test(`Autopilot`, async ({end, equal}) => {
 
   await addPeer({
     lnd,
-    public_key: cluster.target.public_key,
+    public_key: cluster.target.id,
     socket: cluster.target.socket,
   });
 
@@ -51,7 +45,7 @@ test(`Autopilot`, async ({end, equal}) => {
 
   equal((await getAutopilot({lnd})).is_enabled, false, 'Autopilot turned off');
 
-  const pubKey = cluster.control.public_key;
+  const pubKey = cluster.control.id;
 
   await setAutopilot({
     lnd,

package/test/chainrpc-integration/test_get_height.js

@@ -1,24 +1,23 @@
 const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
-const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
-const {spawnLnd} = require('./../macros');
-const {waitForTermination} = require('./../macros');
 
 const confirmationCount = 6;
+const times = 100;
 
 // Get height should return height
 test(`Get height`, async ({end, equal, fail}) => {
-  const spawned = await spawnLnd({});
+  const {nodes} = await spawnLightningCluster({});
 
-  const {generate, kill, lnd} = spawned;
+  const [{chain, generate, kill, lnd}] = nodes;
 
   const startHeight = (await getHeight({lnd})).current_block_height;
 
-  await generate({count: confirmationCount});
+  await asyncRetry({times}, async () => {
+    await generate({});
 
-  await asyncRetry({}, async () => {
     const endHeight = (await getHeight({lnd})).current_block_height;
 
     if (endHeight - startHeight < confirmationCount) {
@@ -30,9 +29,7 @@ test(`Get height`, async ({end, equal, fail}) => {
     return;
   });
 
-  kill();
-
-  await waitForTermination({lnd});
+  await kill({});
 
   return end();
 });

package/test/chainrpc-integration/test_subscribe_to_blocks.js

@@ -1,63 +1,84 @@
 const EventEmitter = require('events');
+const {once} = require('events');
 
 const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
+const {createChainAddress} = require('./../../');
 const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
+const {getChainBalance} = require('./../../');
 const {spawnLnd} = require('./../macros');
 const {subscribeToBlocks} = require('./../../');
 const {waitForTermination} = require('./../macros');
 
 const confirmationCount = 6;
-const interval = 200;
-const times = 400;
+const interval = 1;
+const race = promises => Promise.race(promises);
+const times = 4000;
 
 // Subscribers to blocks should receive block notifications
 test(`Subscribe to blocks`, async ({end, equal, fail}) => {
-  const spawned = await spawnLnd({});
-
-  const {kill, lnd} = spawned;
-
   const blocks = [];
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{generate, lnd}] = nodes;
 
-  // Wait for chainrpc to be active
   await asyncRetry({interval, times}, async () => {
-    const height = (await getHeight({lnd})).current_block_height;
+    const subBlocks = subscribeToBlocks({lnd});
 
-    if (!height) {
-      throw new Error('ExpectedCurrentHeight');
-    }
+    const [event] = await race([
+      once(subBlocks, 'block'),
+      once(subBlocks, 'error'),
+    ]);
 
-    return;
+    if (!event.height) {
+      throw new Error('ExpectedBlockEvent');
+    }
   });
 
-  const sub = subscribeToBlocks({lnd});
-  const startHeight = (await getHeight({lnd})).current_block_height;
+  try {
+    // Wait for chainrpc to be active
+    await asyncRetry({interval, times}, async () => {
+      if (!!(await getChainBalance({lnd})).chain_balance) {
+        return;
+      }
 
-  sub.on('block', async data => blocks.push(data));
-  sub.on('error', err => {});
+      await generate({});
 
-  await spawned.generate({count: confirmationCount});
+      await getHeight({lnd});
 
-  await asyncRetry({interval, times}, async () => {
-    if (blocks.length < confirmationCount) {
-      throw new Error('ExpectedAdditionalBlocks');
-    }
-  });
+      throw new Error('ExpectedChainBalance');
+    });
 
-  blocks.forEach(({height, id}) => {
-    equal(!!height, true, 'Got expected block height');
-    equal(id.length, 64, 'Got expected block hash length');
-    return;
-  });
+    const sub = subscribeToBlocks({lnd});
+    const startHeight = (await getHeight({lnd})).current_block_height;
+
+    sub.on('block', data => blocks.push(data));
+    sub.on('error', err => {});
+
+    const {address} = await createChainAddress({lnd});
 
-  kill();
+    await asyncRetry({interval, times}, async () => {
+      await generate({});
 
-  await waitForTermination({lnd});
+      if (blocks.length < confirmationCount) {
+        throw new Error('ExpectedAdditionalBlocks');
+      }
+    });
 
-  return end();
+    blocks.forEach(({height, id}) => {
+      equal(!!height, true, 'Got expected block height');
+      equal(id.length, 64, 'Got expected block hash length');
+      return;
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  } finally {
+    await kill({});
 
-  return;
+    return end();
+  }
 });

package/test/chainrpc-integration/test_subscribe_to_chain_address.js

@@ -1,12 +1,16 @@
 const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {chainSendTransaction} = require('./../macros');
 const {createChainAddress} = require('./../../');
 const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
+const {getChainBalance} = require('./../../');
+const {getChainTransactions} = require('./../../');
 const {getHeight} = require('./../../');
 const {mineTransaction} = require('./../macros');
+const {sendToChainAddress} = require('./../../');
 const {spawnLnd} = require('./../macros');
 const {subscribeToChainAddress} = require('./../../');
 const {waitForTermination} = require('./../macros');
@@ -15,102 +19,104 @@ const count = 100;
 const defaultFee = 1e3;
 const defaultVout = 0;
 const format = 'np2wpkh';
-const interval = retryCount => 50 * Math.pow(2, retryCount);
-const times = 15;
+const interval = 1;
+const times = 1500;
 const tokens = 1e8;
 
 // Subscribing to chain transaction confirmations should trigger events
 test(`Subscribe to chain transactions`, async ({end, equal, fail}) => {
-  const node = await spawnLnd({});
+  const {kill, nodes} = await spawnLightningCluster({});
 
-  const cert = node.chain_rpc_cert_file;
-  const host = node.listen_ip;
-  const {kill} = node;
-  const pass = node.chain_rpc_pass;
-  const port = node.chain_rpc_port;
-  const {lnd} = node;
-  const user = node.chain_rpc_user;
+  const [{chain, generate, lnd}] = nodes;
 
-  const startHeight = (await getHeight({lnd})).current_block_height;
+  // Wait for chainrpc to be active
+  await asyncRetry({interval, times}, async () => {
+    if (!!(await getChainBalance({lnd})).chain_balance) {
+      return;
+    }
 
-  const {address} = await createChainAddress({format, lnd});
+    await generate({});
 
-  // Generate some funds for LND
-  const {blocks} = await node.generate({count});
+    await getHeight({lnd});
 
-  const [block] = blocks;
+    throw new Error('ExpectedChainBalance');
+  });
 
-  const [coinbaseTransactionId] = block.transaction_ids;
+  let firstConf;
+  const {address} = await createChainAddress({format, lnd});
+  const startHeight = (await getHeight({lnd})).current_block_height;
 
-  const {transaction} = chainSendTransaction({
-    tokens,
-    destination: address,
-    fee: defaultFee,
-    private_key: node.mining_key,
-    spend_transaction_id: coinbaseTransactionId,
-    spend_vout: defaultVout,
-  });
+  await asyncRetry({interval, times}, async () => {
+    const sub = subscribeToChainAddress({
+      lnd,
+      min_height: startHeight,
+      p2sh_address: address,
+    });
 
-  const sub = subscribeToChainAddress({
-    lnd,
-    min_height: startHeight,
-    p2sh_address: address,
-  });
+    sub.on('confirmation', conf => firstConf = conf);
+    sub.on('error', err => {});
 
-  let firstConf;
+    await generate({count});
 
-  sub.on('confirmation', conf => firstConf = conf);
-  sub.on('error', err => {});
+    await sendToChainAddress({lnd, address, tokens});
 
-  // Wait for generation to be over
-  await asyncRetry({interval, times}, async () => {
-    await mineTransaction({cert, host, pass, port, transaction, user});
+    const {transactions} = await getChainTransactions({lnd});
+
+    const [{transaction}] = transactions
+      .filter(n => !n.is_confirmed)
+      .filter(n => !!n.is_outgoing);
 
-    if (!firstConf) {
-      throw new Error('ExpectedSubscribeToChainAddressSeesConfirmation');
+    if (!transaction) {
+      throw new Error('ExpectedTrnasaction');
     }
 
-    equal(firstConf.block.length, 64, 'Confirmation block hash is returned');
-    equal(firstConf.height, 102, 'Confirmation block height is returned');
-    equal(firstConf.transaction, transaction, 'Confirmation raw tx returned');
+    // Wait for generation to be over
+    await asyncRetry({interval, times}, async () => {
+      await generate({});
 
-    return;
-  });
+      if (!firstConf) {
+        throw new Error('ExpectedSubscribeToChainAddressSeesConf');
+      }
 
-  let secondConf;
+      equal(firstConf.block.length, 64, 'Confirmation block hash returned');
+      equal(firstConf.height >= 102, true, 'Got confirmation block height');
+      equal(firstConf.transaction, transaction, 'Confirmation raw tx');
 
-  const sub2 = subscribeToChainAddress({
-    lnd,
-    min_confirmations: 6,
-    min_height: startHeight,
-    p2sh_address: address,
-  });
+      return;
+    });
 
-  sub2.on('error', () => {});
+    let secondConf;
 
-  sub2.on('confirmation', conf => secondConf = conf);
+    const sub2 = subscribeToChainAddress({
+      lnd,
+      min_confirmations: 6,
+      min_height: startHeight,
+      p2sh_address: address,
+    });
 
-  // Wait for generation to be over
-  await asyncRetry({interval, times}, async () => {
-    await mineTransaction({cert, host, pass, port, transaction, user});
+    sub2.on('error', () => {});
 
-    if (!secondConf) {
-      throw new Error('ExpectedSubscribeToChainAddressSeesMultiConfirmation');
-    }
+    sub2.on('confirmation', conf => secondConf = conf);
 
-    equal(secondConf.block.length, 64, 'Confirmation block hash is returned');
-    equal(secondConf.height, 102, 'Confirmation block height is returned');
-    equal(secondConf.transaction, transaction, 'Confirmation raw tx returned');
+    // Wait for generation to be over
+    await asyncRetry({interval, times}, async () => {
+      await generate({});
 
-    return;
-  });
+      if (!secondConf) {
+        throw new Error('ExpectedSubscribeToChainAddressSeesConfirmation');
+      }
 
-  sub.removeAllListeners();
-  sub2.removeAllListeners();
+      equal(secondConf.block.length, 64, 'Confirmation block hash returned');
+      equal(secondConf.height >= 102, true, 'Confirmation block height');
+      equal(secondConf.transaction, transaction, '2nd conf raw tx returned');
 
-  kill();
+      return;
+    });
+
+    [sub, sub2].forEach(n => n.removeAllListeners());
+  });
 
-  await waitForTermination({lnd});
+  await kill({});
 
   return end();
 });