From d52fb9779fa8f00f2254f37d414d6f5ca664b6a6 Mon Sep 17 00:00:00 2001 From: Kirill Date: Tue, 11 Jan 2022 02:17:07 +0000 Subject: [PATCH] Update README: other bridges rules and misc. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c261859..4ecd578 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,11 @@ To add a new asset, please follow these steps: * `name`: the human-readable name of the token. Must match the `name` of your ERC-20 token. * `symbol`: the abbreviation, like USDT or BTC. Must match the `symbol` of your ERC-20 token. * `decimals`: used in frontends to show the proper significant digits of a token. This concept is explained well in this [OpenZeppelin post](https://docs.openzeppelin.com/contracts/3.x/erc20#a-note-on-decimals). Must match the `decimals` of your ERC-20 token. + * [OPTIONAL] `near_address`: if your token has a NEAR address (native NEAR or bridged via RainbowBridge), make sure to fill this field * [OPTIONAL] `icon`: a small image associated with this token. Must be a [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs), to help consumers display it quickly while protecting user data. Recommendation: use [optimized SVG](https://codepen.io/tigt/post/optimizing-svgs-in-data-uris), which can result in high-resolution images having small bytes size. Recommendation: create icons that will work well with both light-mode and dark-mode websites by either using middle-tone color schemes, or by [embedding media queries in the SVG](https://timkadlec.com/2013/04/media-queries-within-svg/). If you don't fill this field, we will use your `.svg` icon to fill this field by ourselves. * [OPTIONAL] `reference`: a link to a valid JSON file containing various keys offering supplementary details on the token. Example: "/ipfs/QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm", "https://example.com/token.json", etc. If the information given in this document conflicts with the on-chain attributes, the values in reference shall be considered the source of truth. If you don't fill this field, please leave it empty and this field will be empty for your NEP-141 token. * [OPTIONAL] `reference_hash`: the base64-encoded sha256 hash of the JSON file contained in the reference field. This is to guard against off-chain tampering. If you don't fill this field, please leave it empty and this field will be empty for your NEP-141 token. + * [OPTIONAL] `bridge": If your asset is being bridged not via Rainbow Bridge but using some other bridge, make sure to fill this field with the name of the used bridge (e.g. for the Allbridge tokens it will be "Allbridge") 4. Fire a pull request having the following name: "Add metadata" (e.g. "Add USDT metadata") having the previously mentioned files (JSON and SVG) in PR and having the content following the template: @@ -34,8 +36,10 @@ To add a new asset, please follow these steps: ERC-20: https://etherscan.io/address/0xdac17f958d2ee523a2206206994597c13d831ec7 NEP-141: https://explorer.mainnet.near.org/accounts/dac17f958d2ee523a2206206994597c13d831ec7.factory.bridge.near + Aurora ERC-20: https://explorer.mainnet.aurora.dev/address/0x4988a896b1227218e4A686fdE5EabdcAbd91571f ``` 5. Aurora team will review your PR and update the metadata of your token. Always check the deployment status [here](https://rainbowbridge.app/deploy) (contract addresses, on-chain metadata, and storage registration when bridging to Aurora ) +6. If your asset is being bridged not via Rainbow Bridge but using some other bridge, make sure to also add an abbreviation of the bridge to JSON and SVG files as a prefix. E.g. if you used Allbridge for USDT token, the file names should be `abr_usdt.json` and `abr_usdt.svg` respectively. ## Adding a new asset (Testnet) In case you want to add your Testnet token as well, please use the same procedure describe above, but use your `symbol` of ERC-20 and `_testnet` suffix within the file name. E.g.: `usdt_testnet.json`, `usdt_testnet.svg`.