lightning 5.20.0 → 5.21.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Versions
 
+## 5.21.0
+
+- `getChainFeeEstimate`: Add support for specifying min `utxo_confirmations`
+
+## 5.20.2
+
+- `getWalletInfo`: Add support for detecting lnd versions 0.15.0 and 0.15.1
+
+## 5.20.1
+
+- Update typescript definitions
+
 ## 5.20.0
 
 - `getLockedUtxos`: Add support for returning script, value of locked utxos

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/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/lnd_methods/info/constants.json

@@ -25,6 +25,7 @@
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",
     "52bb3f33707b81972c67937c7a89addcdf00991c": "0.10.1-beta",
     "596fd90ef310cd7abbf2251edaae9ba4d5f8a689": "0.13.1-beta",
+    "5c36d96c9cbe8b27c29f9682dcbdab7928ae870f": "0.15.0-beta",
     "6042004edaaa5b3cad0a0808ff23dba4716f7178": "0.14.1-beta",
     "61c34683058f2cc8dc10f49392a0057440d831c4": "0.13.4-beta",
     "725ff104808f49f0a5247bfdb4b6b5da7f488d38": "0.13.0-beta",
@@ -35,7 +36,8 @@
     "d176d2d65fc06e6631c4dc9478592be8545a21de": "0.12.0-beta",
     "d233f61383f2f950aa06f5b09da5b0e78e784fae": "0.12.1-beta",
     "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta",
-    "df0b82f0165f19bde8832bacd1e35544b0a2990d": "0.14.0-beta"
+    "df0b82f0165f19bde8832bacd1e35544b0a2990d": "0.14.0-beta",
+    "fd1a95bf322cdd1c743a1554f8e470fbf9a5e564": "0.15.1-beta"
   },
   "weightedType": "weightedcomb",
   "wrongLnd": "12 UNIMPLEMENTED: unknown service autopilotrpc.Autopilot"

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/get_chain_fee_estimate.d.ts

@@ -12,6 +12,8 @@ export type GetChainFeeEstimateArgs = AuthenticatedLightningArgs<{
   }[];
   /** Target Confirmations */
   target_confirmations?: number;
+  /** Minimum Confirmations for UTXO Selection */
+  utxo_confirmations?: number;
 }>;
 
 export type GetChainFeeEstimateResult = {

package/lnd_methods/onchain/get_chain_fee_estimate.js

@@ -8,11 +8,14 @@ const {isArray} = Array;
 const method = 'estimateFee';
 const notFound = -1;
 const type = 'default';
+const unconfirmedConfCount = 0;
 
 /** Get a chain fee estimate for a prospective chain send
 
   Requires `onchain:read` permission
 
+  Specifying 0 for `utxo_confirmations` is not supported in LND 0.13.0 or below
+
   {
     lnd: <Authenticated LND API Object>
     send_to: [{
@@ -20,6 +23,7 @@ const type = 'default';
       tokens: <Tokens Number>
     }]
     [target_confirmations]: <Target Confirmations Number>
+    [utxo_confirmations]: <Minimum Confirmations for UTXO Selection Number>
   }
 
   @returns via cbk or Promise
@@ -65,6 +69,8 @@ module.exports = (args, cbk) => {
         return args.lnd[type][method]({
           AddrToAmount,
           target_conf: args.target_confirmations || undefined,
+          min_confs: args.utxo_confirmations || undefined,
+          spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
         },
         (err, res) => {
           if (!!err) {

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_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/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/send_to_chain_address.js

@@ -5,6 +5,7 @@ const {isLnd} = require('./../../lnd_requests');
 
 const initialConfirmationCount = 0;
 const {isArray} = Array;
+const {isInteger} = Number;
 const lowBalanceErr = 'insufficient funds available to construct transaction';
 const method = 'sendCoins';
 const OPEN = 1;
@@ -53,6 +54,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedLndForChainSendRequest']);
         }
 
+        if (!!args.tokens && !isInteger(args.tokens)) {
+          return cbk([400, 'ExpectedWholeNumberAmountToSendFundsOnChain']);
+        }
+
         if (!args.tokens && !args.is_send_all) {
           return cbk([400, 'MissingTokensToSendOnChain']);
         }

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/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/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.6.10",
+    "@grpc/grpc-js": "1.6.12",
     "@grpc/proto-loader": "0.7.2",
     "@types/express": "4.17.13",
-    "@types/node": "18.7.13",
+    "@types/node": "18.7.14",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -23,7 +23,7 @@
     "cbor": "8.1.0",
     "ecpair": "2.0.1",
     "express": "4.18.1",
-    "invoices": "2.1.0",
+    "invoices": "2.2.0",
     "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
     "type-fest": "2.19.0"
@@ -32,8 +32,8 @@
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
-    "tsd": "0.22.0",
-    "typescript": "4.7.4",
+    "tsd": "0.23.0",
+    "typescript": "4.8.2",
     "ws": "8.8.1"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.20.0"
+  "version": "5.21.0"
 }

package/test/lnd_methods/onchain/test_get_chain_fee_estimate.js

@@ -78,6 +78,22 @@ const tests = [
     description: 'Fee rate and fee are given in chain response',
     expected: {fee: 1, tokens_per_vbyte: 1},
   },
+  {
+    args: {
+      lnd: {
+        default: {
+          estimateFee: ({}, cbk) => cbk(null, {
+            fee_sat: '1',
+            feerate_sat_per_byte: '1',
+          }),
+        },
+      },
+      send_to: [{address: 'address', tokens: 1}],
+      utxo_confirmations: 0,
+    },
+    description: 'Passing 0 UTXO confirmations is supported',
+    expected: {fee: 1, tokens_per_vbyte: 1},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

package/test/lnd_methods/onchain/test_send_to_chain_address.js

@@ -36,6 +36,11 @@ const tests = [
     description: 'Expected tokens to send to chain address',
     error: [400, 'MissingTokensToSendOnChain'],
   },
+  {
+    args: makeArgs({tokens: 0.1}),
+    description: 'Expected non-fractional tokens to send to chain address',
+    error: [400, 'ExpectedWholeNumberAmountToSendFundsOnChain'],
+  },
   {
     args: makeArgs({is_send_all: true, tokens: 1}),
     description: 'Expected either send all or tokens to send to chain address',