ln-service 53.7.3 → 53.9.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Versions
 
+## 53.9.1
+
+- `getPendingPayments`: Add method to get payments in flight
+
+## 53.8.1
+
+- `fundPsbt`: Fix bip32 key derivation error
+
+## 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
@@ -169,6 +170,7 @@ for `unlocker` methods.
 - [getPeers](#getpeers) - Get all connected peers
 - [getPendingChainBalance](#getpendingchainbalance) - Get pending chain balance
 - [getPendingChannels](#getpendingchannels) - Get channels in pending states
+- [getPendingPayments](#getpendingpayments) - Get in-flight outgoing payments
 - [getPublicKey](#getpublickey) - Get a public key out of the seed
 - [getRouteConfidence](#getrouteconfidence) - Get confidence in a route
 - [getRouteThroughHops](#getroutethroughhops) - Get a route through nodes
@@ -2102,6 +2104,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
@@ -2626,6 +2663,98 @@ const {getPendingChannels} = require('ln-service');
 const pendingChannels = (await getPendingChannels({lnd})).pending_channels;
 ```
 
+### getPendingPayments
+
+Get pending payments made through channels.
+
+Requires `offchain:read` permission
+
+    {
+      [limit]: <Page Result Limit Number>
+      lnd: <Authenticated LND API Object>
+      [token]: <Opaque Paging Token String>
+    }
+
+    @returns via cbk or Promise
+    {
+      payments: [{
+        attempts: [{
+          [failure]: {
+            code: <Error Type Code Number>
+            [details]: {
+              [channel]: <Standard Format Channel Id String>
+              [height]: <Error Associated Block Height Number>
+              [index]: <Failed Hop Index Number>
+              [mtokens]: <Error Millitokens String>
+              [policy]: {
+                base_fee_mtokens: <Base Fee Millitokens String>
+                cltv_delta: <Locktime Delta Number>
+                fee_rate: <Fees Charged in Millitokens Per Million Number>
+                [is_disabled]: <Channel is Disabled Bool>
+                max_htlc_mtokens: <Maximum HLTC Millitokens Value String>
+                min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
+                updated_at: <Updated At ISO 8601 Date String>
+              }
+              [timeout_height]: <Error CLTV Timeout Height Number>
+              [update]: {
+                chain: <Chain Id Hex String>
+                channel_flags: <Channel Flags Number>
+                extra_opaque_data: <Extra Opaque Data Hex String>
+                message_flags: <Message Flags Number>
+                signature: <Channel Update Signature Hex String>
+              }
+            }
+            message: <Error Message String>
+          }
+          [index]: <Payment Add Index Number>
+          [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+          is_confirmed: <Payment Attempt Succeeded Bool>
+          is_failed: <Payment Attempt Failed Bool>
+          is_pending: <Payment Attempt is Waiting For Resolution Bool>
+          route: {
+            fee: <Route Fee Tokens Number>
+            fee_mtokens: <Route Fee Millitokens String>
+            hops: [{
+              channel: <Standard Format Channel Id String>
+              channel_capacity: <Channel Capacity Tokens Number>
+              fee: <Fee Number>
+              fee_mtokens: <Fee Millitokens String>
+              forward: <Forward Tokens Number>
+              forward_mtokens: <Forward Millitokens String>
+              [public_key]: <Forward Edge Public Key Hex String>
+              [timeout]: <Timeout Block Height Number>
+            }]
+            mtokens: <Total Fee-Inclusive Millitokens String>
+            [payment]: <Payment Identifier Hex String>
+            timeout: <Timeout Block Height Number>
+            tokens: <Total Fee-Inclusive Tokens Number>
+            [total_mtokens]: <Total Millitokens String>
+          }
+        }]
+        created_at: <Payment at ISO-8601 Date String>
+        [destination]: <Destination Node Public Key Hex String>
+        id: <Payment Preimage Hash String>
+        [index]: <Payment Add Index Number>
+        is_confirmed: <Payment is Confirmed Bool>
+        is_outgoing: <Transaction Is Outgoing Bool>
+        mtokens: <Millitokens Attempted to Pay to Destination String>
+        [request]: <BOLT 11 Payment Request String>
+        safe_tokens: <Payment Tokens Attempted to Pay Rounded Up Number>
+        tokens: <Rounded Down Tokens Attempted to Pay to Destination Number>
+      }]
+      [next]: <Next Opaque Paging Token String>
+    }
+
+```node
+const {getPendingPayments} = require('ln-service')
+
+const {next, payments} = await getPendingPayments({lnd});
+
+if (!next) {
+  const inFlightPaymentsCount = payments.length;
+}
+```
+
 ### getPublicKey
 
 Get a public key in the seed

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');
@@ -60,6 +61,7 @@ const {getPayments} = require('lightning');
 const {getPeers} = require('lightning');
 const {getPendingChainBalance} = require('lightning');
 const {getPendingChannels} = require('lightning');
+const {getPendingPayments} = require('lightning');
 const {getPublicKey} = require('lightning');
 const {getRouteConfidence} = require('lightning');
 const {getRouteThroughHops} = require('lightning');
@@ -189,6 +191,7 @@ module.exports = {
   getInvoice,
   getInvoices,
   getLockedUtxos,
+  getMasterPublicKeys,
   getMethods,
   getNetworkCentrality,
   getNetworkGraph,
@@ -200,6 +203,7 @@ module.exports = {
   getPeers,
   getPendingChainBalance,
   getPendingChannels,
+  getPendingPayments,
   getPublicKey,
   getRouteConfidence,
   getRouteThroughHops,

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.8.1",
     "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.9.1"
 }

package/test/integration/test_get_pending_payments.js

@@ -0,0 +1,87 @@
+const {once} = require('events');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {addPeer} = require('./../../');
+const {createCluster} = require('./../macros');
+const {createInvoice} = require('./../../');
+const {deleteForwardingReputations} = require('./../../');
+const {getHeight} = require('./../../');
+const {getInvoice} = require('./../../');
+const {getPayment} = require('./../../');
+const {getPendingPayments} = require('./../../');
+const {payViaPaymentRequest} = require('./../../');
+const {subscribeToForwardRequests} = require('./../../');
+const {subscribeToPayViaRequest} = require('./../../');
+const {setupChannel} = require('./../macros');
+const {waitForRoute} = require('./../macros');
+
+const size = 3;
+const tokens = 100;
+
+// Getting pending payments should list out payments in flight
+test(`Get pending payments`, async ({end, equal, rejects, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [{generate, lnd}, target, remote] = nodes;
+
+  const channel = await setupChannel({generate, lnd, to: target});
+
+  await remote.generate({count: 100});
+
+  const remoteChan = await setupChannel({
+    lnd: target.lnd,
+    generate: target.generate,
+    to: remote,
+  });
+
+  await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+  const {routes} = await waitForRoute({lnd, tokens, destination: remote.id});
+
+  let height;
+  const [route] = routes;
+
+  {
+    const invoice = await createInvoice({tokens, lnd: remote.lnd});
+
+    const sub = subscribeToForwardRequests({lnd: target.lnd});
+
+    sub.once('forward_request', async forward => {
+      const {pending} = await getPayment({lnd, id: invoice.id});
+
+      const {next, payments} = await getPendingPayments({lnd});
+
+      strictSame(next, undefined, 'No more pages');
+      strictSame(payments.length, 1, 'A single pending payment');
+
+      const [payment] = payments;
+
+      strictSame(payment.destination, remote.id, 'Paying to remote');
+      strictSame(payment.index, 1, 'First payment');
+      strictSame(payment.request, invoice.request, 'Paying invoice request');
+      strictSame(payment.confirmed_at, undefined, 'Not a confirmed payment');
+      strictSame(!!payment.created_at, true, 'Has created date');
+      strictSame(payment.fee, undefined, 'No fee yet');
+      strictSame(payment.fee_mtokens, undefined, 'No fee mtokens');
+      strictSame(payment.hops.length, 1, 'Going through hops');
+      strictSame(payment.id, invoice.id, 'Paying to the same hash');
+      strictSame(payment.is_confirmed, false, 'Payment is pending');
+      strictSame(payment.is_outgoing, true, 'Outgoing payment type');
+      strictSame(payment.mtokens, invoice.mtokens, 'Paying invoiced mtokens');
+      strictSame(payment.safe_fee, undefined, 'No fee paid yet');
+      strictSame(payment.safe_tokens, invoice.tokens, 'Paying safe tokens');
+      strictSame(payment.secret, undefined, 'Preimage not yet known');
+      strictSame(payment.tokens, invoice.tokens, 'Paying invoiced tokens');
+
+      return forward.accept();
+    });
+
+    await payViaPaymentRequest({lnd, request: invoice.request});
+  }
+
+  await kill({});
+
+  return end();
+});

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,