README.md

Maker's Keeper Scripts

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

How to run

1. Clone the repository

  git clone https://github.com/makerdao/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

Run in production

1. Build the typescript into javascript

  yarn build

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

  node dist/upkeep-job.js

Keeper Requirements

• Must be a valid (activated) Keeper on Keep3r V2

Useful Links

• Upkeep Job
• Sequencer