/flatcoin-limit-order-keeper

Primary LanguageTypeScript

Flatcoin limit order keeper

Configuration

  1. Install Node.js version higher than 18: https://nodejs.org/en/download/package-manager
  2. Install yarn package manager: https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable
  3. Clone project: $ git clone https://github.com/dhedge/flatcoin-limit-order-keeper.git
  4. Install dependencies: $ yarn install
  5. Configure .env file properties:
Variable Required Description Example
DB_NAME Yes Local path to SQLite storage ../../positions.db
BLOCKCHAIN_NETWORK_NAME Yes Network name Base
CHAIN_ID Yes Chain id 8453
PROVIDER_HTTPS_URL Yes Provider URL https://mainnet.base.org
PYTH_NETWORK_PRICE_URI Yes Off-chain HTTP API endpoint used to fetch Pyth oracle prices See https://hermes.pyth.network/docs/
PYTH_NETWORK_ETH_USD_PRICE_ID Yes RETH/USD price feed ID See https://pyth.network/developers/price-feed-ids (can be used 0xa0255134973f4fdf2f8f7808354274a3b1ebc6ee438be898d045e8b56ba1fe13)
LIMIT_ORDER_CONTRACT_ADDRESS Yes LiquidationModule contract address See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml
LEVERAGE_MODULE_CONTRACT_ADDRESS Yes LeverageModule contract address See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml
VIEWER_CONTRACT_ADDRESS Yes Viewer contract address See https://github.com/dhedge/flatcoin-v1/blob/master/deployments/8453/8453.toml
SIGNER_WALLET_PK Yes Signer wallet private key
MAX_BATCH_SIZE_FOR_RPC_BATCH_REQUEST Yes Batch size of positions to call via other RPC batch requests 5
BATCH_WAIT_TIME Yes Wait time between batches, ms 500
ETH_PRICE_UPDATE_INTERVAL Yes Interval to update current ETH price, sec 4
  1. Run project: $ yarn run start