ln-service 57.17.0 → 57.18.0

package/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Versions
 
+## 57.18.0
+
+- `getMinimumRelayFee`: Add method to get the chain backend minimum relay fee
+
 ## 57.17.0
 
 - `getFeeRates`: Add support for `inbound_base_discount_mtokens`,
-    'inbound_rate_discount` for inbound fee policy discounts
+    `inbound_rate_discount` for inbound fee policy discounts
 
 ## 57.16.0
 

package/README.md

@@ -2732,6 +2732,25 @@ const allowedMethods = methods.filter(method => {
 });
 ```
 
+### getMinimumRelayFee
+
+Get the current minimum relay fee for the chain backend
+
+Requires LND built with `walletrpc` tag
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.18.2 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      tokens_per_vbyte: <Minimum Relayable Tokens Per Virtual Byte Number>
+    }
+
 ### getNetworkCentrality
 
 Get the graph centrality scores of the nodes on the network

package/index.js

@@ -63,6 +63,7 @@ const {getInvoices} = require('lightning');
 const {getLockedUtxos} = require('lightning');
 const {getMasterPublicKeys} = require('lightning');
 const {getMethods} = require('lightning');
+const {getMinimumRelayFee} = require('lightning');
 const {getNetworkCentrality} = require('lightning');
 const {getNetworkGraph} = require('lightning');
 const {getNetworkInfo} = require('lightning');
@@ -228,6 +229,7 @@ module.exports = {
   getLockedUtxos,
   getMasterPublicKeys,
   getMethods,
+  getMinimumRelayFee,
   getNetworkCentrality,
   getNetworkGraph,
   getNetworkInfo,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.9.4",
     "invoices": "3.0.0",
-    "lightning": "10.17.0",
+    "lightning": "10.18.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "4.0.0",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.21",
+    "ln-docker-daemons": "6.0.22",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -74,5 +74,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.17.0"
+  "version": "57.18.0"
 }

package/test/walletrpc-integration/test_get_minimum_relay_fee.js

@@ -0,0 +1,26 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {getMinimumRelayFee} = require('./../../');
+
+// Getting the min chain fee rate should return the min fee rate
+test(`Get minimum chain fee rate`, async () => {
+  const [{kill, lnd}] = (await spawnLightningCluster({})).nodes;
+
+  try {
+    const feeRate = await getMinimumRelayFee({lnd});
+
+    await kill({});
+
+    // LND 0.18.2 and below do not return a minimum relay fee rate
+    if (!!feeRate.tokens_per_vbyte) {
+      equal(feeRate.tokens_per_vbyte, 1.012, 'Fee rate is returned');
+    }
+  } catch (err) {
+    equal(null, err, 'Expected no error getting relay fee');
+  }
+
+  return;
+});