diff --git a/setup.md b/setup.md new file mode 100644 index 0000000..c1c746e --- /dev/null +++ b/setup.md @@ -0,0 +1,96 @@ +# How to add token pair +In this example we will add token pair `XTZ-QUIPU` for 2 exchanges `Vortex` and `QuipuSwap` + +We will need to add token (`QUIPU`) and token pair (`XTZ-QUIPU`) for each exchange (`Vortex` and `QuipuSwap`) + +We will need `config.json` file. If you don't have `config.json` file, create it with command `init` +``` +npx @stove-labs/arbitrage-bot-cli init +``` +Console output should look like this + +init setup command + +## Add token to `config.json` +Since we already have `XTZ` token in `config.json`, we will only need to add `QUIPU` token + +1. Go to [tzkt.io](tzkt.io) and type `QUIPU` into search bar and click on first result +tzkt.io search + +2. Go to `Tokens` and copy `address` and `decimals` +tzkt.io QUIPU + +3. Fill attributes: +- `ticker` (`QUIPU`) +- `address` (copied from [tzkt.io](tzkt.io)) +- `decimals` (copied from [tzkt.io](tzkt.io)) +- `ecosystemIdentifier` (always `TEZOS`) + + it should look like this: +``` +{ + "ticker": "QUIPU", + "address": "KT193D4vozYnhGJQVtw7CoxxqphqUEEwK6Vb", + "decimals": 6, + "ecosystemIdentifier": "TEZOS" +} +``` +and add it to the `tokenList` array + +## Add Vortex token pair to `config.json` + +1. Go to [Vortex analytics](https://app.vortex.network/charts/analytics) and pick your desired token pair, in our case its `XTZ-QUIPU` +Vortex analytics + +2. Copy the token pair pool `address` +Vortex analytics XTZ-QUIPU + +3. Fill attributes: +- `address` (copied from [Vortex](https://app.vortex.network/)) +- `identifier` (always `VORTEX`) +- `ticker1` (`XTZ`) +- `ticker2` (`QUIPU`) + + it should look like this: +``` +{ + "address": "KT1LErZ1878Kyq3xtSc5pwxzTrD7XSZoE2RY", + "identifier": "VORTEX", + "ticker1": "XTZ", + "ticker2": "QUIPU" +} +``` +and add it to the `vortex` array under `exchangeList` in `config.json` + +## Add Quipuswap token pair to `config.json` + +1. Go to the [Quipuswap analytics](https://analytics.quipuswap.com/pairs) and pick your desired token pair, in our case its `XTZ-QUIPU` +Quipuswap analytics + +2. Copy the token pair pool `address` +Quipuswap analytics XTZ-QUIPU + +3. Fill attributes: +- `address` (copied from [Quipuswap](https://analytics.quipuswap.com/pairs)) +- `identifier` (always `QUIPUSWAP`) +- `ticker1` (`XTZ`) +- `ticker2` (`QUIPU`) + + it should look like this: +``` +{ + "address": "KT1X3zxdTzPB9DgVzA3ad6dgZe9JEamoaeRy", + "identifier": "QUIPUSWAP", + "ticker1": "XTZ", + "ticker2": "QUIPU" +} +``` +and add it to the `quipuswap` array under `exchangeList` in `config.json` + +*** + +After everything command `list` should return this output + +list command + +