Run a Stratum Proxy

​

Introduction

Here, we’ll be installing go-quai-stratum, the Go implementation of the stratum proxy on Quai Network. This tutorial is focused on Linux Distributions and MacOS systems.

Prefer a video tutorial? Check out a video walkthrough on setting up a stratum proxy here:

​

Environment Setup

For the simplest installation process, we recommend installing and running go-quai-stratum on the same computer that you’re running go-quai. Running go-quai-stratum on a separate computer is only recommended for advanced users as it requires additional networking configuration.

​

Install Dependencies

To run an instance of go-quai-stratum, you’ll need to install a few dependencies. You can install dependencies with your favorite package manager (apt, brew, etc.).

  # install snapd if you don't have it already
  sudo apt install snapd

  # install go
  sudo snap install go --classic

# install git and make
sudo apt install git make g++

git clone https://github.com/dominant-strategies/go-quai-stratum
cd go-quai-stratum

git checkout put-latest-release-here

git checkout v01.2.3-rc.4

​

Configuration

To run the Quai stratum proxy, you’ll need to do some minor configuration. Start by copying the example configuration file to a local configuration file:

cp config/config.example.json config/config.json

This will copy the example config and create a new config file within the config directory. Within the newly created config.json file, you’ll be able to configure networking settings and other relevant variables:

​

Running the Proxy

​

Build

Before running the proxy, we need to build the source. You can build via Makefile by running the following command:

make go-quai-stratum

​

Run

Now that we’ve built the source, we can start our proxy. We recommend using a process manager like tmux to run the proxy as background service.

To run the proxy, you’ll need to select a shard to run against.

Start the proxy by changing REGION-NAME and ZONE-NAME to the corresponding or chain names for the region and zone your node is running.

./build/bin/go-quai-stratum --region=REGION-NAME --zone=ZONE-NAME

Available options for REGION-NAME and ZONE-NAME can be found below. You must select a corresponding region and zone, e.g. cyprus and cyprus1.

The proxy by default listens for miner connections on the 3333 port. You can change the port the proxy listens on by passing it in with the --stratum flag in the run command if you’d like.

./build/bin/go-quai-stratum --region=REGION-NAME --zone=ZONE-NAME --stratum=LISTENING-PORT

The proxy should begin streaming logs to the terminal that look similar to below.

INFO   [10-02|14:56:20.718] Loading config                                path=config/config.json
2024/10/02 14:56:20 Set policy stats reset every 1h0m0s
2024/10/02 14:56:20 Set policy state refresh every 1m0s
2024/10/02 14:56:20 Running with 8 policy workers
WARNING[10-02|14:56:20.720] Invalid ethash caches in memory, defaulting to 1  requested=0
INFO   [10-02|14:56:20.736] Connected to Prime at:  ws://127.0.0.1:8001
INFO   [10-02|14:56:20.740] Connected to Region at:  ws://127.0.0.1:8002
INFO   [10-02|14:56:20.748] Connected to Zone at:  ws://127.0.0.1:8200
INFO   [10-02|14:56:20.748] Set block refresh every 1s
INFO   [10-02|14:56:20.751] New block to mine on cyprus1 at height [1 1 1]
INFO   [10-02|14:56:20.751] Sealhash: 0xb3168a87b94f47b4b57b0686b405a72475dca0b8691c76b80a0500091b5608d1
INFO   [10-02|14:56:20.751] Starting proxy on 0.0.0.0:0
2024/10/02 14:56:20 Broadcasting block 1 to 0 stratum miners
2024/10/02 14:56:20 Stratum listening on 0.0.0.0:3333

To stop the proxy, use CTRL+C in your terminal.

After configuring and pointing your proxy at a shard, you’re now ready to point a GPU miner at it and start mining.