P2Pool Node Setup

This guide describes how to set up a GoByte P2Pool node to manage a pool of miners. Unlike centralized mining pools, P2Pool is based on the same peer-2-peer (P2P) model as GoByte, making the pool as a whole highly resistant to malicious attacks, and preserving and protecting the decentralized nature of GoByte. When you launch a P2Pool node, it seeks out, connects with, and shares data with a decentralized network of other P2Pool nodes (also known as peers). P2Pool nodes share a cryptographic chain of data representing value, similar to GoByte’s blockchain. The P2Pool version is called the sharechain. The decentralized and fair nature of this mining model means mining with P2Pool is strongly encouraged. P2Pool for GoByte uses the p2pool-gobyte software on GitHub, which is a fork of p2pool for Bitcoin. For more information, see here.

Because of the way P2Pool manages difficulty adjustments on the sharechain, it is important to maintain low latency between the miners and the P2Pool node to avoid miners submitting shares too late to enter the sharechain. When setting up your node, you need to consider its physical and network location relative to the miners you intend to connect to the node. If you operate a mining farm, your P2Pool node should probably be a physical machine on the same local network as your miners. If you plan to operate a public node, it may be best to set up your P2Pool node as a virtual machine in a data center with a high speed connection so geographically close miners can mine to your pool with relatively low latency.

This following section describes the steps to setup an Ubuntu Server running P2Pool for GoByte. It has been tested with Ubuntu 18.04 LTS and GoByte While a reasonable effort will be made to keep it up to date, it should be possible to modify the instructions slightly to support different versions or operating systems as necessary.

Setting up the host server

Download a copy of Ubuntu Server LTS from https://www.ubuntu.com/download/server and install it on your system according to the steps described here. If you are using a VPS such as Vultr or AWS, your provider will most likely provide an option to install this system during provisioning. Ensure you enable OpenSSH server during setup so you can control your server from a remote console. Once you have access to your server, create a new non-root user if you have not already done so using the following command, replacing <username> with a username of your choice:

adduser <username>

You will be prompted for a password. Enter and confirm using a new password (different to your root password) and store it in a safe place. You will also see prompts for user information, but this can be left blank. Once the user has been created, we will add them to the sudo group so they can perform commands as root:

usermod -aG sudo <username>

Reboot your server and log in as the new user. At this point it is recommended to connect remotely using PuTTY (for Windows) or ssh (for Linux and macOS) if you have not already done so.

Setting up port forwarding

If you are on a private network behind a router, you will need to set up port forwarding for at least port 8999 (UDP/TCP) for access to the sharechain, as well as port 7903 (UDP/TCP) if you want your node to be accessible to the public. How this is done depends on your particular network router and is therefore beyond the scope of this documentation. An example from the popular DD-WRT open source router distribution is shown below. Guides to setting up port forwarding can be found here and here.

Take note of your IP address either from your router management interface or by visiting https://www.whatismyip.com


Setting up port forwarding under DD-WRT

Option 1: Automated script setup

GoByte community member sirbond has generously donated a script to automatically deploy everything required to run a p2pool-gobyte node under Ubuntu Server 16.04 and higher. For more details, see this forum post, or simply follow these instructions to get the script. To get fetch the script and get started, type:

sudo apt install git
git clone https://github.com/gobytecoin/p2pool-gobyte-deploy

The files will be created in the p2pool-gobyte-deploy folder. We now need to configure a few variables specific to your system:

nano ./p2pool-gobyte-deploy/p2pool.deploy.sh

Scroll down to the section labeled #Variables and enter the following information, replacing the <xxx> placeholders after the = sign. Note that it may also be necessary to update the GBX_WALLET_URL, GBX_WALLET_ZIP and GBX_WALLET_LOCAL values if they do not match the current version of GoByte:

  • PUBLIC_IP = your public IP address from the previous step
  • EMAIL = your email address
  • PAYOUT_ADDRESS = your GBX wallet address to receive fees
  • USER_NAME = linux user name
  • RPCUSER = enter a random alphanumeric rpc user name
  • RPCPASSWORD = enter a random alphanumeric rpc password

