Interface SwapParams

Required params to handle swap transfer (different tokens on the same chain)

interface SwapParams {
    amount: string;
    destinationToken: TokenWithChainDetails;
    fromAccountAddress: string;
    minimumReceiveAmount?: string;
    sourceToken: TokenWithChainDetails;
    toAccountAddress: string;
    txFeeParams?: TxFeeParams;
}

Hierarchy (View Summary)

BaseSendParams
- SwapParams

Index

Properties

amount destinationToken fromAccountAddress minimumReceiveAmount? sourceToken toAccountAddress txFeeParams?

Properties

amount

amount: string

The float amount of Total tokens to transfer.

In Send case If SendParams#gasFeePaymentMethod is FeePaymentMethod#WITH_STABLECOIN:
Includes gas fee
Includes extra gas

destinationToken

destinationToken: TokenWithChainDetails

The token info object on the destination chain.

fromAccountAddress

fromAccountAddress: string

The account address to transfer tokens from.

`Optional`minimumReceiveAmount

minimumReceiveAmount?: string

minimum amount to receive including possible slippage, see AllbridgeCoreSdk#getAmountToBeReceived

sourceToken

sourceToken: TokenWithChainDetails

The token info object on the source chain.

toAccountAddress

toAccountAddress: string

The account address to transfer tokens to.

`Optional`txFeeParams

txFeeParams?: TxFeeParams