Skip to content

How to Run Keeper Jobs

Ryan Hall edited this page Mar 22, 2021 · 9 revisions

Running Keeper Jobs

Prerequisites

chainlink installation

First, you must have the latest version of the chainlink node installed and configured using the instructions above.

Env Vars

The following environment variables configure keeper jobs. They are all optional.

  • KEEPER_REGISTRY_SYNC_INTERVAL - interval in which to perform a full sync of the keeper registry - default 30 min
  • KEEPER_MINIMUM_REQUIRED_CONFIRMATIONS - minimum number of confirmations before processing keeper logs - default 12
  • KEEPER_MAXIMUM_GRACE_PERIOD - maximum number of blocks to wait after performing upkeep before resuming regular checks - default 100

Start the node

Start the node using chainlink local node

Determine node's ethereum address

If you already know your node's eth address, you can skip this step.

  1. remotely login to your node using chainlink admin login
  2. observe the keys using chainlink keys eth list
  3. Copy the eth address of the key your node will be using for keeper jobs
  4. Make sure your account is funded!

You can also retrieve this information from the operator UI.

Ensure your node is on the keeper registry

Your node's address must have already been added to the keeper registry contract.

Creating a keeper job

Keeper jobs have the following spec format:

type            = "keeper"
schemaVersion   = 1
name            = "example keeper spec"
contractAddress = "0x0000000000000000000000000000000000000000"
fromAddress     = "0x0000000000000000000000000000000000000000"

Call the name whatever you want; contractAddress is the address of the keeper registry; and fromAddress is your node's eth address.

You can only create toml jobs in the operator UI.

Running Keeper

After adding your job, you should start seeing the keeper services synchronize the data from the rgistry and begin checking contracts for upkeep. You will only observe the keeper running by observing the logs. The UI has minimal support for keeper jobs right now.