Interface TransferParams

High-level transfer parameters using chain/token symbols

interface TransferParams {
    amount: bigint;
    fallbackRecipient?: string;
    from: "dymension" | "ethereum" | "base" | "bsc" | "solana" | "kaspa";
    recipient: string;
    rpcUrl?: string;
    sender: string;
    to: "dymension" | "ethereum" | "base" | "bsc" | "solana" | "kaspa";
    token: "KAS" | "ETH" | "DYM" | "SOL";
}

Properties

amount fallbackRecipient? from recipient rpcUrl? sender to token

Properties

amount

amount: bigint

Amount in token's smallest unit (e.g., wei for ETH)

OptionalfallbackRecipient

fallbackRecipient?: string

Fallback recipient on Hub if forwarding fails (defaults to sender's Hub address equivalent)

from

from: "dymension" | "ethereum" | "base" | "bsc" | "solana" | "kaspa"

Source chain name

recipient

recipient: string

Recipient address on destination chain

OptionalrpcUrl

rpcUrl?: string

Optional RPC URL for source chain

sender

sender: string

Sender address on source chain

to

to: "dymension" | "ethereum" | "base" | "bsc" | "solana" | "kaspa"

Destination chain name

token

token: "KAS" | "ETH" | "DYM" | "SOL"

Token symbol (e.g., 'KAS', 'ETH', 'DYM')

Settings

Member Visibility

On This Page

Properties