lightning 10.10.3 → 10.11.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Versions
 
-## 10.10.3
+## 10.11.0
+
+- `getChannel`, `getNetworkGraph`, `getNode`: Add
+    `inbound_base_discount_mtokens` and `inbound_rate_discount`
+
+## 10.10.4
 
 - `getPeers`: Set minimum possible peer ping time to positive zero
 

package/lnd_methods/info/get_channel.js

@@ -12,6 +12,9 @@ const edgeNotFoundErrorMessage = 'edge not found';
 
   Requires `info:read` permission
 
+  `inbound_base_discount_mtokens` is not supported on LND 0.17.5 and below
+  `inbound_rate_discount` is not supported on LND 0.17.5 and below
+
   {
     id: <Standard Format Channel Id String>
     lnd: <Authenticated LND API Object>
@@ -25,6 +28,8 @@ const edgeNotFoundErrorMessage = 'edge not found';
       [base_fee_mtokens]: <Base Fee Millitokens String>
       [cltv_delta]: <Locktime Delta Number>
       [fee_rate]: <Fees Charged in Millitokens Per Million Number>
+      [inbound_base_discount_mtokens]: <Source Based Base Fee Reduction String>
+      [inbound_rate_discount]: <Source Based Per Million Rate Reduction Number>
       [is_disabled]: <Channel Is Disabled Bool>
       [max_htlc_mtokens]: <Maximum HTLC Millitokens Value String>
       [min_htlc_mtokens]: <Minimum HTLC Millitokens Value String>

package/lnd_methods/info/get_network_graph.js

@@ -16,6 +16,9 @@ const type = 'default';
 
   Requires `info:read` permission
 
+  `inbound_base_discount_mtokens` is not supported on LND 0.17.5 and below
+  `inbound_rate_discount` is not supported on LND 0.17.5 and below
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -29,6 +32,8 @@ const type = 'default';
         [base_fee_mtokens]: <Bae Fee Millitokens String>
         [cltv_delta]: <CLTV Height Delta Number>
         [fee_rate]: <Fee Rate In Millitokens Per Million Number>
+        [inbound_base_discount_mtokens]: <Source Base Fee Reduction String>
+        [inbound_rate_discount]: <Source Per Million Rate Reduction Number>
         [is_disabled]: <Edge is Disabled Bool>
         [max_htlc_mtokens]: <Maximum HTLC Millitokens String>
         [min_htlc_mtokens]: <Minimum HTLC Millitokens String>

package/lnd_methods/info/get_node.js

@@ -22,6 +22,9 @@ const type = 'default';
 
   Requires `info:read` permission
 
+  `inbound_base_discount_mtokens` is not supported on LND 0.17.5 and below
+  `inbound_rate_discount` is not supported on LND 0.17.5 and below
+
   {
     [is_omitting_channels]: <Omit Channels from Node Bool>
     lnd: <Authenticated LND API Object>
@@ -40,6 +43,8 @@ const type = 'default';
         [base_fee_mtokens]: <Base Fee Millitokens String>
         [cltv_delta]: <Locktime Delta Number>
         [fee_rate]: <Fees Charged in Millitokens Per Million Number>
+        [inbound_base_discount_mtokens]: <Source Base Fee Reduction String>
+        [inbound_rate_discount]: <Source Per Million Rate Reduction Number>
         [is_disabled]: <Channel Is Disabled Bool>
         [max_htlc_mtokens]: <Maximum HTLC Millitokens Value String>
         [min_htlc_mtokens]: <Minimum HTLC Millitokens Value String>

package/lnd_methods/offchain/update_routing_fees.js

@@ -11,6 +11,7 @@ const feeRatio = 1e6;
 const {floor} = Math;
 const {isArray} = Array;
 const method = 'updateChannelPolicy';
+const surcharge = discount => discount === undefined ? undefined : -discount;
 const tokensAsMtokens = tokens => (BigInt(tokens) * BigInt(1e3)).toString();
 const type = 'default';
 
@@ -29,6 +30,8 @@ const type = 'default';
     [base_fee_tokens]: <Base Fee Tokens Charged Number>
     [cltv_delta]: <HTLC CLTV Delta Number>
     [fee_rate]: <Fee Rate In Millitokens Per Million Number>
+    [inbound_base_discount_mtokens]: <Inbound Fee Millitokens Reduction String>
+    [inbound_rate_discount]: <Source Millitokens Per Million Discount Number>
     lnd: <Authenticated LND API Object>
     [max_htlc_mtokens]: <Maximum HTLC Millitokens to Forward String>
     [min_htlc_mtokens]: <Minimum HTLC Millitokens to Forward String>
@@ -105,6 +108,8 @@ module.exports = (args, cbk) => {
           chan_point: !isGlobal ? chan : undefined,
           fee_rate: rate / feeRatio,
           global: isGlobal || undefined,
+          inbound_base_fee_msat: surcharge(args.inbound_base_discount_mtokens),
+          inbound_fee_rate_ppm: surcharge(args.inbound_rate_discount),
           max_htlc_msat: args.max_htlc_mtokens || undefined,
           min_htlc_msat: args.min_htlc_mtokens || undefined,
           min_htlc_msat_specified: !!args.min_htlc_mtokens,

package/lnd_methods/onchain/request_chain_fee_increase.js

@@ -69,7 +69,6 @@ module.exports = (args, cbk) => {
       request: ['feeRate', ({feeRate}, cbk) => {
         return args.lnd[type][method]({
           force: true,
-          immediate: true,
           outpoint: {
             output_index: args.transaction_vout,
             txid_str: args.transaction_id,

package/lnd_responses/channel_policy_as_policy.js

@@ -1,4 +1,6 @@
 const asDate = epochTime => new Date(epochTime * 1e3).toISOString();
+const discount = fee => (!fee ? 0 : -fee).toString();
+const inverse = rate => !rate ? 0 : -rate;
 
 /** Convert raw channel policy to standard channel policy
 
@@ -7,6 +9,8 @@ const asDate = epochTime => new Date(epochTime * 1e3).toISOString();
       disabled: <Forwarding is Disabled Bool>
       fee_base_msat: <Base Fee Tokens String>
       fee_rate_milli_msat: <Fee Rate Number String>
+      inbound_fee_base_msat: <Inbound Fee Base Number>
+      inbound_fee_rate_milli_msat: <Inbound Fee Rate Number>
       last_update: <Last Update Epoch Time Seconds Number>
       max_htlc_msat: <Maximum HTLC Millitokens String>
       min_htlc: <Minimum HTLC Millitokens String>
@@ -23,6 +27,8 @@ const asDate = epochTime => new Date(epochTime * 1e3).toISOString();
     base_fee_mtokens: <Base Fee Millitokens String>
     cltv_delta: <Forward CLTV Delta Number>
     fee_rate: <Fee Rate in Parts Per Millitoken Number>
+    inbound_base_discount_mtokens: <Source Specific Base Fee Reduction String>
+    inbound_rate_discount: <Source Specific Per Million Rate Reduction Number>
     is_disabled: <Forwarding Is Disabled Bool>
     max_htlc_mtokens: <Maximum Forward Millitokens String>
     min_htlc_mtokens: <Minimum Forward Millitokens String>
@@ -72,6 +78,8 @@ module.exports = args => {
     base_fee_mtokens: args.policy.fee_base_msat,
     cltv_delta: args.policy.time_lock_delta,
     fee_rate: Number(args.policy.fee_rate_milli_msat),
+    inbound_base_discount_mtokens: discount(args.policy.inbound_fee_base_msat),
+    inbound_rate_discount: inverse(args.policy.inbound_fee_rate_milli_msat),
     is_disabled: args.policy.disabled,
     max_htlc_mtokens: args.policy.max_htlc_msat,
     min_htlc_mtokens: args.policy.min_htlc,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "@grpc/grpc-js": "1.10.7",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "20.12.8",
+    "@types/node": "20.12.10",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,7 +22,7 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.18.1"
+    "type-fest": "4.18.2"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.10.3"
+  "version": "10.11.0"
 }

package/test/lnd_methods/info/test_get_channel.js

@@ -128,6 +128,8 @@ const tests = [
           base_fee_mtokens: '1',
           cltv_delta: 1,
           fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: true,
           max_htlc_mtokens: '1',
           min_htlc_mtokens: '1',
@@ -138,6 +140,8 @@ const tests = [
           base_fee_mtokens: '2',
           cltv_delta: 2,
           fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: false,
           max_htlc_mtokens: '2',
           min_htlc_mtokens: '2',

package/test/lnd_methods/info/test_get_network_graph.js

@@ -117,6 +117,8 @@ const tests = [
             base_fee_mtokens: '1000',
             cltv_delta: 1,
             fee_rate: 1,
+            inbound_base_discount_mtokens: '0',
+            inbound_rate_discount: 0,
             is_disabled: false,
             max_htlc_mtokens: '1000',
             min_htlc_mtokens: '1000',
@@ -127,6 +129,8 @@ const tests = [
             base_fee_mtokens: '2',
             cltv_delta: 2,
             fee_rate: 2,
+            inbound_base_discount_mtokens: '0',
+            inbound_rate_discount: 0,
             is_disabled: true,
             max_htlc_mtokens: '2',
             min_htlc_mtokens: '2',

package/test/lnd_methods/info/test_get_node.js

@@ -98,6 +98,8 @@ const makeExpected = ({}) => {
           base_fee_mtokens: '1',
           cltv_delta: 1,
           fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: true,
           max_htlc_mtokens: '1',
           min_htlc_mtokens: '1',
@@ -108,6 +110,8 @@ const makeExpected = ({}) => {
           base_fee_mtokens: '2',
           cltv_delta: 2,
           fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: false,
           max_htlc_mtokens: '2',
           min_htlc_mtokens: '2',

package/test/lnd_responses/test_channel_edge_as_channel.js

@@ -60,6 +60,8 @@ const tests = [
           base_fee_mtokens: '1',
           cltv_delta: 1,
           fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: true,
           max_htlc_mtokens: '1',
           min_htlc_mtokens: '1',
@@ -70,6 +72,8 @@ const tests = [
           base_fee_mtokens: '2',
           cltv_delta: 2,
           fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: false,
           max_htlc_mtokens: '2',
           min_htlc_mtokens: '2',

package/test/lnd_responses/test_channel_policy_as_policy.js

@@ -4,6 +4,25 @@ const {throws} = require('node:assert').strict;
 
 const chanPolicyAsPolicy = require('./../../lnd_responses/channel_policy_as_policy');
 
+const makeExpected = overrides => {
+  const expected = {
+    base_fee_mtokens: '1',
+    cltv_delta: 1,
+    fee_rate: 1,
+    inbound_base_discount_mtokens: '0',
+    inbound_rate_discount: 0,
+    is_disabled: false,
+    max_htlc_mtokens: '1',
+    min_htlc_mtokens: '1',
+    public_key: '00',
+    updated_at: new Date(1000).toISOString(),
+  };
+
+  Object.keys(overrides || {}).forEach(key => expected[key] = overrides[key]);
+
+  return expected;
+};
+
 const tests = [
   {
     args: {},
@@ -94,16 +113,28 @@ const tests = [
       },
     },
     description: 'Policy mapped',
-    expected: {
-      base_fee_mtokens: '1',
-      cltv_delta: 1,
-      fee_rate: 1,
-      is_disabled: false,
-      max_htlc_mtokens: '1',
-      min_htlc_mtokens: '1',
+    expected: makeExpected({}),
+  },
+  {
+    args: {
       public_key: '00',
-      updated_at: new Date(1000).toISOString(),
+      policy: {
+        disabled: false,
+        fee_base_msat: '1',
+        fee_rate_milli_msat: '1',
+        inbound_fee_base_msat: -1,
+        inbound_fee_rate_milli_msat: -1,
+        last_update: 1,
+        max_htlc_msat: '1',
+        min_htlc: '1',
+        time_lock_delta: 1,
+      },
     },
+    description: 'Policy mapped',
+    expected: makeExpected({
+      inbound_base_discount_mtokens: '1',
+      inbound_rate_discount: 1,
+    }),
   },
 ];
 

package/test/lnd_responses/test_node_info_as_node.js

@@ -75,6 +75,8 @@ const makeExpected = overrides => {
           base_fee_mtokens: '1',
           cltv_delta: 1,
           fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: true,
           max_htlc_mtokens: '1',
           min_htlc_mtokens: '1',
@@ -85,6 +87,8 @@ const makeExpected = overrides => {
           base_fee_mtokens: '2',
           cltv_delta: 2,
           fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
           is_disabled: false,
           max_htlc_mtokens: '2',
           min_htlc_mtokens: '2',

package/test/lnd_responses/test_rpc_peer_as_peer.js

@@ -30,7 +30,6 @@ const makePeer = overrides => {
   return response;
 };
 
-
 const makeExpected = overrides => {
   const expected = {
     bytes_received: 1,