ln-service 54.2.5 → 54.3.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 54.3.0
+
+- `getSettlementStatus`: Add method to lookup received htlc settlement status
+
+## 54.2.6
+
+- `getWalletInfo`: Add support for LND 0.14.5
+
 ## 54.2.5
 
 - `getWalletInfo`: Add support for LND 0.15.4

package/README.md

@@ -10,7 +10,7 @@ through npm.
 Supported LND versions:
 
 - v0.15.2-beta to v0.15.4-beta
-- v0.14.4-beta
+- v0.14.4-beta to v0.14.5-beta
 
 For typescript-ready methods, check out https://github.com/alexbosworth/lightning#readme
 
@@ -177,6 +177,7 @@ for `unlocker` methods.
 - [getRouteConfidence](#getrouteconfidence) - Get confidence in a route
 - [getRouteThroughHops](#getroutethroughhops) - Get a route through nodes
 - [getRouteToDestination](#getroutetodestination) - Get a route to a destination
+- [getSettlementStatus](#getsettlementstatus) - Get status of a received HTLC
 - [getSweepTransactions](#getsweeptransactions) - Get transactions sweeping to
     self
 - [getTowerServerInfo](#gettowerserverinfo) - Get information about tower server
@@ -290,7 +291,7 @@ for `unlocker` methods.
 
 Add a new advertised p2p socket address
 
-Note: this method is not supported in LND versions 0.14.3 and below
+Note: this method is not supported in LND versions 0.14.5 and below
 
 Requires LND built with `peersrpc` build tag
 
@@ -391,7 +392,7 @@ Requires LND built with `signrpc`, `walletrpc` build tags
 
 Requires `address:read`, `signer:generate` permissions
 
-This method is not supported in LND 0.14.3 and below
+This method is not supported in LND 0.14.5 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -593,7 +594,7 @@ Create a new receive address.
 
 Requires `address:write` permission
 
-LND 0.14.3 and below do not support p2tr addresses
+LND 0.14.5 and below do not support p2tr addresses
 
     {
       [format]: <Receive Address Type String> // "np2wpkh" || "p2tr" || "p2wpkh"
@@ -1175,7 +1176,7 @@ Requires LND built with `signrpc` build tag
 
 Requires `signer:generate` permission
 
-This method is not supported in LND 0.14.3 and below
+This method is not supported in LND 0.14.5 and below
 
     {
       id: <Session Id Hex String>
@@ -3075,7 +3076,7 @@ Call this iteratively after failed route attempts to get new routes
 
 Requires `info:read` permission
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -3153,6 +3154,43 @@ const {route} = await getRouteToDestination({destination, lnd, tokens});
 await payViaRoutes({lnd, routes: [route]});
 ```
 
+### getSettlementStatus
+
+Get the settlement status of a received HTLC
+
+Note: this method is not supported in LND versions 0.15.4 and below
+
+Requires `offchain:read` permissions
+
+    {
+      channel: <Standard Format Channel Id String>
+      lnd: <Authenticated LND API Object>
+      payment: <Payment Id Number>
+    }
+
+    @returns via cbk or Promise
+    {
+      is_onchain: <Payment Went to Chain Bool>
+      is_settled: <Payment Is Settled Into Non-HTLC Balance Bool>
+    }
+
+Example:
+
+```node
+const {getSettlementStatus} = require('ln-service');
+const {getChannels} = require('ln-service');
+
+const [channel] = (await getChannels({lnd})).channels;
+
+const settlement = await getSettlementStatus({
+  lnd,
+  channel: channel.id,
+  payment: 0,
+});
+
+const isSettledOffchain = settlement.is_settled && !settlement.is_onchain;
+```
+
 ### getSweepTransactions
 
 Get self-transfer spend transactions related to channel closes
@@ -3479,7 +3517,7 @@ Determine if a payment destination is actually payable by probing it
 
 Requires `offchain:write` permission
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -3569,8 +3607,8 @@ If give_tokens is set, it is a gift and it does not alter the capacity
 
 Requires `offchain:write`, `onchain:write`, `peers:write` permissions
 
-`base_fee_mtokens` is not supported on LND 0.15.3 and below
-`fee_rate` is not supported on LND 0.15.3 and below
+`base_fee_mtokens` is not supported on LND 0.15.4 and below
+`fee_rate` is not supported on LND 0.15.4 and below
 
     {
       [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
@@ -3622,8 +3660,8 @@ after the funding step.
 `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
 as well as a channel open request listener to accept the trusted funding.
 
-`base_fee_mtokens` is not supported on LND 0.15.3 and below
-`fee_rate` is not supported on LND 0.15.3 and below
+`base_fee_mtokens` is not supported on LND 0.15.4 and below
+`fee_rate` is not supported on LND 0.15.4 and below
 
     {
       channels: [{
@@ -3779,7 +3817,7 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [confidence]: <Preferred Route Confidence Number Out of One Million Number>
@@ -3869,7 +3907,7 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -3959,7 +3997,7 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [confidence]: <Preferred Route Confidence Number Out of One Million Number>
@@ -4164,7 +4202,7 @@ If `total_mtokens` are specified, a `payment` nonce is required.
 
 Requires `offchain:write` permission
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -4350,7 +4388,7 @@ await recoverFundsFromChannels({backup, lnd});
 
 Remove an existing advertised p2p socket address
 
-Note: this method is not supported in LND versions 0.14.3 and below
+Note: this method is not supported in LND versions 0.14.5 and below
 
 Requires LND built with `peersrpc` build tag
 
@@ -4867,8 +4905,8 @@ Requires LND built with `signrpc` build tag
 
 Requires `signer:generate` permission
 
-`root_hash` is not supported in LND 0.14.3 and below
-`spending` is not supported in LND 0.14.3 and below
+`root_hash` is not supported in LND 0.14.5 and below
+`spending` is not supported in LND 0.14.5 and below
 
     {
       inputs: [{
@@ -5042,7 +5080,7 @@ Requires LND built with `chainrpc` build tag
 
 Requires `onchain:read` permission
 
-Subscribing to P2TR outputs is not supported in LND 0.14.3 and below
+Subscribing to P2TR outputs is not supported in LND 0.14.5 and below
 
     {
       [bech32_address]: <Bech32 P2WPKH or P2WSH Address String>
@@ -5770,7 +5808,7 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -5936,7 +5974,7 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [confidence]: <Preferred Route Confidence Number Out of One Million Number>
@@ -6272,7 +6310,7 @@ Subscribe to outgoing payments
 
 Requires `offchain:read` permission
 
-Note: Method not supported on LND 0.15.3 and below
+Note: Method not supported on LND 0.15.4 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -6452,7 +6490,7 @@ Subscribe to a probe attempt
 
 Requires `offchain:write` permission
 
-Preferred `confidence` is not supported on LND 0.14.3 and below
+Preferred `confidence` is not supported on LND 0.14.5 and below
 
     {
       [cltv_delta]: <Final CLTV Delta Number>
@@ -6949,7 +6987,7 @@ await unlockWallet({lnd, password: 'walletSecretPassword'});
 
 Update the node alias as advertised in the graph
 
-Note: this method is not supported in LND versions 0.14.3 and below
+Note: this method is not supported in LND versions 0.14.5 and below
 
 Requires LND built with `peersrpc` build tag
 
@@ -7003,7 +7041,7 @@ await updateChainTransaction({id, lnd, description: 'First transaction'});
 
 Update the node color as advertised in the graph
 
-Note: this method is not supported in LND versions 0.14.3 and below
+Note: this method is not supported in LND versions 0.14.5 and below
 
 Requires LND built with `peersrpc` build tag
 
@@ -7062,7 +7100,7 @@ Requires LND built with `signrpc` build tag
 
 Requires `signer:generate` permission
 
-This method is not supported in LND 0.14.3 and below
+This method is not supported in LND 0.14.5 and below
 
     {
       hash: <Hash to Sign Hex String>

package/index.js

@@ -70,6 +70,7 @@ const {getPublicKey} = require('lightning');
 const {getRouteConfidence} = require('lightning');
 const {getRouteThroughHops} = require('lightning');
 const {getRouteToDestination} = require('lightning');
+const {getSettlementStatus} = require('lightning');
 const {getSweepTransactions} = require('lightning');
 const {getTowerServerInfo} = require('lightning');
 const {getUtxos} = require('lightning');
@@ -221,6 +222,7 @@ module.exports = {
   getRouteConfidence,
   getRouteThroughHops,
   getRouteToDestination,
+  getSettlementStatus,
   getSweepTransactions,
   getTowerServerInfo,
   getUtxos,

package/package.json

@@ -10,11 +10,11 @@
     "bolt07": "1.8.2",
     "cors": "2.8.5",
     "express": "4.18.2",
-    "invoices": "2.2.0",
-    "lightning": "6.2.6",
+    "invoices": "2.2.1",
+    "lightning": "6.3.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
-    "ws": "8.10.0"
+    "ws": "8.11.0"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
@@ -28,7 +28,7 @@
     "bn.js": "5.2.1",
     "bs58check": "2.1.2",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "3.1.4",
+    "ln-docker-daemons": "3.1.5",
     "p2tr": "1.3.2",
     "portfinder": "1.0.32",
     "psbt": "2.7.1",
@@ -59,8 +59,9 @@
     "integration-test-0.15.4": "DOCKER_LND_VERSION=v0.15.4-beta npm run test",
     "integration-test-0.15.3": "DOCKER_LND_VERSION=v0.15.3-beta npm run test",
     "integration-test-0.15.2": "DOCKER_LND_VERSION=v0.15.2-beta npm run test",
+    "integration-test-0.14.5": "DOCKER_LND_VERSION=v0.14.5-beta npm run test",
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-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/peersrpc-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": "54.2.5"
+  "version": "54.3.0"
 }

package/test/integration/test_create_chain_address.js

@@ -40,7 +40,7 @@ test(`Create address results in address creation`, async ({end, equal}) => {
 
     equal(address.startsWith(prefixForV1), true, 'A taproot address is made');
   } catch (err) {
-    // LND 0.14.3 and below do not support TR addresses
+    // LND 0.14.5 and below do not support TR addresses
     const [code] = err;
 
     equal(code, 501, 'Taproot addresses are unsupported');

package/test/integration/test_get_pending_force.js

@@ -178,7 +178,7 @@ test(`Get pending channels`, async ({end, equal}) => {
   equal(forceClose.received, 0, 'No receive amount');
   equal(forceClose.recovered_tokens, undefined, 'No recovered amount');
 
-  // LND 0.14.3 and below do not support remote balance info
+  // LND 0.14.5 and below do not support remote balance info
   if (!!forceClose.remote_balance) {
     equal(forceClose.remote_balance, giftTokens, 'Got gift remote balance');
   } else {

package/test/integration/test_get_settlement_status.js

@@ -0,0 +1,65 @@
+const asyncRetry = require('async/retry');
+const {setupChannel} = require('ln-docker-daemons');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {createInvoice} = require('./../../');
+const {getSettlementStatus} = require('./../../');
+const {pay} = require('./../../');
+
+const fakeChannelId = '1x1x1';
+const interval = 100;
+const size = 2;
+const times = 1000;
+const tokens = 100;
+
+// Get the settlement status of an HTLC
+test(`Get settlement status`, async ({end, equal, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [{generate, lnd}, target] = nodes;
+
+  // LND 0.15.4 and below do not support settlement status lookups
+  try {
+    await getSettlementStatus({
+      lnd: target.lnd,
+      channel: fakeChannelId,
+      payment: Number(),
+    });
+  } catch (err) {
+    const [code, message] = err;
+
+    if (code !== 404) {
+      equal(code, 501, 'Method unsupported');
+      equal(message, 'LookupHtlcMethodUnsupported', 'Got unsupported message');
+
+      await kill({});
+
+      return end();
+    }
+  }
+
+  try {
+    const channel = await setupChannel({generate, lnd, to: target});
+
+    const {request} = await createInvoice({tokens, lnd: target.lnd});
+
+    const payment = await pay({lnd, request});
+
+    const settlement = await asyncRetry({interval, times}, async () => {
+      return await getSettlementStatus({
+        lnd: target.lnd,
+        channel: channel.id,
+        payment: Number(),
+      });
+    });
+
+    strictSame(settlement, {is_onchain: false, is_settled: true}, 'Status');
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/integration/test_open_channel.js

@@ -70,7 +70,7 @@ test(`Open channel`, async ({end, equal}) => {
       throw new Error('ExpectedKnownPolicyBaseFeeMtokens');
     }
 
-    // LND 0.15.3 and below do not support setting fees on open
+    // LND 0.15.4 and below do not support setting fees on open
     if (policy.base_fee_mtokens === defaultBaseFee) {
       return;
     }

package/test/integration/test_open_channels.js

@@ -139,7 +139,7 @@ test(`Open channels`, async ({end, equal}) => {
 
       const policy = policies.find(n => !!n.cltv_delta);
 
-      // LND 0.15.3 and below do not support setting fees on open
+      // LND 0.15.4 and below do not support setting fees on open
       if (policy.base_fee_mtokens === defaultBaseFee) {
         return;
       }

package/test/integration/test_trusted_funding.js

@@ -162,7 +162,9 @@ test(`Open unconfirmed channels`, async ({end, equal, match, strictSame}) => {
 
     match(otherId, /16000000x0/, 'Got ephemeral id');
 
-    await closeChannel({lnd, id: confirmed.id});
+    await asyncRetry({interval, times}, async () => {
+      await closeChannel({lnd, id: confirmed.id});
+    });
 
     // Propose a private channel to the peer
     const openPrivate = await asyncRetry({interval, times}, async () => {

package/test/routerrpc-integration/test_subscribe_to_payments.js

@@ -43,7 +43,7 @@ test(`Subscribe to payments`, async ({end, rejects, strictSame}) => {
     sub.on('error', error => {
       const [,, {err}] = error;
 
-      // subscribeToPayments is not supported on LND 0.15.3 and below
+      // subscribeToPayments is not supported on LND 0.15.4 and below
       if (err.details === unsupported) {
         return isLegacy.push(error);
       }

package/test/signerrpc-integration/test_begin_group_signing_session.js

@@ -49,7 +49,7 @@ test(`Begin group signing session`, async ({end, equal}) => {
       public_keys: [Buffer.alloc(33, 2).toString('hex')],
     });
   } catch (err) {
-    // On LND 0.14.3 and below, group signing is not supported
+    // On LND 0.14.5 and below, group signing is not supported
     if (err.slice().shift() === 501) {
       await kill({});
 

package/test/signerrpc-integration/test_sign_taproot.js

@@ -48,7 +48,7 @@ test(`Sign a taproot transaction`, async ({end, equal}) => {
       public_keys: [Buffer.alloc(33, 2).toString('hex')],
     });
   } catch (err) {
-    // On LND 0.14.3 and below, taproot signing is not supported
+    // On LND 0.14.5 and below, taproot signing is not supported
     if (err.slice().shift() === 501) {
       await kill({});
 

package/test/tower_clientrpc-integration/test_disconnect_watchtower.js

@@ -38,7 +38,7 @@ test(`Disconnect watchtower`, async ({end, equal, match}) => {
 
   const [disconnected] = (await getConnectedWatchtowers({lnd})).towers;
 
-  // LND 0.15.3 and below retain the tower
+  // LND 0.15.4 and below retain the tower
   if (!!disconnected) {
     equal(disconnected.is_active, false, 'Tower is inactive');
   }