Merge pull request #162 from bkiac/update-types

Add utxo_selection types
alexbosworth · Apr 24, 2024 · f3c7ba4 · f3c7ba4
2 parents 03f7396 + 115662f
commit f3c7ba4
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 0 deletions.
diff --git a/lnd_methods/onchain/fund_psbt.d.ts b/lnd_methods/onchain/fund_psbt.d.ts
@@ -1,6 +1,7 @@
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  UtxoSelection,
 } from '../../typescript';
 import {MergeExclusive} from 'type-fest';
 
@@ -57,6 +58,8 @@ export type FundPsbtResult = {
   }[];
   /** Unsigned PSBT Hex */
   psbt: string;
+  /** Select UTXOs Using Method String */
+  utxo_selection?: UtxoSelection;
 };
 
 /**
@@ -73,6 +76,8 @@ export type FundPsbtResult = {
  * This method is not supported in LND 0.11.1 and below
  *
  * Specifying 0 for `min_confirmations` is not supported in LND 0.13.0 and below
+ *
+ * `utxo_selection` is not supported in LND 0.17.5 and below
  */
 export const fundPsbt: AuthenticatedLightningMethod<
   FundPsbtArgs,

diff --git a/lnd_methods/onchain/get_chain_fee_estimate.d.ts b/lnd_methods/onchain/get_chain_fee_estimate.d.ts
@@ -1,6 +1,7 @@
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  UtxoSelection,
 } from '../../typescript';
 
 export type GetChainFeeEstimateArgs = AuthenticatedLightningArgs<{
@@ -14,6 +15,8 @@ export type GetChainFeeEstimateArgs = AuthenticatedLightningArgs<{
   target_confirmations?: number;
   /** Minimum Confirmations for UTXO Selection */
   utxo_confirmations?: number;
+  /** Select UTXOs Using Method String */
+  utxo_selection?: UtxoSelection;
 }>;
 
 export type GetChainFeeEstimateResult = {
@@ -27,6 +30,8 @@ export type GetChainFeeEstimateResult = {
  * Get a chain fee estimate for a prospective chain send
  *
  * Requires `onchain:read` permission
+ *
+ * `utxo_selection` is not supported in LND 0.17.5 and below
  */
 export const getChainFeeEstimate: AuthenticatedLightningMethod<
   GetChainFeeEstimateArgs,

diff --git a/lnd_methods/onchain/send_to_chain_address.d.ts b/lnd_methods/onchain/send_to_chain_address.d.ts
@@ -3,6 +3,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
   LightningError,
+  UtxoSelection,
 } from '../../typescript';
 import {MergeExclusive} from 'type-fest';
 
@@ -38,6 +39,8 @@ export type SendToChainAddressArgs = AuthenticatedLightningArgs<
     target_confirmations?: number;
     /** Minimum Confirmations for UTXO Selection */
     utxo_confirmations?: number;
+    /** Select UTXOs Using Method String */
+    utxo_selection?: UtxoSelection;
   } & ExpectedNoTokensSpecifiedWhenSendingAllFunds &
     ExpectedLogFunctionForChainSendSocketAnnounce
 >;
@@ -61,6 +64,8 @@ export type SendToChainAddressResult = {
  * Requires `onchain:write` permission
  *
  * `utxo_confirmations` is not supported on LND 0.11.1 or below
+ *
+ * `utxo_selection` is not supported in LND 0.17.5 and below
  */
 export const sendToChainAddress: AuthenticatedLightningMethod<
   SendToChainAddressArgs,

diff --git a/lnd_methods/onchain/send_to_chain_addresses.d.ts b/lnd_methods/onchain/send_to_chain_addresses.d.ts
@@ -3,6 +3,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
   LightningError,
+  UtxoSelection,
 } from '../../typescript';
 import {MergeExclusive} from 'type-fest';
 
@@ -32,6 +33,8 @@ export type SendToChainAddressesArgs = AuthenticatedLightningArgs<
     target_confirmations?: number;
     /** Minimum Confirmations for UTXO Selection */
     utxo_confirmations?: number;
+    /** Select UTXOs Using Method String */
+    utxo_selection?: UtxoSelection;
   } & ExpectedLogForChainSendWebSocketAnnouncement
 >;
 
@@ -54,6 +57,8 @@ export type SendToChainAddressesResult = {
  * Requires `onchain:write` permission
  *
  * `utxo_confirmations` is not supported on LND 0.11.1 or below
+ *
+ * `utxo_selection` is not supported in LND 0.17.5 and below
  */
 export const sendToChainAddresses: AuthenticatedLightningMethod<
   SendToChainAddressesArgs,

diff --git a/lnd_methods/onchain/send_to_chain_output_scripts.d.ts b/lnd_methods/onchain/send_to_chain_output_scripts.d.ts
@@ -1,6 +1,7 @@
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  UtxoSelection,
 } from '../../typescript';
 import {MergeExclusive} from 'type-fest';
 
@@ -17,6 +18,8 @@ export type SendToChainOutputScriptsArgs = AuthenticatedLightningArgs<{
   }[];
   /** Minimum Confirmations for UTXO Selection Number */
   utxo_confirmations?: number;
+  /** Select UTXOs Using Method String */
+  utxo_selection?: UtxoSelection;
 }>;
 
 export type SendToChainOutputScriptsResult = {
@@ -40,6 +43,8 @@ export type SendToChainOutputScriptsResult = {
  * Requires `onchain:write` permission
  *
  * Requires LND compiled with `walletrpc` build tag
+ *
+ * `utxo_selection` is not supported in LND 0.17.5 and below
  */
 export const sendToChainOutputScripts: AuthenticatedLightningMethod<
   SendToChainOutputScriptsArgs,

diff --git a/typescript/shared.d.ts b/typescript/shared.d.ts
@@ -118,3 +118,5 @@ export type RouteNode = {
 export type Route = RouteNode[]
 
 export type Routes = Route[]
+
+export type UtxoSelection = "largest" | "random";