Yearn Keeper Scripts

This repository enables keepers of the Keep3r Network to execute Yearn's jobs on Ethereum.

How to run

1. Clone the repository

  git clone https://github.com/yearn/keeper-scripts

2. Install dependencies

  yarn install

3. Create and complete the .env file using env.example as an example

4. Fine-tune the constants in src/constants.ts to your liking. Read the docs for a technical in-depth explanation.

5. Try out the scripts

  yarn start:factory-harvest-v1
  yarn start:tend-v2
  yarn start:harvest-v2

Run in production

1. Build the typescript into javascript

  yarn build

2. Run the jobs directly from javascript (using PM2 is highly recommended)

  node dist/src/factory-harvest-v1.js
  node dist/src/tend-v2.js
  node dist/src/harvest-v2.js

Keeper Requirements

Factory-Harvest-V1 Job:

• Must be a valid keeper on Keep3r V2

Tend-V2 Job

• Must be a valid keeper on Keep3r V2
• Have at least 50 KP3R bonded on Keep3r V2
• Should not be a contract

Harvest-V2 Job:

• Must be a valid keeper on Keep3r V2
• Have at least 50 KP3R bonded on Keep3r V2
• Should not be a contract
• Should at least have 1 ETH bonded on the Stealth Vault
• Should enable Stealth Relayer through the Stealth Vault. This should be done by calling the Vault's method enableStealthContract

Useful Links

• Factory-Harvest-V1 Job
• Tend-V2 Job
• Harvest-V2 Job
• Stealth Relayer
• Stealth Vault
• Stealth Relayer & Vault docs
• Keep3r V2
• Keep3r V1