1 use secp256k1::key::{SecretKey,PublicKey};
4 use ln::msgs::{MsgEncodable,MsgDecodable};
5 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
7 use util::events::{EventsProvider,Event};
8 use util::logger::{Logger, Record};
10 use std::collections::{HashMap,LinkedList};
11 use std::sync::{Arc, Mutex};
12 use std::sync::atomic::{AtomicUsize, Ordering};
13 use std::{cmp,error,mem,hash,fmt};
15 pub struct MessageHandler {
16 pub chan_handler: Arc<msgs::ChannelMessageHandler>,
17 pub route_handler: Arc<msgs::RoutingMessageHandler>,
20 /// Provides an object which can be used to send data to and which uniquely identifies a connection
21 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
22 /// implement Hash to meet the PeerManager API.
23 /// For efficiency, Clone should be relatively cheap for this type.
24 /// You probably want to just extend an int and put a file descriptor in a struct and implement
25 /// send_data. Note that if you are using a higher-level net library that may close() itself, be
26 /// careful to ensure you don't have races whereby you might register a new connection with an fd
27 /// the same as a yet-to-be-disconnect_event()-ed.
28 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
29 /// Attempts to send some data from the given Vec starting at the given offset to the peer.
30 /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
31 /// Note that in the disconnected case, a disconnect_event must still fire and further write
32 /// attempts may occur until that time.
33 /// If the returned size is smaller than data.len() - write_offset, a write_available event must
34 /// trigger the next time more data can be written. Additionally, until the a send_data event
35 /// completes fully, no further read_events should trigger on the same peer!
36 /// If a read_event on this descriptor had previously returned true (indicating that read
37 /// events should be paused to prevent DoS in the send buffer), resume_read may be set
38 /// indicating that read events on this descriptor should resume. A resume_read of false does
39 /// *not* imply that further read events should be paused.
40 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, resume_read: bool) -> usize;
41 /// Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
42 /// more calls to write_event, read_event or disconnect_event may be made with this descriptor.
43 /// No disconnect_event should be generated as a result of this call, though obviously races
44 /// may occur whereby disconnect_socket is called after a call to disconnect_event but prior to
45 /// that event completing.
46 fn disconnect_socket(&mut self);
49 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
50 /// generate no further read/write_events for the descriptor, only triggering a single
51 /// disconnect_event (unless it was provided in response to a new_*_connection event, in which case
52 /// no such disconnect_event must be generated and the socket be silently disconencted).
53 pub struct PeerHandleError {
54 no_connection_possible: bool,
56 impl fmt::Debug for PeerHandleError {
57 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
58 formatter.write_str("Peer Sent Invalid Data")
61 impl fmt::Display for PeerHandleError {
62 fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
63 formatter.write_str("Peer Sent Invalid Data")
66 impl error::Error for PeerHandleError {
67 fn description(&self) -> &str {
68 "Peer Sent Invalid Data"
73 channel_encryptor: PeerChannelEncryptor,
75 their_node_id: Option<PublicKey>,
76 their_global_features: Option<msgs::GlobalFeatures>,
77 their_local_features: Option<msgs::LocalFeatures>,
79 pending_outbound_buffer: LinkedList<Vec<u8>>,
80 pending_outbound_buffer_first_msg_offset: usize,
81 awaiting_write_event: bool,
83 pending_read_buffer: Vec<u8>,
84 pending_read_buffer_pos: usize,
85 pending_read_is_header: bool,
88 struct PeerHolder<Descriptor: SocketDescriptor> {
89 peers: HashMap<Descriptor, Peer>,
90 /// Only add to this set when noise completes:
91 node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
94 pub struct PeerManager<Descriptor: SocketDescriptor> {
95 message_handler: MessageHandler,
96 peers: Mutex<PeerHolder<Descriptor>>,
97 pending_events: Mutex<Vec<Event>>,
98 our_node_secret: SecretKey,
99 initial_syncs_sent: AtomicUsize,
104 macro_rules! encode_msg {
105 ($msg: expr, $msg_code: expr) => {
107 let just_msg = $msg.encode();
108 let mut encoded_msg = Vec::with_capacity(just_msg.len() + 2);
109 encoded_msg.extend_from_slice(&byte_utils::be16_to_array($msg_code));
110 encoded_msg.extend_from_slice(&just_msg[..]);
116 //TODO: Really should do something smarter for this
117 const INITIAL_SYNCS_TO_SEND: usize = 5;
119 /// Manages and reacts to connection events. You probably want to use file descriptors as PeerIds.
120 /// PeerIds may repeat, but only after disconnect_event() has been called.
121 impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
122 pub fn new(message_handler: MessageHandler, our_node_secret: SecretKey, logger: Arc<Logger>) -> PeerManager<Descriptor> {
124 message_handler: message_handler,
125 peers: Mutex::new(PeerHolder { peers: HashMap::new(), node_id_to_descriptor: HashMap::new() }),
126 pending_events: Mutex::new(Vec::new()),
127 our_node_secret: our_node_secret,
128 initial_syncs_sent: AtomicUsize::new(0),
133 /// Get the list of node ids for peers which have completed the initial handshake.
134 /// For outbound connections, this will be the same as the their_node_id parameter passed in to
135 /// new_outbound_connection, however entries will only appear once the initial handshake has
136 /// completed and we are sure the remote peer has the private key for the given node_id.
137 pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
138 let peers = self.peers.lock().unwrap();
139 peers.peers.values().filter_map(|p| p.their_node_id).collect()
142 /// Indicates a new outbound connection has been established to a node with the given node_id.
143 /// Note that if an Err is returned here you MUST NOT call disconnect_event for the new
144 /// descriptor but must disconnect the connection immediately.
145 /// Returns some bytes to send to the remote node.
146 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
147 /// disconnect_event.
148 pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor) -> Result<Vec<u8>, PeerHandleError> {
149 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone());
150 let res = peer_encryptor.get_act_one().to_vec();
151 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
153 let mut peers = self.peers.lock().unwrap();
154 if peers.peers.insert(descriptor, Peer {
155 channel_encryptor: peer_encryptor,
157 their_node_id: Some(their_node_id),
158 their_global_features: None,
159 their_local_features: None,
161 pending_outbound_buffer: LinkedList::new(),
162 pending_outbound_buffer_first_msg_offset: 0,
163 awaiting_write_event: false,
165 pending_read_buffer: pending_read_buffer,
166 pending_read_buffer_pos: 0,
167 pending_read_is_header: false,
169 panic!("PeerManager driver duplicated descriptors!");
174 /// Indicates a new inbound connection has been established.
175 /// May refuse the connection by returning an Err, but will never write bytes to the remote end
176 /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
177 /// call disconnect_event for the new descriptor but must disconnect the connection
179 /// Panics if descriptor is duplicative with some other descriptor which has not yet has a
180 /// disconnect_event.
181 pub fn new_inbound_connection(&self, descriptor: Descriptor) -> Result<(), PeerHandleError> {
182 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
183 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
185 let mut peers = self.peers.lock().unwrap();
186 if peers.peers.insert(descriptor, Peer {
187 channel_encryptor: peer_encryptor,
190 their_global_features: None,
191 their_local_features: None,
193 pending_outbound_buffer: LinkedList::new(),
194 pending_outbound_buffer_first_msg_offset: 0,
195 awaiting_write_event: false,
197 pending_read_buffer: pending_read_buffer,
198 pending_read_buffer_pos: 0,
199 pending_read_is_header: false,
201 panic!("PeerManager driver duplicated descriptors!");
206 fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
207 while !peer.awaiting_write_event {
209 let next_buff = match peer.pending_outbound_buffer.front() {
213 let should_be_reading = peer.pending_outbound_buffer.len() < 10;
215 let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
216 peer.pending_outbound_buffer_first_msg_offset += data_sent;
217 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
219 peer.pending_outbound_buffer_first_msg_offset = 0;
220 peer.pending_outbound_buffer.pop_front();
222 peer.awaiting_write_event = true;
227 /// Indicates that there is room to write data to the given socket descriptor.
228 /// May return an Err to indicate that the connection should be closed.
229 /// Will most likely call send_data on the descriptor passed in (or the descriptor handed into
230 /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
231 /// invariants around calling write_event in case a write did not fully complete must still
232 /// hold - be ready to call write_event again if a write call generated here isn't sufficient!
233 /// Panics if the descriptor was not previously registered in a new_*_connection event.
234 pub fn write_event(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
235 let mut peers = self.peers.lock().unwrap();
236 match peers.peers.get_mut(descriptor) {
237 None => panic!("Descriptor for write_event is not already known to PeerManager"),
239 peer.awaiting_write_event = false;
240 Self::do_attempt_write_data(descriptor, peer);
246 /// Indicates that data was read from the given socket descriptor.
247 /// May return an Err to indicate that the connection should be closed.
248 /// Will very likely call send_data on the descriptor passed in (or a descriptor handed into
249 /// new_*_connection) before returning. Thus, be very careful with reentrancy issues! The
250 /// invariants around calling write_event in case a write did not fully complete must still
251 /// hold. Note that this function will often call send_data on many peers before returning, not
253 /// If Ok(true) is returned, further read_events should not be triggered until a write_event on
254 /// this file descriptor has resume_read set (preventing DoS issues in the send buffer). Note
255 /// that this must be true even if a send_data call with resume_read=true was made during the
256 /// course of this function!
257 /// Panics if the descriptor was not previously registered in a new_*_connection event.
258 pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
259 match self.do_read_event(peer_descriptor, data) {
262 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
268 fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
270 let mut peers = self.peers.lock().unwrap();
271 let (should_insert_node_id, pause_read) = match peers.peers.get_mut(peer_descriptor) {
272 None => panic!("Descriptor for read_event is not already known to PeerManager"),
274 assert!(peer.pending_read_buffer.len() > 0);
275 assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
277 let mut insert_node_id = None;
278 let mut read_pos = 0;
279 while read_pos < data.len() {
281 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
282 peer.pending_read_buffer[peer.pending_read_buffer_pos..peer.pending_read_buffer_pos + data_to_copy].copy_from_slice(&data[read_pos..read_pos + data_to_copy]);
283 read_pos += data_to_copy;
284 peer.pending_read_buffer_pos += data_to_copy;
287 if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
288 peer.pending_read_buffer_pos = 0;
290 macro_rules! encode_and_send_msg {
291 ($msg: expr, $msg_code: expr) => {
293 log_trace!(self, "Encoding and sending message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
294 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
299 macro_rules! try_potential_handleerror {
304 if let Some(action) = e.action {
306 msgs::ErrorAction::UpdateFailHTLC { msg } => {
307 encode_and_send_msg!(msg, 131);
310 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
311 return Err(PeerHandleError{ no_connection_possible: false });
313 msgs::ErrorAction::IgnoreError => {
316 msgs::ErrorAction::SendErrorMessage { msg } => {
317 encode_and_send_msg!(msg, 17);
322 return Err(PeerHandleError{ no_connection_possible: false });
329 macro_rules! try_potential_decodeerror {
335 return Err(PeerHandleError{ no_connection_possible: false });
341 macro_rules! try_ignore_potential_decodeerror {
346 log_debug!(self, "Error decoding message, ignoring due to lnd spec incompatibility. See https://github.com/lightningnetwork/lnd/issues/1407");
353 let next_step = peer.channel_encryptor.get_noise_step();
355 NextNoiseStep::ActOne => {
356 let act_two = try_potential_handleerror!(peer.channel_encryptor.process_act_one_with_key(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
357 peer.pending_outbound_buffer.push_back(act_two);
358 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
360 NextNoiseStep::ActTwo => {
361 let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
362 peer.pending_outbound_buffer.push_back(act_three);
363 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
364 peer.pending_read_is_header = true;
366 insert_node_id = Some(peer.their_node_id.unwrap());
367 let mut local_features = msgs::LocalFeatures::new();
368 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
369 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
370 local_features.set_initial_routing_sync();
372 encode_and_send_msg!(msgs::Init {
373 global_features: msgs::GlobalFeatures::new(),
377 NextNoiseStep::ActThree => {
378 let their_node_id = try_potential_handleerror!(peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
379 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
380 peer.pending_read_is_header = true;
381 peer.their_node_id = Some(their_node_id);
382 insert_node_id = Some(peer.their_node_id.unwrap());
384 NextNoiseStep::NoiseComplete => {
385 if peer.pending_read_is_header {
386 let msg_len = try_potential_handleerror!(peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
387 peer.pending_read_buffer = Vec::with_capacity(msg_len as usize + 16);
388 peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
389 if msg_len < 2 { // Need at least the message type tag
390 return Err(PeerHandleError{ no_connection_possible: false });
392 peer.pending_read_is_header = false;
394 let msg_data = try_potential_handleerror!(peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
395 assert!(msg_data.len() >= 2);
398 peer.pending_read_buffer = [0; 18].to_vec();
399 peer.pending_read_is_header = true;
401 let msg_type = byte_utils::slice_to_be16(&msg_data[0..2]);
402 log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
403 if msg_type != 16 && peer.their_global_features.is_none() {
404 // Need an init message as first message
405 return Err(PeerHandleError{ no_connection_possible: false });
408 // Connection control:
410 let msg = try_potential_decodeerror!(msgs::Init::decode(&msg_data[2..]));
411 if msg.global_features.requires_unknown_bits() {
412 return Err(PeerHandleError{ no_connection_possible: true });
414 if msg.local_features.requires_unknown_bits() {
415 return Err(PeerHandleError{ no_connection_possible: true });
417 peer.their_global_features = Some(msg.global_features);
418 peer.their_local_features = Some(msg.local_features);
421 let mut local_features = msgs::LocalFeatures::new();
422 if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
423 self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
424 local_features.set_initial_routing_sync();
426 encode_and_send_msg!(msgs::Init {
427 global_features: msgs::GlobalFeatures::new(),
437 let msg = try_potential_decodeerror!(msgs::Ping::decode(&msg_data[2..]));
438 if msg.ponglen < 65532 {
439 let resp = msgs::Pong { byteslen: msg.ponglen };
440 encode_and_send_msg!(resp, 19);
444 try_potential_decodeerror!(msgs::Pong::decode(&msg_data[2..]));
449 let msg = try_potential_decodeerror!(msgs::OpenChannel::decode(&msg_data[2..]));
450 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
451 encode_and_send_msg!(resp, 33);
454 let msg = try_potential_decodeerror!(msgs::AcceptChannel::decode(&msg_data[2..]));
455 try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
459 let msg = try_potential_decodeerror!(msgs::FundingCreated::decode(&msg_data[2..]));
460 let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
461 encode_and_send_msg!(resp, 35);
464 let msg = try_potential_decodeerror!(msgs::FundingSigned::decode(&msg_data[2..]));
465 try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
468 let msg = try_potential_decodeerror!(msgs::FundingLocked::decode(&msg_data[2..]));
469 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
471 Some(resp) => encode_and_send_msg!(resp, 259),
477 let msg = try_potential_decodeerror!(msgs::Shutdown::decode(&msg_data[2..]));
478 let resp_options = try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
479 if let Some(resp) = resp_options.0 {
480 encode_and_send_msg!(resp, 38);
482 if let Some(resp) = resp_options.1 {
483 encode_and_send_msg!(resp, 39);
487 let msg = try_potential_decodeerror!(msgs::ClosingSigned::decode(&msg_data[2..]));
488 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
489 if let Some(resp) = resp_option {
490 encode_and_send_msg!(resp, 39);
495 let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::decode(&msg_data[2..]));
496 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
499 let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::decode(&msg_data[2..]));
500 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
503 let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::decode(&msg_data[2..]));
504 let chan_update = try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
505 if let Some(update) = chan_update {
506 self.message_handler.route_handler.handle_htlc_fail_channel_update(&update);
510 let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::decode(&msg_data[2..]));
511 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
515 let msg = try_potential_decodeerror!(msgs::CommitmentSigned::decode(&msg_data[2..]));
516 let resps = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
517 encode_and_send_msg!(resps.0, 133);
518 if let Some(resp) = resps.1 {
519 encode_and_send_msg!(resp, 132);
523 let msg = try_potential_decodeerror!(msgs::RevokeAndACK::decode(&msg_data[2..]));
524 let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
527 for resp in resps.update_add_htlcs {
528 encode_and_send_msg!(resp, 128);
530 for resp in resps.update_fulfill_htlcs {
531 encode_and_send_msg!(resp, 130);
533 for resp in resps.update_fail_htlcs {
534 encode_and_send_msg!(resp, 131);
536 encode_and_send_msg!(resps.commitment_signed, 132);
542 let msg = try_potential_decodeerror!(msgs::UpdateFee::decode(&msg_data[2..]));
543 try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
545 136 => { }, // TODO: channel_reestablish
549 let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::decode(&msg_data[2..]));
550 try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
553 let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::decode(&msg_data[2..]));
554 let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
557 // TODO: forward msg along to all our other peers!
561 let msg = try_ignore_potential_decodeerror!(msgs::NodeAnnouncement::decode(&msg_data[2..]));
562 try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
565 let msg = try_potential_decodeerror!(msgs::ChannelUpdate::decode(&msg_data[2..]));
566 try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
569 if (msg_type & 1) == 0 {
570 return Err(PeerHandleError{ no_connection_possible: true });
580 Self::do_attempt_write_data(peer_descriptor, peer);
582 (insert_node_id /* should_insert_node_id */, peer.pending_outbound_buffer.len() > 10) // pause_read
586 match should_insert_node_id {
587 Some(node_id) => { peers.node_id_to_descriptor.insert(node_id, peer_descriptor.clone()); },
594 self.process_events();
599 /// Checks for any events generated by our handlers and processes them. May be needed after eg
600 /// calls to ChannelManager::process_pending_htlc_forward.
601 pub fn process_events(&self) {
602 let mut upstream_events = Vec::new();
604 // TODO: There are some DoS attacks here where you can flood someone's outbound send
605 // buffer by doing things like announcing channels on another node. We should be willing to
606 // drop optional-ish messages when send buffers get full!
608 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_events();
609 let mut peers = self.peers.lock().unwrap();
610 for event in events_generated.drain(..) {
611 macro_rules! get_peer_for_forwarding {
612 ($node_id: expr, $handle_no_such_peer: block) => {
614 let descriptor = match peers.node_id_to_descriptor.get($node_id) {
615 Some(descriptor) => descriptor.clone(),
617 $handle_no_such_peer;
621 match peers.peers.get_mut(&descriptor) {
625 None => panic!("Inconsistent peers set state!"),
631 Event::FundingGenerationReady {..} => { /* Hand upstream */ },
632 Event::FundingBroadcastSafe {..} => { /* Hand upstream */ },
633 Event::PaymentReceived {..} => { /* Hand upstream */ },
634 Event::PaymentSent {..} => { /* Hand upstream */ },
635 Event::PaymentFailed {..} => { /* Hand upstream */ },
636 Event::PendingHTLCsForwardable {..} => { /* Hand upstream */ },
638 Event::SendOpenChannel { ref node_id, ref msg } => {
639 log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
640 log_pubkey!(node_id),
641 log_bytes!(msg.temporary_channel_id));
642 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
643 //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
645 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
646 Self::do_attempt_write_data(&mut descriptor, peer);
649 Event::SendFundingCreated { ref node_id, ref msg } => {
650 log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
651 log_pubkey!(node_id),
652 log_bytes!(msg.temporary_channel_id),
653 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
654 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
655 //TODO: generate a DiscardFunding event indicating to the wallet that
656 //they should just throw away this funding transaction
658 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
659 Self::do_attempt_write_data(&mut descriptor, peer);
662 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
663 log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {}{} for channel {}",
664 log_pubkey!(node_id),
665 if announcement_sigs.is_some() { " with announcement sigs" } else { "" },
666 log_bytes!(msg.channel_id));
667 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
668 //TODO: Do whatever we're gonna do for handling dropped messages
670 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
671 match announcement_sigs {
672 &Some(ref announce_msg) => peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(announce_msg, 259))),
675 Self::do_attempt_write_data(&mut descriptor, peer);
678 Event::SendHTLCs { ref node_id, ref msgs, ref commitment_msg } => {
679 log_trace!(self, "Handling SendHTLCs event in peer_handler for node {} with {} HTLCs for channel {}",
680 log_pubkey!(node_id),
682 log_bytes!(commitment_msg.channel_id));
683 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
684 //TODO: Do whatever we're gonna do for handling dropped messages
687 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 128)));
689 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
690 Self::do_attempt_write_data(&mut descriptor, peer);
693 Event::SendFulfillHTLC { ref node_id, ref msg, ref commitment_msg } => {
694 log_trace!(self, "Handling SendFulfillHTLCs event in peer_handler for node {} with payment_preimage {} for channel {}",
695 log_pubkey!(node_id),
696 log_bytes!(msg.payment_preimage),
697 log_bytes!(msg.channel_id));
698 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
699 //TODO: Do whatever we're gonna do for handling dropped messages
701 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 130)));
702 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
703 Self::do_attempt_write_data(&mut descriptor, peer);
706 Event::SendFailHTLC { ref node_id, ref msg, ref commitment_msg } => {
707 log_trace!(self, "Handling SendFailHTLCs event in peer_handler for node {} for HTLC ID {} for channel {}",
708 log_pubkey!(node_id),
710 log_bytes!(msg.channel_id));
711 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
712 //TODO: Do whatever we're gonna do for handling dropped messages
714 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
715 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_msg, 132)));
716 Self::do_attempt_write_data(&mut descriptor, peer);
719 Event::SendShutdown { ref node_id, ref msg } => {
720 log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
721 log_pubkey!(node_id),
722 log_bytes!(msg.channel_id));
723 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
724 //TODO: Do whatever we're gonna do for handling dropped messages
726 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
727 Self::do_attempt_write_data(&mut descriptor, peer);
730 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
731 log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
732 if self.message_handler.route_handler.handle_channel_announcement(msg).is_ok() && self.message_handler.route_handler.handle_channel_update(update_msg).is_ok() {
733 let encoded_msg = encode_msg!(msg, 256);
734 let encoded_update_msg = encode_msg!(update_msg, 258);
736 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
737 if !peer.channel_encryptor.is_ready_for_encryption() {
740 match peer.their_node_id {
742 Some(their_node_id) => {
743 if their_node_id == msg.contents.node_id_1 || their_node_id == msg.contents.node_id_2 {
748 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
749 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
750 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
755 Event::BroadcastChannelUpdate { ref msg } => {
756 log_trace!(self, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
757 if self.message_handler.route_handler.handle_channel_update(msg).is_ok() {
758 let encoded_msg = encode_msg!(msg, 258);
760 for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
761 if !peer.channel_encryptor.is_ready_for_encryption() {
764 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
765 Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
770 Event::HandleError { ref node_id, ref action } => {
771 if let Some(ref action) = *action {
773 msgs::ErrorAction::UpdateFailHTLC { ref msg } => {
774 log_trace!(self, "Handling UpdateFailHTLC HandleError event in peer_handler for node {} for HTLC ID {} for channel {}",
775 log_pubkey!(node_id),
777 log_bytes!(msg.channel_id));
778 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
779 //TODO: Do whatever we're gonna do for handling dropped messages
781 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 131)));
782 Self::do_attempt_write_data(&mut descriptor, peer);
785 msgs::ErrorAction::DisconnectPeer { ref msg } => {
786 if let Some(mut descriptor) = peers.node_id_to_descriptor.remove(node_id) {
787 if let Some(mut peer) = peers.peers.remove(&descriptor) {
788 if let Some(ref msg) = *msg {
789 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
790 log_pubkey!(node_id),
792 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
793 // This isn't guaranteed to work, but if there is enough free
794 // room in the send buffer, put the error message there...
795 Self::do_attempt_write_data(&mut descriptor, &mut peer);
797 log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
800 descriptor.disconnect_socket();
801 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
804 msgs::ErrorAction::IgnoreError => {
807 msgs::ErrorAction::SendErrorMessage { ref msg } => {
808 log_trace!(self, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
809 log_pubkey!(node_id),
811 let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, {
812 //TODO: Do whatever we're gonna do for handling dropped messages
814 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
815 Self::do_attempt_write_data(&mut descriptor, peer);
819 log_error!(self, "Got no-action HandleError Event in peer_handler for node {}, no such events should ever be generated!", log_pubkey!(node_id));
825 upstream_events.push(event);
829 let mut pending_events = self.pending_events.lock().unwrap();
830 for event in upstream_events.drain(..) {
831 pending_events.push(event);
835 /// Indicates that the given socket descriptor's connection is now closed.
836 /// This must be called even if a PeerHandleError was given for a read_event or write_event,
837 /// but must NOT be called if a PeerHandleError was provided out of a new_*_connection event!
838 /// Panics if the descriptor was not previously registered in a successful new_*_connection event.
839 pub fn disconnect_event(&self, descriptor: &Descriptor) {
840 self.disconnect_event_internal(descriptor, false);
843 fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
844 let mut peers = self.peers.lock().unwrap();
845 let peer_option = peers.peers.remove(descriptor);
847 None => panic!("Descriptor for disconnect_event is not already known to PeerManager"),
849 match peer.their_node_id {
851 peers.node_id_to_descriptor.remove(&node_id);
852 self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
861 impl<Descriptor: SocketDescriptor> EventsProvider for PeerManager<Descriptor> {
862 fn get_and_clear_pending_events(&self) -> Vec<Event> {
863 let mut pending_events = self.pending_events.lock().unwrap();
864 let mut ret = Vec::new();
865 mem::swap(&mut ret, &mut *pending_events);
872 use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
875 use util::test_utils;
876 use util::logger::Logger;
878 use secp256k1::Secp256k1;
879 use secp256k1::key::{SecretKey, PublicKey};
881 use rand::{thread_rng, Rng};
883 use std::sync::{Arc};
885 #[derive(PartialEq, Eq, Clone, Hash)]
886 struct FileDescriptor {
890 impl SocketDescriptor for FileDescriptor {
891 fn send_data(&mut self, data: &Vec<u8>, write_offset: usize, _resume_read: bool) -> usize {
892 assert!(write_offset < data.len());
893 data.len() - write_offset
896 fn disconnect_socket(&mut self) {}
899 fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
900 let secp_ctx = Secp256k1::new();
901 let mut peers = Vec::new();
902 let mut rng = thread_rng();
903 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
905 for _ in 0..peer_count {
906 let chan_handler = test_utils::TestChannelMessageHandler::new();
907 let router = test_utils::TestRoutingMessageHandler::new();
909 let mut key_slice = [0;32];
910 rng.fill_bytes(&mut key_slice);
911 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
913 let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
914 let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));
921 fn establish_connection(peer_a: &PeerManager<FileDescriptor>, peer_b: &PeerManager<FileDescriptor>) {
922 let secp_ctx = Secp256k1::new();
923 let their_id = PublicKey::from_secret_key(&secp_ctx, &peer_b.our_node_secret).unwrap();
924 let fd = FileDescriptor { fd: 1};
925 peer_a.new_inbound_connection(fd.clone()).unwrap();
926 peer_a.peers.lock().unwrap().node_id_to_descriptor.insert(their_id, fd.clone());
930 fn test_disconnect_peer() {
931 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
932 // push an DisconnectPeer event to remove the node flagged by id
933 let mut peers = create_network(2);
934 establish_connection(&peers[0], &peers[1]);
935 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 1);
937 let secp_ctx = Secp256k1::new();
938 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret).unwrap();
940 let chan_handler = test_utils::TestChannelMessageHandler::new();
941 chan_handler.pending_events.lock().unwrap().push(events::Event::HandleError {
943 action: Some(msgs::ErrorAction::DisconnectPeer { msg: None }),
945 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
946 peers[0].message_handler.chan_handler = Arc::new(chan_handler);
948 peers[0].process_events();
949 assert_eq!(peers[0].peers.lock().unwrap().peers.len(), 0);