From 8967d7748cf3ff4031448a868b475f6d396da6d9 Mon Sep 17 00:00:00 2001 From: link2xt Date: Tue, 19 Nov 2024 12:03:06 +0000 Subject: [PATCH] docs: fix references to iroh-related headers in peer_channels docs --- src/peer_channels.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/peer_channels.rs b/src/peer_channels.rs index 73e0c68446..a377856022 100644 --- a/src/peer_channels.rs +++ b/src/peer_channels.rs @@ -10,12 +10,12 @@ //! Adding peer channels to webxdc needs upfront negotation of a topic and sharing of public keys so that //! nodes can connect to each other. The explicit approach is as follows: //! -//! 1. We introduce a new [GossipTopic](crate::headerdef::HeaderDef::IrohGossipTopic) message header with a random 32-byte TopicId, +//! 1. We introduce a new [`IrohGossipTopic`](crate::headerdef::HeaderDef::IrohGossipTopic) message header with a random 32-byte TopicId, //! securely generated on the initial webxdc sender's device. This message header is encrypted //! and sent in the same message as the webxdc application. //! 2. Whenever `joinRealtimeChannel().setListener()` or `joinRealtimeChannel().send()` is called by the webxdc application, //! we start a routine to establish p2p connectivity and join the gossip swarm with Iroh. -//! 3. The first step of this routine is to introduce yourself with a regular message containing the `IrohPublicKey`. +//! 3. The first step of this routine is to introduce yourself with a regular message containing the [`IrohNodeAddr`](crate::headerdef::HeaderDef::IrohNodeAddr). //! This message contains the users relay-server and public key. //! Direct IP address is not included as this information can be persisted by email providers. //! 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).