https://github.com/kleros/gtcr-action-bot

A bot to watch Generalized TCR contracts and call functions on behalf of users
https://github.com/kleros/gtcr-action-bot

backend curated-list generalized-curated-list

Last synced: about 1 month ago
JSON representation

A bot to watch Generalized TCR contracts and call functions on behalf of users

• Host: GitHub
• URL: https://github.com/kleros/gtcr-action-bot
• Owner: kleros
• License: mit
• Created: 2020-04-14T19:47:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-04T13:32:46.000Z (8 months ago)
• Last Synced: 2024-06-04T15:17:54.110Z (8 months ago)
• Topics: backend, curated-list, generalized-curated-list
• Language: TypeScript
• Homepage:
• Size: 900 KB
• Stars: 1
• Watchers: 10
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  GeneralizedTCR Action Bot





  

  

  



This bot watches a GTCR Factory contract and all GTCR contracts spawned from it. It is a convenience tool and does primarily two things:

- Detects submissions that passed the challenge period and executes them for the user.

- Detects pending crowdfunding rewards that were not withdrawn, and withdraws them for the user.

## Prerequisites

We recommend using [volta](https://volta.sh/)

- Tested on NodeJS version 14.

## 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

## Production

1. Create a `.env` file with the name of the network you wish to use. Example `.env.xdai`.

2. Look into `package.json` for the appropriate script (e.g. start:xdai). Create one if it does not yet exist.

3. Use PM2 like so: `pm2 start yarn --interpreter bash --name gtcr-action-bot- -- start:`, replacing `network` with the network name.

Example for xDai:

`pm2 start yarn --interpreter bash --name gab-xdai -- start:xdai`

## Contributing

See CONTRIBUTING.md.