garlicoin-miner v0.1.0

garlicoin-miner

Simple yet very educative Garlicoin miner (GRLC/TUX) in Javascript

Install

$ npm install garlicoin-miner

Usage

const GRLCMiner = require('garlicoin-miner');
// View this block in Block Explorer:  https://insight.bitpay.com/block/00000000000000000020cf2bdc6563fb25c424af588d5fb7223461e72715e4a9
// Get it in JSON format: https://garlicinsight.com/insight-grlc-api/block/85edd31125eed66fef096b6aacc15d55a036531870b12681bf8fa1ba54539e1b
const block = {
	version: 536870912,
	previousblockhash: 'dc2eafec687085e93e217fb95c11337dfa0a06e7f5b026213067db670e71cde2',
	merkleroot: 'cc8bf1939c6227d4c30a46582862e673d866953f5fba7eaa7923ab838c38a4dc',
	time: 1531846386,
	bits: '1c03afd3'
};
let nonce = 1717644812 // initial nonce that we'll use for testing purposes

const miner = new GRLCMiner(block);

// Calculate the target based on current dificulty for this block (block.bits)
const target = miner.getTarget();
console.log('The target for this block is:');
console.log(target.toString('hex'));

let hash;
let found = false;

console.log('\n[Start Mining with initial nonce:', nonce, ']');
while (nonce < (45291990+10000) && !found) { 
	hash = miner.getHash(nonce);
	found = miner.checkHash(hash);
	console.log(hash.toString('hex'), nonce, found ? '<- nonce FOUND!!' : '');
	if (found) {
		miner.verifyNonce(block, nonce);
	}
	nonce++;
}

Example Output

API

getTarget()

Returns the target Buffer for that block based on it's bits (difficulty).

getHash(nonce)

Returns the sha256sha256 hash Buffer for that block's nonce.

checkHash(hash)

Returns a Boolean with true if the hash is lower than the target and viceversa.

checkHash(block, hash)

Print colored verification of the hash against the target on the console (the code shows another way to build the block header in javascript).

Related

• Bitcoin mining the hard way: the algorithms, protocols, and bytes - Inspiration for this module.
• What is (bitcoin) "difficulty" - Bitcoin Difficulty calculations and algorithms.

License

MIT © Carlos Guerrero MIT © KorkyMonster