Skip to content
This repository has been archived by the owner on May 20, 2024. It is now read-only.

Revert "Update README.md (#52)" #120

Draft
wants to merge 10 commits into
base: update-readme-for-new-token-pairs
Choose a base branch
from
Draft
Prev Previous commit
Revert "Update README.md (#52)"
This reverts commit 9294709.
  • Loading branch information
walker112171 authored Aug 25, 2023
commit ff529c51c459b33e2785ed9a211338c2ab6e442f
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,31 @@

This is a community-sourced token list used to power the [Verse DEX](https://verse.bitcoin.com/).

If you wish to add an SEP-20 or ERC-20 token / liquidity pool to the Verse DEX, follow the instructions below:

# How to add your token / liquidity pool to [verse.bitcoin.com](https://verse.bitcoin.com)
1. Open a pull request on this repo ([example](https://github.com/bitcoin-portal/verse-dex-tokens/pull/2)) containing the following:
- Add your token config to [tokens.json](https://github.com/bitcoin-portal/verse-dex-tokens/blob/trunk/config/tokens.json). Include any liquidity pairs you'd like to list under `pairs` e.g. :
```javascript
{
"abbr": "JOY", // token symbol
"value": "JOY", // same as abbr
"abbr": "FLEX", // token symbol
"value": "FLEX", // same as abbr
"protocol": "SEP20_PROTOCOL",
"blockchain": "BCH",
"label": "JOY", // token display name
"ticker": "joy",
"label": "FLEX", // token display name
"ticker": "flex",
"explorer": "https://www.smartscan.cash/tx/",
"token": "0x6732E55Ac3ECa734F54C26Bd8DF4eED52Fb79a6E", // token contract address
"token": "0x98Dd7eC28FB43b3C4c770AE532417015fa939Dd3", // token contract address
"decimals": 18,
"pairs": ["BCH", "TANGO"] // this will add JOY/BCH and JOY/TANGO to the list of liquidity pools
"pairs": ["BCH", "flexUSD"] // this will add FLEX/BCH and FLEX/flexUSD to the list of liquidity pools
}
```
- A 64x64 png of the token icon to the /icons directory
- A wallet address from which you will provide the initial liquidity for the pool

2. Our team will review your PR and merge it. You will then be able to view and add initial liquidity to the new pools on the Verse DEX using your provided wallet address.

## Syntax for token pairs ##
- Bitcoin Cash: "BCH"
- flexUSD: "flexUSD"
- Flex: "FLEX"
- Joystick: "JOY"
- TANGO: "TANGO"
- LAW: "LAW"
Expand Down