{"id":23107824,"url":"https://github.com/kleros/corobot","last_synced_at":"2025-04-03T22:44:08.633Z","repository":{"id":43975905,"uuid":"247708052","full_name":"kleros/corobot","owner":"kleros","description":"A bot to watch, notify about governor events and execute transactions","archived":false,"fork":false,"pushed_at":"2023-01-06T02:44:20.000Z","size":993,"stargazers_count":0,"open_issues_count":7,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-22T16:51:04.744Z","etag":null,"topics":["backend","governor","notifications"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kleros.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-16T13:22:38.000Z","updated_at":"2024-04-09T23:28:55.000Z","dependencies_parsed_at":"2023-02-05T03:46:14.104Z","dependency_job_id":null,"html_url":"https://github.com/kleros/corobot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleros%2Fcorobot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleros%2Fcorobot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleros%2Fcorobot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleros%2Fcorobot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kleros","download_url":"https://codeload.github.com/kleros/corobot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247092373,"owners_count":20882217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","governor","notifications"],"created_at":"2024-12-17T01:16:14.448Z","updated_at":"2025-04-03T22:44:08.604Z","avatar_url":"https://github.com/kleros.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cb style=\"font-size: 32px;\"\u003eCorobot\u003c/b\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://standardjs.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\" alt=\"JavaScript Style Guide\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://conventionalcommits.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\" alt=\"Conventional Commits\"\u003e\u003c/a\u003e\n  \u003ca href=\"http://commitizen.github.io/cz-cli/\"\u003e\u003cimg src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\" alt=\"Commitizen Friendly\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\u003cimg src=\"https://img.shields.io/badge/styled_with-prettier-ff69b4.svg\" alt=\"Styled with Prettier\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA Bot to watch for Kleros Governor events and respond with notifications and transactions.\n\n## Description\n\n\u003e Words in ALL_CAPS are environment variables. See [`.env.example`](.env.example) for more information on them.\n\nThis software consists of 6 modules that monitor the state of an instance of Kleros Governor:\n\n### 1. Execute Approved\nExecutes approved transactions in the previous session.\n\n### 2. Emergency Alarm\nMonitors 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:\n- One of the submitters (WHITELISTED_ADDRESSES) submits a list;\n- One of the submitters (WHITELISTED_ADDRESSES) disarms the alarm.\n\n### 3. Pass Period\nIf the submission period of the current session is over is not marked as disputed, the bot will submit a transaction to execute submissions:\n- If no one made a submission, it will move the governor to the next session.\n- If there is only one submitted list, it will mark it as approved and move the contract to the next session.\n- If there is more than one submission, it will raise a dispute.\n\n### 4. Alarm UI\nThe Alarm UI allows the submitters to disarm the alarm for the current session. A web3 enabled browser is required.\n\n## Prerequisites\n\n- Tested on NodeJS version 11\n\n## Get Started\n\n1.  Clone this repo.\n2.  Duplicate `.env.example`, rename it to `.env` and fill in the environment variables.\n3.  Run `yarn` to install dependencies and then `yarn start` to run the service in development mode.\n\n\u003e To run the service in production mode use `yarn production`.\n\n\u003e To start with PM2 use `pm2 start yarn --name corobot --interpreter bash -- production`\n\n## Other Scripts\n\n- `yarn format` - Lint, fix and prettify all the project.\n.js files with styled components and .js files.\n- `yarn run cz` - Run commitizen.\n\n## Contributing\n\nSee CONTRIBUTING.md.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleros%2Fcorobot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkleros%2Fcorobot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleros%2Fcorobot/lists"}