Press Ctrl + X to close the editor and Y and Enter save the file. Then run the script:

bash ./p2pool-gobyte-deploy/p2pool.deploy.sh

The script will carry out all steps necessary to set up P2pool on Ubuntu Server and start gobyted synchronisation. When setup is complete, you should see a message reading Installation Completed. You can now run a second script to start p2pool-gobyte:

bash ~/p2pool.start.sh

Your P2Pool node is now running. If you see errors similar to Error getting work from gobyted or -10 GoByte Core is downloading blocks… then you must wait until GoByte finishes synchronisation. Once this is done, you can point your miners to <ip_address>:7903 to begin mining.


Example configuration showing a single miner connected to a p2pool-gobyte node on the local network

Option 2: Manual setup

First update your operating system as follows:

sudo apt update
sudo apt upgrade

Setting up gobyted

P2Pool requires a full GoByte node to be running to get block and transaction data. To download and install GoByte, visit https://www.gobyte.network/downloads on your computer to find the link to the latest GoByte Core wallet. Click Linux, then right-click on Download TGZ for GoByte Core x64 and select Copy link address. Go back to your terminal window and enter the following command, pasting in the address to the latest version of GoByte Core by right clicking or pressing Ctrl + V:

cd ~
wget https://github.com/gobytecoin/gobyte/releases/download/v0.12.2.4/GoByteCore-

Verify the integrity of your download by running the following command and comparing the output against the value for the file as shown on the GoByte website under Hash File:

sha256sum GoByteCore-

Link to the hash file to verify download integrity

Create a working directory for GoByte, extract the compressed archive, copy the necessary files to the directory and set them as executable:

mkdir .gobytecore
tar xfvz GoByteCore-
cp GoByteCore- .gobytecore/
cp GoByteCore- .gobytecore/

Clean up unneeded files:

rm GoByteCore-
rm -r GoByteCore-

Create a configuration file using the following command:

nano ~/.gobytecore/gobyte.conf

An editor window will appear. We now need to create a configuration file specifying several variables. Copy and paste the following text to get started, then replace the variables specific to your configuration as follows:


Replace the fields marked with XXXXXXX as follows:

  • rpcuser: enter any string of numbers or letters, no special characters allowed
  • rpcpassword: enter any string of numbers or letters, no special characters allowed

The result should look something like this:


Entering key data in gobyte.conf on the P2Pool node

Press Ctrl + X to close the editor and Y and Enter save the file. You can now start running GoByte on the masternode to begin synchronization with the blockchain:


You will see a message reading GoByte Core server starting. You can continue with the following steps and check synchronization periodically using the following command. Synchronization is complete when the number of blocks is equal to the current number of blocks in the GoByte blockchain, as can be seen from any synchronized GoByte wallet or block explorer:

~/.gobytecore/gobyte-cli getblockcount

Setting up P2Pool

We will now set up the P2Pool software and its dependencies. Begin with the dependencies:

sudo apt install python-zope.interface python-twisted python-twisted-web python-dev gcc g++ git

Create working directories and set up p2pool-gobyte:

mkdir git
cd git
git clone https://github.com/gobytecoin/p2pool-gobyte
cd p2pool-gobyte
git submodule init
git submodule update
cd gobyte_hash
python setup.py install --user

We will add some optional extra interfaces to the control panel:

cd ..
mv web-static web-static.old
git clone https://github.com/justino/p2pool-ui-punchy web-static
mv web-static.old web-static/legacy
cd web-static
git clone https://github.com/hardcpp/P2PoolExtendedFrontEnd ext

You can now start p2pool and optionally specify the payout address, external IP (if necessary), fee and donation as follows:

python ~/git/p2pool-gobyte/run_p2pool.py --external-ip <public_ip> -f <fee> --give-author <donation> -a <payout_address>

You can then monitor your node by browsing to the following addresses, replacing <ip_address> with the IP address of your P2Pool node:


Example configuration showing a single Bitmain Antminer D3 connected to a p2pool-gobyte node on the local network