Currently, we use two files for data:
And an index.js file for easier usage of coins-registry in other projects. Through the interface, it is easy to get tokens or pools lists for the selected chain type. It provides two methods:
getPoolsFor. Each of these methods requires the network type as an argument. Possible values for network types:
There is a coins list in coins.json. One coin can be presented as follows:
"name": "Aptos Coin",
source- enum data type with strict value check. If you’d like to add the new value into it, fill the form. Usually source is the name of a partner's company to add many coins into the list. We support now following sources:
aptos- for the native Aptos Coin.
partners- for other tokens.
celer- for tokens provided by Celer.
layerzero- for tokens provided by Layer Zero.
wormhole- for tokens provided by Wormhole.
name- tokens' full name. We update this value by a request to the node. It is used on Picture 1 as a bottom string after the dot (on the picture it is Bitcoin).
chainId- for mainnet value is 1. Currently, testnet tokens stored in the
testnetbranch of this repo.
decimals- decimals how supported by your token. We update this value by a request to the node.
symbol- it is used to construct a token alias, which can be equal to symbol as on Picture 1 in the top string.
type- full type of token. String with following structure ADDRESS::MODULE::COIN, e.g.
caution- if we need to show warning icon near the token - we will add the caution field.
order- order of a token in the tokens list. Current logic:
60 BUSD / BNB
1000 other tokens
coinX- a full type of coin. String with the following structure ADDRESS::MODULE::COIN, e.g.
coinY- a full type of coin. String with the following structure ADDRESS::MODULE::COIN, e.g.
⚠️ Coins should be sorted.
curve- to strictly point curve type use the following values:
- selectable - will keep a switcher for a curve type available for declared coins pair.
- uncorrelated - keep only an uncorrelated curve pool on UI.
- stable - keep only a stable curve pool on UI.