open-etc-pool-friends

README

Open Source Ethereum Mining Pool PPLNS / SOLO

index page

Donations

• Donate 1% from pool fees to developers (Attention becomes automatic)

• open-etc-pool-friends wallet ETC: 0xd92fa5a9732a0aec36dc8d5a6a1305dc2d3e09e6

Features

Email: office.poolnode@gmail.com

YouTube.

hey come check out Discord with me.

hey come check out Telegram with me.

This pool is being further developed to provide an easy to use pool for Ethereum Classic miners. This software is functional however an optimised release of the pool is expected soon. Testing and bug submissions are welcome!

• Support for HTTP and Stratum mining
• Detailed block stats with luck percentage and full reward
• Failover geth instances: geth high availability built in
• Separate stats for workers: can highlight timed-out workers so miners can perform maintenance of rigs
• JSON-API for stats
• New vue based UI
• Supports Ethereum Classic, Mordor, Ethereum, Ropsten, ubiq

Building on Linux

Dependencies:

• go >= 1.19
• core-geth
• redis-server >= 2.8.0
• nodejs >= 4 LTS
• nginx

Install go lang

 sudo apt-get update && apt-get upgrade
 sudo apt-get install golang
 sudo apt-get install rsync
 sudo apt-get install git
 sudo apt-get install ipset
 sudo ipset create blacklist hash:ip

Install npm

sudo apt-get install npm

Install redis-server

 sudo apt-get install redis-server

It is recommended to bind your DB address on 127.0.0.1 or on internal ip. Also, please set up the password for advanced security!!!

Install nginx

 sudo apt-get install nginx

Search on Google for nginx-setting

Install NODE

See source: https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions

curl to setup the node.js repository in your sources.

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -

Now install node.js. *Note the command name changes in ubuntu, nodejs instead of node. This is to avoid a name conflict with a package called node in ubuntu. sudo apt-get install -y nodejs

