bolt07 1.8.4 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 1.9.0
+
+- `hopsFromChannels`, `routeFromChannels`, `routeFromHops`: Add support for
+    inbound discounts
+
 ## 1.8.4
 
 - `decodeSocket`: Decode a connection socket from hex data

package/ids/chan_number.js

@@ -27,4 +27,3 @@ module.exports = ({channel, id}) => {
 
   return {number: new BN(Buffer.from(rawId, 'hex')).toString(decBase)};
 };
-

package/package.json

@@ -28,5 +28,5 @@
   "scripts": {
     "test": "npx nyc@15.1 node --experimental-test-coverage --test"
   },
-  "version": "1.8.4"
+  "version": "1.9.0"
 }

package/routing/hops_from_channels.js

@@ -15,6 +15,8 @@ const payNodesCount = 2;
         base_fee_mtokens: <Base Fee Millitokens String>
         cltv_delta: <Locktime Delta Number>
         fee_rate: <Fees Charged Per Million Tokens 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>
         min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
         public_key: <Node Public Key String>
@@ -34,6 +36,8 @@ const payNodesCount = 2;
       channel_capacity: <Maximum Tokens Number>
       cltv_delta: <CLTV 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>
       public_key: <Public Key Hex String>
     }]
   }
@@ -74,7 +78,7 @@ module.exports = ({channels, destination}) => {
     const nextPolicy = chans[i + [channel].length];
     let overridePolicy;
 
-    const peer = channel.policies.find(n => n.public_key === nextHop);
+    const peer = channel.policies.find(n => n.public_key === nextHop) || {};
     const policy = channel.policies.find(n => n.public_key !== nextHop);
 
     if (!policy) {
@@ -104,6 +108,8 @@ module.exports = ({channels, destination}) => {
       channel_capacity: channel.capacity,
       cltv_delta: cltvDelta || defaultCltvDelta,
       fee_rate: (overridePolicy || policy).fee_rate,
+      inbound_base_discount_mtokens: peer.inbound_base_discount_mtokens,
+      inbound_rate_discount: peer.inbound_rate_discount,
       public_key: nextHop,
     };
   });

package/routing/policy_fee.js

