lightningdevkit/structs/LSPS1OrderParams.d.mts

Lightning Development Kit

import { Option_StrZ } from '../structs/Option_StrZ.mjs';
import { CommonBase } from './CommonBase.mjs';
/**
 * An object representing an bLIP-51 / LSPS1 channel order.
 */
export declare class LSPS1OrderParams extends CommonBase {
    /**
     * Indicates how many satoshi the LSP will provide on their side.
     */
    get_lsp_balance_sat(): bigint;
    /**
     * Indicates how many satoshi the LSP will provide on their side.
     */
    set_lsp_balance_sat(val: bigint): void;
    /**
     * Indicates how many satoshi the client will provide on their side.
     *
     * The client sends these funds to the LSP, who will push them back to the client upon opening
     * the channel.
     */
    get_client_balance_sat(): bigint;
    /**
     * Indicates how many satoshi the client will provide on their side.
     *
     * The client sends these funds to the LSP, who will push them back to the client upon opening
     * the channel.
     */
    set_client_balance_sat(val: bigint): void;
    /**
     * The number of confirmations the funding tx must have before the LSP sends `channel_ready`.
     */
    get_required_channel_confirmations(): number;
    /**
     * The number of confirmations the funding tx must have before the LSP sends `channel_ready`.
     */
    set_required_channel_confirmations(val: number): void;
    /**
     * The maximum number of blocks the client wants to wait until the funding transaction is confirmed.
     */
    get_funding_confirms_within_blocks(): number;
    /**
     * The maximum number of blocks the client wants to wait until the funding transaction is confirmed.
     */
    set_funding_confirms_within_blocks(val: number): void;
    /**
     * Indicates how long the channel is leased for in block time.
     */
    get_channel_expiry_blocks(): number;
    /**
     * Indicates how long the channel is leased for in block time.
     */
    set_channel_expiry_blocks(val: number): void;
    /**
     * May contain arbitrary associated data like a coupon code or a authentication token.
     */
    get_token(): Option_StrZ;
    /**
     * May contain arbitrary associated data like a coupon code or a authentication token.
     */
    set_token(val: Option_StrZ): void;
    /**
     * Indicates if the channel should be announced to the network.
     */
    get_announce_channel(): boolean;
    /**
     * Indicates if the channel should be announced to the network.
     */
    set_announce_channel(val: boolean): void;
    /**
     * Constructs a new LSPS1OrderParams given each field
     */
    static constructor_new(lsp_balance_sat_arg: bigint, client_balance_sat_arg: bigint, required_channel_confirmations_arg: number, funding_confirms_within_blocks_arg: number, channel_expiry_blocks_arg: number, token_arg: Option_StrZ, announce_channel_arg: boolean): LSPS1OrderParams;
    clone_ptr(): bigint;
    /**
     * Creates a copy of the LSPS1OrderParams
     */
    clone(): LSPS1OrderParams;
    /**
     * Checks if two LSPS1OrderParamss contain equal inner contents.
     * This ignores pointers and is_owned flags and looks at the values in fields.
     * Two objects with NULL inner values will be considered "equal" here.
     */
    eq(b: LSPS1OrderParams): boolean;
}