Files
purple-explorer/lib/explorer.js
T
Joe Uhren 3a2f679201 Improved block sync speed
-A number of functions have been rewritten to be more optimized and faster: calculate_total, is_unique, convert_to_satoshi, get_input_addresses, processVoutAddresses, prepare_vout, prepare_vin
-Txes are now written to database via bulk writes which helps improve the sync speed and also controls memory usage with batching to write data once a certain threshold is reached
-update_address function changed to update_addresses since it now bulk writes the addresses in batches to improve sync speed and also controls memory usage with batching to write data once a certain threshold is reached
-The syncLoop function has been completely removed from the project and replaced with async library loops or even normal "for" loops in some cases which greatly improves sync speeds over large batches of data
-Fixed an issue with the flattened count of txes that is saved to the coinstats collection which could save incorrectly when using more than 1 thread
-Fixed an issue with the block sync which caused an unwanted delay when syncing less blocks than the amount of threads used to sync the data
-Fixed an issue with vout data processing that could sometimes populate data out of order
-Added a new sync.batch_size setting used to determine how many records (txes, addresses, addresstxes) should be saved in a single database transaction
-Added a new wait_for_bulk_database_save setting used to increase the block sync speed at the cost of not returning any error msgs for data that failed to save
-get_input_addresses function no longer returns in the exports section of the explorer.js file since it is only referenced in that file
-Updated explorerspec tests to use the newest function changes for any tests that needed to be updated

Special thanks to Karzo from Pepecoin for help with the bulkwrite code changes!
2025-02-02 19:10:17 -07:00

1454 lines
54 KiB
JavaScript

