lightning 10.12.0 → 10.13.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 10.13.0
+
+- `subscribeToGraph`: Add support for `inbound_base_discount_mtokens` and
+    `inbound_rate_discount`
+
 ## 10.12.0
 
 - `createFundedPsbt`: Add method to create a funded PSBT given inputs/outputs

package/lnd_methods/info/subscribe_to_graph.d.ts

@@ -19,6 +19,10 @@ export type SubscribeToGraphChannelUpdatedEvent = {
   min_htlc_mtokens: string;
   /** Announcing Public Key, Target Public Key */
   public_keys: [string, string];
+  /** Source Base Fee Reduction String */
+  inbound_base_discount_mtokens: string;
+  /** Source Per Million Rate Reduction Number */
+  inbound_rate_discount: number;
   /** Channel Transaction Id */
   transaction_id: string;
   /** Channel Transaction Output Index */

package/lnd_methods/info/subscribe_to_graph.js

@@ -18,6 +18,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>
   }
@@ -45,6 +48,8 @@ const type = 'default';
     cltv_delta: <Channel CLTV Delta Number>
     fee_rate: <Channel Fee Rate In Millitokens Per Million Number>
     id: <Standard Format Channel Id String>
+    inbound_base_discount_mtokens: <Source Specific Base Fee Reduction String>
+    inbound_rate_discount: <Source Specific Per Million Rate Reduction Number>
     is_disabled: <Channel Is Disabled Bool>
     [max_htlc_mtokens]: <Channel Maximum HTLC Millitokens String>
     min_htlc_mtokens: <Channel Minimum HTLC Millitokens String>

package/lnd_responses/rpc_channel_update_as_update.js

@@ -1,5 +1,6 @@
 const {chanFormat} = require('bolt07');
 
+const asDiscount = fee => !fee ? 0 : -fee;
 const bufferAsHex = buffer => buffer.toString('hex');
 const emptyTxId = Buffer.alloc(32);
 const {isBuffer} = Buffer;
@@ -20,6 +21,8 @@ const now = () => new Date().toISOString();
       disabled: <Forwarding is Disabled Bool>
       fee_base_msat: <Forwarding Base Fee Millitokens String>
       fee_rate_milli_msat: <Forwarding Fee Rate Per Million String>
+      inbound_fee_base_msat: <Inbound Fee Base Number>
+      inbound_fee_rate_milli_msat: <Inbound Fee Base Number>
       max_htlc_msat: <Maximum HTLC Size Millitokens String>
       min_htlc: <Minimum HTLC Size Millitokens String>
       time_lock_delta: <Forwarding CLTV Delta Number>
@@ -36,6 +39,8 @@ const now = () => new Date().toISOString();
     cltv_delta: <Channel CLTV Delta Number>
     fee_rate: <Channel Fee Rate In Millitokens Per Million Number>
     id: <Standard Format Channel Id String>
+    inbound_base_discount_mtokens: <Source Fee Discount Millitokens String>
+    inbound_rate_discount: <Source Based PPM Fee Discount Number>
     is_disabled: <Channel Is Disabled Bool>
     [max_htlc_mtokens]: <Channel Maximum HTLC Millitokens String>
     min_htlc_mtokens: <Channel Minimum HTLC Millitokens String>
@@ -112,6 +117,8 @@ module.exports = update => {
     throw new Error('ExpectedValidChannelId');
   }
 
+  const inBase = asDiscount(update.routing_policy.inbound_fee_base_msat);
+  const inRate = asDiscount(update.routing_policy.inbound_fee_rate_milli_msat);
   const maxHtlc = update.routing_policy.max_htlc_msat;
   const transactionId = update.chan_point.funding_txid_bytes.reverse();
 
@@ -123,6 +130,8 @@ module.exports = update => {
     cltv_delta: update.routing_policy.time_lock_delta,
     fee_rate: Number(update.routing_policy.fee_rate_milli_msat),
     id: chanFormat({number: update.chan_id}).channel,
+    inbound_base_discount_mtokens: inBase.toString(),
+    inbound_rate_discount: inRate,
     is_disabled: update.routing_policy.disabled,
     max_htlc_mtokens: maxHtlc !== Number().toString() ? maxHtlc : undefined,
     min_htlc_mtokens: update.routing_policy.min_htlc,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "@grpc/grpc-js": "1.10.8",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "20.12.12",
+    "@types/node": "20.12.13",
     "@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.2"
+    "type-fest": "4.18.3"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.12.0"
+  "version": "10.13.0"
 }

package/test/lnd_methods/info/test_subscribe_to_graph.js

@@ -472,6 +472,8 @@ const tests = [
             cltv_delta: 1,
             fee_rate: 1,
             id: '0x0x1',
+            inbound_base_discount_mtokens: '0',
+            inbound_rate_discount: 0,
             is_disabled: false,
             max_htlc_mtokens: '1',
             min_htlc_mtokens: '1',

package/test/lnd_responses/test_rpc_channel_update_as_update.js

@@ -9,6 +9,8 @@ const makeRoutingPolicy = overrides => {
     disabled: false,
     fee_base_msat: '1',
     fee_rate_milli_msat: '1',
+    inbound_fee_base_msat: 0,
+    inbound_fee_rate_milli_msat: 0,
     max_htlc_msat: '1',
     min_htlc: '1',
     time_lock_delta: 1,
@@ -44,6 +46,8 @@ const makeExpected = overrides => {
     cltv_delta: 1,
     fee_rate: 1,
     id: '0x0x1',
+    inbound_base_discount_mtokens: '0',
+    inbound_rate_discount: 0,
     is_disabled: false,
     max_htlc_mtokens: '1',
     min_htlc_mtokens: '1',
@@ -156,6 +160,19 @@ const tests = [
     description: 'RPC channel update is mapped to update',
     expected: makeExpected({}),
   },
+  {
+    args: makeArgs({
+      routing_policy: makeRoutingPolicy({
+        inbound_fee_base_msat: -1,
+        inbound_fee_rate_milli_msat: -1,
+      }),
+    }),
+    description: 'RPC channel with inbound rates is mapped',
+    expected: makeExpected({
+      inbound_base_discount_mtokens: '1',
+      inbound_rate_discount: 1,
+    }),
+  },
   {
     args: makeArgs({
       capacity: '0',