cryptonote-nodejs-pool

High performance Node.js (with native C addons) mining pool for CryptoNote based coins. Comes with lightweight example front-end script which uses the pool's REST API with modern fetch() calls. Support for Cryptonight (Original, Monero v7, Stellite v7), Cryptonight Light (Original, Aeon v7, IPBC) and Cryptonight Heavy (Sumokoin) algorithms.

Acknowledgment: This project is based on the original work by Daniel Vandal (dvandal). We are grateful for his contributions to the CryptoNote mining pool ecosystem. This fork includes modernizations and updates for compatibility with current Node.js and Redis versions. Please refer to the License section for compliance information.

Features

Optimized pool server

TCP (stratum-like) protocol for server-push based jobs
- Compared to old HTTP protocol, this has a higher hash rate, lower network/CPU server load, lower orphan block percent, and less error prone
Support for Cryptonight (Original, Monero v7, Stellite v7), Cryptonight Light (Original, Aeon v7, IPBC) and Cryptonight Heavy (Sumokoin) algorithms.
IP banning to prevent low-diff share attacks
Socket flooding detection
Share trust algorithm to reduce share validation hashing CPU load
Clustering for vertical scaling
Ability to configure multiple ports - each with their own difficulty
Miner login (wallet address) validation
Workers identification (specify worker name as the password)
Variable difficulty / share limiter
Set fixed difficulty on miner client by passing "address" param with "+[difficulty]" postfix
Modular components for horizontal scaling (pool server, database, stats/API, payment processing, front-end)
SSL support for both pool and API servers
RBPPS (PROP) payment system

Live statistics API

Currency network/block difficulty
Current block height
Network hashrate
Pool hashrate
Each miners' individual stats (hashrate, shares submitted, pending balance, total paid, payout estimate, etc)
Blocks found (pending, confirmed, and orphaned)
Historic charts of pool's hashrate, miners count and coin difficulty
Historic charts of users's hashrate and payments

Mined blocks explorer

Mined blocks table with block status (pending, confirmed, and orphaned)
Blocks luck (shares/difficulty) statistics
Universal blocks and transactions explorer based on chainradar.com

Smart payment processing

Splintered transactions to deal with max transaction size
Minimum payment threshold before balance will be paid out
Minimum denomination for truncating payment amount precision to reduce size/complexity of block transactions
Prevent "transaction is too big" error with "payments.maxTransactionAmount" option
Option to enable dynamic transfer fee based on number of payees per transaction and option to have miner pay transfer fee instead of pool owner (applied to dynamic fee only)
Control transactions priority with config.payments.priority (default: 0).
Set payment ID on miner client when using "[address].[paymentID]" login
Integrated payment ID addresses support for Exchanges

Admin panel

Aggregated pool statistics
Coin daemon & wallet RPC services stability monitoring
Log files data access
Users list with detailed statistics

Pool stability monitoring

Detailed logging in process console & log files
Coin daemon & wallet RPC services stability monitoring
See logs data from admin panel

Extra features

An easily extendable, responsive, light-weight front-end using API to display data
Onishin's keepalive function
Support for slush mining system (disabled by default)
E-Mail Notifications on worker connected, disconnected (timeout) or banned (support MailGun, SMTP and Sendmail)
Telegram channel notifications when a block is unlocked
Top 10 miners report
Multilingual user interface

Usage

Requirements

Coin daemon(s) (find the coin's repo and build latest version from source)
- List of Cryptonote coins
Node.js v18.0+ (updated for modern dependencies)
- For Ubuntu:

curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash
sudo apt-get install -y nodejs

Redis key-value store v2.6+
- For Ubuntu:

sudo add-apt-repository ppa:chris-lea/redis-server
sudo apt-get update
sudo apt-get install redis-server

libssl required for the node-multi-hashing module
- For Ubuntu: sudo apt-get install libssl-dev
Boost is required for the cryptoforknote-util module
- For Ubuntu: sudo apt-get install libboost-all-dev
libsodium is required for the cryptoforknote-util module
- For Ubuntu: sudo apt-get install libsodium-dev

Seriously

Those are legitimate requirements. If you use old versions of Node.js or Redis that may come with your system package manager then you will have problems. Follow the linked instructions to get the last stable versions.

Redis warning: It'sa good idea to learn about and understand software that you are using - a good place to start with redis is data persistence.

Do not run the pool as root : create a new user without ssh access to avoid security issues :

sudo adduser --disabled-password --disabled-login your-user

To login with this user :

sudo su - your-user

1) Downloading & Installing

Clone the repository and run npm install for all the dependencies to be installed. The postinstall script will automatically patch bigint-buffer with a safe implementation:

