kryptokrona-service-rpc-js
v0.0.3
Published
Wrapper for the kryptokrona walletd daemon JSON-RPC interface
Downloads
8
Readme
kryptokrona-service-rpc-js
A js wrapper for the kryptokrona walletd JSON-RPC interface
Example
import KryptokronaService from 'kryptokrona-service-rpc-js'
let walletd = new KryptokronaService(
'http://localhost',
8070,
'myRpcPassword'
)
walletd.getStatus()
.then(resp => {
console.log(resp.body)
})
.catch(err => {
console.log(err)
})
> {"id":0,"jsonrpc":"2.0","result":{"blockCount":240364,"knownBlockCount":0,"lastBlockHash":"f50dce59476febf23b07d45f3cbe8fbab13a0d79b4cf02b4314035327d2a3e79","peerCount":0}}
Installation
Install with npm
npm install kryptokrona-service-rpc-js
or
npm install kryptokrona-service-rpc-js --save
Usage
Import
First, import / require KryptokronaService
Using Module 'default'
import KryptokronaService from 'kryptokrona-service-rpc-js'
or
var KryptokronaService = require('kryptokrona-service-rpc-js').default
Using Named Import
import { KryptokronaService } from 'kryptokrona-service-rpc-js'
or
var { KryptokronaService } = require('kryptokrona-service-rpc-js').default
Instantiating the RPC client
Construct an instance of the KryptokronaService class with host and port of running daemon along with the rpc password.
An optional boolean
arg may be passed to turn logging on or off.
var walletd = new KryptokronaService(
hostname,
port,
password,
logging
)
Note: hostname
must contain http://
prefix.
Using the RPC Client
Instance methods of KryptokronaService correspond to the JSON RPC method calls. Each method initiates an asynchronous HTTP request to the walletd daemon. Both Promise and Callback styles are supported.
Success callbacks pass a response
object with status
, header
, and body
properties.
Error callbacks pass an error
object.
Promise Style
walletd
.getStatus()
.then(resp => {
console.log(resp.status)
console.log(resp.headers)
console.log(resp.body)
})
.catch(err => {
console.log(err)
})
Callback Style
walletd.getStatus(
resp => {
console.log(resp.status)
console.log(resp.headers)
console.log(resp.body)
},
err => {
console.log(err)
}
)
API
API docs with method/parameter information is in the works. Check back soon!
Contribute
Fork the repo at http://github.com/kryptokrona/kryptokrona-service-rpc-js, create a feature branch and subbmit PRs from feature branch to master
Bugs/Issues/Feature Requests
File issues at http://github.com/kryptokrona/kryptokrona-service-rpc-js/issues
Thanks
Big thanks to @fexra for bughunting, testing, feedback and other help.