mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-03-10 21:36:17 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix documentation on onion message packet ControlTlvs

Browse source
This commit is contained in:
Valentine Wallace 2023-08-09 14:29:35 -07:00
parent 0ddd3cb684
commit ebb0676e85
No known key found for this signature in database
GPG key ID: FD3E106A2CE099B4
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lightning/src/onion_message/packet.rs
View file

@ -264,9 +264,9 @@ ReadableArgs<(SharedSecret, &H, &L)> for Payload<<H as CustomOnionMessageHandler
} }
/// When reading a packet off the wire, we don't know a priori whether the packet is to be forwarded /// When reading a packet off the wire, we don't know a priori whether the packet is to be forwarded
/// or received. Thus we read a ControlTlvs rather than reading a ForwardControlTlvs or /// or received. Thus we read a `ControlTlvs` rather than reading a [`ForwardTlvs`] or
/// ReceiveControlTlvs directly. Also useful on the encoding side to keep forward and receive TLVs /// [`ReceiveTlvs`] directly. Also useful on the encoding side to keep forward and receive TLVs in
/// in the same iterator. /// the same iterator.
pub(crate) enum ControlTlvs { pub(crate) enum ControlTlvs {
/// This onion message is intended to be forwarded. /// This onion message is intended to be forwarded.
Forward(ForwardTlvs), Forward(ForwardTlvs),