Keep4r is a fork of the Keep3rV1 — a decentralized keeper network for projects that need external devops and for external teams to find keeper jobs.

3 min readOct 30, 2020

Introduction

This Docs has been forked and modified by the keep4r team from keep3r.network. We are still updating and improving the documentation.

Keep4r Network is a decentralized keeper network for projects that need external devops and for external teams to find keeper jobs

Keepers

A Keeper is the term used to refer to an external person and/or team that executes a job. This can be as simplistic as calling a transaction — usually a smart-contract call, or as complex as requiring extensive off-chain logic. The scope of Keep4r allows users register contracts as jobs for keepers, and keepers to register themselves as available to perform jobs. It is up to the individual keeper to set up their devops and infrastructure and create their own rules based on what transactions they deem profitable.

Jobs

A Job is the term used to refer to a smart contract that wishes an external entity to perform an action. They would like the action to be performed in “good will” and not have a malicious result. For this reason they register as a job, and keepers can then execute on their contract.

Becoming a Keeper

To join as a Keeper you call bond(uint) on the Keep4r contract. You do not need to deposit any DAI or ETH tokens to join as a Keeper, so you can join with bond(0). There is a 1 day bonding delay before you can activate as a Keeper. Once the 7 days have passed, you can call activate(). Once activated you lastJob timestamp will be set to the current block timestamp.

Registering a Job

A job can be any system that requires external execution, the scope of Keep4r is not to define or restrict the action taken, but to create an incentive mechanism for all parties involved. There are two cores ways to create a Job;

Registering a Job via Governance

If you prefer, you can register as a job by simply submitting a proposal via Governance, to include the contract as a job. If governance approves, no further steps are required.

Registering a Job via Contract

WIP — We are working on better ways to register jobs via the job factory interface

Job Interface

Some contracts require external event execution, an example for this is the harvest() function in the yearn ecosystem, or the update(address,address) function in the uniquote ecosystem. These normally require a restricted access control list, however these can be difficult for fully decentralized projects to manage, as they lack devops infrastructure.

These interfaces can be broken down into two types, no risk delta (something like update(address,address) in uniquote, which needs to be executed, but not risk to execution), and harvest() in yearn, which can be exploited by malicious actors by front-running deposits.

For no, or low risk executions, you can simply call Keep4r.isKeeper(msg.sender) which will let you know if the given actor is a keeper in the network.

For high, sensitive, or critical risk executions, you can specify a minimum bond, minimum jobs completed, and minimum Keeper age required to execute this function. Based on these 3 limits you can define your own trust ratio on these keepers.

So a function definition would look as follows;

function execute() external { require(Keep4r.isKeeper(msg.sender), "Keep4r not allowed"); }

At the end of the call, you simply need to call workReceipt(address,uint) to finalize the execution for the keeper network. In the call you specify the keeper being rewarded, and the amount of KP4R you would like to award them with. This is variable based on what you deem is a fair reward for the work executed.

Forked from keep3r

Example Keep4rJob

interface UniOracleFactory {
    function update(address tokenA, address tokenB) external;
}interface Keep4r {
    function isKeeper(address) external view returns (bool);
    function workReceipt(address keeper, uint amount) external;
}contract Keep4rJob {
    UniOracleFactory constant JOB = UniOracleFactory(0x61da8b0808CEA5281A912Cd85421A6D12261D136);
    KP4RJobV1 constant kp4rJobV1 = Keep4r(0x9696Fea1121C938C861b94FcBEe98D971de54B32);    function update(address tokenA, address tokenB) external {
        require(kp4rJobV1.isKeeper(msg.sender), "Keep4rJob::update: not a valid keeper");
        JOB.update(tokenA, tokenB);
        kp4rJobV1.workReceipt(msg.sender, 1e18);
    }
}