6 releases (breaking)
|0.30.0||Apr 5, 2023|
|0.29.0||Aug 15, 2022|
|0.28.0||May 23, 2022|
|0.27.1||Feb 24, 2022|
|0.23.0||Jul 3, 2020|
#690 in Magic Beans
Rust Groestlcoin Library
Library with support for de/serialization, parsing and executing on data structures and network messages related to Groestlcoin.
Supports (or should support)
- De/serialization of Groestlcoin 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.
For JSONRPC interaction with Groestlcoin Core, it is recommended to use rust-groestlcoincore-rpc.
It is recommended to always use cargo-crev to verify the trustworthiness of each of your dependencies, including this one.
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 Groestlcoin Core reference implementation. In a consensus based cryptocurrency such as Groestlcoin 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.
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.
Currently can be found on docs.rs/groestlcoin. 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 PRing them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss please join us in #groestlcoin on libera.chat.
For more information please see
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
To build with the MSRV you will need to pin some dependencies (also for
cargo update -p serde --precise 1.0.156 cargo update -p syn --precise 1.0.107
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-groestlcoin since we support much older
versions than the current stable one (see MSRV section).
The cargo feature
std is enabled by default. At least one of the features
no-std or both must be enabled.
no-std feature does not disable
std. To disable the
std feature you must disable default features. The
no-std feature only enables additional features required for this crate to be usable without
std. Both can be enabled without conflict.
The library can be built and tested using
git clone firstname.lastname@example.org:rust-groestlcoin/rust-groestlcoin.git cd rust-groestlcoin cargo build
You can run tests with:
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'
Unit and integration tests are available for those interested, along with benchmarks. For project developers, especially new contributors looking for something to work on, we do:
There are always more tests to write and more bugs to find, contributions to our testing efforts extremely welcomed. Please consider testing code a first class citizen, we definitely do take PRs improving and cleaning up test code.
Run as for any other Rust project
cargo test --all-features.
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.
We have started doing mutation testing with mutagen. To run
these tests first install the latest dev version with
cargo +nightly install --git https://github.com/llogiq/mutagen
then run with
RUSTFLAGS='--cfg=mutate' cargo +nightly mutagen.
We have started using kani, install with
cargo install --locked kani-verifier (no need to run
cargo kani setup). Run the tests with
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