Extract router

packages/ciphernode/core/src/enclave_core/mod.rs

@@ -1,14 +1,8 @@
 mod events;
 mod eventbus;
 mod ordered_set;
-mod e3_request_router;
-mod committee_meta;
-mod ciphernode_selector;
 
 pub use events::*;
 pub use eventbus::*;
 pub use ordered_set::*;
-pub use e3_request_router::*;
-pub use committee_meta::*;
-pub use ciphernode_selector::*;
 

packages/ciphernode/core/src/enclave_node/main_aggregator.rs

@@ -1,14 +1,14 @@
 use crate::{
-    enclave_core::{EventBus,CommitteeMetaFactory, E3RequestRouter},
+    enclave_core::EventBus,
     evm::{connect_evm_caller, connect_evm_ciphernode_registry, connect_evm_enclave},
     fhe::FheFactory,
     logger::SimpleLogger,
     p2p::P2p,
     plaintext_aggregator::PlaintextAggregatorFactory,
     publickey_aggregator::PublicKeyAggregatorFactory,
+    router::{CommitteeMetaFactory, E3RequestRouter},
     sortition::Sortition,
-    utils::PlaintextWriter,
-    utils::PublicKeyWriter,
+    utils::{PlaintextWriter, PublicKeyWriter},
 };
 use actix::{Actor, Addr, Context};
 use alloy::primitives::Address;

packages/ciphernode/core/src/enclave_node/main_ciphernode.rs

@@ -1,12 +1,5 @@
 use crate::{
-    data::Data,
-    enclave_core::{CiphernodeSelector, CommitteeMetaFactory, E3RequestRouter, EventBus},
-    evm::{connect_evm_ciphernode_registry, connect_evm_enclave},
-    fhe::FheFactory,
-    keyshare::KeyshareFactory,
-    logger::SimpleLogger,
-    p2p::P2p,
-    sortition::Sortition,
+    data::Data, enclave_core::EventBus, evm::{connect_evm_ciphernode_registry, connect_evm_enclave}, fhe::FheFactory, keyshare::KeyshareFactory, logger::SimpleLogger, p2p::P2p, router::{CiphernodeSelector, CommitteeMetaFactory, E3RequestRouter}, sortition::Sortition
 };
 use actix::{Actor, Addr, Context};
 use alloy::primitives::Address;

packages/ciphernode/core/src/fhe/fhe.rs

@@ -1,5 +1,5 @@
 use super::set_up_crp;
