darkcoin

1.0.0 • Public • Published

node-darkcoin

A node.js wrapper for communicating with a darkcoin server via JSON-RPC.

Setup darkcoin daemon

I believe that in order to connect to the json-rpc server, you must specifically set the port in the config file. The first time I tried connecting to the default port, I did not get a response.

To set this up, edit your darkcoin.conf file.

On linux, this is located by default at /home/username/.darkcoin/darkcoin.conf

On windows this is located by default at need to look this up...

This file must have these three lines:

rpcuser=username
rpcpassword=password
rpcport=8332

By default it will have the first two, you will need to add the rpcport=8332 yourself.

Install

npm install darkcoin

Usage

Initialize

var Darkcoin = require('darkcoin');
 
var options = {
  port: 8332,
  host: '127.0.0.1',
  login: 'USERNAME HERE',
  hash: 'PASSWORD HERE'
};
 
var darkcoin = new Darkcoin.Connection(options);

Send Commands

Commands are sent through the method call. The syntax is:

darkcoin.call(command, arguments, callback);
//Where callback has the form:
function(err,res)

command can be any of the commands that you can pass to darkcoind.

arguments has three forms.

  • If there is no argument for your command, it must be null.
  • If there is a singular argument, it can be passed as a string or number.
  • If there are multiple commands, it must be passed as an array [option1, option2]

getInfo example

darkcoin.call('getinfo', null, function(err, res) {
    if (err) {
        throw err;
    } else {
        console.log(res);
    }
});

Avalible commands

There is not an API published of specifically darkcoin commands that I am aware of, however they can be found in two places. We can look at the Darkcoin source files beginning with 'rpc', for example rpcblockchain.cpp. The second, and more user friendly place is the Litecoin API as it is what Darkcoin is based on.

Readme

Keywords

Package Sidebar

Install

npm i darkcoin

Weekly Downloads

1

Version

1.0.0

License

none

Last publish

Collaborators

  • nmjohnson