Instadapp/trustwallet-assets
1
0
Fork 0
mirror of https://github.com/Instadapp/trustwallet-assets.git synced 2024-07-29 22:37:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed various typos/mistakes. Fixed links. (#1576)

Browse Source 
* Fixed various typos/mistakes. Fixed links.

* Fixed grammar mistake
This commit is contained in:
Philipp Pendelin 2020-03-27 05:27:51 +01:00 committed by GitHub
parent 63e16f74ac
commit 0b74589267
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -22,7 +22,7 @@ Token repository [https://github.com/trustwallet/assets](https://github.com/trus
4. [coins](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) integrated in [Wallet Core](https://developer.trustwallet.com/wallet-core)
5. dApp images available in `Browser` section in Trust Wallet and at https://dapps.trustwallet.com and bookmarks icons. [read requirments](#dApp-image-naming-requirments). Also you can submit dApp to our list [read more](#dApp-subbmition-and-listing-requirements)
5. dApp images available in `Browser` section in Trust Wallet and at https://dapps.trustwallet.com and bookmarks icons. [read requirements](#dApp-image-naming-requirements). Also you can submit dApp to our list [read more](#dApp-subbmition-and-listing-requirements)
6. Staking validators info, such as name, image, validator id, website url. [Supported staking coins](https://trustwallet.com/staking/). [Read requirements](#Staking-validators-requirements)
@ -41,40 +41,40 @@ Token repository [https://github.com/trustwallet/assets](https://github.com/trus
### Add new asset
1. Prepare asset, look at [image requirements](#image-requirements), [dapp requirements](#dApp-image-naming-requirments)
2. Get familiar with [folder strcture](#repository-structure), will give you understanding where asset should be placed
2. Get familiar with our [folder strcture](#repository-structure), it will give you an understanding where assets should be placed
3. [Add asset guide](#how-to-add-asset)
### Update and remove existing asset
### Update and remove an existing asset
Whenever you updating or deleting asset on behalf of asset owner or just found outdated information, please provide link to the source saying about changes. That will help to speed up review process.
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 helpwull if you want to:
1. Update information about smart contract
This instruction wil be helpfull if you want to:
1. Update information about the smart contract
2. (Depreate)[#What-is-smart-contract-deprication] or update contract address
Smart contract address update procedure:
1. Rename old contract address in coreponding coin folder to new contract e.g:
1. Rename old contract address in coresponding coin folder to new contract e.g.:
1. Remove smart contract e.g:
1. Remove smart contract e.g.:
```bash
`rm -r ./blockchains/<COIN>/assets/<OLD_CONTRACT_ADDRESS>/`
`rm -r ./blockchains/ethereum/assets/0x19fFfd124CD9089E21026d10dA97f8cD6B442Bff/`
```
2. Commit changes and make PR
2. Commit changes and make a PR (pull request)
## Image Requirements
- file extension: `png`. Uppercase `PNG` considered invalid
- file extension: `png`. Uppercase `PNG` is considered as invalid
- name：file name requirements for: `logo.png` name, but [folder naming](#repository-structure) where they placed is most important part of contribution
- size: `256px by 256px` or `512px by 512px`
- background: preferably transparent
- use simple drag and drop online service [tinypng](https://tinypng.com/) to optimize image size
## dApp image naming requirments
## dApp image naming requirements
- [Folder for upload](https://github.com/trustwallet/assets/tree/master/dapps)
- `<subdomain>.<domain_name>.png` e.g:
https://app.compound.finance/ => `app.compound.finance.png`
@ -93,9 +93,9 @@ Smart contract address update procedure:
`blockchains` folder contains many subfolders and represents chains e.g. `ethereum`, `binance` ...
`assets` folder contains token folders named by smart contract address in `checksum address` for Ethreum like networks and inside of it `logo.png` - image representation. Note: Lowercased or uppercased contract addresses considered invalid. You can find checksum address by searching on [ etherscan.io](https://etherscan.io), for example stablecoin [DAI](https://etherscan.io/address/0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359) checksum address located at the top left corner of the page and has both uppercase and lowercase characters. Or [convert Ethereum address to Checksum address](https://piyolab.github.io/sushiether/RunScrapboxCode/?web3=1.0.0-beta.33&code=https://scrapbox.io/api/code/sushiether/web3.js_-_Ethereum_%E3%81%AE%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%82%B5%E3%83%A0%E4%BB%98%E3%81%8D%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9%E3%81%AB%E5%A4%89%E6%8F%9B%E3%81%99%E3%82%8B/demo.js). For other networks address must be specified as it was originated on a chain, e.g TRON TRC10: `1002000`, TRON TRC20: `TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t` etc ...
`assets` folder contains token folders named by smart contract address in `checksum address` for Ethereum like networks and inside of it `logo.png` - image representation. Note: Lowercase or uppercase contract addresses are considered as invalid. You can find the checksum address by searching on [ etherscan.io](https://etherscan.io), for example stablecoin [DAI](https://etherscan.io/address/0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359) 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](https://piyolab.github.io/sushiether/RunScrapboxCode/?web3=1.0.0-beta.33&code=https://scrapbox.io/api/code/sushiether/web3.js_-_Ethereum_%E3%81%AE%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%82%B5%E3%83%A0%E4%BB%98%E3%81%8D%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9%E3%81%AB%E5%A4%89%E6%8F%9B%E3%81%99%E3%82%8B/demo.js). For other networks the address must be specified as it was originated on the chain, e.g TRON TRC10: `1002000`, TRON TRC20: `TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t` etc ...
`info` folder contains for now only `logo.png` that represents coin image
`info` folder contains for now only `logo.png` that represents the coin image
`validators` folder contains folders: `assets` same structure as above and `list.json` information about validators.
@ -173,10 +173,10 @@ Process adding new tokens may look complicated at first glance, but once you com
- optional: adjust fork branch nam
9. Click on `Propose changes`
10. Press on `Create pull request`
13. 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
13. 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. For more information see [FAQ](#faq).
### Easy way for Git user
1. Fork the repo to your own github account
### Easy way for Git users
1. Fork the repository to your own GitHub account
2. Clone fork and create new branch:
```bash
git clone git@github.com:YOUR_HANDLE/assets.git
@ -184,24 +184,24 @@ cd tokens
git branch <branch_name>
git checkout <branch_name>
```
3. Add asset to appropriate directory, here [folder strcture](#repository-structure) to help you
3. Add asset to appropriate directory, the [folder strcture](#repository-structure) documentation will help you
4. Commit and push to your fork
```bash
git add -A
git commit -m “Add <token_name>”
git push origin <branch_name>
```
5. From your repo clone page make PR
5. From your repo clone page make a new PR (pull request)
## FAQ
### Why do I still see old logo in Trust Wallet after uploaded new one
### 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.
### Why i don't see my token in search after PR was merged ?
### Why i don't see my token in search after PR was merged?
After PR was merged, set of cron workers will update token status normally with in 10 minutes and sometimes up to 30 minutes and token became visible in search result.
### What is smart contract deprication (removal)
### What is smart contract deprication (removal)?
A process of removing smart contract information such as (token logo and info) from this repository.
Removed contract address will be added to the blacklist and, as a result, will no longer be present in token search results inside the TW app.
Why would you want to do this ?.