commit_verify

Crates.iocommit_verify
lib.rscommit_verify
version0.11.0-beta.5
sourcesrc
created_at2021-05-14 15:45:10.007958
updated_at2024-03-19 11:09:52.355405
descriptionCommit-verify API for client-side validation
homepagehttps://github.com/LNP-BP
repositoryhttps://github.com/LNP-BP/client_side_validation
max_upload_size
id397445
LNP/BP Consensus Maintainers (lnpbp-consensus-maintainers)

documentation

README

# Client-side-validation commit-verify library ![Build](https://github.com/LNP-BP/client_side_validation/workflows/Build/badge.svg) ![Tests](https://github.com/LNP-BP/client_side_validation/workflows/Tests/badge.svg) ![Lints](https://github.com/LNP-BP/client_side_validation/workflows/Lints/badge.svg) [![codecov](https://codecov.io/gh/LNP-BP/client_side_validation/branch/master/graph/badge.svg)](https://codecov.io/gh/LNP-BP/client_side_validation) [![crates.io](https://meritbadge.herokuapp.com/commit_verify)](https://crates.io/crates/commit_verify) [![Docs](https://docs.rs/commit_verify/badge.svg)](https://docs.rs/commit_verify) [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/) [![Apache-2 licensed](https://img.shields.io/crates/l/commit_verify)](./LICENSE) This is an implementation of [LNPBP-4] multi-commitment standard, [LNPBP-9] standard, defining to cryptographic commitment schemes used in client-side-validation, and [LNPBP-81] tagged merkle tree standard. It is a part of more generic [`client_side_validation`] library covering other client-side-validation standards. Client-side-validation is a paradigm for distributed computing, based on top of proof-of-publication/commitment medium layer, which may be a bitcoin blockchain or other type of distributed consensus system. The development of the library is supported by [LNP/BP Standards Association][lnpbp-web] and is performed on its [GitHub page][lnpbp-github]. Minimum supported rust version for the library (MSRV) is 1.66 and 2021 rust edition. ## Documentation Detailed developer & API documentation for the library can be accessed at To learn about the technologies enabled by the library please check [slides from our tech presentations][presentations] and [LNP/BP tech talks videos][lnpbp-youtube] ## Usage To use the library, you just need to reference a latest version, in `[dependencies]` section of your project `Cargo.toml`. ```toml commit_verify = "1" ``` If you are using other client-side-validation libraries, consider importing just a single [`client_side_validation`] library which re-exports all of them, including the current one. The library has just a two feature flags, both of which are not used by default: - `rand`, providing support for generating random 32-byte sequences of `Slice32` type, used in many LNP/BP applications (for instance as hash-lock preimages or during LNPBP-4 multi-commitments) - `serde`, providing support for data structure serialization with serde across the library ## Contributing Contribution guidelines can be found in [CONTRIBUTING](../CONTRIBUTING.md) ## Licensing The libraries are distributed on the terms of Apache 2.0 opensource license. See [LICENCE](LICENSE) file for the license details. [`client_side_validation`]: https://crates.io/crates/client_side_validation [lnpbp-web]: https://lnp-bp.org [lnpbp-github]: https://github.com/LNP-BP [lnpbp-youtube]: https://www.youtube.com/@LNPBP [presentations]: https://github.com/LNP-BP/FAQ/blob/master/Presentation%20slides/ [LNPBP-4]: https://github.com/LNP-BP/LNPBPs/blob/master/lnpbp-0004.md [LNPBP-9]: https://github.com/LNP-BP/LNPBPs/blob/master/lnpbp-0009.md [LNPBP-81]" https://github.com/LNP-BP/LNPBPs/blob/master/lnpbp-0081.md
Commit count: 1203

cargo fmt