scash-nodejs-pool

Mining pool software for Satoshi Cash (SCASH) written in Node.js: a stratum server for Scash's RandomX with share checking, block building from the node's block template, block accounting through the pool wallet, and batch payouts. It is a fork of cryptonote-nodejs-pool by Dvandal (GNU GPL v2) and of its adaptations epic-nodejs-pool, veil-nodejs-pool, qwc-nodejs-pool and c64-nodejs-pool, written for the Bitcoin Core based node and wallet RPC of Scash. Live example: https://scash.pool-pay.com.

What it does

• Stratum server (plain TCP and TLS ports, XMRig protocol with the algo extension): the pool asks the node for a block template (getblocktemplate), builds the block itself (coinbase with the BIP34 height, an extranonce and the SegWit witness commitment, merkle root, the 112 byte Scash header) and gives every miner the header with its own nonce start and a share target that follows the miner's hashrate (vardiff, remembered across reconnects). It checks every share itself with a small C++ helper (hasher/rxhash --scash): the RandomX hash and the RandomX commitment of the header, using the RandomX library of the Scash node. A share that meets the network target is submitted to the node as a whole block with submitblock.
• Scash proof of work (see the Scash protocol spec): RandomX 1.2.1 with the Argon2 salt RandomX-Scash, key = SHA256d(Scash/RandomX/Epoch/<time / 7 days>), input = the 112 byte header (nonce at byte 76, hashRandomX zero), the block is valid when the RandomX commitment is not above the target and the header carries the hash. The algorithm is rx/scash in poolpayminer.
• Accounts are native SegWit addresses (scash1q..., 45 characters, bech32 checksum verified), optionally +worker, with a reward mode prefix prop: (shared, default) or solo:.
• Rewards: PROP with time weighting (slush) or SOLO.
• Block unlocker: a block is settled after depth blocks (Scash's coinbase maturity is 100). The reward is what the pool wallet received in the block's coinbase transaction (gettransaction); a block that is no longer on the chain is marked orphaned and nothing is credited.
• Payment processor: everyone who is due is paid in one sendmany transaction per round (the network fee is shared by the paid miners or paid by the pool). The balance is debited before sending; a batch whose outcome is unknown (crash, timeout) is found again in the wallet by its comment and never sent twice; refused or stuck batches go back to the balances. Dry-run mode, a whitelist for rehearsals and an emergency brake (deployment/pause-payments.sh).
• Website and API: a ready website (website_example/) with the dashboard and its four graphs, blocks, payments, top miners, worker statistics, a "Getting started" page with a config generator, and the public read-only JSON API.
• Protection against connection floods: limits per IP, a login deadline, an optional IP allow list, banning of miners with many invalid shares.
• Tests (test/): the hashing is checked against real Scash mainnet blocks (test/test-real-blocks.js), a simulated node lets a real RandomX miner find shares and blocks against the pool code, and test/test-scash-regtest.js runs the whole chain against a real scashd on regtest: the block built by the pool must be accepted by the node.

Developer donation (please read)

The pool takes a developer donation from the reward of every block it finds, before the miners' shares are computed. It is configured in config.json (see config_examples/scash.json):

"blockUnlocker": {
  "poolFee": 1,
  "donations": { "scash1qnlhxgc3zqeqveurgaqt78efsekgqg7vydyr86w": 0.5 }
}

• poolFee is the fee of the pool operator (percent). donations is a table Scash address -> percent (up to 10% per entry) for the developers of this software; the default is 0.5% to the address of the project's own pool. The donation is paid like any other balance.
• It is included in the "Pool Fee" figure that the pool's website and API show to the miners (as in the original software).
• You are free to change the percentage, the address or to empty the table ("donations": {}): it is your pool and the license is the GPL. Please tell your miners the truth about the fees of your pool.
• This has nothing to do with the miner poolpayminer (a separate project with its own fee).

Installation

See docs/INSTALL.md: the Scash node and wallet (build from source), the RandomX helper, Redis, the pool services (systemd templates in deployment/), the website and the first payout rehearsal.

Requirements: Linux, Node.js 18 or newer, Redis, a Scash node (scashd 2.0.0 / Bitcoin Core 27 based) synchronised with the network, a C++ compiler for the helper and the node's RandomX library, a web server for the website and a TLS certificate for the TLS stratum ports.

Miners

poolpayminer (Windows and Linux, free, has its own fee) knows the algorithm rx/scash. Example: poolpayminer -a rx/scash --tls -o scash.pool-pay.com:5051 -u scash1qYourAddress+rigname -p x -k.

Tests

npm install
node test/test-account.js                 # address handling, needs nothing else
make -C hasher RANDOMX=/path/to/prefix    # the node's depends/<host> directory has include/randomx.h and lib/librandomx.a
node test/test-real-blocks.js             # the hash and commitment of real mainnet blocks, needs only the helper
# The others use test/config.test.json and a THROWAWAY Redis on port 16379 (they flush it, never point them at a real database):
redis-server --port 16379 --requirepass CHANGE_ME_REDIS_PASSWORD --save "" --appendonly no &
node test/test-scash-pool.js              # simulated node + pool + a miner that really mines
node test/test-scash-payments.js          # unlocker and payments against a simulated node and wallet
node test/test-scash-regtest.js           # a real scashd on regtest accepts a block built by the pool (MINER_BIN=<poolpayminer> also mines with the real miner)

Money warning

The payment processor moves real coins. Rehearse first: "dryRun": true, then a whitelist (onlyAccounts) with a few small payouts of your own, then enable it. A transaction that has been sent to the network can not be cancelled. Keep the wallet backup (listdescriptors true) and the RPC password private.

License and credits

GNU GPL v2 (see LICENSE). Based on cryptonote-nodejs-pool, Copyright (c) Dvandal and contributors. Scash and RandomX are separate programs and are not included.