Construct outbound OMs before enqueueing them
What the developer wrote
Authored by Valentine Wallace
Construct outbound OMs before enqueueing them
Makes the next commit cleaner when we add support for forwarding onion messages
within send_onion_message_internal. Also rename enqueue_onion_message to
specify that it is used for outbound onion messages.
What changed, and why it matters
This commit is a straightforward internal code reorganization in the onion messaging module. It moves the construction of outbound onion messages to happen before they are placed in a send queue, and renames a helper function to clarify it handles outbound traffic. There is no indication of a security fix or behavior change.
No security action required. Treat as normal refactoring.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The change refactors send_onion_message_internal and send_onion_message_using_path so that create_onion_message is called directly in each, producing an OnionMessage, first_node_id, and optional addresses. These are then passed to a renamed enqueue_outbound_onion_message helper, which no longer constructs the message itself. The logic for pathfinding, message creation, buffer-full checks, and queue insertion remains functionally identical. The commit message explicitly frames this as preparation for a future feature (forwarding onion messages).
Changed components
lightning/src/onion_message/messenger.rsInspect captured patch +35 / −22
diff --git a/lightning/src/onion_message/messenger.rs b/lightning/src/onion_message/messenger.rs
index de889a9..afdd97a 100644
--- a/lightning/src/onion_message/messenger.rs
+++ b/lightning/src/onion_message/messenger.rs
@@ -1492,13 +1492,29 @@ where
} => (destination, None),
};
- let mut logger = WithContext::from(&self.logger, None, None, None);
- let result = self.find_path(destination).and_then(|path| {
- let first_hop = path.intermediate_nodes.get(0).map(|p| *p);
- logger = WithContext::from(&self.logger, first_hop, None, None);
- self.enqueue_onion_message(path, contents, reply_path, log_suffix)
- });
+ let path = self.find_path(destination).map_err(|e| {
+ log_trace!(self.logger, "Failed to find path {}", log_suffix);
+ e
+ })?;
+ let first_hop = path.intermediate_nodes.get(0).map(|p| *p);
+ let logger = WithContext::from(&self.logger, first_hop, None, None);
+
+ log_trace!(logger, "Constructing onion message {}: {:?}", log_suffix, contents);
+ let (first_node_id, onion_message, addresses) = create_onion_message(
+ &self.entropy_source,
+ &self.node_signer,
+ &self.node_id_lookup,
+ &self.secp_ctx,
+ path,
+ contents,
+ reply_path,
+ )
+ .map_err(|e| {
+ log_warn!(logger, "Failed to create onion message with {:?} {}", e, log_suffix);
+ e
+ })?;
+ let result = self.enqueue_outbound_onion_message(onion_message, first_node_id, addresses);
match result.as_ref() {
Err(SendError::GetNodeIdFailed) => {
log_warn!(logger, "Unable to retrieve node id {}", log_suffix);
@@ -1578,22 +1594,10 @@ where
.map_err(|_| SendError::PathNotFound)
}
- fn enqueue_onion_message<T: OnionMessageContents>(
- &self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedMessagePath>,
- log_suffix: fmt::Arguments,
+ fn enqueue_outbound_onion_message(
+ &self, onion_message: OnionMessage, first_node_id: PublicKey,
+ addresses: Option<Vec<SocketAddress>>,
) -> Result<SendSuccess, SendError> {
- log_trace!(self.logger, "Constructing onion message {}: {:?}", log_suffix, contents);
-
- let (first_node_id, onion_message, addresses) = create_onion_message(
- &self.entropy_source,
- &self.node_signer,
- &self.node_id_lookup,
- &self.secp_ctx,
- path,
- contents,
- reply_path,
- )?;
-
let mut message_recipients = self.message_recipients.lock().unwrap();
if outbound_buffer_full(&first_node_id, &message_recipients) {
return Err(SendError::BufferFull);
@@ -1713,7 +1717,16 @@ where
pub fn send_onion_message_using_path<T: OnionMessageContents>(
&self, path: OnionMessagePath, contents: T, reply_path: Option<BlindedMessagePath>,
) -> Result<SendSuccess, SendError> {
- self.enqueue_onion_message(path, contents, reply_path, format_args!(""))
+ let (first_node_id, onion_message, addresses) = create_onion_message(
+ &self.entropy_source,
+ &self.node_signer,
+ &self.node_id_lookup,
+ &self.secp_ctx,
+ path,
+ contents,
+ reply_path,
+ )?;
+ self.enqueue_outbound_onion_message(onion_message, first_node_id, addresses)
}
pub(crate) fn peel_onion_message(
Why this scored 12/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.