@@ -4,10 +4,10 @@ use reth_network::protocol::ProtocolHandler as ProtocolHandlerTrait;
44use reth_network_api:: PeerId ;
55use tokio:: sync:: mpsc;
66
7- /// A Receiver for `ScrollWireEvents` .
7+ /// A Receiver for [`Event`] .
88pub ( super ) type ScrollWireEventReceiver = mpsc:: UnboundedReceiver < Event > ;
99
10- /// A Sender for `ScrollWireEvents` .
10+ /// A Sender for [`Event`] .
1111pub ( super ) type ScrollWireEventSender = mpsc:: UnboundedSender < Event > ;
1212
1313/// The state of the protocol.
@@ -20,15 +20,15 @@ pub struct ProtocolState {
2020}
2121
2222impl ProtocolState {
23- /// Returns a reference to the sender for emitting [`ScrollWireEvent `]s.
23+ /// Returns a reference to the sender for emitting [`Event `]s.
2424 pub const fn event_sender ( & self ) -> & ScrollWireEventSender {
2525 & self . event_sender
2626 }
2727}
2828
2929/// A handler for the `ScrollWire` protocol.
3030///
31- /// This handler contains the state of the protocol ([`ProtocolState`]) and protocol configuration.
31+ /// This handler contains the state of the protocol and protocol configuration.
3232/// This type is responsible for handling incoming and outgoing connections. It would typically be
3333/// used for protocol negotiation, but currently we do not have any.
3434#[ derive( Debug ) ]
@@ -38,8 +38,8 @@ pub struct ProtocolHandler {
3838}
3939
4040impl ProtocolHandler {
41- /// Creates a tuple of ([`ProtocolHandler`], [`ScrollWireEventReceiver `]) from the provided
42- /// configuration.
41+ /// Creates a tuple of ([`ProtocolHandler`], [`mpsc::UnboundedReceiver<Event> `]) from the
42+ /// provided configuration.
4343 pub fn new ( config : ScrollWireConfig ) -> ( Self , ScrollWireEventReceiver ) {
4444 let ( events_tx, events_rx) = mpsc:: unbounded_channel ( ) ;
4545 let state = ProtocolState { event_sender : events_tx } ;
0 commit comments