Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.79 KB

README.md

File metadata and controls

76 lines (48 loc) · 2.79 KB
Raw

🤖 APE-compound-bot

A bot that automatically claims APE rewards from ApeStaking in ParaSpace and then compound them, you can use the bot to earn rewards from this operation, see our document.

💡 Getting started

0. Prerequisites

  • pnpm install: install dependencies
  • pnpm build: build the project
  • cp .env.sample .env: copy sample env file and configure environment variables in .env file

see How to configure the bot for more details.

1. Create Keystore

🙈 Do not share screen while creating keystore

pnpm create:keystore

create:keystore

The script will generate a keystore file in **/keystore/default/<your-address>, you can run the ape-compound-bot via this keystore.

2. Run via keystore or private key

You may need to run pnpm build before running the bot.

pnpm start

🔧 Appendix

How to configure the bot

The bot is configured via environment variables. You can find the list of environment variables in the .env.sample file.

The .env file contains the following variables you need to configure:

  • ETH_ENDPOINT=<your-RPC-endpoint>: The RPC endpoint of the Ethereum network you want to connect to. You can use Infura or Alchemy to get a free RPC endpoint.

  • wallet connection: the bot will use the wallet to sign transactions directly.

    • private key: you can give the bot a private key directly.
    • keystore and password: you can give the bot a keystore and the password of the keystore, the bot will unlock the keystore you encrypted with the password.
Example .env 
ETH_ENVIRONMENT=production
ETH_NETWORK_NAME=mainnet
ETH_ENDPOINT=https://eth-mainnet.g.alchemy.com/v2/<**your-api-key**>

# Make sure to set wallet connection, either:
## 1. private key
ETH_PRIVATE_KEY=

## 2. or keystore
### If you has a keystore `**/keystore/default/0x5D48a0512efE84C6Ed674481F774F285a85ab896` encrypted with password 123456
KEYSTORE_DIR=keystore/default
KEYSTORE_NAME=0x5D48a0512efE84C6Ed674481F774F285a85ab896
# PASSWORD_BASE64=MTIzNDU2
PASSWORD=123456

How to start the bot

pnpm start: run the bot via private key or keystore

  1. If you want to run the bot via private key, you need to set the ETH_PRIVATE_KEY environment variable.
  2. If you want to run the bot via keystore, you need to set the KEYSTORE_DIR and KEYSTORE_NAME environment variables. The console will ask you to enter the password of the keystore you set in 1. Create Keystore

This project is MIT Licensed.