Skip to content
Provide pro-active alert notifications that will help LPT token holders to be updated and understand how the transcoders are delegating tokens in near real time
JavaScript HTML
Branch: development
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
img
server
test
utils
.babelrc
.editorconfig
.env.example
.eslintignore
.eslintrc
.gitattributes
.gitignore
.istanbul.yml
.prettierrc.json
.travis.yml
API.md
CHANGELOG.md
CODE_OF_CONDUCT.md Create project setup Dec 19, 2018
CONTRIBUTING.md
LICENSE
Procfile
README.md
index.js
index.route.js
package-lock.json
package.json

README.md

Livepeer Backend Notifications

Provide pro-active alert notifications that will help LPT token holders to be updated and understand how the transcoders they are delegating the tokens to are performing in near real time

Build Status Coverage Status contributions welcome MIT licensed

Application

APP Live Version

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

In order to develop livepeer-alerts-backend, you'll need:

Frontend

You can take a look at the frontend right here

Get Started

  • To run server, simply execute $ npm run start
  • To run tests, simply execute $ npm run test

Clone this repository and install npm dependencies:

1) git clone https://github.com/protofire/livepeer-alerts-backend.git
2) cd livepeer-alerts-backend
3) npm install
4) Copy ".env.example" and rename it as ".env"
5) Edit the ".env" file with your SEND_GRID_API_KEY and your MONGO_HOST_URL 
6) npm start

Configuration

  • Copy env example file to run in dev mode: $ cp .env.example .env

Running the tests

1) On the project folder run "npm test"

API

The API is described in details on the API readme.

Built With

Notifications

Livepeer state machine diagram used to send emails.

Notification Sended to Sended at
Delegate claim reward call Delegator, needs to be bonded The subscription and at the beginning of the round
Delegate not claim reward call Delegator, needs to be bonded The subscription and at the beginning of the round
Delegator is in unbonded state Delegator The subscription and at the beginning of the round
Delegator is in unbonding state, notify rounds left to bond Delegator At the beginning of the round
Delegate change the rules Delegator When the delegate change the rules
Delegator is ready to bond Delegator When the status change from pending to bonded
Delegate did reward call Delegate The subscription and at the beginning of the round
Delegate not did reward call Delegate The subscription and at the beginning of the round
Weekly earned LPT Delegator The subscription and after 7 rounds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details

You can’t perform that action at this time.