This is the bot that executes limit orders for gTrade, the decentralized leveraged trading platform.
$ git clone [email protected]:GainsNetwork-org/nft-bot-v3.git
$ cp .env.polygon.example .env.polygon
$ cp .env.arbitrum.example .env.arbitrum
$ cp .env.mumbai.example .env.mumbai
(.env.polygon, .env.arbitrum and .env.mumbai)
- Set
WSS_URLSto your dedicated WSS endpoints (comma separated list) - Set
PRIVATE_KEYto your account's private key - Set
PUBLIC_KEYto your account's public key - Set
ORACLE_ADDRESSto your Oracle contract address
$ docker-compose build
$ docker-compose up
To update all bot instances run the following:
docker-compose up --build --force-recreate -d
| Name | Description |
|---|---|
| LOG_LEVEL | Sets the level at which the bot should log. Valid values are: error, warn, info, verbose, debug. Using debug will produce a massive amount of output and is not suggested except for initial setup or problem solving. |
| ENABLE_CONSOLE_LOGGING | Whether or not log messages should be output to the console. |
| ENABLE_FS_LOGGING | Whether or not log messages should be output to a log file. This will log into a .logs/<utc-date> directory each time the bot is started. |
| WSS_URLS | The RPC endpoint URLs that should be used for all blockchain communication. |
| PRICES_URL | The WSS endpoint where the Gains backend pricing service is running. |
| STORAGE_ADDRESS | The address of the Gains Storage contract on chain. |
| PAIR_INFOS_ADDRESS | The address of the Gains Pair Infos contract on chain. |
| PRIVATE_KEY | The private key of your account that should be used to execute transactions. |
| PUBLIC_KEY | The public key of your account that should be used to execute transactions. IF ORACLE OPERATOR: Make sure this address is either owner() or authorized fulfiller on your oracle address in order to claim rewards. |
| EVENT_CONFIRMATIONS_SEC | The number of seconds that must pass for an event coming from the blockchain to be considered as confirmed and safe for execution against. |
| MIN_PRIORITY_GWEI | The minimum priority gas fee in GWEI that should be used when triggering orders. |
| MAX_GAS_PRICE_GWEI | The maximum gas price in GWEI that should be used when triggering orders. |
| MAX_GAS_PER_TRANSACTION | |
| PRIORITY_GWEI_MULTIPLIER | A multiplier that can be applied to the current priority gas fee which was fetched from the polygon gas station. |
| VAULT_REFILL_ENABLED | Whether or not you want the bot to participate in refilling the vault as a good citizen of the Gains Network. |
| CHECK_REFILL_SEC | How frequently the vault refilling process should occur. |
| AUTO_HARVEST_SEC | How frequently the bot will harvest any rewards earned from triggering orders. |
| FAILED_ORDER_TRIGGER_TIMEOUT_SEC | How long the bot should wait before it will retry an order after it has failed to successfully process on chain. |
| OPEN_TRADES_REFRESH_SEC | How frequently the bot should fully refresh trade data from the Gains smart contracts on chain. By default, the bot is keeping itself up to date based on delta events it's receiving from the chain so this isn't technically necessary, but it's a good fail safe in case the bot fails to hear about a certain even due to connectivity or other issues. Setting this to 0 will disable explicit refreshing and only ever keep state based on events it receives. |
| GAS_REFRESH_INTERVAL_SEC | How frequently to get the latest gas prices from the gas station. |
| FETCH_TRADING_VARIABLES_REFRESH_INTERVAL_SEC | How frequently trading variables should be refreshed from the Gains smart contracts on chain. There are many variables that go into the calculations of triggering order and these variables need to be freshed to ensure the bot is always using the latest numbers. This is always done at start up, but does not need to be done too frequently at runtime. |
| DRY_RUN | Set to true to enable a "dry run" mode where the bot will do everything except submit the actual transactions to the chain for processing. This is good for initial setup to ensure everything is working as expected and other testing combined with a LOG_LEVEL of debug. |
| CHAIN_ID | The ID of the block chain the bot is going to be interacting with. This defaults to 137 for Polygon's mainnet and you should only need to change it if you're targeting another chain. |
| NETWORK_ID | The ID of the network of the block chain the bot is going to be interacting with. This defaults to 137 for Polygon's mainnet and you should only need to change it if you're targeting another chain. |
| CHAIN | The name of the block chain the bot is going to be interacting with. This defaults to mainnet and you should only change it if you're targeting a different chain. |
| BASE_CHAIN | The name of the base block chain the bot is going to be interacting with. This only needs to be set if you're testing on a network that is forked from a different chain. (e.g. testing on Polygon's Mumbai you would set this to goerli) |
| HARDFORK | The ethereum hardfork of the block chain the bot is going to be interacting with. This defaults to london today and you should only need to change it if you're intending to target a different hardfork. |
| ENABLE_CONCURRENT_PRICE_UPDATE_PROCESSING | Whether or not the bot should allow multiple price updates to be processed concurrently. This allows for faster reaction time when triggering orders rather than waiting on previous price update processing to complete. Defaults to true. |
| USE_MULTICALL | Whether or not the bot should multicall fetching open orders and other information. Some RPC providers may restrict multicalls. Set to false to use call batching instead. Defaults to true |
| MAX_RETRIES | How many times the bot should attempt to trigger an order. Set to -1 to disable. |
| ORACLE_ADDRESS | FOR ORACLE OPERATORS ONLY: The address of your oracle. The PUBLIC_KEY you use to run the bot must either be an authorized fulfiller or the owner of the oracle contract |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent