Bitcoind

Automate your Bitcoin transactions with this Ruby interface to the bitcoind JSON-RPC API.

Connecting

Before connecting, you will need to configure a username and password for bitcoind, and start bitcoind. See example bitcoin.conf file:

rpcssl=1
#rpcallowip=10.0.*.*
rpcuser=yourUsername
rpcpassword=veryS3cr3t

Please make sure that SSL is activated. If you want to bind bitcoind to a specific IP delete comment sign before rpcallowip. For more information about SSL configuration see https://en.bitcoin.it/wiki/Enabling_SSL_on_original_client_daemon

Once that's done:

client = Bitcoind.new 'username', 'password'
  # => #<Bitcoind::Client "https://username:password@localhost:8332" >

client = Bitcoind.new 'username', 'password', 'remote_ip'
  # => #<Bitcoind::Client "https://username:password@remote_ip:8332" >

Account Balances

You can get the balance of all addresses controlled by the client:

client.balance
  # => 12.34

You can also get a hash of all accounts the client controls:

client.accounts
  # => {"Your Address"=>#<Bitcoind::Account "Your Address" >, "eve-online ransoms"=>#<Bitcoind::Account "eve-online ransoms" >}

And of course each account has its own balance too:

ransom = client.accounts['eve-online ransoms']
  # => #<Bitcoind::Account "eve-online ransoms" >
ransom.balance
  # => 2.19

Transactions

You can get all the transactions in an account:

ransom.transactions
  # => [#<Bitcoind::Transaction abadbabe123deadbeef 2.19 to eve-online ransoms at 2011-02-19 16:21:09 -0500>]

You can send money from an account too:

ransom.send_to 'destinationaddress', 2
  # => #<Bitcoind::Account deadbeef888abadbeef UNCONFIRMED>

Making Accounts

Creating an account with an associated address is done through the accounts interface:

tiny_wings = client.accounts.new 'tiny wings ransoms'
  # => #<Bitcoind::Account "tiny wings ransoms" >
tiny_wings.address
  # => "1KV5khnHbbHF2nNQkk7Pe5nPndEj43U27r"

Contributing

• Fork the project on GitHub
• Write tests for your changes locally
• Make the tests pass by implementing the changes
• Push your changes to GitHub.
• Send a pull request.

Copyright

Copyright (c) 2011 Bryce Kerley. See LICENSE.txt for further details.