Optional (

Install bower. NOTE: Used by https://github.com/adiwg/mdEditor

Warning

npm WARN deprecated bower@1.8.2: ...psst! Your project can stop working at any moment because its dependencies can change. Prevent this by migrating to Yarn: https://bower.io/blog/2017/how-to-migrate-away-from-bower/
/usr/bin/bower -> /usr/lib/node_modules/bower/bin/bower

YOU HAVE BEEN WARNED

sudo npm install -g bower

Run core-geth

I highly recommend to use Ubuntu 20.04 LTS.

1. First install: sudo apt-get install build-essential
2. install sudo apt-get install make
3. install sudo apt-get install git
4. install core-geth.

Run console

New Wallet

./geth account new --datadir /home/pool/classic/.ethereum/

If you use Ubuntu, it is easier to control services by using serviced.

 sudo nano /etc/systemd/system/geth.service

Copy the following example

[Unit]
Description=geth
After=network-online.target

[Service]
ExecStart=/home/pool/core-geth/build/bin/geth --miner.threads=1 --datadir /home/pool/classic/.ethereum/ --syncmode=snap --http --http.api eth,net,web3,txpool,miner --miner.etherbase=0x95f296f317E8E3AFb3DEf009173E77cCe00B5aeC --mine --cache=8000 --maxpeers 100 --password="/home/pool/.pw" --allow-insecure-unlock --http.port "8545" --nat "any" --unlock 0x95f296f317E8E3AFb3DEf009173E77cCe00B5aeC --miner.extradata ys --classic --snapshot=false --port 30305

User=pool

Restart=always
RestartSec=3

[Install]
WantedBy=multi-user.target

Then run core-geth by the following commands

$ sudo systemctl enable geth
$ sudo systemctl start geth

If you want to debug the node command

$ sudo systemctl status geth

Open Firewall

Firewall should be opened to operate this service. Whether Ubuntu firewall is basically opened or not, the firewall should be opened based on your situation. You can open firewall by opening 80,443,8008,30305.

Clone & compile:

git clone https://github.com/yuriy0803/open-etc-pool-friends.git
cd open-etc-pool-friends

go build

Install Frontend

Modify configuration file

 nano ~/open-etc-pool-friends/www/config/environment.js

Make some modifications in these settings.

ApiUrl: '//your-pool-domain/',
HttpHost: 'http://your-pool-domain',
StratumHost: 'your-pool-domain',
PoolFee: '1%',

The frontend is a single-page Ember.js application that polls the pool API to render miner stats.

Running Pool

./open-etc-pool-friends api.json

Building Frontend

Install nodejs. I suggest using LTS version >= 4.x from https://github.com/nodesource/distributions or from your Linux distribution or simply install nodejs on Ubuntu Xenial 16.04.

NOTE: at this point keep your nodejs version <= 19.x.

The frontend is a single-page Ember.js application that polls the pool API to render miner stats.

cd www

Change ApiUrl: '//example.net/' in www/config/environment.js to match your domain name. Also don't forget to adjust other options.

Install deps

 sudo npm install -g ember-cli@2.18
 sudo npm install -g bower
 sudo chown -R $USER:$GROUP ~/.npm
 sudo chown -R $USER:$GROUP ~/.config
 npm install
 bower install
 ember install ember-truth-helpers
 npm install jdenticon@2.1.0

Build.

 chmod 755 build.sh
./build.sh

Run Pool api.json

It is required to run pool by serviced. If it is not, the terminal could be stopped, and pool doesn’t work.

 sudo nano /etc/systemd/system/api.service

Copy the following example

[Unit]
Description=api
After=network-online.target

[Service]
ExecStart=/home/pool/open-etc-pool-friends/open-etc-pool-friends /home/pool/open-etc-pool-friends/api.json

User=pool

Restart=always
RestartSec=3

[Install]
WantedBy=multi-user.target

Then run api by the following commands

 sudo systemctl enable api
 sudo systemctl start api

If you want to debug the node command

 sudo systemctl status api

As you can see above, the frontend of the pool homepage is created. Then, move to the directory, www, which services the file.

Set up nginx.

 sudo nano /etc/nginx/sites-available/default

Modify based on configuration file.

# Default server configuration
# nginx example

upstream api {
    server 127.0.0.1:8080;
}

server {
    listen 80 default_server;
    listen [::]:80 default_server;
    root /var/www/etc2pool;

    # Add index.php to the list if you are using PHP
    index index.html index.htm index.nginx-debian.html;

    server_name _;

    location / {
            # First attempt to serve request as file, then
            # as directory, then fall back to displaying a 404.
            try_files $uri $uri/ =404;
    }

    location /api {
            proxy_pass http://127.0.0.1:8080;
    }

}

After setting nginx is completed, run the command below.

 sudo service nginx restart

Status all.

 sudo journalctl -f 

Customization

You can customize the layout using built-in web server with live reload:

ember server --port 8082 --environment development

Don't use built-in web server in production.

Check out www/app/templates directory and edit these templates in order to customise the frontend.

Configuration

Configuration is actually simple, just read it twice and think twice before changing defaults.

Don't copy config directly from this manual. Use the example config from the package, otherwise you will get errors on start because of JSON comments.

{
  // Set to the number of CPU cores of your server
  "threads": 2,
  // Prefix for keys in redis store
  "coin": "etc",
  // Give unique name to each instance
  "name": "main",
  // shares or (solo "pplns": 0,)
  "pplns": 9000,
   // mordor, classic, ethereum, ropsten or ubiq, etica,
   //  ethereumPow, ethereumFair, expanse, octaspace, canxium, universal
  "network": "classic",
  // etchash, ethash, ubqhash
  "algo": "etchash",
  // exchange api coingecko
  "coin-name":"etc",
  
  "proxy": {
    "enabled": true,

    // Bind HTTP mining endpoint to this IP:PORT
    "listen": "0.0.0.0:8888",

    // Allow only this header and body size of HTTP request from miners
    "limitHeadersSize": 1024,
    "limitBodySize": 256,

    /* Set to true if you are behind CloudFlare (not recommended) or behind http-reverse
      proxy to enable IP detection from X-Forwarded-For header.
      Advanced users only. It's tricky to make it right and secure.
    */
    "behindReverseProxy": false,

    // Stratum mining endpoint
    "stratum": {
      "enabled": true,
      // Bind stratum mining socket to this IP:PORT
      "listen": "0.0.0.0:8008",
      "timeout": "120s",
      "maxConn": 8192,
      "tls": false,
      "certFile": "/path/to/cert.pem",
      "keyFile": "/path/to/key.pem"
    },

    // Try to get new job from node in this interval
    "blockRefreshInterval": "120ms",
    "stateUpdateInterval": "3s",
    // Require this share difficulty from miners
    "difficulty": 2000000000,

    /* Reply error to miner instead of job if redis is unavailable.
      Should save electricity to miners if pool is sick and they didn't set up failovers.
    */
    "healthCheck": true,
    // Mark pool sick after this number of redis failures.
    "maxFails": 100,
    // TTL for workers stats, usually should be equal to large hashrate window from API section
    "hashrateExpiration": "3h",

    "policy": {
      "workers": 8,
      "resetInterval": "60m",
      "refreshInterval": "1m",
      //blacklist Wallet for miners
      "blacklist_file" : "/home/pool/open-etc-pool-friends/stratum_blacklist.json",

      "banning": {
        "enabled": false,
        /* Name of ipset for banning.
        Check http://ipset.netfilter.org/ documentation.
        */
        "ipset": "blacklist",
        // Remove ban after this amount of time
        "timeout": 1800,
        // Percent of invalid shares from all shares to ban miner
        "invalidPercent": 30,
        // Check after after miner submitted this number of shares
        "checkThreshold": 30,
        // Bad miner after this number of malformed requests
        "malformedLimit": 5
      },
      // Connection rate limit
      "limits": {
        "enabled": false,
        // Number of initial connections
        "limit": 30,
        "grace": "5m",
        // Increase allowed number of connections on each valid share
        "limitJump": 10
      }
    }
  },

  // Provides JSON data for frontend which is static website
  "api": {
    "enabled": true,
    "listen": "0.0.0.0:8080",
    // Collect miners stats (hashrate, ...) in this interval
    "statsCollectInterval": "5s",
    // Purge stale stats interval
    "purgeInterval": "10m",
    // Fast hashrate estimation window for each miner from it's shares
    "hashrateWindow": "30m",
    // Long and precise hashrate from shares, 3h is cool, keep it
    "hashrateLargeWindow": "3h",
    // Collect stats for shares/diff ratio for this number of blocks
    "luckWindow": [64, 128, 256],
    // Max number of payments to display in frontend
    "payments": 50,
    // Max numbers of blocks to display in frontend
    "blocks": 50,

    /* If you are running API node on a different server where this module
      is reading data from redis writeable slave, you must run an api instance with this option enabled in order to purge hashrate stats from main redis node.
      Only redis writeable slave will work properly if you are distributing using redis slaves.
      Very advanced. Usually all modules should share same redis instance.
    */
    "purgeOnly": false
  },

  // Check health of each node in this interval
  "upstreamCheckInterval": "5s",

  /* List of parity nodes to poll for new jobs. Pool will try to get work from
    first alive one and check in background for failed to back up.
    Current block template of the pool is always cached in RAM indeed.
  */
  "upstream": [
    {
      "name": "main",
      "url": "http://127.0.0.1:8545",
      "timeout": "10s"
    },
    {
      "name": "backup",
      "url": "http://127.0.0.2:8545",
      "timeout": "10s"
    }
  ],

  // This is standard redis connection options
  "redis": {
    // Where your redis instance is listening for commands
    "endpoint": "127.0.0.1:6379",
    "poolSize": 10,
    "database": 0,
    "password": "",
        "sentinelEnabled": false,
        "masterName": "mymaster",
        "sentinelAddrs": [
            "127.0.0.1:26379",
            "127.0.0.1:26389",
            "127.0.0.1:26399"
        ]
	},

  "exchange": {
    "enabled": true,
     "url": "https://api.coingecko.com/api/v3/coins/markets?vs_currency=usd&ids=ethereum-classic",
     "timeout": "50s",
     "refreshInterval": "900s"
    },

  // This module periodically remits ether to miners
  "unlocker": {
    "enabled": false,
    // Pool fee percentage
    "poolFee": 1.0,
    // Pool fees beneficiary address (leave it blank to disable fee withdrawals)
    "poolFeeAddress": "",
    // Donate 10% from pool fees to developers
    "donate": true,
    // Unlock only if this number of blocks mined back
    "depth": 120,
    // Simply don't touch this option
    "immatureDepth": 20,
    // Keep mined transaction fees as pool fees
    "keepTxFees": false,
    // Run unlocker in this interval
    "interval": "10m",
    // Parity node rpc endpoint for unlocking blocks
    "daemon": "http://127.0.0.1:8545",
    // Rise error if can't reach parity
    "timeout": "10s",
    // london hard fork ON or OFF
    "isLondonHardForkEnabled": false
  },

  // Pay out miners using this module
  "payouts": {
    "enabled": false,
    // Require minimum number of peers on node
    "requirePeers": 25,
    // Run payouts in this interval
    "interval": "12h",
    // Parity node rpc endpoint for payouts processing
    "daemon": "http://127.0.0.1:8545",
    // Rise error if can't reach parity
    "timeout": "10s",
    // Address with pool balance
    "address": "0x0",
    // Let parity to determine gas and gasPrice
    "autoGas": true,
    // Sends as EIP1559 TX
    "maxPriorityFee": "2000000000",
    // Gas amount and price for payout tx (advanced users only)
    "gas": "21000",
    "gasPrice": "50000000000",
    // Send payment only if miner's balance is >= 0.5 Ether
    "threshold": 500000000,
    // Perform BGSAVE on Redis after successful payouts session
    "bgsave": false
  }
}

If you are distributing your pool deployment to several servers or processes, create several configs and disable unneeded modules on each server. (Advanced users)

I recommend this deployment strategy:

• Mining instance - 1x (it depends, you can run one node for EU, one for US, one for Asia)
• Unlocker and payouts instance - 1x each (strict!)
• API instance - 1x

Notes

• Unlocking and payouts are sequential, 1st tx go, 2nd waiting for 1st to confirm and so on. You can disable that in code. Carefully read docs/PAYOUTS.md.
• Also, keep in mind that unlocking and payouts will halt in case of backend or node RPC errors. In that case check everything and restart.
• You must restart module if you see errors with the word suspended.
• Don't run payouts and unlocker modules as part of mining node. Create separate configs for both, launch independently and make sure you have a single instance of each module running.
• If poolFeeAddress is not specified all pool profit will remain on coinbase address. If it specified, make sure to periodically send some dust back required for payments.

Mordor

To use this pool on the mordor testnet two settings require changing to "mordor"

network in your config.json (this sets backend (validation,unlocker) to mordor paramaters) APP.Network in your www/config/environment.js (this sets the frontend to mordor paramaters) rerun ./build.sh

Extra) How To Secure the pool frontend with Let's Encrypt (https)

First, install the Certbot's Nginx package with apt-get

 sudo apt-get update
 sudo apt-get install python3-certbot-nginx

And then open your nginx setting file, make sure the server name is configured!

 sudo nano /etc/nginx/sites-available/default
. . .
server_name <your-pool-domain>;
. . .

Change the _ to your pool domain, and now you can obtain your auto-renewaled ssl certificate for free!

 sudo certbot --nginx -d <your-pool-domain>

Now you can access your pool's frontend via https! Share your pool link!