Library with support for de/serialization, parsing and executing on data structures and network messages related to Groestlcoin.
Supports (or should support)
For JSONRPC interaction with Groestlcoin Core, it is recommended to use rust-bitcoincore-rpc.
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.
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.
This library should always compile with any combination of features on Rust 1.41.
Because some dependencies have broken the build in minor/patch releases, to
compile with 1.41.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.41.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.41.0 we also need to pin byteorder:
cargo update -p byteorder --precise "1.3.4"
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 library can be built and tested using cargo:
git clone git@github.com:rust-groestlcoin/rust-groestlcoin.git
cd rust-groestlcoin
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:.
See CHANGELOG.md.
The code in this project is licensed under the Creative Commons CC0 1.0 Universal license.