@@ -1,3 +1,4 @@
+const none = '0';
 const rateDivisor = BigInt(1e6);
 
 /** Fee for policy
@@ -7,6 +8,8 @@ const rateDivisor = BigInt(1e6);
     policy: {
       base_fee_mtokens: <Base Fee Millitokens String>
       fee_rate: <Fee Rate Number>
+      [inbound_base_discount_mtokens]: <Source Base Fee Reduction String>
+      [inbound_rate_discount]: <Source Per Million Rate Reduction Number>
     }
   }
 
@@ -38,8 +41,16 @@ module.exports = ({mtokens, policy}) => {
   const baseFeeMtokens = BigInt(policy.base_fee_mtokens);
   const feeRate = BigInt(policy.fee_rate);
   const forwardMtokens = BigInt(mtokens);
+  const lowerBaseFee = BigInt(policy.inbound_base_discount_mtokens || none);
+  const lowerFeeRate = BigInt(policy.inbound_rate_discount || none);
 
+  const discount = lowerBaseFee + forwardMtokens * lowerFeeRate / rateDivisor;
   const fee = baseFeeMtokens + forwardMtokens * feeRate / rateDivisor;
 
-  return {fee_mtokens: fee.toString()};
+  // Exit early when the discount drowns out the fee
+  if (-discount > fee) {
+    return {fee_mtokens: none};
+  }
+
+  return {fee_mtokens: (fee + discount).toString()};
 };

package/routing/route_from_channels.js

@@ -17,6 +17,8 @@ const {isArray} = Array;
         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/routing/route_from_hops.js

@@ -17,6 +17,8 @@ const minFee = 0;
       [channel_capacity]: <Channel Capacity Tokens Number>
       cltv_delta: <CLTV 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>
       public_key: <Next Hop Public Key Hex String>
     }]
     initial_cltv: <Initial CLTV Delta Number>

package/test/routing/test_hops_from_channels.js

@@ -110,6 +110,8 @@ const tests = [
         channel_capacity: 16777215,
         cltv_delta: 40,
         fee_rate: 2500,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'b',
       },
       {
@@ -118,6 +120,8 @@ const tests = [
         channel_capacity: 16777215,
         cltv_delta: 30,
         fee_rate: 2500,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'c',
       },
       {
@@ -126,6 +130,8 @@ const tests = [
         channel_capacity: 16777215,
         cltv_delta: 144,
         fee_rate: 1,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'd',
       },
       {
@@ -134,6 +140,8 @@ const tests = [
         channel_capacity: 16777215,
         cltv_delta: 144,
         fee_rate: 1,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'e',
       },
     ],
@@ -151,6 +159,8 @@ const tests = [
         channel_capacity: 8429350,
         cltv_delta: 40,
         fee_rate: 2500,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: '03e50492eab4107a773141bb419e107bda3de3d55652e6e1a41225f06a0bbf2d56',
       },
       {
@@ -159,6 +169,8 @@ const tests = [
         channel_capacity: 2000000,
         cltv_delta: 40,
         fee_rate: 2500,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: '03bb88ccc444534da7b5b64b4f7b15e1eccb18e102db0e400d4b9cfe93763aa26d',
       },
       {
@@ -167,6 +179,8 @@ const tests = [
         channel_capacity: 400000,
         cltv_delta: 40,
         fee_rate: 100,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: '028dcc199be86786818c8c32bffe9db8855c5fca98951eec99d1fa335d841605c2',
       },
       {
@@ -175,6 +189,8 @@ const tests = [
         channel_capacity: 364355,
         cltv_delta: 40,
         fee_rate: 1,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: '03277a99c297a53859b42a9bb8cb2c5c17b9eaa44509bae150e2ea35ca5aa29bd9',
       },
     ],
@@ -189,6 +205,8 @@ const tests = [
         channel_capacity: 1000,
         cltv_delta: 40,
         fee_rate: 7,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'alice',
       },
       {
@@ -197,6 +215,8 @@ const tests = [
         channel_capacity: 2000,
         cltv_delta: 40,
         fee_rate: 7,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'bob',
       },
       {
@@ -205,6 +225,8 @@ const tests = [
         channel_capacity: 3000,
         cltv_delta: 40,
         fee_rate: 9,
+        inbound_base_discount_mtokens: undefined,
+        inbound_rate_discount: undefined,
         public_key: 'charlie',
       },
     ],
@@ -240,6 +262,8 @@ const tests = [
       channel_capacity: 100,
       cltv_delta: 40,
       fee_rate: 1,
+      inbound_base_discount_mtokens: undefined,
+      inbound_rate_discount: undefined,
       public_key: Buffer.alloc(33).toString('hex'),
     }],
   },
@@ -273,6 +297,117 @@ const tests = [
     description: 'Mapping hops from channels requires hop channel ids',
     expected: [],
   },
+  {
+    args: {
+      channels: [
+        {
+          capacity: 16777215,
+          destination: 'b',
+          id: '1x1x1',
+          policies: [
+            {
+              _policy_a_has_to_b: true,
+              base_fee_mtokens: '0',
+              fee_rate: 5000,
+              is_disabled: false,
+              min_htlc_mtokens: '2000',
+              public_key: 'a',
+            },
+            {
+              _policy_b_has_to_a: true,
+              base_fee_mtokens: '0',
+              fee_rate: 0,
+              inbound_base_discount_mtokens: '-5000',
+              inbound_rate_discount: 0,
+              is_disabled: false,
+              public_key: 'b',
+            },
+          ],
+        },
+        {
+          capacity: 16777215,
+          destination: 'c',
+          id: '2x2x2',
+          policies: [
+            {
+              _policy_b_has_to_c: true,
+              base_fee_mtokens: '0',
+              fee_rate: 50000,
+              is_disabled: false,
+              min_htlc_mtokens: '2000',
+              public_key: 'b',
+            },
+            {
+              _policy_c_has_to_b: true,
+              base_fee_mtokens: '0',
+              fee_rate: 0,
+              inbound_base_discount_mtokens: '8000',
+              inbound_rate_discount: 200000,
+              is_disabled: false,
+              public_key: 'c',
+            },
+          ],
+        },
+        {
+          capacity: 16777215,
+          destination: 'd',
+          id: '3x3x3',
+          policies: [
+            {
+              _policy_c_has_to_d: true,
+              base_fee_mtokens: '9000',
+              fee_rate: 100000,
+              is_disabled: false,
+              min_htlc_mtokens: '2000',
+              public_key: 'c',
+            },
+            {
+              _policy_d_has_to_c: true,
+              base_fee_mtokens: '0',
+              fee_rate: 0,
+              inbound_base_discount_mtokens: '-2000',
+              inbound_rate_discount: -80000,
+              is_disabled: false,
+              public_key: 'd',
+            },
+          ],
+        },
+      ],
+    },
+    description: 'Map channels with inbound fee rates',
+    expected: [
+      {
+        base_fee_mtokens: '0',
+        channel: '1x1x1',
+        channel_capacity: 16777215,
+        cltv_delta: 40,
+        fee_rate: 50000,
+        inbound_base_discount_mtokens: '-5000',
+        inbound_rate_discount: 0,
+        public_key: 'b',
+      },
+      {
+        base_fee_mtokens: '0',
+        channel: '2x2x2',
+        channel_capacity: 16777215,
+        cltv_delta: 40,
+        fee_rate: 50000,
+        inbound_base_discount_mtokens: '8000',
+        inbound_rate_discount: 200000,
+        public_key: 'c',
+      },
+      {
+        base_fee_mtokens: '9000',
+        channel: '3x3x3',
+        channel_capacity: 16777215,
+        cltv_delta: 40,
+        fee_rate: 100000,
+        inbound_base_discount_mtokens: '-2000',
+        inbound_rate_discount: -80000,
+        public_key: 'd',
+      },
+    ],
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

package/test/routing/test_policy_fee.js

@@ -27,9 +27,35 @@ const tests = [
   },
   {
     args: {mtokens: '1000000', policy: {base_fee_mtokens: '1', fee_rate: 1}},
-    description: 'Fee rate is required',
+    description: 'Fee is calculated',
     expected: {fee_mtokens: '2'},
   },
+  {
+    args: {
+      mtokens: '1000000',
+      policy: {
+        base_fee_mtokens: '1',
+        fee_rate: 1,
+        inbound_base_discount_mtokens: '-1',
+        inbound_rate_discount: -1,
+      },
+    },
+    description: 'Fee rate with discount is calculated',
+    expected: {fee_mtokens: '0'},
+  },
+  {
+    args: {
+      mtokens: '1000000',
+      policy: {
+        base_fee_mtokens: '1',
+        fee_rate: 1,
+        inbound_base_discount_mtokens: '-10',
+        inbound_rate_discount: -1,
+      },
+    },
+    description: 'Fee rate with big discount is calculated',
+    expected: {fee_mtokens: '0'},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {