ln-service 54.2.6 → 54.3.0

package/CHANGELOG.md

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

package/README.md

@@ -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
@@ -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

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.7",
+    "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",
@@ -63,5 +63,5 @@
     "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.6"
+  "version": "54.3.0"
 }

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();
+});