From 114492ebb636aba3471e3385493ecdcc0e997087 Mon Sep 17 00:00:00 2001
From: Daniel Liu <liudaniel@qq.com>
Date: Wed, 22 Mar 2023 15:56:14 +0800
Subject: [PATCH] docs: create xdc documents

---
 docs/README.md                |  15 ++
 docs/install.md               | 123 +++++++++++
 docs/run.md                   |  29 +++
 docs/setup-test-enviroment.md |  73 +++++++
 docs/test-globiance.md        | 189 ++++++++++++++++
 docs/test-xdc-chain.md        | 390 ++++++++++++++++++++++++++++++++++
 docs/test-xsswap.md           | 345 ++++++++++++++++++++++++++++++
 docs/upgrade.md               |  24 +++
 8 files changed, 1188 insertions(+)
 create mode 100644 docs/README.md
 create mode 100644 docs/install.md
 create mode 100644 docs/run.md
 create mode 100644 docs/setup-test-enviroment.md
 create mode 100644 docs/test-globiance.md
 create mode 100644 docs/test-xdc-chain.md
 create mode 100644 docs/test-xsswap.md
 create mode 100644 docs/upgrade.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000000..ef70047712
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,15 @@
+# User guide for xdc
+
+## Original README
+
+Here is [the original README.md](../README.original.md).
+
+## Documents for xdc
+
+- [Fresh install](./install.md)
+- [Upgrade old version](./upgrade.md)
+- [Run hummingbot](./run.md)
+- [Setup test enviroment](./setup-test-enviroment.md)
+- [Test xdc chain](./test-xdc-chain.md)
+- [Test xsswap exchange](./test-xsswap.md)
+- [Test globiance exchange](./test-globiance.md)
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 0000000000..2f89fd48c2
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,123 @@
+# Install hummingbot
+
+## 1. Environment
+
+- OS: Ubuntu 22.04
+- hummingbot: v1.13.0
+
+## 2. Install dependencies
+
+```shell
+sudo apt update -y
+sudo apt install -y build-essential curl git httpie jq wget
+```
+
+## 3. Install Miniconda3
+
+```shell
+cd ${HOME}
+wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
+chmod +x Miniconda3-latest-Linux-x86_64.sh
+./Miniconda3-latest-Linux-x86_64.sh -b -u
+./miniconda3/bin/conda init
+# Reload .bashrc to register "conda" command
+exec bash
+conda install -y conda-build
+```
+
+## 4. Install client
+
+### 4.1 Install client
+
+```shell
+cd ${HOME}
+git clone https://github.com/Carry-So/hummingbot.git
+cd hummingbot
+git checkout xdc-release-1.13.0
+./clean
+./install
+conda activate hummingbot
+./compile
+```
+
+### 4.2 Start client
+
+Start hummingbot by run command:
+
+```shell
+cd ${HOME}/hummingbot
+bin/hummingbot.py
+```
+
+Setup your password when first login, refer to https://docs.hummingbot.org/operation/password/#creating-a-password.
+
+### 4.3 generate certificates
+
+Then run command `gateway generate-certs` in the input panel to generate self-signed certificates, refer to https://docs.hummingbot.org/gateway/installation/#generate-certs.
+
+![096258ea4fc1c15ad154e99d7365ea9](https://user-images.githubusercontent.com/7695325/226868318-0188180e-0515-4a37-b919-1e14f84df693.png)
+
+## 5. Install gateway
+
+### 5.1 Install gateway
+
+```shell
+cd ${HOME}
+git clone https://github.com/Carry-So/hummingbot-gateway.git
+cd hummingbot-gateway
+git checkout xdc-release-1.13.0
+
+# Install dependencies
+yarn
+
+# Complile Typescript into Javascript
+yarn build
+```
+
+### 5.2 Setup gateway
+
+Run Gateway setup script, which helps you set configs and certificates:
+
+```shell
+cd ${HOME}/hummingbot
+./gateway-setup.sh
+```
+
+Below is the interactive process:
+
+```text
+===============  SETUP GATEWAY ===============
+
+
+Enter path to the Hummingbot certs folder >>> /home/liudan/hummingbot/certs
+
+   Confirm if this is correct:
+
+            Copy configs FROM: /home/liudan/hummingbot-gateway/src/templates
+              Copy configs TO: /home/liudan/hummingbot-gateway/conf
+
+              Copy certs FROM: /home/liudan/hummingbot/certs
+                Copy certs TO: /home/liudan/hummingbot-gateway/certs
+
+Do you want to proceed? [Y/N] >>> Y
+
+Files successfully copied from /home/liudan/hummingbot-gateway/src/templates to /home/liudan/hummingbot-gateway/conf
+
+Files successfully copied from /home/liudan/hummingbot/certs to /home/liudan/hummingbot-gateway/certs
+```
+
+### 5.3 Start gateway
+
+Start gateway using passphrase:
+
+```shell
+cd ${HOME}/hummingbot-gateway
+# yarn start --passphrase=daniel
+yarn start --passphrase=<passphrase>
+```
+
+### 5.4 Test connection
+
+The client should show: `Gateway: ONLINE` on the top of log pane(right) now. Run the command `gateway test-connection` in Hummingbot to test the connection. Now, you can type command `exit` in client to quit now. When you exit and restart client, it should automatically detect whether gateway is running and connect to it.
+
+![1679479291584](https://user-images.githubusercontent.com/7695325/226868564-5a05c170-f142-4768-93f8-f7f545887213.png)
diff --git a/docs/run.md b/docs/run.md
new file mode 100644
index 0000000000..39c2cdd730
--- /dev/null
+++ b/docs/run.md
@@ -0,0 +1,29 @@
+# Run hummingbot
+
+## 1. Start gateway
+
+Run the following commands to start gateway:
+
+```shell
+cd ${HOME}/hummingbot-gateway
+# yarn start --passphrase=daniel
+yarn start --passphrase=<passphrase>
+```
+
+![1679479660200](https://user-images.githubusercontent.com/7695325/226870035-f060c2d7-bd1b-4d9c-9622-2344c37b48cf.png)
+
+## 2. Start client
+
+Run the following commands to start client:
+
+```shell
+cd ${HOME}/hummingbot
+conda activate hummingbot
+bin/hummingbot.py
+```
+
+## 3. Connect xsswap
+
+Run the command `gateway connect xsswap` in client.
+
+![1679640895282](https://user-images.githubusercontent.com/7695325/227447487-5f736dc6-85d6-41e0-807f-e644bffe1e31.png)
diff --git a/docs/setup-test-enviroment.md b/docs/setup-test-enviroment.md
new file mode 100644
index 0000000000..af4e337275
--- /dev/null
+++ b/docs/setup-test-enviroment.md
@@ -0,0 +1,73 @@
+# Setup test enviroment
+
+## 1. Install dependent packages
+
+```shell
+sudo apt update
+sudo apt install -y curl httpie jq
+```
+
+![1679628520407](https://user-images.githubusercontent.com/7695325/227417028-79ae7b2b-aca3-4d25-aa09-73749e8bba32.png)
+
+The httpie is recommended to send https request in our test cases. You can use curl also.
+
+## 2. Set environment variables
+
+Set the following environment variables:
+
+```shell
+# address of gateway, maybe different in your environment
+export SERVER="https://127.0.0.1:15888"
+
+# POST command use JSON format
+export HEADER="Content-Type: application/json"
+
+# public key of test account, replace it with your account
+export ETH_ADDRESS="0xD4CE02705041F04135f1949Bc835c1Fe0885513c"
+export XDC_ADDRESS="xdcD4CE02705041F04135f1949Bc835c1Fe0885513c"
+
+# path of certs
+CERTS_PATH="${HOME}/hummingbot/certs"
+export GATEWAY_CERT="${CERTS_PATH}/client_cert.pem"
+export GATEWAY_KEY="${CERTS_PATH}/client_key.pem"
+```
+
+![1679627883880](https://user-images.githubusercontent.com/7695325/227415681-e8386105-76c7-44a1-825c-b0cf83fd319d.png)
+
+## 3. Config httpie
+
+Remember to delete this file after test.
+
+```shell
+mkdir -p ${HOME}/.config/httpie
+
+cat > ${HOME}/.config/httpie/config.json <<EOF
+{
+    "default_options": [
+        "--verify=no",
+        "--cert=${GATEWAY_CERT}",
+        "--cert-key=${GATEWAY_KEY}"
+    ]
+}
+EOF
+
+# check file content
+cat ${HOME}/.config/httpie/config.json
+```
+
+![1679627737884](https://user-images.githubusercontent.com/7695325/227415370-c8e6476e-cf45-4448-90be-dbeca4be19e1.png)
+
+![1679627793913](https://user-images.githubusercontent.com/7695325/227415471-ab024c88-7320-4732-9666-c22260dc8223.png)
+
+## 4. Mint tokens
+
+- I created some test tokens on apothem blockchain with [factory contract 0xfD9F33ab143b1717D4784A420eE5A93A8CbBcABd](https://explorer.apothem.network/address/xdcfD9F33ab143b1717D4784A420eE5A93A8CbBcABd#readContract). Pleas mint enough test tokes to your test account on blockchain explorer.
+
+| Token | Decimals | Link                                                                                                                                            |
+| ----: | -------: | :---------------------------------------------------------------------------------------------------------------------------------------------- |
+| WBTC2 |        8 | [0x01B0500f82EF188D0410a46f2E8940133E213e83](https://explorer.apothem.network/address/xdc01b0500f82ef188d0410a46f2e8940133e213e83#readContract) |
+|  YFI2 |       18 | [0x22e4Eb82FF59c53B275aDEacd4EE4Bc47fc4f16d](https://explorer.apothem.network/address/xdc22e4Eb82FF59c53B275aDEacd4EE4Bc47fc4f16d#readContract) |
+|  MKR2 |       18 | [0x258E445fEf3F41429e38ee124DA63aBfb08edc70](https://explorer.apothem.network/address/xdc258E445fEf3F41429e38ee124DA63aBfb08edc70#readContract) |
+| AAVE2 |       18 | [0x3042207876c47D3c206df99b3279d97813B34Ea1](https://explorer.apothem.network/address/xdc3042207876c47D3c206df99b3279d97813B34Ea1#readContract) |
+|  UNI2 |       18 | [0xD9e33607d06cBB1Fef59488b9969426b10F310B8](https://explorer.apothem.network/address/xdcD9e33607d06cBB1Fef59488b9969426b10F310B8#readContract) |
+| USDC2 |        6 | [0xF83B9Dc502A3F76c042b4043B6C1B5eBBE574389](https://explorer.apothem.network/address/xdcF83B9Dc502A3F76c042b4043B6C1B5eBBE574389#readContract) |
diff --git a/docs/test-globiance.md b/docs/test-globiance.md
new file mode 100644
index 0000000000..7ba5333eff
--- /dev/null
+++ b/docs/test-globiance.md
@@ -0,0 +1,189 @@
+# Test globiance exchange
+
+Test hummingbot API with [globiance exchange](https://app.xspswap.finance/pool)
+
+**Notice: The globiance exchange is not ready on testnet(apothem) now.**
+
+According to https://raw.githubusercontent.com/pro100skm/xdc-token-list/master/mainnet.tokenlist.json, 0x951857744785E80e2De051c32EE7b25f9c458C42 is WXDC, 0x8A3cc832Bb6B255622E92dc9d4611F2A94d200DA is GBEX-WXDC.
+
+## Preparations
+
+### 1. Setup enviroment
+
+Setup enviroment according to [instructions](./setup-test-enviroment.md) before test.
+
+## Test cases
+
+### 1. Approve allowance
+
+Set allowances to maximum for each test token.
+
+#### 1.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "globiance",
+    "token": "GBEX"
+}' | jq
+
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "globiance",
+    "token": "SRX"
+}' | jq
+```
+
+#### 1.2 If use httpie
+
+**xinfin**
+
+```shell
+# set GBEX allowance for globiance
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=xinfin address=${XDC_ADDRESS} spender=globiance token=GBEX
+
+# set SRX allowance for globiance
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=xinfin address=${XDC_ADDRESS} spender=globiance token=SRX
+```
+
+![1666779725755](https://user-images.githubusercontent.com/7695325/198002274-fb670684-481b-4c5e-a57c-c857d9196ac4.png)
+
+### 2. Query allowances
+
+#### 2.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/allowances" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "globiance",
+    "tokenSymbols": ["GBEX", "SRX"]
+}' | jq
+```
+
+#### 2.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=xinfin address=${XDC_ADDRESS} spender=globiance tokenSymbols:='["GBEX", "SRX"]'
+```
+
+![1666779804001](https://user-images.githubusercontent.com/7695325/198002507-528d438f-3450-4ee2-abc3-be41d39fb280.png)
+
+### 3. fetch token price
+
+#### 3.1 If use curl
+
+**xinfin**
+
+```shell
+# buy SRX, quote with GBEX
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "globiance",
+    "chain": "xdc",
+    "network": "xinfin",
+    "base": "SRX",
+    "quote": "GBEX",
+    "amount": "1",
+    "side": "BUY"
+}' | jq
+
+# sell SRX, quote with GBEX
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "globiance",
+    "chain": "xdc",
+    "network": "xinfin",
+    "base": "SRX",
+    "quote": "GBEX",
+    "amount": "1",
+    "side": "SELL"
+}' | jq
+```
+
+#### 3.2 If use httpie
+
+**xinfin**
+
+```shell
+# buy SRX, quote with GBEX
+https --print=b POST ${SERVER}/amm/price connector=globiance chain=xdc network=xinfin quote=GBEX amount=1 base=SRX side=BUY
+
+# sell SRX, quote with GBEX
+https --print=b POST ${SERVER}/amm/price connector=globiance chain=xdc network=xinfin quote=GBEX amount=1 base=SRX side=SELL
+```
+
+![1666779895385](https://user-images.githubusercontent.com/7695325/198002823-963eb1ef-183e-4e81-a233-a14145678575.png)
+
+### 4. Trade
+
+We will check balances of base and quote tokens before and after trade. **Notice: wait 3-4 seconds to send next request.**
+
+#### 4.1 If use curl
+
+**xinfin**
+
+```shell
+# buy SRX, quote with GBEX
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "SRX",
+    "quote": "GBEX",
+    "amount": "1",
+    "side": "BUY",
+    "chain": "xdc",
+    "network": "xinfin",
+    "connector": "globiance"
+}' | jq
+
+# sell SRX, quote with GBEX
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "SRX",
+    "quote": "GBEX",
+    "amount": "1",
+    "side": "SELL",
+    "chain": "xdc",
+    "network": "xinfin",
+    "connector": "globiance"
+}' | jq
+```
+
+#### 4.2 If use httpie
+
+**xinfin**
+
+```shell
+# query GBEX and SRX balances before buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["GBEX", "SRX"]'
+
+# buy SRX, quote with GBEX
+https --print=h POST ${SERVER}/amm/trade connector=globiance chain=xdc network=xinfin address=${XDC_ADDRESS} quote=GBEX amount=1 base=SRX side=BUY
+
+# query GBEX and SRX balances after buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["GBEX", "SRX"]'
+```
+
+![1666780493107](https://user-images.githubusercontent.com/7695325/198004848-25381332-e345-4275-bd5b-556dab7c16d5.png)
+
+```shell
+# query GBEX and SRX balances before sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["GBEX", "SRX"]'
+
+# sell SRX, quote with GBEX
+https --print=h POST ${SERVER}/amm/trade connector=globiance chain=xdc network=xinfin address=${XDC_ADDRESS} quote=GBEX amount=1 base=SRX side=SELL
+
+# query GBEX and SRX balances after sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["GBEX", "SRX"]'
+```
+
+![1666780585280](https://user-images.githubusercontent.com/7695325/198005148-a03db32b-686d-4efa-ad85-3217ebac1271.png)
diff --git a/docs/test-xdc-chain.md b/docs/test-xdc-chain.md
new file mode 100644
index 0000000000..ed5d464753
--- /dev/null
+++ b/docs/test-xdc-chain.md
@@ -0,0 +1,390 @@
+# Test xdc chain
+
+Test hummingbot gateway API with xdc chain
+
+## Setup enviroment
+
+- Setup enviroment according to [instruction](./setup-test-enviroment.md) before test.
+- Mint some test tokens to your test account.
+
+## Test cases
+
+### 1. Query gateway status
+
+```shell
+# curl -s -X GET -k --key ${GATEWAY_KEY} --cert ${GATEWAY_CERT} ${SERVER} | jq
+https --print=b ${SERVER}
+```
+
+![1669875962368](https://user-images.githubusercontent.com/7695325/204981105-8f7b982b-f291-4eba-a6f6-358e71cb4739.png)
+
+### 2. Query network config
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert $GATEWAY_CERT "${SERVER}/network/config" | jq
+https --print=b ${SERVER}/network/config
+```
+
+![1669876075182](https://user-images.githubusercontent.com/7695325/204981405-07601263-d3c8-4e03-a4a6-50a504d4b5e4.png)
+
+### 3. Query connectors
+
+```shell
+# curl -s -X GET -k --key ${GATEWAY_KEY} --cert ${GATEWAY_CERT} ${SERVER}/connectors | jq
+https --print=b ${SERVER}/connectors
+```
+
+![1669878972967](https://user-images.githubusercontent.com/7695325/204989577-c2a1ac93-25e9-4069-8250-8c216c6e3103.png)
+
+### 4. Query network status
+
+**xinfin**
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert $GATEWAY_CERT "${SERVER}/network/status?chain=xdc&network=xinfin" | jq
+https --print=b ${SERVER}/network/status chain==xdc network==xinfin
+```
+
+![1679628870454](https://user-images.githubusercontent.com/7695325/227417766-c2db5b0b-eef8-495e-91d8-6f6c30040e68.png)
+
+**apothem**
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert $GATEWAY_CERT "${SERVER}/network/status?chain=xdc&network=apothem" | jq
+https --print=b ${SERVER}/network/status chain==xdc network==apothem
+```
+
+![1679628964147](https://user-images.githubusercontent.com/7695325/227417988-a7fcef50-2aa2-431f-8cf9-43f0eaf4f3a4.png)
+
+**all networks**
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert "$GATEWAY_CERT" "${SERVER}/network/status" | jq
+https --print=b ${SERVER}/network/status
+```
+
+![1679629021834](https://user-images.githubusercontent.com/7695325/227418131-8ca22930-8647-4f56-90b0-aeb343fd139c.png)
+
+### 5. Fetch token list
+
+**xinfin**
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert $GATEWAY_CERT "${SERVER}/network/tokens?chain=xdc&network=xinfin" | jq
+https --print=b ${SERVER}/network/tokens chain==xdc network==xinfin
+```
+
+![1669876730976](https://user-images.githubusercontent.com/7695325/204983090-cbbeccc3-5a1c-4375-a54c-9e3e4a7aa08b.png)
+
+**apothem**
+
+```shell
+# curl -s -X GET -k --key $GATEWAY_KEY --cert $GATEWAY_CERT "${SERVER}/network/tokens?chain=xdc&network=apothem" | jq
+https --print=b ${SERVER}/network/tokens chain==xdc network==apothem
+```
+
+![1669876794725](https://user-images.githubusercontent.com/7695325/204983245-c74c2b81-043e-40b2-a5cd-a969ef19a0f4.png)
+
+### 6. Query transaction
+
+#### 6.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}"  "${SERVER}/network/poll" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "txHash": "0xf49e741720e3f6c464e7bfbdcaefddb6f9a4cc39d4b367476727e95be735b350"
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}"  "${SERVER}/network/poll" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "txHash": "0x1114601d48ebc3afa5e06af13e759560e74b3d5d1837d951919bc57727a623dd"
+}' | jq
+```
+
+#### 6.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b POST ${SERVER}/network/poll chain=xdc network=xinfin txHash=0xf49e741720e3f6c464e7bfbdcaefddb6f9a4cc39d4b367476727e95be735b350
+```
+
+![1669879304138](https://user-images.githubusercontent.com/7695325/204990835-4f7ccf87-1c5f-4f15-be16-b094adfbc29f.png)
+
+**apothem**
+
+```shell
+https --print=b POST ${SERVER}/network/poll chain=xdc network=apothem txHash=0x1114601d48ebc3afa5e06af13e759560e74b3d5d1837d951919bc57727a623dd
+```
+
+![1669877250971](https://user-images.githubusercontent.com/7695325/204984600-dfec94b2-dc89-4f29-845d-c341a1870af4.png)
+
+### 7 Add private key
+
+The length of private key is 67 characters with `xdc` prefix or 66 characters with `0x` prefix, such as:
+
+- xdc prefix: xdc0123456789012345678901234567890123456789012345678901234567890123
+- 0x prefix: 0x0123456789012345678901234567890123456789012345678901234567890123
+
+We will use xdc-prefix in below tests.
+
+```shell
+# export XDC_PRIVATE_KEY="xdc0123456789012345678901234567890123456789012345678901234567890123"
+export XDC_PRIVATE_KEY="<YOUR_XDC_PRIVATE_KEY>"
+```
+
+![image](https://user-images.githubusercontent.com/7695325/204986439-f300c68b-ec2f-4d50-a548-af143e4b0497.png)
+
+#### 7.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/wallet/add" -d '{
+    "privateKey": "'"${XDC_PRIVATE_KEY}"'",
+    "chain": "xdc",
+    "network":"xinfin"
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/wallet/add" -d '{
+    "privateKey": "'"${XDC_PRIVATE_KEY}"'",
+    "chain": "xdc",
+    "network":"apothem"
+}' | jq
+```
+
+#### 7.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b ${SERVER}/wallet/add privateKey=${XDC_PRIVATE_KEY} chain=xdc network=xinfin
+```
+
+![1669878351454](https://user-images.githubusercontent.com/7695325/204987731-8ec1bd75-8826-461f-b22a-9fe249563c0c.png)
+
+**apothem**
+
+```shell
+https --print=b ${SERVER}/wallet/add privateKey=${XDC_PRIVATE_KEY} chain=xdc network=apothem
+```
+
+![1669878845008](https://user-images.githubusercontent.com/7695325/204989230-e008cb01-1897-4e54-b5d7-674c8453c90d.png)
+
+### 8. Query token balances
+
+#### 8.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/network/balances" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"${XDC_ADDRESS}"'",
+    "tokenSymbols": ["XDC","WXDC"]
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/network/balances" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"${XDC_ADDRESS}"'",
+    "tokenSymbols": ["XDC","WXDC", "DAI", "WBTC2", "YFI2", "MKR2", "AAVE2", "UNI2", "USDC2"]
+}' | jq
+```
+
+#### 8.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin \
+address=${XDC_ADDRESS} tokenSymbols:='["XDC", "WXDC"]'
+```
+
+![1669879947119](https://user-images.githubusercontent.com/7695325/204992862-ef76f4cb-3ae5-40fd-81be-a05a1fba1d04.png)
+
+**apothem**
+
+```shell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=apothem \
+address=${XDC_ADDRESS} tokenSymbols:='["XDC", "WXDC", "WBTC2", "YFI2", "MKR2", "USDC2"]'
+```
+
+![1669879997687](https://user-images.githubusercontent.com/7695325/204993016-c0af4356-cb40-4452-b99b-97a63f2aa505.png)
+
+### 9. Query account nonce
+
+#### 9.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/nonce" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address":"'"$XDC_ADDRESS"'"
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/nonce" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address":"'"$XDC_ADDRESS"'"
+}' | jq
+```
+
+#### 9.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b POST ${SERVER}/evm/nonce chain=xdc network=xinfin address=${XDC_ADDRESS}
+```
+
+![1669880139820](https://user-images.githubusercontent.com/7695325/204993415-26bf4011-dfff-42a8-b05c-853b8d7db63e.png)
+
+**apothem**
+
+```shell
+https --print=b POST ${SERVER}/evm/nonce chain=xdc network=apothem address=${XDC_ADDRESS}
+```
+
+![1669880196463](https://user-images.githubusercontent.com/7695325/204993550-f0b96dd3-bfdd-4f0e-9251-02032dcd81ad.png)
+
+### 10. Query allowances
+
+#### 10.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/allowances" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xdc41c0ad06c98951e9bf7172cd1d285c6e34537170",
+    "tokenSymbols": ["WXDC", "SRX", "XTT", "xUSDT"]
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/allowances" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xdc41c0ad06c98951e9bf7172cd1d285c6e34537170",
+    "tokenSymbols": ["WBTC2", "YFI2", "MKR2", "AAVE2", "UNI2", "USDC2"]
+}' | jq
+```
+
+#### 10.2 If use httpie
+
+**xinfin**
+
+```shell
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=xinfin address=${XDC_ADDRESS} \
+spender=xdc85f33E1242d87a875301312BD4EbaEe8876517BA tokenSymbols:='["WXDC", "SRX", "XTT", "xUSDT"]'
+```
+
+![1669880604574](https://user-images.githubusercontent.com/7695325/204994914-8fe48046-8036-42e2-812e-c58d5ec469d4.png)
+
+**apothem**
+
+```shell
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=apothem address=${XDC_ADDRESS} \
+spender=xdc85f33E1242d87a875301312BD4EbaEe8876517BA tokenSymbols:='["WBTC2", "YFI2", "MKR2", "AAVE2", "UNI2", "USDC2"]'
+```
+
+![1669880674424](https://user-images.githubusercontent.com/7695325/204995095-dda5e586-62d7-4415-9f12-eb1423e5826b.png)
+
+### 11. Approve allowance
+
+#### 11.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xdc41c0ad06c98951e9bf7172cd1d285c6e34537170",
+    "token": "SRX"
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xdc41c0ad06c98951e9bf7172cd1d285c6e34537170",
+    "token": "USDC2"
+}' | jq
+```
+
+#### 11.2 If use httpie
+
+**xinfin**
+
+```shell
+# query allowances
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=xinfin address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 tokenSymbols:='["SRX"]'
+
+# set allowances to maximum
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=xinfin address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 token=SRX
+
+# query allowances
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=xinfin address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 tokenSymbols:='["SRX"]'
+```
+
+![1666773893275](https://user-images.githubusercontent.com/7695325/197979153-8eb127e4-1099-4546-ac84-875c81d15749.png)
+
+**apothem**
+
+```shell
+# clear allowances
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=apothem address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 token=USDC2 amount=0
+
+# query allowances
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=apothem address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 tokenSymbols:='["USDC2"]'
+
+# set allowances to maximum
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=apothem address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 token=USDC2
+
+# query allowances
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=apothem address=${XDC_ADDRESS} \
+spender=xdc41c0ad06c98951e9bf7172cd1d285c6e34537170 tokenSymbols:='["USDC2"]'
+```
+
+![1666773765723](https://user-images.githubusercontent.com/7695325/197978588-b0744215-7a64-404a-90c9-1561f833602f.png)
diff --git a/docs/test-xsswap.md b/docs/test-xsswap.md
new file mode 100644
index 0000000000..4da1de829b
--- /dev/null
+++ b/docs/test-xsswap.md
@@ -0,0 +1,345 @@
+# Test xsswap exchange
+
+Test hummingbot gateway API with [xsswap exchange](https://app.xspswap.finance/pool)
+
+## Preparations
+
+### 1. Setup enviroment
+
+Setup enviroment according to [instructions](./setup-test-enviroment.md) before test.
+
+### 2. Trade pools
+
+I created some trade pools on xsswap and testnet:
+
+| Token1 | Token2 | Price(Token1/Token2) |
+| -----: | -----: | -------------------: |
+|  WBTC2 |  USDC2 |                20000 |
+|   YFI2 |  USDC2 |                 8000 |
+|   MKR2 |  USDC2 |                  600 |
+|  AAVE2 |  USDC2 |                   70 |
+|   UNI2 |  USDC2 |                    5 |
+
+## Test cases
+
+### 1. Approve allowance
+
+Set allowances to maximum for each test token.
+
+#### 1.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "token": "WXDC"
+}' | jq
+
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "token": "XTT"
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "token": "USDC2"
+}' | jq
+
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/approve" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "token": "WBTC2"
+}' | jq
+```
+
+#### 1.2 If use httpie
+
+**xinfin**
+
+```shell
+# set WXDC allowance for xsswap
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=xinfin address=${XDC_ADDRESS} spender=xsswap token=WXDC
+
+# set XTT allowance for xsswap
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=xinfin address=${XDC_ADDRESS} spender=xsswap token=XTT
+```
+
+![1666777201581](https://user-images.githubusercontent.com/7695325/197992826-0d4168b2-a60d-41c0-9a8f-9fe0282b9308.png)
+
+**apothem**
+
+```shell
+# set USDC2 allowance for xsswap
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=apothem address=${XDC_ADDRESS} spender=xsswap token=USDC2
+
+# set WBTC2 allowance for xsswap
+https --print=h POST ${SERVER}/evm/approve chain=xdc network=apothem address=${XDC_ADDRESS} spender=xsswap token=WBTC2
+```
+
+![1666774991914](https://user-images.githubusercontent.com/7695325/197983708-1d166542-d25c-44fb-a8c0-14fc5ce3c450.png)
+
+### 2. Query allowances
+
+#### 2.1 If use curl
+
+**xinfin**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/allowances" -d '{
+    "chain": "xdc",
+    "network": "xinfin",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "tokenSymbols": ["WXDC", "XTT"]
+}' | jq
+```
+
+**apothem**
+
+```shell
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/evm/allowances" -d '{
+    "chain": "xdc",
+    "network": "apothem",
+    "address": "'"$XDC_ADDRESS"'",
+    "spender": "xsswap",
+    "tokenSymbols": ["WBTC2", "USDC2"]
+}' | jq
+```
+
+#### 2.2 If use httpie
+
+**xinfin**
+
+```shell
+# query allowances of WXDC and XTT
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=xinfin address=${XDC_ADDRESS} spender=xsswap tokenSymbols:='["WXDC", "XTT"]'
+```
+
+![1666778539223](https://user-images.githubusercontent.com/7695325/197997814-dff8a1e7-2d9a-4e9c-9a4d-431a1fb9ebad.png)
+
+**apothem**
+
+```shell
+# query allowances of WBTC2 and USDC2
+https --print=b POST ${SERVER}/evm/allowances chain=xdc network=apothem address=${XDC_ADDRESS} spender=xsswap tokenSymbols:='["WBTC2", "USDC2"]'
+```
+
+![1666775412785](https://user-images.githubusercontent.com/7695325/197985347-176d758b-ec46-47a0-8ec1-207173b038cb.png)
+
+### 3. fetch token price
+
+#### 3.1 If use curl
+
+**xinfin**
+
+```shell
+# buy XTT, quote with WXDC
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "xsswap",
+    "chain": "xdc",
+    "network": "xinfin",
+    "base": "XTT",
+    "quote": "WXDC",
+    "amount": "1",
+    "side": "BUY"
+}' | jq
+
+# sell XTT, quote with WXDC
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "xsswap",
+    "chain": "xdc",
+    "network": "xinfin",
+    "base": "XTT",
+    "quote": "WXDC",
+    "amount": "1",
+    "side": "SELL"
+}' | jq
+```
+
+**apothem**
+
+```shell
+# buy WBTC2, quote with USDC2
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "xsswap",
+    "chain": "xdc",
+    "network": "apothem",
+    "base": "WBTC2",
+    "quote": "USDC2",
+    "amount": "1",
+    "side": "BUY"
+}' | jq
+
+# sell WBTC2, quote with USDC2
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/price" -d '{
+    "connector": "xsswap",
+    "chain": "xdc",
+    "network": "apothem",
+    "base": "WBTC2",
+    "quote": "USDC2",
+    "amount": "1",
+    "side": "SELL"
+}' | jq
+```
+
+#### 3.2 If use httpie
+
+**xinfin**
+
+```shell
+# buy XTT, quote with WXDC
+https --print=b POST ${SERVER}/amm/price connector=xsswap chain=xdc network=xinfin quote=WXDC amount=1 base=XTT side=BUY
+
+# sell XTT, quote with WXDC
+https --print=b POST ${SERVER}/amm/price connector=xsswap chain=xdc network=xinfin quote=WXDC amount=1 base=XTT side=SELL
+```
+
+![1666777532897](https://user-images.githubusercontent.com/7695325/197994039-94414986-4563-4768-a1c3-b33f9cef8170.png)
+
+**apothem**
+
+```shell
+# buy WBTC2, quote with USDC2
+https --print=b POST ${SERVER}/amm/price connector=xsswap chain=xdc network=apothem quote=USDC2 amount=1 base=WBTC2 side=BUY
+
+# sell WBTC2, quote with USDC2
+https --print=b POST ${SERVER}/amm/price connector=xsswap chain=xdc network=apothem quote=USDC2 amount=1 base=WBTC2 side=SELL
+```
+
+![1666600887376](https://user-images.githubusercontent.com/7695325/197485115-402b76f8-645f-4a32-b09a-9af28cb0dd43.png)
+
+### 4. Trade
+
+We will check balances of base and quote tokens before and after trade. **Notice: wait 3-4 seconds to send next request.**
+
+#### 4.1 If use curl
+
+**xinfin**
+
+```shell
+# buy XTT, quote with WXDC
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "XTT",
+    "quote": "WXDC",
+    "amount": "1",
+    "side": "BUY",
+    "chain": "xdc",
+    "network": "xinfin",
+    "connector": "xsswap"
+}' | jq
+
+# sell XTT, quote with WXDC
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "XTT",
+    "quote": "WXDC",
+    "amount": "1",
+    "side": "SELL",
+    "chain": "xdc",
+    "network": "xinfin",
+    "connector": "xsswap"
+}' | jq
+```
+
+**apothem**
+
+```shell
+# buy WBTC2, quote with USDC2
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "WBTC2",
+    "quote": "USDC2",
+    "amount": "1",
+    "side": "BUY",
+    "chain": "xdc",
+    "network": "apothem",
+    "connector": "xsswap"
+}' | jq
+
+# sell WBTC2, quote with USDC2
+curl -s -X POST -k --key $GATEWAY_KEY --cert $GATEWAY_CERT -H "${HEADER}" "${SERVER}/amm/trade" -d '{
+    "address": "'"$XDC_ADDRESS"'",
+    "base": "WBTC2",
+    "quote": "USDC2",
+    "amount": "1",
+    "side": "SELL",
+    "chain": "xdc",
+    "network": "apothem",
+    "connector": "xsswap"
+}' | jq
+```
+
+#### 4.2 If use httpie
+
+**xinfin**
+
+```shell
+# query balances before buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["WXDC", "XTT"]'
+
+# buy XTT, quote with WXDC
+https --print=h POST ${SERVER}/amm/trade connector=xsswap chain=xdc network=xinfin address=${XDC_ADDRESS} quote=WXDC amount=1 base=XTT side=BUY
+
+# query balances after buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["WXDC", "XTT"]'
+```
+
+![1666778040514](https://user-images.githubusercontent.com/7695325/197995925-0e05a3f1-828a-4cff-8b27-f63900d017e5.png)
+
+```shell
+# query WXDC and XTT balances before sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["WXDC", "XTT"]'
+
+# sell XTT, quote with WXDC
+https --print=h POST ${SERVER}/amm/trade connector=xsswap chain=xdc network=xinfin address=${XDC_ADDRESS} quote=WXDC amount=1 base=XTT side=SELL
+
+# query WXDC and XTT balances after sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=xinfin address=${XDC_ADDRESS} tokenSymbols:='["WXDC", "XTT"]'
+```
+
+![1666778145685](https://user-images.githubusercontent.com/7695325/197996331-b6c780c8-00c8-41d7-9488-c9bd0bfe3052.png)
+
+**apothem**
+
+```shell
+# query WBTC2 and USDC2 balances before buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=apothem address=${XDC_ADDRESS} tokenSymbols:='["WBTC2", "USDC2"]'
+
+# buy WBTC2, quote with USDC2
+https --print=h POST ${SERVER}/amm/trade connector=xsswap chain=xdc network=apothem address=${XDC_ADDRESS} quote=USDC2 amount=1 base=WBTC2 side=BUY
+
+# query WBTC2 and USDC2 balances after buy
+https --print=b POST ${SERVER}/network/balances chain=xdc network=apothem address=${XDC_ADDRESS} tokenSymbols:='["WBTC2", "USDC2"]'
+```
+
+![1666602199336](https://user-images.githubusercontent.com/7695325/197489651-0407e3c6-4151-481e-b34a-e0dee3369f27.png)
+
+```shell
+# query WBTC2 and USDC2 balances before sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=apothem address=${XDC_ADDRESS} tokenSymbols:='["WBTC2", "USDC2"]'
+
+# sell WBTC2, quote with USDC2
+https --print=h POST ${SERVER}/amm/trade connector=xsswap chain=xdc network=apothem address=${XDC_ADDRESS} quote=USDC2 amount=1 base=WBTC2 side=SELL
+
+# query WBTC2 and USDC2 balances after sell
+https --print=b POST ${SERVER}/network/balances chain=xdc network=apothem address=${XDC_ADDRESS} tokenSymbols:='["WBTC2", "USDC2"]'
+```
+
+![1666602830052](https://user-images.githubusercontent.com/7695325/197491647-c8b24ff2-e2b2-4279-b4cc-e420dd705feb.png)
diff --git a/docs/upgrade.md b/docs/upgrade.md
new file mode 100644
index 0000000000..a4d2b521fa
--- /dev/null
+++ b/docs/upgrade.md
@@ -0,0 +1,24 @@
+# Upgrade hummingbot
+
+## 1. Upgrade gateway
+
+```shell
+cd ${HOME}/hummingbot-gateway
+git fetch --all
+git checkout <NEW-VERSION>
+yarn
+yarn build
+```
+
+## 2. Upgrade client
+
+```shell
+cd ${HOME}/hummingbot
+git fetch --all
+git checkout <NEW-VERSION>
+conda deactivate
+./clean
+./install
+conda activate hummingbot
+./compile
+```