Communicate with clamd via JSON-RPC
JavaScript Makefile
Clone or download
Pull request Compare This branch is 21 commits ahead, 33 commits behind freewil:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.gitmodules
.npmignore
.travis.yml
Makefile
Readme.md
package.json

Readme.md

node-clamcoin Build Status

node-clamcoin is a simple wrapper for the CLAM client's JSON-RPC API.

The methods are exposed as lower camelcase methods on the clamcoin.Client object, or you may call the API directly using the cmd method.

Install

npm install clamcoin

Examples

Create client

// all config options are optional
var client = new clamcoin.Client({
  host: 'localhost',
  port: 8332,
  user: 'username',
  pass: 'password',
  timeout: 30000
});

Get balance across all accounts with minimum confirmations of 6

client.getBalance('*', 6, function(err, balance, resHeaders) {
  if (err) return console.log(err);
  console.log('Balance:', balance);
});

Getting the balance directly using cmd

client.cmd('getbalance', '*', 6, function(err, balance, resHeaders){
  if (err) return console.log(err);
  console.log('Balance:', balance);
});

Batch multiple RPC calls into single HTTP request

var batch = [];
for (var i = 0; i < 10; ++i) {
  batch.push({
    method: 'getnewaddress',
    params: ['myaccount']
  });
}
client.cmd(batch, function(err, address, resHeaders) {
  if (err) return console.log(err);
  console.log('Address:', address);
});

SSL

If you're using this to connect to clamd across a network it is highly recommended to enable ssl, otherwise an attacker may intercept your RPC credentials resulting in theft of your clamcoins.

When enabling ssl by setting the configuration option to true, the sslStrict option (verifies the server certificate) will also be enabled by default. It is highly recommended to specify the sslCa as well, even if your clamd has a certificate signed by an actual CA, to ensure you are connecting to your own clamd.

var client = new clamcoin.Client({
  host: 'localhost',
  port: 8332,
  user: 'username',
  pass: 'password',
  ssl: true,
  sslStrict: true,
  sslCa: fs.readFileSync(__dirname + '/myca.cert')
});