Merge pull request #76 from fjarri/evidence-session-id

Pass more info for evidence verification

CHANGELOG.md

@@ -10,9 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Removed `protocol::digest` re-export ([#75]).
 - `digest` and `signature` are now re-exported from the top level instead of `session` ([#75]).
+- `ProtocolError::verify_messages_constitute_error()` takes a new `shared_randomness` argument. ([#76])
+- `Protocol` and `ProtocolError` are now generic over `Id`. ([#76])
+- `ProtocolError::verify_messages_constitute_error()` takes a new `guilty_party` argument. ([#76])
+- `Combinator`/`CombinatorEntryPoint` removed in favor of a single `ChainedMarker` trait. ([#76])
+- The `combined_echos` argument to `ProtocolError::verify_messages_constitute_error()` now has a mapping of id to echo instead of just a vector of echos. ([#76])
+- `ProtocolError::verify_messages_constitute_error()` now takes messages and mapping of messages by value. ([#76])
 
 
 [#75]: https://github.com/entropyxyz/manul/pull/75
+[#76]: https://github.com/entropyxyz/manul/pull/76
 
 
 ## [0.1.0] - 2024-11-19

README.md

@@ -26,7 +26,7 @@ We try to find the balance between supporting the majority of protocols and keep
 - A protocol consists of several rounds.
 - A round generates messages to send out without any additional external input, then waits for messages from other parties. When it receives enough messages, it can be finalized.
 - On finalization, a round can return the result, halt with an error, or continue to another round.
-- Each round declares a set of parties it sends messages to. Then it can optionally send a direct message to each party in the set, set a regular broadcast to all parties in the set, or send an echo-broadcast to all parties in the set (that is, a broadcast where it is ensured that all parties received the same thing). Any number of these options can be picked.
+- Each round declares a set of parties it sends messages to. Then it can optionally send a direct message to each party in the set, send a regular broadcast to all parties in the set, or send an echo-broadcast to all parties in the set (that is, a broadcast where it is ensured that all parties received the same thing). Any number of these options can be picked.
 
 
 [crate-image]: https://img.shields.io/crates/v/manul.svg

examples/src/simple.rs

@@ -23,7 +23,7 @@ pub enum SimpleProtocolError {
     Round2InvalidPosition,
 }
 
-impl ProtocolError for SimpleProtocolError {
+impl<Id> ProtocolError<Id> for SimpleProtocolError {
     fn description(&self) -> String {
         format!("{:?}", self)
     }
@@ -53,13 +53,15 @@ impl ProtocolError for SimpleProtocolError {
     fn verify_messages_constitute_error(
         &self,
         deserializer: &Deserializer,
-        _echo_broadcast: &EchoBroadcast,
-        _normal_broadcast: &NormalBroadcast,
-        direct_message: &DirectMessage,
-        _echo_broadcasts: &BTreeMap<RoundId, EchoBroadcast>,
-        _normal_broadcasts: &BTreeMap<RoundId, NormalBroadcast>,
-        _direct_messages: &BTreeMap<RoundId, DirectMessage>,
-        combined_echos: &BTreeMap<RoundId, Vec<EchoBroadcast>>,
+        _guilty_party: &Id,
+        _shared_randomness: &[u8],
+        _echo_broadcast: EchoBroadcast,
+        _normal_broadcast: NormalBroadcast,
+        direct_message: DirectMessage,
+        _echo_broadcasts: BTreeMap<RoundId, EchoBroadcast>,
+        _normal_broadcasts: BTreeMap<RoundId, NormalBroadcast>,
+        _direct_messages: BTreeMap<RoundId, DirectMessage>,
+        combined_echos: BTreeMap<RoundId, BTreeMap<Id, EchoBroadcast>>,
     ) -> Result<(), ProtocolValidationError> {
         match self {
             SimpleProtocolError::Round1InvalidPosition => {
@@ -76,7 +78,7 @@ impl ProtocolError for SimpleProtocolError {
                 // Deserialize the echos
                 let _r1_echos = r1_echos_serialized
                     .iter()
-                    .map(|echo| echo.deserialize::<Round1Echo>(deserializer))
+                    .map(|(_id, echo)| echo.deserialize::<Round1Echo>(deserializer))
                     .collect::<Result<Vec<_>, _>>()?;
 
                 // Message contents would be checked here
@@ -86,7 +88,7 @@ impl ProtocolError for SimpleProtocolError {
     }
 }
 
-impl Protocol for SimpleProtocol {
+impl<Id> Protocol<Id> for SimpleProtocol {
     type Result = u8;
     type ProtocolError = SimpleProtocolError;
 

examples/src/simple_chain.rs

@@ -2,10 +2,7 @@ use alloc::collections::BTreeSet;
 use core::fmt::Debug;
 
 use manul::{
-    combinators::{
-        chain::{Chain, ChainedJoin, ChainedProtocol, ChainedSplit},
-        CombinatorEntryPoint,
-    },
+    combinators::chain::{ChainedJoin, ChainedMarker, ChainedProtocol, ChainedSplit},
     protocol::{PartyId, Protocol},
 };
 
@@ -16,7 +13,9 @@ use super::simple::{SimpleProtocol, SimpleProtocolEntryPoint};
 #[derive(Debug)]
 pub struct DoubleSimpleProtocol;
 
-impl ChainedProtocol for DoubleSimpleProtocol {
+impl ChainedMarker for DoubleSimpleProtocol {}
+
+impl<Id> ChainedProtocol<Id> for DoubleSimpleProtocol {
     type Protocol1 = SimpleProtocol;
     type Protocol2 = SimpleProtocol;
 }
@@ -25,16 +24,14 @@ pub struct DoubleSimpleEntryPoint<Id> {
     all_ids: BTreeSet<Id>,
 }
 
+impl<Id> ChainedMarker for DoubleSimpleEntryPoint<Id> {}
+
 impl<Id: PartyId> DoubleSimpleEntryPoint<Id> {
     pub fn new(all_ids: BTreeSet<Id>) -> Self {
         Self { all_ids }
     }
 }
 
-impl<Id> CombinatorEntryPoint for DoubleSimpleEntryPoint<Id> {
-    type Combinator = Chain;
-}
-
 impl<Id> ChainedSplit<Id> for DoubleSimpleEntryPoint<Id>
 where
     Id: PartyId,
@@ -60,7 +57,7 @@ where
 {
     type Protocol = DoubleSimpleProtocol;
     type EntryPoint = SimpleProtocolEntryPoint<Id>;
-    fn make_entry_point2(self, _result: <SimpleProtocol as Protocol>::Result) -> Self::EntryPoint {
+    fn make_entry_point2(self, _result: <SimpleProtocol as Protocol<Id>>::Result) -> Self::EntryPoint {
         SimpleProtocolEntryPoint::new(self.all_ids)
     }
 }

examples/tests/async_runner.rs

@@ -35,7 +35,7 @@ async fn run_session<P, SP>(
     session: Session<P, SP>,
 ) -> Result<SessionReport<P, SP>, LocalError>
 where
-    P: Protocol,
+    P: Protocol<SP::Verifier>,
     SP: SessionParameters,
 {
     let rng = &mut OsRng;
@@ -194,7 +194,7 @@ async fn message_dispatcher<SP>(
 
 async fn run_nodes<P, SP>(sessions: Vec<Session<P, SP>>) -> Vec<SessionReport<P, SP>>
 where
-    P: Protocol + Send,
+    P: Protocol<SP::Verifier> + Send,
     SP: SessionParameters,
     P::Result: Send,
     SP::Signer: Send,

manul/benches/empty_rounds.rs

@@ -18,7 +18,7 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug)]
 pub struct EmptyProtocol;
 
-impl Protocol for EmptyProtocol {
+impl<Id> Protocol<Id> for EmptyProtocol {
     type Result = ();
     type ProtocolError = ();
 }

manul/src/combinators.rs

@@ -1,7 +1,4 @@
 //! Combinators operating on protocols.
 
 pub mod chain;
-mod markers;
 pub mod misbehave;
-
-pub use markers::{Combinator, CombinatorEntryPoint};