From: Matt Corallo Date: Fri, 6 Jul 2018 21:29:34 +0000 (-0400) Subject: Move open_channel message handling into an event X-Git-Tag: v0.0.12~394^2 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=c47525cb8496c4a82b68e0933a3a5fe0c38e5494;p=rust-lightning Move open_channel message handling into an event This simplifies client usage cause peer_handler doesn't have an interface to shove arbitrary messages in. --- diff --git a/src/ln/channelmanager.rs b/src/ln/channelmanager.rs index 4dfa20a34..991c3e54f 100644 --- a/src/ln/channelmanager.rs +++ b/src/ln/channelmanager.rs @@ -233,7 +233,14 @@ impl ChannelManager { Ok(res) } - pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, user_id: u64) -> Result { + /// Creates a new outbound channel to the given remote node and with the given value. + /// user_id will be provided back as user_channel_id in FundingGenerationReady and + /// FundingBroadcastSafe events to allow tracking of which events correspond with which + /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you + /// may wish to avoid using 0 for user_id here. + /// If successful, will generate a SendOpenChannel event, so you should probably poll + /// PeerManager::process_events afterwards. + pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, user_id: u64) -> Result<(), HandleError> { let chan_keys = if cfg!(feature = "fuzztarget") { ChannelKeys { funding_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(), @@ -259,8 +266,15 @@ impl ChannelManager { let mut channel_state = self.channel_state.lock().unwrap(); match channel_state.by_id.insert(channel.channel_id(), channel) { Some(_) => panic!("RNG is bad???"), - None => Ok(res) + None => {} } + + let mut events = self.pending_events.lock().unwrap(); + events.push(events::Event::SendOpenChannel { + node_id: their_network_key, + msg: res, + }); + Ok(()) } /// Gets the list of open channels, in random order. See ChannelDetail field documentation for @@ -2004,17 +2018,27 @@ mod tests { static mut CHAN_COUNT: u32 = 0; fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, Uint256, Transaction) { - let open_chan = node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 42).unwrap(); - let accept_chan = node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_chan).unwrap(); + node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 42).unwrap(); + + let events_1 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_1.len(), 1); + let accept_chan = match events_1[0] { + Event::SendOpenChannel { ref node_id, ref msg } => { + assert_eq!(*node_id, node_b.node.get_our_node_id()); + node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap() + }, + _ => panic!("Unexpected event"), + }; + node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap(); let chan_id = unsafe { CHAN_COUNT }; let tx; let funding_output; - let events_1 = node_a.node.get_and_clear_pending_events(); - assert_eq!(events_1.len(), 1); - match events_1[0] { + let events_2 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_2.len(), 1); + match events_2[0] { Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => { assert_eq!(*channel_value_satoshis, 100000); assert_eq!(user_channel_id, 42); @@ -2033,9 +2057,9 @@ mod tests { _ => panic!("Unexpected event"), } - let events_2 = node_a.node.get_and_clear_pending_events(); - assert_eq!(events_2.len(), 1); - let funding_signed = match events_2[0] { + let events_3 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_3.len(), 1); + let funding_signed = match events_3[0] { Event::SendFundingCreated { ref node_id, ref msg } => { assert_eq!(*node_id, node_b.node.get_our_node_id()); let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap(); @@ -2056,9 +2080,9 @@ mod tests { added_monitors.clear(); } - let events_3 = node_a.node.get_and_clear_pending_events(); - assert_eq!(events_3.len(), 1); - match events_3[0] { + let events_4 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_4.len(), 1); + match events_4[0] { Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => { assert_eq!(user_channel_id, 42); assert_eq!(*funding_txo, funding_output); @@ -2067,9 +2091,9 @@ mod tests { }; confirm_transaction(&node_a.chain_monitor, &tx, chan_id); - let events_4 = node_a.node.get_and_clear_pending_events(); - assert_eq!(events_4.len(), 1); - match events_4[0] { + let events_5 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_5.len(), 1); + match events_5[0] { Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => { assert_eq!(*node_id, node_b.node.get_our_node_id()); assert!(announcement_sigs.is_none()); @@ -2081,9 +2105,9 @@ mod tests { let channel_id; confirm_transaction(&node_b.chain_monitor, &tx, chan_id); - let events_5 = node_b.node.get_and_clear_pending_events(); - assert_eq!(events_5.len(), 1); - let as_announcement_sigs = match events_5[0] { + let events_6 = node_b.node.get_and_clear_pending_events(); + assert_eq!(events_6.len(), 1); + let as_announcement_sigs = match events_6[0] { Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => { assert_eq!(*node_id, node_a.node.get_our_node_id()); channel_id = msg.channel_id.clone(); @@ -2094,9 +2118,9 @@ mod tests { _ => panic!("Unexpected event"), }; - let events_6 = node_a.node.get_and_clear_pending_events(); - assert_eq!(events_6.len(), 1); - let (announcement, as_update) = match events_6[0] { + let events_7 = node_a.node.get_and_clear_pending_events(); + assert_eq!(events_7.len(), 1); + let (announcement, as_update) = match events_7[0] { Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => { (msg, update_msg) }, @@ -2104,9 +2128,9 @@ mod tests { }; node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap(); - let events_7 = node_b.node.get_and_clear_pending_events(); - assert_eq!(events_7.len(), 1); - let bs_update = match events_7[0] { + let events_8 = node_b.node.get_and_clear_pending_events(); + assert_eq!(events_8.len(), 1); + let bs_update = match events_8[0] { Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => { assert!(*announcement == *msg); update_msg diff --git a/src/ln/peer_handler.rs b/src/ln/peer_handler.rs index 812bade68..2472518d6 100644 --- a/src/ln/peer_handler.rs +++ b/src/ln/peer_handler.rs @@ -614,6 +614,14 @@ impl PeerManager { //TODO: Handle upstream in some confused form so that upstream just knows //to call us somehow? }, + Event::SendOpenChannel { ref node_id, ref msg } => { + let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, { + //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); + continue; + }, Event::SendFundingCreated { ref node_id, ref msg } => { let (mut descriptor, peer) = get_peer_for_forwarding!(node_id, { //TODO: generate a DiscardFunding event indicating to the wallet that diff --git a/src/util/events.rs b/src/util/events.rs index 1608d0873..0c3332f99 100644 --- a/src/util/events.rs +++ b/src/util/events.rs @@ -54,6 +54,12 @@ pub enum Event { PendingHTLCsForwardable { time_forwardable: Instant, }, + /// Used to indicate that we've initialted a channel open and should send the open_channel + /// message provided to the given peer + SendOpenChannel { + node_id: PublicKey, + msg: msgs::OpenChannel, + }, /// Used to indicate that a funding_created message should be sent to the peer with the given node_id. SendFundingCreated { node_id: PublicKey,