https://github.com/dashpay/dashd-rpc
Dash Client Library to connect to Dash Core (dashd) via RPC
https://github.com/dashpay/dashd-rpc
backend dapi platform
Last synced: about 1 month ago
JSON representation
Dash Client Library to connect to Dash Core (dashd) via RPC
- Host: GitHub
- URL: https://github.com/dashpay/dashd-rpc
- Owner: dashpay
- License: mit
- Created: 2017-06-29T01:02:26.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T10:52:50.000Z (11 months ago)
- Last Synced: 2025-04-30T06:45:41.376Z (about 1 month ago)
- Topics: backend, dapi, platform
- Language: JavaScript
- Homepage:
- Size: 347 KB
- Stars: 16
- Watchers: 16
- Forks: 67
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dashd-rpc
[](https://github.com/dashevo/dashd-rpc/actions/workflows/test.yml)
[](https://www.npmjs.org/package/@dashevo/dashd-rpc)
Dash Client Library to connect to Dash Core (dashd) via RPC
## Install
dashd-rpc runs on [node](http://nodejs.org/), and can be installed via [npm](https://npmjs.org/):
```bash
npm install @dashevo/dashd-rpc
```
## Usage
### 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 returned
- `require('@dashevo/dashd-rpc')` to have callback functions returned
### Examples
Config:
```javascript
var config = {
protocol: 'http',
user: 'dash',
pass: 'local321',
host: '127.0.0.1',
port: 19998
};
```
Promise based:
```javascript
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):
```javascript
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](https://github.com/dashevo/dash-std-template/issues/new) or submit PRs.
## License
[MIT](LICENSE) © Dash Core Group, Inc.