Token

Domain model for an ERC-20 token.

Properties

address

address: `0x${string}`;

ERC-20 contract address. Casing follows the source that produced the token; compare addresses case-insensitively when joining across sources. Use this as the identifier when passing the token to other SDK calls (tokenAddress, collateralToken, creditedToken).

---

decimals

decimals: number;

Number of token decimals. Every bigint amount the SDK accepts or returns for this token is in smallest units, so display values are amount / 10 ** decimals (1 USDC = 1_000_000n).

---

metadata?

optional metadata?: TokenMetadata;

Off-chain display metadata (currently the logo URL). Present only when the SDK’s asset repository has an entry for this address; see TokenMetadata and buildTokenLogoUrl.

---

name

name: string;

Full token name (e.g. "USD Coin").

---

symbol

symbol: string;

Token ticker (e.g. "USDC").