ln-service 53.3.0 → 53.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Versions
 
+## 53.5.0
+
+- `createWallet`: Add support for returning the admin `macaroon`
+
+## 53.4.2
+
+- `pay`, `payViaPaymentRequest`: Fix support for `outgoing_channels` constraint
+
+## 53.4.0
+
+- `deletePendingChannel`: Add method to remove a stuck pending channel open
+
 ## 53.3.0
 
 - `getInvoices`: Add `is_unconfirmed` to filter out canceled/settled invoices

package/README.md

@@ -102,7 +102,7 @@ for `unlocker` methods.
 
 ## All Methods
 
-- [addPeer](#addPeer) - Connect to a peer
+- [addPeer](#addpeer) - Connect to a peer
 - [authenticatedLndGrpc](#authenticatedlndgrpc) - LND API Object
 - [broadcastChainTransaction](#broadcastchaintransaction) - Push a chain tx
 - [cancelHodlInvoice](#cancelhodlinvoice) - Cancel a held or any open invoice
@@ -118,17 +118,22 @@ for `unlocker` methods.
 - [createUnsignedRequest](#createunsignedrequest) - create an unsigned invoice
 - [createWallet](#createwallet) - Make a new wallet
 - [decodePaymentRequest](#decodepaymentrequest) - Decode a Lightning invoice
-- [deleteFailedPayAttempts](#deletefailedpayattempts) - Remove records of failed pay attempts
-- [deleteFailedPayments](#deletefailedpayments) - Remove records of payments that failed
+- [deleteFailedPayAttempts](#deletefailedpayattempts) - Remove records of 
+    failed pay attempts
+- [deleteFailedPayments](#deletefailedpayments) - Remove records of payments 
+    that failed
 - [deleteForwardingReputations](#deleteforwardingreputations) - Wipe node reps
 - [deletePayment](#deletepayment) - Delete the record of a single past payment
 - [deletePayments](#deletepayments) - Delete entire history of past payments
+- [deletePendingChannel](#deletependingchannel) - Delete a pending channel that
+    will never confirm due to a conflicting confirmed transaction
 - [diffieHellmanComputeSecret](#diffiehellmancomputesecret) - Get DH shared key
 - [disableChannel](#disablechannel) - Disable a channel for outgoing payments
 - [disconnectWatchtower](#disconnectwatchtower) - Disconnect a watchtower
 - [enableChannel](#enablechannel) - Enable a channel for outgoing payments
 - [fundPendingChannels](#fundpendingchannels) - Fund pending open channels
-- [fundPsbt](#fundpsbt) - Create an unsigned PSBT with funding inputs and spending outputs
+- [fundPsbt](#fundpsbt) - Create an unsigned PSBT with funding inputs and 
+    spending outputs
 - [getAccessIds](#getaccessids) - Get granted macaroon root access ids
 - [getAutopilot](#getautopilot) - Get autopilot status or node scores
 - [getBackup](#getbackup) - Get a backup of a channel
@@ -157,48 +162,53 @@ for `unlocker` methods.
 - [getNetworkGraph](#getnetworkgraph) - Get the channels and nodes of the graph
 - [getNetworkInfo](#getnetworkinfo) - Get high-level graph info
 - [getNode](#getnode) - Get graph info about a single node and its channels
-- [getPathfindingSettings](#getpathfindingsettings) - Get pathfinding system settings
+- [getPathfindingSettings](#getpathfindingsettings) - Get pathfinding system
+    settings
 - [getPayment](#getpayment) - Get a past payment
 - [getPayments](#getpayments) - Get all past payments
 - [getPeers](#getpeers) - Get all connected peers
 - [getPendingChainBalance](#getpendingchainbalance) - Get pending chain balance
 - [getPendingChannels](#getpendingchannels) - Get channels in pending states
 - [getPublicKey](#getpublickey) - Get a public key out of the seed
-- [getRouteConfidence](#getRouteConfidence) - Get confidence in a route
-- [getRouteThroughHops](#getRouteThroughHops) - Get a route through nodes
-- [getRouteToDestination](#getRouteToDestination) - Get a route to a destination
-- [getSweepTransactions](#getSweepTransactions) - Get transactions sweeping to self
-- [getTowerServerInfo](#getTowerServerInfo) - Get information about tower server
-- [getUtxos](#getUtxos) - Get on-chain unspent outputs
-- [getWalletInfo](#getWalletInfo) - Get general wallet info
+- [getRouteConfidence](#getrouteconfidence) - Get confidence in a route
+- [getRouteThroughHops](#getroutethroughhops) - Get a route through nodes
+- [getRouteToDestination](#getroutetodestination) - Get a route to a destination
+- [getSweepTransactions](#getsweeptransactions) - Get transactions sweeping to
+    self
+- [getTowerServerInfo](#gettowerserverinfo) - Get information about tower server
+- [getUtxos](#getutxos) - Get on-chain unspent outputs
+- [getWalletInfo](#getwalletinfo) - Get general wallet info
 - [getWalletStatus](#getwalletstatus) - Get the status of the wallet
-- [getWalletVersion](#getWalletVersion) - Get the build and version of the LND
-- [grantAccess](#grantAccess) - Grant an access credential macaroon
-- [grpcProxyServer](#grpcProxyServer) - REST proxy server for calling to gRPC
-- [isDestinationPayable](#isDestinationPayable) - Check can pay to destination
-- [lockUtxo](#lockUtxo) - Lock a UTXO temporarily to prevent it being used
-- [openChannel](#openChannel) - Open a new channel
-- [openChannels](#openChannels) - Open channels with external funding
-- [parsePaymentRequest](#parsePaymentRequest) - Parse a BOLT11 Payment Request
+- [getWalletVersion](#getwalletversion) - Get the build and version of the LND
+- [grantAccess](#grantaccess) - Grant an access credential macaroon
+- [grpcProxyServer](#grpcproxyserver) - REST proxy server for calling to gRPC
+- [isDestinationPayable](#isdestinationpayable) - Check can pay to destination
+- [lockUtxo](#lockutxo) - Lock a UTXO temporarily to prevent it being used
+- [openChannel](#openchannel) - Open a new channel
+- [openChannels](#openchannels) - Open channels with external funding
+- [parsePaymentRequest](#parsepaymentrequest) - Parse a BOLT11 Payment Request
 - [pay](#pay) - Send a payment
-- [payViaPaymentDetails](#payViaPaymentDetails) - Pay using decomposed details
-- [payViaPaymentRequest](#payViaPaymentRequest) - Pay using a payment request
-- [payViaRoutes](#payViaRoutes) - Make a payment over specified routes
-- [prepareForChannelProposal](#prepareForChannelProposal) - setup for a channel proposal
+- [payViaPaymentDetails](#payviapaymentdetails) - Pay using decomposed details
+- [payViaPaymentRequest](#payviapaymentrequest) - Pay using a payment request
+- [payViaRoutes](#payviaroutes) - Make a payment over specified routes
+- [prepareForChannelProposal](#prepareforchannelproposal) - setup for a channel
+    proposal
 - [probe](#probe) - Find a payable route by attempting a fake payment
-- [probeForRoute](#probeForRoute) - Actively probe to find a payable route
+- [probeForRoute](#probeforroute) - Actively probe to find a payable route
 - [proposeChannel](#proposechannel) - Offer a channel proposal to a peer
-- [recoverFundsFromChannel](#recoverFundsFromChannel) - Restore a channel
-- [recoverFundsFromChannels](#recoverFundsFromChannels) - Restore all channels
-- [removePeer](#removePeer) - Disconnect from a connected peer
-- [requestChainFeeIncrease](#requestchainfeeincrease) - Request a CPFP spend on a UTXO
+- [recoverFundsFromChannel](#recoverfundsfromchannel) - Restore a channel
+- [recoverFundsFromChannels](#recoverfundsfromchannels) - Restore all channels
+- [removePeer](#removepeer) - Disconnect from a connected peer
+- [requestChainFeeIncrease](#requestchainfeeincrease) - Request a CPFP spend on
+    a UTXO
 - [restrictMacaroon](#restrictmacaroon) - Add limitations to a macaroon
 - [revokeAccess](#revokeaccess) - Revoke all access macaroons given to an id
 - [routeFromChannels](#routefromchannels) - Convert channel series to a route
 - [sendMessageToPeer](#sendmessagetopeer) - Send a custom message to a peer
 - [sendToChainAddress](#sendtochainaddress) - Send on-chain to an address
 - [sendToChainAddresses](#sendtochainaddresses) - Send on-chain to addresses
-- [sendToChainOutputScripts](#sendtochainoutputscripts) - Send to on-chain script outputs
+- [sendToChainOutputScripts](#sendtochainoutputscripts) - Send to on-chain
+    script outputs
 - [setAutopilot](#setautopilot) - Turn autopilot on and set autopilot scores
 - [settleHodlInvoice](#settlehodlinvoice) - Accept a HODL HTLC invoice
 - [signBytes](#signbytes) -  Sign over arbitrary bytes with node keys
@@ -211,18 +221,21 @@ for `unlocker` methods.
 - [subscribeToChainAddress](#subscribetochainaddress) - Subscribe to receives
 - [subscribeToChainSpend](#subscribetochainspend) - Subscribe to chain spends
 - [subscribeToChannels](#subscribetochannels) - Subscribe to channel statuses
-- [subscribeToForwardRequests](#subscribetoforwardrequests) - Interactively route
+- [subscribeToForwardRequests](#subscribetoforwardrequests) - Interactively
+    route
 - [subscribeToForwards](#subscribetoforwards) - Subscribe to HTLC events
 - [subscribeToGraph](#subscribetograph) - Subscribe to network graph updates
 - [subscribeToInvoice](#subscribetoinvoice) - Subscribe to invoice updates
 - [subscribeToInvoices](#subscribetoinvoices) - Subscribe to all invoices
 - [subscribeToOpenRequests](#subscribetoopenrequests) - Approve open requests
 - [subscribeToPastPayment](#subscribetopastpayment) - Subscribe to a payment
-- [subscribeToPastPayments](#subscribetopastpayments) - Subscribe to all sent payments
+- [subscribeToPastPayments](#subscribetopastpayments) - Subscribe to all sent
+    payments
 - [subscribeToPayViaDetails](#subscribetopayviadetails) - Pay using details
 - [subscribeToPayViaRequest](#subscribetopayviarequest) - Pay using a request
 - [subscribeToPayViaRoutes](#subscribetopayviaroutes) - Pay using routes
-- [subscribeToPeerMessages](#subscribetopeermessages) - Listen to incoming custom messages
+- [subscribeToPeerMessages](#subscribetopeermessages) - Listen to incoming
+    custom messages
 - [subscribeToPeers](#subscribetopeers) - Subscribe to peers connectivity
 - [subscribeToProbe](#subscribetoprobe) - Subscribe to a probe for a route
 - [subscribeToProbeForRoute](#subscribetoprobeforroute) - Probe for a route
@@ -230,11 +243,14 @@ for `unlocker` methods.
 - [subscribeToTransactions](#subscribetotransactions) - Subscribe to chain tx
 - [subscribeToWalletStatus](#subscribetowalletstatus) - Subscribe to node state
 - [unauthenticatedLndGrpc](#unauthenticatedLndGrpc) - LND for locked lnd APIs
-- [unlockUtxo](#unlockUtxo) - Release a locked UTXO so that it can be used again
-- [unlockWallet](#unlockWallet) - Unlock a locked lnd
-- [updateChainTransaction](#updateChainTransaction) - Update a chain transaction
+- [unlockUtxo](#unlockutxo) - Release a locked UTXO so that it can be used
+    again
+- [unlockWallet](#unlockwallet) - Unlock a locked lnd
+- [updateChainTransaction](#updatechaintransaction) - Update a chain
+    transaction
 - [updateConnectedWatchtower](#updateconnectedwatchtower) - Update watchtower
-- [updatePathfindingSettings](#updatepathfindingsettings) - Update pathfinding configuration
+- [updatePathfindingSettings](#updatepathfindingsettings) - Update pathfinding
+    configuration
 - [updateRoutingFees](#updateroutingfees) - Change routing fees
 - [verifyAccess](#verifyaccess) - Verify a macaroon has access
 - [verifyBackup](#verifybackup) - Verify a channel backup
@@ -256,6 +272,7 @@ for `unlocker` methods.
     - run regtest integration tests
 - [ln-pathfinding](https://npmjs.com/package/ln-accounting) - pathfinding
     utilities
+- [ln-sync](https://www.npmjs.com/package/ln-sync) - metadata helper methods
 - [probing](https://npmjs.com/package/probing) - payment probing utilities
 - [psbt](https://www.npmjs.com/package/psbt) - BIP 174 PSBT utilities
 
@@ -745,6 +762,9 @@ Requires unlocked lnd and unauthenticated LND API Object
     }
 
     @returns via cbk or Promise
+    {
+      macaroon: <Base64 Encoded Admin Macaroon String>
+    }
 
 Example:
 
@@ -918,6 +938,36 @@ const {deletePayments} = require('ln-service');
 await deletePayments({lnd});
 ```
 
+### deletePendingChannel
+
+Delete a pending channel
+
+Pass the confirmed conflicting transaction that spends the same input to
+make sure that no funds are being deleted.
+
+This method is not supported on LND 0.13.3 and below
+
+    {
+      confirmed_transaction: <Hex Encoded Conflicting Transaction String>
+      lnd: <Authenticated LND API Object>
+      pending_transaction: <Hex Encoded Pending Transaction String>
+      pending_transaction_vout: <Pending Channel Output Index Number>
+    }
+
+    @returns via cbk or Promise
+
+```node
+const {deletePendingChannel} = require('ln-service');
+
+// Delete a stuck pending channel
+await deletePendingChannel({
+  lnd,
+  confirmed_transaction: confirmedTransactionHex,
+  pending_transaction: stuckPendingChannelOpenTxHex,
+  pending_transaction_vout: pendingChannelOutputIndexNumber,
+});
+```
+
 ### diffieHellmanComputeSecret
 
 Derive a shared secret

package/index.js

@@ -19,6 +19,7 @@ const {deleteFailedPayAttempts} = require('lightning');
 const {deleteFailedPayments} = require('lightning');
 const {deletePayment} = require('lightning');
 const {deletePayments} = require('lightning');
+const {deletePendingChannel} = require('lightning');
 const {diffieHellmanComputeSecret} = require('lightning');
 const {disableChannel} = require('lightning');
 const {disconnectWatchtower} = require('lightning');
@@ -157,6 +158,7 @@ module.exports = {
   deleteForwardingReputations,
   deletePayment,
   deletePayments,
+  deletePendingChannel,
   diffieHellmanComputeSecret,
   disableChannel,
   disconnectWatchtower,

package/package.json

@@ -10,23 +10,23 @@
     "bolt07": "1.8.0",
     "cors": "2.8.5",
     "express": "4.17.2",
-    "invoices": "2.0.2",
-    "lightning": "5.3.0",
+    "invoices": "2.0.3",
+    "lightning": "5.3.3",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
-    "ws": "8.4.0"
+    "ws": "8.4.2"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.3",
-    "asyncjs-util": "1.2.7",
+    "asyncjs-util": "1.2.8",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.1.0",
+    "ln-docker-daemons": "2.2.0",
     "portfinder": "1.0.28",
     "psbt": "1.1.10",
     "rimraf": "3.0.2",
@@ -55,5 +55,5 @@
   "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"
   },
-  "version": "53.3.0"
+  "version": "53.5.0"
 }

package/test/integration/test_delete_pending_channel.js

@@ -0,0 +1,156 @@
+const {once} = require('events');
+
+const asyncEach = require('async/each');
+const asyncRetry = require('async/retry');
+const {extractTransaction} = require('psbt');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {addPeer} = require('./../../');
+const {broadcastChainTransaction} = require('./../../');
+const {cancelPendingChannel} = require('./../../');
+const {createCluster} = require('./../macros');
+const {delay} = require('./../macros');
+const {deletePendingChannel} = require('./../../');
+const {fundPendingChannels} = require('./../../');
+const {fundPsbt} = require('./../../');
+const {getChainBalance} = require('./../../');
+const {getChannels} = require('./../../');
+const {getLockedUtxos} = require('./../../');
+const {getPendingChannels} = require('./../../');
+const {openChannels} = require('./../../');
+const {signPsbt} = require('./../../');
+const {unlockUtxo} = require('./../../');
+
+const capacity = 1e6;
+const count = 100;
+const interval = 100;
+const race = promises => Promise.race(promises);
+const size = 3;
+const timeout = 1000 * 5;
+const times = 200;
+
+// Forfeiting a pending channel should remove the pending channel
+test(`Forfeit pending channel`, async ({end, equal}) => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [control, target, remote] = nodes;
+
+  const {generate, lnd} = control;
+
+  try {
+    await control.generate({count});
+
+    await asyncEach([target, remote], async node => {
+      return await addPeer({lnd, public_key: node.id, socket: node.socket});
+    });
+
+    const channels = [{capacity, partner_public_key: target.id}];
+
+    // Propose a channel to target
+    const proposeToTarget = await asyncRetry({interval, times}, async () => {
+      return await race([
+        delay(timeout),
+        openChannels({channels, lnd, is_avoiding_broadcast: true}),
+      ]);
+    });
+
+    // Setup funding for the target
+    const fundTarget = await fundPsbt({lnd, outputs: proposeToTarget.pending});
+
+    // Sign the funding to the target
+    const signTarget = await signPsbt({lnd, psbt: fundTarget.psbt});
+
+    // Fund the target channel that will get stuck
+    await fundPendingChannels({
+      lnd,
+      channels: proposeToTarget.pending.map(n => n.id),
+      funding: signTarget.psbt,
+    });
+
+    await asyncEach((await getLockedUtxos({lnd})).utxos, async utxo => {
+      return await unlockUtxo({
+        lnd,
+        id: utxo.lock_id,
+        transaction_id: utxo.transaction_id,
+        transaction_vout: utxo.transaction_vout,
+      });
+    });
+
+    // Propose a channel to remote
+    const proposeToRemote = await asyncRetry({interval, times}, async () => {
+      return await race([
+        delay(timeout),
+        openChannels({lnd,
+          channels: [{capacity, partner_public_key: remote.id}],
+          is_avoiding_broadcast: true,
+        }),
+      ]);
+    });
+
+    // Setup funding for the remote, using the same inputs
+    const fundRemote = await fundPsbt({
+      lnd,
+      inputs: fundTarget.inputs,
+      outputs: proposeToRemote.pending
+    });
+
+    // Sign the funding to the target
+    const signRemote = await signPsbt({lnd, psbt: fundRemote.psbt});
+
+    // Fund the remote channel
+    await fundPendingChannels({
+      lnd,
+      channels: proposeToRemote.pending.map(n => n.id),
+      funding: signRemote.psbt,
+    });
+
+    const {transaction} = extractTransaction({psbt: signRemote.psbt});
+
+    await broadcastChainTransaction({lnd, transaction});
+
+    const channel = await asyncRetry({interval, times}, async () => {
+      const [channel] = (await getChannels({lnd})).channels;
+
+      if (!!channel) {
+        return channel;
+      }
+
+      await generate({});
+
+      throw new Error('ExpectedNewChannelCreated');
+    });
+
+    const [pending] = (await getPendingChannels({lnd})).pending_channels;
+
+    const stuckTx = extractTransaction({psbt: signTarget.psbt});
+
+    const [stuckPending] = proposeToTarget.pending;
+
+    // Try to cancel the pending channel, it will fail
+    try {
+      await cancelPendingChannel({lnd, id: stuckPending.id});
+    } catch (err) {
+      const [code] = err;
+
+      equal(code, 503, 'Pending channel cannot be canceled');
+    }
+
+    await deletePendingChannel({
+      lnd,
+      confirmed_transaction: transaction,
+      pending_transaction: stuckTx.transaction,
+      pending_transaction_vout: pending.transaction_vout,
+    });
+
+    const [stillPending] = (await getPendingChannels({lnd})).pending_channels;
+
+    equal(stillPending, undefined, 'Conflicting pending channel deleted');
+  } catch (err) {
+    equal(err, null, 'No error is expected');
+  } finally {
+    await kill({});
+  }
+
+  return end();
+});

package/test/integration/test_subscribe_to_open_requests.js

@@ -105,14 +105,16 @@ test(`Subscribe to open requests`, async ({end, equal, fail, ok}) => {
   });
 
   try {
-    await openChannel({
-      lnd: target.lnd,
-      chain_fee_tokens_per_vbyte: defaultFee,
-      give_tokens: giftTokens,
-      is_private: true,
-      local_tokens: channelCapacityTokens,
-      partner_public_key: control.id,
-      socket: control.socket,
+    await asyncRetry({interval, times}, async () => {
+      return await openChannel({
+        lnd: target.lnd,
+        chain_fee_tokens_per_vbyte: defaultFee,
+        give_tokens: giftTokens,
+        is_private: true,
+        local_tokens: channelCapacityTokens,
+        partner_public_key: control.id,
+        socket: control.socket,
+      });
     });
   } catch (err) {
     equal(err, null, 'Expected no error when a channel is accepted');