Bitcoinrb is a Ruby implementation of Bitcoin Protocol.
NOTE: Bitcoinrb work in progress, and there is a possibility of incompatible change.
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.
- ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
- Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, etc..)
- PSBT(Partially Signed Bitcoin Transaction) support
- [WIP] SPV node
- [WIP] 0ff-chain protocol
If you use node features, please install level DB as follows.
-
for Ubuntu
$ sudo apt-get install libleveldb-dev
-
for Mac
$ brew install leveldb
and put leveldb-ruby
in your Gemfile and run bundle install.
gem leveldb-ruby
Add this line to your application's Gemfile:
gem 'bitcoinrb', require: 'bitcoin'
And then execute:
$ bundle
Or install it yourself as:
$ gem install bitcoinrb
And then add to your .rb file:
require 'bitcoin'
The parameters of the blockchain are managed by Bitcoin::ChainParams
. Switch chain parameters as follows:
- mainnet
Bitcoin.chain_params = :mainnet
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/mainnet.yml.
- testnet
Bitcoin.chain_params = :testnet
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/testnet.yml.
- regtest
Bitcoin.chain_params = :regtest
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/regtest.yml.
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.
The gem is available as open source under the terms of the MIT License.