const request = require('postman-request');
const async = require('async');
const settings = require('./settings');
const Address = require('../models/address');
const base_server = 'http://127.0.0.1:' + settings.webserver.port + '/';
const base_url = base_server + 'api/';
const onode = require('./node');
const client = new onode.Client(settings.wallet);
const rpc_queue = async.queue((task_params, cb) => {
client.cmd([task_params], function(err, response) {
if (err)
return cb(`${settings.localization.ex_error}: ${settings.localization.check_console}`);
else
return cb(response);
});
}, settings.api_cmds.rpc_concurrent_tasks);
// returns coinbase total sent as current coin supply
function coinbase_supply(cb) {
Address.findOne({a_id: 'coinbase'}).then((address) => {
if (address)
return cb(address.sent);
else
return cb(0);
}).catch((err) => {
console.log(err);
return cb(0);
});
}
function rpcCommand(params, cb) {
rpc_queue.push({method: params[0].method, params: params[0].parameters}, cb);
}
function prepareRpcCommand(cmd, addParams) {
var method_name = '';
var params = addParams || [];
// Check for null/blank string
if (cmd != null && cmd.trim() != '') {
// Split cmd by spaces
var split = cmd.split(' ');
for (i = 0; i < split.length; i++) {
if (i == 0)
method_name = split[i];
else
params.push(split[i]);
}
}
return { method: method_name, parameters: params };
}
function convertHashUnits(hashes) {
if (settings.shared_pages.page_header.panels.network_panel.nethash_units == 'K') {
// return units in KH/s
return (hashes / 1000).toFixed(4);
} else if (settings.shared_pages.page_header.panels.network_panel.nethash_units == 'M') {
// return units in MH/s
return (hashes / 1000000).toFixed(4);
} else if (settings.shared_pages.page_header.panels.network_panel.nethash_units == 'G') {
// return units in GH/s
return (hashes / 1000000000).toFixed(4);
} else if (settings.shared_pages.page_header.panels.network_panel.nethash_units == 'T') {
// return units in TH/s
return (hashes / 1000000000000).toFixed(4);
} else if (settings.shared_pages.page_header.panels.network_panel.nethash_units == 'P') {
// return units in PH/s
return (hashes / 1000000000000000).toFixed(4);
} else {
// return units in H/s
return hashes.toFixed(4);
}
}
function processVoutAddresses(address_list, vout_value, arr_vout) {
// check if there are any addresses to process
if (address_list != null && address_list.length > 0) {
// check if vout address is inside an array
if (Array.isArray(address_list[0])) {
// extract the address
address_list[0] = address_list[0][0];
}
const amount_sat = module.exports.convert_to_satoshi(parseFloat(vout_value));
const index = module.exports.is_unique(arr_vout, address_list[0], 'addresses');
// check if vout address is unique, if so add to array, if not add its amount to existing index
if (index == -1) {
// unique vout
arr_vout.push({addresses: address_list[0], amount: amount_sat});
} else {
// already exists
arr_vout[index].amount += amount_sat;
}
}
// return the list of addresses
return arr_vout;
}
function encodeP2PKaddress(p2pk_descriptor, cb) {
// find the descriptor value
module.exports.get_descriptorinfo(p2pk_descriptor, function(descriptor_info) {
// check for errors
if (descriptor_info != null) {
// encode the address using the output descriptor
module.exports.get_deriveaddresses(descriptor_info.descriptor, function(p2pkh_address) {
// check for errors
if (p2pkh_address != null) {
// return P2PKH address
return cb(p2pkh_address);
} else {
// address could not be encoded
return cb(null);
}
});
} else {
// address could not be encoded
return cb(null);
}
});
}
function normalizeMasternodeCount(raw_count) {
// check if any data was returned
if (raw_count != null) {
// check if the data is in the expected object format
if (raw_count.total != null && raw_count.enabled != null) {
// data is already in the correct format
return raw_count;
} else {
const regex = /^\d+ \/ \d+$/;
// check if the data is in the format of "{enabled_count} / {total_count}"
if (regex.test(raw_count)) {
const splitCount = raw_count.split('/');
// enabled / total format detected
// return the data formatted as an object
return {
enabled: splitCount[0].trim(),
total: splitCount[1].trim()
};
// check if the data is in the format of "Total: {total_count} Enabled: {enabled_count}"
} else if (raw_count.toString().indexOf('Total: ') > -1 && raw_count.toString().indexOf('Enabled: ')) {
// Total: {total_count} Enabled: {enabled_count}" format detected
const totalRegex = /Total: (\d+)/;
const enabledRegex = /Enabled: (\d+)/;
const totalMatch = raw_count.match(totalRegex);
const enabledMatch = raw_count.match(enabledRegex);
// check if both the total and enabled values were found
if (totalMatch && enabledMatch) {
// return the data formatted as an object
return {
total: totalMatch[1],
enabled: enabledMatch[1]
};
} else {
// the data is in an unrecognized format
return raw_count;
}
} else {
// the data is in an unrecognized format
return raw_count;
}
}
} else {
// no data returned, so nothing to fix
return raw_count;
}
}
function get_input_addresses(input, vout, cb) {
let addresses = [];
if (input.coinbase) {
let amount = 0;
for (let i = 0; i < vout.length; i++)
amount += parseFloat(vout[i].value);
addresses.push({ hash: 'coinbase', amount: amount });
return cb(addresses, null);
} else {
module.exports.get_rawtransaction(input.txid, function(tx) {
if (tx) {
let tx_type = null;
async.eachSeries(tx.vout, function(current_vout, loop) {
if (current_vout.n == input.vout) {
if (current_vout.scriptPubKey.addresses || current_vout.scriptPubKey.address) {
let new_address = current_vout.scriptPubKey.address || current_vout.scriptPubKey.addresses[0];
// check if address is inside an array
if (Array.isArray(new_address)) {
// extract the address
new_address = new_address[0];
}
const index = module.exports.is_unique(addresses, new_address, 'hash');
if (index == -1)
addresses.push({hash: new_address, amount: current_vout.value});
else
addresses[index].amount += current_vout.value;
loop();
} else {
// no addresses defined
// check if bitcoin features are enabled
if (settings.blockchain_specific.bitcoin.enabled == true) {
// assume the asm value is a P2PK (Pay To Pubkey) public key that should be encoded as a P2PKH (Pay To Pubkey Hash) address
encodeP2PKaddress(current_vout.scriptPubKey.asm, function(p2pkh_address) {
// check if the address was encoded properly
if (p2pkh_address != null) {
// mark this tx as p2pk
tx_type = 'p2pk';
// check if address is inside an array
if (Array.isArray(p2pkh_address)) {
// extract the address
p2pkh_address = p2pkh_address[0];
}
// save the P2PKH address
const index = module.exports.is_unique(addresses, p2pkh_address, 'hash');
if (index == -1)
addresses.push({hash: p2pkh_address, amount: current_vout.value});
else
addresses[index].amount += current_vout.value;
loop();
} else {
// could not decipher the address, save as unknown and move to next vin
console.log('Failed to find vin address from tx ' + input.txid);
const index = module.exports.is_unique(addresses, 'unknown_address', 'hash');
if (index == -1)
addresses.push({hash: 'unknown_address', amount: current_vout.value});
else
addresses[index].amount += current_vout.value;
loop();
}
});
} else {
// could not decipher the address, save as unknown and move to next vin
console.log('Failed to find vin address from tx ' + input.txid);
const index = module.exports.is_unique(addresses, 'unknown_address', 'hash');
if (index == -1)
addresses.push({hash: 'unknown_address', amount: current_vout.value});
else
addresses[index].amount += current_vout.value;
loop();
}
}
} else
loop();
}, function() {
return cb(addresses, tx_type);
});
} else
return cb();
});
}
}
function finalize_vout(first_vout, arr_vout, arr_vin, tx_type, txid, cb) {
if (typeof first_vout !== 'undefined' && first_vout.scriptPubKey.type == 'nonstandard') {
if (arr_vin.length > 0 && arr_vout.length > 0) {
if (arr_vin[0].addresses == arr_vout[0].addresses) {
// pos
arr_vout[0].amount -= arr_vin[0].amount;
arr_vin.shift();
// check if any vin remains
if (arr_vin == null || arr_vin.length == 0) {
// empty vin should be linked to coinbase
arr_vin = [{coinbase: 'coinbase'}];
let new_vout = [];
// loop through the arr_vout to create a copy of the data with coin amounts only for use with prepare_vin()
for (i = 0; i < arr_vout.length; i++)
new_vout.push({ value: arr_vout[i].amount / 100000000 });
// call the prepare_vin again to populate the vin data correctly
module.exports.prepare_vin({ txid: txid, vin: arr_vin, vout: new_vout}, function(return_vin, return_tx_type_vin) {
return cb(arr_vout, return_vin, return_tx_type_vin);
});
} else
return cb(arr_vout, arr_vin, tx_type);
} else
return cb(arr_vout, arr_vin, tx_type);
} else
return cb(arr_vout, arr_vin, tx_type);
} else
return cb(arr_vout, arr_vin, tx_type);
}
module.exports = {
convert_to_satoshi: function(amount) {
// fix to 8 decimals and convert to string
const fixed = amount.toFixed(8).toString();
// remove decimal (.) and return integer
return parseInt(fixed.replace('.', ''));
},
get_hashrate: function(cb) {
// check if hash rate should be hidden
if (settings.shared_pages.show_hashrate == false)
return cb('-');
// check how to acquire network hashrate
if (settings.shared_pages.page_header.panels.network_panel.nethash == 'netmhashps') {
// load getmininginfo rpc call from settings
var cmd = prepareRpcCommand(settings.api_cmds.getmininginfo);
// check if the rpc cmd is valid
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
// check if getting data from wallet rpc or web api request
if (settings.api_cmds.use_rpc) {
// get data from wallet via rpc cmd
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb('-');
var net_hash = null;
// check for different implementations of the net has value
if (response.netmhashps) {
// value returned in MH/s so convert to H/s
net_hash = (response.netmhashps * 1000000);
} else if (response.networkhashps)
net_hash = response.networkhashps;
else if (response.hashespersec)
net_hash = response.hashespersec;
// check if netmhashps has a value
if (net_hash) {
// return hash value with proper units
return cb(convertHashUnits(net_hash));
} else {
// netmhashps is blank/null
return cb('-');
}
});
} else {
// get data via internal web api request
var uri = base_url + 'getmininginfo';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`) {
// return a blank value
return cb('-');
} else {
var net_hash = null;
// check for different implementations of the net has value
if (body.netmhashps) {
// value returned in MH/s so convert to H/s
net_hash = (body.netmhashps * 1000000);
} else if (body.networkhashps)
net_hash = body.networkhashps;
else if (body.hashespersec)
net_hash = body.hashespersec;
// check if there is a net hash value
if (net_hash) {
// return hash value with proper units
return cb(convertHashUnits(net_hash));
} else {
// netmhashps is blank/null
return cb('-');
}
}
});
}
} else {
// getmininginfo cmd not set
return cb('-');
}
} else if (settings.shared_pages.page_header.panels.network_panel.nethash == 'getnetworkhashps') {
// load getnetworkhashps rpc call from settings
var cmd = prepareRpcCommand(settings.api_cmds.getnetworkhashps);
// check if the rpc cmd is valid
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
// check if getting data from wallet rpc or web api request
if (settings.api_cmds.use_rpc) {
// get data from wallet via rpc cmd
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb('-');
// check if the response has a value
if (response) {
// return hash value with proper units
return cb(convertHashUnits(response));
} else {
// response is blank/null
return cb('-');
}
});
} else {
// get data via internal web api request
var uri = base_url + 'getnetworkhashps';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`) {
// return a blank value
return cb('-');
} else {
// return hash value with proper units
return cb(convertHashUnits(body));
}
});
}
} else {
// getnetworkhashps cmd not set
return cb('-');
}
} else {
// Invalid network hashrate setting value
return cb('-');
}
},
get_difficulty: function(cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getdifficulty);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getdifficulty';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_connectioncount: function(cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getconnectioncount);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getconnectioncount';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_masternodelist: function(cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getmasternodelist);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getmasternodelist';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_masternodecount: function(cb) {
// check if the masternode count api is enabled
if (settings.api_page.public_apis.rpc.getmasternodecount.enabled == true && settings.api_cmds['getmasternodecount'] != null && settings.api_cmds['getmasternodecount'] != '') {
var cmd = prepareRpcCommand(settings.api_cmds.getmasternodecount);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(normalizeMasternodeCount(response));
});
} else {
var uri = base_url + 'getmasternodecount';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(normalizeMasternodeCount(body));
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_blockcount: function(cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getblockcount);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getblockcount';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_blockhash: function(height, cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getblockhash, (height ? [parseInt(height)] : []));
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getblockhash?height=' + (height ? height : '');
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_block: function(hash, cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getblock, (hash ? [hash] : []));
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getblock?hash=' + hash;
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_rawtransaction: function(hash, cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getrawtransaction, (hash ? [hash, 1] : []));
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getrawtransaction?txid=' + hash + '&decrypt=1';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_maxmoney: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getmaxmoney);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getmaxmoney';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_maxvote: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getmaxvote);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getmaxvote';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_vote: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getvote);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getvote';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_phase: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getphase);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getphase';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_reward: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getreward);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getreward';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_estnext: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getnextrewardestimate);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getnextrewardestimate';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_nextin: function(cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getnextrewardwhenstr);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getnextrewardwhenstr';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_descriptorinfo: function(descriptor, cb) {
// format the descriptor correctly for use in the getdescriptorinfo cmd
descriptor = 'pkh(' + descriptor.replace(' OP_CHECKSIG', '') + ')';
var cmd = prepareRpcCommand(settings.blockchain_specific.bitcoin.api_cmds.getdescriptorinfo, (descriptor ? [descriptor] : []));
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getdescriptorinfo?descriptor=' + encodeURIComponent(descriptor);
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_deriveaddresses: function(descriptor, cb) {
var cmd = prepareRpcCommand(settings.blockchain_specific.bitcoin.api_cmds.deriveaddresses, (descriptor ? [descriptor] : []));
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'deriveaddresses?descriptor=' + encodeURIComponent(descriptor);
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
balance_supply: function(cb) {
Address.find({}, 'balance').where('balance').gt(0).exec().then((docs) => {
let count = 0;
async.eachSeries(docs, function(current_doc, loop) {
count += current_doc.balance;
loop();
}, function() {
return cb(count);
});
}).catch((err) => {
console.log(err);
return cb(0);
});
},
get_supply: function(cb) {
if (settings.sync.supply == 'HEAVY') {
// attempt to get the supply from the getsupply or similar api cmd that returns the current money supply as a single positive decimal value
var cmd = prepareRpcCommand(settings.blockchain_specific.heavycoin.api_cmds.getsupply);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getsupply';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
} else if (settings.sync.supply == 'GETINFO') {
// attempt to get the supply from the getinfo or similar api cmd that returns and object containing various state info. Must include a value called "moneysupply" which represents the current running total of coins
var cmd = prepareRpcCommand(settings.api_cmds.getinfo);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (!response || !response.moneysupply || response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response.moneysupply);
});
} else {
var uri = base_url + 'getinfo';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (!body || !body.moneysupply || body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body.moneysupply);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
} else if (settings.sync.supply == 'BALANCES') {
// get the supply by running a query on the addresses collection and summing up all positive balances (potentially a long running query for blockchains with tons of addresses)
module.exports.balance_supply(function(supply) {
return cb(supply/100000000);
});
} else if (settings.sync.supply == 'TXOUTSET') {
// attempt to get the supply from the gettxoutsetinfo or similar api cmd that returns an object with statistics about the unspent transaction output set. Must include a value called "total_amount" which represents the current running total of coins
var cmd = prepareRpcCommand(settings.api_cmds.gettxoutsetinfo);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (!response || !response.total_amount || response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response.total_amount);
});
} else {
var uri = base_url + 'gettxoutsetinfo';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (!body || !body.total_amount || body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body.total_amount);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
} else if (settings.sync.supply == 'GETBLOCKCHAININFO') {
// attempt to get the supply from the getblockchaininfo or similar api cmd that returns and object containing various state info. Must include a value called "moneysupply" which represents the current running total of coins
var cmd = prepareRpcCommand(settings.api_cmds.getblockchaininfo);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (!response || !response.moneysupply || response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response.moneysupply);
});
} else {
var uri = base_url + 'getblockchaininfo';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (!body || !body.moneysupply || body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body.moneysupply);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
} else {
// returns coinbase total sent as current coin supply
coinbase_supply(function(supply) {
return cb(supply/100000000);
});
}
},
get_peerinfo: function(cb) {
var cmd = prepareRpcCommand(settings.api_cmds.getpeerinfo);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'getpeerinfo';
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
verify_message: function(address, signature, message, cb) {
var cmd = prepareRpcCommand(settings.api_cmds.verifymessage, [address, signature, message]);
if (!(cmd.method == '' && cmd.parameters.length == 0)) {
if (settings.api_cmds.use_rpc) {
rpcCommand([{method:cmd.method, parameters: cmd.parameters}], function(response) {
// check if an error msg was received from the rpc server
if (response == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(response);
});
} else {
var uri = base_url + 'verifymessage?address=' + address + '&signature=' + signature + '&message=' + message;
request({uri: uri, json: true}, function (error, response, body) {
// check if an error msg was received from the web api server
if (body == `${settings.localization.ex_error}: ${settings.localization.check_console}`)
return cb(null);
else
return cb(body);
});
}
} else {
// cmd not in use. return null.
return cb(null);
}
},
get_geo_location: function(address, cb) {
request({uri: 'https://reallyfreegeoip.org/json/' + address, json: true}, function (error, response, geo) {
return cb(error, geo);
});
},
is_unique: function(array, object, key_name) {
for (let i = 0; i < array.length; i++) {
if (array[i][key_name] === object)
return i;
}
return -1;
},
calculate_total: function(vout) {
let total = 0;
for (let i = 0; i < vout.length; i++)
total += vout[i].amount;
return total;
},
prepare_vout: function(vout, txid, vin, vhidden, cb) {
let arr_vout = [];
let arr_vin = vin;
let tx_type = null;
try {
async.eachSeries(vout, function(current_vout, loop) {
// make sure vout has an address
if (current_vout.scriptPubKey.type != 'nonstandard' && current_vout.scriptPubKey.type != 'nulldata') {
// check if this is a zerocoin tx
if (current_vout.scriptPubKey.type != 'zerocoinmint') {
const address_list = current_vout.scriptPubKey.addresses;
// check if there are one or more addresses in the vout
if (address_list == null || address_list.length == 0) {
// no addresses defined
// check if there is a single address defined
if (current_vout.scriptPubKey.address == null) {
// no single address defined
// check if bitcoin features are enabled
if (settings.blockchain_specific.bitcoin.enabled == true) {
// assume the asm value is a P2PK (Pay To Pubkey) public key that should be encoded as a P2PKH (Pay To Pubkey Hash) address
encodeP2PKaddress(current_vout.scriptPubKey.asm, function(p2pkh_address) {
// check if the address was encoded properly
if (p2pkh_address != null) {
// mark this tx as p2pk
tx_type = 'p2pk';
// process vout addresses and save the updated array
arr_vout = processVoutAddresses(p2pkh_address, current_vout.value, arr_vout);
} else {
// could not decipher the address, save as unknown
console.log('Failed to find vout address from tx ' + txid);
// process vout addresses and save the updated array
arr_vout = processVoutAddresses(['unknown_address'], current_vout.value, arr_vout);
}
// move to next vout
loop();
});
} else {
// could not decipher the address, save as unknown and move to next vout
console.log('Failed to find vout address from tx ' + txid);
// process vout addresses and save the updated array
arr_vout = processVoutAddresses(['unknown_address'], current_vout.value, arr_vout);
// move to next vout
loop();
}
} else {
// process vout addresses and save the updated array
arr_vout = processVoutAddresses([current_vout.scriptPubKey.address], current_vout.value, arr_vout);
// move to next vout
loop();
}
} else {
// process vout addresses and save the updated array
arr_vout = processVoutAddresses(address_list, current_vout.value, arr_vout);
// move to next vout
loop();
}
} else {
// TODO: add support for zerocoin transactions
console.log('Zerocoin tx found. skipping for now as it is unsupported');
tx_type = "zerocoin";
loop();
}
} else {
// no address, move to next vout
loop();
}
}, function() {
// check if zksnarks is enabled and there are any hidden/anonymous outputs
if (settings.blockchain_specific.zksnarks.enabled == true && vhidden != null && vhidden.length > 0) {
const hidden_address = 'hidden_address';
tx_type = 'zksnarks';
// loop through all hidden/anonymous outputs
async.eachSeries(vhidden, function(current_vhidden, loop) {
if (current_vhidden.vpub_old > 0) {
// process vout addresses and save the updated array
arr_vout = processVoutAddresses([hidden_address], parseFloat(current_vhidden.vpub_old), arr_vout);
// move to next vout
loop();
} else {
const amount_sat = module.exports.convert_to_satoshi(parseFloat(current_vhidden.vpub_new));
const index = module.exports.is_unique(arr_vin, hidden_address, 'addresses');
if ((!vout || vout.length == 0) && (!vin || vin.length == 0)) {
// hidden sender is sending to hidden recipient
// the sent and received values are not known in this case. only the fee paid is known and subtracted from the sender.
// process vout addresses and save the updated array
arr_vout = processVoutAddresses([hidden_address], 0, arr_vout);
// add a private send address with the known amount sent
if (index == -1) {
// add hidden address to array
arr_vin.push({addresses: hidden_address, amount: amount_sat});
} else {
// update hidden address amount in array
arr_vin[index].amount = arr_vin[index].amount + amount_sat;
}
// move to next vout
loop();
} else {
// add a private send address with the known amount sent
if (index == -1) {
// add hidden address to array
arr_vin.push({addresses: hidden_address, amount: amount_sat});
} else {
// update hidden address amount in array
arr_vin[index].amount += amount_sat;
}
// move to next vout
loop();
}
}
}, function() {
// finished updating hidden vout data
finalize_vout(vout[0], arr_vout, arr_vin, tx_type, txid, function(final_arr_vout, final_arr_vin, final_tx_type) {
return cb(final_arr_vout, final_arr_vin, final_tx_type);
});
});
} else {
// finalize vout data
finalize_vout(vout[0], arr_vout, arr_vin, tx_type, txid, function(final_arr_vout, final_arr_vin, final_tx_type) {
return cb(final_arr_vout, final_arr_vin, final_tx_type);
});
}
});
} catch(err) {
// check if a "Maximum call stack size exceeded" error occurred
if (err instanceof RangeError && /Maximum call stack size exceeded/i.test(err.message)) {
// return invalid results with error msg
return cb(null, null, 'StackSizeError');
} else {
// any other error should be output normally
throw err;
}
}
},
prepare_vin: function(tx, cb) {
let arr_vin = [];
let tx_type = null;
async.eachSeries(tx.vin, function(vin, loop) {
get_input_addresses(vin, tx.vout, function(addresses, tx_type_vin) {
// check if the tx type is set
if (tx_type_vin != null) {
// set the tx type return value
tx_type = tx_type_vin;
}
if (addresses && addresses.length) {
const amount_sat = module.exports.convert_to_satoshi(parseFloat(addresses[0].amount));
const index = module.exports.is_unique(arr_vin, addresses[0].hash, 'addresses');
if (index == -1)
arr_vin.push({addresses: addresses[0].hash, amount: amount_sat});
else
arr_vin[index].amount += amount_sat;
loop();
} else {
// could not decipher the address, save as unknown and move to next vin
console.log('Failed to find vin address from tx ' + tx.txid);
const index = module.exports.is_unique(arr_vin, 'unknown_address', 'addresses');
if (index == -1)
arr_vin.push({addresses: 'unknown_address', amount: 0});
loop();
}
});
}, function() {
return cb(arr_vin, tx_type);
});
},
create_lock: function(lock) {
const fs = require('fs');
var fname = './tmp/' + lock + '.pid';
try {
fs.appendFileSync(fname, process.pid.toString());
return true;
} catch(err) {
console.log("Error: Unable to remove lock: %s", fname);
return false;
}
},
remove_lock: function(lock) {
const fs = require('fs');
var fname = './tmp/' + lock + '.pid';
try {
fs.unlinkSync(fname);
return true;
} catch(err) {
console.log("Error: Unable to remove lock: %s", fname);
return false;
}
},
is_locked: function(lock_array, silent = false) {
const fs = require('fs');
const path = require('path');
var retVal = false;
// loop through all lock files that need to be checked
for (var i = 0; i < lock_array.length; i++) {
var pidFile = path.join(path.dirname(__dirname), 'tmp', `${lock_array[i]}.pid`);
// check if the script is already running (tmp/file.pid file already exists)
if (fs.existsSync(pidFile)) {
const { execSync } = require('child_process');
var deactivateLock = false;
// the pid file exists
// determine the operating system
switch (process.platform) {
case 'win32':
// windows
// run a cmd that will determine if the lock should still be active
var cmdResult = execSync(`tasklist /FI "PID eq ${fs.readFileSync(pidFile).toString()}"`);
// check if the process that created the lock is actually still running (crude check by testing for # of carriage returns or node.exe process running, but should work universally across different systems and languages)
if (cmdResult.toString().split('\n').length < 4 || cmdResult.toString().toLowerCase().indexOf('\nnode.exe') == -1) {
// lock should be deactivated
deactivateLock = true;
}
break;
default:
// linux or other
// run a cmd that will determine if the lock should still be active
try {
var cmdResult = execSync('ps -p `cat "' + pidFile + '"` > /dev/null');
} catch (err) {
// if an error occurs, the process is NOT running and therefore the lock should be deactivated
deactivateLock = true;
}
}
// check if the lock should be deactivated
if (deactivateLock) {
// script is not actually running so the lock file can be deleted
try {
fs.rmSync(pidFile);
} catch(err) {
if (!silent)
console.log(`Failed to delete lock file ${pidFile}: ${err}`);
}
} else {
// script is running
if (!silent)
console.log(`${lock_array[i]} script is running..`);
retVal = true;
break;
}
}
}
return retVal;
},
get_market_currency_code: function() {
let currency = '';
// check if the market price is being updated by coingecko api
if (settings.markets_page.market_price == 'COINGECKO') {
currency = (settings.markets_page.coingecko_currency == null || settings.markets_page.coingecko_currency == '' ? '' : settings.markets_page.coingecko_currency);
} else if (settings.markets_page.default_exchange.trading_pair != null && settings.markets_page.default_exchange.trading_pair.indexOf('/') > -1) {
currency = settings.markets_page.default_exchange.trading_pair.split('/')[1];
}
return currency;
}
};