Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.39 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.39 KB
Raw

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
  1. Install dependencies
  yarn install

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

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

  3. 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
  1. 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:

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