node-verge
v0.3.9
Published
nodejs VERGE client
Downloads
12
Readme
____ _________________________ ________ ___________
\ \ / /\_ _____/\______ \ / _____/ \_ _____/
\ Y / | __)_ | _// \ ___ | __)_
\ / | \ | | \\ \_\ \ | \ 2016 VERGE
\___/ /_______ / |____|_ / \______ //_______ /
\/ \/ \/ \/
A Node.js VERGE Client
node-verge is a VERGE client for node.js
It is a fork of the excellent Kapitalize Bitcoin Client (now removed from GitHub) intended for use with VERGE. The purpose of this repository is:
- Provide a one-stop resource for the Node.js developer to get started with VERGE integration.
- Prevent would-be VERGE web developers worrying whether a VERGE client will work out of the box, or have to construct their own.
- Promote Node.js development of VERGE web apps.
- Identify and address any incompatibilities with the VERGE APIs that exist now, and/or in the future.
Dependencies
You'll need a running instance of verged to connect with.
Then, install the node-verge NPM package.
npm install node-verge
Examples
Some code examples follow below
var verge = require('node-verge')()
verge.auth('myusername', 'mypassword')
verge.getDifficulty(function() {
console.log(arguments);
})
Chaining
Pretty much everything is chainable.
var verge = require('node-verge')()
verge
.auth('MyUserName', 'mypassword')
.getNewAddress()
.getBalance()
Methods
The Litecoin API is supported as direct methods. Use either camelcase or lowercase.
verge.getNewAddress(function(err, address) {
this.validateaddress(address, function(err, info) {
})
})
.exec(command [string], ...arguments..., callback [function])
Executes the given command with optional arguments. Function callback
defaults to console.log
.
All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!
verge.exec('getNewAddress')
verge.exec('getbalance', function(err, balance) {
})
.set(key [string, object], value [optional])
Accepts either key & value strings or an Object containing settings, returns this
for chainability.
verge.set('host', '127.0.0.1')
.get(key [string])
Returns the specified option's value
verge.get('user')
.auth(user [string], pass [string])
Generates authorization header, returns this
for chainability
Commands
TODO: Write tests for these.
All Litecoin API commands are supported, in lowercase or camelcase form.
Generation is limited to [genproclimit] processors, -1 is unlimited.
Options
You may pass options to the initialization function or to the set
method.
var verge = require('verge')({
user:'user'
})
verge.set('pass', 'somn')
verge.set({port:20102})
Available options and default values:
- host localhost
- port 20102
- user
- pass
- passphrasecallback
- https
- ca
Passphrase Callback
With an encryped wallet, any operation that accesses private keys requires a wallet unlock. A wallet is unlocked using the walletpassphrase <passphrase> <timeout>
JSON-RPC method: the wallet will relock after timeout
seconds.
You may pass an optional function passphrasecallback
to the node-verge
initialization function to manage wallet unlocks. passphrasecallback
should be a function accepting three arguments:
function(command, args, callback) {}
- command is the command that failed due to a locked wallet.
- args is the arguments for the failed command.
- callback is a typical node-style continuation callback of the form
function(err, passphrase, timeout) {}
. Call callback with the wallet passphrase and desired timeout from within your passphrasecallback to unlock the wallet.
You may hard code your passphrase (not recommended) as follows:
var verge = require('node-verge')({
passphrasecallback: function(command, args, callback) {
callback(null, 'passphrase', 30);
}
})
Because passphrasecallback
is a continuation, you can retrieve the passphrase in an asynchronous manner. For example, by prompting the user:
var readline = require('readline')
var rl = readline.createInterface({
input: process.stdin,
output: process.stdout
})
var verge = require('node-verge')({
passphrasecallback: function(command, args, callback) {
rl.question('Enter passphrase for "' + command + '" operation: ', function(passphrase) {
if (passphrase) {
callback(null, passphrase, 1)
} else {
callback(new Error('no passphrase entered'))
}
})
}
})
Secure RPC with SSL
By default verged
exposes its JSON-RPC interface via HTTP; that is, all RPC commands are transmitted in plain text across the network! To secure the JSON-RPC channel you can supply verged
with a self-signed SSL certificate and an associated private key to enable HTTPS. For example, in your verge.conf
:
rpcssl=1
rpcsslcertificatechainfile=/etc/ssl/certs/verged.crt
rpcsslprivatekeyfile=/etc/ssl/private/verged.pem
In order to securely access an SSL encrypted JSON-RPC interface you need a copy of the self-signed certificate from the server: in this case verged.crt
. Pass your self-signed certificate in the ca
option and set https: true
and node-verge is secured!
var fs = require('fs')
var ca = fs.readFileSync('verged.crt')
var verge = require('node-verge')({
user: 'rpcusername',
pass: 'rpcpassword',
https: true,
ca: ca
})
Testing
npm install -g nodeunit
nodeunit test/test-node-verge.js
Bounties
VERGE donation address is DPNC2H2pYUCSebQ992GyeRTRuWw3hCTBwD
Donations in verge will be used for bounties, and holding. As a side note: I encourage all GitHub repository owners to post a donation address so their community can easily support development financially.