Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated lib.rs example usage
  • Loading branch information
ong-jonas committed Oct 16, 2023
commit 9e3082b2b4f1a5f408e4379821fdd203f49aa92f
40 changes: 27 additions & 13 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,41 @@
//!
//! ```no_run
//! use crate::Config;
//! use crate::message_gate::MessageGateChain;
//! use crate::peer:PeerBuilder;
//! use crate::messages::Message;
//!
//!
//! // 1. Build a configuration.
//! let config = Config::default();
//!
//! // 2. Create message gate chain.
//! let gates = MessageGateChain::new()
//! // .append(message_gate1)
//! // .append(message_gate2)
//! // ...
//!
//! let config = Config {
//! keypair,
//! topics_to_subscribe,
//! listening_port,
//! boot_nodes,
//! outgoing_msgs_buffer_capacity, // 8
//! incoming_msgs_buffer_capacity, // 10
//! peer_discovery_interval, // 10
//! kademlia_protocol_name // "/pchain_p2p/1.0.0"
//! };
//!
//! // 2. Create a message handler
//! let (tx, rx) = mpsc::channel();
//! let message_sender = tx.clone();
//! let message_handler = move |msg_orgin: [u8;32], msg: Message| {
//! let _ = message_sender.send((msg_origin, msg));
//! };
//!
//! // 3. Start P2P network.
//! let network = pchain_network::NetworkHandle::start(network_config, subscribe_topics, message_gate_chain).await;
//!
//! let peer = PeerBuilder::new(config)
//! .on_receive_msg(message_handler)
//! .build()
//! .await
//! .unwrap();
//!
//! // 4. Send out messages.
//! network.broadcast_mempool_tx_msg(txn);
//! peer.broadcast_mempool_msg(txn);
//!
//!

// TODO jonas: update example usage above

pub mod behaviour;

Expand Down
2 changes: 1 addition & 1 deletion tests/network.rs
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ pub async fn node(

let message_sender = tx.clone();
let message_handler = move |msg_origin: [u8;32], msg: Message| {
message_sender.send((msg_origin, msg)).unwrap();
let _ = message_sender.send((msg_origin, msg));
};

let peer = PeerBuilder::new(config)
Expand Down