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 or screen to run the proxy.

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

Start the proxy by passing either the corresponding web socket ports or chain names for the region and zone you’ve selected to run. Run with chain names using this command:

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

Or to run with ports use:

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

Available options for REGION-NAME, ZONE-NAME, REGION-PORT, and ZONE-PORT can be found below. You must select a corresponding region and zone, i.e. paxos and paxos3 or hydra and hydra2.

If you’re running a version of go-quai-stratum prior to v0.9.0-rc.0, you’ll need to pass in the corresponding web socket ports as chain names are not supported prior to this version.

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.

WARN[0000] One ethash cache must always be in memory requested=0
2023/09/06 13:47:17 main.go:45: Loading config: 0x14000032970
2023/09/06 13:47:17 main.go:84: Running with 4 threads
2023/09/06 13:47:17 policy.go:80: Set policy stats reset every 1h0m0s
2023/09/06 13:47:17 policy.go:84: Set policy state refresh every 1m0s
2023/09/06 13:47:17 policy.go:100: Running with 8 policy workers
WARN[0000] One ethash cache must always be in memory requested=0
2023/09/06 13:47:17 proxy.go:104: Set block refresh every 120ms
2023/09/06 13:47:17 stratum.go:38: Stratum listening on 0.0.0.0:3333
2023/09/06 13:47:17 proxy.go:294: New block to mine on Zone at height [1 1 1]
2023/09/06 13:47:17 proxy.go:295: Sealhash: 0xc4a31a763af09272a5da7f237978f5e0ead1e409c1e19a034ff8e40e7d727561
2023/09/06 13:47:17 proxy.go:228: Starting proxy on 0.0.0.0:0
2023/09/06 13:47:17 stratum.go:280: Broadcasting new job to 0 stratum miners

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.