Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@iduartgomez
iduartgomez committed Jan 14, 2024
1 parent a68f7a7 commit 7227b99
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions crates/core/src/transport.rs
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,6 @@
#![allow(dead_code)] // TODO: Remove before integration
//! Freenet Transport protocol implementation.
//!
//! # Protocol
//!
//! ## Connection Establishment
//!
//! ### Neither peer is a gateway
//!
//!
//!
//! # Transport message types (u8)
//!
//! * 0: Symmetric key encrypted with our public key
//! * 1: Acknowledgement of symmetric key - encrypted with symmetric key
//! * 2: Message - encrypted with symmetric key
//! * 3: Disconnect message - encrypted with symmetric key
//!
//! # Transport
//!
//! The transport layer is responsible for reliably sending and receiving messages
Expand Down Expand Up @@ -52,6 +37,13 @@
//!
//! ## Opening a Connection
//!
//! ## Transport message types (u8)
//!
//! * 0: Symmetric key encrypted with our public key
//! * 1: Acknowledgement of symmetric key - encrypted with symmetric key
//! * 2: Message - encrypted with symmetric key
//! * 3: Disconnect message - encrypted with symmetric key
//!
//! ### Neither peer is a gateway
//!
//! 1. Peer A sends a `ConnectionStart` message to Peer B with its chosen symmetric key
Expand Down

0 comments on commit 7227b99

Please sign in to comment.