lightning 10.6.0 → 10.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 10.7.0
+
+- `getPendingChannels`: Add support for `close_transaction` to return raw tx
+
+## 10.6.1
+
+- `addAdvertisedFeature`: Add typescript definitions
+
 ## 10.6.0
 
 - `addAdvertisedFeature`: Add method to advertise a feature bit support

package/grpc/protos/lightning.proto

@@ -348,13 +348,13 @@ service Lightning {
     */
     rpc ListPayments (ListPaymentsRequest) returns (ListPaymentsResponse);
 
-    /*
+    /* lncli: `deletepayments`
     DeletePayment deletes an outgoing payment from DB. Note that it will not
     attempt to delete an In-Flight payment, since that would be unsafe.
     */
     rpc DeletePayment (DeletePaymentRequest) returns (DeletePaymentResponse);
 
-    /*
+    /* lncli: `deletepayments --all`
     DeleteAllPayments deletes all outgoing payments from DB. Note that it will
     not attempt to delete In-Flight payments, since that would be unsafe.
     */
@@ -486,7 +486,7 @@ service Lightning {
     rpc ExportAllChannelBackups (ChanBackupExportRequest)
         returns (ChanBackupSnapshot);
 
-    /*
+    /* lncli: `verifychanbackup`
     VerifyChanBackup allows a caller to verify the integrity of a channel backup
     snapshot. This method will accept either a packed Single or a packed Multi.
     Specifying both will result in an error.
@@ -884,7 +884,8 @@ message SendRequest {
     repeated FeatureBit dest_features = 15;
 
     /*
-    The payment address of the generated invoice.
+    The payment address of the generated invoice.  This is also called
+    payment secret in specifications (e.g. BOLT 11).
     */
     bytes payment_addr = 16;
 }
@@ -1933,13 +1934,16 @@ message GetInfoResponse {
     /*
     Whether the current node is connected to testnet. This field is
     deprecated and the network field should be used instead
-    **/
+    */
     bool testnet = 10 [deprecated = true];
 
     reserved 11;
 
-    // A list of active chains the node is connected to
-    repeated Chain chains = 16;
+    /*
+    Deprecated. The only active chain is bitcoin.
+    A list of active chains the node is connected to
+    */
+    repeated Chain chains = 16 [deprecated = true];
 
     // The URIs of the current node.
     repeated string uris = 12;
@@ -1981,8 +1985,9 @@ message GetRecoveryInfoResponse {
 }
 
 message Chain {
-    // The blockchain the node is on (eg bitcoin, litecoin)
-    string chain = 1;
+    // Deprecated. The chain is now always assumed to be bitcoin.
+    // The blockchain the node is on (must be bitcoin)
+    string chain = 1 [deprecated = true];
 
     // The network the node is on (eg regtest, testnet, mainnet)
     string network = 2;
@@ -2042,12 +2047,18 @@ 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.
+    bool no_wait = 8;
 }
 
 message CloseStatusUpdate {
     oneof update {
         PendingUpdate close_pending = 1;
         ChannelCloseUpdate chan_close = 3;
+        InstantUpdate close_instant = 4;
     }
 }
 
@@ -2056,6 +2067,9 @@ message PendingUpdate {
     uint32 output_index = 2;
 }
 
+message InstantUpdate {
+}
+
 message ReadyForPsbtFunding {
     /*
     The P2WSH address of the channel funding multisig address that the below
@@ -2623,6 +2637,9 @@ message PendingHTLC {
 }
 
 message PendingChannelsRequest {
+    // Indicates whether to include the raw transaction hex for
+    // waiting_close_channels.
+    bool include_raw_tx = 1;
 }
 message PendingChannelsResponse {
     message PendingChannel {
@@ -2720,6 +2737,10 @@ message PendingChannelsResponse {
 
         // The transaction id of the closing transaction
         string closing_txid = 4;
+
+        // The raw hex encoded bytes of the closing transaction. Included if
+        // include_raw_tx in the request is true.
+        string closing_tx_hex = 5;
     }
 
     message Commitments {
@@ -2858,6 +2879,11 @@ message WalletBalanceRequest {
     // The wallet account the balance is shown for.
     // If this is not specified, the balance of the "default" account is shown.
     string account = 1;
+
+    // The minimum number of confirmations each one of your outputs used for the
+    // funding transaction must satisfy. If this is not specified, the default
+    // value of 1 is used.
+    int32 min_confs = 2;
 }
 
 message WalletBalanceResponse {
@@ -2943,6 +2969,9 @@ message QueryRoutesRequest {
     not add any additional block padding on top of final_ctlv_delta. This
     padding of a few blocks needs to be added manually or otherwise failures may
     happen when a block comes in while the payment is in flight.
+
+    Note: must not be set if making a payment to a blinded path (delta is
+    set by the aggregate parameters provided by blinded_payment_paths)
     */
     int32 final_cltv_delta = 4;
 
@@ -3016,12 +3045,21 @@ message QueryRoutesRequest {
     */
     repeated lnrpc.RouteHint route_hints = 16;
 
+    /*
+    An optional blinded path(s) to reach the destination. Note that the
+    introduction node must be provided as the first hop in the route.
+    */
+    repeated BlindedPaymentPath blinded_payment_paths = 19;
+
     /*
     Features assumed to be supported by the final node. All transitive feature
     dependencies must also be set properly. For a given feature bit pair, either
     optional or remote may be set, but not both. If this field is nil or empty,
     the router will try to load destination features from the graph as a
     fallback.
+
+    Note: must not be set if making a payment to a blinded route (features
+    are provided in blinded_payment_paths).
     */
     repeated lnrpc.FeatureBit dest_features = 17;
 
@@ -3127,6 +3165,32 @@ message Hop {
 
     // The payment metadata to send along with the payment to the payee.
     bytes metadata = 13;
+
+    /*
+    Blinding point is an optional blinding point included for introduction
+    nodes in blinded paths. This field is mandatory for hops that represents
+    the introduction point in a blinded path.
+    */
+    bytes blinding_point = 14;
+
+    /*
+    Encrypted data is a receiver-produced blob of data that provides hops
+    in a blinded route with forwarding data. As this data is encrypted by
+    the recipient, we will not be able to parse it - it is essentially an
+    arbitrary blob of data from our node's perspective. This field is
+    mandatory for all hops in a blinded path, including the introduction
+    node.
+    */
+    bytes encrypted_data = 15;
+
+    /*
+    The total amount that is sent to the recipient (possibly across multiple
+    HTLCs), as specified by the sender when making a payment to a blinded path.
+    This value is only set in the final hop payload of a blinded payment. This
+    value is analogous to the MPPRecord that is used for regular (non-blinded)
+    MPP payments.
+    */
+    uint64 total_amt_msat = 16;
 }
 
 message MPPRecord {
@@ -3134,7 +3198,8 @@ message MPPRecord {
     A unique, random identifier used to authenticate the sender as the intended
     payer of a multi-path payment. The payment_addr must be the same for all
     subpayments, and match the payment_addr provided in the receiver's invoice.
-    The same payment_addr must be used on all subpayments.
+    The same payment_addr must be used on all subpayments. This is also called
+    payment secret in specifications (e.g. BOLT 11).
     */
     bytes payment_addr = 11;
 
@@ -3472,6 +3537,61 @@ message RouteHint {
     repeated HopHint hop_hints = 1;
 }
 
+message BlindedPaymentPath {
+    // The blinded path to send the payment to.
+    BlindedPath blinded_path = 1;
+
+    // The base fee for the blinded path provided, expressed in msat.
+    uint64 base_fee_msat = 2;
+
+    // The proportional fee for the blinded path provided, expressed in msat.
+    uint64 proportional_fee_msat = 3;
+
+    /*
+    The total CLTV delta for the blinded path provided, including the
+    final CLTV delta for the receiving node.
+    */
+    uint32 total_cltv_delta = 4;
+
+    /*
+    The minimum hltc size that may be sent over the blinded path, expressed
+    in msat.
+    */
+    uint64 htlc_min_msat = 5;
+
+    /*
+    The maximum htlc size that may be sent over the blinded path, expressed
+    in msat.
+    */
+    uint64 htlc_max_msat = 6;
+
+    // The feature bits for the route.
+    repeated FeatureBit features = 7;
+}
+
+message BlindedPath {
+    // The unblinded pubkey of the introduction node for the route.
+    bytes introduction_node = 1;
+
+    // The ephemeral pubkey used by nodes in the blinded route.
+    bytes blinding_point = 2;
+
+    /*
+    A set of blinded node keys and data blobs for the blinded portion of the
+    route. Note that the first hop is expected to be the introduction node,
+    so the route is always expected to have at least one hop.
+    */
+    repeated BlindedHop blinded_hops = 3;
+}
+
+message BlindedHop {
+    // The blinded public key of the node.
+    bytes blinded_node = 1;
+
+    // An encrypted blob of data provided to the blinded node.
+    bytes encrypted_data = 2;
+}
+
 message AMPInvoiceState {
     // The state the HTLCs associated with this setID are in.
     InvoiceHTLCState state = 1;
@@ -3658,9 +3778,10 @@ message Invoice {
     bool is_keysend = 25;
 
     /*
-    The payment address of this invoice. This value will be used in MPP
-    payments, and also for newer invoices that always require the MPP payload
-    for added end-to-end security.
+    The payment address of this invoice. This is also called payment secret in
+    specifications (e.g. BOLT 11). This value will be used in MPP payments, and
+    also for newer invoices that always require the MPP payload for added
+    end-to-end security.
     Note: Output only, don't specify for creating an invoice.
     */
     bytes payment_addr = 26;
@@ -3765,9 +3886,9 @@ message AddInvoiceResponse {
     uint64 add_index = 16;
 
     /*
-    The payment address of the generated invoice. This value should be used
-    in all payments for this invoice as we require it for end to end
-    security.
+    The payment address of the generated invoice. This is also called
+    payment secret in specifications (e.g. BOLT 11). This value should be used
+    in all payments for this invoice as we require it for end to end security.
     */
     bytes payment_addr = 17;
 }
@@ -3918,10 +4039,20 @@ message Payment {
     string payment_request = 9;
 
     enum PaymentStatus {
-        UNKNOWN = 0;
+        // Deprecated. This status will never be returned.
+        UNKNOWN = 0 [deprecated = true];
+
+        // Payment has inflight HTLCs.
         IN_FLIGHT = 1;
+
+        // Payment is settled.
         SUCCEEDED = 2;
+
+        // Payment is failed.
         FAILED = 3;
+
+        // Payment is created and has not attempted any HTLCs.
+        INITIATED = 4;
     }
 
     // The status of the payment.
@@ -4017,11 +4148,11 @@ message ListPaymentsRequest {
     */
     bool count_total_payments = 5;
 
-    // If set, returns all invoices with a creation date greater than or equal
+    // If set, returns all payments with a creation date greater than or equal
     // to it. Measured in seconds since the unix epoch.
     uint64 creation_date_start = 6;
 
-    // If set, returns all invoices with a creation date less than or equal to
+    // If set, returns all payments with a creation date less than or equal to
     // it. Measured in seconds since the unix epoch.
     uint64 creation_date_end = 7;
 }

package/lnd_methods/offchain/get_pending_channels.d.ts

@@ -7,6 +7,8 @@ export type GetPendingChannelsResult = {
     blocks_until_expiry?: number;
     /** Channel Capacity Tokens */
     capacity: number;
+    /** Channel Closing Transaction */
+    close_transaction?: string;
     /** Channel Closing Transaction Id */
     close_transaction_id?: string;
     /** Channel Description */

package/lnd_methods/offchain/get_pending_channels.js

@@ -23,6 +23,8 @@ const type = 'default';
 
   `blocks_until_expiry` is not supported in LND 0.16.4 or before
 
+  `close_transaction` is not supported in LND 0.17.4 or before
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -32,6 +34,7 @@ const type = 'default';
     pending_channels: [{
       [blocks_until_expiry]: <Blocks Until Open Channel Expires Number>
       capacity: <Channel Capacity Tokens Number>
+      [close_transaction]: <Channel Closing Raw Transaction Hex String>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       [description]: <Channel Description String>
       is_active: <Channel Is Active Bool>
@@ -80,7 +83,7 @@ module.exports = ({lnd}, cbk) => {
 
       // Get pending channels
       getPending: ['validate', ({}, cbk) => {
-        return lnd[type][method]({}, (err, res) => {
+        return lnd[type][method]({include_raw_tx: true}, (err, res) => {
           if (!!err) {
             return cbk([503, 'UnexpectedPendingChannelsErr', {err}]);
           }

package/lnd_methods/peers/add_advertised_feature.d.ts

@@ -0,0 +1,20 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type AddAdvertisedFeature = AuthenticatedLightningArgs<{
+  /** BOLT 09 Feature Bit Number */
+  feature: number;
+}>;
+
+/**
+ * Add an advertised feature to the graph node announcement
+ *
+ * Note: this method is not supported in LND versions 0.14.5 and below
+ *
+ * Requires LND built with `peersrpc` build tag
+ *
+ * Requires `peers:write` permissions
+ */
+export const addAdvertisedFeature: AuthenticatedLightningMethod<AddAdvertisedFeature>;

package/lnd_methods/peers/index.d.ts

@@ -1,3 +1,4 @@
+export * from './add_advertised_feature';
 export * from './add_external_socket';
 export * from './add_peer';
 export * from './get_peers';

package/lnd_responses/pending_as_pending_channels.js

@@ -22,6 +22,7 @@ const outpointSeparator = ':';
         remote_chan_reserve_sat: <Remote Side Channel Reserve Tokens String>
         remote_node_pub: <Remote Node Public Key Hex String>
       }
+      closing_tx_hex: <Closing Raw Transaction Hex String>
       closing_txid: <Closing Transaction Id Hex String>
       limbo_balance: <Tokens Waiting For Resolution String>
       maturity_height: <Timelock Height Number>
@@ -86,6 +87,7 @@ const outpointSeparator = ':';
     pending_channels: [{
       [blocks_until_expiry]: <Blocks Until Open Channel Expires Number>
       capacity: <Channel Capacity Tokens Number>
+      [close_transaction]: <Channel Closing Raw Transaction Hex String>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       [description]: <Channel Description String>
       is_active: <Channel Is Active Bool>
@@ -271,6 +273,7 @@ module.exports = args => {
     }
 
     sum[pending.channel.channel_point] = {
+      close_transaction: pending.closing_tx_hex,
       close_transaction_id: pending.closing_txid,
       pending_balance: Number(pending.limbo_balance),
     };
@@ -297,6 +300,7 @@ module.exports = args => {
     return {
       blocks_until_expiry: !!chanOpen ? chanOpen.funding_expiry : undefined,
       capacity: Number(channel.capacity),
+      close_transaction: wait.close_transaction || undefined,
       close_transaction_id: endTx || undefined,
       description: channel.memo || undefined,
       is_active: false,

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.1",
+    "@grpc/grpc-js": "1.10.2",
     "@grpc/proto-loader": "0.7.10",
-    "@types/node": "20.11.19",
+    "@types/node": "20.11.25",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,12 +22,12 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.10.2"
+    "type-fest": "4.12.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
-    "tsd": "0.30.4",
-    "typescript": "5.3.3"
+    "tsd": "0.30.7",
+    "typescript": "5.4.2"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.6.0"
+  "version": "10.7.0"
 }

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -103,6 +103,7 @@ const makeExpectedPending = overrides => {
   const res = {
     blocks_until_expiry: undefined,
     capacity: 1,
+    close_transaction: undefined,
     close_transaction_id: Buffer.alloc(32).toString('hex'),
     description: undefined,
     is_active: false,