Skip to content

Shard-Labs/depositor-bot

 
 

Repository files navigation

Lido Lido On Polygon Depositor bot

Delegator and Reward Distributor bot

The bot is used to delegate and distribute rewards

Reward Distribution

The Bot will distribute rewards each cycle (default 24h), we do some checks before executing the transaction: Check if the gas fees are cheap. Check if there are some accumulated rewards. When the transaction is submitted successfully the process will sleep for a cycle otherwise the Bot will keep trying to submit a transaction each 13 sec (block time).

Delegation

The Bot will delegate the buffered tokens accumulated in the stMatic contract. Each block time we do a check to see if there are enough buffered tokens to delegate. If the actual buffered tokens are 3%(MAX_RATE) of the total staked tokens in the protocol we delegate automatically without checking gas fees. If the buffered tokens are between 1%(MIN_RATE) and 3%(MAX_RATE) of the total staked tokens, the delegation is executed each cycle (default 24h). If the total Buffered is less than 1%(MIN_RATE) we don’t delegate.

How to install

Only for development: Ganache CLI is required to run Brownie

npm install -g ganache-cli

Python packages

git clone [email protected]:Shard-Labs/depositor-bot.git
cd depositor-bot
pip install -r requirements.txt

Run script

To run (development):

Run:

# For depositor bot
brownie run depositor --network=mainnet

Deploy

To run bot in dry mode in docker:

  1. Required envs:NETWORK (e.g. mainnet) and WEB3_INFURA_PROJECT_ID.
  2. Run
docker-compose up
  • Optional: provide WALLET_PRIVATE_KEY env to run with account.
  • Optional: provide CREATE_TRANSACTIONS env ('true') to send tx to mempool.
  • Optional: cycle CYCLE env time interval to delegate and distribute rewards.

Available variables

Vars in env Amount Default - Raw Description
NETWORK (required) - None Network (e.g. mainnet, goerli)
WEB3_INFURA_PROJECT_ID (required) - None Project ID in infura
MAX_GAS_FEE 100 GWEI 100 gwei Bot will wait for a lower price. Treshold for gas_fee
DISTRIBUTE_REWARDS_MAX_GAS_FEE 300 GWEI 300 gwei Bot will distribute rewards if the for gas_fee is less than this value
DISTRIBUTE_REWARDS true true If true Distribute rewards else ignore
GAS_FEE_PERCENTILE_1 20 20 Percentile for first recommended fee calculation
GAS_FEE_PERCENTILE_DAYS_HISTORY_1 1 1 Percentile for first recommended calculates from N days of the fee history
GAS_FEE_PERCENTILE_2 20 20 Percentile for second recommended fee calculation
GAS_FEE_PERCENTILE_DAYS_HISTORY_2 2 2 Percentile calculates from N days of the fee history
GAS_PRIORITY_FEE_PERCENTILE 55 55 Priority transaction will be N percentile from priority fees in last block (min 2 gwei - max 10 gwei)
CONTRACT_GAS_LIMIT 10 * 10**6 10000000 Default transaction gas limit
WALLET_PRIVATE_KEY - None Account private key
CREATE_TRANSACTIONS - None If true then tx will be send to blockchain
MIN_PRIORITY_FEE 2 GWEI 2 gwei Min priority fee that will be used in tx
MAX_PRIORITY_FEE 10 GWEI 10 gwei Max priority fee that will be used in tx (4 gwei recommended)
PRIORITY_FEE 1 GWEI 1 gwei Priority fee that will be used in tx
CYCLE 86400 86400 The time interval between each delegation and reward distribution
MAX_RATE 3 3 The ratio (totalBuffered * 100 / totalStaked), if the ratio > MAX_RATIO delegate automatically
MIN_RATE 1 1 The min ratio to delegate the buffered tokens

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 95.0%
  • Shell 2.9%
  • Dockerfile 2.1%