Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaintope/bitcoinrb
The implementation of the bitcoin protocol for ruby.
https://github.com/chaintope/bitcoinrb
bitcoin blockchain ruby
Last synced: 5 days ago
JSON representation
The implementation of the bitcoin protocol for ruby.
- Host: GitHub
- URL: https://github.com/chaintope/bitcoinrb
- Owner: chaintope
- License: mit
- Created: 2017-06-13T09:12:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T00:57:12.000Z (4 months ago)
- Last Synced: 2024-10-29T22:44:55.639Z (2 months ago)
- Topics: bitcoin, blockchain, ruby
- Language: Ruby
- Homepage:
- Size: 32.7 MB
- Stars: 62
- Watchers: 12
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-bitcoin - bitcoinrb - Ruby bitcoin library including script interpreter. (Ruby Libraries)
README
# Bitcoinrb [](https://github.com/chaintope/bitcoinrb/actions/workflows/ruby.yml) [](https://badge.fury.io/rb/bitcoinrb) [](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](https://github.com/chaintope/bitcoinrb/wiki/Script)(including [BIP-65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki), [BIP-68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki), [BIP-112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))
* [De/serialization of Bitcoin protocol network messages](https://github.com/chaintope/bitcoinrb/wiki/P2P-Message)
* De/serialization of blocks and [transactions](https://github.com/chaintope/bitcoinrb/wiki/Transaction)
* Key generation and verification for ECDSA, including [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) supports.
* ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
* Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, [BIP-141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki), [BIP-143](https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki), [BIP-144](https://github.com/bitcoin/bips/blob/master/bip-0144.mediawiki))
* bech32([BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki)) and bech32m([BIP-350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki)) address support
* [BIP-174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) PSBT(Partially Signed Bitcoin Transaction) support
* [BIP-85](https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki) Deterministic Entropy From BIP32 Keychains support by `Bitcoin::BIP85Entropy` class.
* Schnorr signature([BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki))
* Taproot consensus([BIP-341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki) and [BIP-342](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki))
* [Output script descriptor](https://github.com/chaintope/bitcoinrb/wiki/Output-Script-Descriptor) ([BIP-380](https://github.com/bitcoin/bips/blob/master/bip-0380.mediawiki), [BIP-381](https://github.com/bitcoin/bips/blob/master/bip-0381.mediawiki), [BIP-382](https://github.com/bitcoin/bips/blob/master/bip-0382.mediawiki), [BIP-383](https://github.com/bitcoin/bips/blob/master/bip-0383.mediawiki), [BIP-384](https://github.com/bitcoin/bips/blob/master/bip-0384.mediawiki), [BIP-385](https://github.com/bitcoin/bips/blob/master/bip-0385.mediawiki), [BIP-386](https://github.com/bitcoin/bips/blob/master/bip-0386.mediawiki), [BIP-387](https://github.com/bitcoin/bips/blob/master/bip-0387.mediawiki))
## Requirements
### use Node implementation
If you use node features, please install level DB as follows.
#### install LevelDB
* for Ubuntu
$ sudo apt-get install libleveldb-dev
+ for Mac
$ brew install leveldb
and put `leveldb-native` in your Gemfile and run bundle install.
```ruby
gem 'leveldb-native'
```
## Installation
Add this line to your application's Gemfile:
```ruby
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'
## Usage
Examples can be found on the [wiki](https://github.com/chaintope/bitcoinrb/wiki).
### Chain selection
The parameters of the blockchain are managed by `Bitcoin::ChainParams`. Switch chain parameters as follows:
* mainnet
```ruby
Bitcoin.chain_params = :mainnet
```
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/mainnet.yml.
* testnet
```ruby
Bitcoin.chain_params = :testnet
```
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/testnet.yml.
* regtest
```ruby
Bitcoin.chain_params = :regtest
```
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/regtest.yml.
* default signet
```ruby
Bitcoin.chain_params = :signet
```
This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/signet.yml.
## Test
This library can use the [libsecp256k1](https://github.com/bitcoin-core/secp256k1/) 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`.
## 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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).