A minimal fork of Rust Bitcoin Library to support Bitcoin Cash.
Library with support for de/serialization, parsing and executing on data structures and network messages related to Bitcoin.
Supports (or should support)
This library should not be used for consensus code (i.e. fully validating blockchain data). It technically supports doing this, but doing so is very ill-advised because there are many deviations, known and unknown, between this library and the Bitcoin Cash node implementations. In a consensus based cryptocurrency such as Bitcoin it is critical that all parties are using the same rules to validate data.
Patches to fix specific consensus incompatibilities are welcome.
Currently can be found on the projects gitlab page. Patches to add usage examples and to expand on existing docs would be extremely appreciated.
Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before MRing them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss please join us in rustbitcoincash on Telegram.
This library should always compile with any combination of features on Rust 1.29.
Because some dependencies have broken the build in minor/patch releases, to
compile with 1.29.0 you will need to run the following version-pinning command:
cargo update -p cc --precise "1.0.41" --verbose
Rust can be installed using your package manager of choice or
rustup.rs. The former way is considered more secure since
it typically doesn't involve trust in the CA system. But you should be aware
that the version of Rust shipped by your distribution might be out of date.
Generally this isn't a problem for rust-bitcoin since we support much older
versions than the current stable one (see MSRV section).
The library can be built and tested using cargo:
git clone https://gitlab.com/rust-bitcoincash/rust-bitcoincash.git
cd rust-bitcoincash
cargo build
You can run tests with:
cargo test
Please refer to the cargo documentation for more detailed instructions.
Every PR needs at least two reviews to get merged. During the review phase
maintainers and contributors are likely to leave comments and request changes.
Please try to address them, otherwise your PR might get closed without merging
after a longer time of inactivity. If your PR isn't ready for review yet please
mark it by prefixing the title with WIP:.
Patches which add support for non-BitcoinCash cryptocurrencies by adding constants to existing enums (e.g. to set the network message magic-byte sequence) are welcome. Anything more involved will be considered on a case-by-case basis, as the altcoin landscape includes projects which frequently appear and disappear, and are poorly designed anyway and keeping the codebase maintainable is a large priority.
In general, things that improve cross-chain compatibility (e.g. support for cross-chain atomic swaps) are more likely to be accepted than things which support only a single blockchain.
See CHANGELOG.md.
The code in this project is licensed under the Creative Commons CC0 1.0 Universal license.