@atomiqlabs/sdk/dist/swaps/IAddressSwap.d.ts

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

/**
 * Type guard to check if an object is an {@link IAddressSwap}
 *
 * @category Swaps/Types
 */
export declare function isIAddressSwap(obj: any): obj is IAddressSwap;
/**
 * Interface for swaps which require a user to send funds to a specific address
 *
 * @category Swaps/Types
 */
export interface IAddressSwap {
    /**
     * An address to which the user needs to send funds on the source chain
     */
    getAddress(): string;
    /**
     * A hyperlink representation of the address + amount that the user needs to sends on the source chain.
     *  This is suitable to be displayed in a form of QR code.
     */
    getHyperlink(): string;
}