Upgrade to secp256k1 v12, bitcoin v16, and crates bitcoin_hashes
[rust-lightning] / src / ln / peer_handler.rs
index d868b0758bd745a6e7ee53294e7127c7942d4a89..78a5896f2ce993899d3a0fd1b2b1c3450d4c26a8 100644 (file)
@@ -88,6 +88,12 @@ impl error::Error for PeerHandleError {
        }
 }
 
+enum InitSyncTracker{
+       NoSyncRequested,
+       ChannelsSyncing(u64),
+       NodesSyncing(PublicKey),
+}
+
 struct Peer {
        channel_encryptor: PeerChannelEncryptor,
        outbound: bool,
@@ -102,6 +108,24 @@ struct Peer {
        pending_read_buffer: Vec<u8>,
        pending_read_buffer_pos: usize,
        pending_read_is_header: bool,
+
+       sync_status: InitSyncTracker,
+}
+
+impl Peer {
+       /// Returns true if the the channel announcements/updates for the given channel should be
+       /// forwarded to this peer.
+       /// If we are sending our routing table to this peer and we have not yet sent channel
+       /// announcements/updates for the given channel_id then we will send it when we get to that
+       /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
+       /// sent the old versions, we should send the update, and so return true here.
+       fn should_forward_channel(&self, channel_id: u64)->bool{
+               match self.sync_status {
+                       InitSyncTracker::NoSyncRequested => true,
+                       InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
+                       InitSyncTracker::NodesSyncing(_) => true,
+               }
+       }
 }
 
 struct PeerHolder<Descriptor: SocketDescriptor> {
@@ -210,7 +234,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                if peers.peers.insert(descriptor, Peer {
                        channel_encryptor: peer_encryptor,
                        outbound: true,
-                       their_node_id: Some(their_node_id),
+                       their_node_id: None,
                        their_global_features: None,
                        their_local_features: None,
 
@@ -221,6 +245,8 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                        pending_read_buffer: pending_read_buffer,
                        pending_read_buffer_pos: 0,
                        pending_read_is_header: false,
+
+                       sync_status: InitSyncTracker::NoSyncRequested,
                }).is_some() {
                        panic!("PeerManager driver duplicated descriptors!");
                };
@@ -255,21 +281,74 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                        pending_read_buffer: pending_read_buffer,
                        pending_read_buffer_pos: 0,
                        pending_read_is_header: false,
+
+                       sync_status: InitSyncTracker::NoSyncRequested,
                }).is_some() {
                        panic!("PeerManager driver duplicated descriptors!");
                };
                Ok(())
        }
 
