skypool-nimiq-miner - GitLite

KO | EN

gitlite — search

#javascript #python #react #llm #golang #android #rust #docker #nodejs #java #cli #awesome-list #mcp #openai

skypool-nimiq-miner

(★ 57)

Nimiq CPU/GPU miner for skypool.xyz :hammer::hammer::hammer:

File Explorer

Download Latest Version (.zip)

- cpuid.h
- detectCPU.cc
- package.json
- proxy.js
- proxy_config.txt
- readme.md
.gitignore
binding.gyp
CHANGELOG
config.txt
CPUType.js
h-config.sh
index.js
LICENSE
Miner.js
package-lock.json
package.json
Protocol.js
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/skypool-org/skypool-nimiq-miner

Downloads the entire project code from GitHub to your computer.

cd skypool-nimiq-miner

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

3. Install `yarn` globally: `sudo npm install -g yarn`.

Downloads and installs the libraries listed in package.json.

4. Install `gulp` globally: `yarn global add gulp`.

Type this command into your terminal and run it.

6. Build the project: `cd skypool-nimiq-miner && yarn`.

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Skypool Nimiq Miner

This is [Skypool](https://nimiq.skypool.org) Nimiq Miner Client, using self-designed Nimiq mining protocol which is different to official p2p mining protocol, Skypool mining protocol get block data from server directly, which is more effieciency in bad netowork environment and need less client network bandwidth.

**Note** : Skypool Nimiq Miner is only compatible with Skypool Nimiq Servers, the server code is not open source.

Download Skypool Nimiq Mining Client in [release](https://github.com/skypool-org/skypool-nimiq-miner/releases).

In the release page, different version for different CPU instruction set to get the best hashrate:
* extreme --> avx512f
* fast --> avx2
* normal --> avx
* compat --> non-avx

## Usage
``` bash
node index.js --address=<address> [--name=<name>] [--thread=<thread>] [--server=<server>] [--percent=<percent>] [--cpu=<cpu>]
```

## Building by Yourself

1. Install [Node.js](https://nodejs.org) v8.0.0 or higher.
2. On Ubuntu and Debian, install `git` and `build-essential`: `sudo apt-get install -y git build-essential`.
    - On other Linux systems, install `git`, `python2.7`, `make`, `gcc` and `gcc-c++`.
    - For MacOS or Windows, [check here for git](https://git-scm.com/downloads) and [here for compilation tools](https://github.com/nodejs/node-gyp#on-mac-os-x).
3. Install `yarn` globally: `sudo npm install -g yarn`.
4. Install `gulp` globally:  `yarn global add gulp`.
5. Clone this repository: `git clone https://github.com/skypool-org/skypool-nimiq-miner`.
6. Build the project: `cd skypool-nimiq-miner && yarn`.
7. Config `config.txt`, Run `node index.js`.

---

# Skypool Nimiq Proxy
[Step by step tutorial for using proxy](https://github.com/skypool-org/skypool-nimiq-miner/wiki/Proxy-tutorial)

## Why to use proxy
* Use Proxy if the Skypool nodes are blocked by cloud providers, e.g., Google Cloud Platform
* You can also hide your mining address on miner side, and set it on the proxy side
* Start proxy on an unblocked cloud server, e.g., AWS, so the proxy can connect to Skypool nodes
* Configure the blocked cloud server miners to proxy, so these miners can mine nimiq now

## Usage
1. Download Skypool Nimiq Proxy in [release](https://github.com/skypool-org/skypool-nimiq-miner/releases).
2. Start Proxy on an unblocked cloud server, with a public ip (for example, `1.2.3.4`)
3. Configure the Skypool Nimiq Miner's config file, and change `server` value to `"server": "ws://1.2.3.4:8080",`
4. Start mining now, you can see logs in proxy to see the number of connected miners
``` bash
node index.js --proxyServerPort=<proxyServerPort> --server=<server> [--miningAddress=<miningAddress>]
```

## Build by yourself
1. Install [Node.js](https://nodejs.org/) v8.0.0 or higher.
2. Build the project: `cd skypool-nimiq-miner/proxy && yarn`.
3. Config `proxy_config.txt`, you can find usage and example in this file
4. Run `node proxy.js` to start proxy
5. Config the miner config file `config.txt`, change `server` value to the proxy url, e.g., `"server": "ws://localhost:8080",`
6. Start mining clients to start mining with proxy