node-gameunits v0.3.9

A Node.js Gameunits Client!

node-gameunits is a Gameunits client for Node.js.

• Provide a one-stop resource for the Node.js developer to get started with Gameunits integration.
• Prevent would-be Gameunits web developers worrying whether a Gameunits client will work out of the box.
• Promote Node.js development of Gameunits web apps.

Dependencies

You'll need a running instance of gameunitsd to connect with.

Then, install the node-gameunits NPM package.

npm install node-gameunits

Examples

var gameunits = require('node-gameunits')()

gameunits.auth('myusername', 'mypassword')

gameunits.getDifficulty(function() {
    console.log(arguments);
})

Chaining

Pretty much everything is chainable.

var gameunits = require('node-gameunits')()

gameunits
.auth('MyUserName', 'mypassword')
.getNewAddress()
.getBalance()

Methods

The API is supported as direct methods. Use either camelcase or lowercase.

gameunits.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!

gameunits.exec('getNewAddress')

gameunits.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.

gameunits.set('host', '127.0.0.1')

.get(key string)

Returns the specified option's value

gameunits.get('user')

.auth(user string, pass string)

Generates authorization header, returns this for chainability

Commands

TODO: Write tests for these.

All Gameunits 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 gameunits = require('gameunits')({
    user:'user'
})

gameunits.set('pass', 'somn')
gameunits.set({port:40001})

Available options and default values:

• host localhost
• port 40001
• 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-gameunits 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 gameunits = require('node-gameunits')({
    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 gameunits = require('node-gameunits')({
  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 gameunitsd 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 gameunitsd with a self-signed SSL certificate and an associated private key to enable HTTPS. For example, in your gameunits.conf:

rpcssl=1
rpcsslcertificatechainfile=/etc/ssl/certs/gameunitsd.crt
rpcsslprivatekeyfile=/etc/ssl/private/gameunitsd.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 gameunitsd.crt. Pass your self-signed certificate in the ca option and set https: true and node-gameunits is secured!

var fs = require('fs')

var ca = fs.readFileSync('gameunitsd.crt')

var gameunits = require('node-gameunits')({
  user: 'rpcusername',
  pass: 'rpcpassword',
  https: true,
  ca: ca
})

Testing

npm install -g nodeunit

nodeunit test/test-node-gameunits.js