mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-20 21:38:26 +00:00

History

matejcik ff6bf906d0 chore(common): sync builtin definitions with the external repo		2023-04-06 15:55:26 +02:00
..
bitcoin
ethereum	chore(common): sync builtin definitions with the external repo	2023-04-06 15:55:26 +02:00
fido	feat(core): Introduce use_compact option for FIDO2.	2023-04-05 15:49:27 +02:00
misc	chore: Cardano preview testnet	2023-01-09 13:58:11 +01:00
nem
blockchain_link.json
coins_details.json	chore(common): update chains and tokens	2023-02-28 14:46:34 +01:00
duplicity_overrides.json	fix(common): deal with duplicity code leftovers	2023-03-24 13:24:46 +01:00
README.md	fix(common): deal with duplicity code leftovers	2023-03-24 13:24:46 +01:00
support.json	chore(common): sync builtin definitions with the external repo	2023-04-06 15:55:26 +02:00
wallets.json	feat(common): switch to external Ethereum definitions, add generators	2023-03-24 13:24:46 +01:00

README.md

Coin and FIDO Definitions

This directory hosts JSON definitions of recognized coins, tokens, and FIDO/U2F apps.

FIDO

The fido/ subdirectory contains definitons of apps whose logos and names are shown on Trezor T screen for FIDO/U2F authentication.

Each app must have a single JSON file in the fido/ subdirectory. Every app must have its label set to the user-recognizable application name. The u2f field is a list of U2F origin hashes, and the webauthn field is a list of FIDO2/WebAuthn hostnames for the app. At least one must be present.

Each app can have an icon. If present, it must be a 128x128 pixels RGBA PNG of the same name as the corresponding JSON name. If the app does not have an icon, it must instead have a field no_icon set to true in the JSON.

Coins

We currently recognize five categories of coins.

`bitcoin`

The bitcoin/ subdirectory contains definitions for Bitcoin and altcoins based on Bitcoin code.

Each Bitcoin-like coin must have a single JSON file in the bitcoin/ subdirectory, and a corresponding PNG image with the same name. The PNG must be 96x96 pixels and the picture must be a circle suitable for displaying on Trezor T.

Testnet is considered a separate coin, so it must have its own JSON and icon.

We will not support coins that have address_type 0, i.e., same as Bitcoin.

`eth` and `erc20`

Definitions for Ethereum chains (networks) and tokens (erc20) are split in two parts:

built-in definitions - some of the chain and token definitions are built into the firmware image. List of built-in chains is stored in ethereum/networks.json and tokens in ethereum/tokens.json.
external definitions - dynamically generated from multiple sources. Whole process is described in separate document.

We generally do not accept updates to the built-in definitions. Instead, make sure your network or token is included in the external definitions. A good place to start is the ethereum-lists GitHub organization: add your token to the tokens repository, or your EVM chain to the chains repository.

`nem`

The file nem/nem_mosaics.json describes NEM mosaics.

`misc`

Supported coins that are not derived from Bitcoin, Ethereum or NEM are currently grouped and listed in separate file misc/misc.json. Each coin must also have an icon in misc/<short>.png, where short is lowercased shortcut field from the JSON.

Keys

Throughout the system, coins are identified by a key - a colon-separated string generated from the coin's type and shortcut:

for Bitcoin-likes, key is bitcoin:<shortcut>
for Ethereum networks, key is eth:<shortcut>:<chain_id>
for ERC20 tokens, key is erc20:<chain_symbol>:<token_shortcut>
for NEM mosaic, key is nem:<shortcut>
for others, key is misc:<shortcut>

If a token shortcut has a suffix, such as CAT (BlockCat), the whole thing is part of the key (so the key is erc20:eth:CAT (BlockCat)).

Duplicate keys are not allowed and coins that would result in duplicate keys cannot be added to the dataset.

Wallet URLs

If you want to add a wallet link, modify the file wallets.json.

Support Information

We keep track of support status of each built-in coin over our devices. That is trezor1 for Trezor One, trezor2 for Trezor T, connect for Connect and suite for Trezor Suite. In further description, the word "device" applies to Connect and Suite as well.

This information is stored in support.json. External contributors should not touch this file unless asked to.

Each coin on each device can be in one of four support states:

supported explicitly: coin's key is listed in the device's supported dictionary. If it's a Trezor device, it contains the firmware version from which it is supported. For connect and suite, the value is simply true.
unsupported explicitly: coin's key is listed in the device's unsupported dictionary. The value is a string with reason for not supporting. For connect and suite, if the key is not listed at all, it is also considered unsupported. ERC20 tokens detected as duplicates are also considered unsupported.
unknown: coin's key is not listed at all.

Supported coins are used in code generation (i.e., included in built firmware). Unsupported and unknown coins are excluded from code generation.

You can edit support.json manually, but it is usually better to use the support.py tool. See tools docs for details.