lightning 10.26.2 → 10.27.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Versions
 
-## 10.26.2
+## 10.27.0
+
+- `getPendingChannels`: Add support for `opening_funding_height`,
+    `opening_waiting_blocks`
+
+## 10.26.3
 
 - Add support for LND 0.19.3
 

package/grpc/protos/lightning.proto

@@ -341,6 +341,13 @@ service Lightning {
     */
     rpc SubscribeInvoices (InvoiceSubscription) returns (stream Invoice);
 
+    /* lncli: `deletecanceledinvoice`
+    DeleteCanceledInvoice removes a canceled invoice from the database. If the
+    invoice is not in the canceled state, an error will be returned.
+    */
+    rpc DeleteCanceledInvoice (DelCanceledInvoiceReq)
+        returns (DelCanceledInvoiceResp);
+
     /* lncli: `decodepayreq`
     DecodePayReq takes an encoded payment request string and attempts to decode
     it, returning a full description of the conditions encoded within the
@@ -548,9 +555,10 @@ service Lightning {
         returns (ListPermissionsResponse);
 
     /*
-    CheckMacaroonPermissions checks whether a request follows the constraints
-    imposed on the macaroon and that the macaroon is authorized to follow the
-    provided permissions.
+    CheckMacaroonPermissions checks whether the provided macaroon contains all
+    the provided permissions. If the macaroon is valid (e.g. all caveats are
+    satisfied), and all permissions provided in the request are met, then
+    this RPC returns true.
     */
     rpc CheckMacaroonPermissions (CheckMacPermRequest)
         returns (CheckMacPermResponse);
@@ -2840,6 +2848,25 @@ message PendingChannelsResponse {
         // very likely canceled the funding and the channel will never become
         // fully operational.
         int32 funding_expiry_blocks = 3;
+
+        // The number of blocks remaining until the channel status changes from
+        // pending to active. A value of 0 indicates that the channel is now
+        // active.
+        //
+        // "Active" here means both channel peers have the channel marked OPEN
+        // and can immediately start using it. For public channels, this does
+        // not imply a channel_announcement has been gossiped. It only becomes
+        // public on the network after 6 on‐chain confirmations.
+        // See BOLT07 "Routing Gossip":
+        // https://github.com/lightning/bolts/blob/master/07-routing-gossip.md
+        //
+        // ZeroConf channels bypass the pending state entirely: they are marked
+        // active immediately upon creation, so they never show up as "pending".
+        uint32 confirmations_until_active = 7;
+
+        // The confirmation height records the block height at which the funding
+        // transaction was first confirmed.
+        uint32 confirmation_height = 8;
     }
 
     message WaitingCloseChannel {
@@ -4233,6 +4260,16 @@ message InvoiceSubscription {
     uint64 settle_index = 2;
 }
 
+message DelCanceledInvoiceReq {
+    // Invoice payment hash to delete.
+    string invoice_hash = 1;
+}
+
+message DelCanceledInvoiceResp {
+    // The status of the delete operation.
+    string status = 1;
+}
+
 enum PaymentFailureReason {
     /*
     Payment isn't failed (yet).
@@ -5107,9 +5144,37 @@ message Op {
 }
 
 message CheckMacPermRequest {
+    // The macaroon to check permissions for, serialized in binary format. For
+    // a macaroon to be valid, it must have been issued by lnd, must succeed all
+    // caveat conditions, and must contain all of the permissions specified in
+    // the permissions field.
     bytes macaroon = 1;
+
+    // The list of permissions the macaroon should be checked against. Only if
+    // the macaroon contains all of these permissions, it is considered valid.
+    // If the list of permissions given is empty, then the macaroon is
+    // considered valid only based on issuance authority and caveat validity.
+    // An empty list of permissions is therefore equivalent to saying "skip
+    // checking permissions" (unless check_default_perms_from_full_method is
+    // specified).
     repeated MacaroonPermission permissions = 2;
+
+    // The RPC method to check the macaroon against. This is only used if there
+    // are custom `uri:<rpcpackage>.<ServiceName>/<MethodName>` permissions in
+    // the permission list above. To check a macaroon against the list of
+    // permissions of a certain RPC method, query the `ListPermissions` RPC
+    // first, extract the permissions for the method, and then pass them in the
+    // `permissions` field above.
     string fullMethod = 3;
+
+    // If this field is set to true, then the permissions list above MUST be
+    // empty. The default permissions for the provided fullMethod will be used
+    // to check the macaroon. This is equivalent to looking up the permissions
+    // for a method in the `ListPermissions` RPC and then calling this RPC with
+    // the permission list returned from that call. Without this flag, the list
+    // of permissions must be non-empty for the check to actually perform a
+    // permission check.
+    bool check_default_perms_from_full_method = 4;
 }
 
 message CheckMacPermResponse {

package/lnd_methods/offchain/get_pending_channels.js

@@ -25,6 +25,10 @@ const type = 'default';
 
   `close_transaction` is not supported in LND 0.17.5 or before
 
+  `opening_funding_height` is not supported in LND 0.19.3 or before
+
+  `opening_waiting_blocks` is not supported in LND 0.19.3 or before
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -45,6 +49,8 @@ const type = 'default';
       is_timelocked: <Channel Local Funds Constrained by Timelock Script Bool>
       local_balance: <Channel Local Tokens Balance Number>
       local_reserve: <Channel Local Reserved Tokens Number>
+      [opening_funding_height]: <Funding Seen At Best Block Height Number>
+      [opening_waiting_blocks]: <Open Activation Waiting Blocks Count Number>
       partner_public_key: <Channel Peer Public Key String>
       [pending_balance]: <Tokens Pending Recovery Number>
       [pending_payments]: [{

package/lnd_responses/pending_as_pending_channels.js

@@ -41,6 +41,8 @@ const outpointSeparator = ':';
         capacity: <Channel Capacity Tokens Count String>
         channel_point: <Channel Outpoint String>
         commitment_type: <Type of Channel String>
+        confirmation_height: <Best Chain Block Height Funding Seen Number>
+        confirmations_until_active: <Blocks Remaining to Channel Active Number>
         initiator: <Channel Creator Status String>
         local_balance: <Local Balance Tokens String>
         local_chan_reserve_sat: <Local Side Channel Reserve Tokens String>
@@ -97,6 +99,8 @@ const outpointSeparator = ':';
       is_timelocked: <Channel Local Funds Constrained by Timelock Script Bool>
       local_balance: <Channel Local Tokens Balance Number>
       local_reserve: <Channel Local Reserved Tokens Number>
+      [opening_funding_height]: <Funding Seen At Best Block Height Number>
+      [opening_waiting_blocks]: <Open Activation Waiting Blocks Count Number>
       partner_public_key: <Channel Peer Public Key String>
       [pending_balance]: <Tokens Pending Recovery Number>
       [pending_payments]: [{
@@ -247,6 +251,8 @@ module.exports = args => {
 
     sum[pending.channel.channel_point] = {
       funding_expiry: Number(pending.funding_expiry_blocks) || undefined,
+      open_blocks: Number(pending.confirmations_until_active) || undefined,
+      open_height: Number(pending.confirmation_height) || undefined,
       transaction_fee: Number(pending.commit_fee),
       transaction_weight: Number(pending.commit_weight),
     };
@@ -311,6 +317,8 @@ module.exports = args => {
       is_timelocked: forced.timelock_blocks !== undefined,
       local_balance: Number(channel.local_balance),
       local_reserve: Number(channel.local_chan_reserve_sat),
+      opening_funding_height: !chanOpen ? undefined : chanOpen.open_height,
+      opening_waiting_blocks: !chanOpen ? undefined : chanOpen.open_blocks,
       partner_public_key: channel.remote_node_pub,
       pending_balance: pendingTokens || undefined,
       pending_payments: forced.pending_payments || undefined,

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.13.4",
+    "@grpc/grpc-js": "1.14.0",
     "@grpc/proto-loader": "0.8.0",
-    "@types/node": "24.3.0",
+    "@types/node": "24.5.2",
     "@types/request": "2.48.13",
     "@types/ws": "8.18.1",
     "async": "3.2.6",
@@ -22,7 +22,7 @@
     "invoices": "4.0.0",
     "psbt": "4.0.0",
     "tiny-secp256k1": "2.2.4",
-    "type-fest": "4.41.0"
+    "type-fest": "5.0.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.26.2"
+  "version": "10.27.0"
 }

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -57,7 +57,8 @@ const makePendingForceClosingChannel = overrides => {
 const makePendingOpenChannel = overrides => {
   const res = {
     channel: makeChannel({}),
-    confirmation_height: 1,
+    confirmation_height: 0,
+    confirmations_until_active: 0,
     commit_fee: '1',
     commit_weight: '1',
     fee_per_kw: '1',
@@ -114,6 +115,8 @@ const makeExpectedPending = overrides => {
     is_timelocked: true,
     local_balance: 1,
     local_reserve: 1,
+    opening_funding_height: undefined,
+    opening_waiting_blocks: undefined,
     partner_public_key: Buffer.alloc(33).toString('hex'),
     pending_balance: 1,
     pending_payments: [{
@@ -438,6 +441,36 @@ const tests = [
       ],
     }),
   },
+  {
+    args: makeArgs({
+      pending_force_closing_channels: [],
+      pending_open_channels: [
+        makePendingOpenChannel({
+          confirmation_height: 1,
+          confirmations_until_active: 3,
+        }),
+      ],
+      waiting_close_channels: [],
+    }),
+    description: 'Pending open channels are mapped',
+    expected: makeExpected({
+      pending_channels: [
+        makeExpectedPending({
+          close_transaction_id: undefined,
+          is_closing: false,
+          is_opening: true,
+          is_timelocked: false,
+          opening_funding_height: 1,
+          opening_waiting_blocks: 3,
+          pending_balance: undefined,
+          pending_payments: undefined,
+          recovered_tokens: undefined,
+          timelock_blocks: undefined,
+          timelock_expiration: undefined,
+        }),
+      ],
+    }),
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {