Bitcoinrb

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(including BIP-65, BIP-68, BIP-112)
• 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, BIP-141, BIP-143, BIP-144)
• bech32(BIP-173) and bech32m(BIP-350) address support
• BIP-174 PSBT(Partially Signed Bitcoin Transaction) support
• BIP-85 Deterministic Entropy From BIP32 Keychains support by Bitcoin::BIP85Entropy class.
• Schnorr signature(BIP-340)
• Taproot consensus(BIP-341 and BIP-342)
• Output script descriptor (BIP-380, BIP-381, BIP-382, BIP-383, BIP-384, BIP-385, BIP-386, BIP-387)

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-native in your Gemfile and run bundle install.

gem 'leveldb-native'

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'

Examples can be found on the wiki.

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.

• default signet

Bitcoin.chain_params = :signet

This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/signet.yml.

This library can use the libsecp256k1 dynamic library. Therefore, some tests require this library. In a Linux environment, spec/lib/libsecp256k1.so is already located, so there is no need to do anything. If you want to test in another environment, please set the library path in the environment variable TEST_LIBSECP256K1_PATH.

In case the supplied linux spec/lib/libsecp256k1.so is not working (architecture), you might have to compile it yourself. Since if available in the repository, it might not be compiled using the ./configure --enable-module-recovery option. Then TEST_LIBSECP256K1_PATH=/path/to/secp256k1/.libs/libsecp256k1.so rspec can be used.

The libsecp256k1 library currently tested for operation with this library is v0.4.0.

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.