/sibit

Simplified Command-Line Bitcoin Client and a Ruby library for making Bitcoin payments and checking address balances

Primary LanguageRubyMIT LicenseMIT

logo

EO principles respected here DevOps By Rultor.com We recommend RubyMine

rake PDD status Gem Version Maintainability License Test Coverage Hits-of-Code

To understand how Bitcoin protocol works, I recommend you watching this short video and then reading this blog post of mine: Sibit Demonstrates How Bitcoin Works.

This is a simple Bitcoin client, to use from the command line or from your Ruby app. You don't need to run any Bitcoin software, no need to install anything, and so on. All you need is just a command line and Ruby 2.3+. The purpose of this client is to simplify most typical operations with Bitcoin. If you need something more complex, I would recommend using bitcoin-ruby for Ruby and Electrum as a GUI client.

You may want to discuss this tool at Bitcointalk and give the thread a few merits.

This is a Ruby gem, install it first (if doesn't work, there are some hints at the bottom of this page):

$ gem install sibit

Then, you generate a private key:

$ sibit generate
E9873D79C6D87FC233AA332626A3A3FE

Next, you create a new address, using your private key:

$ sibit create E9873D79C6D87FC233AA332626A3A3FE
1CC3X2gu58d6wXUWMffpuzN9JAfTUWu4Kj

To check the balance at the address (the result is in satoshi):

$ sibit balance 1CC3X2gu58d6wXUWMffpuzN9JAfTUWu4Kj
80988977

To send a payment from a few addresses to a new address:

$ sibit pay AMOUNT FEE A1:P1,A2:P2,... TARGET CHANGE
e87f138c9ebf5986151667719825c28458a28cc66f69fed4f1032a93b399fdf8

Here, AMOUNT is the amount of satoshi you are sending, FEE is the miner fee you are ready to spend to make this transaction delivered (you can say S, M, L, or XL if you want it to be calculated automatically), A1:P1,A2:P2,... is a comma-separated list of addresses A and private keys P you are sending your coins from, TARGET is the address you are sending to, CHANGE is the address where the change will be sent to. The transaction hash will be returned. Not all UTXOs will be used, but only the necessary amount of them.

By default, the fee will be paid on top of the payment amount you are sending. Say, you are sending 0.5 BTC and the fee is 0.0001 BTC. Totally, you will spend 0.5001. However, you can make Sibit deduct the fee from the payment amount. In this case you should provide a negative amount of the fee or one of -S, -M, -L, -XL. You can also say +S, if you want the opposite, which is the default.

It is recommended to run it with --dry --verbose options first, to see what's going to be sent to the network. If everything looks correct, remove the --dry and run again, the transaction will be pushed to the network.

All operations are performed through the Blockchain API. Transactions are pushed to the Bitcoin network via this relay.

Ruby SDK

You can do the same from your Ruby app:

require 'sibit'
sibit = Sibit.new
pkey = sibit.generate
address = sibit.create(pkey)
balance = sibit.balance(address)
target = sibit.create(pkey) # where to send coins to
change = sibit.create(pkey) # where the change will be sent to
tx = sibit.pay(10_000_000, 'XL', { address => pkey }, target, change)

Should work.

APIs

The library works through one (or a few) public APIs for fetching Bitcoin data and pushing transactions to the network. At the moment we work with the following APIs:

The first one in this list is used by default. If you want to use a different one, you just specify it in the constructor of Sibit object:

require 'sibit'
require 'sibit/btc'
sibit = Sibit.new(api: Sibit::Btc.new)

You may also use a combination of APIs. This may be very useful since some APIs are not reliable and others don't have all the features required. You can provide an array of objects and they will be used one by one, until a successful response is obtained:

require 'sibit'
require 'sibit/btc'
require 'sibit/cryptoapis'
sibit = Sibit.new(
  api: Sibit::FirstOf.new(
    [
      Sibit::Btc.new,
      Sibit::Cryptoapis.new('key')
    ]
  )
)

If you think we may need to use some other API, you can submit a ticket, or implement it yourself and submit a pull request.

How to install

To install on a fresh Ubuntu 18:

$ sudo apt-get update
$ sudo apt-get install -y ruby ruby-dev autoconf automake build-essential
$ sudo gem update --system
$ gem install rake --no-document
$ gem install sibit

Should work. If it doesn't, submit an issue, I will try to help.

How to contribute

Read these guidelines. Make sure your build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ bundle exec rake

If it's clean and you don't see any error messages, submit your pull request.

If it doesn't build on MacOS, check this out.