kleros / corobot

A bot to watch, notify about governor events and execute transactions

Corobot

A Bot to watch for Kleros Governor events and respond with notifications and transactions.

Description

Words in ALL_CAPS are environment variables. See .env.example for more information on them.

This software consists of 6 modules that monitor the state of an instance of Kleros Governor:

1. Execute Approved

Executes approved transactions in the previous session.

2. Emergency Alarm

Monitors submitted lists for the current session. If none of the submitters (WHITELISTED_ADDRESSES) made a submission during the first half of the session, this module will send emails to the watchers (WATCHERS) more and more frequently until either:

• One of the submitters (WHITELISTED_ADDRESSES) submits a list;
• One of the submitters (WHITELISTED_ADDRESSES) disarms the alarm.

3. Pass Period

If the submission period of the current session is over is not marked as disputed, the bot will submit a transaction to execute submissions:

• If no one made a submission, it will move the governor to the next session.
• If there is only one submitted list, it will mark it as approved and move the contract to the next session.
• If there is more than one submission, it will raise a dispute.

4. Alarm UI

The Alarm UI allows the submitters to disarm the alarm for the current session. A web3 enabled browser is required.

Prerequisites

• Tested on NodeJS version 11

Get Started

1. Clone this repo.
2. Duplicate .env.example, rename it to .env and fill in the environment variables.
3. Run yarn to install dependencies and then yarn start to run the service in development mode.

To run the service in production mode use yarn production.

To start with PM2 use pm2 start yarn --name corobot --interpreter bash -- production

Other Scripts

• yarn format - Lint, fix and prettify all the project. .js files with styled components and .js files.
• yarn run cz - Run commitizen.

Contributing

See CONTRIBUTING.md.

corobot's Issues

Use double the suggested gas price when submitting a list

Only submit a list if none of team addresses submitted

Authenticate disarm robot.

Include whitelisted addresses in the warning emails

Add more information to the Low on ETH email

The bot should give more context on what the low on ETH email means:

• Why does it need ETH?
• How much does it need?
• What happens if it drops below what limit?

New Feature: Gentle New Session notification

• The bot should send out a gentle (not frightening) notifying that a new session has just started and request a that a new list be submitted.

Corobot 2.0: Update to reflect latest contract version

Changes from the review affect when transactions can be executed and period duration math. We need a new version for the next deployment of the governor.

Don't request a submission when passing periods, instead monitor.

Bot improvements

• Bot should not watch for one, but a list of addresses.
• Add a simple UI to "disarm" the alarm. A white listed should be allowed to click it.
• At the end of the submission period, if no one submitted, the bot should send an empty list.
• The bot should also call executeTransactionList()

Expand README to better describe how the bot works

Deactivating the alarm should also prevent the bot from submitting a list

Corobot 2.0 should have a separate list to notify of new sessions.

Currently, all watchers will receive a notification when a new session of the governor starts.

• Actually, watchers should only receive an email if the main submitter fails.
• Notify only the main submitter when a new session starts.