git clone https://github.com/dvandal/cryptonote-nodejs-pool.git pool
cd pool

npm install

Note on Security: This pool uses a pure JavaScript Base58 implementation (lib/safe-base58.js) that eliminates the need for base58-native and its bignum dependency. The implementation uses native BigInt with proper bounds checking and has zero native dependencies.

Note on Remaining Vulnerabilities: npm audit may still report vulnerabilities in bigint-buffer and bignum:

bigint-buffer: Automatically patched during installation with a safe native BigInt implementation (see patches/ directory). The patch eliminates the buffer overflow vulnerability. This is required transitively by cryptonight-hashing.
bignum: Required transitively by native modules (cryptoforknote-util). All versions are affected, but we use the latest version (0.13.1) and it's only used internally by native C++ addons with controlled inputs for block processing operations.

2) Configuration

Copy the config_examples/COIN.json file of your choice to config.json then overview each options and change any to match your preferred setup.

Explanation for each field:

/* Pool host displayed in notifications and front-end */
"poolHost": "your.pool.host",

/* Used for storage in redis so multiple coins can share the same redis instance. */
"coin": "graft",

/* Used for front-end display */
"symbol": "GRFT",

/* Minimum units in a single coin, see COIN constant in DAEMON_CODE/src/cryptonote_config.h */
"coinUnits": 10000000000,

/* Number of coin decimals places for notifications and front-end */
"coinDecimalPlaces": 4,
  
/* Coin network time to mine one block, see DIFFICULTY_TARGET constant in DAEMON_CODE/src/cryptonote_config.h */
"coinDifficultyTarget": 120,

/* Set daemon type. Supported values: default, forknote (Fix block height + 1), bytecoin (ByteCoin Wallet RPC API) */
"daemonType": "default",

/* Set Cryptonight algorithm settings.
   Supported algorithms: cryptonight (default). cryptonight_light and cryptonight_heavy
   Supported variants for "cryptonight": 
     0 (Original), 
     1 (Monero v7), 
     3 (CryptoNight-GPU / Stellite / XTL / Conceal block v7)
   Supported variants for "cryptonight_light": 0 (Original), 1 (Aeon v7), 2 (IPBC)
   Supported blob types: 0 (Cryptonote), 1 (Forknote v1), 2 (Forknote v2), 3 (Cryptonote v2 / Masari)
   Note: For Conceal coin, use variant 3 (CryptoNight-GPU) for block v7 */
"cnAlgorithm": "cryptonight",
"cnVariant": 3,
"cnBlobType": 0,

/* Logging */
"logging": {

    "files": {

        /* Specifies the level of log output verbosity. This level and anything
           more severe will be logged. Options are: info, warn, or error. */
        "level": "info",

        /* Directory where to write log files. */
        "directory": "logs",

        /* How often (in seconds) to append/flush data to the log files. */
        "flushInterval": 5
    },

    "console": {
        "level": "info",
        /* Gives console output useful colors. If you direct that output to a log file
           then disable this feature to avoid nasty characters in the file. */
        "colors": true
    }
},

