ln-service 57.22.3 → 57.23.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 57.23.0
+
+- `getRoutingFeeEstimate`: Add method to estimate an offchain payment fee
+
 ## 57.22.3
 
 - Add support for LND 0.18.4

package/README.md

@@ -223,6 +223,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
+- [getRoutingFeeEstimate](#getroutingfeeestimate) - Get offchain fee estimate
 - [getSettlementStatus](#getsettlementstatus) - Get status of a received HTLC
 - [getSweepTransactions](#getsweeptransactions) - Get transactions sweeping to
     self
@@ -3629,6 +3630,35 @@ const {route} = await getRouteToDestination({destination, lnd, tokens});
 await payViaRoutes({lnd, routes: [route]});
 ```
 
+### getRoutingFeeEstimate
+
+    Estimate routing fees and timeout required to pay a payment request
+
+    Requires `offchain:read` permission
+
+    This method is not supported on LND 0.18.3 and below
+
+   {
+      lnd: <Authenticated LND API Object>
+      request: <BOLT 11 Payment Request String>
+      [timeout]: <Maximum Route Pathfinding Time in Milliseconds Number>
+    }
+
+    @returns via cbk or Promise
+    {
+      fee_mtokens: <Estimated Minimum Required Route Fee Millitokens String>
+      timeout: <Estimated Minimum Time Lock Block Height Delay Number>
+    }
+
+Example:
+
+```node
+const {getRoutingFeeEstimate} = require('ln-service');
+
+// Get the minimum fee required to make an offchain payment to a request
+const minFeeMtok = (await getRoutingFeeEstimate({lnd, request})).fee_mtokens;
+```
+
 ### getSettlementStatus
 
 Get the settlement status of a received HTLC

package/index.js

@@ -80,6 +80,7 @@ const {getPublicKey} = require('lightning');
 const {getRouteConfidence} = require('lightning');
 const {getRouteThroughHops} = require('lightning');
 const {getRouteToDestination} = require('lightning');
+const {getRoutingFeeEstimate} = require('lightning');
 const {getSettlementStatus} = require('lightning');
 const {getSweepTransactions} = require('lightning');
 const {getTowerServerInfo} = require('lightning');
@@ -246,6 +247,7 @@ module.exports = {
   getRouteConfidence,
   getRouteThroughHops,
   getRouteToDestination,
+  getRoutingFeeEstimate,
   getSettlementStatus,
   getSweepTransactions,
   getTowerServerInfo,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.9.4",
     "invoices": "3.0.0",
-    "lightning": "10.22.3",
+    "lightning": "10.23.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -73,5 +73,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.22.3"
+  "version": "57.23.0"
 }

package/test/routerrpc-integration/test_get_routing_fee_estimate.js

@@ -0,0 +1,76 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {setupChannel} = require('ln-docker-daemons');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {addPeer} = require('./../../');
+const {createInvoice} = require('./../../');
+const {getRoutingFeeEstimate} = require('./../../');
+const {getWalletInfo} = require('./../../');
+const {probeForRoute} = require('./../../');
+const {waitForRoute} = require('./../macros');
+
+const channelCapacityTokens = 1e6;
+const interval = 50;
+const size = 3;
+const times = 9000;
+const tokens = 1e6 / 2;
+
+// Getting routing fee estimate should return required fee for a route
+test('Get route confidence', async () => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [{generate, lnd}, target, remote] = nodes;
+
+  await asyncRetry({interval, times}, async () => {
+    const wallet = await getWalletInfo({lnd});
+
+    await generate({});
+
+    if (!wallet.is_synced_to_chain) {
+      throw new Error('NotSyncedToChain');
+    }
+  });
+
+  try {
+    // Create a channel from the control to the target node
+    await setupChannel({
+      generate,
+      lnd,
+      capacity: channelCapacityTokens,
+      to: target,
+    });
+
+    // Create a channel from target to remote
+    await setupChannel({
+      generate: target.generate,
+      give: Math.round(channelCapacityTokens / 2),
+      lnd: target.lnd,
+      to: remote,
+    });
+
+    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+    const destination = remote.id;
+
+    // Allow time for graph sync to complete
+    const {routes} = await waitForRoute({destination, lnd, tokens});
+
+    const {request} = await createInvoice({tokens, lnd: remote.lnd});
+
+    const height = (await getWalletInfo({lnd})).current_block_height;
+
+    const estimate = await getRoutingFeeEstimate({lnd, request});
+
+    equal(estimate.fee_mtokens, '1500', 'Got fee');
+    equal(estimate.timeout - height, 83, 'Got timeout');
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  } finally {
+    await kill({});
+  }
+
+  return;
+});