Skip to content

Commit 8fdfdf3

Browse files
committed
Export Onion Message structs in their respective modules
Re-exports in Rust make `use` statements a little shorter, but for otherwise don't materially change a crate's API. Sadly, the C bindings generator currently can't figure out re-exports, but it also exports everything into one global namespace, so it doesn't matter much anyway.
1 parent 66f2f2c commit 8fdfdf3

File tree

7 files changed

+20
-18
lines changed

7 files changed

+20
-18
lines changed

fuzz/src/onion_message.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ use lightning::ln::script::ShutdownScript;
1111
use lightning::util::enforcing_trait_impls::EnforcingSigner;
1212
use lightning::util::logger::Logger;
1313
use lightning::util::ser::{Readable, Writeable, Writer};
14-
use lightning::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, OnionMessenger};
14+
use lightning::onion_message::packet::CustomOnionMessageContents;
15+
use lightning::onion_message::messenger::{OnionMessenger, CustomOnionMessageHandler};
1516

1617
use crate::utils::test_logger;
1718

lightning-rapid-gossip-sync/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ use lightning::io;
7979
use lightning::routing::gossip::NetworkGraph;
8080
use lightning::util::logger::Logger;
8181

82-
pub use crate::error::GraphSyncError;
82+
use crate::error::GraphSyncError;
8383

8484
/// Error types that these functions can return
85-
mod error;
85+
pub mod error;
8686

8787
/// Core functionality of this crate
8888
mod processing;

lightning/src/ln/msgs.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ pub struct UpdateAddHTLC {
310310
pub struct OnionMessage {
311311
/// Used in decrypting the onion packet's payload.
312312
pub blinding_point: PublicKey,
313-
pub(crate) onion_routing_packet: onion_message::Packet,
313+
pub(crate) onion_routing_packet: onion_message::packet::Packet,
314314
}
315315

316316
/// An update_fulfill_htlc message to be sent or received from a peer
@@ -1422,7 +1422,7 @@ impl Readable for OnionMessage {
14221422
let blinding_point: PublicKey = Readable::read(r)?;
14231423
let len: u16 = Readable::read(r)?;
14241424
let mut packet_reader = FixedLengthReader::new(r, len as u64);
1425-
let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
1425+
let onion_routing_packet = <onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
14261426
Ok(Self {
14271427
blinding_point,
14281428
onion_routing_packet,

lightning/src/ln/peer_handler.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ use crate::util::ser::{VecWriter, Writeable, Writer};
2525
use crate::ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
2626
use crate::ln::wire;
2727
use crate::ln::wire::Encode;
28-
use crate::onion_message::{CustomOnionMessageContents, CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
28+
use crate::onion_message::messenger::{CustomOnionMessageHandler, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
29+
use crate::onion_message::packet::CustomOnionMessageContents;
2930
use crate::routing::gossip::{NetworkGraph, P2PGossipSync};
3031
use crate::util::atomic_counter::AtomicCounter;
3132
use crate::util::crypto::sign;

lightning/src/onion_message/functional_tests.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
use crate::chain::keysinterface::{KeysInterface, Recipient};
1313
use crate::ln::features::InitFeatures;
1414
use crate::ln::msgs::{self, DecodeError, OnionMessageHandler};
15-
use super::{BlindedRoute, CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OnionMessageContents, OnionMessenger, SendError};
15+
use super::blinded_route::BlindedRoute;
16+
use super::messenger::{CustomOnionMessageHandler, Destination, OnionMessenger, SendError};
17+
use super::packet::{CustomOnionMessageContents, OnionMessageContents};
1618
use crate::util::enforcing_trait_impls::EnforcingSigner;
1719
use crate::util::ser::{ Writeable, Writer};
1820
use crate::util::test_utils;

lightning/src/onion_message/messenger.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ use crate::ln::msgs::{self, OnionMessageHandler};
2121
use crate::ln::onion_utils;
2222
use crate::ln::peer_handler::IgnoringMessageHandler;
2323
use super::blinded_route::{BlindedRoute, ForwardTlvs, ReceiveTlvs};
24-
pub use super::packet::{CustomOnionMessageContents, OnionMessageContents};
24+
use super::packet::{CustomOnionMessageContents, OnionMessageContents};
2525
use super::packet::{BIG_PACKET_HOP_DATA_LEN, ForwardControlTlvs, Packet, Payload, ReceiveControlTlvs, SMALL_PACKET_HOP_DATA_LEN};
2626
use super::utils;
2727
use crate::util::events::OnionMessageProvider;
@@ -46,7 +46,9 @@ use crate::prelude::*;
4646
/// # use lightning::chain::keysinterface::{InMemorySigner, KeysManager, KeysInterface};
4747
/// # use lightning::ln::msgs::DecodeError;
4848
/// # use lightning::ln::peer_handler::IgnoringMessageHandler;
49-
/// # use lightning::onion_message::{BlindedRoute, CustomOnionMessageContents, Destination, OnionMessageContents, OnionMessenger};
49+
/// # use lightning::onion_message::messenger::{Destination, OnionMessenger};
50+
/// # use lightning::onion_message::packet::{CustomOnionMessageContents, OnionMessageContents};
51+
/// # use lightning::onion_message::blinded_route::BlindedRoute;
5052
/// # use lightning::util::logger::{Logger, Record};
5153
/// # use lightning::util::ser::{Writeable, Writer};
5254
/// # use lightning::io;

lightning/src/onion_message/mod.rs

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,12 @@
1818
//! information on its usage.
1919
//!
2020
//! [offers]: <https://github.com/lightning/bolts/pull/798>
21-
//! [blinded routes]: crate::onion_message::BlindedRoute
21+
//! [blinded routes]: crate::onion_message::blinded_route::BlindedRoute
22+
//! [`OnionMessenger`]: crate::onion_message::messenger::OnionMessenger
2223
23-
mod blinded_route;
24-
mod messenger;
25-
mod packet;
24+
pub mod blinded_route;
25+
pub mod messenger;
26+
pub mod packet;
2627
mod utils;
2728
#[cfg(test)]
2829
mod functional_tests;
29-
30-
// Re-export structs so they can be imported with just the `onion_message::` module prefix.
31-
pub use self::blinded_route::{BlindedRoute, BlindedHop};
32-
pub use self::messenger::{CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OnionMessageContents, OnionMessenger, SendError, SimpleArcOnionMessenger, SimpleRefOnionMessenger};
33-
pub(crate) use self::packet::Packet;

0 commit comments

Comments
 (0)