dashd-rpc
Dash Client Library to connect to Dash Core (dashd) via RPC
Install
dashd-rpc runs on node, and can be installed via npm:
npm install @dashevo/dashd-rpcUsage
RpcClient
Config parameters :
- 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: 9998) - Set the port on which perform the RPC command.
Promise vs callback based
require('@dashevo/dashd-rpc/promise')to have promises returnedrequire('@dashevo/dashd-rpc')to have callback functions returned
Examples
Config:
var config = {
protocol: 'http',
user: 'dash',
pass: 'local321',
host: '127.0.0.1',
port: 19998
};Promise based:
var RpcClient = require('@dashevo/dashd-rpc/promise');
var rpc = new RpcClient(config);
rpc.getRawMemPool()
.then(ret => {
return Promise.all(ret.result.map(r => rpc.getRawTransaction(r)))
})
.then(rawTxs => {
rawTxs.forEach(rawTx => {
console.log(`RawTX: ${rawTx.result}`);
})
})
.catch(err => {
console.log(err)
})Callback based (legacy):
var run = function() {
var bitcore = require('@dashevo/dashcore-lib');
var RpcClient = require('@dashevo/dashd-rpc');
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('@dashevo/dashd-rpc');
var client = new RPCclient({
protocol:'http',
user: 'dash',
pass: 'local321',
host: '127.0.0.1',
port: 19998,
timeout: 1000
});
var cb = function (err, data) {
console.log(data)
};
// Get full help
client.help(cb);
// Get help of specific method
client.help('getinfo',cb);
Contributing
Feel free to dive in! Open an issue or submit PRs.
License
MIT © Dash Core Group, Inc.