Giter Site home page Giter Site logo

gtcr-action-bot's Introduction

GeneralizedTCR Action Bot

JavaScript Style Guide Conventional Commits Commitizen Friendly

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

  • 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-<network> -- start:<network>, replacing network with the network name.

Example for xDai: pm2 start yarn --interpreter bash --name gab-xdai -- start:xdai

Contributing

See CONTRIBUTING.md.

gtcr-action-bot's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gtcr-action-bot's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.