reexport packet::Packet publically

Author: Evanfeenstra

lightning/src/onion_message/mod.rs

@@ -29,4 +29,5 @@ mod functional_tests;
 // Re-export structs so they can be imported with just the `onion_message::` module prefix.
 pub use self::messenger::{CustomOnionMessageContents, CustomOnionMessageHandler, DefaultMessageRouter, Destination, MessageRouter, OnionMessageContents, OnionMessagePath, OnionMessenger, SendError, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
 pub use self::offers::{OffersMessage, OffersMessageHandler};
-pub(crate) use self::packet::{ControlTlvs, Packet};
+pub use self::packet::Packet;
+pub(crate) use self::packet::ControlTlvs;

lightning/src/onion_message/packet.rs

@@ -32,15 +32,21 @@ use crate::prelude::*;
 pub(super) const SMALL_PACKET_HOP_DATA_LEN: usize = 1300;
 pub(super) const BIG_PACKET_HOP_DATA_LEN: usize = 32768;
 
+/// Packet of hop data for next peer
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Packet {
+	/// Bolt 04 version number
 	pub version: u8,
+	/// The PublicKey used during shared secret generation
 	pub public_key: PublicKey,
+	/// 1300 bytes payload for the next hop
+	//
 	// Unlike the onion packets used for payments, onion message packets can have payloads greater
 	// than 1300 bytes.
 	// TODO: if 1300 ends up being the most common size, optimize this to be:
 	// enum { ThirteenHundred([u8; 1300]), VarLen(Vec<u8>) }
 	pub hop_data: Vec<u8>,
+	/// HMAC to verify the integrity of hop_data
 	pub hmac: [u8; 32],
 }