ln-service 53.7.3 → 53.8.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 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

@@ -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

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');
@@ -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.2",
+    "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,9 +22,11 @@
     "@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.4",
     "portfinder": "1.0.28",
@@ -66,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.3"
+  "version": "53.8.0"
 }

package/test/integration/test_send_to_chain_address.js

@@ -78,6 +78,10 @@ test(`Send to chain address`, async ({end, equal}) => {
           lnd: control.lnd,
         });
 
+        if (!!(await getChainBalance({lnd: control.lnd})).chain_balance) {
+          throw new Error('ExpectedChainBalanceOnControlEmptiedOut');
+        }
+
         return;
       });
 

package/test/walletrpc-integration/test_get_master_public_keys.js

@@ -0,0 +1,79 @@
+const bip32 = require('bip32');
+const bs58check = require('bs58check');
+const ecc = require('tiny-secp256k1')
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {createChainAddress} = require('./../../');
+const {getMasterPublicKeys} = require('./../../');
+
+const asHex = n => n.toString('hex');
+const BIP32Factory = bip32.default;
+const chainCodeFromMasterPublicKey = n => n.slice(13, 45);
+const firstKeyPath = 'm/0/0';
+const identityKeyName = 'act:6';
+const p2wpkhPath = `m/84'/0'/0'`;
+const publicKeyFromMasterPublicKey = n => n.slice(45, 78);
+
+// Getting master public keys should return a list of master public keys
+test(`Get master public keys`, async ({end, equal, strictSame}) => {
+  const [{id, kill, lnd}] = (await spawnLightningCluster({})).nodes;
+
+  const {fromPublicKey} = await BIP32Factory(ecc);
+
+  // This method is not supported on LND 0.13.3 and below
+  try {
+    const {keys} = await getMasterPublicKeys({lnd});
+
+    const [,, key] = keys;
+
+    // Check if extended keys are available
+    if (!key) {
+      await kill({});
+
+      return end();
+    }
+  } catch (err) {
+    strictSame(err, [501, 'GetMasterPublicKeysMethodNotSupported'], 'Got err');
+
+    await kill({});
+
+    return end();
+  }
+
+  try {
+    // Make a new address
+    const {address} = await createChainAddress({lnd});
+
+    // Get the list of accounts
+    const {keys} = await getMasterPublicKeys({lnd});
+
+    const masterP2wpkhKey = keys.find(n => n.derivation_path === p2wpkhPath);
+
+    // The address creation is reflected in the accounts metadata
+    equal(masterP2wpkhKey.external_key_count, [address].length, 'Key is used');
+
+    // Find the identity key master public key
+    const masterIdentityKey = keys.find(n => n.named === identityKeyName);
+
+    // Convert the key from base58 into its raw form
+    const rawKey = bs58check.decode(masterIdentityKey.extended_public_key);
+
+    const chainCode = chainCodeFromMasterPublicKey(rawKey);
+    const publicKey = publicKeyFromMasterPublicKey(rawKey);
+
+    // Make a bip32 object to derive from
+    const masterKey = fromPublicKey(publicKey, chainCode);
+
+    // Pull out the first key from the identity master public key
+    const identityKey = masterKey.derivePath(firstKeyPath);
+
+    equal(asHex(identityKey.publicKey), id, 'Got identity master public key');
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/walletrpc-integration/test_partially_sign_psbt.js

@@ -158,6 +158,11 @@ test(`Partially sign PSBT`, async ({end, equal, strictSame}) => {
 
     const bip32Derivations = flatten(allDerivations);
 
+    // Exit early when derivations are not supported
+    if (!!bip32Derivations.filter(n => !n).length) {
+      await partiallySignPsbt({lnd: control.lnd, psbt: base.psbt});
+    }
+
     // Update the PSBT so that it has the consolidated details
     const updated = updatePsbt({
       ecp,