Interface TokenWithChainDetails

General Token Interface

interface TokenWithChainDetails {
    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;
    transferTime: TransferTime;
    txCostAmount: TxCostAmount;
    xReserve?: XReserveTokenInfo;
    yieldAddress?: string;
    yieldId?: number;
}

Hierarchy (View Summary)

  • Token
  • Omit<ChainDetails, "name">

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 transferTime txCostAmount xReserve? yieldAddress? yieldId?

Properties

OptionalabrPayer

abrPayer?: AbrPayerChainInfo

ABR payer chain info

allbridgeChainId

allbridgeChainId: number

Allbridge's Id

apr

apr: string

Deprecated

use apr7d
Token APR

apr30d

apr30d: string

Token APR based on last 30 days

apr7d

apr7d: string

Token APR based on last 7 days

bridgeAddress

bridgeAddress: string

Bridge contract address

OptionalbridgeId

bridgeId?: string

Algo Bridge appId

OptionalcctpAddress

cctpAddress?: string

Token CCTP address
Optional. Defined if the token is supported by CCTP

OptionalcctpFeeShare

cctpFeeShare?: string

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

OptionalcctpV2Address

cctpV2Address?: string

Token CCTP address
Optional. Defined if the token is supported by CCTP

OptionalcctpV2FeeShare

cctpV2FeeShare?: string

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

OptionalchainId

chainId?: string

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

chainName

chainName: string

Blockchain network name

chainSymbol

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: ChainType

Blockchain type. For more details, see: ChainType.

confirmations

confirmations: number

Number of confirmations required

decimals

decimals: number

Token decimals

feeShare

feeShare: string

Token fee share

lpRate

lpRate: string

Token LP rate

name

name: string

Token name

OptionaloftBridgeAddress

oftBridgeAddress?: string

OFT Bridge contract address Optional. Defined if the chain supports OFT

OptionaloftId

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 OFT

OptionaloriginTokenAddress

originTokenAddress?: string

Token origin address

OptionalpaddingUtilId

paddingUtilId?: string

Algo Padding appId

poolAddress

poolAddress: string

Token pool address

OptionalsuiAddresses

suiAddresses?: SuiAddresses

Sui addresses Optional. Defined for SUI

symbol

symbol: string

Token symbol

tokenAddress

tokenAddress: string

Token address

transferTime

transferTime: TransferTime

Average transfer time to other blockchains

txCostAmount

txCostAmount: TxCostAmount

Transfers costs

OptionalxReserve

xReserve?: XReserveTokenInfo

XReserve bridge configuration for token. Optional. Defined if the token is supported by XReserve

OptionalyieldAddress

yieldAddress?: string

Yield contract address

OptionalyieldId

yieldId?: number

Settings

Member Visibility

On This Page

Properties