lightning 10.15.1 → 10.16.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 10.16.1
+
+- `getFeeRates`: Add support for `inbound_base_discount_mtokens`,
+    'inbound_rate_discount` for inbound fee policy discounts
+
+- `getClosedChannels`: Add support for anchor resolution status via new
+    attributes `anchor_is_confirmed`, `anchor_is_pending`, `anchor_spent_by`,
+    and `anchor_vout`
+
 ## 10.15.1
 
 - Add support for LND 0.18.2

package/lnd_methods/offchain/get_closed_channels.d.ts

@@ -74,6 +74,14 @@ export type GetClosedChannelsResult = {
     transaction_id: string;
     /** Channel Funding Output Index */
     transaction_vout: number;
+    /** Anchor CPFP Transaction Id Hex */
+    anchor_spent_by?: string,
+    /** Our Close Transaction Anchor Output Index */
+    anchor_vout?: number,
+    /** Is Anchor CPFP Transaction Confirmed */
+    anchor_is_confirmed?: boolean,
+    /** Is Anchor CPFP Transaction Pending */
+    anchor_is_pending?: boolean,
   }[];
 };
 

package/lnd_methods/offchain/get_closed_channels.js

@@ -31,6 +31,10 @@ const outpointSeparator = ':';
   @returns via cbk or Promise
   {
     channels: [{
+      [anchor_is_confirmed]: <Anchor Sweep Confirmed Bool>
+      [anchor_is_pending]: <Anchor Sweep Pending Confirmation Bool>
+      [anchor_spent_by]: <Anchor Sweep Transaction Id Hex String>
+      [anchor_vout]: <Anchor Output Index Number>
       capacity: <Closed Channel Capacity Tokens Number>
       [close_balance_spent_by]: <Channel Balance Output Spent By Tx Id String>
       [close_balance_vout]: <Channel Balance Close Tx Output Index Number>
@@ -191,10 +195,15 @@ module.exports = (args, cbk) => {
 
           const resolutions = chanResolutions.map(rpcResolutionAsResolution);
 
+          const {anchor} = resolutions.find(n => n.anchor) || {anchor: {}};
           const {balance} = resolutions.find(n => n.balance) || {balance: {}};
           const payments = resolutions.map(n => n.payment).filter(n => !!n);
 
           return cbk(null, {
+            anchor_is_confirmed: anchor.is_confirmed,
+            anchor_is_pending: anchor.is_pending,
+            anchor_spent_by: anchor.spent_by,
+            anchor_vout: anchor.transaction_vout,
             capacity: Number(chan.capacity),
             close_balance_spent_by: balance.spent_by,
             close_balance_vout: balance.transaction_vout,

package/lnd_methods/offchain/get_fee_rates.d.ts

@@ -11,6 +11,18 @@ export type GetFeeRatesResult = {
     fee_rate: number;
     /** Standard Format Channel Id */
     id: string;
+    /**
+    * Source Based Base Fee Reduction String
+    *
+    * Not supported on LND 0.17.5 and below
+    */
+    inbound_base_discount_mtokens: string;
+    /**
+    * Source Based Per Million Rate Reduction Number
+    *
+    * Not supported on LND 0.17.5 and below
+    */
+    inbound_rate_discount: number;
     /** Channel Funding Transaction Id Hex */
     transaction_id: string;
     /** Funding Outpoint Output Index */

package/lnd_methods/offchain/get_fee_rates.js

@@ -23,6 +23,8 @@ const type = 'default';
       base_fee_mtokens: <Base Flat Fee Millitokens String>
       fee_rate: <Fee Rate in Millitokens Per Million Number>
       id: <Standard Format Channel Id String>
+      inbound_base_discount_mtokens: <Source Based Base Fee Reduction String>
+      inbound_rate_discount: <Source Based Per Million Rate Reduction Number>
       transaction_id: <Channel Funding Transaction Id Hex String>
       transaction_vout: <Funding Outpoint Output Index Number>
     }]

package/lnd_responses/channel_edge_as_channel.js

@@ -43,6 +43,8 @@ const separatorChar = ':';
       [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_responses/constants.json

@@ -78,7 +78,8 @@
   "resolutionTypes": {
     "balance": "COMMIT",
     "incoming_payment": "INCOMING_HTLC",
-    "outgoing_payment": "OUTGOING_HTLC"
+    "outgoing_payment": "OUTGOING_HTLC",
+    "anchor": "ANCHOR"
   },
   "syncTypes": {
     "active": "ACTIVE_SYNC",

package/lnd_responses/rpc_fees_as_channel_fees.js

@@ -2,6 +2,8 @@ const {chanFormat} = require('bolt07');
 
 const {safeTokens} = require('./../bolt00');
 
+const discount = fee => (!fee ? 0 : -fee).toString();
+const inverse = rate => !rate ? 0 : -rate;
 const isHash = n => /^[0-9A-F]{64}$/i.test(n);
 const notFound = -1;
 const outpointDivider = ':';
@@ -21,6 +23,8 @@ const outpointDivider = ':';
     base_fee_mtokens: <Base Flat Fee Millitokens String>
     fee_rate: <Fee Rate in Millitokens Per Million Number>
     id: <Standard Format Channel Id String>
+    inbound_base_discount_mtokens: <Source Based Base Fee Reduction String>
+    inbound_rate_discount: <Source Based Per Million Rate Reduction Number>
     transaction_id: <Channel Funding Transaction Id Hex String>
     transaction_vout: <Funding Outpoint Output Index Number>
   }
@@ -61,6 +65,8 @@ module.exports = channel => {
     base_fee_mtokens: channel.base_fee_msat,
     fee_rate: Number(channel.fee_per_mil),
     id: chanFormat({number: channel.chan_id}).channel,
+    inbound_base_discount_mtokens: discount(channel.inbound_base_fee_msat),
+    inbound_rate_discount: inverse(channel.inbound_fee_per_mil),
     transaction_id: txId,
     transaction_vout: Number(index),
   };

package/lnd_responses/rpc_resolution_as_resolution.js

@@ -22,6 +22,12 @@ const outpointSeparator = ':';
 
   @returns
   {
+    [anchor]: {
+      is_confirmed: <Anchor Output Spend Is Confirmed Bool>
+      is_pending: <Anchor Output Spend Is Pending Confirmation Bool>
+      [spent_by]: <Sweep Transaction Id Hex String>
+      transaction_vout: <Anchor Output Index Number>
+    }
     [balance]: {
       spent_by: <Close Transaction Spent By Transaction Id Hex String>
       transaction_vout: <Balance Spent By Transaction Output Index Number>
@@ -72,6 +78,16 @@ module.exports = args => {
   }
 
   switch (args.resolution_type) {
+  case resolutionTypes.anchor:
+    return {
+      anchor: {
+        is_confirmed: args.outcome === resolutionOutcomes.confirmed,
+        is_pending: args.outcome === resolutionOutcomes.pending,
+        spent_by: args.sweep_txid || undefined,
+        transaction_vout: args.outpoint.output_index,
+      },
+    };
+
   case resolutionTypes.balance:
     // Exit early when the outcome is indeterminate
     if (!args.sweep_txid || args.outcome !== resolutionOutcomes.confirmed) {

package/package.json

@@ -7,11 +7,11 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.11",
+    "@grpc/grpc-js": "1.11.1",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "20.14.10",
+    "@types/node": "22.1.0",
     "@types/request": "2.48.12",
-    "@types/ws": "8.5.10",
+    "@types/ws": "8.5.12",
     "async": "3.2.5",
     "asyncjs-util": "1.2.12",
     "bitcoinjs-lib": "6.1.6",
@@ -22,12 +22,12 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.21.0"
+    "type-fest": "4.23.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "tsd": "0.31.1",
-    "typescript": "5.5.3"
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.15.1"
+  "version": "10.16.1"
 }

package/test/lnd_methods/offchain/test_get_closed_channels.js

@@ -43,6 +43,10 @@ const makeArgs = ({override}) => {
 
 const makeExpectedChannel = ({override}) => {
   const expected = {
+    anchor_is_confirmed: undefined,
+    anchor_is_pending: undefined,
+    anchor_spent_by: undefined,
+    anchor_vout: undefined,
     capacity: 1,
     close_balance_vout: undefined,
     close_balance_spent_by: undefined,
@@ -270,6 +274,35 @@ const tests = [
     description: 'Empty chan id is returned as undefined',
     expected: {channels: [makeExpectedChannel({override: {id: undefined}})]},
   },
+  {
+    args: makeArgs({
+      override: {
+        lnd: makeLnd(null, {
+          resolutions: [{
+            amount_sat: '1',
+            outcome: 'CLAIMED',
+            outpoint: {
+              output_index: 0,
+              txid_str: Buffer.alloc(32).toString('hex'),
+            },
+            resolution_type: 'ANCHOR',
+            sweep_txid: Buffer.alloc(32, 1).toString('hex'),
+          }],
+        }),
+      },
+    }),
+    description: 'Anchor resolution maps to anchor status',
+    expected: {
+      channels: [
+        makeExpectedChannel({override: {
+          anchor_is_confirmed: true,
+          anchor_is_pending: false,
+          anchor_spent_by: Buffer.alloc(32, 1).toString('hex'),
+          anchor_vout: 0,
+        }}),
+      ],
+    },
+  },
   {
     args: makeArgs({override: {lnd: makeLnd(null, {resolutions: [null]})}}),
     description: 'Valid resolutions are expected',

package/test/lnd_methods/offchain/test_get_fee_rates.js

@@ -56,6 +56,8 @@ const tests = [
         base_fee_mtokens: '0',
         fee_rate: 0,
         id: '0x0x1',
+        inbound_base_discount_mtokens: '0',
+        inbound_rate_discount: 0,
         transaction_id: Buffer.alloc(32).toString('hex'),
         transaction_vout: 0,
       }],

package/test/lnd_responses/test_rpc_fees_as_channel_fees.js

@@ -66,6 +66,8 @@ const tests = [
       base_fee_mtokens: '1',
       fee_rate: 0,
       id: '0x0x1',
+      inbound_base_discount_mtokens: '0',
+      inbound_rate_discount: 0,
       transaction_id: Buffer.alloc(32).toString('hex'),
       transaction_vout: 0,
     },

package/test/lnd_responses/test_rpc_resolution_as_resolution.js

@@ -113,6 +113,30 @@ const tests = [
       },
     },
   },
+  {
+    args: makeArgs({resolution_type: 'ANCHOR'}),
+    description: 'RPC anchor resolution is mapped to anchor',
+    expected: {
+      anchor: {
+        is_confirmed: true,
+        is_pending: false,
+        spent_by: Buffer.alloc(32, 1).toString('hex'),
+        transaction_vout: 0,
+      },
+    },
+  },
+  {
+    args: makeArgs({resolution_type: 'ANCHOR', sweep_txid: ''}),
+    description: 'RPC pending anchor resolution is mapped to anchor',
+    expected: {
+      anchor: {
+        is_confirmed: true,
+        is_pending: false,
+        spent_by: undefined,
+        transaction_vout: 0,
+      },
+    },
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {