warp-keeper

Overview

Warp keeper is a set of bots that monitor the jobs in warp protocol and execute or evict them when certain conditions are met.

For a detailed overview on what is warp and how does the keeper work, please refer to the overview doc.

Usage

1. Start your own full node or have access to a remote one, it is highly recommended to run your own node to minimize latency as the executable job is executed in a first come first win manner.
2. Create a .env file, copy the content from .example.env, MNEMONIC_KEY is the key that holds fund for the keeper. You can enter your sentry key to receive alert when the bot crash, you can also enable skip to bid your execution / eviction tx.
   1. You can adjust the MIN_REWARD value, in principal we would rather set it too high than too low, to avoid reward not able to cover tx fee.
3. Create a warp account, you can do it on the UI by following the guide.
4. Start docker, then run yarn start-warp-keeper-in-docker, this will run everything (redis, collector, monitor and executor) in docker.
5. Congrats! You are doing your part to make Warp protocol awesome! Watch out for any email alert from sentry in case the bot crash.

Caution

This bot DOES NOT guarantee to make you profit, as job execution is first come first get reward, because jobs on blockchain are transparent to everyone it's very possible you try to execute a job at the same time as someone else, and the other bot beat you first to the chain, in this case you still spend the tx fee but get no reward.

Although this bot should be working at this point, I'm still tuning it to add proper error handling and try to make it more efficient and profitable.

Feel free to reach me on twitter for any questions or feedbacks.