pinkdiamond1 / coins-registry

Coins Registry for LiquidSwap

LiquidSwap Coin Registry

We are developing our own Coin Registry file format for LiquidSwap, which contains all the information about the pools in which tokens can be exchanged.

An example of a JSON file you can see here example.json

File description

Field	Description	Note
name	Preset name	string, required, example: Custom Preset
image	Preset image	string, example: https://example.com/images/my-preset.svg
version	Semver preset version	object, required.
version.major	Semver Major version	number, required, example: 1
version.minor	Semver Minor version	number, required, example: 0
version.patch	Semver Patch version	number, required, example: 0
tokens[]	A list of all tokens that are present in the pools	array, required.
tokens[].title	Fullname of the token	string, required, example: Ethereum
tokens[].chainId	Network ChainID	number, required, example: 97. Aptos Devnet - 97
tokens[].symbol	Native Token symbol	string, required, example: ETH. This is the symbol of the token, which is specified when deploying the contract
tokens[].alias	Visible Token symbol	string, example: WETH. This is the symbol of the token that will be visible to the user
tokens[].image	Token image	string, example: https://example.com/images/my-token.svg
tokens[].type	Aptos type	string, required, example: 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::CoinsExtended::ETH
pools[]	List of pools	array, required.
pools[].chainId	Network ChainID	number, required, example: 97. Aptos Devnet - 97
pools[].address	Pool owner (creator) address	string, required, example: 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318
pools[].module	Address of the module in which the pool is registered	string, required, example: 0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9. Only one module address is currently available
pools[].tokens[]	Token addresses used in the pool	array, required. The first two tokens should be sorted alphabetically according to their symbol from smallest to largest
pools[].tokens[][0]	First token	string, required, example: 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::CoinsExtended::ETH
pools[].tokens[][1]	Second token	string, required, example: 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::CoinsExtended::USDC
pools[].tokens[][2]	LP token	string, required, example: 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::LP::LP<0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::CoinsExtended::ETH, 0xb4d7b2466d211c1f4629e8340bb1a9e75e7f8fb38cc145c54c5c9f9d5017a318::CoinsExtended::USDC>

Contribution

You are welcome to fork the current repository and do an PR.

The current repository maintaining under MIT license.

License

MIT.