-       fn do_attempt_write_data(descriptor: &mut Descriptor, peer: &mut Peer) {
+       fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
+               macro_rules! encode_and_send_msg {
+                       ($msg: expr, $msg_code: expr) => {
+                               {
+                                       log_trace!(self, "Encoding and sending sync update message of type {} to {}", $msg_code, log_pubkey!(peer.their_node_id.unwrap()));
+                                       peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!($msg, $msg_code)[..]));
+                               }
+                       }
+               }
+               const MSG_BUFF_SIZE: usize = 10;
                while !peer.awaiting_write_event {
+                       if peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE {
+                               match peer.sync_status {
+                                       InitSyncTracker::NoSyncRequested => {},
+                                       InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
+                                               let steps = ((MSG_BUFF_SIZE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
+                                               let all_messages = self.message_handler.route_handler.get_next_channel_announcements(0, steps);
+                                               for &(ref announce, ref update_a, ref update_b) in all_messages.iter() {
+                                                       encode_and_send_msg!(announce, 256);
+                                                       encode_and_send_msg!(update_a, 258);
+                                                       encode_and_send_msg!(update_b, 258);
+                                                       peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
+                                               }
+                                               if all_messages.is_empty() || all_messages.len() != steps as usize {
+                                                       peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
+                                               }
+                                       },
+                                       InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
+                                               let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
+                                               let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
+                                               for msg in all_messages.iter() {
+                                                       encode_and_send_msg!(msg, 256);
+                                                       peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
+                                               }
+                                               if all_messages.is_empty() || all_messages.len() != steps as usize {
+                                                       peer.sync_status = InitSyncTracker::NoSyncRequested;
+                                               }
+                                       },
+                                       InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
+                                       InitSyncTracker::NodesSyncing(key) => {
+                                               let steps = (MSG_BUFF_SIZE - peer.pending_outbound_buffer.len()) as u8;
+                                               let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
+                                               for msg in all_messages.iter() {
+                                                       encode_and_send_msg!(msg, 256);
+                                                       peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
+                                               }
+                                               if all_messages.is_empty() || all_messages.len() != steps as usize {
+                                                       peer.sync_status = InitSyncTracker::NoSyncRequested;
+                                               }
+                                       },
+                               }
+                       }
+
                        if {
                                let next_buff = match peer.pending_outbound_buffer.front() {
                                        None => return,
                                        Some(buff) => buff,
                                };
-                               let should_be_reading = peer.pending_outbound_buffer.len() < 10;
 
+                               let should_be_reading = peer.pending_outbound_buffer.len() < MSG_BUFF_SIZE;
                                let data_sent = descriptor.send_data(next_buff, peer.pending_outbound_buffer_first_msg_offset, should_be_reading);
                                peer.pending_outbound_buffer_first_msg_offset += data_sent;
                                if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
@@ -297,7 +376,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                        None => panic!("Descriptor for write_event is not already known to PeerManager"),
                        Some(peer) => {
                                peer.awaiting_write_event = false;
-                               Self::do_attempt_write_data(descriptor, peer);
+                               self.do_attempt_write_data(descriptor, peer);
                        }
                };
                Ok(())
@@ -417,10 +496,14 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                () => {
                                                                        match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
                                                                                hash_map::Entry::Occupied(_) => {
+                                                                                       log_trace!(self, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
                                                                                        peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
                                                                                        return Err(PeerHandleError{ no_connection_possible: false })
                                                                                },
-                                                                               hash_map::Entry::Vacant(entry) => entry.insert(peer_descriptor.clone()),
+                                                                               hash_map::Entry::Vacant(entry) => {
+                                                                                       log_trace!(self, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
+                                                                                       entry.insert(peer_descriptor.clone())
+                                                                               },
                                                                        };
                                                                }
                                                        }
@@ -433,11 +516,12 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                        peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
                                                                },
                                                                NextNoiseStep::ActTwo => {
-                                                                       let act_three = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret)).to_vec();
-                                                                       peer.pending_outbound_buffer.push_back(act_three);
+                                                                       let (act_three, their_node_id) = try_potential_handleerror!(peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
+                                                                       peer.pending_outbound_buffer.push_back(act_three.to_vec());
                                                                        peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
                                                                        peer.pending_read_is_header = true;
 
+                                                                       peer.their_node_id = Some(their_node_id);
                                                                        insert_node_id!();
                                                                        let mut local_features = msgs::LocalFeatures::new();
                                                                        if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
@@ -477,6 +561,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                log_trace!(self, "Received message of type {} from {}", msg_type, log_pubkey!(peer.their_node_id.unwrap()));
                                                                                if msg_type != 16 && peer.their_global_features.is_none() {
                                                                                        // Need an init message as first message
+                                                                                       log_trace!(self, "Peer {} sent non-Init first message", log_pubkey!(peer.their_node_id.unwrap()));
                                                                                        return Err(PeerHandleError{ no_connection_possible: false });
                                                                                }
                                                                                let mut reader = ::std::io::Cursor::new(&msg_data[2..]);
@@ -511,6 +596,10 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                        if msg.local_features.supports_unknown_bits() { "present" } else { "none" },
                                                                                                        if msg.global_features.supports_unknown_bits() { "present" } else { "none" });
 
+                                                                                               if msg.local_features.initial_routing_sync() {
+                                                                                                       peer.sync_status = InitSyncTracker::ChannelsSyncing(0);
+                                                                                                       peers.peers_needing_send.insert(peer_descriptor.clone());
+                                                                                               }
                                                                                                peer.their_global_features = Some(msg.global_features);
                                                                                                peer.their_local_features = Some(msg.local_features);
 
@@ -520,6 +609,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                                self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
                                                                                                                local_features.set_initial_routing_sync();
                                                                                                        }
+
                                                                                                        encode_and_send_msg!(msgs::Init {
                                                                                                                global_features: msgs::GlobalFeatures::new(),
                                                                                                                local_features,
@@ -667,7 +757,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                }
                                        }
 
