Skip to content

add.md

Latest commit

 

History

History
76 lines (52 loc) · 3.65 KB

add.md

File metadata and controls

76 lines (52 loc) · 3.65 KB
Raw

wallet-cli token add

Add a token to the address book, fetching its metadata from the chain.

Synopsis

wallet-cli token add (--contract <address> | --asset-id <id>) [options]

Description

Fetches the token's name, symbol and decimals from the chain and adds it to the local token address book. Works on both TRON (TRC20/TRC10) and EVM (ERC20) networks. The book is scoped to network + account: a token added on tron:3448148188 for one account does not appear for other networks or accounts.

Once added, the token can be used by symbol elsewhere — e.g. tx send --token USDT. The book has two layers: official (bundled, read-only) and user (the ones you add). If the token is already bundled in the official layer, it fails with token_already_listed (no need to add it again); if you have already added it before, adding it again does not error — it re-fetches the token's metadata (symbol/decimals/name) and updates it, returning action: refreshed.

EVM contract addresses are stored and returned in checksum form. Address comparison ignores case, so adding the same user token with different casing refreshes its existing entry. TRON token names are returned as text, including names that resemble hexadecimal strings.

Options

Option Description
--contract <string> Token contract address — TRC20 on TRON, ERC20 on EVM; exactly one of --contract / --asset-id
--asset-id <string> TRON only. TRC10 numeric asset id; exactly one of --asset-id / --contract

--asset-id is a TRON-only flag: help tags it (TRON only), and passing it on an EVM network fails with invalid_option before any node call.

Plus the global options.

Examples

wallet-cli token add --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --network nile
✅ Added to token book
  Name      Tether USD
  Symbol    USDT
  Decimals  6
wallet-cli token add --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --network nile -o json
{"schema":"wallet-cli.result.v1","success":true,"command":"token.add","data":{"network":"tron:3448148188","account":"wlt_b2.0","action":"added","token":{"kind":"trc20","id":"TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf","symbol":"USDT","decimals":6,"name":"Tether USD"}},"meta":{"durationMs":15,"warnings":[]},"chain":{"family":"tron","network":"tron:3448148188","chainId":"3448148188"}}

An ERC20 token on an EVM network, where token.kind is erc20:

wallet-cli token add --contract 0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238 --network sepolia

Output

Field Type Meaning
network string Network the entry is scoped to
account string Account the entry is scoped to
action string "added" (first time) / "refreshed" (already in user layer, metadata refreshed)
token.kind string trc20 / trc10 (TRON) or erc20 (EVM)
token.id string Contract address, or TRC10 asset id
token.symbol string Fetched symbol
token.decimals number Fetched decimals
token.name string Fetched name

Exit status

0 added · 1 execution failure (token_metadata_unavailable — metadata could not be fetched, nothing is stored; encoding_error / io_error — the local token book could not be decoded or written) · 2 usage error (token_already_listed — already in the official layer; invalid_value; invalid_option — missing or conflicting selectors on TRON, or --asset-id on an EVM network; missing_option — a missing --contract on EVM).

See also

token list · token remove · tx send