/* Modular Pool Server */
"poolServer": {
    "enabled": true,

    /* Set to "auto" by default which will spawn one process/fork/worker for each CPU
       core in your system. Each of these workers will run a separate instance of your
       pool(s), and the kernel will load balance miners using these forks. Optionally,
       the 'forks' field can be a number for how many forks will be spawned. */
    "clusterForks": "auto",

    /* Address where block rewards go, and miner payments come from. */
    "poolAddress": "GBqRuitSoU3PFPBAkXMEnLdBRWXH4iDSD6RDxnQiEFjVJhWUi1UuqfV5EzosmaXgpPGE6JJQjMYhZZgWY8EJQn8jQTsuTit",

    /* This is the integrated address prefix used for miner login validation. */
    "intAddressPrefix": 91,

    /* Poll RPC daemons for new blocks every this many milliseconds. */
    "blockRefreshInterval": 1000,

    /* How many seconds until we consider a miner disconnected. */
    "minerTimeout": 900,

    "sslCert": "./cert.pem", // The SSL certificate
    "sslKey": "./privkey.pem", // The SSL private key
    "sslCA": "./chain.pem" // The SSL certificate authority chain
    
    "ports": [
        {
            "port": 3333, // Port for mining apps to connect to
            "difficulty": 2000, // Initial difficulty miners are set to
            "desc": "Low end hardware" // Description of port
        },
        {
            "port": 4444,
            "difficulty": 15000,
            "desc": "Mid range hardware"
        },
        {
            "port": 5555,
            "difficulty": 25000,
            "desc": "High end hardware"
        },
        {
            "port": 7777,
            "difficulty": 500000,
            "desc": "Cloud-mining / NiceHash"
        },
        {
            "port": 8888,
            "difficulty": 25000,
            "desc": "Hidden port",
            "hidden": true // Hide this port in the front-end
        },
        {
            "port": 9999,
            "difficulty": 20000,
            "desc": "SSL connection",
            "ssl": true // Enable SSL
        }
    ],

    /* Variable difficulty is a feature that will automatically adjust difficulty for
       individual miners based on their hashrate in order to lower networking and CPU
       overhead. */
    "varDiff": {
        "minDiff": 100, // Minimum difficulty
        "maxDiff": 100000000,
        "targetTime": 60, // Try to get 1 share per this many seconds
        "retargetTime": 30, // Check to see if we should retarget every this many seconds
        "variancePercent": 30, // Allow time to vary this % from target without retargeting
        "maxJump": 100 // Limit diff percent increase/decrease in a single retargeting
    },
	
    /* Set difficulty on miner client side by passing <address> param with +<difficulty> postfix */
    "fixedDiff": {
        "enabled": true,
        "separator": "+", // Character separator between <address> and <difficulty>
    },

    /* Set payment ID on miner client side by passing <address>.<paymentID> */
    "paymentId": {
        "addressSeparator": "." // Character separator between <address> and <paymentID>
    },

    /* Feature to trust share difficulties from miners which can
       significantly reduce CPU load. */
    "shareTrust": {
        "enabled": true,
        "min": 10, // Minimum percent probability for share hashing
        "stepDown": 3, // Increase trust probability % this much with each valid share
        "threshold": 10, // Amount of valid shares required before trusting begins
        "penalty": 30 // Upon breaking trust require this many valid share before trusting
    },

    /* If under low-diff share attack we can ban their IP to reduce system/network load. */
    "banning": {
        "enabled": true,
        "time": 600, // How many seconds to ban worker for
        "invalidPercent": 25, // What percent of invalid shares triggers ban
        "checkThreshold": 30 // Perform check when this many shares have been submitted
    },
    
    /* Slush Mining is a reward calculation technique which disincentivizes pool hopping and rewards 'loyal' miners by valuing younger shares higher than older shares. Remember adjusting the weight!
    More about it here: https://mining.bitcoin.cz/help/#!/manual/rewards */
    "slushMining": {
        "enabled": false, // Enables slush mining. Recommended for pools catering to professional miners
        "weight": 300 // Defines how fast the score assigned to a share declines in time. The value should roughly be equivalent to the average round duration in seconds divided by 8. When deviating by too much numbers may get too high for JS.
    }
},

/* Module that sends payments to miners according to their submitted shares. */
"payments": {
    "enabled": true,
    "interval": 300, // How often to run in seconds
    "maxAddresses": 50, // Split up payments if sending to more than this many addresses
    "mixin": 5, // Number of transactions yours is indistinguishable from
    "priority": 0, // The transaction priority    
    "transferFee": 4000000000, // Fee to pay for each transaction
    "dynamicTransferFee": true, // Enable dynamic transfer fee (fee is multiplied by number of miners)
    "minerPayFee" : true, // Miner pays the transfer fee instead of pool owner when using dynamic transfer fee
    "minPayment": 100000000000, // Miner balance required before sending payment
    "maxPayment": null, // Maximum miner balance allowed in miner settings
    "maxTransactionAmount": 0, // Split transactions by this amount (to prevent "too big transaction" error)
    "denomination": 10000000000 // Truncate to this precision and store remainder
},

/* Module that monitors the submitted block maturities and manages rounds. Confirmed
   blocks mark the end of a round where workers' balances are increased in proportion
   to their shares. */
"blockUnlocker": {
    "enabled": true,
    "interval": 30, // How often to check block statuses in seconds

    /* Block depth required for a block to unlocked/mature. Found in daemon source as
       the variable CRYPTONOTE_MINED_MONEY_UNLOCK_WINDOW */
    "depth": 60,
    "poolFee": 0.8, // 0.8% pool fee (1% total fee total including donations)
    "devDonation": 0.2, // 0.2% donation to send to pool dev
    "networkFee": 0.0, // Network/Governance fee (used by some coins like Loki)
    
    /* Some forknote coins have an issue with block height in RPC request, to fix you can enable this option.
       See: https://github.com/forknote/forknote-pool/issues/48 */
    "fixBlockHeightRPC": false
},

