lightning 10.23.1 → 10.24.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 10.24.0
+
+- `closeChannel`: Add `is_graceful_close` to wait for pending resolutions
+
 ## 10.23.1
 
 - `getRoutingFeeEstimate`: Add method to estimate an offchain payment fee

package/grpc/protos/lightning.proto

@@ -274,12 +274,14 @@ service Lightning {
     }
 
     /*
-    SendPaymentSync is the synchronous non-streaming version of SendPayment.
-    This RPC is intended to be consumed by clients of the REST proxy.
-    Additionally, this RPC expects the destination's public key and the payment
-    hash (if any) to be encoded as hex strings.
+    Deprecated, use routerrpc.SendPaymentV2. SendPaymentSync is the synchronous
+    non-streaming version of SendPayment. This RPC is intended to be consumed by
+    clients of the REST proxy. Additionally, this RPC expects the destination's
+    public key and the payment hash (if any) to be encoded as hex strings.
     */
-    rpc SendPaymentSync (SendRequest) returns (SendResponse);
+    rpc SendPaymentSync (SendRequest) returns (SendResponse) {
+        option deprecated = true;
+    }
 
     /* lncli: `sendtoroute`
     Deprecated, use routerrpc.SendToRouteV2. SendToRoute is a bi-directional
@@ -293,10 +295,13 @@ service Lightning {
     }
 
     /*
-    SendToRouteSync is a synchronous version of SendToRoute. It Will block
-    until the payment either fails or succeeds.
+    Deprecated, use routerrpc.SendToRouteV2. SendToRouteSync is a synchronous
+    version of SendToRoute. It Will block until the payment either fails or
+    succeeds.
     */
-    rpc SendToRouteSync (SendToRouteRequest) returns (SendResponse);
+    rpc SendToRouteSync (SendToRouteRequest) returns (SendResponse) {
+        option deprecated = true;
+    }
 
     /* lncli: `addinvoice`
     AddInvoice attempts to add a new invoice to the invoice database. Any
@@ -2141,9 +2146,13 @@ message CloseChannelRequest {
     // NOTE: This field is only respected if we're the initiator of the channel.
     uint64 max_fee_per_vbyte = 7;
 
-    // If true, then the rpc call will not block while it awaits a closing txid.
-    // Consequently this RPC call will not return a closing txid if this value
-    // is set.
+    // If true, then the rpc call will not block while it awaits a closing txid
+    // to be broadcasted to the mempool. To obtain the closing tx one has to
+    // listen to the stream for the particular updates. Moreover if a coop close
+    // is specified and this flag is set to true the coop closing flow will be
+    // initiated even if HTLCs are active on the channel. The channel will wait
+    // until all HTLCs are resolved and then start the coop closing process. The
+    // channel will be disabled in the meantime and will disallow any new HTLCs.
     bool no_wait = 8;
 }
 
@@ -2161,6 +2170,10 @@ message PendingUpdate {
 }
 
 message InstantUpdate {
+    // The number of pending HTLCs that are currently active on the channel.
+    // These HTLCs need to be resolved before the channel can be closed
+    // cooperatively.
+    int32 num_pending_htlcs = 1;
 }
 
 message ReadyForPsbtFunding {

package/grpc/protos/walletkit.proto

@@ -1188,9 +1188,8 @@ message BumpFeeRequest {
     // The input we're attempting to bump the fee of.
     lnrpc.OutPoint outpoint = 1;
 
-    // Optional. The deadline in number of blocks that the input should be spent
-    // within. When not set, for new inputs, the default value (1008) is used;
-    // for existing inputs, their current values will be retained.
+    // Optional. The conf target the underlying fee estimator will use to
+    // estimate the starting fee rate for the fee function.
     uint32 target_conf = 2;
 
     /*
@@ -1217,7 +1216,7 @@ message BumpFeeRequest {
 
     /*
     Optional. Whether this input will be swept immediately. When set to true,
-    the sweeper will sweep this input without waiting for the next batch.
+    the sweeper will sweep this input without waiting for the next block.
     */
     bool immediate = 6;
 
@@ -1230,6 +1229,12 @@ message BumpFeeRequest {
     retained.
     */
     uint64 budget = 7;
+
+    // Optional. The deadline delta in number of blocks that the output
+    // should be spent within. This translates internally to the width of the
+    // fee function that the sweeper will use to bump the fee rate. When the
+    // deadline is reached, ALL the budget will be spent as fees.
+    uint32 deadline_delta = 8;
 }
 
 message BumpFeeResponse {
@@ -1243,7 +1248,8 @@ message BumpForceCloseFeeRequest {
     lnrpc.ChannelPoint chan_point = 1;
 
     // Optional. The deadline delta in number of blocks that the anchor output
-    // should be spent within to bump the closing transaction.
+    // should be spent within to bump the closing transaction. When the
+    // deadline is reached, ALL the budget will be spent as fees
     uint32 deadline_delta = 2;
 
     /*
@@ -1270,6 +1276,10 @@ message BumpForceCloseFeeRequest {
     transaction of the force closed channel otherwise the fee bumping will fail.
     */
     uint64 budget = 5;
+
+    // Optional. The conf target the underlying fee estimator will use to
+    // estimate the starting fee rate for the fee function.
+    uint32 target_conf = 6;
 }
 
 message BumpForceCloseFeeResponse {

package/lnd_methods/onchain/close_channel.js

@@ -23,10 +23,13 @@ const type = 'default';
 
   `max_tokens_per_vbyte` is not supported in LND 0.15.0 and below
 
+  `is_graceful_close` is not supported in LND 0.17.5 and below
+
   {
     [address]: <Request Sending Local Channel Funds To Address String>
     [id]: <Standard Format Channel Id String>
     [is_force_close]: <Is Force Close Bool>
+    [is_graceful_close]: <Is Waiting For Pending Payments to Coop Close Bool>
     lnd: <Authenticated LND API Object>
     [max_tokens_per_vbyte]: <Fail Cooperative Close Above Fee Rate Number>
     [public_key]: <Peer Public Key String>
@@ -143,6 +146,7 @@ module.exports = (args, cbk) => {
           delivery_address: args.address || undefined,
           force: !!args.is_force_close,
           max_fee_per_vbyte: args.max_tokens_per_vbyte || undefined,
+          no_wait: args.is_graceful_close || undefined,
           sat_per_vbyte: !!tokensPerVByte ? tokensPerVByte : undefined,
           target_conf: targetConf,
         });

package/package.json

@@ -7,27 +7,27 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.12.6",
+    "@grpc/grpc-js": "1.13.0",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "22.13.4",
+    "@types/node": "22.13.10",
     "@types/request": "2.48.12",
-    "@types/ws": "8.5.14",
+    "@types/ws": "8.18.0",
     "async": "3.2.6",
     "asyncjs-util": "1.2.12",
     "bitcoinjs-lib": "6.1.7",
     "bn.js": "5.2.1",
     "bolt07": "1.9.4",
     "bolt09": "2.1.0",
-    "ecpair": "2.1.0",
+    "ecpair": "3.0.0",
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.34.1"
+    "type-fest": "4.37.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "tsd": "0.31.2",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.23.1"
+  "version": "10.24.0"
 }

package/test/lnd_methods/onchain/test_close_channel.js

@@ -197,6 +197,11 @@ const tests = [
     description: 'A channel is closed with a tx fee',
     expected: {transaction_id: '04030201', transaction_vout: 0},
   },
+  {
+    args: makeArgs({is_graceful_close: true}),
+    description: 'A channel is closed with a graceful exit',
+    expected: {transaction_id: '04030201', transaction_vout: 0},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {