Code Monkey home page Code Monkey logo

pool's Introduction

ADAMANT Forging Pool

Read more about Forging, delegates, Fair dPoS, and how to run your Forging pool

This software is a successor of outdated v2 Forging pool


Calculate and transfer voters’ rewards automatically.

  • 🌈 Easy to install
  • 🀝 Reliable, uses decentralized network advantages
  • πŸ› οΈ Customizable (using config file)
  • πŸ“œ History stored in local files (powered by lowdb)
  • πŸš€ Minimum server requirements: 1 vCPU and 512 MB of RAM
  • πŸͺš You can setup the pool on a separate machine without a node
  • πŸ“ˆ Dashboard for voters with mobile version support
  • πŸ”” Notification system via ADAMANT or Slack for admin

Installation

Requirements

  • NodeJS v16+ (already installed if you have a node on your machine)

Setup

Clone the repository with pool into a newly created directory:

git clone https://github.com/Adamant-im/pool

Move to directory with the cloned repository:

cd pool

Install dependencies using npm or any other package manager:

npm install

Build a website:

npm run build:web

Pre-launch tuning

Copy default config as config.jsonc:

cp config.default.jsonc config.jsonc

And edit that file by inserting the pool's secret phrase as the minimum configuration, e.g. using nano:

nano config.jsonc

See comments in config.default.jsonc for more parameters.

Migration from v2

To migrate a database from v2 run the migration script with the specified path to the target pool or database:

# or ~/adamant-pool/db
$ node scripts/migrate.mjs ~/adamant-pool

Launching

You can start the pool using npm command:

npm run start

but we recommend to use a process manager to start the pool, f.e. pm2:

pm2 start ./scripts/start.sh --name "adamantpool"

Add pool to cron

Edit crontab file using the command below:

crontab -e

and paste the string:

@reboot cd /home/adamant/pool && pm2 start /home/adamant/pool/scripts/start.sh --name "adamantpool"

Contribution

Please have a look at the CONTRIBUTING.md

pool's People

Contributors

adamant-al avatar martiliones avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

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.