-use crate::enclave_core::{E3Requested, EnclaveEvent, EventHook, OrderedSet, Seed};
+use crate::{enclave_core::{E3Requested, EnclaveEvent,OrderedSet, Seed}, router::EventHook};
 use anyhow::*;
 use fhe::{
     bfv::{

packages/ciphernode/core/src/fhe/utils.rs

@@ -4,7 +4,7 @@ use fhe::{
     mbfv::CommonRandomPoly,
 };
 use fhe_traits::{Deserialize, Serialize};
-use std::{fs, io::Write, path::Path, sync::Arc};
+use std::sync::Arc;
 
 use super::SharedRng;
 
@@ -59,5 +59,3 @@ pub fn decode_params(bytes: &[u8]) -> Result<Arc<BfvParameters>> {
 pub fn set_up_crp(params: Arc<BfvParameters>, rng: SharedRng) -> CommonRandomPoly {
     CommonRandomPoly::new(&params, &mut *rng.lock().unwrap()).unwrap()
 }
-
-

packages/ciphernode/core/src/keyshare/keyshare.rs

@@ -1,9 +1,11 @@
 use crate::{
     data::{Data, Get, Insert},
     enclave_core::{
-        CiphernodeSelected, CiphertextOutputPublished, DecryptionshareCreated, EnclaveErrorType, EnclaveEvent, EventBus, EventHook, FromError, KeyshareCreated
+        CiphernodeSelected, CiphertextOutputPublished, DecryptionshareCreated, EnclaveErrorType,
+        EnclaveEvent, EventBus, FromError, KeyshareCreated,
     },
     fhe::{DecryptCiphertext, Fhe},
+    router::EventHook,
 };
 use actix::prelude::*;
 use anyhow::{anyhow, Context, Result};

packages/ciphernode/core/src/lib.rs

@@ -12,6 +12,7 @@ mod logger;
 mod p2p;
 mod plaintext_aggregator;
 mod publickey_aggregator;
+mod router;
 mod sortition;
 mod utils;
 
@@ -26,17 +27,17 @@ mod tests {
     use crate::{
         data::Data,
         enclave_core::{
-            CiphernodeAdded, CiphernodeSelected, CiphernodeSelector, CiphertextOutputPublished,
-            CommitteeMetaFactory, DecryptionshareCreated, E3RequestRouter, E3Requested, E3id,
-            EnclaveEvent, EventBus, GetHistory, KeyshareCreated, PlaintextAggregated,
-            PublicKeyAggregated, ResetHistory, Seed,
+            CiphernodeAdded, CiphernodeSelected, CiphertextOutputPublished, DecryptionshareCreated,
+            E3Requested, E3id, EnclaveEvent, EventBus, GetHistory, KeyshareCreated,
+            PlaintextAggregated, PublicKeyAggregated, ResetHistory, Seed,
         },
         fhe::{setup_crp_params, FheFactory, ParamsWithCrp, SharedRng},
         keyshare::KeyshareFactory,
         logger::SimpleLogger,
         p2p::P2p,
         plaintext_aggregator::PlaintextAggregatorFactory,
         publickey_aggregator::PublicKeyAggregatorFactory,
+        router::{CiphernodeSelector, CommitteeMetaFactory, E3RequestRouter},
         sortition::Sortition,
     };
     use actix::prelude::*;

packages/ciphernode/core/src/plaintext_aggregator/plaintext_aggregator.rs

@@ -1,9 +1,9 @@
 use crate::{
     enclave_core::{
-        DecryptionshareCreated, E3id, EnclaveEvent, EventBus, EventHook, OrderedSet,
-        PlaintextAggregated, Seed,
+        DecryptionshareCreated, E3id, EnclaveEvent, EventBus, OrderedSet, PlaintextAggregated, Seed,
     },
     fhe::{Fhe, GetAggregatePlaintext},
+    router::EventHook,
     sortition::{GetHasNode, Sortition},
 };
 use actix::prelude::*;

packages/ciphernode/core/src/publickey_aggregator/publickey_aggregator.rs

@@ -1,9 +1,9 @@
 use crate::{
     enclave_core::{
-        E3id, EnclaveEvent, EventBus, EventHook, KeyshareCreated, OrderedSet, PublicKeyAggregated,
-        Seed,
+        E3id, EnclaveEvent, EventBus, KeyshareCreated, OrderedSet, PublicKeyAggregated, Seed,
     },
     fhe::{Fhe, GetAggregatePublicKey},
+    router::EventHook,
     sortition::{GetHasNode, Sortition},
 };
 use actix::prelude::*;

packages/ciphernode/core/src/enclave_core/ciphernode_selector.rs → packages/ciphernode/core/src/router/ciphernode_selector.rs

@@ -1,4 +1,5 @@
-/// CiphernodeSelector is an actor that determines if a ciphernode
+/// CiphernodeSelector is an actor that determines if a ciphernode is part of a committee and if so
+/// forwards a CiphernodeSelected event to the event bus
 use actix::prelude::*;
 use crate::{enclave_core::{CiphernodeSelected, EnclaveEvent, EventBus, Subscribe}, sortition::{GetHasNode, Sortition}};
 

packages/ciphernode/core/src/enclave_core/e3_request_router.rs → packages/ciphernode/core/src/router/e3_request_router.rs

@@ -4,6 +4,8 @@ use actix::{Actor, Addr, Context, Handler, Recipient};
 use crate::{enclave_core::{E3id, EnclaveEvent, EventBus, Subscribe}, fhe::Fhe, keyshare::Keyshare, plaintext_aggregator::PlaintextAggregator, publickey_aggregator::PublicKeyAggregator};
 use super::CommitteeMeta;
 
+
+/// Helper class to buffer events for downstream instances incase events arrive in the wrong order
 #[derive(Default)]
 struct EventBuffer {
     buffer: HashMap<String, Vec<EnclaveEvent>>,
@@ -22,6 +24,8 @@ impl EventBuffer {
     }
 }
 
+/// Context that is set to each event hook. Hooks can use this context to gather dependencies if
+/// they need to instantiate struct instances or actors.
 #[derive(Default)]
 pub struct E3RequestContext {
     pub keyshare: Option<Addr<Keyshare>>,
@@ -109,7 +113,7 @@ impl Handler<EnclaveEvent> for E3RequestRouter {
     }
 }
 
-
+/// Builder for E3RequestRouter
 pub struct E3RequestRouterBuilder {
     pub bus: Addr<EventBus>,
     pub hooks: Vec<EventHook>,

packages/ciphernode/core/src/router/mod.rs

@@ -0,0 +1,7 @@
+mod ciphernode_selector;
+mod committee_meta;
+mod e3_request_router;
+
+pub use ciphernode_selector::*;
+pub use committee_meta::*;
+pub use e3_request_router::*;