@allbridge/bridge-core-sdk
    Preparing search index...

    Interface CYDToken

    General Token Interface

    interface CYDToken {
        abrPayer?: AbrPayerChainInfo;
        allbridgeChainId: number;
        apr: string;
        apr30d: string;
        apr7d: string;
        bridgeAddress: string;
        bridgeId?: string;
        cctpAddress?: string;
        cctpFeeShare?: string;
        cctpV2Address?: string;
        cctpV2FeeShare?: string;
        chainId?: string;
        chainName: string;
        chainSymbol: ChainSymbol;
        chainType: ChainType;
        confirmations: number;
        decimals: number;
        feeShare: string;
        lpRate: string;
        name: string;
        oftBridgeAddress?: string;
        oftId?: string;
        originTokenAddress?: string;
        paddingUtilId?: string;
        poolAddress: string;
        suiAddresses?: SuiAddresses;
        symbol: string;
        tokenAddress: string;
        tokens: TokenWithChainDetailsYield[];
        transferTime: TransferTime;
        txCostAmount: TxCostAmount;
        xReserve?: XReserveTokenInfo;
        yieldAddress: string;
        yieldId?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    abrPayer? allbridgeChainId apr apr30d apr7d bridgeAddress bridgeId? cctpAddress? cctpFeeShare? cctpV2Address? cctpV2FeeShare? chainId? chainName chainSymbol chainType confirmations decimals feeShare lpRate name oftBridgeAddress? oftId? originTokenAddress? paddingUtilId? poolAddress suiAddresses? symbol tokenAddress tokens transferTime txCostAmount xReserve? yieldAddress yieldId?

    Properties

    abrPayer?: AbrPayerChainInfo

    ABR payer chain info

    allbridgeChainId: number

    Allbridge's Id

    apr: string

    Token APR

    Do not use.

    apr30d: string

    Token APR based on last 30 days

    Do not use.

    apr7d: string

    Token APR based on last 7 days

    Do not use.

    bridgeAddress: string

    Bridge contract address

    Do not use.

    bridgeId?: string

    Algo Bridge appId

    cctpAddress?: string

    Token CCTP address (bridge contract to approve for Messenger.CCTP)
    Optional. Defined if the token is supported by CCTP

    cctpFeeShare?: string

    Token fee share for CCTP
    Optional. Defined if the token is supported by CCTP

    cctpV2Address?: string

    Token CCTP V2 address (bridge contract to approve for Messenger.CCTP_V2)
    Optional. Defined if the token is supported by CCTP V2

    cctpV2FeeShare?: string

    Token fee share for CCTP V2
    Optional. Defined if the token is supported by CCTP V2

    chainId?: string

    Common Blockchain Id
    A 0x-prefixed hexadecimal string
    Optional.

    chainName: string

    Blockchain network name

    chainSymbol: ChainSymbol

    The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: ChainSymbol.

    chainType: ChainType

    Blockchain type. For more details, see: ChainType.

    confirmations: number

    Number of confirmations required

    decimals: number

    Token decimals

    feeShare: string

    Token fee share

    Do not use.

    lpRate: string

    Token LP rate

    Do not use.

    name: string

    Token name

    oftBridgeAddress?: string

    OFT Bridge contract address (the contract to approve for Messenger.OFT) Optional. Defined if the chain supports OFT

    oftId?: string

    Internal identifier for the same token across different chains.

    Used to link representations of a token deployed on multiple networks (e.g., Ethereum, BSC). Tokens with the same oftId are considered to be equivalent.

    Optional. Defined if the token is supported by Messenger.OFT. The bridge contract to approve is ChainDetails.oftBridgeAddress.

    originTokenAddress?: string

    Token origin address

    paddingUtilId?: string

    Algo Padding appId

    poolAddress: string

    Token pool address

    Do not use.

    suiAddresses?: SuiAddresses

    Sui addresses Optional. Defined for SUI

    symbol: string

    Token symbol

    tokenAddress: string

    Token address

    tokens: TokenWithChainDetailsYield[]
    transferTime: TransferTime

    Average transfer time to other blockchains

    txCostAmount: TxCostAmount

    Transfers costs

    xReserve?: XReserveTokenInfo

    xReserve bridge configuration for token, see XReserveTokenInfo. Optional. Defined if the token is supported by Messenger.X_RESERVE

    yieldAddress: string

    Yield contract address

    yieldId?: number

    Settings

    Member Visibility

    On This Page

    Properties