Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kleros/low-balance-bot

Watche Ethereum addresses and notify if its balance falls below some threashold.
https://github.com/kleros/low-balance-bot

backend kleros platform

Last synced: about 1 month ago
JSON representation

Watche Ethereum addresses and notify if its balance falls below some threashold.

Awesome Lists containing this project

README

        


Low Balance Bot


JavaScript Style Guide
Conventional Commits
Commitizen Friendly
Styled with Prettier

This bot watches Ethereum addresses and sends out email notifications if they fall below a threshold.

## Description

> Words in ALL_CAPS are environment variables. See [`.env.example`](.env.example) for more information on them.

Thi bot will periodically query every address in WALLETS, and if notify if any one falls below a threshold.

## 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 `node -r dotenv/config index.js`.

> To start with PM2 use `pm2 start --node-args="-r dotenv/config" index.js --name low-balance-bot`

> If switching networks, remember to clean the database with `yarn clean`.

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