ln-service 53.7.0 → 53.8.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## 53.7.0
+## 53.8.0
+
+- `getMasterPublicKeys`: Add method to get bip32 master public keys
+
+## 53.7.3
 
 - `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
 

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.14.0-beta to v0.14.1-beta
+- v0.14.0-beta to v0.14.2-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
@@ -157,6 +157,7 @@ for `unlocker` methods.
 - [getInvoice](#getinvoice) - Get a previously created invoice
 - [getInvoices](#getinvoices) - Get all previously created invoices
 - [getLockedUtxos](#getlockedutxos) - Get all previously locked UTXOs
+- [getMasterPublicKeys](#getmasterpublickeys) - Get a list of master pub keys
 - [getMethods](#getmethods) - Get available methods and associated permissions
 - [getNetworkCentrality](#getnetworkcentrality) - Get centrality score for nodes
 - [getNetworkGraph](#getnetworkgraph) - Get the channels and nodes of the graph
@@ -2102,6 +2103,41 @@ const {getLockedUtxos} = require('ln-service');
 const numLockedUtxos = (await getLockedUtxos({lnd})).utxos.length;
 ```
 
+### getMasterPublicKeys
+
+Get the currently tracked master public keys
+
+Requires LND compiled with `walletrpc` build tag
+
+Requires `onchain:read` permission
+
+This method is not supported in LND 0.13.3 and below
+
+    {
+      lnd: <Authenticated API LND Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      keys: [{
+        derivation_path: <Key Derivation Path String>
+        extended_public_key: <Base58 Encoded Master Public Key String>
+        external_key_count: <Used External Keys Count Number>
+        internal_key_count: <Used Internal Keys Count Number>
+        is_watch_only: <Node has Master Private Key Bool>
+        named: <Account Name String>
+      }]
+    }
+
+```node
+const {getMasterPublicKeys} = require('ln-service');
+
+const {keys} = await getMasterPublicKeys({lnd});
+
+// Find the master public key that derives pay to witness public key hash keys
+const masterAddressesKey = keys.find(n => n.derivation_path === `m/84'/0'/0'`);
+```
+
 ### getMethods
 
 Get the list of all methods and their associated requisite permissions
@@ -3401,7 +3437,7 @@ Requires `onchain:write` permission
 
 Requires LND built with `walletrpc` tag
 
-This method is not supported in LND 0.14.1 and below
+This method is not supported in LND 0.14.2 and below
 
     {
       lnd: <Authenticated LND API Object>

package/index.js

@@ -49,6 +49,7 @@ const {getIdentity} = require('lightning');
 const {getInvoice} = require('lightning');
 const {getInvoices} = require('lightning');
 const {getLockedUtxos} = require('lightning');
+const {getMasterPublicKeys} = require('lightning');
 const {getMethods} = require('lightning');
 const {getNetworkCentrality} = require('lightning');
 const {getNetworkGraph} = require('lightning');
@@ -91,7 +92,7 @@ const {requestChainFeeIncrease} = require('lightning');
 const {restrictMacaroon} = require('./macaroons');
 const {revokeAccess} = require('lightning');
 const {routeFromChannels} = require('bolt07');
-const {sendMessageToPeer} = require('lightning/lnd_methods');
+const {sendMessageToPeer} = require('lightning');
 const {sendToChainAddress} = require('lightning');
 const {sendToChainAddresses} = require('lightning');
 const {sendToChainOutputScripts} = require('lightning');
@@ -118,7 +119,7 @@ const {subscribeToPastPayments} = require('lightning');
 const {subscribeToPayViaDetails} = require('lightning');
 const {subscribeToPayViaRequest} = require('lightning');
 const {subscribeToPayViaRoutes} = require('lightning');
-const {subscribeToPeerMessages} = require('lightning/lnd_methods');
+const {subscribeToPeerMessages} = require('lightning');
 const {subscribeToPeers} = require('lightning');
 const {subscribeToProbeForRoute} = require('lightning');
 const {subscribeToRpcRequests} = require('lightning');
@@ -189,6 +190,7 @@ module.exports = {
   getInvoice,
   getInvoices,
   getLockedUtxos,
+  getMasterPublicKeys,
   getMethods,
   getNetworkCentrality,
   getNetworkGraph,

package/package.json

@@ -10,11 +10,11 @@
     "bolt07": "1.8.0",
     "cors": "2.8.5",
     "express": "4.17.2",
-    "invoices": "2.0.3",
-    "lightning": "5.6.0",
+    "invoices": "2.0.4",
+    "lightning": "5.6.3",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
-    "ws": "8.4.2"
+    "ws": "8.5.0"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
@@ -22,13 +22,15 @@
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.3",
     "asyncjs-util": "1.2.8",
+    "bip32": "3.0.1",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
+    "bs58check": "2.1.2",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.2.3",
+    "ln-docker-daemons": "2.2.4",
     "portfinder": "1.0.28",
-    "psbt": "1.1.11",
+    "psbt": "2.0.0",
     "rimraf": "3.0.2",
     "secp256k1": "4.0.3",
     "tiny-secp256k1": "2.2.0",
@@ -54,6 +56,7 @@
   },
   "scripts": {
     "integration-test-daily-lnd-build": "DOCKER_LND_VERSION=daily-testing-only npm run test",
+    "integration-test-0.14.2": "DOCKER_LND_VERSION=v0.14.2-beta npm run test",
     "integration-test-0.14.1": "DOCKER_LND_VERSION=v0.14.1-beta npm run test",
     "integration-test-0.14.0": "DOCKER_LND_VERSION=v0.14.0-beta npm run test",
     "integration-test-0.13.4": "DOCKER_LND_VERSION=v0.13.4-beta npm run test",
@@ -65,5 +68,5 @@
     "integration-test-0.12.0": "DOCKER_LND_VERSION=v0.12.0-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/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "53.7.0"
+  "version": "53.8.0"
 }

package/test/integration/test_add_peer.js

@@ -8,8 +8,8 @@ const {getPeers} = require('./../../');
 
 const interval = 100;
 const size = 2;
-const times = 100;
-const timeout = 1;
+const times = 2000;
+const timeout = 100;
 
 // Adding peers should result in a connected peer
 test(`Add a peer`, async ({end, equal}) => {
@@ -27,6 +27,8 @@ test(`Add a peer`, async ({end, equal}) => {
         lnd,
         timeout,
         public_key: target.id,
+        retry_count: 1,
+        retry_delay: 1,
         socket: target.socket,
       });
 

package/test/integration/test_delete_pending_channel.js

@@ -5,6 +5,7 @@ const asyncRetry = require('async/retry');
 const {extractTransaction} = require('psbt');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
+const tinysecp = require('tiny-secp256k1');
 
 const {addPeer} = require('./../../');
 const {broadcastChainTransaction} = require('./../../');
@@ -27,11 +28,13 @@ const count = 100;
 const interval = 100;
 const race = promises => Promise.race(promises);
 const size = 3;
-const timeout = 1000 * 5;
+const timeout = 1000 * 20;
 const times = 200;
 
 // Forfeiting a pending channel should remove the pending channel
 test(`Forfeit pending channel`, async ({end, equal, strictSame}) => {
+  const ecp = (await import('ecpair')).ECPairFactory(tinysecp);
+
   const {kill, nodes} = await spawnLightningCluster({size});
 
   const [control, target, remote] = nodes;
@@ -105,7 +108,7 @@ test(`Forfeit pending channel`, async ({end, equal, strictSame}) => {
       funding: signRemote.psbt,
     });
 
-    const {transaction} = extractTransaction({psbt: signRemote.psbt});
+    const {transaction} = extractTransaction({ecp, psbt: signRemote.psbt});
 
     await broadcastChainTransaction({lnd, transaction});
 

package/test/integration/test_get_closed_channels.js

@@ -9,9 +9,7 @@ const {createHodlInvoice} = require('./../../');
 const {delay} = require('./../macros');
 const {payViaPaymentRequest} = require('./../../');
 const {getChainTransactions} = require('./../../');
-const {getChannels} = require('./../../');
 const {getClosedChannels} = require('./../../');
-const {getHeight} = require('./../../');
 const {getPendingChannels} = require('./../../');
 const {getSweepTransactions} = require('./../../');
 const {getUtxos} = require('./../../');

package/test/integration/test_get_invoice.js

@@ -2,7 +2,6 @@ const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {createInvoice} = require('./../../');
-const {getHeight} = require('./../../');
 const {getInvoice} = require('./../../');
 const {pay} = require('./../../');
 const {setupChannel} = require('./../macros');

package/test/integration/test_get_node.js

@@ -1,3 +1,4 @@
+const asyncRetry = require('async/retry');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
@@ -15,8 +16,10 @@ const confirmationCount = 20;
 const defaultFee = 1e3;
 const defaultAliasLength = '00000000000000000000'.length;
 const feeRate = 21;
+const interval = 10;
 const mtokPerTok = BigInt(1e3);
 const size = 3;
+const times = 1000;
 
 // Getting a node should return the public graph node info
 test(`Get node`, async ({end, equal, strictSame}) => {
@@ -42,7 +45,16 @@ test(`Get node`, async ({end, equal, strictSame}) => {
       transaction_vout: controlToTarget.transaction_vout,
     });
 
-    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+    await asyncRetry({interval, times}, async () => {
+      await addPeer({
+        lnd,
+        public_key: remote.id,
+        retry_count: 1,
+        retry_delay: 1,
+        socket: remote.socket,
+        timeout: 1000,
+      });
+    });
 
     await delay(3000);
 

package/test/integration/test_get_peers.js

@@ -15,27 +15,38 @@ test('Get peers', async ({end, equal}) => {
 
   const [{lnd}, target] = nodes;
 
-  await asyncRetry({interval, times}, async () => {
-    await addPeer({lnd, public_key: target.id, socket: target.socket});
-
-    const [peer] = (await getPeers({lnd})).peers;
-
-    if (!peer || !peer.is_sync_peer) {
-      throw new Error('ExpectedSyncPeer');
-    }
-
-    equal(peer.bytes_received !== undefined, true, 'Bytes received');
-    equal(peer.bytes_sent !== undefined, true, 'Bytes sent');
-    equal(peer.is_inbound, false, 'Is inbound peer');
-    equal(peer.is_sync_peer, true, 'Is sync peer');
-    equal(peer.ping_time, 0, 'Ping time');
-    equal(peer.public_key, target.id, 'Public key');
-    equal(!!peer.socket, true, 'Socket');
-    equal(peer.tokens_received, 0, 'Tokens received');
-    equal(peer.tokens_sent, 0, 'Tokens sent');
-
-    return;
-  });
+  try {
+    await asyncRetry({interval, times}, async () => {
+      await addPeer({
+        lnd,
+        public_key: target.id,
+        retry_count: 1,
+        retry_delay: 1,
+        socket: target.socket,
+        timeout: 100,
+      });
+
+      const [peer] = (await getPeers({lnd})).peers;
+
+      if (!peer || !peer.is_sync_peer) {
+        throw new Error('ExpectedSyncPeer');
+      }
+
+      equal(peer.bytes_received !== undefined, true, 'Bytes received');
+      equal(peer.bytes_sent !== undefined, true, 'Bytes sent');
+      equal(peer.is_inbound, false, 'Is inbound peer');
+      equal(peer.is_sync_peer, true, 'Is sync peer');
+      equal(peer.ping_time, 0, 'Ping time');
+      equal(peer.public_key, target.id, 'Public key');
+      equal(!!peer.socket, true, 'Socket');
+      equal(peer.tokens_received, 0, 'Tokens received');
+      equal(peer.tokens_sent, 0, 'Tokens sent');
+
+      return;
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  }
 
   await kill({});
 

package/test/integration/test_get_pending_force.js

@@ -178,7 +178,7 @@ test(`Get pending channels`, async ({end, equal}) => {
   equal(forceClose.received, 0, 'No receive amount');
   equal(forceClose.recovered_tokens, undefined, 'No recovered amount');
 
-  // LND 0.14.1 and below do not support remote balance info
+  // LND 0.14.2 and below do not support remote balance info
   if (!!forceClose.remote_balance) {
     equal(forceClose.remote_balance, giftTokens, 'Got gift remote balance');
   } else {

package/test/integration/test_get_wallet_info.js

@@ -12,34 +12,40 @@ const times = 1000;
 const walletInfoType = 'wallet';
 
 // Getting the wallet info should return info about the wallet
-test(`Get wallet info`, async ({end, equal, strictSame}) => {
+test(`Get wallet info`, async ({end, equal, ok, strictSame}) => {
   const {kill, nodes} = await spawnLightningCluster({});
 
-  const [{lnd}] = nodes;
-
-  const result = await getWalletInfo({lnd});
-
-  await asyncRetry({interval, times}, async () => {
-    if (result.current_block_height === initHeight) {
-      return;
-    }
-
-    throw new Error('ExpectedBlockHeightAtInitHeight');
-  });
-
-  equal(result.active_channels_count, 0, 'Expected channels count');
-  equal(!!result.alias, true, 'Expected alias');
-  strictSame(result.chains, [regtestChainId], 'Got chains');
-  equal(!!result.current_block_hash, true, 'Expected best block hash');
-  equal(result.current_block_height, initHeight, 'Expected best block height');
-  equal(!!result.latest_block_at, true, 'Last block time');
-  equal(result.peers_count, 0, 'Expected wallet peers count');
-  equal(result.pending_channels_count, 0, 'Expected pending channels count');
-  equal(result.public_key.length, pubKeyHexLength, 'Expected public key');
-  strictSame(result.uris.length, 1, 'Expected node URI');
-  equal(!!result.version, true, 'Expected version');
-
-  await kill({});
+  const [{generate, lnd}] = nodes;
+
+  try {
+    const result = await asyncRetry({interval, times}, async () => {
+      await generate({});
+
+      const result = await getWalletInfo({lnd});
+
+      if (result.current_block_height >= initHeight) {
+        return result;
+      }
+
+      throw new Error('ExpectedBlockHeightAtInitHeight');
+    });
+
+    equal(result.active_channels_count, 0, 'Expected channels count');
+    equal(!!result.alias, true, 'Expected alias');
+    strictSame(result.chains, [regtestChainId], 'Got chains');
+    equal(!!result.current_block_hash, true, 'Expected best block hash');
+    ok(result.current_block_height >= initHeight, 'Expected block height');
+    equal(!!result.latest_block_at, true, 'Last block time');
+    equal(result.peers_count, 0, 'Expected wallet peers count');
+    equal(result.pending_channels_count, 0, 'Expected pending channels count');
+    equal(result.public_key.length, pubKeyHexLength, 'Expected public key');
+    strictSame(result.uris.length, 1, 'Expected node URI');
+    equal(!!result.version, true, 'Expected version');
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  } finally {
+    await kill({});
+  }
 
   return end();
 });

package/test/integration/test_open_channels.js

@@ -4,6 +4,7 @@ const {extractTransaction} = require('psbt');
 const {finalizePsbt} = require('psbt');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
+const tinysecp = require('tiny-secp256k1');
 const {transactionAsPsbt} = require('psbt');
 
 const {addPeer} = require('./../../');
@@ -29,27 +30,29 @@ const times = 2000;
 
 // Opening channels should open up channels
 test(`Open channels`, async ({end, equal}) => {
+  const ecp = (await import('ecpair')).ECPairFactory(tinysecp);
+
   const {kill, nodes} = await spawnLightningCluster({size});
 
   const [{generate, lnd}, target, remote] = nodes;
 
-  await generate({count: maturity});
+  try {
+    await generate({count: maturity});
 
-  await asyncRetry({interval, times}, async () => {
-    const lnds = [lnd, target.lnd, remote.lnd];
+    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 heights = await asyncMap(lnds, async lnd => {
+        return (await getHeight({lnd})).current_block_height;
+      });
 
-    const [controlHeight, targetHeight, remoteHeight] = heights;
+      const [controlHeight, targetHeight, remoteHeight] = heights;
 
-    if (controlHeight !== targetHeight || controlHeight !== remoteHeight) {
-      throw new Error('ExpectedSyncHeights');
-    }
-  });
+      if (controlHeight !== targetHeight || controlHeight !== remoteHeight) {
+        throw new Error('ExpectedSyncHeights');
+      }
+    });
 
-  try {
     const chainTx = (await getChainTransactions({lnd})).transactions;
 
     const spending = chainTx.map(({transaction}) => transaction);
@@ -97,11 +100,15 @@ test(`Open channels`, async ({end, equal}) => {
       .map(({transaction}) => transaction)
       .find(transaction => spending.find(spend => transaction !== spend));
 
-    const fundingPsbt = transactionAsPsbt({spending, transaction: fundTx});
+    const fundingPsbt = transactionAsPsbt({
+      ecp,
+      spending,
+      transaction: fundTx,
+    });
 
-    const {psbt} = finalizePsbt({psbt: fundingPsbt.psbt});
+    const {psbt} = finalizePsbt({ecp, psbt: fundingPsbt.psbt});
 
-    const reconstitutedTransaction = extractTransaction({psbt});
+    const reconstitutedTransaction = extractTransaction({ecp, psbt});
 
     await fundPendingChannels({
       lnd,

package/test/integration/test_pay.js

@@ -10,7 +10,6 @@ const {createInvoice} = require('./../../');
 const {decodePaymentRequest} = require('./../../');
 const {delay} = require('./../macros');
 const {getChannel} = require('./../../');
-const {getChannels} = require('./../../');
 const {getHeight} = require('./../../');
 const {getNetworkGraph} = require('./../../');
 const {getRouteToDestination} = require('./../../');

package/test/integration/test_pay_private_invoice.js

@@ -8,7 +8,6 @@ const {cancelHodlInvoice} = require('./../../');
 const {createInvoice} = require('./../../');
 const {decodePaymentRequest} = require('./../../');
 const {getChannel} = require('./../../');
-const {getChannels} = require('./../../');
 const {getInvoice} = require('./../../');
 const {getRouteToDestination} = require('./../../');
 const {openChannel} = require('./../../');