Skip to content

Introduce SendOnlyMessageHandler trait #3922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
Merged

Introduce SendOnlyMessageHandler trait #3922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion lightning/src/chain/chainmonitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::ln::channel_state::ChannelDetails;
use crate::ln::msgs::{self, BaseMessageHandler, Init, MessageSendEvent};
use crate::ln::msgs::{self, BaseMessageHandler, Init, MessageSendEvent, SendOnlyMessageHandler};
use crate::ln::our_peer_storage::DecryptedOurPeerStorage;
use crate::ln::types::ChannelId;
use crate::prelude::*;
Expand Down Expand Up @@ -866,6 +866,25 @@ where
}
}

impl<
ChannelSigner: EcdsaChannelSigner,
C: Deref,
T: Deref,
F: Deref,
L: Deref,
P: Deref,
ES: Deref,
> SendOnlyMessageHandler for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
C::Target: chain::Filter,
T::Target: BroadcasterInterface,
F::Target: FeeEstimator,
L::Target: Logger,
P::Target: Persist<ChannelSigner>,
ES::Target: EntropySource,
{
}

impl<
ChannelSigner: EcdsaChannelSigner,
C: Deref,
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/msgs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2177,6 +2177,13 @@ pub trait OnionMessageHandler: BaseMessageHandler {
fn timer_tick_occurred(&self);
}

/// A handler which can only be used to send messages.
///
/// This is implemented by [`ChainMonitor`].
///
/// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
pub trait SendOnlyMessageHandler: BaseMessageHandler {}

#[derive(Clone, Debug, PartialEq, Eq)]
/// Information communicated in the onion to the recipient for multi-part tracking and proof that
/// the payment is associated with an invoice.
Expand Down
23 changes: 14 additions & 9 deletions lightning/src/ln/peer_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use crate::blinded_path::message::{AsyncPaymentsContext, DNSResolverContext, Off
use crate::ln::msgs;
use crate::ln::msgs::{
BaseMessageHandler, ChannelMessageHandler, Init, LightningError, MessageSendEvent,
OnionMessageHandler, RoutingMessageHandler, SocketAddress,
OnionMessageHandler, RoutingMessageHandler, SendOnlyMessageHandler, SocketAddress,
};
use crate::ln::peer_channel_encryptor::{
MessageBuf, NextNoiseStep, PeerChannelEncryptor, MSG_BUF_ALLOC_SIZE,
Expand Down Expand Up @@ -270,6 +270,8 @@ impl CustomOnionMessageHandler for IgnoringMessageHandler {
}
}

impl SendOnlyMessageHandler for IgnoringMessageHandler {}

impl OnionMessageContents for Infallible {
fn tlv_type(&self) -> u64 {
unreachable!();
Expand Down Expand Up @@ -581,7 +583,7 @@ where
RM::Target: RoutingMessageHandler,
OM::Target: OnionMessageHandler,
CustomM::Target: CustomMessageHandler,
SM::Target: BaseMessageHandler,
SM::Target: SendOnlyMessageHandler,
{
/// A message handler which handles messages specific to channels. Usually this is just a
/// [`ChannelManager`] object or an [`ErroringMessageHandler`].
Expand All @@ -604,8 +606,9 @@ where
/// [`IgnoringMessageHandler`].
pub custom_message_handler: CustomM,

/// A message handler which can be used to send messages. This should generally be a
/// [`ChainMonitor`].
/// A message handler which can be used to send messages.
///
/// This should generally be a [`ChainMonitor`].
///
/// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
pub send_only_message_handler: SM,
Expand Down Expand Up @@ -965,7 +968,7 @@ pub trait APeerManager {
type CMH: Deref<Target = Self::CMHT>;
type NST: NodeSigner + ?Sized;
type NS: Deref<Target = Self::NST>;
type SMT: BaseMessageHandler + ?Sized;
type SMT: SendOnlyMessageHandler + ?Sized;
type SM: Deref<Target = Self::SMT>;
/// Gets a reference to the underlying [`PeerManager`].
fn as_ref(
Expand Down Expand Up @@ -999,7 +1002,7 @@ where
L::Target: Logger,
CMH::Target: CustomMessageHandler,
NS::Target: NodeSigner,
SM::Target: BaseMessageHandler,
SM::Target: SendOnlyMessageHandler,
{
type Descriptor = Descriptor;
type CMT = <CM as Deref>::Target;
Expand Down Expand Up @@ -1056,7 +1059,7 @@ pub struct PeerManager<
L::Target: Logger,
CMH::Target: CustomMessageHandler,
NS::Target: NodeSigner,
SM::Target: BaseMessageHandler,
SM::Target: SendOnlyMessageHandler,
{
message_handler: MessageHandler<CM, RM, OM, CMH, SM>,
/// Connection state for each connected peer - we have an outer read-write lock which is taken
Expand Down Expand Up @@ -1140,7 +1143,7 @@ where
OM::Target: OnionMessageHandler,
L::Target: Logger,
NS::Target: NodeSigner,
SM::Target: BaseMessageHandler,
SM::Target: SendOnlyMessageHandler,
{
/// Constructs a new `PeerManager` with the given `ChannelMessageHandler` and
/// `OnionMessageHandler`. No routing message handler is used and network graph messages are
Expand Down Expand Up @@ -1290,7 +1293,7 @@ where
L::Target: Logger,
CMH::Target: CustomMessageHandler,
NS::Target: NodeSigner,
SM::Target: BaseMessageHandler,
SM::Target: SendOnlyMessageHandler,
{
/// Constructs a new `PeerManager` with the given message handlers.
///
Expand Down Expand Up @@ -3841,6 +3844,8 @@ mod tests {
}
}

impl SendOnlyMessageHandler for TestBaseMsgHandler {}

fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
let mut cfgs = Vec::new();
for i in 0..peer_count {
Expand Down