ln-service 53.0.1 → 53.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 54.2.0
+
+- `getPendingChannels`: Add support for channel `capacity`
+
+## 53.1.2
+
+- `openChannels`: Fix `cooperative_close_address` not being set on channels
+
+## 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.

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.14.0-beta
+- v0.14.0-beta to v0.14.1-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
@@ -74,8 +74,8 @@ the LND directory. (~/.lnd or ~/Library/Application Support/Lnd)
 
 Be careful to avoid copying any newline characters in creds. To exclude them:
 
-    base64 ~/.lnd/tls.cert | tr -d '\n'
-    base64 ~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'
+    base64 -w0 ~/.lnd/tls.cert
+    base64 -w0 ~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
 
 You can then use these to interact with your LND node directly:
 
@@ -249,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
 
@@ -2531,6 +2535,7 @@ Requires `offchain:read` permission
     @returns via cbk or Promise
     {
       pending_channels: [{
+        capacity: <Channel Capacity Tokens Number>
         [close_transaction_id]: <Channel Closing Transaction Id String>
         is_active: <Channel Is Active Bool>
         is_closing: <Channel Is Closing Bool>
@@ -3201,11 +3206,11 @@ Requires `offchain:write`, `onchain:write`, `peers:write` permissions
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       [is_private]: <Channel is Private Bool> // Defaults to false
       lnd: <Authenticated LND API Object>
-      local_tokens: <Local Tokens Number>
+      local_tokens: <Total Channel Capacity Tokens Number>
       [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
       [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-      partner_public_key: <Public Key Hex String>
       [partner_csv_delay]: <Peer Output CSV Delay Number>
+      partner_public_key: <Public Key Hex String>
       [partner_socket]: <Peer Connection Host:Port String>
     }
 
@@ -3236,6 +3241,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>
@@ -3243,10 +3251,11 @@ channel that was not funded.
         [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
         [is_private]: <Channel is Private Bool> // Defaults to false
         [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-        partner_public_key: <Public Key Hex String>
         [partner_csv_delay]: <Peer Output CSV Delay Number>
+        partner_public_key: <Public Key Hex String>
         [partner_socket]: <Peer Connection Host:Port String>
       }]
+      [is_avoiding_broadcast]: <Avoid Broadcast of All Channels Bool>
       lnd: <Authenticated LND API Object>
     }
 
@@ -6052,8 +6061,8 @@ This method is not supported in LND 0.13.4 and below
         local_tokens: <Local Tokens Number>
         [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
         [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-        partner_public_key: <Public Key Hex String>
         [partner_csv_delay]: <Peer Output CSV Delay Number>
+        partner_public_key: <Public Key Hex String>
       }
       uri: <RPC URI String>
     }

package/package.json

@@ -11,10 +11,10 @@
     "cors": "2.8.5",
     "express": "4.17.1",
     "invoices": "2.0.2",
-    "lightning": "5.0.1",
+    "lightning": "5.2.1",
     "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,7 +23,7 @@
     "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",
@@ -35,7 +35,7 @@
     "varuint-bitcoin": "1.1.2"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=12.20"
   },
   "keywords": [
     "bitcoin",
@@ -54,5 +54,5 @@
   "scripts": {
     "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": "53.0.1"
+  "version": "53.2.0"
 }

package/test/integration/test_get_pending_coop.js

@@ -51,6 +51,7 @@ test(`Get pending channels`, async ({end, equal}) => {
     equal(channel.pending_balance, 980950, 'Waiting on balance');
   }
 
+  equal(channel.capacity, 1000000, 'Got channel capacity');
   equal(channel.close_transaction_id, undefined, 'No close tx id');
   equal(channel.is_active, false, 'Ended');
   equal(channel.is_closing, true, 'Closing');

package/test/integration/test_get_pending_force.js

@@ -68,6 +68,7 @@ test(`Get pending channels`, async ({end, equal}) => {
     equal(pendingOpen.transaction_weight, 724, 'Channel tx weight');
   }
 
+  equal(pendingOpen.capacity, 1000000, 'Got channel opening capacity');
   equal(pendingOpen.close_transaction_id, undefined, 'Not closing');
   equal(pendingOpen.is_active, false, 'Not active yet');
   equal(pendingOpen.is_closing, false, 'Not closing yet');
@@ -111,6 +112,7 @@ test(`Get pending channels`, async ({end, equal}) => {
     equal(waitClose.pending_balance, 980950, 'Waiting on balance');
   }
 
+  equal(waitClose.capacity, 1000000, 'Got channel closing capacity');
   equal(waitClose.close_transaction_id, undefined, 'Waiting for close tx');
   equal(waitClose.is_active, false, 'Not active yet');
   equal(waitClose.is_closing, true, 'Channel is closing');
@@ -166,6 +168,7 @@ test(`Get pending channels`, async ({end, equal}) => {
     equal(forceClose.pending_balance, 980950, 'Waiting on balance');
   }
 
+  equal(forceClose.capacity, 1000000, 'Got channel close capacity');
   equal(forceClose.close_transaction_id, channelClose.transaction_id, 'Txid');
   equal(forceClose.is_active, false, 'Not active anymore');
   equal(forceClose.is_closing, true, 'Channel is force closing');

package/test/integration/test_open_channels.js

@@ -1,3 +1,4 @@
+const asyncMap = require('async/map');
 const asyncRetry = require('async/retry');
 const {extractTransaction} = require('psbt');
 const {finalizePsbt} = require('psbt');
@@ -6,22 +7,25 @@ const {test} = require('@alexbosworth/tap');
 const {transactionAsPsbt} = require('psbt');
 
 const {addPeer} = require('./../../');
+const {createChainAddress} = require('./../../');
 const {delay} = require('./../macros');
 const {fundPendingChannels} = require('./../../');
 const {getChainBalance} = require('./../../');
 const {getChainTransactions} = require('./../../');
 const {getChannels} = require('./../../');
+const {getHeight} = require('./../../');
 const {getPeers} = require('./../../');
 const {openChannels} = require('./../../');
 const {sendToChainAddresses} = require('./../../');
 
 const capacity = 1e6;
 const count = 10;
-const interval = 1;
+const interval = 10;
+const maturity = 100;
 const race = promises => Promise.race(promises);
 const size = 3;
 const timeout = 250 * 10;
-const times = 200;
+const times = 2000;
 
 // Opening channels should open up channels
 test(`Open channels`, async ({end, equal}) => {
@@ -29,11 +33,19 @@ test(`Open channels`, async ({end, equal}) => {
 
   const [{generate, lnd}, target, remote] = nodes;
 
-  await asyncRetry({times}, async () => {
-    if (!(await getChainBalance({lnd})).chain_balance) {
-      await generate({});
+  await generate({count: maturity});
+
+  await asyncRetry({interval, times}, async () => {
+    const lnds = [lnd, target.lnd, remote.lnd];
+
+    const heights = await asyncMap(lnds, async lnd => {
+      return (await getHeight({lnd})).current_block_height;
+    });
+
+    const [controlHeight, targetHeight, remoteHeight] = heights;
 
-      throw new Error('ExpectedChainBalanceToOpenChannel');
+    if (controlHeight !== targetHeight || controlHeight !== remoteHeight) {
+      throw new Error('ExpectedSyncHeights');
     }
   });
 
@@ -42,11 +54,12 @@ test(`Open channels`, async ({end, equal}) => {
 
     const spending = chainTx.map(({transaction}) => transaction);
 
-    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+    const {address} = await createChainAddress({lnd});
 
-    const channels = [target, remote].map(node => ({
+    const channels = [target, remote].map(({id}) => ({
       capacity,
-      partner_public_key: node.id,
+      cooperative_close_address: address,
+      partner_public_key: id,
     }));
 
     let pending;
@@ -54,6 +67,7 @@ test(`Open channels`, async ({end, equal}) => {
     // Wait for peers to be connected
     await asyncRetry({interval, times}, async () => {
       await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+      await addPeer({lnd, public_key: target.id, socket: target.socket});
 
       if ((await getPeers({lnd})).peers.length !== channels.length) {
         throw new Error('ExpectedConnectedPeersToOpenChannels');
@@ -67,13 +81,13 @@ test(`Open channels`, async ({end, equal}) => {
     });
 
     // Normally funding would involve an un-broadcast transaction
-    await sendToChainAddresses({lnd, send_to: pending});
+    const {id} = await sendToChainAddresses({lnd, send_to: pending});
 
-    await asyncRetry({interval, times}, async() => {
+    await asyncRetry({interval, times}, async () => {
       const {transactions} = await getChainTransactions({lnd});
 
-      if (transactions.length !== pending.length) {
-        throw new Error('ExpectedMultipleChainTransactions');
+      if (!transactions.find(n => n.id === id)) {
+        throw new Error('ExpectedChainTransaction');
       }
 
       return;
@@ -96,7 +110,7 @@ test(`Open channels`, async ({end, equal}) => {
     });
 
     await asyncRetry({interval, times}, async () => {
-      await generate({count});
+      await generate({});
 
       const {channels} = await getChannels({lnd});
 
@@ -104,8 +118,14 @@ test(`Open channels`, async ({end, equal}) => {
         throw new Error('ExpectedNewChannelsCreatedAndActive');
       }
 
+      const [channel] = channels;
+
+      equal(channel.cooperative_close_address, address, 'Channel close addr');
+
       return;
     });
+  } catch (err) {
+    equal(err, null, 'No error is reported');
   } finally {
     return await kill({});
   }

package/test/integration/test_propose_channel.js

@@ -359,6 +359,7 @@ test(`Propose a channel with a coop delay`, async ({end, equal, ok}) => {
     equal(incoming.transaction_weight, 724, 'Funding tx weight');
   }
 
+  equal(incoming.capacity, 1000000, 'Incoming capacity is defined');
   equal(incoming.close_transaction_id, undefined, 'Not a closing tx');
   equal(incoming.is_active, false, 'Not active yet');
   equal(incoming.is_closing, false, 'Channel is not closing');

package/test/integration/test_subscribe_to_peers.js

@@ -1,5 +1,6 @@
 const {once} = require('events');
 
+const asyncRetry = require('async/retry');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
@@ -9,7 +10,9 @@ const {removePeer} = require('./../../');
 const {subscribeToPeers} = require('./../../');
 
 const all = promise => Promise.all(promise);
+const interval = 10;
 const size = 2;
+const times = 1000;
 
 // Subscribing to peer events should trigger reception of peer status changes
 test(`Subscribe to peers`, async ({end, equal}) => {
@@ -21,7 +24,9 @@ test(`Subscribe to peers`, async ({end, equal}) => {
 
   sub.on('error', () => {});
 
-  await addPeer({lnd, public_key: target.id, socket: target.socket});
+  await asyncRetry({interval, times}, async () => {
+    await addPeer({lnd, public_key: target.id, socket: target.socket});
+  });
 
   const disconnect = removePeer({lnd, public_key: target.id});
   const receiveDisconnect = once(sub, 'disconnected');
@@ -32,7 +37,9 @@ test(`Subscribe to peers`, async ({end, equal}) => {
 
   equal(disconnected.public_key, target.id, 'Got d/c event');
 
-  const connect = addPeer({lnd, public_key: target.id, socket: target.socket});
+  const connect = asyncRetry({interval, times}, async () => {
+    return addPeer({lnd, public_key: target.id, socket: target.socket});
+  });
 
   const receiveConnectMessage = once(sub, 'connected');
 

package/test/routerrpc-integration/test_multipath_payment.js

@@ -103,7 +103,7 @@ test(`Pay with multiple paths`, async ({end, equal, rejects, strictSame}) => {
     total_mtokens: parsed.mtokens,
   });
 
-  // Pay using routes. Multiple channels must be used too avoid tempChanFail
+  // Pay using routes. Multiple channels must be used to avoid tempChanFail
   try {
     const routes = [route1.route, route2.route];