ln-service 57.9.0 → 57.10.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 57.10.0
+
+- `getPendingSweeps`: Add method to get the list of pending outpoints to sweep
+- `requestBatchedFeeIncrease`: Add method to batch a CPFP sweep of an outpoint
+
+## 57.9.1
+
+- Add support for LND 0.17.5
+
 ## 57.9.0
 
 - `fundPsbt`, `getChainFeeEstimate`, `sendToChainAddress`,

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.17.0-beta to v0.17.4-beta
+- v0.17.0-beta to v0.17.5-beta
 - v0.16.0-beta to v0.16.4-beta
 - v0.15.2-beta to v0.15.5-beta
 - v0.14.4-beta to v0.14.5-beta
@@ -215,6 +215,7 @@ for `unlocker` methods.
 - [getPendingChainBalance](#getpendingchainbalance) - Get pending chain balance
 - [getPendingChannels](#getpendingchannels) - Get channels in pending states
 - [getPendingPayments](#getpendingpayments) - Get in-flight outgoing payments
+- [getPendingSweeps](#getpendingsweeps) - Get sweeps waiting for resolution
 - [getPublicKey](#getpublickey) - Get a public key out of the seed
 - [getRouteConfidence](#getrouteconfidence) - Get confidence in a route
 - [getRouteThroughHops](#getroutethroughhops) - Get a route through nodes
@@ -248,6 +249,8 @@ for `unlocker` methods.
 - [removeAdvertisedFeature](#removeadvertisedfeature) - Remove feature from ad
 - [removeExternalSocket](#removeexternalsocket) - Remove a p2p host:ip announce
 - [removePeer](#removepeer) - Disconnect from a connected peer
+- [requestBatchedFeeIncrease](#requestbatchedfeeincrease) - Request a batched
+    CPFP spend on an unconfirmed outpoint
 - [requestChainFeeIncrease](#requestchainfeeincrease) - Request a CPFP spend on
     a UTXO
 - [restrictMacaroon](#restrictmacaroon) - Add limitations to a macaroon
@@ -1003,7 +1006,7 @@ Remove a chain transaction.
 
 Requires `onchain:write` permission
 
-This method is not supported on LND 0.17.4 and below
+This method is not supported on LND 0.17.5 and below
 
     {
       id: <Transaction Id Hex String>
@@ -1351,7 +1354,7 @@ This method is not supported in LND 0.11.1 and below
 
 Specifying 0 for `min_confirmations` is not supported in LND 0.13.0 and below
 
-`utxo_selection` is not supported in LND 0.17.4 and below
+`utxo_selection` is not supported in LND 0.17.5 and below
 
     {
       [fee_tokens_per_vbyte]: <Chain Fee Tokens Per Virtual Byte Number>
@@ -1648,7 +1651,7 @@ Requires `onchain:read` permission
 
 Specifying 0 for `utxo_confirmations` is not supported in LND 0.13.0 or below
 
-`utxo_selection` is not supported in LND 0.17.4 and below
+`utxo_selection` is not supported in LND 0.17.5 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -1706,7 +1709,7 @@ Get a chain transaction.
 
 Requires `onchain:read` permission
 
-This method is not supported on LND 0.17.4 and below
+This method is not supported on LND 0.17.5 and below
 
     {
       id: <Transaction Id Hex String>
@@ -2019,7 +2022,7 @@ Get the current configuration file settings and the output log
 Requires `info:read`, `offchain:read`, `onchain:read`, `peers:read`
 permissions
 
-This method is not supported on LND 0.17.4 and below
+This method is not supported on LND 0.17.5 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -2054,7 +2057,7 @@ Includes previously connected watchtowers
 
 `is_anchor` flag is not supported on LND 0.11.1 and below
 
-`is_taproot` flag is not supported on LND 0.17.4 and below
+`is_taproot` flag is not supported on LND 0.17.5 and below
 
     {
       [is_anchor]: <Get Anchor Type Tower Info Bool>
@@ -3113,7 +3116,7 @@ Requires `offchain:read` permission
 
 `blocks_until_expiry` is not supported in LND 0.16.4 or before
 
-`close_transaction` is not supported in LND 0.17.4 or before
+`close_transaction` is not supported in LND 0.17.5 or before
 
     {
       lnd: <Authenticated LND API Object>
@@ -3256,7 +3259,7 @@ Requires `offchain:read` permission
     }
 
 ```node
-const {getPendingPayments} = require('ln-service')
+const {getPendingPayments} = require('ln-service');
 
 const {next, payments} = await getPendingPayments({lnd});
 
@@ -3265,6 +3268,42 @@ if (!next) {
 }
 ```
 
+### getPendingSweeps
+
+Get pending self-transfer spends
+
+Requires `onchain:read` permission
+
+Requires LND built with `walletrpc` build tag
+
+This method is not supported in LND 0.17.5 or below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      sweeps: [{
+        broadcasts_count: <Total Sweep Broadcast Attempts Count Number>
+        [current_fee_rate]: <Current Chain Fee Rate Tokens Per VByte Number>
+        [initial_fee_rate]: <Requested Chain Fee Rate Tokens per VByte Number>
+        is_batching: <Requested Waiting For Batching Bool>
+        [max_fee]: <Maximum Total Fee Tokens Allowed Number>
+        [max_height]: <Targeted Maximum Confirmation Height Number>
+        tokens: <Sweep Outpoint Tokens Value Number>
+        transaction_id: <Sweeping Outpoint Transaction Id Hex String>
+        transaction_vout: <Sweeping Outpoint Transaction Output Index Number>
+        type: <Outpoint Constraint Script Type String>
+      }]
+    }
+
+```node
+const {getPendingSweeps} = require('ln-service');
+
+const pendingSweepsCount = (await getPendingSweeps({lnd})).sweeps.length;
+```
+
 ### getPublicKey
 
 Get a public key in the seed
@@ -4767,6 +4806,36 @@ const connectedPeerPublicKey = 'nodePublicKeyHexString';
 await removePeer({lnd, public_key: connectedPeerPublicKey});
 ```
 
+### requestBatchedFeeIncrease
+
+Request batched CPFP fee bumping of an unconfirmed outpoint on a deadline
+
+Requires `onchain:write` permission
+
+Requires LND built with `walletrpc` build tag
+
+This method is unsupported on LND 0.17.5 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+      [max_fee]: <Maximum Tokens to Pay Into Chain Fees Number>
+      [max_height]: <Maximum Height To Reach a Confirmation Number>
+      transaction_id: <Unconfirmed UTXO Transaction Id Hex String>
+      transaction_vout: <Unconfirmed UTXO Transaction Index Number>
+    }
+
+    @returns via cbk or Promise
+
+```node
+const {requestBatchedFeeIncrease} = require('ln-service');
+
+await requestBatchedFeeIncrease({
+  lnd,
+  transaction_id: unconfirmedUtxoTxId,
+  transaction_vout: unconfirmedUtxoTxOutputIndex,
+});
+```
+
 ### requestChainFeeIncrease
 
 Request a future on-chain CPFP fee increase for an unconfirmed UTXO
@@ -4972,7 +5041,7 @@ Requires `onchain:write` permission
 
 `utxo_confirmations` is not supported on LND 0.11.1 or below
 
-`utxo_selection` is not supported in LND 0.17.4 and below
+`utxo_selection` is not supported in LND 0.17.5 and below
 
     {
       address: <Destination Chain Address String>
@@ -5016,7 +5085,7 @@ Requires `onchain:write` permission
 
 `utxo_confirmations` is not supported on LND 0.11.1 or below
 
-`utxo_selection` is not supported in LND 0.17.4 and below
+`utxo_selection` is not supported in LND 0.17.5 and below
 
     {
       [description]: <Transaction Label String>
@@ -5060,7 +5129,7 @@ Requires `onchain:write` permission
 
 Requires LND compiled with `walletrpc` build tag
 
-`utxo_selection` is not supported in LND 0.17.4 and below
+`utxo_selection` is not supported in LND 0.17.5 and below
 
     {
       [description]: <Transaction Label String>

package/index.js

@@ -73,6 +73,7 @@ const {getPeers} = require('lightning');
 const {getPendingChainBalance} = require('lightning');
 const {getPendingChannels} = require('lightning');
 const {getPendingPayments} = require('lightning');
+const {getPendingSweeps} = require('lightning');
 const {getPublicKey} = require('lightning');
 const {getRouteConfidence} = require('lightning');
 const {getRouteThroughHops} = require('lightning');
@@ -103,6 +104,7 @@ const {recoverFundsFromChannels} = require('lightning');
 const {removeAdvertisedFeature} = require('lightning');
 const {removeExternalSocket} = require('lightning');
 const {removePeer} = require('lightning');
+const {requestBatchedFeeIncrease} = require('lightning');
 const {requestChainFeeIncrease} = require('lightning');
 const {restrictMacaroon} = require('./macaroons');
 const {revokeAccess} = require('lightning');
@@ -235,6 +237,7 @@ module.exports = {
   getPendingChainBalance,
   getPendingChannels,
   getPendingPayments,
+  getPendingSweeps,
   getPublicKey,
   getRouteConfidence,
   getRouteThroughHops,
@@ -265,6 +268,7 @@ module.exports = {
   removeAdvertisedFeature,
   removeExternalSocket,
   removePeer,
+  requestBatchedFeeIncrease,
   requestChainFeeIncrease,
   restrictMacaroon,
   revokeAccess,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.8.4",
     "invoices": "3.0.0",
-    "lightning": "10.9.0",
+    "lightning": "10.10.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.13",
+    "ln-docker-daemons": "6.0.15",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -52,6 +52,8 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
+    "integration-test-0.17.5": "DOCKER_LND_VERSION=v0.17.5-beta npm run test",
+    "integration-test-0.17.4": "DOCKER_LND_VERSION=v0.17.4-beta npm run test",
     "integration-test-0.17.3": "DOCKER_LND_VERSION=v0.17.3-beta npm run test",
     "integration-test-0.17.2": "DOCKER_LND_VERSION=v0.17.2-beta npm run test",
     "integration-test-0.17.1": "DOCKER_LND_VERSION=v0.17.1-beta npm run test",
@@ -69,5 +71,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && node test/runner"
   },
-  "version": "57.9.0"
+  "version": "57.10.0"
 }

package/test/chainrpc-integration/test_subscribe_to_blocks.js

@@ -7,7 +7,6 @@ const asyncRetry = require('async/retry');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 
 const {createChainAddress} = require('./../../');
-const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
 const {getChainBalance} = require('./../../');

package/test/chainrpc-integration/test_subscribe_to_chain_address.js

@@ -6,7 +6,6 @@ const {spawnLightningCluster} = require('ln-docker-daemons');
 
 const {chainSendTransaction} = require('./../macros');
 const {createChainAddress} = require('./../../');
-const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
 const {getChainBalance} = require('./../../');
 const {getChainTransactions} = require('./../../');

package/test/walletrpc-integration/test_get_pending_sweeps.js

@@ -0,0 +1,84 @@
+const {equal} = require('node:assert').strict;
+const {exit} = require('node:process');
+const test = require('node:test');
+
+const asyncAuto = require('async/auto');
+const asyncRetry = require('async/retry');
+const {setupChannel} = require('ln-docker-daemons');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {closeChannel} = require('./../../');
+const {createHodlInvoice} = require('./../../');
+const {delay} = require('./../macros');
+const {getChainTransactions} = require('./../../');
+const {getClosedChannels} = require('./../../');
+const {getInvoice} = require('./../../');
+const {getPendingChannels} = require('./../../');
+const {getPendingSweeps} = require('./../../');
+const {getWalletInfo} = require('./../../');
+const {openChannel} = require('./../../');
+const {pay} = require('./../../');
+
+const blockDelay = 50;
+const channelCapacityTokens = 1e6;
+const confirmationCount = 6;
+const defaultFee = 1e3;
+const give = 1e5;
+const interval = 50;
+const size = 2;
+const times = 10000;
+const tokens = 100;
+
+// Force close a channel and get the resulting pending sweeps
+test(`Get pending sweeps`, async t => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  t.after(() => exit());
+
+  const [{generate, lnd}, target] = nodes;
+
+  await asyncRetry({interval, times}, async () => {
+    const wallet = await getWalletInfo({lnd});
+
+    await generate({});
+
+    if (!wallet.is_synced_to_chain) {
+      throw new Error('NotSyncedToChain');
+    }
+  });
+
+  const channel = await setupChannel({
+    generate,
+    lnd,
+    give_tokens: give,
+    partner_csv_delay: blockDelay,
+    to: target,
+  });
+
+  const closing = await closeChannel({
+    lnd,
+    is_force_close: true,
+    transaction_id: channel.transaction_id,
+    transaction_vout: channel.transaction_vout,
+  });
+
+  await asyncRetry({interval, times}, async () => {
+    await generate({});
+
+    if (!!(await getClosedChannels({lnd})).channels.length) {
+      return;
+    }
+
+    throw new Error('ExpectedClosedChannel');
+  });
+
+  const {sweeps} = await getPendingSweeps({lnd});
+
+  const [sweep] = sweeps;
+
+  equal(sweep.transaction_id, closing.transaction_id, 'Got closing sweep');
+
+  await kill({});
+
+  return;
+});

package/test/walletrpc-integration/test_request_batched_fee_increase.js

@@ -0,0 +1,61 @@
+const {deepEqual} = require('node:assert').strict;
+const {equal} = require('node:assert').strict;
+const {fail} = require('node:assert').strict;
+const test = require('node:test');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {broadcastChainTransaction} = require('./../../');
+const {createChainAddress} = require('./../../');
+const {delay} = require('./../macros');
+const {fundPsbt} = require('./../../');
+const {getPendingSweeps} = require('./../../');
+const {getUtxos} = require('./../../');
+const {requestBatchedFeeIncrease} = require('./../../');
+const {signPsbt} = require('./../../');
+
+const count = 100;
+const tokens = 1e8;
+
+// Test requesting a batched chain fee increase
+test(`Request batched chain fee increase`, async () => {
+  const [{generate, kill, lnd}] = (await spawnLightningCluster({})).nodes;
+
+  try {
+    await generate({count});
+
+    const {address} = await createChainAddress({lnd});
+
+    const {psbt} = await fundPsbt({lnd, outputs: [
+      {address, tokens},
+      {tokens, address: '2N8hwP1WmJrFF5QWABn38y63uYLhnJYJYTF'},
+    ]});
+
+    const {transaction} = await signPsbt({lnd, psbt});
+
+    await broadcastChainTransaction({lnd, transaction});
+
+    const bump = (await getUtxos({lnd})).utxos.find(n => n.tokens === tokens);
+
+    await requestBatchedFeeIncrease({
+      lnd,
+      transaction_id: bump.transaction_id,
+      transaction_vout: bump.transaction_vout,
+    });
+
+    const {sweeps} = await getPendingSweeps({lnd});
+
+    const [sweep] = sweeps;
+
+    equal(sweep.transaction_id, bump.transaction_id, 'Requested tx id bump');
+    equal(sweep.transaction_vout, bump.transaction_vout, 'Requested tx vout');
+
+    await kill({});
+  } catch (err) {
+    await kill({});
+
+    equal(err, null, 'Expected no error');
+  }
+
+  return;
+});