Skip to main content
Version: 1.17.0

Type Alias: TokenInfo

TokenInfo = { decimals: number; name?: string; symbol: string; uiMultiplier?: TokenUIMultiplier; }

Defined in: chain.ts:461

Token metadata information.

Properties​

decimals​

readonly decimals: number

Defined in: chain.ts:465

Number of decimals for the token.


name?​

readonly optional name?: string

Defined in: chain.ts:467

Optional human-readable token name.


symbol​

readonly symbol: string

Defined in: chain.ts:463

Token symbol (e.g., "LINK").


uiMultiplier?​

readonly optional uiMultiplier?: TokenUIMultiplier

Defined in: chain.ts:475

The token's UI multiplier, present only when the token supports ERC-8056 (Scaled UI Amount, e.g. tokenized equities after a stock split). Read fresh on every call. Convert amounts with toUIAmount and fromUIAmount; transfers, fees and rate limits stay in raw units. CCIP does not synchronize multipliers between chains: convert an amount with the multiplier of the token on the chain that holds it (e.g. the destination token for a received amount).