Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dev #38

Merged
merged 12 commits into from
Aug 8, 2020
Merged

Dev #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ac19e53
dev
ROZ-MOFUMOFU-ME Jul 4, 2020
e1ed4b2
dev
ROZ-MOFUMOFU-ME Jul 4, 2020
a575076
vips
ROZ-MOFUMOFU-ME Jul 4, 2020
78a71cf
dev
ROZ-MOFUMOFU-ME Jul 6, 2020
0ce6f11
fix
ROZ-MOFUMOFU-ME Jul 6, 2020
59b7d95
dwv
ROZ-MOFUMOFU-ME Jul 6, 2020
3043653
fix stats
ROZ-MOFUMOFU-ME Jul 6, 2020
f8eda7b
vips
ROZ-MOFUMOFU-ME Jul 8, 2020
d5ab51d
fix stats
ROZ-MOFUMOFU-ME Jul 8, 2020
6023cca
fix
ROZ-MOFUMOFU-ME Jul 15, 2020
4828587
fix Kumacoin
ROZ-MOFUMOFU-ME Jul 15, 2020
b0b308a
some fix
ROZ-MOFUMOFU-ME Aug 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
235 changes: 220 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@
[![CircleCI](https://circleci.com/gh/ROZ-MOFUMOFU-ME/zny-nomp/tree/main.svg?style=svg)](https://circleci.com/gh/ROZ-MOFUMOFU-ME/zny-nomp/tree/main)

This is a Yescrypt, YesPoWer, Lyra2REv2, sha256d and more algo mining pool based off of Node Open Mining Portal.

Donations for development are greatly appreciated!
* ZNY: ZmnBu9jPKvVFL22PcwMHSEuVpTxFeCdvNv
* NUKO: 0xa79bde46faab3c40632604728e9f2165b052581c
* KOTO :k1FTuimwDJ8oo3x23cEBLxovxw5Cqq2U1HK
* SUSU: SeXbMBaax7NgnTEFEMxin5ycXy9r9CDBot
* MONA: mona1qnur6ljkl5pe8w6ql8xfqw4aa38d5xa9q68dxll
* BELL: BCVicYRSqKKt1ynJKPrXHA46hUWLrbjR49
* SUGAR: sugar1qtwqle9lrr753kxuzqqsh3hv28jl07e3mntx78n
* VIPS: VFixsia2EstV4uEEigUXUrknDGsFeWyNhE
* KUMA: KHjjZ5misqq45zwhj86WKqV8bzqcYExzyM
* BTC: 3C8oCWjVs2sycQcK3ttiPRSKV4AKBhC7xT

#### Production Usage Notice
This is beta software. All of the following are things that can change and break an existing ZNY-NOMP setup: functionality of any feature, structure of configuration files and structure of redis data. If you use this software in production then *DO NOT* pull new code straight into production usage because it can and often will break your setup and require you to tweak things like config files or redis data. *Only tagged releases are considered stable.*
Expand Down Expand Up @@ -86,14 +74,215 @@ Clone the repository and run `npm update` for all the dependencies to be install

```bash
sudo apt-get install build-essential libsodium-dev npm libboost-all-dev libgmp-dev
sudo apt install nodejs node-gyp libssl1.0-dev -y
sudo apt install npm -y
sudo npm install n -g
sudo n v9
sudo n v12
sudo apt purge nodejs npm -y
sudo ln -sf /usr/local/bin/node /usr/bin/node
sudo ln -sf /usr/local/bin/npm /usr/bin/npm
git clone https://github.com/ROZ-MOFUMOFU-ME/zny-nomp
cd zny-nomp
npm update
npm install
```

#### 2) Configuration

##### Portal config
Inside the `config_example.json` file, ensure the default configuration will work for your environment, then copy the file to `config.json`.

Explanation for each field:
````javascript
{
/* Specifies the level of log output verbosity. Anything more severe than the level specified
will also be logged. */
"logLevel": "debug", //or "warning", "error"

/* By default the server logs to console and gives pretty colors. If you direct that output to a
log file then disable this feature to avoid nasty characters in your log file. */
"logColors": true,

/* The server CLI (command-line interface) will listen for commands on this port. For example,
blocknotify messages are sent to the server through this. */
"cliPort": 17117,

/* By default 'forks' is set to "auto" 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. */
"clustering": {
"enabled": true,
"forks": "auto"
},

/* Pool config file will inherit these default values if they are not set. */
"defaultPoolConfigs": {

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

/* If no new blocks are available for this many seconds update and rebroadcast job. */
"jobRebroadcastTimeout": 55,

/* Disconnect workers that haven't submitted shares for this many seconds. */
"connectionTimeout": 600,

/* (For MPOS mode) Store the block hashes for shares that aren't block candidates. */
"emitInvalidBlockHashes": false,

/* This option will only authenticate miners using an address or mining key. */
"validateWorkerUsername": true,

/* Enable for client IP addresses to be detected when using a load balancer with TCP
proxy protocol enabled, such as HAProxy with 'send-proxy' param:
http://haproxy.1wt.eu/download/1.5/doc/configuration.txt */
"tcpProxyProtocol": false,

/* If under low-diff share attack we can ban their IP to reduce system/network load. If
running behind HAProxy be sure to enable 'tcpProxyProtocol', otherwise you'll end up
banning your own IP address (and therefore all workers). */
"banning": {
"enabled": true,
"time": 600, //How many seconds to ban worker for
"invalidPercent": 50, //What percent of invalid shares triggers ban
"checkThreshold": 500, //Perform check when this many shares have been submitted
"purgeInterval": 300 //Every this many seconds clear out the list of old bans
},

/* Used for storing share and block submission data and payment processing. */
"redis": {
"host": "127.0.0.1",
"port": 6379
}
},

/* This is the front-end. Its not finished. When it is finished, this comment will say so. */
"website": {
"enabled": true,
/* If you are using a reverse-proxy like nginx to display the website then set this to
127.0.0.1 to not expose the port. */
"host": "0.0.0.0",
"port": 80,
/* Used for displaying stratum connection data on the Getting Started page. */
"stratumHost": "cryppit.com",
"stats": {
/* Gather stats to broadcast to page viewers and store in redis for historical stats
every this many seconds. */
"updateInterval": 15,
/* How many seconds to hold onto historical stats. Currently set to 24 hours. */
"historicalRetention": 43200,
/* How many seconds worth of shares should be gathered to generate hashrate. */
"hashrateWindow": 300
},
/* Not done yet. */
"adminCenter": {
"enabled": true,
"password": "password"
}
},

/* Redis instance of where to store global portal data such as historical stats, proxy states,
ect.. */
"redis": {
"host": "127.0.0.1",
"port": 6379
},


/* With this switching configuration, you can setup ports that accept miners for work based on
a specific algorithm instead of a specific coin. Miners that connect to these ports are
automatically switched a coin determined by the server. The default coin is the first
configured pool for each algorithm and coin switching can be triggered using the
cli.js script in the scripts folder.

Miners connecting to these switching ports must use their public key in the format of
RIPEMD160(SHA256(public-key)). An address for each type of coin is derived from the miner's
public key, and payments are sent to that address. */
"switching": {
"switch1": {
"enabled": false,
"algorithm": "sha256",
"ports": {
"3333": {
"diff": 10,
"varDiff": {
"minDiff": 16,
"maxDiff": 512,
"targetTime": 15,
"retargetTime": 90,
"variancePercent": 30
}
}
}
},
"switch2": {
"enabled": false,
"algorithm": "scrypt",
"ports": {
"4444": {
"diff": 10,
"varDiff": {
"minDiff": 16,
"maxDiff": 512,
"targetTime": 15,
"retargetTime": 90,
"variancePercent": 30
}
}
}
},
"switch3": {
"enabled": false,
"algorithm": "x11",
"ports": {
"5555": {
"diff": 0.001
}
}
}
},

"profitSwitch": {
"enabled": false,
"updateInterval": 600,
"depth": 0.90,
"usePoloniex": true,
"useCryptsy": true,
"useMintpal": true
}
}
````


##### Coin config
Inside the `coins` directory, ensure a json file exists for your coin. If it does not you will have to create it.
Here is an example of the required fields:
````javascript
{
"name": "BitZeny",
"symbol": "ZNY",
"algorithm": "yescryptR8",

// Coinbase value is what is added to a block when it is mined, set this to your pool name so
// explorers can see which pool mined a particular block.
"coinbase": "Bitzeny",
/* Magic value only required for setting up p2p block notifications. It is found in the daemon
source code as the pchMessageStart variable.
For example, BitZeny mainnet magic: https://github.com/BitzenyCoreDevelopers/bitzeny/blob/z2.0.x/src/chainparams.cpp#L114
And for BitZeny testnet magic: https://github.com/BitzenyCoreDevelopers/bitzeny/blob/z2.0.x/src/chainparams.cpp#L206 */
"peerMagic": "daa5bef9", //optional
"peerMagicTestnet": "59454e59" //optional

//"txMessages": false, //options - defaults to false

//"mposDiffMultiplier": 256, //options - only for x11 coins in mpos mode
}
````

For additional documentation how to configure coins and their different algorithms
see [these instructions](//github.com/AoD-Technologies/cryptocurrency-stratum-pool#module-usage).


##### Pool config
Take a look at the example json file inside the `pool_configs` directory. Rename it to `bitzeny.json` and change the
example fields to fit your setup.
Expand Down Expand Up @@ -146,14 +335,30 @@ the `node-stratum-pool` and `node-multi-hashing` modules, and any config files t
* Run `npm update` to force updating/reinstalling of the dependencies.
* Compare your `config.json` and `pool_configs/coin.json` configurations to the latest example ones in this repo or the ones in the setup instructions where each config field is explained. <b>You may need to modify or add any new changes.</b>

Donations
-------
Donations for development are greatly appreciated!
* ZNY: ZmnBu9jPKvVFL22PcwMHSEuVpTxFeCdvNv
* NUKO: 0xa79bde46faab3c40632604728e9f2165b052581c
* KOTO :k1FTuimwDJ8oo3x23cEBLxovxw5Cqq2U1HK
* SUSU: SeXbMBaax7NgnTEFEMxin5ycXy9r9CDBot
* MONA: mona1qnur6ljkl5pe8w6ql8xfqw4aa38d5xa9q68dxll
* BELL: BCVicYRSqKKt1ynJKPrXHA46hUWLrbjR49
* SUGAR: sugar1qtwqle9lrr753kxuzqqsh3hv28jl07e3mntx78n
* VIPS: VFixsia2EstV4uEEigUXUrknDGsFeWyNhE
* KUMA: KHjjZ5misqq45zwhj86WKqV8bzqcYExzyM
* BTC: 3C8oCWjVs2sycQcK3ttiPRSKV4AKBhC7xT

Credits
-------
### ZNY-NOMP
* [ROZ-MOFUMOFU-ME](https://github.com/ROZ-MOFUMOFU-ME)
* [zinntikumugai](https://github.com/zinntikumugai) - great supporter

### s-nomp
### cryptocurrency-stratum-pool
* [Invader444](//github.com/Invader444)

### S-NOMP
* [egyptianbman](https://github.com/egyptianbman)
* [nettts](https://github.com/nettts)
* [potato](https://github.com/zzzpotato)
Expand Down
9 changes: 8 additions & 1 deletion coins/kumacoin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,12 @@
"peerMagic": "c3d4d2fe",
"peerMagicTestnet": "cdf2c0ef",
"blockTime": 90,
"hasGetInfo": true
"getInfo": true,
"noNetworkInfo": true,
"noGetnetworkhashps": true,
"explorer": {
"txURL": "https://kumabook.electrum-mona.org/tx/",
"blockURL": "https://kumabook.electrum-mona.org/block/"
}
}

4 changes: 3 additions & 1 deletion coins/testnet/kumacoin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,7 @@
"peerMagic": "c3d4d2fe",
"peerMagicTestnet": "cdf2c0ef",
"blockTime": 90,
"hasGetInfo": true
"getInfo": true,
"noNetworkInfo": true,
"noGetnetworkhashps": true
}
24 changes: 8 additions & 16 deletions libs/paymentProcessor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,17 +376,19 @@ function SetupForPool(logger, poolOptions, setupFinished){
if (result[0].response.blocks !== null) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkBlocks', result[0].response.blocks]);
}
if (result[0].response.difficulty !== null) {
if (result[0].response.difficulty !== null && typeof (result[0].response.difficulty) == 'object') {
finalRedisCommands.push(['hset', coin + ':stats', 'networkDiff', result[0].response.difficulty['proof-of-work']]);
} else if (result[0].response.difficulty !== null) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkDiff', result[0].response.difficulty]);
}
if (result[0].response.networkhashps !== null) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkSols', result[0].response.networkhashps]);
}

daemon.cmd(poolOptions.coin.hasGetInfo ? 'getinfo' : 'getnetworkinfo', params,
daemon.cmd(poolOptions.coin.getInfo ? 'getinfo' : 'getnetworkinfo', params,
function (result) {
if (!result || result.error || result[0].error || !result[0].response) {
logger.error(logSystem, logComponent, 'Error with RPC call getnetworkinfo '+JSON.stringify(result[0].error));
logger.error(logSystem, logComponent, 'Error with RPC call getinfo or getnetworkinfo ' + JSON.stringify(result[0].error));
return;
}

Expand All @@ -399,19 +401,9 @@ function SetupForPool(logger, poolOptions, setupFinished){
if (result[0].response.protocolversion !== null) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkProtocolVersion', result[0].response.protocolversion]);
}

if (poolOptions.coin.hasGetInfo === null ) daemon.cmd ('getnetworkinfo', params,
function (result) {
if (!result || result.error || result[0].error || !result[0].response) {
logger.error(logSystem, logComponent, 'Error with RPC call getnetworkinfo ' + JSON.stringify(result[0].error));
return;
}

if (result[0].response.subversion !== null) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkSubVersion', result[0].response.subversion]);
}
}
)
if (result[0].response.subversion !== null && result[0].response.subversion !== undefined) {
finalRedisCommands.push(['hset', coin + ':stats', 'networkSubVersion', result[0].response.subversion]);
}
if (finalRedisCommands.length <= 0)
return;

Expand Down
13 changes: 8 additions & 5 deletions libs/stats.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,8 @@ module.exports = function(logger, portalConfig, poolConfigs){
var _blocktime = coinStats.blockTime || 90;
var _networkHashRate = parseFloat(coinStats.poolStats.networkSols);
coinStats.luckDays = ((_networkHashRate / coinStats.hashrate * _blocktime) / (24 * 60 * 60)).toFixed(3);
coinStats.luckHours = ((_networkHashRate / coinStats.hashrate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.luckHours = ((_networkHashRate / coinStats.hashrate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.luckMinute = ((_networkHashRate / coinStats.hashrate * _blocktime) / (60)).toFixed(3);
coinStats.minerCount = Object.keys(coinStats.miners).length;
coinStats.workerCount = Object.keys(coinStats.workers).length;
portalStats.global.workers += coinStats.workerCount;
Expand Down Expand Up @@ -633,14 +634,16 @@ module.exports = function(logger, portalConfig, poolConfigs){
for (var worker in coinStats.workers) {
var _workerRate = shareMultiplier * coinStats.workers[worker].shares / portalConfig.website.stats.hashrateWindow;
coinStats.workers[worker].luckDays = ((_networkHashRate / _workerRate * _blocktime) / (24 * 60 * 60)).toFixed(3);
coinStats.workers[worker].luckHours = ((_networkHashRate / _workerRate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.workers[worker].luckHours = ((_networkHashRate / _workerRate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.workers[worker].luckMinute = ((_networkHashRate / _workerRate * _blocktime) / (60)).toFixed(3);
coinStats.workers[worker].hashrate = _workerRate;
coinStats.workers[worker].hashrateString = _this.getReadableHashRateString(_workerRate);
}
for (var miner in coinStats.miners) {
var _workerRate = shareMultiplier * coinStats.miners[miner].shares / portalConfig.website.stats.hashrateWindow;
coinStats.miners[miner].luckDays = ((_networkHashRate / _workerRate * _blocktime) / (24 * 60 * 60)).toFixed(3);
coinStats.miners[miner].luckHours = ((_networkHashRate / _workerRate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.miners[miner].luckHours = ((_networkHashRate / _workerRate * _blocktime) / (60 * 60)).toFixed(3);
coinStats.miners[miner].luckMinute = ((_networkHashRate / _workerRate * _blocktime) / (60)).toFixed(3);
coinStats.miners[miner].hashrate = _workerRate;
coinStats.miners[miner].hashrateString = _this.getReadableHashRateString(_workerRate);
}
Expand Down Expand Up @@ -754,7 +757,7 @@ module.exports = function(logger, portalConfig, poolConfigs){
return '0 Hash/s';
//return (Math.round(hashrate / 1000) / 1000 ).toFixed(2)+' Sol/s';
}
var byteUnits = [ ' Hash/s', ' KHash/s', ' MHash/s', ' GHash/s', ' THash/s', ' PHash/s' ];
var byteUnits = [' Hash/s', ' KHash/s', ' MHash/s', ' GHash/s', ' THash/s', ' PHash/s', ' EHash/s', ' ZHash/s', ' YHash/s' ];
var i = Math.floor((Math.log(hashrate/1000) / Math.log(1000)) - 1);
hashrate = (hashrate/1000) / Math.pow(1000, i + 1);
return hashrate.toFixed(2) + byteUnits[i];
Expand All @@ -764,7 +767,7 @@ module.exports = function(logger, portalConfig, poolConfigs){
hashrate = (hashrate * 1000000);
if (hashrate < 1000000)
return '0 Hash/s';
var byteUnits = [ ' Hash/s', ' KHash/s', ' MHash/s', ' GHash/s', ' THash/s', ' PHash/s' ];
var byteUnits = [' Hash/s', ' KHash/s', ' MHash/s', ' GHash/s', ' THash/s', ' PHash/s', ' EHash/s', ' ZHash/s', ' YHash/s' ];
var i = Math.floor((Math.log(hashrate/1000) / Math.log(1000)) - 1);
hashrate = (hashrate/1000) / Math.pow(1000, i + 1);
return hashrate.toFixed(2) + byteUnits[i];
Expand Down
Loading