chore: small doc

iosis-tech · Apr 24, 2024 · da9e4f5 · da9e4f5
1 parent 14f439a
commit da9e4f5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/crates/common/src/network.rs b/crates/common/src/network.rs
@@ -1,3 +1,8 @@
+/*
+    Network
+    This defines the network that the node is connected to.
+*/
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum Network {
     Mainnet,

diff --git a/crates/common/src/topic.rs b/crates/common/src/topic.rs
@@ -2,6 +2,14 @@ use libp2p::gossipsub::IdentTopic;
 
 use crate::network::Network;
 
+/*
+    Topic
+    This defines the topic of the message used in the gossipsub protocol.
+    The topic is used to filter messages and route them to the correct subscribers.
+    `NewJob` is used to notify the network of a new job from Delegator to Executor.
+    `PickedJob` is used to notify the network of a job that has been picked up by an Executor.
+*/
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum Topic {
     NewJob,