lightning 5.6.2 → 5.6.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 5.6.2
+## 5.6.3
 
 - `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
 

package/README.md

@@ -42,8 +42,8 @@ Run `base64` on the tls.cert and admin.macaroon files to get the encoded
 authentication data to create the LND connection. You can find these files in
 the LND directory. (~/.lnd or ~/Library/Application Support/Lnd)
 
-    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:
 

package/index.js

@@ -48,6 +48,7 @@ const {getIdentity} = require('./lnd_methods');
 const {getInvoice} = require('./lnd_methods');
 const {getInvoices} = require('./lnd_methods');
 const {getLockedUtxos} = require('./lnd_methods');
+const {getMasterPublicKeys} = require('./lnd_methods');
 const {getMethods} = require('./lnd_methods');
 const {getNetworkCentrality} = require('./lnd_methods');
 const {getNetworkGraph} = require('./lnd_methods');
@@ -186,6 +187,7 @@ module.exports = {
   getInvoice,
   getInvoices,
   getLockedUtxos,
+  getMasterPublicKeys,
   getMethods,
   getNetworkCentrality,
   getNetworkGraph,

package/lnd_methods/index.js

@@ -46,6 +46,7 @@ const {getIdentity} = require('./info');
 const {getInvoice} = require('./invoices');
 const {getInvoices} = require('./invoices');
 const {getLockedUtxos} = require('./onchain');
+const {getMasterPublicKeys} = require('./onchain');
 const {getMethods} = require('./info');
 const {getNetworkCentrality} = require('./info');
 const {getNetworkGraph} = require('./info');
@@ -180,6 +181,7 @@ module.exports = {
   getInvoice,
   getInvoices,
   getLockedUtxos,
+  getMasterPublicKeys,
   getMethods,
   getNetworkCentrality,
   getNetworkGraph,

package/lnd_methods/macaroon/methods.json

@@ -181,6 +181,10 @@
     "method": "ListLeases",
     "type": "wallet"
   },
+  "getMasterPublicKeys": {
+    "method": "ListAccounts",
+    "type": "wallet"
+  },
   "getMethods": {
     "method": "ListPermissions",
     "type": "default"

package/lnd_methods/onchain/get_master_public_keys.js

@@ -0,0 +1,83 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const {isArray} = Array;
+const method = 'listAccounts';
+const notSupported = /unknown.*walletrpc.WalletKit/;
+const type = 'wallet';
+
+/** 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>
+    }]
+  }
+*/
+module.exports = ({lnd}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedAuthenticatedLndToGetMasterPublicKeys']);
+        }
+
+        return cbk();
+      },
+
+      // Get master public keys
+      getKeys: ['validate', ({}, cbk) => {
+        return lnd[type][method]({}, (err, res) => {
+          if (!!err && notSupported.test(err.details)) {
+            return cbk([501, 'GetMasterPublicKeysMethodNotSupported']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorGettingMasterPublicKeys', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedResultForMasterPublicKeyListRequest']);
+          }
+
+          if (!isArray(res.accounts)) {
+            return cbk([503, 'ExpectedArrayOfAccountsInMasterPublicKeysList']);
+          }
+
+          const keys = res.accounts
+            .filter(account => !!account.extended_public_key)
+            .map(account => ({
+              derivation_path: account.derivation_path,
+              extended_public_key: account.extended_public_key,
+              external_key_count: account.external_key_count,
+              internal_key_count: account.internal_key_count,
+              is_watch_only: account.watch_only,
+              named: account.name,
+            }));
+
+          return cbk(null, {keys});
+        });
+      }],
+    },
+    returnResult({reject, resolve, of: 'getKeys'}, cbk));
+  });
+};

package/lnd_methods/onchain/index.js

@@ -8,6 +8,7 @@ const getChainFeeEstimate = require('./get_chain_fee_estimate');
 const getChainFeeRate = require('./get_chain_fee_rate');
 const getChainTransactions = require('./get_chain_transactions');
 const getLockedUtxos = require('./get_locked_utxos');
+const getMasterPublicKeys = require('./get_master_public_keys');
 const getPendingChainBalance = require('./get_pending_chain_balance');
 const getSweepTransactions = require('./get_sweep_transactions');
 const getUtxos = require('./get_utxos');
@@ -41,6 +42,7 @@ module.exports = {
   getChainFeeRate,
   getChainTransactions,
   getLockedUtxos,
+  getMasterPublicKeys,
   getPendingChainBalance,
   getSweepTransactions,
   getUtxos,

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.5.4",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.15",
+    "@types/node": "17.0.16",
     "@types/request": "2.48.8",
     "@types/ws": "8.2.2",
     "async": "3.2.3",
@@ -23,7 +23,7 @@
     "cbor": "8.1.0",
     "ecpair": "2.0.1",
     "express": "4.17.2",
-    "invoices": "2.0.3",
+    "invoices": "2.0.4",
     "psbt": "2.0.0",
     "tiny-secp256k1": "2.2.0",
     "type-fest": "2.11.1"
@@ -34,7 +34,7 @@
     "@alexbosworth/tap": "15.0.10",
     "tsd": "0.19.1",
     "typescript": "4.5.5",
-    "ws": "8.4.2"
+    "ws": "8.5.0"
   },
   "engines": {
     "node": ">=12.20"
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.6.2"
+  "version": "5.6.3"
 }

package/test/lnd_methods/onchain/test_get_master_public_keys.js

@@ -0,0 +1,94 @@
+const {test} = require('@alexbosworth/tap');
+
+const {getMasterPublicKeys} = require('./../../../lnd_methods');
+
+const makeExpected = overrides => {
+  const res = {
+    derivation_path: 'derivation_path',
+    extended_public_key: 'extended_public_key',
+    external_key_count: 0,
+    internal_key_count: 1,
+    is_watch_only: true,
+    named: 'name',
+  };
+
+  Object.keys(overrides).forEach(k => res[k] = overrides[k]);
+
+  return {keys: [res]};
+};
+
+const makeLnd = overrides => {
+  return {
+    wallet: {
+      listAccounts: ({}, cbk) => {
+        const account = {
+          derivation_path: 'derivation_path',
+          extended_public_key: 'extended_public_key',
+          external_key_count: 0,
+          internal_key_count: 1,
+          name: 'name',
+          watch_only: true,
+        };
+
+        Object.keys(overrides).forEach(k => account[k] = overrides[k]);
+
+        return cbk(null, {accounts: [account]});
+      },
+    },
+  };
+};
+
+const tests = [
+  {
+    args: {},
+    description: 'LND Object is required to get master public keys',
+    error: [400, 'ExpectedAuthenticatedLndToGetMasterPublicKeys'],
+  },
+  {
+    args: {
+      lnd: {
+        wallet: {
+          listAccounts: ({}, cbk) => cbk({
+            details: 'unknown walletrpc.WalletKit',
+          }),
+        },
+      },
+    },
+    description: 'LND unsupported errors are passed back',
+    error: [501, 'GetMasterPublicKeysMethodNotSupported'],
+  },
+  {
+    args: {lnd: {wallet: {listAccounts: ({}, cbk) => cbk('err')}}},
+    description: 'LND errors are passed back',
+    error: [503, 'UnexpectedErrorGettingMasterPublicKeys', {err: 'err'}],
+  },
+  {
+    args: {lnd: {wallet: {listAccounts: ({}, cbk) => cbk()}}},
+    description: 'A response is expected',
+    error: [503, 'ExpectedResultForMasterPublicKeyListRequest'],
+  },
+  {
+    args: {lnd: {wallet: {listAccounts: ({}, cbk) => cbk(null, {})}}},
+    description: 'A response with accounts is expected',
+    error: [503, 'ExpectedArrayOfAccountsInMasterPublicKeysList'],
+  },
+  {
+    args: {lnd: makeLnd({})},
+    description: 'Get a list of master public keys',
+    expected: makeExpected({}),
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async ({end, rejects, strictSame}) => {
+    if (!!error) {
+      await rejects(() => getMasterPublicKeys(args), error, 'Got error');
+    } else {
+      const {keys} = await getMasterPublicKeys(args);
+
+      strictSame(keys, expected.keys, 'Got keys');
+    }
+
+    return end();
+  });
+});