[BREAKGLASS] Append-only mirror of github.com/mempool/node-bitcoin
|
|
||
|---|---|---|
| lib | ||
| test | ||
| index.js | ||
| package.json | ||
| README.md | ||
| test.js | ||
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.
Install
npm install bitcoin
Setup
-
Traverse to
~/.bitcoinor~/Library/Application Support/Bitcoinand add a file calledbitcoin.confif it doesn't already exist. -
Add these lines to the file:
rpcuser=username
rpcpassword=password
You will use these to login to the server.
-
Start your Bitcoin client with the
-serverargument or runbitcoind -
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);
});