Ocean Mining Pool

Ocean pool worker collects mining pool statistics from Ocean.xyz, providing hashrate, earnings, and worker status data.

Install the Ocean Mining Pool

1. Clone the Repository

Use the same working directory for all the workers.

Inside your working directory, run the following command to clone the (miningos-wrk-minerpool-ocean) repository:

git clone https://github.com/tetherto/miningos-wrk-minerpool-ocean.git

After cloning the repository, move into its directory:

cd miningos-wrk-minerpool-ocean

2. Install Dependencies

Inside the miningos-wrk-minerpool-ocean directory, run the following command to install dependencies using npm:

npm ci

3. Generate Configuration Files

Next, run the following script to scan the config/ directory, copy each .example file into an active configuration file by removing the .example suffix.

sh setup-config.sh

4. Configure the Worker

After generating the configuration files, edit the files in the config/ directory to match your environment:

common.json - Worker-wide settings including worker identity

This worker connects to the Ocean.xyz API to fetch mining pool statistics.

5. Enable Debugging and Start the Worker

You can now start the worker by running the following command:

DEBUG="miningos:*" pm2 -s start worker.js --name 'ocean-1' -- --wtype wrk-minerpool-rack-ocean --env development --rack rack-1

6. Start Mock Server (Development Only)

For development and testing without connecting to Ocean.xyz, use the mock server:

DEBUG="miningos:*" pm2 -s start mock/server.js --name 'mock-ocean-1' -- --env development --port 4029

Mock servers are useful for testing the worker without connecting to the actual mining pool API.