@geekcash/geekcash-rpc
v1.0.3
Published
JavaScript Client Library to connect to GeekCash via RPC
Downloads
7
Readme
geekcash-rpc.js
A client library to connect to Dash Core RPC in JavaScript.
Get Started
geekcash-rpc.js runs on node, and can be installed via npm:
npm install @geekcash/geekcash-rpc
RpcClient
Arguments :
- protocol : (string - optional) - (default: 'https') - Set the protocol to be used. Either `http` or `https`.
- user : (string - optional) - (default: 'user') - Set the user credential.
- pass : (string - optional) - (default: 'pass') - Set the password credential.
- host : (string - optional) - (default: '127.0.0.1') - The host you want to connect with.
- port : (integer - optional) - (default: 6888) - Set the port on which perform the RPC command.
Examples
var run = function() {
var bitcore = require('bitcore');
var RpcClient = require('@geekcash/geekcash-rpc');
var config = {
protocol: 'http',
user: 'user',
pass: 'pass',
host: '127.0.0.1',
port: 19998
};
var rpc = new RpcClient(config);
var txids = [];
function showNewTransactions() {
rpc.getRawMemPool(function (err, ret) {
if (err) {
console.error(err);
return setTimeout(showNewTransactions, 10000);
}
function batchCall() {
ret.result.forEach(function (txid) {
if (txids.indexOf(txid) === -1) {
rpc.getRawTransaction(txid);
}
});
}
rpc.batch(batchCall, function(err, rawtxs) {
if (err) {
console.error(err);
return setTimeout(showNewTransactions, 10000);
}
rawtxs.map(function (rawtx) {
var tx = new bitcore.Transaction(rawtx.result);
console.log('\n\n\n' + tx.id + ':', tx.toObject());
});
txids = ret.result;
setTimeout(showNewTransactions, 2500);
});
});
}
showNewTransactions();
};
Help
You can dynamically access to the help of each method by doing
const RpcClient = require('@geekcash/geekcash-rpc');
var client = new RPCclient({
protocol:'http',
user: 'root',
pass: 'password',
host: '127.0.0.1',
port: 6888
});
var cb = function (err, data) {
console.log(data)
};
client.help(cb); //Get full help
client.help('getinfo',cb); //Get help of specific method
License
Code released under the MIT license.
Copyright 2013-2014 BitPay, Inc.