lightning 5.18.0 → 5.20.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Versions
 
+## 5.21.1
+
+- Update typescript definitions
+
+## 5.20.0
+
+- `getLockedUtxos`: Add support for returning script, value of locked utxos
+
+## 5.19.0
+
+- `closeChannel`: Add support for `max_tokens_per_vbyte` to set max fee rate
+- `getChainTransactions`: Add `inputs` support for previous outpoints
+- `subscribeToTransactions`: Add `inputs` support for previous outpoints
+
 ## 5.18.0
 
 - `signBytes`: Add `type` and support for specifying `schnorr` type signing

package/grpc/protos/chainnotifier.proto

@@ -72,6 +72,12 @@ message ConfRequest {
     broadcast height of the transaction/output script.
     */
     uint32 height_hint = 4;
+
+    /*
+    If true, then the block that mines the specified txid/script will be
+    included in eventual the notification event.
+    */
+    bool include_block = 5;
 }
 
 message ConfDetails {
@@ -87,6 +93,12 @@ message ConfDetails {
 
     // The index of the confirmed transaction within the transaction.
     uint32 tx_index = 4;
+
+    /*
+    The raw bytes of the block that mined the transaction. Only included if
+    include_block was set in the request.
+    */
+    bytes raw_block = 5;
 }
 
 message Reorg {

package/grpc/protos/invoices.proto

@@ -44,7 +44,8 @@ service Invoices {
 }
 
 message CancelInvoiceMsg {
-    // Hash corresponding to the (hold) invoice to cancel.
+    // Hash corresponding to the (hold) invoice to cancel. When using
+    // REST, this field must be encoded as base64.
     bytes payment_hash = 1;
 }
 message CancelInvoiceResp {
@@ -138,7 +139,8 @@ message SettleInvoiceResp {
 message SubscribeSingleInvoiceRequest {
     reserved 1;
 
-    // Hash corresponding to the (hold) invoice to subscribe to.
+    // Hash corresponding to the (hold) invoice to subscribe to. When using
+    // REST, this field must be encoded as base64url.
     bytes r_hash = 2;
 }
 
@@ -163,6 +165,7 @@ enum LookupModifier {
 
 message LookupInvoiceMsg {
     oneof invoice_ref {
+        // When using REST, this field must be encoded as base64.
         bytes payment_hash = 1;
         bytes payment_addr = 2;
         bytes set_id = 3;

package/grpc/protos/lightning.proto

@@ -693,7 +693,11 @@ message Transaction {
 
     // A label that was optionally set on transaction broadcast.
     string label = 10;
+
+    // PreviousOutpoints/Inputs of this transaction.
+    repeated PreviousOutPoint previous_outpoints = 12;
 }
+
 message GetTransactionsRequest {
     /*
     The height from which to list transactions, inclusive. If this value is
@@ -1029,12 +1033,21 @@ message OutPoint {
     uint32 output_index = 3;
 }
 
+message PreviousOutPoint {
+    // The outpoint in format txid:n.
+    string outpoint = 1;
+
+    // Denotes if the outpoint is controlled by the internal wallet.
+    // The flag will only detect p2wkh, np2wkh and p2tr inputs as its own.
+    bool is_our_output = 2;
+}
+
 message LightningAddress {
-    // The identity pubkey of the Lightning node
+    // The identity pubkey of the Lightning node.
     string pubkey = 1;
 
     // The network location of the lightning node, e.g. `69.69.69.69:1337` or
-    // `localhost:10011`
+    // `localhost:10011`.
     string host = 2;
 }
 
@@ -1223,11 +1236,15 @@ message VerifyMessageResponse {
 }
 
 message ConnectPeerRequest {
-    // Lightning address of the peer, in the format `<pubkey>@host`
+    /*
+    Lightning address of the peer to connect to.
+    */
     LightningAddress addr = 1;
 
-    /* If set, the daemon will attempt to persistently connect to the target
-     * peer. Otherwise, the call will be synchronous. */
+    /*
+    If set, the daemon will attempt to persistently connect to the target
+    peer. Otherwise, the call will be synchronous.
+    */
     bool perm = 2;
 
     /*
@@ -1945,6 +1962,11 @@ message CloseChannelRequest {
     // A manual fee rate set in sat/vbyte that should be used when crafting the
     // closure transaction.
     uint64 sat_per_vbyte = 6;
+
+    // The maximum fee rate the closer is willing to pay.
+    //
+    // NOTE: This field is only respected if we're the initiator of the channel.
+    uint64 max_fee_per_vbyte = 7;
 }
 
 message CloseStatusUpdate {
@@ -2620,6 +2642,9 @@ message WalletBalanceResponse {
     // other usage.
     int64 locked_balance = 5;
 
+    // The amount of reserve required.
+    int64 reserved_balance_anchor_chan = 6;
+
     // A mapping of each wallet account's name to its balance.
     map<string, WalletAccountBalance> account_balance = 4;
 }
@@ -3241,6 +3266,7 @@ message Invoice {
     /*
     The hash of the preimage. When using REST, this field must be encoded as
     base64.
+    Note: Output only, don't specify for creating an invoice.
     */
     bytes r_hash = 4;
 
@@ -3258,19 +3284,30 @@ message Invoice {
     */
     int64 value_msat = 23;
 
-    // Whether this invoice has been fulfilled
+    /*
+    Whether this invoice has been fulfilled
+
+    The field is deprecated. Use the state field instead (compare to SETTLED).
+    */
     bool settled = 6 [deprecated = true];
 
-    // When this invoice was created
+    /*
+    When this invoice was created.
+    Note: Output only, don't specify for creating an invoice.
+    */
     int64 creation_date = 7;
 
-    // When this invoice was settled
+    /*
+    When this invoice was settled.
+    Note: Output only, don't specify for creating an invoice.
+    */
     int64 settle_date = 8;
 
     /*
     A bare-bones invoice for a payment within the Lightning Network. With the
     details of the invoice, the sender has all the data necessary to send a
     payment to the recipient.
+    Note: Output only, don't specify for creating an invoice.
     */
     string payment_request = 9;
 
@@ -3305,6 +3342,7 @@ message Invoice {
     this index making it monotonically increasing. Callers to the
     SubscribeInvoices call can use this to instantly get notified of all added
     invoices with an add_index greater than this one.
+    Note: Output only, don't specify for creating an invoice.
     */
     uint64 add_index = 16;
 
@@ -3313,6 +3351,7 @@ message Invoice {
     increment this index making it monotonically increasing. Callers to the
     SubscribeInvoices call can use this to instantly get notified of all
     settled invoices with an settle_index greater than this one.
+    Note: Output only, don't specify for creating an invoice.
     */
     uint64 settle_index = 17;
 
@@ -3326,6 +3365,7 @@ message Invoice {
     was ultimately accepted. Additionally, it's possible that the sender paid
     MORE that was specified in the original invoice. So we'll record that here
     as well.
+    Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_sat = 19;
 
@@ -3336,6 +3376,7 @@ message Invoice {
     amount was ultimately accepted. Additionally, it's possible that the sender
     paid MORE that was specified in the original invoice. So we'll record that
     here as well.
+    Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_msat = 20;
 
@@ -3348,18 +3389,26 @@ message Invoice {
 
     /*
     The state the invoice is in.
+    Note: Output only, don't specify for creating an invoice.
     */
     InvoiceState state = 21;
 
-    // List of HTLCs paying to this invoice [EXPERIMENTAL].
+    /*
+    List of HTLCs paying to this invoice [EXPERIMENTAL].
+    Note: Output only, don't specify for creating an invoice.
+    */
     repeated InvoiceHTLC htlcs = 22;
 
-    // List of features advertised on the invoice.
+    /*
+    List of features advertised on the invoice.
+    Note: Output only, don't specify for creating an invoice.
+    */
     map<uint32, Feature> features = 24;
 
     /*
     Indicates if this invoice was a spontaneous payment that arrived via keysend
     [EXPERIMENTAL].
+    Note: Output only, don't specify for creating an invoice.
     */
     bool is_keysend = 25;
 
@@ -3367,6 +3416,7 @@ message Invoice {
     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.
+    Note: Output only, don't specify for creating an invoice.
     */
     bytes payment_addr = 26;
 
@@ -3382,6 +3432,7 @@ message Invoice {
     given set ID. This field is always populated for AMP invoices, and can be
     used along side LookupInvoice to obtain the HTLC information related to a
     given sub-invoice.
+    Note: Output only, don't specify for creating an invoice.
     */
     map<string, AMPInvoiceState> amp_invoice_state = 28;
 }
@@ -4389,6 +4440,14 @@ message RPCMiddlewareRequest {
         the same type, or replaced by an error message.
         */
         RPCMessage response = 6;
+
+        /*
+        This is used to indicate to the client that the server has successfully
+        registered the interceptor. This is only used in the very first message
+        that the server sends to the client after the client sends the server
+        the middleware registration message.
+        */
+        bool reg_complete = 8;
     }
 
     /*
@@ -4426,7 +4485,8 @@ message RPCMessage {
 
     /*
     The full canonical gRPC name of the message type (in the format
-    <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest).
+    <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest). In case of an
+    error being returned from lnd, this simply contains the string "error".
     */
     string type_name = 3;
 
@@ -4435,6 +4495,13 @@ message RPCMessage {
     format.
     */
     bytes serialized = 4;
+
+    /*
+    Indicates that the response from lnd was an error, not a gRPC response. If
+    this is set to true then the type_name contains the string "error" and
+    serialized contains the error string.
+    */
+    bool is_error = 5;
 }
 
 message RPCMiddlewareResponse {
@@ -4511,18 +4578,16 @@ message InterceptFeedback {
     string error = 1;
 
     /*
-    A boolean indicating that the gRPC response should be replaced/overwritten.
-    As its name suggests, this can only be used as a feedback to an intercepted
-    response RPC message and is ignored for feedback on any other message. This
-    boolean is needed because in protobuf an empty message is serialized as a
-    0-length or nil byte slice and we wouldn't be able to distinguish between
+    A boolean indicating that the gRPC message should be replaced/overwritten.
+    This boolean is needed because in protobuf an empty message is serialized as
+    a 0-length or nil byte slice and we wouldn't be able to distinguish between
     an empty replacement message and the "don't replace anything" case.
     */
     bool replace_response = 2;
 
     /*
     If the replace_response field is set to true, this field must contain the
-    binary serialized gRPC response message in the protobuf format.
+    binary serialized gRPC message in the protobuf format.
     */
     bytes replacement_serialized = 3;
 }

package/grpc/protos/peers.proto

@@ -7,7 +7,7 @@ package peersrpc;
 option go_package = "github.com/lightningnetwork/lnd/lnrpc/peersrpc";
 
 // Peers is a service that can be used to get information and interact
-// with the other nodes of the newtwork.
+// with the other nodes of the network.
 service Peers {
     /* lncli: peers updatenodeannouncement
     UpdateNodeAnnouncement allows the caller to update the node parameters

package/grpc/protos/router.proto

@@ -336,6 +336,14 @@ message SendToRouteRequest {
 
     // Route that should be used to attempt to complete the payment.
     lnrpc.Route route = 2;
+
+    /*
+    Whether the payment should be marked as failed when a temporary error is
+    returned from the given route. Set it to true so the payment won't be
+    failed unless a terminal error is occurred, such as payment timeout, no
+    routes, incorrect payment details, or insufficient funds.
+    */
+    bool skip_temp_err = 3;
 }
 
 message SendToRouteResponse {

package/grpc/protos/walletkit.proto

@@ -844,6 +844,16 @@ message UtxoLease {
     The absolute expiration of the output lease represented as a unix timestamp.
     */
     uint64 expiration = 3;
+
+    /*
+    The public key script of the leased output.
+    */
+    bytes pk_script = 4;
+
+    /*
+    The value of the leased output in satoshis.
+    */
+    uint64 value = 5;
 }
 
 message SignPsbtRequest {

package/grpc/protos/walletunlocker.proto

@@ -185,6 +185,13 @@ message InitWalletRequest {
     corresponding private keys and can serve signing RPC requests.
     */
     WatchOnly watch_only = 9;
+
+    /*
+    macaroon_root_key is an optional 32 byte macaroon root key that can be
+    provided when initializing the wallet rather than letting lnd generate one
+    on its own.
+    */
+    bytes macaroon_root_key = 10;
 }
 message InitWalletResponse {
     /*

package/lnd_methods/offchain/get_channels.d.ts

@@ -40,6 +40,8 @@ export type GetChannelsResult = {
     is_partner_initiated: boolean;
     /** Channel Is Private */
     is_private: boolean;
+    /** Funding Output is Trusted */
+    is_trusted_funding?: boolean;
     /** Local Balance Tokens */
     local_balance: number;
     /** Local CSV Blocks Delay */
@@ -56,6 +58,8 @@ export type GetChannelsResult = {
     local_min_htlc_mtokens?: string;
     /** Local Reserved Tokens */
     local_reserve: number;
+    /** Other Channel Ids */
+    other_ids: string[];
     /** Channel Partner Public Key */
     partner_public_key: string;
     /** Past Channel States Count */
@@ -122,6 +126,8 @@ export type GetChannelsResult = {
  * 
  * `in_channel`, `in_payment`, `is_forward`, `out_channel`, `out_payment`,
 `payment` are not supported on LND 0.11.1 and below
+ * 
+ * `is_trusted_funding` is not supported on LND 0.15.0 and below
  */
 export const getChannels: AuthenticatedLightningMethod<
   GetChannelsArgs,

package/lnd_methods/offchain/get_closed_channels.d.ts

@@ -66,6 +66,8 @@ export type GetClosedChannelsResult = {
     is_partner_initiated?: boolean;
     /** Is Remote Force Close */
     is_remote_force_close: boolean;
+    /** Other Channel Ids */
+    other_ids: string[];
     /** Partner Public Key Hex */
     partner_public_key: string;
     /** Channel Funding Transaction Id Hex */
@@ -81,6 +83,8 @@ export type GetClosedChannelsResult = {
  * Multiple close type flags are supported.
  *
  * Requires `offchain:read` permission
+ *
+ * `other_ids is not supported on LND 0.15.0 and below
  */
 export const getClosedChannels: AuthenticatedLightningMethod<
   GetClosedChannelsArgs,

package/lnd_methods/offchain/get_ephemeral_channel_ids.d.ts

@@ -0,0 +1,27 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type GetEphemeralChannelIdsArgs = AuthenticatedLightningArgs;
+
+export type GetEphemeralChannelIdsResult = {
+  channels: {
+    /** Channel Identifiers */
+    other_ids: string[];
+    /** Top Level Channel Identifier */
+    reference_id: string;
+  }[];
+};
+
+/**
+ * Get ephemeral channel ids
+ *
+ * Requires `offchain:read` permission
+ *
+ * This method is not supported on LND 0.15.0 and below
+ */
+export const getEphemeralChannelIds: AuthenticatedLightningMethod<
+  GetEphemeralChannelIdsArgs,
+  GetEphemeralChannelIdsResult
+>;

package/lnd_methods/offchain/index.d.ts

@@ -15,6 +15,7 @@ export * from './get_channel_balance';
 export * from './get_channels';
 export * from './get_closed_channels';
 export * from './get_connected_watchtowers';
+export * from './get_ephemeral_channel_ids';
 export * from './get_failed_payments';
 export * from './get_fee_rates';
 export * from './get_forwarding_confidence';

package/lnd_methods/offchain/subscribe_to_channels.d.ts

@@ -58,6 +58,8 @@ export type SubscribeToChannelsChannelClosedEvent = {
   is_partner_initiated?: boolean;
   /** Is Remote Force Close */
   is_remote_force_close: boolean;
+  /** Other Channel Ids */
+  other_ids: string[];
   /** Partner Public Key Hex */
   partner_public_key: string;
   /** Channel Funding Transaction Id Hex */
@@ -89,6 +91,8 @@ export type SubscribeToChannelsChannelOpenedEvent = {
   is_partner_initiated: boolean;
   /** Channel Is Private */
   is_private: boolean;
+  /** Funding Output is Trusted */
+  is_trusted_funding: boolean;
   /** Local Balance Tokens */
   local_balance: number;
   /** Local Initially Pushed Tokens */
@@ -138,5 +142,7 @@ export type SubscribeToChannelsChannelOpeningEvent = {
  * Subscribe to channel updates
  *
  * Requires `offchain:read` permission
+ *
+ * `is_trusted_funding`, `other_ids` are not supported on LND 0.15.0 and below
  */
 export const subscribeToChannels: AuthenticatedLightningSubscription;

package/lnd_methods/offchain/subscribe_to_open_requests.d.ts

@@ -5,6 +5,8 @@ export type SubscribeToOpenRequestsChannelRequestEvent = {
   accept: (args: {
     /** Restrict Coop Close To Address */
     cooperative_close_address?: string;
+    /** Accept Funding as Trusted */
+    is_trusted_funding?: boolean;
     /** Required Confirmations Before Channel Open */
     min_confirmations?: number;
     /** Peer Unilateral Balance Output CSV Delay */
@@ -28,6 +30,10 @@ export type SubscribeToOpenRequestsChannelRequestEvent = {
   csv_delay: number;
   /** Request Id Hex */
   id: string;
+  /** Incoming Channel Is Private Bool */
+  is_private: boolean;
+  /** Request Immediate Trusted Funding */
+  is_trusted_funding: boolean;
   /** Channel Local Tokens Balance */
   local_balance: number;
   /** Channel Local Reserve Tokens */
@@ -61,5 +67,7 @@ channel requests after a short delay.
 listeners to `channel_request`
  *
  * LND 0.11.1 and below do not support `accept` or `reject` arguments
+ * 
+ * LND 0.15.0 and below do not support `is_trusted_funding`
  */
 export const subscribeToOpenRequests: AuthenticatedLightningSubscription;

package/lnd_methods/onchain/close_channel.d.ts

@@ -49,6 +49,8 @@ export type CoopCloseChannelArgs = AuthenticatedLightningArgs<
     is_force_close?: false;
     /** Request Sending Local Channel Funds To Address String */
     address?: string;
+    /** Fail Cooperative Close Above Fee Rate */
+    max_tokens_per_vbyte?: number;
   } & ExpectedBothPublicKeyAndSocketForChannelClose &
     UnexpectedTokensPerVbyteForChannelClose
 >;
@@ -72,7 +74,11 @@ export type CloseChannelResult = {
  *
  * If cooperatively closing, pass a public key and socket to connect
  *
+ * `max_tokens_per_vbyte` will be ignored when closing a peer initiated channel
+ *
  * Requires `info:read`, `offchain:write`, `onchain:write`, `peers:write` permissions
+ *
+ * `max_tokens_per_vbyte` is not supported in LND 0.15.0 and below
  */
 export const closeChannel: AuthenticatedLightningMethod<
   CloseChannelArgs,

package/lnd_methods/onchain/close_channel.js

@@ -15,17 +15,23 @@ const type = 'default';
 
   If cooperatively closing, pass a public key and socket to connect
 
-  Requires info:read, offchain:write, onchain:write, peers:write permissions
+  `max_tokens_per_vbyte` will be ignored when closing a peer initiated channel
+
+  Requires `info:read`, `offchain:write`, `onchain:write`, `peers:write`
+  permissions
+
+  `max_tokens_per_vbyte` is not supported in LND 0.15.0 and below
 
   {
     [address]: <Request Sending Local Channel Funds To Address String>
     [id]: <Standard Format Channel Id String>
     [is_force_close]: <Is Force Close Bool>
     lnd: <Authenticated LND API Object>
+    [max_tokens_per_vbyte]: <Fail Cooperative Close Above Fee Rate Number>
     [public_key]: <Peer Public Key String>
     [socket]: <Peer Socket String>
     [target_confirmations]: <Confirmation Target Number>
-    [tokens_per_vbyte]: <Tokens Per Virtual Byte Number>
+    [tokens_per_vbyte]: <Target Tokens Per Virtual Byte Number>
     [transaction_id]: <Transaction Id Hex String>
     [transaction_vout]: <Transaction Output Index Number>
   }
@@ -115,6 +121,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,
           sat_per_byte: !!tokensPerVByte ? tokensPerVByte : undefined,
           target_conf: args.target_confirmations || undefined,
         });

package/lnd_methods/onchain/get_chain_transactions.d.ts

@@ -10,39 +10,51 @@ export type GetChainTransactionsArgs = AuthenticatedLightningArgs<{
   before?: number;
 }>;
 
-export type GetChainTransactionsResult = {
-  transactions: {
-    /** Block Hash */
-    block_id?: string;
-    /** Confirmation Count */
-    confirmation_count?: number;
-    /** Confirmation Block Height */
-    confirmation_height?: number;
-    /** Created ISO 8601 Date */
-    created_at: string;
-    /** Transaction Label */
-    description?: string;
-    /** Fees Paid Tokens */
-    fee?: number;
-    /** Transaction Id */
-    id: string;
-    /** Is Confirmed */
-    is_confirmed: boolean;
-    /** Transaction Outbound */
-    is_outgoing: boolean;
-    /** Addresses */
-    output_addresses: string[];
-    /** Tokens Including Fee */
-    tokens: number;
-    /** Raw Transaction Hex */
-    transaction?: string;
+export type ChainTransaction = {
+  /** Block Hash */
+  block_id?: string;
+  /** Confirmation Count */
+  confirmation_count?: number;
+  /** Confirmation Block Height */
+  confirmation_height?: number;
+  /** Created ISO 8601 Date */
+  created_at: string;
+  /** Transaction Label */
+  description?: string;
+  /** Fees Paid Tokens */
+  fee?: number;
+  /** Transaction Id */
+  id: string;
+  inputs: {
+    /** Spent Outpoint is Local */
+    is_local: boolean;
+    /** Transaction Id Hex */
+    transaction_id: string;
+    /** Transaction Output Index */
+    transaction_vout: number;
   }[];
+  /** Is Confirmed */
+  is_confirmed: boolean;
+  /** Transaction Outbound */
+  is_outgoing: boolean;
+  /** Addresses */
+  output_addresses: string[];
+  /** Tokens Including Fee */
+  tokens: number;
+  /** Raw Transaction Hex */
+  transaction?: string;
+};
+
+export type GetChainTransactionsResult = {
+  transactions: ChainTransaction[];
 };
 
 /**
  * Get chain transactions.
  *
  * Requires `onchain:read` permission
+ *
+ * `inputs` are not supported on LND 0.15.0 and below
  */
 export const getChainTransactions: AuthenticatedLightningMethod<
   GetChainTransactionsArgs,

package/lnd_methods/onchain/get_chain_transactions.js

@@ -13,10 +13,12 @@ const type = 'default';
 
   Requires `onchain:read` permission
 
+  `inputs` are not supported on LND 0.15.0 and below
+
   {
     [after]: <Confirmed After Current Best Chain Block Height Number>
     [before]: <Confirmed Before Current Best Chain Block Height Number>
-    lnd: <Authenticated LND Object>
+    lnd: <Authenticated LND API Object>
   }
 
   @returns via cbk or Promise
@@ -29,6 +31,11 @@ const type = 'default';
       [description]: <Transaction Label String>
       [fee]: <Fees Paid Tokens Number>
       id: <Transaction Id String>
+      inputs: [{
+        is_local: <Spent Outpoint is Local Bool>
+        transaction_id: <Transaction Id Hex String>
+        transaction_vout: <Transaction Output Index Number>
+      }]
       is_confirmed: <Is Confirmed Bool>
       is_outgoing: <Transaction Outbound Bool>
       output_addresses: [<Address String>]

package/lnd_methods/onchain/get_locked_utxos.d.ts

@@ -12,6 +12,10 @@ export type GetLockedUtxosResult = {
     lock_expires_at: string;
     /** Locking Id Hex String */
     lock_id: string;
+    /** Outpoint Output Script Hex */
+    output_script?: string;
+    /** Token Value of Outpoint */
+    tokens?: number;
     /** Transaction Id Hex String */
     transaction_id: string;
     /** Transaction Output Index Number */
@@ -27,6 +31,8 @@ export type GetLockedUtxosResult = {
  * Requires LND built with `walletrpc` build tag
  *
  * This method is not supported on LND 0.12.1 and below
+ *
+ * `output_script`, `tokens` are not supported on LND 0.15.0 and below
  */
 export const getLockedUtxos: AuthenticatedLightningMethod<
   GetLockedUtxosArgs,

package/lnd_methods/onchain/get_locked_utxos.js

@@ -6,6 +6,7 @@ const {isLnd} = require('./../../lnd_requests');
 const asMs = sec => Number(sec) * 1e3;
 const bufferAsHex = buffer => buffer.toString('hex');
 const {isArray} = Array;
+const {isBuffer} = Buffer;
 const method = 'listLeases';
 const type = 'wallet';
 const unsuppportedErr = /unknown/;
@@ -18,6 +19,8 @@ const unsuppportedErr = /unknown/;
 
   This method is not supported on LND 0.12.1 and below
 
+  `output_script`, `tokens` are not supported on LND 0.15.0 and below
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -27,6 +30,8 @@ const unsuppportedErr = /unknown/;
     utxos: [{
       lock_expires_at: <Lock Expires At ISO 8601 Date String>
       lock_id: <Locking Id Hex String>
+      [output_script]: <Outpoint Output Script Hex String>
+      [tokens]: <Token Value of Outpoint Number>
       transaction_id: <Transaction Id Hex String>
       transaction_vout: <Transaction Output Index Number>
     }]
@@ -64,10 +69,16 @@ module.exports = ({lnd}, cbk) => {
             return cbk([503, 'ExpectedExpirationDateForLockedUtxo']);
           }
 
+          if (!!res.locked_utxos.filter(n => !isBuffer(n.pk_script)).length) {
+            return cbk([503, 'ExpectedPkScriptForLockedUtxosInResponse']);
+          }
+
           try {
             const utxos = res.locked_utxos.map(lock => ({
               lock_expires_at: new Date(asMs(lock.expiration)).toISOString(),
               lock_id: bufferAsHex(lock.id),
+              output_script: bufferAsHex(lock.pk_script) || undefined,
+              tokens: Number(lock.value) || undefined,
               transaction_id: lock.outpoint.txid_str,
               transaction_vout: lock.outpoint.output_index,
             }));

package/lnd_methods/onchain/open_channels.d.ts

@@ -13,6 +13,8 @@ export type OpenChannelsArgs = AuthenticatedLightningArgs<{
     give_tokens?: number;
     /** Channel is Private */
     is_private?: boolean;
+    /** Peer Should Avoid Waiting For Confirmation */
+    is_trusted_funding?: boolean;
     /** Minimum HTLC Millitokens */
     min_htlc_mtokens?: string;
     /** Public Key Hex */
@@ -45,6 +47,13 @@ minutes to fund the channels.
  *
  * If you do not fund the channels, be sure to `cancelPendingChannel`s on each
 channel that was not funded.
+
+  Use `is_avoiding_broadcast` only when self-publishing the raw transaction
+  after the funding step.
+
+  `is_trusted_funding` is not supported on LND 0.15.0 and below and requires
+  `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
+  as well as a channel open request listener to accept the trusted funding.
  */
 export const openChannels: AuthenticatedLightningMethod<
   OpenChannelsArgs,

package/lnd_methods/onchain/subscribe_to_transactions.d.ts

@@ -1,33 +1,16 @@
 import {AuthenticatedLightningSubscription} from '../../typescript';
+import {ChainTransaction} from './get_chain_transactions';
 
-export type SubscribeToTransactionsChainTransactionEvent = {
-  /** Block Hash */
-  block_id?: string;
-  /** Confirmation Count */
-  confirmation_count?: number;
-  /** Confirmation Block Height */
-  confirmation_height?: number;
-  /** Created ISO 8601 Date */
-  created_at: string;
-  /** Fees Paid Tokens */
-  fee?: number;
-  /** Transaction Id */
-  id: string;
-  /** Is Confirmed */
-  is_confirmed: boolean;
-  /** Transaction Outbound */
-  is_outgoing: boolean;
-  /** Addresses */
-  output_addresses: string[];
-  /** Tokens Including Fee */
-  tokens: number;
-  /** Raw Transaction Hex */
-  transaction?: string;
-};
+export type SubscribeToTransactionsChainTransactionEvent = Omit<
+  ChainTransaction,
+  'description'
+>;
 
 /**
  * Subscribe to transactions
  *
  * Requires `onchain:read` permission
+ *
+ * `inputs` are not supported on LND 0.15.0 and below
  */
 export const subscribeToTransactions: AuthenticatedLightningSubscription;

package/lnd_methods/onchain/subscribe_to_transactions.js

@@ -12,6 +12,8 @@ const type = 'default';
 
   Requires `onchain:read` permission
 
+  `inputs` are not supported on LND 0.15.0 and below
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -30,6 +32,11 @@ const type = 'default';
     created_at: <Created ISO 8601 Date String>
     [fee]: <Fees Paid Tokens Number>
     id: <Transaction Id String>
+    inputs: [{
+      is_local: <Spent Outpoint is Local Bool>
+      transaction_id: <Transaction Id Hex String>
+      transaction_vout: <Transaction Output Index Number>
+    }]
     is_confirmed: <Is Confirmed Bool>
     is_outgoing: <Transaction Outbound Bool>
     output_addresses: [<Address String>]

package/lnd_methods/onchain/unlock_utxo.js

@@ -59,10 +59,6 @@ module.exports = (args, cbk) => {
           },
         },
         err => {
-          if (!!err && unsuppportedErr.test(err.details)) {
-            return cbk([501, 'BackingLndDoesNotSupportUnlockingUtxos']);
-          }
-
           if (!!err) {
             return cbk([503, 'UnexpectedErrorUnlockingUtxo', {err}]);
           }

package/lnd_methods/signer/sign_bytes.d.ts

@@ -10,6 +10,8 @@ export type SignBytesArgs = AuthenticatedLightningArgs<{
   key_index: number;
   /** Bytes To Hash and Sign Hex Encoded String */
   preimage: string;
+  /** Signature Type */
+  type?: 'ecdsa' | 'schnorr';
 }>;
 
 export type SignBytesResult = {
@@ -23,6 +25,8 @@ export type SignBytesResult = {
  * Requires LND built with `signrpc` build tag
  *
  * Requires `signer:generate` permission
+ *
+ * `schnorr` signature type is not supported on LND 0.15.0 and below
  */
 export const signBytes: AuthenticatedLightningMethod<
   SignBytesArgs,

package/lnd_responses/rpc_invoice_as_invoice.js

@@ -167,10 +167,6 @@ module.exports = args => {
     throw new Error('ExpectedPreimageInLookupInvoiceResponse');
   }
 
-  if (args.settled !== false && args.settled !== true) {
-    throw new Error('ExpectedSettledStateInLookupInvoiceResponse');
-  }
-
   if (args.value === undefined) {
     throw new Error('ExpectedTokensValueInLookupInvoiceResponse');
   }
@@ -180,6 +176,7 @@ module.exports = args => {
   const descHash = args.description_hash;
   const expiresInMs = Number(args.expiry) * msPerSec;
   const isAmpPush = !args.payment_request && !!args.is_amp;
+  const isConfirmed = args.state === 'SETTLED';
   const mtok = (BigInt(args.value) * mtokensPerToken).toString();
   const payment = args.payment_addr.toString('hex');
   const settleDate = args.settle_date;
@@ -190,7 +187,7 @@ module.exports = args => {
   return {
     chain_address: args.fallback_addr || undefined,
     cltv_delta: Number(args.cltv_expiry),
-    confirmed_at: !args.settled ? undefined : dateFrom(settleDate),
+    confirmed_at: isConfirmed ? dateFrom(settleDate) : undefined,
     confirmed_index: confirmedIndex || undefined,
     created_at: new Date(createdAtMs).toISOString(),
     description: args.memo,
@@ -205,7 +202,7 @@ module.exports = args => {
     id: args.r_hash.toString('hex'),
     index: Number(args.add_index),
     is_canceled: args.state === 'CANCELED' || undefined,
-    is_confirmed: args.settled,
+    is_confirmed: isConfirmed,
     is_held: args.state === 'ACCEPTED' || undefined,
     is_private: args.private,
     is_push: isAmpPush || args.is_keysend || undefined,

package/lnd_responses/rpc_tx_as_transaction.js

@@ -1,8 +1,12 @@
 const {abs} = Math;
 const {isArray} = Array;
+const isBool = n => n === false || n === true;
 const isHash = n => !!n && /^[0-9A-F]{64}$/i.test(n);
+const isNumber = n => !!n && !isNaN(n);
 const msPerSec = 1e3;
 const notFound = -1;
+const nullHash = '0000000000000000000000000000000000000000000000000000000000000000';
+const outpointAsComponents = n => n.split(':');
 
 /** Transaction from RPC transaction message
 
@@ -13,6 +17,10 @@ const notFound = -1;
     dest_addresses: [<Output Address String>]
     label: <Label String>
     num_confirmations: <Confirmation Count Number>
+    previous_outpoints: [{
+      is_our_output: <Is Local Output Bool>
+      outpoint: <Outpoint String>
+    }]
     raw_tx_hex: <Raw Transaction Serialized Hex String>
     time_stamp: <Transaction Created At Epoch Time String>
     total_fees: <Total Fees Paid Related To This Transaction String>
@@ -31,6 +39,11 @@ const notFound = -1;
     [description]: <Transaction Label String>
     [fee]: <Fees Paid Tokens Number>
     id: <Transaction Id String>
+    inputs: [{
+      is_local: <Spent Outpoint is Local Bool>
+      transaction_id: <Transaction Id Hex String>
+      transaction_vout: <Transaction Output Index Number>
+    }]
     is_confirmed: <Is Confirmed Bool>
     is_outgoing: <Transaction Outbound Bool>
     output_addresses: [<Address String>]
@@ -67,6 +80,10 @@ module.exports = tx => {
     throw new Error('ExpectedChainTransactionConfirmationsCount');
   }
 
+  if (!isArray(tx.previous_outpoints)) {
+    throw new Error('ExpectedArrayOfPreviousOutpointsInRpcTransaction');
+  }
+
   if (!tx.time_stamp) {
     throw new Error('ExpectedChainTransactionTimestamp');
   }
@@ -79,6 +96,37 @@ module.exports = tx => {
     throw new Error('ExpectedChainTransactionId');
   }
 
+  const inputs = tx.previous_outpoints.map(spend => {
+    if (!spend.outpoint) {
+      throw new Error('ExpectedPreviousOutpointInRpcTransaction');
+    }
+
+    const [id, vout] = outpointAsComponents(spend.outpoint);
+
+    if (!isHash(id)) {
+      throw new Error('ExpectedOutpointSpendingTransactionIdInRpcTx');
+    }
+
+    // Exit early when spend is empty
+    if (id === nullHash) {
+      return null;
+    }
+
+    if (!isNumber(vout)) {
+      throw new Error('ExpectedOutpointSpendingTransactionVoutInRpcTx');
+    }
+
+    if (!isBool(spend.is_our_output)) {
+      throw new Error('ExpectedOutpointOwnershipBooleanInRpcTransaction');
+    }
+
+    return {
+      is_local: spend.is_our_output,
+      transaction_id: id,
+      transaction_vout: Number(vout),
+    };
+  });
+
   return {
     block_id: tx.block_hash || undefined,
     confirmation_count: tx.num_confirmations || undefined,
@@ -87,6 +135,7 @@ module.exports = tx => {
     description: tx.label || undefined,
     fee: Number(tx.total_fees) || undefined,
     id: tx.tx_hash,
+    inputs: inputs.filter(n => !!n),
     is_confirmed: !!tx.num_confirmations,
     is_outgoing: Number(tx.amount) < Number(),
     output_addresses: tx.dest_addresses,

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.6.10",
     "@grpc/proto-loader": "0.7.2",
     "@types/express": "4.17.13",
-    "@types/node": "18.7.8",
+    "@types/node": "18.7.13",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -26,14 +26,14 @@
     "invoices": "2.1.0",
     "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.18.1"
+    "type-fest": "2.19.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
     "tsd": "0.22.0",
-    "typescript": "4.7.4",
+    "typescript": "4.8.2",
     "ws": "8.8.1"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.18.0"
+  "version": "5.20.1"
 }

package/test/lnd_methods/onchain/test_get_chain_transactions.js

@@ -11,6 +11,7 @@ const makeExpected = overrides => {
     description: undefined,
     fee: 1,
     id: Buffer.alloc(32).toString('hex'),
+    inputs: [],
     is_confirmed: true,
     is_outgoing: false,
     output_addresses: ['address'],
@@ -33,6 +34,7 @@ const makeLnd = overrides => {
           block_height: 1,
           dest_addresses: ['address'],
           num_confirmations: 1,
+          previous_outpoints: [],
           time_stamp: '1',
           total_fees: '1',
           tx_hash: Buffer.alloc(32).toString('hex'),

package/test/lnd_methods/onchain/test_get_locked_utxos.js

@@ -13,6 +13,8 @@ const makeLnd = overrides => {
             output_index: 0,
             txid_str: Buffer.alloc(32).toString('hex'),
           },
+          pk_script: Buffer.alloc(1),
+          value: '1',
         };
 
         Object.keys(overrides).forEach(k => utxo[k] = overrides[k]);
@@ -56,12 +58,31 @@ const tests = [
     description: 'An outpoint is expected in a locked utxo',
     error: [503, 'UnexpectedErrorParsingLockedUtxosResponse'],
   },
+  {
+    args: {lnd: makeLnd({pk_script: undefined})},
+    description: 'An output script is expected in a locked utxo',
+    error: [503, 'ExpectedPkScriptForLockedUtxosInResponse'],
+  },
+  {
+    args: {lnd: makeLnd({pk_script: Buffer.alloc(0), value: '0'})},
+    description: 'Get legacy tx and map them to normalized transactions',
+    expected: [{
+      lock_expires_at: '1970-01-01T00:00:01.000Z',
+      lock_id: '0000000000000000000000000000000000000000000000000000000000000000',
+      output_script: undefined,
+      tokens: undefined,
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+    }],
+  },
   {
     args: {lnd: makeLnd({})},
     description: 'Get transactions and map them to normalized transactions',
     expected: [{
       lock_expires_at: '1970-01-01T00:00:01.000Z',
       lock_id: '0000000000000000000000000000000000000000000000000000000000000000',
+      output_script: '00',
+      tokens: 1,
       transaction_id: Buffer.alloc(32).toString('hex'),
       transaction_vout: 0,
     }],

package/test/lnd_methods/onchain/test_get_sweep_transactions.js

@@ -13,6 +13,7 @@ const makeDefault = overrides => {
           block_height: 1,
           dest_addresses: ['address'],
           num_confirmations: 1,
+          previous_outpoints: [],
           raw_tx_hex: (new Transaction()).toHex(),
           time_stamp: '1',
           total_fees: '1',

package/test/lnd_methods/onchain/test_subscribe_to_transactions.js

@@ -11,6 +11,7 @@ const makeLnd = overrides => {
     block_height: 1,
     dest_addresses: ['address'],
     num_confirmations: 1,
+    previous_outpoints: [],
     raw_tx_hex: '00',
     time_stamp: '1',
     total_fees: '1',
@@ -95,6 +96,7 @@ const tests = [
       description: undefined,
       fee: 1,
       id: '0000000000000000000000000000000000000000000000000000000000000000',
+      inputs: [],
       is_confirmed: true,
       is_outgoing: false,
       output_addresses: ['address'],

package/test/lnd_methods/onchain/test_unlock_utxo.js

@@ -38,13 +38,6 @@ const tests = [
     description: 'A transaction id is required to unlock a utxo',
     error: [400, 'ExpectedTransactionOutputIndexToUnlockUtxo'],
   },
-  {
-    args: makeArgs({
-      lnd: {wallet: {releaseOutput: ({}, cbk) => cbk({details: 'unknown'})}},
-    }),
-    description: 'LND unknown service errors are returned',
-    error: [501, 'BackingLndDoesNotSupportUnlockingUtxos'],
-  },
   {
     args: makeArgs({lnd: {wallet: {releaseOutput: ({}, cbk) => cbk('err')}}}),
     description: 'LND errors are returned',

package/test/lnd_responses/test_rpc_invoice_as_invoice.js

@@ -49,7 +49,6 @@ const makeInput = overrides => {
     }],
     settle_date: '1',
     settle_index: '1',
-    settled: false,
     state: 'STATE',
     value: '1',
     value_msat: '1000',
@@ -179,11 +178,6 @@ const tests = [
     description: 'Preimage is expected',
     error: 'ExpectedPreimageInLookupInvoiceResponse',
   },
-  {
-    args: makeInput({settled: undefined}),
-    description: 'Settled is expected',
-    error: 'ExpectedSettledStateInLookupInvoiceResponse',
-  },
   {
     args: makeInput({value: undefined}),
     description: 'Value is expected',
@@ -199,7 +193,7 @@ const tests = [
       is_amp: true,
       is_keysend: false,
       payment_request: undefined,
-      settled: true,
+      state: 'SETTLED',
     }),
     description: 'AMP invoice mapped to invoice',
     expected: makeExpected({
@@ -211,7 +205,7 @@ const tests = [
   {
     args: makeInput({
       payment_request: undefined,
-      settled: true,
+      state: 'SETTLED',
       value_msat: '0',
     }),
     description: 'Unsettled zero RPC invoice mapped to invoice',

package/test/lnd_responses/test_rpc_tx_as_transaction.js

@@ -9,6 +9,16 @@ const makeTx = override => {
     block_height: 1,
     dest_addresses: ['address'],
     num_confirmations: 1,
+    previous_outpoints: [
+      {
+        is_our_output: true,
+        outpoint: `${Buffer.alloc(32).toString('hex')}:1`,
+      },
+      {
+        is_our_output: true,
+        outpoint: `${Buffer.alloc(32, 1).toString('hex')}:1`,
+      },
+    ],
     raw_tx_hex: '00',
     time_stamp: '1',
     total_fees: '1',
@@ -56,6 +66,39 @@ const tests = [
     description: 'Confirmation count is expected',
     error: 'ExpectedChainTransactionConfirmationsCount',
   },
+  {
+    args: makeTx({previous_outpoints: undefined}),
+    description: 'Previous outpoints are expected',
+    error: 'ExpectedArrayOfPreviousOutpointsInRpcTransaction',
+  },
+  {
+    args: makeTx({previous_outpoints: [{}]}),
+    description: 'An outpoint spend is expected',
+    error: 'ExpectedPreviousOutpointInRpcTransaction',
+  },
+  {
+    args: makeTx({previous_outpoints: [{outpoint: '00'}]}),
+    description: 'An outpoint with a tx id is expected',
+    error: 'ExpectedOutpointSpendingTransactionIdInRpcTx',
+  },
+  {
+    args: makeTx({
+      previous_outpoints: [{
+        outpoint: `${Buffer.alloc(32, 1).toString('hex')}`,
+      }],
+    }),
+    description: 'An outpoint with a tx vout is expected',
+    error: 'ExpectedOutpointSpendingTransactionVoutInRpcTx',
+  },
+  {
+    args: makeTx({
+      previous_outpoints: [{
+        outpoint: `${Buffer.alloc(32, 1).toString('hex')}:1`,
+      }],
+    }),
+    description: 'Local status for spend is expected',
+    error: 'ExpectedOutpointOwnershipBooleanInRpcTransaction',
+  },
   {
     args: makeTx({time_stamp: undefined}),
     description: 'A time stamp is expected',
@@ -82,6 +125,11 @@ const tests = [
       description: undefined,
       fee: 1,
       id: Buffer.alloc(32).toString('hex'),
+      inputs: [{
+        is_local: true,
+        transaction_id: '0101010101010101010101010101010101010101010101010101010101010101',
+        transaction_vout: 1,
+      }],
       is_confirmed: true,
       is_outgoing: false,
       output_addresses: ['address'],
@@ -95,6 +143,7 @@ const tests = [
       block_hash: '',
       block_height: 0,
       num_confirmations: 0,
+      previous_outpoints: [],
       raw_tx_hex: '',
       total_fees: '0',
     }),
@@ -107,6 +156,7 @@ const tests = [
       description: undefined,
       fee: undefined,
       id: Buffer.alloc(32).toString('hex'),
+      inputs: [],
       is_confirmed: false,
       is_outgoing: true,
       output_addresses: ['address'],