/* AJAX API used for front-end website. */
"api": {
    "enabled": true,
    "hashrateWindow": 600, // How many second worth of shares used to estimate hash rate
    "updateInterval": 3, // Gather stats and broadcast every this many seconds
    "bindIp": "0.0.0.0", // Bind API to a specific IP (set to 0.0.0.0 for all)
    "port": 8117, // The API port
    "blocks": 30, // Amount of blocks to send at a time
    "payments": 30, // Amount of payments to send at a time
    "password": "your_password", // Password required for admin stats
    "ssl": false, // Enable SSL API
    "sslPort": 8119, // The SSL port
    "sslCert": "./cert.pem", // The SSL certificate
    "sslKey": "./privkey.pem", // The SSL private key
    "sslCA": "./chain.pem", // The SSL certificate authority chain
    "trustProxyIP": false // Proxy X-Forwarded-For support
},

/* Coin daemon connection details (default port is 18981) */
"daemon": {
    "host": "127.0.0.1",
    "port": 18981
},

/* Wallet daemon connection details (default port is 18980) */
"wallet": {
    "host": "127.0.0.1",
    "port": 18982
},

/* Redis connection info (default port is 6379) */
"redis": {
    "host": "127.0.0.1",
    "port": 6379,
    "auth": null, // If set, client will run redis auth command on connect. Use for remote db
    "db": 0, // Set the REDIS database to use (default to 0)
    "cleanupInterval": 15 // Set the REDIS database cleanup interval (in days)
}

/* Pool Notifications */
"notifications": {
    "emailTemplate": "email_templates/default.txt",
    "emailSubject": {
        "emailAdded": "Your email was registered",
        "workerConnected": "Worker %WORKER_NAME% connected",
        "workerTimeout": "Worker %WORKER_NAME% stopped hashing",
        "workerBanned": "Worker %WORKER_NAME% banned",
        "blockFound": "Block %HEIGHT% found !",
        "blockUnlocked": "Block %HEIGHT% unlocked !",
        "blockOrphaned": "Block %HEIGHT% orphaned !",
        "payment": "We sent you a payment !"
    },
    "emailMessage": {
        "emailAdded": "Your email has been registered to receive pool notifications.",
        "workerConnected": "Your worker %WORKER_NAME% for address %MINER% is now connected from ip %IP%.",
        "workerTimeout": "Your worker %WORKER_NAME% for address %MINER% has stopped submitting hashes on %LAST_HASH%.",
        "workerBanned": "Your worker %WORKER_NAME% for address %MINER% has been banned.",
        "blockFound": "Block found at height %HEIGHT% by miner %MINER% on %TIME%. Waiting maturity.",
        "blockUnlocked": "Block mined at height %HEIGHT% with %REWARD% and %EFFORT% effort on %TIME%.",
        "blockOrphaned": "Block orphaned at height %HEIGHT% :(",
        "payment": "A payment of %AMOUNT% has been sent to %ADDRESS% wallet."
    },
    "telegramMessage": {
        "workerConnected": "Your worker _%WORKER_NAME%_ for address _%MINER%_ is now connected from ip _%IP%_.",
        "workerTimeout": "Your worker _%WORKER_NAME%_ for address _%MINER%_ has stopped submitting hashes on _%LAST_HASH%_.",
        "workerBanned": "Your worker _%WORKER_NAME%_ for address _%MINER%_ has been banned.",
        "blockFound": "*Block found at height* _%HEIGHT%_ *by miner* _%MINER%_*! Waiting maturity.*",
        "blockUnlocked": "*Block mined at height* _%HEIGHT%_ *with* _%REWARD%_ *and* _%EFFORT%_ *effort on* _%TIME%_*.*",
        "blockOrphaned": "*Block orphaned at height* _%HEIGHT%_ *:(*",
        "payment": "A payment of _%AMOUNT%_ has been sent."
    }
},

/* Email Notifications */
"email": {
    "enabled": false,
    "fromAddress": "your@email.com", // Your sender email
    "transport": "sendmail", // The transport mode (sendmail, smtp or mailgun)
    
    // Configuration for sendmail transport
    // Documentation: http://nodemailer.com/transports/sendmail/
    "sendmail": {
        "path": "/usr/sbin/sendmail" // The path to sendmail command
    },
    
    // Configuration for SMTP transport
    // Documentation: http://nodemailer.com/smtp/
    "smtp": {
        "host": "smtp.example.com", // SMTP server
        "port": 587, // SMTP port (25, 587 or 465)
        "secure": false, // TLS (if false will upgrade with STARTTLS)
        "auth": {
            "user": "username", // SMTP username
            "pass": "password" // SMTP password
        },
        "tls": {
            "rejectUnauthorized": false // Reject unauthorized TLS/SSL certificate
        }
    },
    
    // Configuration for MailGun transport
    "mailgun": {
        "key": "your-private-key", // Your MailGun Private API key
        "domain": "mg.yourdomain" // Your MailGun domain
    }
},

/* Telegram channel notifications.
   See Telegram documentation to setup your bot: https://core.telegram.org/bots#3-how-do-i-create-a-bot */
