lightning/lnd_methods/onchain/send_to_chain_output_scripts.d.ts

Lightning Network client library

import {
  AuthenticatedLightningArgs,
  AuthenticatedLightningMethod,
  UtxoSelection,
} from '../../typescript';
import {MergeExclusive} from 'type-fest';

export type SendToChainOutputScriptsArgs = AuthenticatedLightningArgs<{
  /** Transaction Label String */
  description?: string;
  /** Chain Fee Tokens Per Virtual Byte Number */
  fee_tokens_per_vbyte?: number;
  send_to: {
    /** Output Script Hex String */
    script: string;
    /** Tokens Number */
    tokens: number;
  }[];
  /** Minimum Confirmations for UTXO Selection Number */
  utxo_confirmations?: number;
  /** Select UTXOs Using Method String */
  utxo_selection?: UtxoSelection;
}>;

export type SendToChainOutputScriptsResult = {
  /** Total Confirmations Number */
  confirmation_count: number;
  /** Transaction Id Hex String */
  id: string;
  /** Transaction Is Confirmed Bool */
  is_confirmed: boolean;
  /** Transaction Is Outgoing Bool */
  is_outgoing: boolean;
  /** Transaction Tokens Number */
  tokens: number;
  /** Raw Transaction Hex String */
  transaction: string;
};

/**
 * Send on-chain funds to multiple output scripts
 *
 * 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,
  SendToChainOutputScriptsResult
>;