/assets

Primary LanguageJavaScriptMIT LicenseMIT

Trust Wallet Assets Info

Overview

Hello and welcome to Trust Wallet assets info contribution guide. We appreciate your effort to open-source. Token repository https://github.com/trustwallet/assets (repo) is a source of images used by Trust Wallet including:

  1. ERC20 tokens on Ethereum compatible networks supported by Trust Wallet such as:

  1. BEP2 Binance DEX token (native marketplace on Binance Chain)

  2. TRC10, TRC20 tokens on TRON blockchain

  3. coins integrated in Wallet Core

  4. dApp images available in Browser section in Trust Wallet and at https://dapps.trustwallet.com and bookmarks icons. read requirments

  5. Staking validators info avalible on Trust Wallet Staking Platform

  6. Coming soon: token info, token price, blacklisted and whitelisted tokens (mostly scam/spam ones)

Contribution steps

  1. Prepare image requirements
  2. Get familiar with folder strcture, will give you understanding where asset image should be placed
  3. Add asset guide

Image Requirements

  • file extension: png. Uppercase PNG considered invalid.
  • name：file name requirements for: logo.png name, but folder naming where they placed is most important part of contribution
  • size: 256px by 256px
  • background: preferably transparent
  • use simple drag and drop online service tinypng to optimize image size

dApp image naming requirments

Repository structure

blockchains folder contains many subfolders and represents chains e.g. ethereum, binance ...

assets folder contains token folders named by smart contract address in lowercase register and inside of it logo.png - image representation

info folder contains for now only logo.png that represents coin image

.
├── blockchains
│   └──ethereum
│   │   └──assets
│   │   │  └──0x0a2d9370cf74da3fd3df5d764e394ca8205c50b6 // address folder
│   │   │     └──logo.png // address logo
│   │   └──info
│   │      └──logo.png // coin logo
|   |
|   └──binance
│   │   └──assets
│   │   │  └──one-5f9
│   │   │     └──logo.png
│   │   └──info
│   │      └──logo.png
|   └──tron
│   |  └──assets
│   |  │  └──1002000
│   |  │  |   └──logo.png
|   |  |  └──tgbhcodq1jrwb3zywmfwsrth4rwbil2mzh
|   |  |      └──logo.png
|   |  | 
│   |  └──info
│   |     └──logo.png
|   |
|   └──cosmos
│   │   └──info
|   |   |  └──logo.png
|   |   |
│   │   └──validators
│   │   |  └──assets
|   |   |     └──cosmosvaloper1clpqr4nrk4khgkxj78fcwwh6dl3uw4epsluffn
|   |   |        └──logo.png
|   |   |
|   |   └──list.json
├── ...

Common uploads

Uploading:

  1. Ethereum ERC20 token folder
  2. Binance DEX BEP2 token token folder
  3. TRON TRC10 token token folder
  4. Add Cosmos validator info and image
  5. Add Tezos validator info and image

How To Add Asset

Process adding new tokens may look complicated at first glance, but once you completed it will be way easier do it next time:

Easy way

  1. Follow image requirements
  2. Proceed to https://github.com/trustwallet/assets
  3. Press on Fork in the top right corner, wait for process to complete
  4. Navigate to desire chain folder you want to add asset
  5. Prepare folder with image on your computer
  6. Simply drag and drop folder from step 5 to active window
  7. 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 nam
  1. Click on Propose changes
  2. Press on Create pull request
  3. Once tests have completed and verified that your image follows all requirements, a maintainer will merge it. In 5-10 minutes your token will have the updated image instead of plain logo in Trust Wallet

Easy way for Git user

  1. Fork the repo to your own github account
  2. Clone fork and create new branch:
git clone git@github.com:YOUR_HANDLE/assets.git
cd tokens
git branch <branch_name>
git checkout <branch_name>
  1. Add asset to appropriate directory, here folder strcture to 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 PR

FAQ

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 7 days. In order to see changes immediately, reinstall Trust Wallet. But as always, make sure you have a backup of all your wallets.

How to use it? (For Developers)

Base URL for token image:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/<contract_address_lowercase>/logo.png

Base URL for coin image:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/<coin_name_lowercase>/info/logo.png

Examples:

Coin logo, e.g Bitcoin:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/bitcoin/info/logo.png

ERC20:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0x006bea43baa3f7a6f765f14f10a1a1b08334ef45/logo.png

BEP-2:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/binance/assets/ankr-e97/logo.png

TRC-10:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/tron/assets/1002000/logo.png

TRC-20:

https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/tron/assets/tg37muxruah1e8dwsrrmoq79bnzn1yhztb/logo.png

Used in Applications