Skip to content

Commit 8967d77

Browse files
committed
docs: fix references to iroh-related headers in peer_channels docs
1 parent 948cefa commit 8967d77

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/peer_channels.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
//! Adding peer channels to webxdc needs upfront negotation of a topic and sharing of public keys so that
1111
//! nodes can connect to each other. The explicit approach is as follows:
1212
//!
13-
//! 1. We introduce a new [GossipTopic](crate::headerdef::HeaderDef::IrohGossipTopic) message header with a random 32-byte TopicId,
13+
//! 1. We introduce a new [`IrohGossipTopic`](crate::headerdef::HeaderDef::IrohGossipTopic) message header with a random 32-byte TopicId,
1414
//! securely generated on the initial webxdc sender's device. This message header is encrypted
1515
//! and sent in the same message as the webxdc application.
1616
//! 2. Whenever `joinRealtimeChannel().setListener()` or `joinRealtimeChannel().send()` is called by the webxdc application,
1717
//! we start a routine to establish p2p connectivity and join the gossip swarm with Iroh.
18-
//! 3. The first step of this routine is to introduce yourself with a regular message containing the `IrohPublicKey`.
18+
//! 3. The first step of this routine is to introduce yourself with a regular message containing the [`IrohNodeAddr`](crate::headerdef::HeaderDef::IrohNodeAddr).
1919
//! This message contains the users relay-server and public key.
2020
//! Direct IP address is not included as this information can be persisted by email providers.
2121
//! 4. After the announcement, the sending peer joins the gossip swarm with an empty list of peer IDs (as they don't know anyone yet).

0 commit comments

Comments
 (0)