[BREAKGLASS] Append-only mirror of github.com/mempool/node-bitcoin
Go to file
2010-12-19 10:21:57 -05:00
lib Tested on 0.2.3 2010-12-19 09:47:59 -05:00
package.json Added dependencies to package.json 2010-12-19 10:21:57 -05:00
README.md small fix 2010-12-19 09:50:54 -05:00
test.js Initial commit 2010-12-19 08:50:53 -05:00

node-bitcoin

node-bitcoin is a simple wrapper for the Bitcoin client's JSON-RPC API.

The API is equivalent to the API document here. The methods are exposed as lower camelcase methods on the bitcoin.Client object.

Setup

  1. Traverse to ~/.bitcoin or ~/Library/Application Support/Bitcoin and add a file called bitcoin.conf if it doesn't already exist.

  2. Add these lines to the file:

    rpcuser=username

    rpcpassword=password

You will use these to login to the server.

  1. Start your Bitcoin client with the -server argument or run bitcoind

  2. You should now be able to communicate with Bitcoin JSON-RPC API using the node-bitcoin library, try it out!

Example

var bitcoin = require('bitcoin');
var client = new bitcoin.Client('localhost', 8332, 'username', 'password');

client.getBalance(function(balance) {
  console.log("Balance:", balance);
}