Skip to content

Latest commit

 

History

History
141 lines (126 loc) · 3.07 KB

README.md

File metadata and controls

141 lines (126 loc) · 3.07 KB
Raw

ref-indexer-helper

A light web server using Flask + Gunicorn + Nginx

Feature List

feature remark URL
welcome msg version info /
timestamp current timestamp at server-side /timestamp
latest actions user's latest actions on REF /latest-actions/<account_id>
liquidity pools user's liquidity pools on REF /liquidity-pools/<account_id>
all farms -- /list-farms
pools info for distinct token pair -- /list-top-pools
token price by token id -- /get-token-price?token_id=<token_id>
all tokens price price from coingecko or native pool /list-token-price
all tokens metadata -- /list-token
pool info by single pool id -- /get-pool?pool_id=<pool_id>
all pools info -- /list-pools
pools info by tokens -- /list-pools-by-tokens?token0=<token0>&token1=<token1>
pools info by pool ids -- /list-pools-by-ids?ids=id0|id1|...|idn
provide general info of whitelist pools volume, liquidity /whitelisted-active-pools
provide info for coingecko price, volume, liquidity of all global whitelisted token pools /to-coingecko

Usage

Get user's action history of ref-finance

# request ref-user's latest 10 actions on mainnet
http://localhost/latest-actions/<account_id>
# response in json type
[
    ["<timestamp>", "<method>", "<args>", "<attached_deposit>"],
    ["<timestamp>", "<method>", "<args>", "<attached_deposit>"],
    ...
]

get user's liquidity pools

http://localhost/liquidity-pools/<account_id>
# response in json type
[
    {<pool info>},
    {<pool info>},
    ...
]

List pools with max liquidity in each token pair

http://localhost/list-top-pools
# response in json type
[
    {<pool info>},
    {<pool info>},
    ...
]

list all token with cur market price from coingecko

http://localhost/list-token-price
# response in json type
{
    token_id: {"pirce": "", "decimal": 8, "symbol": ""},
    token_id: {"pirce": "", "decimal": 8, "symbol": ""},
    ...
}

list all pools in ref-finance

http://localhost/list-pools
# response in json type
[
    {<pool info>},
    {<pool info>},
    ...
]

given two tokens, list all pools using that token pair.

http://localhost/list-pools-by-tokens?token0=xxx&token1=xxxx
# response in json type
[
    {<pool info>},
    {<pool info>},
    ...
]

Get all farms in ref-farming

# request for mainnet
http://localhost:8000/list-farms
# response
[
    {...}, # FarmInfo
    {...}, # FarmInfo
    ...
    {...}, # FarmInfo
]

Build

python3 -m venv venv
source venv/bin/activate
# apt-get install libpq-dev
pip install flask
pip install flask-cors
pip install gunicorn
pip install psycopg2
pip install base58
pip install redis
pip install requests
# Flask (2.0.0)
# gunicorn (20.1.0)
# psycopg2 (2.8.6)

deploy backend

Call deploy_xxx.sh to deploy backend shell scripts with correct network id. Then make those scripts be periodically called.
There are several ways to do that:

  • crontab
  • flask_apscheduler
  • other third-party tools

Start Service

source start_server.sh

Stop Service

pstree -ap|grep gunicorn
kill -9 <pid>