Skip to content

Commit

Permalink
Remove out-of-date documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaker committed Jan 30, 2024
1 parent b34e4d4 commit eab06a1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
3 changes: 1 addition & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@
//! An [`IOPattern`] is a UTF8-encoded string wrapper. Absorptions are denoted as `format!(A{}, length)` and
//! squeezes as `format!(S{}, length)`. A label is added at the end of the string, meant to describe the *type* and
//! *the variable* as used in the protocol. Operations are separated by a NULL byte and therefore labels cannot contain
//! NULL bytes themselves, nor start with an ASCII digit.
//! Additional type shortcuts can be found in the [`plugins`] module as extension traits.
//! NULL bytes themselves, nor start with an ASCII digit.x
//!
//!
//! # Protocol transcripts
Expand Down
18 changes: 5 additions & 13 deletions src/plugins/mod.rs
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
//! Bindings for some popular libearies using zero-knowledge.
//!
//! Nimue can be enriched with the following features:
//!
//! - `arkwors` enables the module [`plugins::arkworks`] providing bindings for the
//! arkworks algebra crates.
//! - `dalek` enables the module [`plugins::dalek`] provides bindings for `curve25519_dalek`.
//!
//! A work-in-progress implementation for `group` is in the making (cf. [issue#3])
//!
//! [issue#3]: https://github.com/arkworks-rs/nimue/issues/3
/// Arkworks's [algebra](https://github.com/arkworks-rs/algebra) bindings.
/// Extension traits macros, for both arkworks and group.
mod traits;

#[cfg(feature = "ark")]
/// Arkworks's [algebra](https://github.com/arkworks-rs/algebra) bindings.
pub mod ark;

/// (In-progress) [group](https://github.com/zkcrypto/group) bindings.
#[cfg(feature = "group")]
/// (In-progress) [group](https://github.com/zkcrypto/group) bindings.
pub mod group;

/// Bits needed in order to obtain a (pseudo-random) uniform distribution in F.
Expand All @@ -31,4 +24,3 @@ pub(super) const fn bytes_modp(modulus_bits: u32) -> usize {
/// Unit-tests for inter-operability among libraries.
#[cfg(all(test, feature = "ark", feature = "group"))]
mod tests;
mod traits;

0 comments on commit eab06a1

Please sign in to comment.