"telegram": {
    "enabled": false,
    "botName": "", // The bot user name.
    "token": "", // The bot unique authorization token
    "channel": "", // The telegram channel id (ex: BlockHashMining)
    "channelStats": {
        "enabled": false, // Enable periodical updater of pool statistics in telegram channel
        "interval": 5 // Periodical update interval (in minutes)
    },
    "botCommands": { // Set the telegram bot commands
        "stats": "/stats", // Pool statistics
         "enable": "/enable", // Enable telegram notifications
        "disable": "/disable" // Disable telegram notifications
    }    
},

/* Monitoring RPC services. Statistics will be displayed in Admin panel */
"monitoring": {
    "daemon": {
        "checkInterval": 60, // Interval of sending rpcMethod request
        "rpcMethod": "getblockcount" // RPC method name
    },
    "wallet": {
        "checkInterval": 60,
        "rpcMethod": "getbalance"
    }
},

/* Prices settings for market and price charts */
"prices": {
    "source": "cryptonator", // Exchange (supported values: cryptonator, altex, crex24, cryptopia, stocks.exchange, tradeogre)
    "currency": "USD" // Default currency
},
	    
/* Collect pool statistics to display in frontend charts  */
"charts": {
    "pool": {
        "hashrate": {
            "enabled": true, // Enable data collection and chart displaying in frontend
            "updateInterval": 60, // How often to get current value
            "stepInterval": 1800, // Chart step interval calculated as average of all updated values
            "maximumPeriod": 86400 // Chart maximum periods (chart points number = maximumPeriod / stepInterval = 48)
        },
        "miners": {
            "enabled": true,
            "updateInterval": 60,
            "stepInterval": 1800,
            "maximumPeriod": 86400
        },
        "workers": {
            "enabled": true,
            "updateInterval": 60,
            "stepInterval": 1800,
            "maximumPeriod": 86400
        },
        "difficulty": {
            "enabled": true,
            "updateInterval": 1800,
            "stepInterval": 10800,
            "maximumPeriod": 604800
        },
        "price": {
            "enabled": true,
            "updateInterval": 1800,
            "stepInterval": 10800,
            "maximumPeriod": 604800
        },
        "profit": {
            "enabled": true,
            "updateInterval": 1800,
            "stepInterval": 10800,
            "maximumPeriod": 604800
        }

    },
    "user": { // Chart data displayed in user stats block
        "hashrate": {
            "enabled": true,
            "updateInterval": 180,
            "stepInterval": 1800,
            "maximumPeriod": 86400
        },
        "payments": { // Payment chart uses all user payments data stored in DB
            "enabled": true
        }
    },
    "blocks": {
        "enabled": true,
        "days": 30 // Number of days displayed in chart (if value is 1, display last 24 hours)
    }
}

3) Start the pool

node init.js

The file config.json is used by default but a file can be specified using the -config=file command argument, for example:

node init.js -config=config_backup.json

This software contains four distinct modules:

pool - Which opens ports for miners to connect and processes shares
api - Used by the website to display network, pool and miners' data
unlocker - Processes block candidates and increases miners' balances when blocks are unlocked
payments - Sends out payments to miners according to their balances stored in redis

By default, running the init.js script will start up all four modules. You can optionally have the script start only start a specific module by using the -module=name command argument, for example:

node init.js -module=api

Example screenshot of running the pool in single module mode with tmux.

To keep your pool up, on operating system with systemd, you can create add your pool software as a service.
Use this example to create the systemd service /lib/systemd/system/cryptonote-nodejs-pool.service Then enable and start the service with the following commands :

sudo systemctl enable cryptonote-nodejs-pool.service
sudo systemctl start cryptonote-nodejs-pool.service

4) Host the front-end

Simply host the contents of the website_example directory on file server capable of serving simple static files.

Edit the variables in the website_example/config.js file to use your pool's specific configuration. Variable explanations:

/* Must point to the API setup in your config.json file. */
var api = "http://poolhost:8117";

/* Pool server host to instruct your miners to point to (override daemon setting if set) */
var poolHost = "poolhost.com";

/* Number of coin decimals places (override daemon setting if set) */
"coinDecimalPlaces": 4,

/* Contact email address. */
var email = "support@poolhost.com";

/* Pool Telegram URL. */
var telegram = "https://t.me/YourPool";

/* Pool Discord URL */
var discord = "https://discordapp.com/invite/YourPool";

/* Market stat display params from https://www.cryptonator.com/widget */
var marketCurrencies = ["{symbol}-BTC", "{symbol}-USD", "{symbol}-EUR", "{symbol}-CAD"];

