Add docs

example/src/simple.rs

@@ -93,7 +93,7 @@ impl Protocol for SimpleProtocol {
         if round_id == RoundId::new(1) {
             return message.verify_is_invalid::<Self, Round1Message>();
         }
-        Err(MessageValidationError::Other("Invalid round number".into()))?
+        Err(MessageValidationError::InvalidEvidence("Invalid round number".into()))?
     }
 }
 
@@ -223,7 +223,7 @@ impl<Id: 'static + Debug + Clone + Ord + Send + Sync> Round<Id> for Round1<Id> {
         _rng: &mut impl CryptoRngCore,
         payloads: BTreeMap<Id, Payload>,
         _artifacts: BTreeMap<Id, Artifact>,
-    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Id, Self::Protocol>> {
+    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Self::Protocol>> {
         debug!(
             "{:?}: finalizing with messages from {:?}",
             self.context.id,
@@ -327,7 +327,7 @@ impl<Id: 'static + Debug + Clone + Ord + Send + Sync> Round<Id> for Round2<Id> {
         _rng: &mut impl CryptoRngCore,
         payloads: BTreeMap<Id, Payload>,
         _artifacts: BTreeMap<Id, Artifact>,
-    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Id, Self::Protocol>> {
+    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Self::Protocol>> {
         debug!(
             "{:?}: finalizing with messages from {:?}",
             self.context.id,
@@ -359,7 +359,7 @@ mod tests {
     use alloc::collections::BTreeSet;
 
     use manul::{
-        session::{Keypair, SessionOutcome},
+        session::{signature::Keypair, SessionOutcome},
         testing::{run_sync, Signature, Signer, Verifier},
     };
     use rand_core::OsRng;

example/src/simple_malicious.rs

@@ -5,7 +5,7 @@ use manul::{
     protocol::{
         Artifact, DirectMessage, FinalizeError, FinalizeOutcome, FirstRound, LocalError, Payload, Round, SessionId,
     },
-    session::Keypair,
+    session::signature::Keypair,
     testing::{round_override, run_sync, RoundOverride, RoundWrapper, Signature, Signer, Verifier},
 };
 use rand_core::{CryptoRngCore, OsRng};
@@ -85,7 +85,7 @@ impl<Id: 'static + Debug + Clone + Ord + Send + Sync> RoundOverride<Id> for Mali
         artifacts: BTreeMap<Id, Artifact>,
     ) -> Result<
         FinalizeOutcome<Id, <<Self as RoundWrapper<Id>>::InnerRound as Round<Id>>::Protocol>,
-        FinalizeError<Id, <<Self as RoundWrapper<Id>>::InnerRound as Round<Id>>::Protocol>,
+        FinalizeError<<<Self as RoundWrapper<Id>>::InnerRound as Round<Id>>::Protocol>,
     > {
         let behavior = self.behavior;
         let outcome = self.inner_round().finalize(rng, payloads, artifacts)?;

example/tests/async.rs

@@ -4,7 +4,9 @@ use alloc::collections::{BTreeMap, BTreeSet};
 
 use manul::{
     protocol::{Protocol, Round},
-    session::{CanFinalize, Keypair, LocalError, MessageBundle, RoundOutcome, Session, SessionId, SessionReport},
+    session::{
+        signature::Keypair, CanFinalize, LocalError, MessageBundle, RoundOutcome, Session, SessionId, SessionReport,
+    },
     testing::{Signature, Signer, Verifier},
 };
 use manul_example::simple::{Inputs, Round1};

manul/src/lib.rs

@@ -1,9 +1,11 @@
 #![no_std]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![doc = include_str!("../../README.md")]
 #![warn(
     clippy::mod_module_files,
     clippy::unwrap_used,
     clippy::indexing_slicing,
-    //missing_docs,
+    missing_docs,
     missing_copy_implementations,
     rust_2018_idioms,
     trivial_casts,

manul/src/protocol.rs

@@ -1,3 +1,16 @@
+/*!
+API for protocol implementors.
+
+A protocol is a directed acyclic graph with the nodes being objects of types implementing [`Round`]
+(to be specific, "acyclic" means that the values returned by [`Round::id`]
+should not repeat during the protocol execution; the types might).
+The starting point is a type also implementing [`FirstRound`].
+All the rounds should have their associated type [`Round::Protocol`] set to the same [`Protocol`] instance
+to be executed by a [`Session`](`crate::session::Session`).
+
+For more details, see the documentation of the mentioned traits.
+*/
+
 mod error;
 mod object_safe;
 mod round;
@@ -13,4 +26,4 @@ pub use round::{
 pub(crate) use object_safe::{ObjectSafeRound, ObjectSafeRoundWrapper};
 pub(crate) use round::ReceiveErrorType;
 
-pub use digest::Digest;
+pub use digest;

manul/src/protocol/error.rs

@@ -7,6 +7,7 @@ use core::fmt::Debug;
 pub struct LocalError(String);
 
 impl LocalError {
+    /// Creates a new error from anything castable to string.
     pub fn new(message: impl Into<String>) -> Self {
         Self(message.into())
     }
@@ -18,6 +19,7 @@ impl LocalError {
 pub struct RemoteError(String);
 
 impl RemoteError {
+    /// Creates a new error from anything castable to string.
     pub fn new(message: impl Into<String>) -> Self {
         Self(message.into())
     }

manul/src/protocol/object_safe.rs

@@ -70,7 +70,7 @@ pub(crate) trait ObjectSafeRound<Id>: 'static + Send + Sync {
         rng: &mut dyn CryptoRngCore,
         payloads: BTreeMap<Id, Payload>,
         artifacts: BTreeMap<Id, Artifact>,
-    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Id, Self::Protocol>>;
+    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Self::Protocol>>;
 
     fn expecting_messages_from(&self) -> &BTreeSet<Id>;
 
@@ -145,7 +145,7 @@ where
         rng: &mut dyn CryptoRngCore,
         payloads: BTreeMap<Id, Payload>,
         artifacts: BTreeMap<Id, Artifact>,
-    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Id, Self::Protocol>> {
+    ) -> Result<FinalizeOutcome<Id, Self::Protocol>, FinalizeError<Self::Protocol>> {
         let mut boxed_rng = BoxedRng(rng);
         self.round.finalize(&mut boxed_rng, payloads, artifacts)
     }