@atomiqlabs/sdk/src/swaps/ISwapWithGasDrop.ts

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

import {ChainType} from "@atomiqlabs/base";
import {TokenAmount} from "../types/TokenAmount";
import {SCToken} from "../types/Token";

/**
 * Type guard to check if a swap has gas drop functionality
 *
 * @category Swaps/Types
 */
export function isSwapWithGasDrop(swap: any): swap is ISwapWithGasDrop<any> {
    return swap!=null && typeof(swap.getGasDropOutput)==="function";
}

/**
 * Interface for swaps with gas drop functionality
 *
 * @category Swaps/Types
 */
export interface ISwapWithGasDrop<T extends ChainType> {
    /**
     * Returns the output of the "gas drop", additional native token received by the user on
     *  the destination chain
     */
    getGasDropOutput(): TokenAmount<SCToken<T["ChainId"]>>;
}