@atomiqlabs/sdk/src/types/wallets/LightningInvoiceCreateService.ts

atomiq labs SDK for cross-chain swaps between smart chains and bitcoin

/**
 * Invoice getter callback for the {@link LightningInvoiceCreateService}
 *
 * @category Lightning
 */
export type LightningWalletCallback = (valueSats: number, abortSignal?: AbortSignal) => Promise<string>;
/**
 * Service that creates on-demand fixed amount bolt11 lightning network invoices, optionally
 *  specifying minimum and maximum swappable sats amount. This used for exact input Smart chain ->
 *  Lightning swaps.
 *
 * @category Lightning
 */
export type LightningInvoiceCreateService = {
    getInvoice: LightningWalletCallback,
    minMsats?: bigint,
    maxMSats?: bigint
};

/**
 * Type guard for {@link LightningInvoiceCreateService}
 *
 * @internal
 */
export function isLightningInvoiceCreateService(obj: any): obj is LightningInvoiceCreateService {
    return typeof (obj) === "object" &&
        typeof (obj.getInvoice) === "function" &&
        (obj.minMsats == null || typeof (obj.minMsats) === "bigint") &&
        (obj.maxMSats == null || typeof (obj.maxMSats) === "bigint");
}