lightning 5.5.0 → 5.6.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.6.3
+
+- `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
+
 ## 5.5.0
 
 - `partiallySignPsbt`: Add method to partially sign a PSBT

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/info/constants.json

@@ -20,6 +20,7 @@
   "versions": {
     "0d5b0fefa4d9082f7964836f5e58c3a6bda8e471": "0.10.2-beta",
     "1a3194d302f33bb52823297d9d7f75cd37516053": "0.10.0-beta",
+    "1e511be523eb8e97c4e2d9c89a7a263963a3929f": "0.14.2-beta",
     "3ae46d81f4a2edad06ef778b2940d9b06386d93b": "0.11.0-beta",
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",
     "52bb3f33707b81972c67937c7a89addcdf00991c": "0.10.1-beta",

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/offchain/pay_via_routes.d.ts

@@ -27,6 +27,12 @@ export type PayViaRoutesArgs = AuthenticatedLightningArgs<{
       forward: number;
       /** Forward Millitokens */
       forward_mtokens: string;
+      messages?: {
+        /** Message Type number */
+        type: string;
+        /** Message Raw Value Hex Encoded */
+        value: string;
+      }[];
       /** Public Key Hex */
       public_key?: string;
       /** Timeout Block Height */

package/lnd_methods/offchain/pay_via_routes.js

@@ -29,6 +29,10 @@ const notFound = -1;
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         [public_key]: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_methods/offchain/subscribe_to_pay_via_routes.js

@@ -43,6 +43,10 @@ const unknownWireError = 'unknown wire error';
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         public_key: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_methods/onchain/fund_psbt.js

@@ -1,6 +1,7 @@
 const asyncAuto = require('async/auto');
 const {decodePsbt} = require('psbt');
 const {returnResult} = require('asyncjs-util');
+const tinysecp = require('tiny-secp256k1');
 const {Transaction} = require('bitcoinjs-lib');
 
 const {isLnd} = require('./../../lnd_requests');
@@ -67,6 +68,9 @@ const txIdFromHash = hash => hash.reverse().toString('hex');
 module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
+      // Import ECPair library
+      ecp: async () => (await import('ecpair')).ECPairFactory(tinysecp),
+
       // Check arguments
       validate: cbk => {
         if (!isLnd({method, type, lnd: args.lnd})) {
@@ -201,11 +205,11 @@ module.exports = (args, cbk) => {
       }],
 
       // Derive the raw transaction from the funded PSBT
-      tx: ['fund', ({fund}, cbk) => {
+      tx: ['fund', ({ecp, fund}, cbk) => {
         const {psbt} = fund;
 
         try {
-          const tx = fromHex(decodePsbt({psbt}).unsigned_transaction);
+          const tx = fromHex(decodePsbt({ecp, psbt}).unsigned_transaction);
 
           return cbk(null, tx);
         } catch (err) {

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/lnd_methods/onchain/partially_sign_psbt.d.ts

@@ -20,7 +20,7 @@ export type PartiallySignPsbtResult = {
  *
  * 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
  */
 export const partiallySignPsbt: AuthenticatedLightningMethod<
   PartiallySignPsbtArgs,

package/lnd_methods/onchain/partially_sign_psbt.js

@@ -16,7 +16,7 @@ const type = 'wallet';
 
   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/lnd_requests/rpc_hop_from_hop.js

@@ -1,5 +1,6 @@
 const {chanNumber} = require('bolt07');
 
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const isNumber = n => !isNaN(n);
 const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
 
@@ -12,6 +13,10 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     fee_mtokens: <Fee Millitokens String>
     forward: <Forward Tokens Number>
     forward_mtokens: <Forward Millitokens String>
+    [messages]: [{
+      type: <Message Type Number String>
+      value: <Message Raw Value Hex Encoded String>
+    }]
     [public_key]: <Forward Edge Public Key Hex String>
     timeout: <Timeout Block Height Number>
   }
@@ -25,10 +30,12 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     amt_to_forward_msat: <Millitokens to Forward String>
     chan_id: <Numeric Format Channel Id String>
     chan_capacity: <Channel Capacity Number>
+    [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
     expiry: <Timeout Chain Height Number>
     fee: <Fee in Tokens Number>
     fee_msat: <Fee in Millitokens String>
     [pub_key]: <Next Hop Public Key Hex String>
+    [tlv_payload]: <Has Extra TLV Data Bool>
   }
 */
 module.exports = args => {
@@ -44,7 +51,7 @@ module.exports = args => {
     throw new Error('ExpectedFeeMillitokensToMapRpcHopFromHop');
   }
 
-  return {
+  const hop = {
     amt_to_forward: millitokensAsTokens(args.forward_mtokens).toString(),
     amt_to_forward_msat: args.forward_mtokens,
     chan_id: chanNumber({channel: args.channel}).number,
@@ -54,4 +61,21 @@ module.exports = args => {
     fee_msat: args.fee_mtokens,
     pub_key: args.public_key,
   };
+
+  // Exit early when there are no messages to encode in this hop
+  if (!args.messages || !args.messages.length) {
+    return hop;
+  }
+
+  // Set custom TLV payload records for this hop
+  hop.tlv_payload = true;
+
+  hop.custom_records = args.messages.reduce((tlv, n) => {
+    tlv[n.type] = hexAsBuffer(n.value);
+
+    return tlv;
+  },
+  {});
+
+  return hop;
 };

package/lnd_requests/rpc_route_from_route.js

@@ -14,6 +14,10 @@ const isNumber = n => !isNaN(n);
       fee_mtokens: <Fee Millitokens String>
       forward: <Forward Tokens Number>
       forward_mtokens: <Forward Millitokens String>
+      [messages]: [{
+        type: <Message Type Number String>
+        value: <Message Raw Value Hex Encoded String>
+      }]
       [public_key]: <Forward Edge Public Key Hex String>
       timeout: <Timeout Block Height Number>
     }]
@@ -38,6 +42,7 @@ const isNumber = n => !isNaN(n);
       amt_to_forward_msat: <Millitokens to Forward String>
       chan_id: <Numeric Format Channel Id String>
       chan_capacity: <Channel Capacity Number>
+      [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
       expiry: <Timeout Chain Height Number>
       fee: <Fee in Tokens Number>
       fee_msat: <Fee in Millitokens Number>
@@ -79,7 +84,7 @@ module.exports = args => {
     };
   }
 
-  // Set custom TLV payload records
+  // Set custom TLV payload records on the final hop
   if (!!args.messages && !!args.messages.length) {
     hops[finalHopIndex].tlv_payload = true;
 
@@ -88,7 +93,7 @@ module.exports = args => {
 
       return tlv;
     },
-    {});
+    hops[finalHopIndex].custom_records || {});
   }
 
   return {

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.3",
+    "@grpc/grpc-js": "1.5.4",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.13",
+    "@types/node": "17.0.16",
     "@types/request": "2.48.8",
     "@types/ws": "8.2.2",
     "async": "3.2.3",
@@ -21,10 +21,12 @@
     "bolt07": "1.8.0",
     "bolt09": "0.2.1",
     "cbor": "8.1.0",
+    "ecpair": "2.0.1",
     "express": "4.17.2",
-    "invoices": "2.0.3",
-    "psbt": "1.1.11",
-    "type-fest": "2.11.0"
+    "invoices": "2.0.4",
+    "psbt": "2.0.0",
+    "tiny-secp256k1": "2.2.0",
+    "type-fest": "2.11.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -32,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"
@@ -57,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.5.0"
+  "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();
+  });
+});

package/test/lnd_requests/test_rpc_hop_from_hop.js

@@ -41,6 +41,32 @@ const tests = [
       pub_key: 'public_key',
     },
   },
+  {
+    args: {
+      channel: '0x0x1',
+      channel_capacity: 1,
+      fee: 1,
+      fee_mtokens: '1000',
+      forward: '1',
+      forward_mtokens: '1000',
+      messages: [{type: '12', value: '34'}],
+      public_key: 'public_key',
+      timeout: 1,
+    },
+    description: 'Hop is mapped to RPC hop',
+    expected: {
+      amt_to_forward: '1',
+      amt_to_forward_msat: '1000',
+      chan_id: '1',
+      chan_capacity: '1',
+      custom_records: {'12': Buffer.from('34', 'hex')},
+      expiry: 1,
+      fee: '1',
+      fee_msat: '1000',
+      pub_key: 'public_key',
+      tlv_payload: true,
+    },
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {