lightningdevkit/structs/LSPS1OnchainPaymentInfo.d.mts

Lightning Development Kit

import { Address } from '../structs/Address.mjs';
import { LSPS1PaymentState } from '../enums/LSPS1PaymentState.mjs';
import { Option_AddressZ } from '../structs/Option_AddressZ.mjs';
import { Option_u16Z } from '../structs/Option_u16Z.mjs';
import { LSPSDateTime } from '../structs/LSPSDateTime.mjs';
import { CommonBase } from './CommonBase.mjs';
/**
 * An onchain payment.
 */
export declare class LSPS1OnchainPaymentInfo extends CommonBase {
    /**
     * Indicates the current state of the payment.
     */
    get_state(): LSPS1PaymentState;
    /**
     * Indicates the current state of the payment.
     */
    set_state(val: LSPS1PaymentState): void;
    /**
     * The datetime when the payment option expires.
     */
    get_expires_at(): LSPSDateTime;
    /**
     * The datetime when the payment option expires.
     */
    set_expires_at(val: LSPSDateTime): void;
    /**
     * The total fee the LSP will charge to open this channel in satoshi.
     */
    get_fee_total_sat(): bigint;
    /**
     * The total fee the LSP will charge to open this channel in satoshi.
     */
    set_fee_total_sat(val: bigint): void;
    /**
     * The amount the client needs to pay to have the requested channel openend.
     */
    get_order_total_sat(): bigint;
    /**
     * The amount the client needs to pay to have the requested channel openend.
     */
    set_order_total_sat(val: bigint): void;
    /**
     * An on-chain address the client can send [`Self::order_total_sat`] to to have the channel
     * opened.
     */
    get_address(): Address;
    /**
     * An on-chain address the client can send [`Self::order_total_sat`] to to have the channel
     * opened.
     */
    set_address(val: Address): void;
    /**
     * The minimum number of block confirmations that are required for the on-chain payment to be
     * considered confirmed.
     */
    get_min_onchain_payment_confirmations(): Option_u16Z;
    /**
     * The minimum number of block confirmations that are required for the on-chain payment to be
     * considered confirmed.
     */
    set_min_onchain_payment_confirmations(val: Option_u16Z): void;
    /**
     * The address where the LSP will send the funds if the order fails.
     */
    get_refund_onchain_address(): Option_AddressZ;
    /**
     * The address where the LSP will send the funds if the order fails.
     */
    set_refund_onchain_address(val: Option_AddressZ): void;
    clone_ptr(): bigint;
    /**
     * Creates a copy of the LSPS1OnchainPaymentInfo
     */
    clone(): LSPS1OnchainPaymentInfo;
    /**
     * Checks if two LSPS1OnchainPaymentInfos 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: LSPS1OnchainPaymentInfo): boolean;
}