Merge branch 'refactor' into refactor

src/config.rs

@@ -46,9 +46,12 @@ pub struct Config {
 
     /// Interval in seconds for querying the network to discover peers
     pub peer_discovery_interval: u64,
+
+    /// Protocol name to communicate with other Kademlia nodes
     pub protocol_name: String,
 }
 
+// Returns a complete list of accepted topics in pchain-network
 pub(crate) fn fullnode_topics(public_address: PublicAddress) -> Vec<Topic> {
     vec![Topic::HotStuffRsBroadcast, Topic::HotStuffRsSend(public_address).into(), Topic::Mempool, Topic::DroppedTxns]
 }

src/engine.rs

@@ -40,12 +40,12 @@ use std::net::Ipv4Addr;
 use std::time::Duration;
 
 use crate::{
-    behaviour::{Behaviour, PeerNetworkEvent},
     config,
     conversions,
+    behaviour::{Behaviour, NetworkEvent},
     messages::{DroppedTxMessage, Envelope, Topic, Message}, 
     messages::Topic::{DroppedTxns, HotStuffRsBroadcast, HotStuffRsSend, Mempool},
-    peer::{EngineCommand, PeerBuilder, Peer},
+    peer::{EngineCommand, PeerBuilder, Peer}, conversions, config,
 };
 
 /// [start] p2p networking peer and return the handle [NetworkHandle] of this process.
@@ -164,11 +164,11 @@ pub(crate) async fn start(
                                     // So we need to convert Vec<u8> to pchain_network::Message. Instead of implementing
                                     // TryFrom trait for Vec<u8> to Message, implement a function that takes in the Message Topic to help
                                     // converting Vec<u8> to Message. You can refer to fullnode/mempool messagegate to see how to 
+
                                     // deserialise each Message type.                                    
                                     let topic = config::fullnode_topics(local_public_address)
                                     .into_iter()
                                     .find(|t| t.clone().hash() == message.topic);
-
 
                                     if let Some(topic) = topic {
                                         let pchain_message = match topic {
@@ -190,7 +190,7 @@ pub(crate) async fn start(
                                             }
                                         };
                                     } 
-                                                                                            
+
                                 } else {
                                     log::debug!("Receive unknown gossip message");
                                 }

src/messages.rs

@@ -21,6 +21,17 @@ use pchain_types::{blockchain::TransactionV1, cryptography::{Sha256Hash, PublicA
 /// Hash of the message topic.
 pub type MessageTopicHash = libp2p::gossipsub::TopicHash;
 
+/// [Envelope] encapsulates the message received from the p2p network with it's sender address.
+#[derive(Clone)]
+pub struct Envelope {
+    /// The origin of the message
+    pub origin: PublicAddress,
+
+    /// The message encapsulated
+    pub message: Message,
+}
+
+/// [Topic] defines the topics of the messages in pchain-network.
 #[derive(PartialEq, Debug, Clone)]
 pub enum Topic {
     HotStuffRsBroadcast,