High performance Stratum poolserver in Node.js. One instance of this software can startup and manage multiple coin pools, each with their own daemon and stratum port :)
Notice
This is a module for Node.js that will do nothing on its own. Unless you're a Node.js developer who would like to handle stratum authentication and raw share data then this module will not be of use to you. For a full featured portal that uses this module, see Cryptocurrency Pool Server. It handles payments, website front-end, database layer, mutli-coin/pool support, auto-switching miners between coins/pools, etc.. The portal also has an MPOS compatibility mode so that the it can function as a drop-in-replacement for python-stratum-mining.
Why
This server was built to be more efficient and easier to setup, maintain and scale than existing stratum poolservers which are written in python. Compared to the spaghetti state of the latest stratum-mining python server, this software should also have a lower barrier to entry for other developers to fork and add features or fix bugs.
Features
- Daemon RPC interface
- Stratum TCP socket server
- Block template / job manager
- P2P to get block notifications as peer node
- Optimized generation transaction building
- Connecting to multiple daemons for redundancy
- Process share submissions
- Session managing for purging DDoS/flood initiated zombie workers
- Auto ban IPs that are flooding with invalid shares
- PoW (proof-of-work) & PoS (proof-of-stake) support
- Transaction messages support
- Vardiff (variable difficulty / share limiter)
- When started with a coin deamon that hasn't finished syncing to the network it shows the blockchain download progress and initializes once synced
Hashing algorithms supported:
- ✓ SHA256 (Bitcoin, Freicoin, Peercoin/PPCoin, Terracoin, etc..)
- ✓ Scrypt (Litecoin, Dogecoin, Feathercoin, etc..)
- ✓ Scrypt-Jane (YaCoin, CopperBars, Pennies, Tickets, etc..)
- ✓ Scrypt-N (Vertcoin [VTC])
- ✓ Quark (Quarkcoin [QRK])
- ✓ X11 (Darkcoin [DRK], Hirocoin, Limecoin)
- ✓ X13 (MaruCoin, BoostCoin)
- ✓ NIST5 (Talkcoin)
- ✓ Keccak (Maxcoin [MAX], HelixCoin, CryptoMeth, Galleon, 365coin, Slothcoin, BitcointalkCoin)
- ✓ Skein (Skeincoin [SKC])
- ✓ Groestl (Groestlcoin [GRS])
- ✓ Blake (Blakecoin [BLC])
- ✓ Fugue (Fuguecoin [FC])
- ✓ Qubit (Qubitcoin [Q2C], Myriadcoin [MYR])
- ✓ SHAvite-3 (INKcoin [INK])
- ✓ Sha1 (Sha1coin [SHA], Yaycoin [YAY])
Requirements
- node v12.10.3+
- coin daemon (preferably one with a relatively updated API and not some crapcoin :p)
Example Usage
Install as a node module by cloning repository
git clone https://github.com/AoD-Technologies/cryptocurrency-stratum-pool node_modules/cryptocurrency-stratum-poolnpm update
Module usage
Create the configuration for your coin:
Possible options for algorithm
: sha256, scrypt, scrypt-jane, scrypt-n, quark, x11, keccak, blake,
skein, groestl, fugue, shavite3, hefty1, qubit, or sha1.
var myCoin = "name": "Dogecoin" "symbol": "DOGE" "algorithm": "scrypt" "nValue": 1024 //optional - defaults to 1024 "rValue": 1 //optional - defaults to 1 "txMessages": false //optional - defaults to false, "coinbase": "MyFunPool" // So explorers can see who mined the block /* Magic value only required for setting up p2p block notifications. It is found in the daemon source code as the pchMessageStart variable. For example, litecoin mainnet magic: http://git.io/Bi8YFw And for litecoin testnet magic: http://git.io/NXBYJA */ "peerMagic": "fbc0b6db" //optional "peerMagicTestnet": "fcc1b7dc" //optional;
If you are using the scrypt-jane
algorithm there are additional configurations:
var myCoin = "name": "Freecoin" "symbol": "FEC" "algorithm": "scrypt-jane" "chainStartTime": 1375801200 //defaults to 1367991200 (YACoin) if not used "nMin": 6 //defaults to 4 if not used "nMax": 32 //defaults to 30 if not used;
If you are using the scrypt-n
algorithm there is an additional configuration:
var myCoin = "name": "Execoin" "symbol": "EXE" "algorithm": "scrypt-n" /* This defaults to Vertcoin's timetable if not used. It is required for scrypt-n coins that have modified their N-factor timetable to be different than Vertcoin's. */ "timeTable": "2048": 1390959880 "4096": 1438295269 "8192": 1485630658 "16384": 1532966047 "32768": 1580301436 "65536": 1627636825 "131072": 1674972214 "262144": 1722307603 ;
If you are using the keccak
algorithm there are additional configurations (The rare normalHashing
keccak coins
such as Copperlark and eCoin don't appear to work yet - only the popular ones like Maxcoin are):
var myCoin = "name": "eCoin" "symbol": "ECN" "algorithm": "keccak" /* This is not required and set to false by default. Some coins such as Copperlark and eCoin require it to be set to true. Maxcoin and most others are false. */ "normalHashing": true;
Create and start new pool with configuration options and authentication function
var Stratum = ; var pool = Stratum;
Listen to pool events
/* 'data' object contains: job: 4, //stratum work job ID ip: '71.33.19.37', //ip address of client port: 3333, //port of the client worker: 'matt.worker1', //stratum worker name height: 443795, //block height blockReward: 5000000000, //the number of satoshis received as payment for solving this block difficulty: 64, //stratum worker difficulty shareDiff: 78, //actual difficulty of the share blockDiff: 3349, //block difficulty adjusted for share padding blockDiffActual: 3349 //actual difficulty for this block //AKA the block solution - set if block was found blockHash: '110c0447171ad819dd181216d5d80f41e9218e25d833a2789cb8ba289a52eee4', //Exists if "emitInvalidBlockHashes" is set to true blockHashInvalid: '110c0447171ad819dd181216d5d80f41e9218e25d833a2789cb8ba289a52eee4' //txHash is the coinbase transaction hash from the block txHash: '41bb22d6cc409f9c0bae2c39cecd2b3e3e1be213754f23d12c5d6d2003d59b1d, error: 'low share difficulty' //set if share is rejected for some reason*/pool; /*'severity': can be 'debug', 'warning', 'error''logKey': can be 'system' or 'client' indicating if the error was caused by our system or a stratum client*/pool;
Start pool
poolstart;
Credits
- Invader444 - lead developer
- The NOMP developers
Donations
To support development of this project feel free to donate :)
- AUR:
AStZjnHVZeeMu6qSefmfFf2hcTrw1D4PTV
- BTC:
1HTNmSPrPzWDXiQKHqGGmwxvWpo92861We
- BCH:
qz37lsgu585sthyvj03wdnylzj697utezs09sqr8s6
- BOOT:
RKrEC2DN85DEAVGnPKFMT2kwBop7W8SgtH
- BSV:
16pw6eWNQ543djFGPFhWTupKn6DAFybsYj
- BTCV:
3Cc2odLwAPMb8in6DtzYcaz7VteMHCdCWS
- DASH:
XptCKDUpStArP6WriH1EqUFkG7X4EB5QVb
- DGB:
DNvszcyDbQbSJ6aFGXCc4adSXoXjtFSXYs
- DOGE:
DEiAhRD6ACGeEHPAhKT4W4WiUN6Q85BK83
- LTC:
LQg8JcRgHUST9D2pD6fXXSCRsF9jD3GdWK
- LCC:
CJRx4ps1B8f3fByneiAg7oycEMtTtbFkG2
- LCNT:
Lfe93Y8mC1ueKpHtWw2Kp6APoLQs3GpGpF
- RVN:
RMTcqUJnzSTMZW825eP77yDxhcCuW3xVyy
- SHND:
SZjpJRp5rmD83NmaStVJpn4NkfmwM52Jnw
- VTC:
3KxFSn2hw7G61QyheKLYR5sffR6ErKJNys
- VRSC:
RRb1GeiDcbAGMJQrckCcFSnKj9rZDUVJ4y
- XVG:
D5Xzq6edmskQBVHUZuzvCbuAg1f8gPU2bo
- ZEN:
znhHi2eiRAQhzekktTqdjDBCeb3L2QkuHjf
- ZER:
t1R3enmEZj8rVsUG19sznLSkCRFFj4vEcVM
License
Released under the GNU General Public License v3