From ea227f86c66a88f97267159cc44e4cef3ca00ffd Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 7 Dec 2023 16:00:43 +0000 Subject: [PATCH 1/4] Add crate-level documentation --- src/lib.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 7c2864e..dc27629 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,13 @@ +//! This crate provides low-level types for implementing Zcash specifications. When a +//! common function defined in [the Zcash Protocol Specification] is used in multiple +//! protocols (for example the Sapling and Orchard shielded protocols), a corresponding +//! common type in this crate can be shared between implementations (for example by the +//! [`sapling-crypto`] and [`orchard`] crates). +//! +//! [the Zcash Protocol Specification]: https://zips.z.cash/protocol/protocol.pdf +//! [`sapling-crypto`]: https://crates.io/crates/sapling-crypto +//! [`orchard`]: https://crates.io/crates/orchard + #![deny(rustdoc::broken_intra_doc_links)] mod prf_expand; From fd4d94ef6305d59ff6b320ec3fa72471b727af4b Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 7 Dec 2023 16:00:59 +0000 Subject: [PATCH 2/4] Make crate no-std --- src/lib.rs | 2 ++ src/prf_expand.rs | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index dc27629..fbe8087 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -8,6 +8,8 @@ //! [`sapling-crypto`]: https://crates.io/crates/sapling-crypto //! [`orchard`]: https://crates.io/crates/orchard +#![no_std] +#![deny(unsafe_code)] #![deny(rustdoc::broken_intra_doc_links)] mod prf_expand; diff --git a/src/prf_expand.rs b/src/prf_expand.rs index 28537e7..212c841 100644 --- a/src/prf_expand.rs +++ b/src/prf_expand.rs @@ -1,4 +1,4 @@ -use std::marker::PhantomData; +use core::marker::PhantomData; use blake2b_simd::Params; From 8c8288e679370b45962a00c67fb89245ff3bbeb7 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 7 Dec 2023 16:01:19 +0000 Subject: [PATCH 3/4] Add changelog file --- CHANGELOG.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d263b52 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog +All notable changes to this library will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this library adheres to Rust's notion of +[Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +Initial release. From 717ec1070e669caf4de97e1466aed45f5d9b46cd Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 7 Dec 2023 16:02:38 +0000 Subject: [PATCH 4/4] v0.1.0 --- CHANGELOG.md | 1 + Cargo.lock | 2 +- Cargo.toml | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d263b52..135a8e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,4 +7,5 @@ and this library adheres to Rust's notion of ## [Unreleased] +## [0.1.0] - 2023-12-07 Initial release. diff --git a/Cargo.lock b/Cargo.lock index 07fca47..ef88e4d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -33,7 +33,7 @@ checksum = "245097e9a4535ee1e3e3931fcfcd55a796a44c643e8596ff6566d68f09b87bbc" [[package]] name = "zcash_spec" -version = "0.0.0" +version = "0.1.0" dependencies = [ "blake2b_simd", ] diff --git a/Cargo.toml b/Cargo.toml index e1835cb..453e394 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zcash_spec" -version = "0.0.0" +version = "0.1.0" authors = [ "Jack Grigg ", ]