butterjs-sdk/dist/core/bridge/bridge.d.ts

Butter Network SDK

import { BridgeRequestParam } from '../../types';
import { ButterTransactionResponse } from '../../types/responseTypes';
export declare class ButterBridge {
    /**
     * The BridgeToken method is used to bridge token from one chain to another.
     * see {@link BridgeRequestParam} for detail
     * @param token source token, aka token that user provide
     * @param toChainId target chain id
     * @param toAddress target chain receiving address
     * @param amount amount to bridge, in minimal uint. For example wei in Ethereum, yocto in Near
     * @param options of bridging, check {@link BridgeOptions} for more details
     * @return ButterTransactionResponse
     */
    bridgeToken({ fromAddress, fromToken, toChainId, toAddress, amount, options, }: BridgeRequestParam): Promise<ButterTransactionResponse>;
    gasEstimateBridgeToken({ fromAddress, fromToken, toChainId, toAddress, amount, options, }: BridgeRequestParam): Promise<string>;
}