/* Used for front-end block links. */
var blockchainExplorer = "http://chainradar.com/{symbol}/block/{id}";

/* Used by front-end transaction links. */
var transactionExplorer = "http://chainradar.com/{symbol}/transaction/{id}";

/* Any custom CSS theme for pool frontend */
var themeCss = "themes/light.css";

/* Default language */
var defaultLang = 'en';

5) Customize your website

The following files are included so that you can customize your pool website without having to make significant changes to index.html or other front-end files thus reducing the difficulty of merging updates with your own changes:

custom.css for creating your own pool style
custom.js for changing the functionality of your pool website

Then simply serve the files via nginx, Apache, Google Drive, or anything that can host static content.

SSL

You can configure the API to be accessible via SSL using various methods. Find an example for nginx below:

Using SSL api in config.json:

By using this you will need to update your api variable in the website_example/config.js. For example:
var api = "https://poolhost:8119";

Inside your SSL Listener, add the following:

location ~ ^/api/(.*) {
    proxy_pass http://127.0.0.1:8117/$1$is_args$args;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

By adding this you will need to update your api variable in the website_example/config.js to include the /api. For example:
var api = "http://poolhost/api";

You no longer need to include the port in the variable because of the proxy connection.

Using his own subdomain, for example api.poolhost.com:

server {
    server_name api.poolhost.com
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    
    ssl_certificate /your/ssl/certificate;
    ssl_certificate_key /your/ssl/certificate_key;

    location / {
        more_set_headers 'Access-Control-Allow-Origin: *';
        proxy_pass http://127.0.01:8117;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_cache_bypass $http_upgrade;
    }
}

By adding this you will need to update your api variable in the website_example/config.js. For example:
var api = "//api.poolhost.com";

You no longer need to include the port in the variable because of the proxy connection.

Wallet Commands from admin Page

The admin panel provides two pages for wallet management:

Wallet OPS

The Wallet OPS page provides direct access to wallet JSON-RPC commands:

Get Status - Retrieves the current wallet status including block count, balance, and synchronization state
Save - Forces the wallet to save its state to disk
Get Transactions - Retrieves transaction history for specified addresses

Wallet Optimization

The Wallet Opt page provides wallet optimization features:

Wallet Balance - View the pool wallet's available balance
Estimate Fusion - Estimate how many outputs can be fused at a given threshold
Send Fusion Transaction - Execute a fusion transaction to combine small outputs into larger ones

Fusion transactions help optimize wallet performance by combining multiple small outputs into fewer, larger outputs. This reduces transaction size and fees for future payments.

Upgrading

When updating to the latest code its important to not only git pull the latest from this repo, but to also update the Node.js modules, and any config files that may have been changed.

Inside your pool directory (where the init.js script is) do git pull to get the latest code.
Remove the dependencies by deleting the node_modules directory with rm -r node_modules.
Run npm install to reinstall all dependencies. The postinstall script will automatically patch bigint-buffer with a secure implementation.
Compare your config.json to the latest example ones in this repo or the ones in the setup instructions where each config field is explained. You may need to modify or add any new changes.

Redis Setup

Redis is critical for storing miner shares, balances, and pool statistics. Proper setup ensures data safety.

1. Install and Run Redis

# Ubuntu/Debian
sudo apt-get install redis-server

# Start and enable Redis
sudo systemctl start redis-server
sudo systemctl enable redis-server

# Verify it's running
redis-cli ping
# Should return: PONG

2. Set Proper Ownership & Access Rights

# Ensure Redis data directory has correct permissions
sudo chown -R redis:redis /var/lib/redis/
sudo chmod 755 /var/lib/redis/

# Verify
ls -la /var/lib/redis/

3. Configure Redis for Data Persistence

Edit /etc/redis/redis.conf to enable both RDB snapshots and AOF logging:

sudo nano /etc/redis/redis.conf

# Add or modify these lines:
# RDB Persistence (periodic snapshots)
save 900 1          # Save after 900 sec if 1 key changed
save 300 10         # Save after 300 sec if 10 keys changed
save 60 10000       # Save after 60 sec if 10000 keys changed

# AOF Persistence (every write logged - recommended for mining pools)
appendonly yes
appendfsync everysec

# Data directory
dir /var/lib/redis/

# Restart Redis to apply changes
sudo systemctl restart redis-server

Verify persistence is enabled:

redis-cli INFO persistence | grep -E "aof_enabled|rdb_last_bgsave_status"
# Should show: aof_enabled:1 and rdb_last_bgsave_status:ok

4. Automated Backups

Setup daily backups:

# Make the backup script executable
chmod +x scripts/backup-redis-pool.sh

# Test the backup
./scripts/backup-redis-pool.sh

# Schedule daily backups at 3 AM
crontab -e
# Add this line:
0 3 * * * /home/YOUR_USER/cryptonote-nodejs-pool/scripts/backup-redis-pool.sh

Backups are stored in ~/backups/redis-pool/ and kept for 7 days.

Restore from backup:

# Stop Redis
sudo systemctl stop redis-server

# Restore files
sudo cp ~/backups/redis-pool/dump_YYYYMMDD_HHMMSS.rdb /var/lib/redis/dump.rdb
sudo cp ~/backups/redis-pool/appendonly_YYYYMMDD_HHMMSS.aof /var/lib/redis/appendonly.aof

# Fix permissions
sudo chown redis:redis /var/lib/redis/*

# Start Redis
sudo systemctl start redis-server

# Verify data is restored
redis-cli DBSIZE

5. Health Check Commands

# Check Redis status
redis-cli ping

# View persistence status
redis-cli INFO persistence

# Check database size
redis-cli DBSIZE

# View pool keys
redis-cli KEYS "conceal:*"

# Check miner data (replace with your address)
redis-cli HGETALL conceal:workers:YOUR_WALLET_ADDRESS

# Monitor Redis in real-time
redis-cli --stat

# Check disk space
df -h /var/lib/redis/

# View last save time
redis-cli LASTSAVE | xargs -I {} date -d @{}

Monitor pool-specific data:

# Current round shares
redis-cli HGETALL conceal:shares_actual:roundCurrent

# Blocks found
redis-cli ZRANGE conceal:blocks:candidates 0 -1

# Pending payments
redis-cli HGETALL conceal:balances

JSON-RPC Commands from CLI

Documentation for JSON-RPC commands can be found here:

Curl can be used to use the JSON-RPC commands from command-line. Here is an example of calling getblockheaderbyheight for block 100:

curl 127.0.0.1:18081/json_rpc -d '{"method":"getblockheaderbyheight","params":{"height":100}}'

Monitoring Your Pool

To inspect and make changes to redis I suggest using redis-commander
To monitor server load for CPU, Network, IO, etc - I suggest using Netdata
To keep your pool node script running in background, logging to file, and automatically restarting if it crashes - I suggest using forever or PM2

Solo Mining Bridge

The pool software includes a solo mining bridge mode that allows you to mine directly to your local daemon without running a full pool. This is perfect for home miners who want to solo mine with their GPU using miners like srbminer or xmr-stak.

Features:

Minimal stratum server - no Redis, no payments, no API
Direct connection to your local daemon
Automatic block submission when blocks are found
Supports all Cryptonote algorithms and variants

Setup:

Copy the example configuration:

cp config-solo.json.example config-solo.json

Edit config-solo.json with your settings:

{
    "daemon": {
        "host": "127.0.0.1",
        "port": 16000
    },
    "solo": {
        "host": "0.0.0.0",
        "port": 6666,
        "defaultDifficulty": 20000,
        "targetShareTime": 15,
        "minDifficulty": 500,
        "maxDifficulty": 100000,
        "minerTimeout": 900,
        "blockRefreshInterval": 1000,
        "walletAddress": "YOUR_WALLET_ADDRESS_HERE"
    },
    "cnAlgorithm": "cryptonight",
    "cnVariant": 3,
    "cnBlobType": 0
}

Start the solo bridge:

node index.js --solo-mining

Connect your miner to stratum+tcp://<port-of-cryptonote-nodejs-pool>:6666 (or whatever port you configured)

Health Check:

You can run a one-off health check to verify your daemon connection and see the current block template:

node index.js --solo-mining --health

This will:

Connect to your daemon
Fetch the current block template
Display status (height, difficulty, target) and header information
Exit with code 0 on success, 1 on error

Example output:

{
  "status": {
    "ok": true,
    "daemonConnected": true,
    "height": 123456,
    "networkDifficulty": 987654321,
    "shareDifficulty": 1000,
    "minDifficulty": 500,
    "maxDifficulty": 100000,
    "defaultDifficulty": 1000,
    "target": "00ffff...",
    "algorithm": "cryptonight",
    "variant": 3,
    "blobType": 0
  },
  "header": {
    "blob": "0afebabe...",
    "height": 123456,
    "difficulty": 987654321,
    "target": "00ffff...",
    "previous_hash": "abcd..."
  }
}

Difficulty Configuration:

The solo bridge supports flexible difficulty settings:

defaultDifficulty (default: 1000): Default share difficulty for miners
minDifficulty (default: 500): Minimum allowed share difficulty
maxDifficulty (default: 100000): Maximum allowed share difficulty

Miners can specify a custom difficulty in their login by appending +difficulty to their address (e.g., address+2000). The difficulty will be clamped to the min/max range.

Important: The bridge always respects the network difficulty from the daemon for block validation. Shares must meet the network difficulty to be submitted as blocks. The share difficulty only controls what shares are accepted from miners (to prevent flooding with tiny shares).

Note: The solo bridge does NOT require Redis - it's a minimal implementation that only handles job distribution and block submission. All blocks found go directly to your daemon.

Telegram Notifications:

The solo bridge can send Telegram notifications when blocks are found. To enable:

Create a Telegram Bot:
- Search for @BotFather in Telegram
- Send /newbot and follow prompts to create your bot
- Save the token provided (e.g., 123456789:ABCdefGHIjklMNOpqrsTUVwxyz)
Get Your Chat ID:
- Visit: https://api.telegram.org/botYOUR_BOT_TOKEN/getUpdates
- Start a chat with your bot (search by username)
- Send any message to the bot
- Find "chat":{"id":123456789} - that number is your chat ID

Configure in config-solo.json:

"telegram": {
    "enabled": true,
    "token": "123456789:ABCdefGHIjklMNOpqrsTUVwxyz",
    "chatId": "123456789"
}

Donations

Thanks for supporting my works on this project! If you want to make a donation to Daniel Vandal, the developper of this project, you can send any amount of your choice to one of theses addresses:

Bitcoin (BTC): 17XRyHm2gWAj2yfbyQgqxm25JGhvjYmQjm
Bitcoin Cash (BCH): qpl0gr8u3yu7z4nzep955fqy3w8m6w769sec08u3dp
Ethereum (ETH): 0x83ECF65934690D132663F10a2088a550cA201353
Litecoin (LTC): LS9To9u2C95VPHKauRMEN5BLatC8C1k4F1
Monero (XMR): 49WyMy9Q351C59dT913ieEgqWjaN12dWM5aYqJxSTZCZZj1La5twZtC3DyfUsmVD3tj2Zud7m6kqTVDauRz53FqA9zphHaj
Graft (GRFT): GBqRuitSoU3PFPBAkXMEnLdBRWXH4iDSD6RDxnQiEFjVJhWUi1UuqfV5EzosmaXgpPGE6JJQjMYhZZgWY8EJQn8jQTsuTit
Haven (XHV): hvxy2RAzE7NfXPLE3AmsuRaZztGDYckCJ14XMoWa6BUqGrGYicLCcjDEjhjGAQaAvHYGgPD7cGUwcYP7nEUs8u6w3uaap9UZTf
IntenseCoin (ITNS): iz4fRGV8XsRepDtnK8XQDpHc3TbtciQWQ5Z9285qihDkCAvB9VX1yKt6qUCY6sp2TCC252SQLHrjmeLuoXsv4aF42YZtnZQ53
Masari (MSR): 5n7mffxVT9USrq7tcG3TM8HL5yAz7MirUWypXXJfHrNfTcjNtDouLAAGex8s8htu4vBpmMXFzay8KG3jYGMFhYPr2aMbN6i
Stellite (XTL): Se45GzgpFG3CnvYNwEFnxiRHD2x7YzRnhFLdxjUqXdbv3ysNbfW5U7aUdn87RgMRPM7xwN6CTbXNc7nL5QUgcww11bDeypTe1

Credits

fancoder - Developper on cryptonote-universal-pool project from which current project is forked.

License

Released under the GNU General Public License v2

http://www.gnu.org/licenses/gpl-2.0.html

Name		Name	Last commit message	Last commit date
Latest commit History 953 Commits
deployment		deployment
email_templates		email_templates
lib		lib
scripts		scripts
website_example		website_example
.gitignore		.gitignore
.gitignore.local		.gitignore.local
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
TESTING.md		TESTING.md
biome.json		biome.json
config-solo.json.example		config-solo.json.example
config.json.template		config.json.template
ecosystem.config.js.template		ecosystem.config.js.template
index.js		index.js
init.js		init.js
package.json		package.json

Folders and files

Latest commit

History

Repository files navigation

cryptonote-nodejs-pool

Table of Contents

Features

Optimized pool server

Live statistics API

Mined blocks explorer

Smart payment processing

Admin panel

Pool stability monitoring

Extra features

Usage

Requirements

Seriously

1) Downloading & Installing

2) Configuration

3) Start the pool

4) Host the front-end

5) Customize your website

SSL

Wallet Commands from admin Page

Wallet OPS

Wallet Optimization

Upgrading

Redis Setup

1. Install and Run Redis

2. Set Proper Ownership & Access Rights

3. Configure Redis for Data Persistence

4. Automated Backups

5. Health Check Commands

JSON-RPC Commands from CLI

Monitoring Your Pool

Solo Mining Bridge

Donations

Credits

License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages