#bitcoin #script #key #deserialize #input #transaction #block

no-std bitcoincash

General purpose library for using and interoperating with Bitcoin Cash and other cryptocurrencies

7 releases (4 breaking)

0.29.2 Dec 20, 2022
0.29.1 Sep 11, 2022
0.28.1 May 24, 2022
0.25.2 Jan 8, 2021
0.0.2 Oct 25, 2019

#106 in Magic Beans

Download history 104/week @ 2024-03-02 46/week @ 2024-03-09 82/week @ 2024-03-16 61/week @ 2024-03-23 145/week @ 2024-03-30 101/week @ 2024-04-06 112/week @ 2024-04-13 28/week @ 2024-04-20 32/week @ 2024-04-27 105/week @ 2024-05-04 75/week @ 2024-05-11 80/week @ 2024-05-18 104/week @ 2024-05-25 84/week @ 2024-06-01 111/week @ 2024-06-08 131/week @ 2024-06-15

433 downloads per month
Used in 3 crates

CC0 license

1.5MB
21K SLoC

pipeline status Safety Dance

Rust Bitcoin Cash Library

A minimal fork of Rust Bitcoin Library to support Bitcoin Cash.

Documentation

Supports (or should support)

  • De/serialization of Bitcoin protocol network messages
  • De/serialization of blocks and transactions
  • Script de/serialization
  • Private keys and address creation, de/serialization and validation (including full BIP32 support)
  • PSBT v0 de/serialization and all but the Input Finalizer role. Use rust-miniscript to finalize.

Changes from upstream

  • Added testnet4, scalenet and chipnet support
  • Increased network message size limit (allow for 256MB blocks)
  • Support for CashTokens

It is recommended to always use cargo-crev to verify the trustworthiness of each of your dependencies, including this one.

Known limitations

Consensus

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.

Support for 16-bit pointer sizes

16-bit pointer sizes are not supported and we can't promise they will be. If you care about them please let us know, so we can know how large the interest is and possibly decide to support them.

Documentation

Currently can be found on the projects gitlab page. Patches to add usage examples and to expand on existing docs would be extremely appreciated.

Contributing

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.

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features (minus no-std) on Rust 1.41.1 or Rust 1.47 with no-std.

Installing Rust

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).

Building

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.

Building the docs

We build docs with the nightly toolchain, you may wish to use the following shell alias to check your documentation changes build correctly.

alias build-docs='RUSTDOCFLAGS="--cfg docsrs" cargo +nightly rustdoc --features="$FEATURES" -- -D rustdoc::broken-intra-doc-links'

Running benchmarks

We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the bench marks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.

Pull Requests

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: .

CI Pipeline

The CI pipeline requires approval before being run on each MR.

In order to speed up the review process the CI pipeline can be run locally using act. The fuzz and Cross jobs will be skipped when using act due to caching being unsupported at this time. We do not actively support act but will merge PRs fixing act issues.

Githooks

To assist devs in catching errors before running CI we provide some githooks. If you do not already have locally configured githooks you can use the ones in this repository by running, in the root directory of the repository:

git config --local core.hooksPath githooks/

Alternatively add symlinks in your .git/hooks directory to any of the githooks we provide.

Policy on Altcoins/Altchains

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.

Release Notes

See CHANGELOG.md.

Licensing

The code in this project is licensed under the Creative Commons CC0 1.0 Universal license. We use the SPDX license list and SPDX IDs.

Dependencies

~5–8MB
~90K SLoC