Assets

Overview

The Trust Wallet Token Repository https://github.com/trustwallet/assets is a comprehensive, up-to-date collection of information about several thousands (!) of crypto tokens. Trust Wallet uses token logos from this source, alongside a number of other projects.

The repository contains token info from several blockchains, info on dApps, staking validators, etc. For every token a logo and optional additional information is available (such data is not available on-chain).

Such a large collection can be maintained only through a community effort, so additions are welcome, primarily from token projects.

Please note that new tokens are not accepted, the projects have to be sound, with information available, and non-minimal circulation (for limit details see https://community.trustwallet.com/t/how-to-submit-a-token-logo/3863#how-to-get-approved).

Contribution Quick Start

Details of the repository structure and contribution guidelines are listed below. Here is a quick starter summary for the most common use case.

For adding an ERC20 token:

  • fork the Github repository

  • prepare a logo file, according to the rules below, but must importantly: PNG format, max. pixel size of 512x512 and max. file size of 100kB.

  • add/upload the logo file named logo.png to the folder blockchains/ethereum/assets/<contract>,

    where the last part is the token contract address in checksum format, such as

    blockchains/ethereum/assets/0x1234567461d3f8Db7496581774Bd869C83D51c93/logo.png.

  • Create a PR to the main repo

  • Pay the processing fee

Repository Details

Collections

The token repository contains the following collections:

  1. BEP2 BEP8 Binance DEX tokens (native marketplace on Binance Chain)

  2. TRC10, TRC20 tokens on TRON blockchain

  3. dApp images available in Browser section in Trust Wallet, and bookmarks icons. Read requirements. Also you can submit dApp to our list read more.

  4. Staking validators info, such as name, image, validator id, website url. Supported staking coins. Read requirements.

  5. Crypto price providers map: CoinMarketCap

  6. Token and coin info

  7. Smart contract deprecation/upgrade. Read more.

Repository structure

The blockchains folder contains several subfolders corresponding to blockchain networks, such as ethereum, binance, etc.

The assets subfolder contains token folders named by smart contract address, in checksum format for Ethereum like networks. This folder should contain the logo.png image file.

For other networks the address must be specified as it was originated on the chain, e.g TRON TRC10: 1002000, TRON TRC20: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t etc.

The info folder contains a logo.png that represents the coin image.

The validators folder contains folders: assets same structure as above and list.json information about validators.

The denylist.json and allowlist.json, present in some chain folders like ethereum and binance, contain list of approved tokens and banned tokens. Trust Wallet will never show denylisted tokens, and only allowlisted tokens are shown in the token search results.

Checksum format

For Ethereum like networks, contract folders must be named according to the so-called Checksum Format, with mixed lowercase and uppercase letters, such as 0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359. Non-checksum addresses (e.g. all lowercase) are considered invalid.

You can find the checksum address by searching on etherscan.io, for example stablecoin DAI the checksum address is located at the top left corner of the page and has both uppercase and lowercase characters. Or convert Ethereum address to Checksum address.

Layout

.
├── blockchains
│ └──ethereum
│ │ └──assets
│ │ │ └──0x0a2D9370cF74Da3FD3dF5d764e394Ca8205C50B6 // address folder
│ │ │ └──logo.png // token logo
| | | └──info.json // optional token info
│ │ └──info
│ │ │ └──logo.png // chain coin logo
| | │ └──info.json // chain coin info
│ │ └──allowlist.json // list of accepted tokens
│ │ └──denylist.json // list of blocked tokens
| |
| └──binance
│ │ └──assets
│ │ │ └──ONE-5F9
│ │ │ └──logo.png
| | | └──info.json
│ │ └──info
│ │ └──logo.png
| └──tron
│ | └──assets
│ | │ └──1002000
│ | │ | └──logo.png
| | | | └──info.json
| | | └──TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
| | | └──logo.png
| | | └──info.json
| | |
│ | └──info
│ | └──logo.png
| | └──info.json
| |
| └──cosmos
│ │ └──info
| | | └──logo.png
| | | └──info.json
| | |
│ │ └──validators
│ │ | └──assets
| | | └──cosmosvaloper1clpqr4nrk4khgkxj78fcwwh6dl3uw4epsluffn
| | | └──logo.png
| | |
| | └──list.json
├── ...

Contribution Guidelines

Contribution Use Cases

Add new asset

  1. Prepare asset, look at image requirements, dapp requirements.

  2. Get familiar with our folder structure, it will give you an understanding where assets should be placed

  3. Pay the merge fee

Update and remove an existing asset

Whenever you updating or deleting an asset on behalf of the asset owner or just found outdated information, please provide a link to the source saying about changes. That will help to speed up the review process.

This instruction wil be helpfull if you want to:

  1. Update information about the smart contract

  2. Deprecate or update contract address

Smart contract address update procedure:

  1. Rename old contract address in coresponding coin folder to new contract e.g.:

  2. Remove smart contract e.g.:

`rm -r ./blockchains/<COIN>/assets/<OLD_CONTRACT_ADDRESS>/`
`rm -r ./blockchains/ethereum/assets/0x19fFfd124CD9089E21026d10dA97f8cD6B442Bff/`
  1. Commit changes and make a PR (pull request)

Image Requirements

  • File location: must be placed in the correct folder and subfolder within the folder structure.

  • File extension: png. Uppercase PNG is considered invalid.

  • File name:logo.png, all lowercase.

  • Dimension: 256 x 256 pixels or 512 x 512 pixels.

  • Background: preferably transparent (should fit dark mode as well; deny logos need light border/background).

  • File size: maximum 100kB. Tip: optimize image size, e.g. using simple drag-and-drop online service tinypng.

dApp image naming requirements

dApp submission and listing requirements

Staking validators requirements

  1. Add validator basic information to the bottom of the list, see example for: Kava, Cosmos, Tezos, Tron, Solana, Harmony

  2. Add validator logo image to blockchains/<chain>/validators/assets/<validator_address>/logo.png see images requirements

  3. Check chain specific requirements.

Common uploads

Uploading: 1. Ethereum ERC20 token folder 2. Binance DEX BEP2, BEP8 token token folder 3. TRON TRC10, TRC20 token token folder 4. Add Cosmos validator image 5. Add Tezos validator info 6. Add Ethereum contract address to denylist 7. Add TRON TRC10 ID or TRC20 owner contract address to allowlist

How To Add Files

If you are not familiar with GitHub or Git, the process of adding new tokens may look complicated at first glance, but it consists of only a few steps, and is not very complicated.

Basics, Prerequisites

The assets repository is maintained in GitHub, the largest hosting for open source projects. You need a GitHub account to interact with it.

To do changes in the assets repository, you need to create a personal copy called a fork.

Once the changes are prepared inside the fork, you need to create a pull request to the main repository. Upon review the maintainers will accept your pull request, and the changes will be incorporated.

Adding files using GitHub web page

  1. Press on Fork in the top right corner, wait for process to complete.

    Note: if you already have a fork, it should be updated: easiest is to remove the fork and create it afresh.

  2. Navigate to desire chain folder you want to add asset

  3. Prepare on your local drive a folder corresponding to the token cortact.

  4. Copy the logo image as logo.png into the folder (and optional info file).

  5. Simply drag and drop the folder to active window

  6. In Commit changes box:

    • Add files via upload add meaningfull comment what you adding to the repo

    • optional: In Add an optional extended description write a comment about upload

    • optional: adjust fork branch name

  7. Click on Propose changes

  8. Press on Create pull request

Adding files using GitHub Desktop application

The steps are similar to using the web page, but the desktop app has more control for overwriting the files, branching, pushing.

Adding files using command-line

  1. Fork the repository to your own GitHub account

  2. Clone fork and create new branch:

git clone git@github.com:YOUR_HANDLE/assets.git
cd assets
git checkout -b <branch_name>
  1. Add asset to appropriate directory, the folder strcture documentation will help you

  2. Commit and push to your fork

git add -A
git commit -m “Add <token_name>
git push origin <branch_name>
  1. From your repo clone page make a new PR (pull request)

Fee

Due to an increasing number of pull request (and proportional checking & merging effort), a modest fee is required for processing a pull request, payable in cryptocurrency. Follow the instructions in the pull request for completing the fee payment.

See the fee FAQ

FAQ

Why is the build on my pull request red?

Contributions in a pull request are verified by an automated build. The checks fail if something is wrong, like to logo is too large or an Ethereum contract is not in checksum format. Checks the exact error message in the build to find out the problem.

Why is there a merge conflict in my pull request?

A merge conflict happens if the same file has been modified in the pull request, and also in the master branch since the fork was created. With assets repo, this typically caused by using a fork that was created long ago. The simplest solution in this case is to delete your pull request, delete your fork, create a new fork, and create a new PR. Alternatively, a merge conflict can be resolved using git command line, but Git skills are required. A pull request can also happen when overriding an existing logo.

Why I don't see my token in search after PR was merged?

After PR was merged, it may take some time, but not longer than one hour, until search will show the new logo.

Why do I still see old logo in Trust Wallet after uploaded new one?

Both clients, Android and iOS keep old image cache for up to a few days. In order to see changes immediately, reinstall Trust Wallet. But as always, make sure you have a backup of all your wallets.

What is smart contract deprecation?

A process of removing smart contract information such as (token logo and info) from this repository. Removed contract address will be added to the denylist and, as a result, will no longer be present in token search results inside the TW app. Why would you want to do this ?. You are contract owner or just good samaritan who noticed contract to be no longer "active" and was an upgrade and abandoned by owning organization, involved in a scam, mimicking by its name or/and symbol a real contract. All facts must be supported with a link to any resource proving these statements.

How to use it? (For Developers)

--> For developers

Used in Projects

  • 0x Tracker - The 0x Protocol Trade Explorer and news aggregator.

  • Uniswap - Uniswap is a protocol for automated token exchange on Ethereum.

  • LinkDrop - A customer acquisition platform for DApps. The easiest crypto onboarding.

  • Aragon − Aragon is platform and network for decentralized organizations.

  • SpiderDEX - Decentralized exchange for crypto collectibles.

  • Zerion — A simple interface to decentralized finance.

Disclaimer

Trust Wallet team allows anyone to submit new assets to this repository. However, this does not mean that we are in direct partnership with all of the projects.

Trust Wallet team will reject projects that are deemed as scam or fraudulent after careful review. Trust Wallet team reserves the right to change the terms of asset submissions at any time due to changing market conditions, risk of fraud, or any other factors we deem relevant.