ln-service 53.5.2 → 53.7.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 53.7.2
+
+- `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
+
+## 53.6.0
+
+- `partiallySignPsbt`: Add method to add a partial signature to a PSBT
+
 ## 53.5.2
 
 - `getPayments`: Correct paging issue that prevented paging through all results

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
@@ -187,6 +187,7 @@ for `unlocker` methods.
 - [openChannel](#openchannel) - Open a new channel
 - [openChannels](#openchannels) - Open channels with external funding
 - [parsePaymentRequest](#parsepaymentrequest) - Parse a BOLT11 Payment Request
+- [partiallySignPsbt](#partiallysignpsbt) - Sign a PSBT without finalizing it
 - [pay](#pay) - Send a payment
 - [payViaPaymentDetails](#payviapaymentdetails) - Pay using decomposed details
 - [payViaPaymentRequest](#payviapaymentrequest) - Pay using a payment request
@@ -2529,7 +2530,7 @@ LND 0.11.1 and below do not return `last_reconnected` or `reconnection_rate`
         }]
         is_inbound: <Is Inbound Peer Bool>
         [is_sync_peer]: <Is Syncing Graph Data Bool>
-        [last_reconnected]: <Peer Last Reconnected At ISO 8601 Date String>
+        [last_reconnection]: <Peer Last Reconnected At ISO 8601 Date String>
         ping_time: <Ping Latency Milliseconds Number>
         public_key: <Node Identity Public Key String>
         [reconnection_rate]: <Count of Reconnections Over Time Number>
@@ -3392,6 +3393,46 @@ const {parsePaymentRequest} = require('ln-service');
 const requestDetails = parsePaymentRequest({request: 'paymentRequestString'});
 ```
 
+### partiallySignPsbt
+
+Sign a PSBT to produce a partially signed PSBT
+
+Requires `onchain:write` permission
+
+Requires LND built with `walletrpc` tag
+
+This method is not supported in LND 0.14.2 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+      psbt: <Funded PSBT Hex String>
+    }
+
+    @returns via cbk or Promise
+    {
+      psbt: <Partially Signed PSBT Hex String>
+    }
+
+
+Example:
+
+```node
+const {broadcastChainTransaction} = require('ln-service');
+const {fundPsbt, partiallySignPsbt} = require('ln-service');
+const {extractTransaction, finalizePsbt} = require('psbt');
+
+const funding = await fundPsbt({
+  lnd,
+  outputs: [{address: chainAddress, tokens: 100000}]
+})
+
+const finalize = finalizePsbt({psbt: funding.psbt});
+
+const {transaction} = extractTransaction({psbt: finalize.psbt});
+
+await broadcastChainTransaction({lnd, transaction});
+```
+
 ### pay
 
 Make a payment.
@@ -3665,6 +3706,10 @@ Requires `offchain:write` permission
           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>
         }]
@@ -5651,6 +5696,10 @@ Requires `offchain:write` permission
           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/index.js

@@ -76,6 +76,7 @@ const {lockUtxo} = require('lightning');
 const {openChannel} = require('lightning');
 const {openChannels} = require('lightning');
 const {parsePaymentRequest} = require('invoices');
+const {partiallySignPsbt} = require('lightning');
 const {pay} = require('lightning');
 const {payViaPaymentDetails} = require('lightning');
 const {payViaPaymentRequest} = require('lightning');
@@ -90,7 +91,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');
@@ -117,7 +118,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');
@@ -215,6 +216,7 @@ module.exports = {
   openChannel,
   openChannels,
   parsePaymentRequest,
+  partiallySignPsbt,
   pay,
   payViaPaymentDetails,
   payViaPaymentRequest,

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.17.2",
     "invoices": "2.0.3",
-    "lightning": "5.4.0",
+    "lightning": "5.6.1",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.4.2"
@@ -26,9 +26,9 @@
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.2.0",
+    "ln-docker-daemons": "2.2.4",
     "portfinder": "1.0.28",
-    "psbt": "1.1.10",
+    "psbt": "2.0.0",
     "rimraf": "3.0.2",
     "secp256k1": "4.0.3",
     "tiny-secp256k1": "2.2.0",
@@ -53,7 +53,18 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
-    "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"
+    "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",
+    "integration-test-0.13.3": "DOCKER_LND_VERSION=v0.13.3-beta npm run test",
+    "integration-test-0.13.2": "DOCKER_LND_VERSION=v0.13.2-beta npm run test",
+    "integration-test-0.13.1": "DOCKER_LND_VERSION=v0.13.1-beta npm run test",
+    "integration-test-0.13.0": "DOCKER_LND_VERSION=v0.13.0-beta npm run test",
+    "integration-test-0.12.1": "DOCKER_LND_VERSION=v0.12.1-beta npm run test",
+    "integration-test-0.12.0": "DOCKER_LND_VERSION=v0.12.0-beta npm run test",
+    "test": "echo $DOCKER_LND_VERSION && tap -j 3 --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.5.2"
+  "version": "53.7.2"
 }

package/test/integration/test_add_peer.js

@@ -9,7 +9,7 @@ const {getPeers} = require('./../../');
 const interval = 100;
 const size = 2;
 const times = 100;
-const timeout = 1;
+const timeout = 1000;
 
 // Adding peers should result in a connected peer
 test(`Add a peer`, async ({end, equal}) => {
@@ -17,30 +17,36 @@ test(`Add a peer`, async ({end, equal}) => {
 
   const [{lnd}, target] = nodes;
 
-  const connectedKeys = (await getPeers({lnd})).peers.map(n => n.public_key);
+  try {
+    const connectedKeys = (await getPeers({lnd})).peers.map(n => n.public_key);
 
-  equal(connectedKeys.find(n => n === target.id), undefined, 'No peer');
+    equal(connectedKeys.find(n => n === target.id), undefined, 'No peer');
 
-  await asyncRetry({interval, times}, async () => {
-    await addPeer({
-      lnd,
-      timeout,
-      public_key: target.id,
-      socket: target.socket,
-    });
-
-    const {peers} = await getPeers({lnd});
+    await asyncRetry({interval, times}, async () => {
+      await addPeer({
+        lnd,
+        timeout,
+        public_key: target.id,
+        retry_count: 1,
+        retry_delay: 1,
+        socket: target.socket,
+      });
 
-    const connected = peers.find(n => n.public_key === target.id);
+      const {peers} = await getPeers({lnd});
 
-    if (!connected) {
-      throw new Error('ExpectedConnectionToTarget');
-    }
+      const connected = peers.find(n => n.public_key === target.id);
 
-    equal(connected.public_key, target.id, 'Connected to remote node');
-  });
+      if (!connected) {
+        throw new Error('ExpectedConnectionToTarget');
+      }
 
-  await kill({});
+      equal(connected.public_key, target.id, 'Connected to remote node');
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  } finally {
+    await kill({});
+  }
 
   return end();
 });

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}) => {
+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}) => {
       funding: signRemote.psbt,
     });
 
-    const {transaction} = extractTransaction({psbt: signRemote.psbt});
+    const {transaction} = extractTransaction({ecp, psbt: signRemote.psbt});
 
     await broadcastChainTransaction({lnd, transaction});
 
@@ -136,16 +139,20 @@ test(`Forfeit pending channel`, async ({end, equal}) => {
       equal(code, 503, 'Pending channel cannot be canceled');
     }
 
-    await deletePendingChannel({
-      lnd,
-      confirmed_transaction: transaction,
-      pending_transaction: stuckTx.transaction,
-      pending_transaction_vout: pending.transaction_vout,
-    });
+    try {
+      await deletePendingChannel({
+        lnd,
+        confirmed_transaction: transaction,
+        pending_transaction: stuckTx.transaction,
+        pending_transaction_vout: pending.transaction_vout,
+      });
 
-    const [stillPending] = (await getPendingChannels({lnd})).pending_channels;
+      const [notPending] = (await getPendingChannels({lnd})).pending_channels;
 
-    equal(stillPending, undefined, 'Conflicting pending channel deleted');
+      equal(notPending, undefined, 'Conflicting pending channel deleted');
+    } catch (err) {
+      strictSame(err, [501, 'DeletePendingChannelMethodNotSupported']);
+    }
   } catch (err) {
     equal(err, null, 'No error is expected');
   } finally {

package/test/integration/test_get_failed_payments.js

@@ -28,128 +28,132 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
 
   const [{generate, lnd}, target, remote] = nodes;
 
-  const {address} = await createChainAddress({lnd: remote.lnd});
-
-  await generate({count});
-
-  // Send coins to remote so that it can accept the channel
-  await sendToChainAddress({lnd, address, tokens: channelCapacityTokens});
-
-  // Generate to confirm the tx
-  await generate({count: confirmationCount});
-  await remote.generate({count: confirmationCount});
-
-  await setupChannel({
-    generate,
-    lnd,
-    capacity: channelCapacityTokens + channelCapacityTokens,
-    to: target,
-  });
-
-  await setupChannel({
-    capacity: channelCapacityTokens,
-    lnd: target.lnd,
-    generate: target.generate,
-    generator: target,
-    give: Math.round(channelCapacityTokens / 2),
-    to: remote,
-  });
-
-  await addPeer({lnd, public_key: remote.id, socket: remote.socket});
-
-  const invoice = await createInvoice({tokens, lnd: remote.lnd});
-
-  const bigInvoice = await createInvoice({
-    tokens: (channelCapacityTokens / 2) + (channelCapacityTokens / 4),
-    lnd: remote.lnd,
-  });
-
   try {
-    await pay({lnd, request: bigInvoice.request});
-  } catch (err) {
-  }
-
-  // Create a new channel to increase total edge liquidity
-  await setupChannel({
-    capacity: channelCapacityTokens,
-    lnd: target.lnd,
-    generate: target.generate,
-    generator: target,
-    to: remote,
-  });
-
-  await deleteForwardingReputations({lnd});
-
-  await asyncRetry({times}, async () => {
-    await pay({lnd, request: invoice.request});
-  });
-
-  {
-    const {payments} = await getFailedPayments({lnd});
-
-    const [payment] = payments.filter(n => n.mtokens === bigInvoice.mtokens);
-
-    equal(payment.destination, remote.id, 'Payment to');
-    equal(payment.confirmed_at, undefined, 'No confirmation date');
-    equal(!!payment.created_at, true, 'Got payment created date');
-    equal(payment.fee, undefined, 'No fee when not paid');
-    equal(payment.fee_mtokens, undefined, 'No fee mtokens when not paid');
-    equal(!!payment.id, true, 'Got a payment id');
-    equal(!!payment.index, true, 'Got payment index');
-    equal(payment.is_confirmed, false, 'Failed payment is not confirmed');
-    equal(payment.is_outgoing, true, 'Failed payment is outgoing');
-    equal(payment.mtokens, bigInvoice.mtokens, 'Payment has mtokens');
-    equal(payment.request, bigInvoice.request, 'Probe has a request');
-    equal(payment.secret, undefined, 'Failed has no secret');
-    equal(payment.safe_fee, undefined, 'Failed has no fee');
-    equal(payment.safe_tokens, bigInvoice.tokens, 'Failed has safe tokens');
-    equal(payment.tokens, bigInvoice.tokens, 'Failed has tokens');
-
-    const gotFailed = await getPayment({lnd, id: payment.id});
-
-    strictSame(
-      gotFailed,
-      {
-        failed: {
-          is_insufficient_balance: false,
-          is_invalid_payment: false,
-          is_pathfinding_timeout: false,
-          is_route_not_found: true,
+    const {address} = await createChainAddress({lnd: remote.lnd});
+
+    await generate({count});
+
+    // Send coins to remote so that it can accept the channel
+    await sendToChainAddress({lnd, address, tokens: channelCapacityTokens});
+
+    // Generate to confirm the tx
+    await generate({count: confirmationCount});
+    await remote.generate({count: confirmationCount});
+
+    await setupChannel({
+      generate,
+      lnd,
+      capacity: channelCapacityTokens + channelCapacityTokens,
+      to: target,
+    });
+
+    await setupChannel({
+      capacity: channelCapacityTokens,
+      lnd: target.lnd,
+      generate: target.generate,
+      generator: target,
+      give: Math.round(channelCapacityTokens / 2),
+      to: remote,
+    });
+
+    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+    const invoice = await createInvoice({tokens, lnd: remote.lnd});
+
+    const bigInvoice = await createInvoice({
+      tokens: (channelCapacityTokens / 2) + (channelCapacityTokens / 4),
+      lnd: remote.lnd,
+    });
+
+    try {
+      await pay({lnd, request: bigInvoice.request});
+    } catch (err) {
+    }
+
+    // Create a new channel to increase total edge liquidity
+    await setupChannel({
+      capacity: channelCapacityTokens,
+      lnd: target.lnd,
+      generate: target.generate,
+      generator: target,
+      to: remote,
+    });
+
+    await deleteForwardingReputations({lnd});
+
+    await asyncRetry({times}, async () => {
+      await pay({lnd, request: invoice.request});
+    });
+
+    {
+      const {payments} = await getFailedPayments({lnd});
+
+      const [payment] = payments.filter(n => n.mtokens === bigInvoice.mtokens);
+
+      equal(payment.destination, remote.id, 'Payment to');
+      equal(payment.confirmed_at, undefined, 'No confirmation date');
+      equal(!!payment.created_at, true, 'Got payment created date');
+      equal(payment.fee, undefined, 'No fee when not paid');
+      equal(payment.fee_mtokens, undefined, 'No fee mtokens when not paid');
+      equal(!!payment.id, true, 'Got a payment id');
+      equal(!!payment.index, true, 'Got payment index');
+      equal(payment.is_confirmed, false, 'Failed payment is not confirmed');
+      equal(payment.is_outgoing, true, 'Failed payment is outgoing');
+      equal(payment.mtokens, bigInvoice.mtokens, 'Payment has mtokens');
+      equal(payment.request, bigInvoice.request, 'Probe has a request');
+      equal(payment.secret, undefined, 'Failed has no secret');
+      equal(payment.safe_fee, undefined, 'Failed has no fee');
+      equal(payment.safe_tokens, bigInvoice.tokens, 'Failed has safe tokens');
+      equal(payment.tokens, bigInvoice.tokens, 'Failed has tokens');
+
+      const gotFailed = await getPayment({lnd, id: payment.id});
+
+      strictSame(
+        gotFailed,
+        {
+          failed: {
+            is_insufficient_balance: false,
+            is_invalid_payment: false,
+            is_pathfinding_timeout: false,
+            is_route_not_found: true,
+          },
+          is_confirmed: false,
+          is_failed: true,
+          is_pending: false,
+          payment: undefined,
+          pending: undefined,
         },
-        is_confirmed: false,
-        is_failed: true,
-        is_pending: false,
-        payment: undefined,
-        pending: undefined,
-      },
-      'Got failed state'
-    );
-  }
-
-  {
-    const {payments} = await getPayments({lnd});
-
-    const [payment] = payments;
-
-    equal(payment.destination, remote.id, 'Paid to');
-    equal(!!payment.confirmed_at, true, 'Got confirmation date');
-    equal(!!payment.created_at, true, 'Got payment start date');
-    equal(payment.fee, 1, 'Got fee paid');
-    equal(payment.fee_mtokens, '1500', 'Got fee mtokens paid');
-    strictSame(payment.hops, [target.id], 'Got hops');
-    equal(!!payment.id, true, 'Got a payment id');
-    equal(!!payment.index, true, 'Got payment index');
-    equal(payment.is_confirmed, true, 'Failed payment is not confirmed');
-    equal(payment.is_outgoing, true, 'Failed payment is outgoing');
-    equal(payment.mtokens, invoice.mtokens, 'Payment has mtokens');
-    equal(payment.request, invoice.request, 'Payment has a request');
-    equal(!!payment.secret, true, 'Failed has no secret');
-    equal(payment.safe_fee, 2, 'Failed has no fee');
-    equal(payment.safe_tokens, invoice.tokens, 'Failed has safe tokens');
-    equal(payment.tokens, invoice.tokens, 'Failed has tokens');
+        'Got failed state'
+      );
+    }
+
+    {
+      const {payments} = await getPayments({lnd});
+
+      const [payment] = payments;
+
+      equal(payment.destination, remote.id, 'Paid to');
+      equal(!!payment.confirmed_at, true, 'Got confirmation date');
+      equal(!!payment.created_at, true, 'Got payment start date');
+      equal(payment.fee, 1, 'Got fee paid');
+      equal(payment.fee_mtokens, '1500', 'Got fee mtokens paid');
+      strictSame(payment.hops, [target.id], 'Got hops');
+      equal(!!payment.id, true, 'Got a payment id');
+      equal(!!payment.index, true, 'Got payment index');
+      equal(payment.is_confirmed, true, 'Failed payment is not confirmed');
+      equal(payment.is_outgoing, true, 'Failed payment is outgoing');
+      equal(payment.mtokens, invoice.mtokens, 'Payment has mtokens');
+      equal(payment.request, invoice.request, 'Payment has a request');
+      equal(!!payment.secret, true, 'Failed has no secret');
+      equal(payment.safe_fee, 2, 'Failed has no fee');
+      equal(payment.safe_tokens, invoice.tokens, 'Failed has safe tokens');
+      equal(payment.tokens, invoice.tokens, 'Failed has tokens');
+    }
+  } catch (err) {
+    strictSame(err, null, 'Expected no error');
+  } finally {
+    await kill({});
   }
 
-  await kill({});
-
   return end();
 });