2 unstable releases

Uses old Rust 2015

0.27.1-pre Jan 21, 2022
0.23.0 Apr 28, 2020

#378 in Cryptography

CC0 license

1MB
15K SLoC

Status Continuous integration Safety Dance

Attention

This is the fork of rust-bitcoin.

Rust Monacoin Library

Library with support for de/serialization, parsing and executing on data structures and network messages related to Monacoin.

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 creation, manipulation, merging and finalization
  • Pay-to-contract support as in Appendix A of the Blockstream sidechains whitepaper

For JSONRPC interaction with Bitcoin Core, it is recommended to use rust-bitcoincore-rpc.

Known limitations

Consensus

This library must 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 Core reference implementation. In a consensus based cryptocurrency such as Bitcoin it is critical that all parties are using the same rules to validate data, and this library is simply unable to implement the same rules as Core.

Given the complexity of both C++ and Rust, it is unlikely that this will ever be fixed, and there are no plans to do so. Of course, patches to fix specific consensus incompatibilities are welcome.

Documentation

Currently can be found on docs.rs/bitcoin. Patches to add usage examples and to expand on existing docs would be extremely appreciated.

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.32.

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

In order to use the use-serde feature or to build the unit tests with 1.29.0, the following version-pinning commands are also needed:

cargo update --package "serde" --precise "1.0.98"
cargo update --package "serde_derive" --precise "1.0.98"

For the feature base64 to work with 1.29.0 we also need to pin byteorder:

cargo update -p byteorder --precise "1.3.4"

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 git@github.com:wakiyamap/rust-monacoin.git
cd rust-monacoin
cargo build

You can run tests with:

cargo test

Please refer to the cargo documentation for more detailed instructions.

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

Policy on Altcoins/Altchains

This is altcoin(monacoin) library. Bitcoin(not altcoin) is here.

Release Notes

See CHANGELOG.md.

Licensing

The code in this project is licensed under the Creative Commons CC0 1.0 Universal license.

Dependencies

~8MB
~84K SLoC