@atomiqlabs/sdk
Version:
atomiq labs SDK for cross-chain swaps between smart chains and bitcoin
62 lines (61 loc) • 1.35 kB
TypeScript
/**
* Response of the LNURL-pay link
*
* @category Lightning
*/
export type LNURLPayParams = {
tag: "payRequest";
callback: string;
domain: string;
minSendable: number;
maxSendable: number;
metadata: string;
decodedMetadata: string[][];
commentAllowed: number;
};
/**
* Response of the LNURL-pay link with the added original url
*
* @category Lightning
*/
export type LNURLPayParamsWithUrl = LNURLPayParams & {
url: string;
};
/**
* Parsed LNURL-pay specification
*
* @category Lightning
*/
export type LNURLPay = {
type: "pay";
min: bigint;
max: bigint;
commentMaxLength: number;
shortDescription?: string;
longDescription?: string;
icon?: string;
params: LNURLPayParamsWithUrl;
};
/**
* Type guard for {@link LNURLPayParams}
*
* @category Lightning
* @internal
*/
export declare function isLNURLPayParams(obj: any): obj is LNURLPayParams;
/**
* Type guard for {@link LNURLPay}
*
* @category Lightning
*/
export declare function isLNURLPay(value: any): value is LNURLPay;
/**
* Decoded LNURL-pay success action, revealed after a lightning payment is finished
*
* @category Lightning
*/
export type LNURLDecodedSuccessAction = {
description: string;
text?: string;
url?: string;
};