Bitcoinrb Build Status Gem Version MIT License

Bitcoinrb is a Ruby implementation of Bitcoin Protocol.

NOTE: Bitcoinrb work in progress, and there is a possibility of incompatible change.

Features

Bitcoinrb supports following feature:

  • Bitcoin script interpreter
  • De/serialization of Bitcoin protocol network messages
  • De/serialization of blocks and transactions
  • Key generation and verification for ECDSA, including BIP-32 and BIP-39 supports.
  • Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, etc..)
  • [WIP] SPV node
  • [WIP] 0ff-chain protocol

Requirements

bitcoinrb requires a leveldb library.

install LevelDB

  • for Ubuntu

    $ sudo apt-get install libleveldb-dev

  • for Mac

    $ brew install leveldb

Installation

Add this line to your application's Gemfile:

gem 'bitcoinrb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bitcoinrb

Usage

TODO: Write usage instructions here

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bitcoinrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.