-                                       Self::do_attempt_write_data(peer_descriptor, peer);
+                                       self.do_attempt_write_data(peer_descriptor, peer);
 
                                        peer.pending_outbound_buffer.len() > 10 // pause_read
                                }
@@ -724,7 +814,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 33)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
@@ -734,7 +824,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Drop the pending channel? (or just let it timeout, but that sucks)
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 32)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
@@ -746,7 +836,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //they should just throw away this funding transaction
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 34)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
@@ -757,7 +847,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //they should just throw away this funding transaction
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 35)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
@@ -767,7 +857,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 36)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
@@ -778,7 +868,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //they should just throw away this funding transaction
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 259)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
                                                log_trace!(self, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
@@ -806,7 +896,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                        peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 134)));
                                                }
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(commitment_signed, 132)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
@@ -816,7 +906,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 133)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
@@ -826,7 +916,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 39)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling Shutdown event in peer_handler for node {} for channel {}",
@@ -836,7 +926,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 38)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
                                                log_trace!(self, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
@@ -846,7 +936,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                        });
                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 136)));
-                                               Self::do_attempt_write_data(&mut descriptor, peer);
+                                               self.do_attempt_write_data(&mut descriptor, peer);
                                        },
                                        MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
                                                log_trace!(self, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
@@ -855,7 +945,8 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                        let encoded_update_msg = encode_msg!(update_msg, 258);
 
                                                        for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
-                                                               if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
+                                                               if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() ||
+                                                                               !peer.should_forward_channel(msg.contents.short_channel_id) {
                                                                        continue
                                                                }
                                                                match peer.their_node_id {
@@ -868,7 +959,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                }
                                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
                                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_update_msg[..]));
-                                                               Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
+                                                               self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
                                                        }
                                                }
                                        },
@@ -878,11 +969,12 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                        let encoded_msg = encode_msg!(msg, 258);
 
                                                        for (ref descriptor, ref mut peer) in peers.peers.iter_mut() {
-                                                               if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() {
+                                                               if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_global_features.is_none() ||
+                                                                               !peer.should_forward_channel(msg.contents.short_channel_id)  {
                                                                        continue
                                                                }
                                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_msg[..]));
-                                                               Self::do_attempt_write_data(&mut (*descriptor).clone(), peer);
+                                                               self.do_attempt_write_data(&mut (*descriptor).clone(), peer);
                                                        }
                                                }
                                        },
@@ -903,7 +995,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
                                                                                                // This isn't guaranteed to work, but if there is enough free
                                                                                                // room in the send buffer, put the error message there...
-                                                                                               Self::do_attempt_write_data(&mut descriptor, &mut peer);
+                                                                                               self.do_attempt_write_data(&mut descriptor, &mut peer);
                                                                                        } else {
                                                                                                log_trace!(self, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
                                                                                        }
@@ -921,7 +1013,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                //TODO: Do whatever we're gonna do for handling dropped messages
                                                                        });
                                                                        peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encode_msg!(msg, 17)));
-                                                                       Self::do_attempt_write_data(&mut descriptor, peer);
+                                                                       self.do_attempt_write_data(&mut descriptor, peer);
                                                                },
                                                        }
                                                } else {
@@ -933,7 +1025,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 
                        for mut descriptor in peers.peers_needing_send.drain() {
                                match peers.peers.get_mut(&descriptor) {
-                                       Some(peer) => Self::do_attempt_write_data(&mut descriptor, peer),
+                                       Some(peer) => self.do_attempt_write_data(&mut descriptor, peer),
                                        None => panic!("Inconsistent peers set state!"),
                                }
                        }
@@ -999,7 +1091,6 @@ mod tests {
        }
 
        fn create_network(peer_count: usize) -> Vec<PeerManager<FileDescriptor>> {
-               let secp_ctx = Secp256k1::new();
                let mut peers = Vec::new();
                let mut rng = thread_rng();
                let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
@@ -1010,7 +1101,7 @@ mod tests {
                        let node_id = {
                                let mut key_slice = [0;32];
                                rng.fill_bytes(&mut key_slice);
-                               SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
+                               SecretKey::from_slice(&key_slice).unwrap()
                        };
                        let msg_handler = MessageHandler { chan_handler: Arc::new(chan_handler), route_handler: Arc::new(router) };
                        let peer = PeerManager::new(msg_handler, node_id, Arc::clone(&logger));