โI Want to Become a Keeper
Instructions to register a keeper and install the software
To become a keeper, you have to do the following:
Register a keeper in the PowerAgent contract;
Install the PowerAgent software;
Activate the keeper in the PowerAgent contract.
Keeper registration
Keeper registration, activation, management, stake deposit and withdrawal, compensation withdrawal are done via PowerAgent DApp.
To register a new keeper, follow the instructions below:
Press โConnectโ and connect with your Admin wallet.
Press the โCreate Keeperโ button:
Select the most recent agent version. Press the โCreate Keeperโ button at the bottom:
In the keeper creation pop-up window, specify the amount of CVP to stake (no less than 1000) and the Worker address which you created beforehand:
An โUnlockโ button will light up. Press and confirm the transaction. Afterwards, press โCreate keeperโ.
Afterwards, a keeper will be created, but not activated. Proceed to Installation Section and install the node software.
Node installation
Follow one of guides listed below based on the chosen method:
Installation
Start with a clean AMD-64 architecture distribution (the code is given for Ubuntu or Debian.
Install NodeJS, npm, Docker, and Docker-Compose
Install NodeJS and npm
Refer to the official installation documentation.
Install Docker and Docker Compose
Refer to the official installation documentation.
Navigate to a directory of your choice:
cd /path/to/the/directory/of/your/choice
Clone the standalone repository and
cd
to it:git clone https://github.com/powerpool-finance/powerpool-agent-v2-compose cd powerpool-agent-v2-compose
Generate the worker keyfile:
npm i node jsongen.js ${YOUR_WORKER_PRIVATE_KEY} ${A_PASSWORD_OF_YOUR_CHOICE}
Mind that the password will be specified in the config later on, so remember it.
Open the config file with a text editor of your choice. For the sake of an example, here we open it with nano
nano config/main.yaml
Fill the file out according to the schema, substituting the variables where needed (numerical values can also be changed, if you so desire). Do not remove
โโ
(quotation marks).
[OPTIONAL] Change the name of the package if you want to run several instances of the PowerAgent on the same machine.
version: "3.9" services: ${SERVICE_NAME}: container_name: ${CONTAINER_NAME} image: powerpool/power-agent-node:latest restart: always volumes: - ./config:/usr/app/config - ./keys:/usr/app/keys environment: NODE_ENV: ${NODE_ENV}
Launch the node.
docker compose up -d docker logs -f ${CONTAINER_NAME}
Update
In the folder with the docker-compose.yaml
file run:
docker compose down --rmi local
docker compose pull
docker compose up -d
Stop
In the folder with the docker-compose.yaml
file run:
docker compose down --rmi local
Afterwards, proceed to the keeper activaton section.
Example configs for standalone installation:
networks:
enabled:
- gnosis
details:
gnosis:
rpc: 'your_rpc_address'
block_logs_mode: true
agents:
'0x071412e301C2087A4DAA055CF4aFa2683cE1e499':
data_source: subgraph
subgraph_url: https://api.studio.thegraph.com/proxy/48711/ppav2-rd-gnosis-b12-ui/version/latest
executor: pga
keeper_worker_address: 'your_keeper_worker_address'
key_pass: 'your_password'
accrue_reward: false
๐ฅณ This concludes the installation + configuration process. Good job! Now the keeper must be activated in order to be able to execute transactions.
Keeper activation
After installation, go back to the DApp, open โMy Keepersโ tab and expand the entry for your newly registered keeper.
The status of the keeper will be โActivatingโ. Next to it, locate the โCompleteโ button and confirm the transaction:

Verify that the keeper is active:

Managing Keepers
On the My Keepers tab you can see all your registered keepers; both active and inactive.
Click on the keeper entry to expand the detailed view:

Summary tab.
Here you can see the total number of your keepers, sum of all their CVP stakes and their total earnings in native token.
Keeper stats tab.
Here the key metrics of your keeper are presented: active and pending withdrawal CVP stake, number of jobs completed, and detailed balance.
Control tab.
On this tab you can stake or withdraw CVP for your keeper, as well as withdraw native token earnings.
Last updated
Was this helpful?