From: Valentine Wallace Date: Fri, 16 Jun 2023 19:42:38 +0000 (-0400) Subject: Minor BlindedHop docs update X-Git-Tag: v0.0.117-alpha1~45^2~7 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=9777485ed70689d55caf988b13ff7b7a0204429f;p=rust-lightning Minor BlindedHop docs update --- diff --git a/lightning/src/blinded_path/mod.rs b/lightning/src/blinded_path/mod.rs index 6225f9986..691eda29a 100644 --- a/lightning/src/blinded_path/mod.rs +++ b/lightning/src/blinded_path/mod.rs @@ -40,13 +40,14 @@ pub struct BlindedPath { pub blinded_hops: Vec, } -/// Used to construct the blinded hops portion of a blinded path. These hops cannot be identified -/// by outside observers and thus can be used to hide the identity of the recipient. +/// An encrypted payload and node id corresponding to a hop in a payment or onion message path, to +/// be encoded in the sender's onion packet. These hops cannot be identified by outside observers +/// and thus can be used to hide the identity of the recipient. #[derive(Clone, Debug, Hash, PartialEq, Eq)] pub struct BlindedHop { - /// The blinded node id of this hop in a blinded path. + /// The blinded node id of this hop in a [`BlindedPath`]. pub blinded_node_id: PublicKey, - /// The encrypted payload intended for this hop in a blinded path. + /// The encrypted payload intended for this hop in a [`BlindedPath`]. // The node sending to this blinded path will later encode this payload into the onion packet for // this hop. pub encrypted_payload: Vec,