1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level network map tracking logic lives here.
12 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
13 use bitcoin::secp256k1::key::PublicKey;
14 use bitcoin::secp256k1::Secp256k1;
15 use bitcoin::secp256k1;
17 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
18 use bitcoin::hashes::Hash;
19 use bitcoin::blockdata::script::Builder;
20 use bitcoin::blockdata::transaction::TxOut;
21 use bitcoin::blockdata::opcodes;
22 use bitcoin::hash_types::BlockHash;
26 use ln::features::{ChannelFeatures, NodeFeatures};
27 use ln::msgs::{DecodeError, ErrorAction, Init, LightningError, RoutingMessageHandler, NetAddress, MAX_VALUE_MSAT};
28 use ln::msgs::{ChannelAnnouncement, ChannelUpdate, NodeAnnouncement, OptionalField};
29 use ln::msgs::{QueryChannelRange, ReplyChannelRange, QueryShortChannelIds, ReplyShortChannelIdsEnd};
31 use util::ser::{Writeable, Readable, Writer};
32 use util::logger::{Logger, Level};
33 use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
34 use util::scid_utils::{block_from_scid, scid_from_parts, MAX_SCID_BLOCK};
38 use alloc::collections::{BTreeMap, btree_map::Entry as BtreeEntry};
40 use sync::{RwLock, RwLockReadGuard};
41 use core::sync::atomic::{AtomicUsize, Ordering};
44 use bitcoin::hashes::hex::ToHex;
46 /// The maximum number of extra bytes which we do not understand in a gossip message before we will
47 /// refuse to relay the message.
48 const MAX_EXCESS_BYTES_FOR_RELAY: usize = 1024;
50 /// Maximum number of short_channel_ids that will be encoded in one gossip reply message.
51 /// This value ensures a reply fits within the 65k payload limit and is consistent with other implementations.
52 const MAX_SCIDS_PER_REPLY: usize = 8000;
54 /// Represents the compressed public key of a node
55 #[derive(Clone, Copy)]
56 pub struct NodeId([u8; PUBLIC_KEY_SIZE]);
59 /// Create a new NodeId from a public key
60 pub fn from_pubkey(pubkey: &PublicKey) -> Self {
61 NodeId(pubkey.serialize())
64 /// Get the public key slice from this NodeId
65 pub fn as_slice(&self) -> &[u8] {
70 impl fmt::Debug for NodeId {
71 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
72 write!(f, "NodeId({})", log_bytes!(self.0))
76 impl core::hash::Hash for NodeId {
77 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
84 impl PartialEq for NodeId {
85 fn eq(&self, other: &Self) -> bool {
86 self.0[..] == other.0[..]
90 impl cmp::PartialOrd for NodeId {
91 fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
97 fn cmp(&self, other: &Self) -> cmp::Ordering {
98 self.0[..].cmp(&other.0[..])
102 impl Writeable for NodeId {
103 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
104 writer.write_all(&self.0)?;
109 impl Readable for NodeId {
110 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
111 let mut buf = [0; PUBLIC_KEY_SIZE];
112 reader.read_exact(&mut buf)?;
117 /// Represents the network as nodes and channels between them
118 pub struct NetworkGraph {
119 genesis_hash: BlockHash,
120 // Lock order: channels -> nodes
121 channels: RwLock<BTreeMap<u64, ChannelInfo>>,
122 nodes: RwLock<BTreeMap<NodeId, NodeInfo>>,
125 impl Clone for NetworkGraph {
126 fn clone(&self) -> Self {
127 let channels = self.channels.read().unwrap();
128 let nodes = self.nodes.read().unwrap();
130 genesis_hash: self.genesis_hash.clone(),
131 channels: RwLock::new(channels.clone()),
132 nodes: RwLock::new(nodes.clone()),
137 /// A read-only view of [`NetworkGraph`].
138 pub struct ReadOnlyNetworkGraph<'a> {
139 channels: RwLockReadGuard<'a, BTreeMap<u64, ChannelInfo>>,
140 nodes: RwLockReadGuard<'a, BTreeMap<NodeId, NodeInfo>>,
143 /// Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
144 /// return packet by a node along the route. See [BOLT #4] for details.
146 /// [BOLT #4]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
147 #[derive(Clone, Debug, PartialEq)]
148 pub enum NetworkUpdate {
149 /// An error indicating a `channel_update` messages should be applied via
150 /// [`NetworkGraph::update_channel`].
151 ChannelUpdateMessage {
152 /// The update to apply via [`NetworkGraph::update_channel`].
155 /// An error indicating only that a channel has been closed, which should be applied via
156 /// [`NetworkGraph::close_channel_from_update`].
158 /// The short channel id of the closed channel.
159 short_channel_id: u64,
160 /// Whether the channel should be permanently removed or temporarily disabled until a new
161 /// `channel_update` message is received.
164 /// An error indicating only that a node has failed, which should be applied via
165 /// [`NetworkGraph::fail_node`].
167 /// The node id of the failed node.
169 /// Whether the node should be permanently removed from consideration or can be restored
170 /// when a new `channel_update` message is received.
175 impl_writeable_tlv_based_enum_upgradable!(NetworkUpdate,
176 (0, ChannelUpdateMessage) => {
179 (2, ChannelClosed) => {
180 (0, short_channel_id, required),
181 (2, is_permanent, required),
183 (4, NodeFailure) => {
184 (0, node_id, required),
185 (2, is_permanent, required),
189 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> EventHandler for NetGraphMsgHandler<G, C, L>
190 where C::Target: chain::Access, L::Target: Logger {
191 fn handle_event(&self, event: &Event) {
192 if let Event::PaymentPathFailed { payment_hash: _, rejected_by_dest: _, network_update, .. } = event {
193 if let Some(network_update) = network_update {
194 self.handle_network_update(network_update);
200 /// Receives and validates network updates from peers,
201 /// stores authentic and relevant data as a network graph.
202 /// This network graph is then used for routing payments.
203 /// Provides interface to help with initial routing sync by
204 /// serving historical announcements.
206 /// Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
207 /// [`NetworkGraph`].
208 pub struct NetGraphMsgHandler<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref>
209 where C::Target: chain::Access, L::Target: Logger
211 secp_ctx: Secp256k1<secp256k1::VerifyOnly>,
213 chain_access: Option<C>,
214 full_syncs_requested: AtomicUsize,
215 pending_events: Mutex<Vec<MessageSendEvent>>,
219 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> NetGraphMsgHandler<G, C, L>
220 where C::Target: chain::Access, L::Target: Logger
222 /// Creates a new tracker of the actual state of the network of channels and nodes,
223 /// assuming an existing Network Graph.
224 /// Chain monitor is used to make sure announced channels exist on-chain,
225 /// channel data is correct, and that the announcement is signed with
226 /// channel owners' keys.
227 pub fn new(network_graph: G, chain_access: Option<C>, logger: L) -> Self {
229 secp_ctx: Secp256k1::verification_only(),
231 full_syncs_requested: AtomicUsize::new(0),
233 pending_events: Mutex::new(vec![]),
238 /// Adds a provider used to check new announcements. Does not affect
239 /// existing announcements unless they are updated.
240 /// Add, update or remove the provider would replace the current one.
241 pub fn add_chain_access(&mut self, chain_access: Option<C>) {
242 self.chain_access = chain_access;
245 /// Returns true when a full routing table sync should be performed with a peer.
246 fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
247 //TODO: Determine whether to request a full sync based on the network map.
248 const FULL_SYNCS_TO_REQUEST: usize = 5;
249 if self.full_syncs_requested.load(Ordering::Acquire) < FULL_SYNCS_TO_REQUEST {
250 self.full_syncs_requested.fetch_add(1, Ordering::AcqRel);
257 /// Applies changes to the [`NetworkGraph`] from the given update.
258 fn handle_network_update(&self, update: &NetworkUpdate) {
260 NetworkUpdate::ChannelUpdateMessage { ref msg } => {
261 let short_channel_id = msg.contents.short_channel_id;
262 let is_enabled = msg.contents.flags & (1 << 1) != (1 << 1);
263 let status = if is_enabled { "enabled" } else { "disabled" };
264 log_debug!(self.logger, "Updating channel with channel_update from a payment failure. Channel {} is {}.", short_channel_id, status);
265 let _ = self.network_graph.update_channel(msg, &self.secp_ctx);
267 NetworkUpdate::ChannelClosed { short_channel_id, is_permanent } => {
268 let action = if is_permanent { "Removing" } else { "Disabling" };
269 log_debug!(self.logger, "{} channel graph entry for {} due to a payment failure.", action, short_channel_id);
270 self.network_graph.close_channel_from_update(short_channel_id, is_permanent);
272 NetworkUpdate::NodeFailure { ref node_id, is_permanent } => {
273 let action = if is_permanent { "Removing" } else { "Disabling" };
274 log_debug!(self.logger, "{} node graph entry for {} due to a payment failure.", action, node_id);
275 self.network_graph.fail_node(node_id, is_permanent);
281 macro_rules! secp_verify_sig {
282 ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr ) => {
283 match $secp_ctx.verify($msg, $sig, $pubkey) {
285 Err(_) => return Err(LightningError{err: "Invalid signature from remote node".to_owned(), action: ErrorAction::IgnoreError}),
290 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> RoutingMessageHandler for NetGraphMsgHandler<G, C, L>
291 where C::Target: chain::Access, L::Target: Logger
293 fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
294 self.network_graph.update_node_from_announcement(msg, &self.secp_ctx)?;
295 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
296 msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
297 msg.contents.excess_data.len() + msg.contents.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
300 fn handle_channel_announcement(&self, msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
301 self.network_graph.update_channel_from_announcement(msg, &self.chain_access, &self.secp_ctx)?;
302 log_gossip!(self.logger, "Added channel_announcement for {}{}", msg.contents.short_channel_id, if !msg.contents.excess_data.is_empty() { " with excess uninterpreted data!" } else { "" });
303 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
306 fn handle_channel_update(&self, msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
307 self.network_graph.update_channel(msg, &self.secp_ctx)?;
308 Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY)
311 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)> {
312 let mut result = Vec::with_capacity(batch_amount as usize);
313 let channels = self.network_graph.channels.read().unwrap();
314 let mut iter = channels.range(starting_point..);
315 while result.len() < batch_amount as usize {
316 if let Some((_, ref chan)) = iter.next() {
317 if chan.announcement_message.is_some() {
318 let chan_announcement = chan.announcement_message.clone().unwrap();
319 let mut one_to_two_announcement: Option<msgs::ChannelUpdate> = None;
320 let mut two_to_one_announcement: Option<msgs::ChannelUpdate> = None;
321 if let Some(one_to_two) = chan.one_to_two.as_ref() {
322 one_to_two_announcement = one_to_two.last_update_message.clone();
324 if let Some(two_to_one) = chan.two_to_one.as_ref() {
325 two_to_one_announcement = two_to_one.last_update_message.clone();
327 result.push((chan_announcement, one_to_two_announcement, two_to_one_announcement));
329 // TODO: We may end up sending un-announced channel_updates if we are sending
330 // initial sync data while receiving announce/updates for this channel.
339 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement> {
340 let mut result = Vec::with_capacity(batch_amount as usize);
341 let nodes = self.network_graph.nodes.read().unwrap();
342 let mut iter = if let Some(pubkey) = starting_point {
343 let mut iter = nodes.range(NodeId::from_pubkey(pubkey)..);
347 nodes.range::<NodeId, _>(..)
349 while result.len() < batch_amount as usize {
350 if let Some((_, ref node)) = iter.next() {
351 if let Some(node_info) = node.announcement_info.as_ref() {
352 if node_info.announcement_message.is_some() {
353 result.push(node_info.announcement_message.clone().unwrap());
363 /// Initiates a stateless sync of routing gossip information with a peer
364 /// using gossip_queries. The default strategy used by this implementation
365 /// is to sync the full block range with several peers.
367 /// We should expect one or more reply_channel_range messages in response
368 /// to our query_channel_range. Each reply will enqueue a query_scid message
369 /// to request gossip messages for each channel. The sync is considered complete
370 /// when the final reply_scids_end message is received, though we are not
371 /// tracking this directly.
372 fn sync_routing_table(&self, their_node_id: &PublicKey, init_msg: &Init) {
374 // We will only perform a sync with peers that support gossip_queries.
375 if !init_msg.features.supports_gossip_queries() {
379 // Check if we need to perform a full synchronization with this peer
380 if !self.should_request_full_sync(&their_node_id) {
384 let first_blocknum = 0;
385 let number_of_blocks = 0xffffffff;
386 log_debug!(self.logger, "Sending query_channel_range peer={}, first_blocknum={}, number_of_blocks={}", log_pubkey!(their_node_id), first_blocknum, number_of_blocks);
387 let mut pending_events = self.pending_events.lock().unwrap();
388 pending_events.push(MessageSendEvent::SendChannelRangeQuery {
389 node_id: their_node_id.clone(),
390 msg: QueryChannelRange {
391 chain_hash: self.network_graph.genesis_hash,
398 /// Statelessly processes a reply to a channel range query by immediately
399 /// sending an SCID query with SCIDs in the reply. To keep this handler
400 /// stateless, it does not validate the sequencing of replies for multi-
401 /// reply ranges. It does not validate whether the reply(ies) cover the
402 /// queried range. It also does not filter SCIDs to only those in the
403 /// original query range. We also do not validate that the chain_hash
404 /// matches the chain_hash of the NetworkGraph. Any chan_ann message that
405 /// does not match our chain_hash will be rejected when the announcement is
407 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError> {
408 log_debug!(self.logger, "Handling reply_channel_range peer={}, first_blocknum={}, number_of_blocks={}, sync_complete={}, scids={}", log_pubkey!(their_node_id), msg.first_blocknum, msg.number_of_blocks, msg.sync_complete, msg.short_channel_ids.len(),);
410 log_debug!(self.logger, "Sending query_short_channel_ids peer={}, batch_size={}", log_pubkey!(their_node_id), msg.short_channel_ids.len());
411 let mut pending_events = self.pending_events.lock().unwrap();
412 pending_events.push(MessageSendEvent::SendShortIdsQuery {
413 node_id: their_node_id.clone(),
414 msg: QueryShortChannelIds {
415 chain_hash: msg.chain_hash,
416 short_channel_ids: msg.short_channel_ids,
423 /// When an SCID query is initiated the remote peer will begin streaming
424 /// gossip messages. In the event of a failure, we may have received
425 /// some channel information. Before trying with another peer, the
426 /// caller should update its set of SCIDs that need to be queried.
427 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError> {
428 log_debug!(self.logger, "Handling reply_short_channel_ids_end peer={}, full_information={}", log_pubkey!(their_node_id), msg.full_information);
430 // If the remote node does not have up-to-date information for the
431 // chain_hash they will set full_information=false. We can fail
432 // the result and try again with a different peer.
433 if !msg.full_information {
434 return Err(LightningError {
435 err: String::from("Received reply_short_channel_ids_end with no information"),
436 action: ErrorAction::IgnoreError
443 /// Processes a query from a peer by finding announced/public channels whose funding UTXOs
444 /// are in the specified block range. Due to message size limits, large range
445 /// queries may result in several reply messages. This implementation enqueues
446 /// all reply messages into pending events. Each message will allocate just under 65KiB. A full
447 /// sync of the public routing table with 128k channels will generated 16 messages and allocate ~1MB.
448 /// Logic can be changed to reduce allocation if/when a full sync of the routing table impacts
449 /// memory constrained systems.
450 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError> {
451 log_debug!(self.logger, "Handling query_channel_range peer={}, first_blocknum={}, number_of_blocks={}", log_pubkey!(their_node_id), msg.first_blocknum, msg.number_of_blocks);
453 let inclusive_start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0);
455 // We might receive valid queries with end_blocknum that would overflow SCID conversion.
456 // If so, we manually cap the ending block to avoid this overflow.
457 let exclusive_end_scid = scid_from_parts(cmp::min(msg.end_blocknum() as u64, MAX_SCID_BLOCK), 0, 0);
459 // Per spec, we must reply to a query. Send an empty message when things are invalid.
460 if msg.chain_hash != self.network_graph.genesis_hash || inclusive_start_scid.is_err() || exclusive_end_scid.is_err() || msg.number_of_blocks == 0 {
461 let mut pending_events = self.pending_events.lock().unwrap();
462 pending_events.push(MessageSendEvent::SendReplyChannelRange {
463 node_id: their_node_id.clone(),
464 msg: ReplyChannelRange {
465 chain_hash: msg.chain_hash.clone(),
466 first_blocknum: msg.first_blocknum,
467 number_of_blocks: msg.number_of_blocks,
469 short_channel_ids: vec![],
472 return Err(LightningError {
473 err: String::from("query_channel_range could not be processed"),
474 action: ErrorAction::IgnoreError,
478 // Creates channel batches. We are not checking if the channel is routable
479 // (has at least one update). A peer may still want to know the channel
480 // exists even if its not yet routable.
481 let mut batches: Vec<Vec<u64>> = vec![Vec::with_capacity(MAX_SCIDS_PER_REPLY)];
482 let channels = self.network_graph.channels.read().unwrap();
483 for (_, ref chan) in channels.range(inclusive_start_scid.unwrap()..exclusive_end_scid.unwrap()) {
484 if let Some(chan_announcement) = &chan.announcement_message {
485 // Construct a new batch if last one is full
486 if batches.last().unwrap().len() == batches.last().unwrap().capacity() {
487 batches.push(Vec::with_capacity(MAX_SCIDS_PER_REPLY));
490 let batch = batches.last_mut().unwrap();
491 batch.push(chan_announcement.contents.short_channel_id);
496 let mut pending_events = self.pending_events.lock().unwrap();
497 let batch_count = batches.len();
498 let mut prev_batch_endblock = msg.first_blocknum;
499 for (batch_index, batch) in batches.into_iter().enumerate() {
500 // Per spec, the initial `first_blocknum` needs to be <= the query's `first_blocknum`
501 // and subsequent `first_blocknum`s must be >= the prior reply's `first_blocknum`.
503 // Additionally, c-lightning versions < 0.10 require that the `first_blocknum` of each
504 // reply is >= the previous reply's `first_blocknum` and either exactly the previous
505 // reply's `first_blocknum + number_of_blocks` or exactly one greater. This is a
506 // significant diversion from the requirements set by the spec, and, in case of blocks
507 // with no channel opens (e.g. empty blocks), requires that we use the previous value
508 // and *not* derive the first_blocknum from the actual first block of the reply.
509 let first_blocknum = prev_batch_endblock;
511 // Each message carries the number of blocks (from the `first_blocknum`) its contents
512 // fit in. Though there is no requirement that we use exactly the number of blocks its
513 // contents are from, except for the bogus requirements c-lightning enforces, above.
515 // Per spec, the last end block (ie `first_blocknum + number_of_blocks`) needs to be
516 // >= the query's end block. Thus, for the last reply, we calculate the difference
517 // between the query's end block and the start of the reply.
519 // Overflow safe since end_blocknum=msg.first_block_num+msg.number_of_blocks and
520 // first_blocknum will be either msg.first_blocknum or a higher block height.
521 let (sync_complete, number_of_blocks) = if batch_index == batch_count-1 {
522 (true, msg.end_blocknum() - first_blocknum)
524 // Prior replies should use the number of blocks that fit into the reply. Overflow
525 // safe since first_blocknum is always <= last SCID's block.
527 (false, block_from_scid(batch.last().unwrap()) - first_blocknum)
530 prev_batch_endblock = first_blocknum + number_of_blocks;
532 pending_events.push(MessageSendEvent::SendReplyChannelRange {
533 node_id: their_node_id.clone(),
534 msg: ReplyChannelRange {
535 chain_hash: msg.chain_hash.clone(),
539 short_channel_ids: batch,
547 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: QueryShortChannelIds) -> Result<(), LightningError> {
550 err: String::from("Not implemented"),
551 action: ErrorAction::IgnoreError,
556 impl<G: Deref<Target=NetworkGraph>, C: Deref, L: Deref> MessageSendEventsProvider for NetGraphMsgHandler<G, C, L>
558 C::Target: chain::Access,
561 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
562 let mut ret = Vec::new();
563 let mut pending_events = self.pending_events.lock().unwrap();
564 core::mem::swap(&mut ret, &mut pending_events);
569 #[derive(Clone, Debug, PartialEq)]
570 /// Details about one direction of a channel. Received
571 /// within a channel update.
572 pub struct DirectionalChannelInfo {
573 /// When the last update to the channel direction was issued.
574 /// Value is opaque, as set in the announcement.
575 pub last_update: u32,
576 /// Whether the channel can be currently used for payments (in this one direction).
578 /// The difference in CLTV values that you must have when routing through this channel.
579 pub cltv_expiry_delta: u16,
580 /// The minimum value, which must be relayed to the next hop via the channel
581 pub htlc_minimum_msat: u64,
582 /// The maximum value which may be relayed to the next hop via the channel.
583 pub htlc_maximum_msat: Option<u64>,
584 /// Fees charged when the channel is used for routing
585 pub fees: RoutingFees,
586 /// Most recent update for the channel received from the network
587 /// Mostly redundant with the data we store in fields explicitly.
588 /// Everything else is useful only for sending out for initial routing sync.
589 /// Not stored if contains excess data to prevent DoS.
590 pub last_update_message: Option<ChannelUpdate>,
593 impl fmt::Display for DirectionalChannelInfo {
594 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
595 write!(f, "last_update {}, enabled {}, cltv_expiry_delta {}, htlc_minimum_msat {}, fees {:?}", self.last_update, self.enabled, self.cltv_expiry_delta, self.htlc_minimum_msat, self.fees)?;
600 impl_writeable_tlv_based!(DirectionalChannelInfo, {
601 (0, last_update, required),
602 (2, enabled, required),
603 (4, cltv_expiry_delta, required),
604 (6, htlc_minimum_msat, required),
605 (8, htlc_maximum_msat, required),
606 (10, fees, required),
607 (12, last_update_message, required),
610 #[derive(Clone, Debug, PartialEq)]
611 /// Details about a channel (both directions).
612 /// Received within a channel announcement.
613 pub struct ChannelInfo {
614 /// Protocol features of a channel communicated during its announcement
615 pub features: ChannelFeatures,
616 /// Source node of the first direction of a channel
617 pub node_one: NodeId,
618 /// Details about the first direction of a channel
619 pub one_to_two: Option<DirectionalChannelInfo>,
620 /// Source node of the second direction of a channel
621 pub node_two: NodeId,
622 /// Details about the second direction of a channel
623 pub two_to_one: Option<DirectionalChannelInfo>,
624 /// The channel capacity as seen on-chain, if chain lookup is available.
625 pub capacity_sats: Option<u64>,
626 /// An initial announcement of the channel
627 /// Mostly redundant with the data we store in fields explicitly.
628 /// Everything else is useful only for sending out for initial routing sync.
629 /// Not stored if contains excess data to prevent DoS.
630 pub announcement_message: Option<ChannelAnnouncement>,
633 impl fmt::Display for ChannelInfo {
634 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
635 write!(f, "features: {}, node_one: {}, one_to_two: {:?}, node_two: {}, two_to_one: {:?}",
636 log_bytes!(self.features.encode()), log_bytes!(self.node_one.as_slice()), self.one_to_two, log_bytes!(self.node_two.as_slice()), self.two_to_one)?;
641 impl_writeable_tlv_based!(ChannelInfo, {
642 (0, features, required),
643 (2, node_one, required),
644 (4, one_to_two, required),
645 (6, node_two, required),
646 (8, two_to_one, required),
647 (10, capacity_sats, required),
648 (12, announcement_message, required),
652 /// Fees for routing via a given channel or a node
653 #[derive(Eq, PartialEq, Copy, Clone, Debug, Hash)]
654 pub struct RoutingFees {
655 /// Flat routing fee in satoshis
657 /// Liquidity-based routing fee in millionths of a routed amount.
658 /// In other words, 10000 is 1%.
659 pub proportional_millionths: u32,
662 impl_writeable_tlv_based!(RoutingFees, {
663 (0, base_msat, required),
664 (2, proportional_millionths, required)
667 #[derive(Clone, Debug, PartialEq)]
668 /// Information received in the latest node_announcement from this node.
669 pub struct NodeAnnouncementInfo {
670 /// Protocol features the node announced support for
671 pub features: NodeFeatures,
672 /// When the last known update to the node state was issued.
673 /// Value is opaque, as set in the announcement.
674 pub last_update: u32,
675 /// Color assigned to the node
677 /// Moniker assigned to the node.
678 /// May be invalid or malicious (eg control chars),
679 /// should not be exposed to the user.
681 /// Internet-level addresses via which one can connect to the node
682 pub addresses: Vec<NetAddress>,
683 /// An initial announcement of the node
684 /// Mostly redundant with the data we store in fields explicitly.
685 /// Everything else is useful only for sending out for initial routing sync.
686 /// Not stored if contains excess data to prevent DoS.
687 pub announcement_message: Option<NodeAnnouncement>
690 impl_writeable_tlv_based!(NodeAnnouncementInfo, {
691 (0, features, required),
692 (2, last_update, required),
694 (6, alias, required),
695 (8, announcement_message, option),
696 (10, addresses, vec_type),
699 #[derive(Clone, Debug, PartialEq)]
700 /// Details about a node in the network, known from the network announcement.
701 pub struct NodeInfo {
702 /// All valid channels a node has announced
703 pub channels: Vec<u64>,
704 /// Lowest fees enabling routing via any of the enabled, known channels to a node.
705 /// The two fields (flat and proportional fee) are independent,
706 /// meaning they don't have to refer to the same channel.
707 pub lowest_inbound_channel_fees: Option<RoutingFees>,
708 /// More information about a node from node_announcement.
709 /// Optional because we store a Node entry after learning about it from
710 /// a channel announcement, but before receiving a node announcement.
711 pub announcement_info: Option<NodeAnnouncementInfo>
714 impl fmt::Display for NodeInfo {
715 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
716 write!(f, "lowest_inbound_channel_fees: {:?}, channels: {:?}, announcement_info: {:?}",
717 self.lowest_inbound_channel_fees, &self.channels[..], self.announcement_info)?;
722 impl_writeable_tlv_based!(NodeInfo, {
723 (0, lowest_inbound_channel_fees, option),
724 (2, announcement_info, option),
725 (4, channels, vec_type),
728 const SERIALIZATION_VERSION: u8 = 1;
729 const MIN_SERIALIZATION_VERSION: u8 = 1;
731 impl Writeable for NetworkGraph {
732 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
733 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
735 self.genesis_hash.write(writer)?;
736 let channels = self.channels.read().unwrap();
737 (channels.len() as u64).write(writer)?;
738 for (ref chan_id, ref chan_info) in channels.iter() {
739 (*chan_id).write(writer)?;
740 chan_info.write(writer)?;
742 let nodes = self.nodes.read().unwrap();
743 (nodes.len() as u64).write(writer)?;
744 for (ref node_id, ref node_info) in nodes.iter() {
745 node_id.write(writer)?;
746 node_info.write(writer)?;
749 write_tlv_fields!(writer, {});
754 impl Readable for NetworkGraph {
755 fn read<R: io::Read>(reader: &mut R) -> Result<NetworkGraph, DecodeError> {
756 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
758 let genesis_hash: BlockHash = Readable::read(reader)?;
759 let channels_count: u64 = Readable::read(reader)?;
760 let mut channels = BTreeMap::new();
761 for _ in 0..channels_count {
762 let chan_id: u64 = Readable::read(reader)?;
763 let chan_info = Readable::read(reader)?;
764 channels.insert(chan_id, chan_info);
766 let nodes_count: u64 = Readable::read(reader)?;
767 let mut nodes = BTreeMap::new();
768 for _ in 0..nodes_count {
769 let node_id = Readable::read(reader)?;
770 let node_info = Readable::read(reader)?;
771 nodes.insert(node_id, node_info);
773 read_tlv_fields!(reader, {});
777 channels: RwLock::new(channels),
778 nodes: RwLock::new(nodes),
783 impl fmt::Display for NetworkGraph {
784 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
785 writeln!(f, "Network map\n[Channels]")?;
786 for (key, val) in self.channels.read().unwrap().iter() {
787 writeln!(f, " {}: {}", key, val)?;
789 writeln!(f, "[Nodes]")?;
790 for (&node_id, val) in self.nodes.read().unwrap().iter() {
791 writeln!(f, " {}: {}", log_bytes!(node_id.as_slice()), val)?;
797 impl PartialEq for NetworkGraph {
798 fn eq(&self, other: &Self) -> bool {
799 self.genesis_hash == other.genesis_hash &&
800 *self.channels.read().unwrap() == *other.channels.read().unwrap() &&
801 *self.nodes.read().unwrap() == *other.nodes.read().unwrap()
806 /// Creates a new, empty, network graph.
807 pub fn new(genesis_hash: BlockHash) -> NetworkGraph {
810 channels: RwLock::new(BTreeMap::new()),
811 nodes: RwLock::new(BTreeMap::new()),
815 /// Returns a read-only view of the network graph.
816 pub fn read_only(&'_ self) -> ReadOnlyNetworkGraph<'_> {
817 let channels = self.channels.read().unwrap();
818 let nodes = self.nodes.read().unwrap();
819 ReadOnlyNetworkGraph {
825 /// For an already known node (from channel announcements), update its stored properties from a
826 /// given node announcement.
828 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
829 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
830 /// routing messages from a source using a protocol other than the lightning P2P protocol.
831 pub fn update_node_from_announcement<T: secp256k1::Verification>(&self, msg: &msgs::NodeAnnouncement, secp_ctx: &Secp256k1<T>) -> Result<(), LightningError> {
832 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
833 secp_verify_sig!(secp_ctx, &msg_hash, &msg.signature, &msg.contents.node_id);
834 self.update_node_from_announcement_intern(&msg.contents, Some(&msg))
837 /// For an already known node (from channel announcements), update its stored properties from a
838 /// given node announcement without verifying the associated signatures. Because we aren't
839 /// given the associated signatures here we cannot relay the node announcement to any of our
841 pub fn update_node_from_unsigned_announcement(&self, msg: &msgs::UnsignedNodeAnnouncement) -> Result<(), LightningError> {
842 self.update_node_from_announcement_intern(msg, None)
845 fn update_node_from_announcement_intern(&self, msg: &msgs::UnsignedNodeAnnouncement, full_msg: Option<&msgs::NodeAnnouncement>) -> Result<(), LightningError> {
846 match self.nodes.write().unwrap().get_mut(&NodeId::from_pubkey(&msg.node_id)) {
847 None => Err(LightningError{err: "No existing channels for node_announcement".to_owned(), action: ErrorAction::IgnoreError}),
849 if let Some(node_info) = node.announcement_info.as_ref() {
850 if node_info.last_update >= msg.timestamp {
851 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
856 msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
857 msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY &&
858 msg.excess_data.len() + msg.excess_address_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY;
859 node.announcement_info = Some(NodeAnnouncementInfo {
860 features: msg.features.clone(),
861 last_update: msg.timestamp,
864 addresses: msg.addresses.clone(),
865 announcement_message: if should_relay { full_msg.cloned() } else { None },
873 /// Store or update channel info from a channel announcement.
875 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
876 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
877 /// routing messages from a source using a protocol other than the lightning P2P protocol.
879 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
880 /// the corresponding UTXO exists on chain and is correctly-formatted.
881 pub fn update_channel_from_announcement<T: secp256k1::Verification, C: Deref>(
882 &self, msg: &msgs::ChannelAnnouncement, chain_access: &Option<C>, secp_ctx: &Secp256k1<T>
883 ) -> Result<(), LightningError>
885 C::Target: chain::Access,
887 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.contents.encode()[..])[..]);
888 secp_verify_sig!(secp_ctx, &msg_hash, &msg.node_signature_1, &msg.contents.node_id_1);
889 secp_verify_sig!(secp_ctx, &msg_hash, &msg.node_signature_2, &msg.contents.node_id_2);
890 secp_verify_sig!(secp_ctx, &msg_hash, &msg.bitcoin_signature_1, &msg.contents.bitcoin_key_1);
891 secp_verify_sig!(secp_ctx, &msg_hash, &msg.bitcoin_signature_2, &msg.contents.bitcoin_key_2);
892 self.update_channel_from_unsigned_announcement_intern(&msg.contents, Some(msg), chain_access)
895 /// Store or update channel info from a channel announcement without verifying the associated
896 /// signatures. Because we aren't given the associated signatures here we cannot relay the
897 /// channel announcement to any of our peers.
899 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
900 /// the corresponding UTXO exists on chain and is correctly-formatted.
901 pub fn update_channel_from_unsigned_announcement<C: Deref>(
902 &self, msg: &msgs::UnsignedChannelAnnouncement, chain_access: &Option<C>
903 ) -> Result<(), LightningError>
905 C::Target: chain::Access,
907 self.update_channel_from_unsigned_announcement_intern(msg, None, chain_access)
910 fn update_channel_from_unsigned_announcement_intern<C: Deref>(
911 &self, msg: &msgs::UnsignedChannelAnnouncement, full_msg: Option<&msgs::ChannelAnnouncement>, chain_access: &Option<C>
912 ) -> Result<(), LightningError>
914 C::Target: chain::Access,
916 if msg.node_id_1 == msg.node_id_2 || msg.bitcoin_key_1 == msg.bitcoin_key_2 {
917 return Err(LightningError{err: "Channel announcement node had a channel with itself".to_owned(), action: ErrorAction::IgnoreError});
920 let utxo_value = match &chain_access {
922 // Tentatively accept, potentially exposing us to DoS attacks
925 &Some(ref chain_access) => {
926 match chain_access.get_utxo(&msg.chain_hash, msg.short_channel_id) {
927 Ok(TxOut { value, script_pubkey }) => {
928 let expected_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
929 .push_slice(&msg.bitcoin_key_1.serialize())
930 .push_slice(&msg.bitcoin_key_2.serialize())
931 .push_opcode(opcodes::all::OP_PUSHNUM_2)
932 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
933 if script_pubkey != expected_script {
934 return Err(LightningError{err: format!("Channel announcement key ({}) didn't match on-chain script ({})", script_pubkey.to_hex(), expected_script.to_hex()), action: ErrorAction::IgnoreError});
936 //TODO: Check if value is worth storing, use it to inform routing, and compare it
937 //to the new HTLC max field in channel_update
940 Err(chain::AccessError::UnknownChain) => {
941 return Err(LightningError{err: format!("Channel announced on an unknown chain ({})", msg.chain_hash.encode().to_hex()), action: ErrorAction::IgnoreError});
943 Err(chain::AccessError::UnknownTx) => {
944 return Err(LightningError{err: "Channel announced without corresponding UTXO entry".to_owned(), action: ErrorAction::IgnoreError});
950 let chan_info = ChannelInfo {
951 features: msg.features.clone(),
952 node_one: NodeId::from_pubkey(&msg.node_id_1),
954 node_two: NodeId::from_pubkey(&msg.node_id_2),
956 capacity_sats: utxo_value,
957 announcement_message: if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
958 { full_msg.cloned() } else { None },
961 let mut channels = self.channels.write().unwrap();
962 let mut nodes = self.nodes.write().unwrap();
963 match channels.entry(msg.short_channel_id) {
964 BtreeEntry::Occupied(mut entry) => {
965 //TODO: because asking the blockchain if short_channel_id is valid is only optional
966 //in the blockchain API, we need to handle it smartly here, though it's unclear
968 if utxo_value.is_some() {
969 // Either our UTXO provider is busted, there was a reorg, or the UTXO provider
970 // only sometimes returns results. In any case remove the previous entry. Note
971 // that the spec expects us to "blacklist" the node_ids involved, but we can't
973 // a) we don't *require* a UTXO provider that always returns results.
974 // b) we don't track UTXOs of channels we know about and remove them if they
976 // c) it's unclear how to do so without exposing ourselves to massive DoS risk.
977 Self::remove_channel_in_nodes(&mut nodes, &entry.get(), msg.short_channel_id);
978 *entry.get_mut() = chan_info;
980 return Err(LightningError{err: "Already have knowledge of channel".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)})
983 BtreeEntry::Vacant(entry) => {
984 entry.insert(chan_info);
988 macro_rules! add_channel_to_node {
989 ( $node_id: expr ) => {
990 match nodes.entry($node_id) {
991 BtreeEntry::Occupied(node_entry) => {
992 node_entry.into_mut().channels.push(msg.short_channel_id);
994 BtreeEntry::Vacant(node_entry) => {
995 node_entry.insert(NodeInfo {
996 channels: vec!(msg.short_channel_id),
997 lowest_inbound_channel_fees: None,
998 announcement_info: None,
1005 add_channel_to_node!(NodeId::from_pubkey(&msg.node_id_1));
1006 add_channel_to_node!(NodeId::from_pubkey(&msg.node_id_2));
1011 /// Close a channel if a corresponding HTLC fail was sent.
1012 /// If permanent, removes a channel from the local storage.
1013 /// May cause the removal of nodes too, if this was their last channel.
1014 /// If not permanent, makes channels unavailable for routing.
1015 pub fn close_channel_from_update(&self, short_channel_id: u64, is_permanent: bool) {
1016 let mut channels = self.channels.write().unwrap();
1018 if let Some(chan) = channels.remove(&short_channel_id) {
1019 let mut nodes = self.nodes.write().unwrap();
1020 Self::remove_channel_in_nodes(&mut nodes, &chan, short_channel_id);
1023 if let Some(chan) = channels.get_mut(&short_channel_id) {
1024 if let Some(one_to_two) = chan.one_to_two.as_mut() {
1025 one_to_two.enabled = false;
1027 if let Some(two_to_one) = chan.two_to_one.as_mut() {
1028 two_to_one.enabled = false;
1034 /// Marks a node in the graph as failed.
1035 pub fn fail_node(&self, _node_id: &PublicKey, is_permanent: bool) {
1037 // TODO: Wholly remove the node
1039 // TODO: downgrade the node
1043 /// For an already known (from announcement) channel, update info about one of the directions
1046 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
1047 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1048 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1049 pub fn update_channel<T: secp256k1::Verification>(&self, msg: &msgs::ChannelUpdate, secp_ctx: &Secp256k1<T>) -> Result<(), LightningError> {
1050 self.update_channel_intern(&msg.contents, Some(&msg), Some((&msg.signature, secp_ctx)))
1053 /// For an already known (from announcement) channel, update info about one of the directions
1054 /// of the channel without verifying the associated signatures. Because we aren't given the
1055 /// associated signatures here we cannot relay the channel update to any of our peers.
1056 pub fn update_channel_unsigned(&self, msg: &msgs::UnsignedChannelUpdate) -> Result<(), LightningError> {
1057 self.update_channel_intern(msg, None, None::<(&secp256k1::Signature, &Secp256k1<secp256k1::VerifyOnly>)>)
1060 fn update_channel_intern<T: secp256k1::Verification>(&self, msg: &msgs::UnsignedChannelUpdate, full_msg: Option<&msgs::ChannelUpdate>, sig_info: Option<(&secp256k1::Signature, &Secp256k1<T>)>) -> Result<(), LightningError> {
1062 let chan_enabled = msg.flags & (1 << 1) != (1 << 1);
1063 let chan_was_enabled;
1065 let mut channels = self.channels.write().unwrap();
1066 match channels.get_mut(&msg.short_channel_id) {
1067 None => return Err(LightningError{err: "Couldn't find channel for update".to_owned(), action: ErrorAction::IgnoreError}),
1069 if let OptionalField::Present(htlc_maximum_msat) = msg.htlc_maximum_msat {
1070 if htlc_maximum_msat > MAX_VALUE_MSAT {
1071 return Err(LightningError{err: "htlc_maximum_msat is larger than maximum possible msats".to_owned(), action: ErrorAction::IgnoreError});
1074 if let Some(capacity_sats) = channel.capacity_sats {
1075 // It's possible channel capacity is available now, although it wasn't available at announcement (so the field is None).
1076 // Don't query UTXO set here to reduce DoS risks.
1077 if capacity_sats > MAX_VALUE_MSAT / 1000 || htlc_maximum_msat > capacity_sats * 1000 {
1078 return Err(LightningError{err: "htlc_maximum_msat is larger than channel capacity or capacity is bogus".to_owned(), action: ErrorAction::IgnoreError});
1082 macro_rules! maybe_update_channel_info {
1083 ( $target: expr, $src_node: expr) => {
1084 if let Some(existing_chan_info) = $target.as_ref() {
1085 if existing_chan_info.last_update >= msg.timestamp {
1086 return Err(LightningError{err: "Update older than last processed update".to_owned(), action: ErrorAction::IgnoreAndLog(Level::Gossip)});
1088 chan_was_enabled = existing_chan_info.enabled;
1090 chan_was_enabled = false;
1093 let last_update_message = if msg.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY
1094 { full_msg.cloned() } else { None };
1096 let updated_channel_dir_info = DirectionalChannelInfo {
1097 enabled: chan_enabled,
1098 last_update: msg.timestamp,
1099 cltv_expiry_delta: msg.cltv_expiry_delta,
1100 htlc_minimum_msat: msg.htlc_minimum_msat,
1101 htlc_maximum_msat: if let OptionalField::Present(max_value) = msg.htlc_maximum_msat { Some(max_value) } else { None },
1103 base_msat: msg.fee_base_msat,
1104 proportional_millionths: msg.fee_proportional_millionths,
1108 $target = Some(updated_channel_dir_info);
1112 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1113 if msg.flags & 1 == 1 {
1114 dest_node_id = channel.node_one.clone();
1115 if let Some((sig, ctx)) = sig_info {
1116 secp_verify_sig!(ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_two.as_slice()).map_err(|_| LightningError{
1117 err: "Couldn't parse source node pubkey".to_owned(),
1118 action: ErrorAction::IgnoreAndLog(Level::Debug)
1121 maybe_update_channel_info!(channel.two_to_one, channel.node_two);
1123 dest_node_id = channel.node_two.clone();
1124 if let Some((sig, ctx)) = sig_info {
1125 secp_verify_sig!(ctx, &msg_hash, &sig, &PublicKey::from_slice(channel.node_one.as_slice()).map_err(|_| LightningError{
1126 err: "Couldn't parse destination node pubkey".to_owned(),
1127 action: ErrorAction::IgnoreAndLog(Level::Debug)
1130 maybe_update_channel_info!(channel.one_to_two, channel.node_one);
1135 let mut nodes = self.nodes.write().unwrap();
1137 let node = nodes.get_mut(&dest_node_id).unwrap();
1138 let mut base_msat = msg.fee_base_msat;
1139 let mut proportional_millionths = msg.fee_proportional_millionths;
1140 if let Some(fees) = node.lowest_inbound_channel_fees {
1141 base_msat = cmp::min(base_msat, fees.base_msat);
1142 proportional_millionths = cmp::min(proportional_millionths, fees.proportional_millionths);
1144 node.lowest_inbound_channel_fees = Some(RoutingFees {
1146 proportional_millionths
1148 } else if chan_was_enabled {
1149 let node = nodes.get_mut(&dest_node_id).unwrap();
1150 let mut lowest_inbound_channel_fees = None;
1152 for chan_id in node.channels.iter() {
1153 let chan = channels.get(chan_id).unwrap();
1155 if chan.node_one == dest_node_id {
1156 chan_info_opt = chan.two_to_one.as_ref();
1158 chan_info_opt = chan.one_to_two.as_ref();
1160 if let Some(chan_info) = chan_info_opt {
1161 if chan_info.enabled {
1162 let fees = lowest_inbound_channel_fees.get_or_insert(RoutingFees {
1163 base_msat: u32::max_value(), proportional_millionths: u32::max_value() });
1164 fees.base_msat = cmp::min(fees.base_msat, chan_info.fees.base_msat);
1165 fees.proportional_millionths = cmp::min(fees.proportional_millionths, chan_info.fees.proportional_millionths);
1170 node.lowest_inbound_channel_fees = lowest_inbound_channel_fees;
1176 fn remove_channel_in_nodes(nodes: &mut BTreeMap<NodeId, NodeInfo>, chan: &ChannelInfo, short_channel_id: u64) {
1177 macro_rules! remove_from_node {
1178 ($node_id: expr) => {
1179 if let BtreeEntry::Occupied(mut entry) = nodes.entry($node_id) {
1180 entry.get_mut().channels.retain(|chan_id| {
1181 short_channel_id != *chan_id
1183 if entry.get().channels.is_empty() {
1184 entry.remove_entry();
1187 panic!("Had channel that pointed to unknown node (ie inconsistent network map)!");
1192 remove_from_node!(chan.node_one);
1193 remove_from_node!(chan.node_two);
1197 impl ReadOnlyNetworkGraph<'_> {
1198 /// Returns all known valid channels' short ids along with announced channel info.
1200 /// (C-not exported) because we have no mapping for `BTreeMap`s
1201 pub fn channels(&self) -> &BTreeMap<u64, ChannelInfo> {
1205 /// Returns all known nodes' public keys along with announced node info.
1207 /// (C-not exported) because we have no mapping for `BTreeMap`s
1208 pub fn nodes(&self) -> &BTreeMap<NodeId, NodeInfo> {
1212 /// Get network addresses by node id.
1213 /// Returns None if the requested node is completely unknown,
1214 /// or if node announcement for the node was never received.
1215 pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>> {
1216 if let Some(node) = self.nodes.get(&NodeId::from_pubkey(&pubkey)) {
1217 if let Some(node_info) = node.announcement_info.as_ref() {
1218 return Some(node_info.addresses.clone())
1228 use ln::PaymentHash;
1229 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
1230 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph, NetworkUpdate, MAX_EXCESS_BYTES_FOR_RELAY};
1231 use ln::msgs::{Init, OptionalField, RoutingMessageHandler, UnsignedNodeAnnouncement, NodeAnnouncement,
1232 UnsignedChannelAnnouncement, ChannelAnnouncement, UnsignedChannelUpdate, ChannelUpdate,
1233 ReplyChannelRange, ReplyShortChannelIdsEnd, QueryChannelRange, QueryShortChannelIds, MAX_VALUE_MSAT};
1234 use util::test_utils;
1235 use util::logger::Logger;
1236 use util::ser::{Readable, Writeable};
1237 use util::events::{Event, EventHandler, MessageSendEvent, MessageSendEventsProvider};
1238 use util::scid_utils::scid_from_parts;
1240 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
1241 use bitcoin::hashes::Hash;
1242 use bitcoin::network::constants::Network;
1243 use bitcoin::blockdata::constants::genesis_block;
1244 use bitcoin::blockdata::script::Builder;
1245 use bitcoin::blockdata::transaction::TxOut;
1246 use bitcoin::blockdata::opcodes;
1250 use bitcoin::secp256k1::key::{PublicKey, SecretKey};
1251 use bitcoin::secp256k1::{All, Secp256k1};
1257 fn create_network_graph() -> NetworkGraph {
1258 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1259 NetworkGraph::new(genesis_hash)
1262 fn create_net_graph_msg_handler(network_graph: &NetworkGraph) -> (
1263 Secp256k1<All>, NetGraphMsgHandler<&NetworkGraph, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>
1265 let secp_ctx = Secp256k1::new();
1266 let logger = Arc::new(test_utils::TestLogger::new());
1267 let net_graph_msg_handler = NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger));
1268 (secp_ctx, net_graph_msg_handler)
1272 fn request_full_sync_finite_times() {
1273 let network_graph = create_network_graph();
1274 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
1275 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()[..]).unwrap());
1277 assert!(net_graph_msg_handler.should_request_full_sync(&node_id));
1278 assert!(net_graph_msg_handler.should_request_full_sync(&node_id));
1279 assert!(net_graph_msg_handler.should_request_full_sync(&node_id));
1280 assert!(net_graph_msg_handler.should_request_full_sync(&node_id));
1281 assert!(net_graph_msg_handler.should_request_full_sync(&node_id));
1282 assert!(!net_graph_msg_handler.should_request_full_sync(&node_id));
1286 fn handling_node_announcements() {
1287 let network_graph = create_network_graph();
1288 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
1290 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1291 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1292 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1293 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1294 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1295 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1296 let zero_hash = Sha256dHash::hash(&[0; 32]);
1297 let first_announcement_time = 500;
1299 let mut unsigned_announcement = UnsignedNodeAnnouncement {
1300 features: NodeFeatures::known(),
1301 timestamp: first_announcement_time,
1305 addresses: Vec::new(),
1306 excess_address_data: Vec::new(),
1307 excess_data: Vec::new(),
1309 let mut msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1310 let valid_announcement = NodeAnnouncement {
1311 signature: secp_ctx.sign(&msghash, node_1_privkey),
1312 contents: unsigned_announcement.clone()
1315 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
1317 Err(e) => assert_eq!("No existing channels for node_announcement", e.err)
1321 // Announce a channel to add a corresponding node.
1322 let unsigned_announcement = UnsignedChannelAnnouncement {
1323 features: ChannelFeatures::known(),
1324 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1325 short_channel_id: 0,
1328 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1329 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1330 excess_data: Vec::new(),
1333 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1334 let valid_announcement = ChannelAnnouncement {
1335 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1336 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1337 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1338 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1339 contents: unsigned_announcement.clone(),
1341 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1342 Ok(res) => assert!(res),
1347 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
1348 Ok(res) => assert!(res),
1352 let fake_msghash = hash_to_message!(&zero_hash);
1353 match net_graph_msg_handler.handle_node_announcement(
1355 signature: secp_ctx.sign(&fake_msghash, node_1_privkey),
1356 contents: unsigned_announcement.clone()
1359 Err(e) => assert_eq!(e.err, "Invalid signature from remote node")
1362 unsigned_announcement.timestamp += 1000;
1363 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
1364 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1365 let announcement_with_data = NodeAnnouncement {
1366 signature: secp_ctx.sign(&msghash, node_1_privkey),
1367 contents: unsigned_announcement.clone()
1369 // Return false because contains excess data.
1370 match net_graph_msg_handler.handle_node_announcement(&announcement_with_data) {
1371 Ok(res) => assert!(!res),
1374 unsigned_announcement.excess_data = Vec::new();
1376 // Even though previous announcement was not relayed further, we still accepted it,
1377 // so we now won't accept announcements before the previous one.
1378 unsigned_announcement.timestamp -= 10;
1379 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1380 let outdated_announcement = NodeAnnouncement {
1381 signature: secp_ctx.sign(&msghash, node_1_privkey),
1382 contents: unsigned_announcement.clone()
1384 match net_graph_msg_handler.handle_node_announcement(&outdated_announcement) {
1386 Err(e) => assert_eq!(e.err, "Update older than last processed update")
1391 fn handling_channel_announcements() {
1392 let secp_ctx = Secp256k1::new();
1393 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1395 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1396 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1397 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1398 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1399 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1400 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1402 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1403 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_1_btckey).serialize())
1404 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_2_btckey).serialize())
1405 .push_opcode(opcodes::all::OP_PUSHNUM_2)
1406 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
1409 let mut unsigned_announcement = UnsignedChannelAnnouncement {
1410 features: ChannelFeatures::known(),
1411 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
1412 short_channel_id: 0,
1415 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1416 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1417 excess_data: Vec::new(),
1420 let mut msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1421 let valid_announcement = ChannelAnnouncement {
1422 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1423 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1424 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1425 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1426 contents: unsigned_announcement.clone(),
1429 // Test if the UTXO lookups were not supported
1430 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1431 let mut net_graph_msg_handler = NetGraphMsgHandler::new(&network_graph, None, Arc::clone(&logger));
1432 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1433 Ok(res) => assert!(res),
1438 match network_graph.read_only().channels().get(&unsigned_announcement.short_channel_id) {
1444 // If we receive announcement for the same channel (with UTXO lookups disabled),
1445 // drop new one on the floor, since we can't see any changes.
1446 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1448 Err(e) => assert_eq!(e.err, "Already have knowledge of channel")
1451 // Test if an associated transaction were not on-chain (or not confirmed).
1452 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1453 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
1454 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1455 net_graph_msg_handler = NetGraphMsgHandler::new(&network_graph, Some(chain_source.clone()), Arc::clone(&logger));
1456 unsigned_announcement.short_channel_id += 1;
1458 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1459 let valid_announcement = ChannelAnnouncement {
1460 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1461 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1462 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1463 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1464 contents: unsigned_announcement.clone(),
1467 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1469 Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
1472 // Now test if the transaction is found in the UTXO set and the script is correct.
1473 unsigned_announcement.short_channel_id += 1;
1474 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script.clone() });
1476 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1477 let valid_announcement = ChannelAnnouncement {
1478 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1479 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1480 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1481 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1482 contents: unsigned_announcement.clone(),
1484 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1485 Ok(res) => assert!(res),
1490 match network_graph.read_only().channels().get(&unsigned_announcement.short_channel_id) {
1496 // If we receive announcement for the same channel (but TX is not confirmed),
1497 // drop new one on the floor, since we can't see any changes.
1498 *chain_source.utxo_ret.lock().unwrap() = Err(chain::AccessError::UnknownTx);
1499 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1501 Err(e) => assert_eq!(e.err, "Channel announced without corresponding UTXO entry")
1504 // But if it is confirmed, replace the channel
1505 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: 0, script_pubkey: good_script });
1506 unsigned_announcement.features = ChannelFeatures::empty();
1507 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1508 let valid_announcement = ChannelAnnouncement {
1509 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1510 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1511 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1512 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1513 contents: unsigned_announcement.clone(),
1515 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1516 Ok(res) => assert!(res),
1520 match network_graph.read_only().channels().get(&unsigned_announcement.short_channel_id) {
1521 Some(channel_entry) => {
1522 assert_eq!(channel_entry.features, ChannelFeatures::empty());
1528 // Don't relay valid channels with excess data
1529 unsigned_announcement.short_channel_id += 1;
1530 unsigned_announcement.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
1531 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1532 let valid_announcement = ChannelAnnouncement {
1533 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1534 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1535 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1536 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1537 contents: unsigned_announcement.clone(),
1539 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
1540 Ok(res) => assert!(!res),
1544 unsigned_announcement.excess_data = Vec::new();
1545 let invalid_sig_announcement = ChannelAnnouncement {
1546 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1547 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1548 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1549 bitcoin_signature_2: secp_ctx.sign(&msghash, node_1_btckey),
1550 contents: unsigned_announcement.clone(),
1552 match net_graph_msg_handler.handle_channel_announcement(&invalid_sig_announcement) {
1554 Err(e) => assert_eq!(e.err, "Invalid signature from remote node")
1557 unsigned_announcement.node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1558 msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1559 let channel_to_itself_announcement = ChannelAnnouncement {
1560 node_signature_1: secp_ctx.sign(&msghash, node_2_privkey),
1561 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1562 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1563 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1564 contents: unsigned_announcement.clone(),
1566 match net_graph_msg_handler.handle_channel_announcement(&channel_to_itself_announcement) {
1568 Err(e) => assert_eq!(e.err, "Channel announcement node had a channel with itself")
1573 fn handling_channel_update() {
1574 let secp_ctx = Secp256k1::new();
1575 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
1576 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1577 let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
1578 let net_graph_msg_handler = NetGraphMsgHandler::new(&network_graph, Some(chain_source.clone()), Arc::clone(&logger));
1580 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1581 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1582 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1583 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1584 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1585 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1587 let zero_hash = Sha256dHash::hash(&[0; 32]);
1588 let short_channel_id = 0;
1589 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
1590 let amount_sats = 1000_000;
1593 // Announce a channel we will update
1594 let good_script = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2)
1595 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_1_btckey).serialize())
1596 .push_slice(&PublicKey::from_secret_key(&secp_ctx, node_2_btckey).serialize())
1597 .push_opcode(opcodes::all::OP_PUSHNUM_2)
1598 .push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script().to_v0_p2wsh();
1599 *chain_source.utxo_ret.lock().unwrap() = Ok(TxOut { value: amount_sats, script_pubkey: good_script.clone() });
1600 let unsigned_announcement = UnsignedChannelAnnouncement {
1601 features: ChannelFeatures::empty(),
1606 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1607 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1608 excess_data: Vec::new(),
1611 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1612 let valid_channel_announcement = ChannelAnnouncement {
1613 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1614 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1615 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1616 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1617 contents: unsigned_announcement.clone(),
1619 match net_graph_msg_handler.handle_channel_announcement(&valid_channel_announcement) {
1626 let mut unsigned_channel_update = UnsignedChannelUpdate {
1631 cltv_expiry_delta: 144,
1632 htlc_minimum_msat: 1000000,
1633 htlc_maximum_msat: OptionalField::Absent,
1634 fee_base_msat: 10000,
1635 fee_proportional_millionths: 20,
1636 excess_data: Vec::new()
1638 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1639 let valid_channel_update = ChannelUpdate {
1640 signature: secp_ctx.sign(&msghash, node_1_privkey),
1641 contents: unsigned_channel_update.clone()
1644 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1645 Ok(res) => assert!(res),
1650 match network_graph.read_only().channels().get(&short_channel_id) {
1652 Some(channel_info) => {
1653 assert_eq!(channel_info.one_to_two.as_ref().unwrap().cltv_expiry_delta, 144);
1654 assert!(channel_info.two_to_one.is_none());
1659 unsigned_channel_update.timestamp += 100;
1660 unsigned_channel_update.excess_data.resize(MAX_EXCESS_BYTES_FOR_RELAY + 1, 0);
1661 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1662 let valid_channel_update = ChannelUpdate {
1663 signature: secp_ctx.sign(&msghash, node_1_privkey),
1664 contents: unsigned_channel_update.clone()
1666 // Return false because contains excess data
1667 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1668 Ok(res) => assert!(!res),
1671 unsigned_channel_update.timestamp += 10;
1673 unsigned_channel_update.short_channel_id += 1;
1674 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1675 let valid_channel_update = ChannelUpdate {
1676 signature: secp_ctx.sign(&msghash, node_1_privkey),
1677 contents: unsigned_channel_update.clone()
1680 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1682 Err(e) => assert_eq!(e.err, "Couldn't find channel for update")
1684 unsigned_channel_update.short_channel_id = short_channel_id;
1686 unsigned_channel_update.htlc_maximum_msat = OptionalField::Present(MAX_VALUE_MSAT + 1);
1687 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1688 let valid_channel_update = ChannelUpdate {
1689 signature: secp_ctx.sign(&msghash, node_1_privkey),
1690 contents: unsigned_channel_update.clone()
1693 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1695 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than maximum possible msats")
1697 unsigned_channel_update.htlc_maximum_msat = OptionalField::Absent;
1699 unsigned_channel_update.htlc_maximum_msat = OptionalField::Present(amount_sats * 1000 + 1);
1700 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1701 let valid_channel_update = ChannelUpdate {
1702 signature: secp_ctx.sign(&msghash, node_1_privkey),
1703 contents: unsigned_channel_update.clone()
1706 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1708 Err(e) => assert_eq!(e.err, "htlc_maximum_msat is larger than channel capacity or capacity is bogus")
1710 unsigned_channel_update.htlc_maximum_msat = OptionalField::Absent;
1712 // Even though previous update was not relayed further, we still accepted it,
1713 // so we now won't accept update before the previous one.
1714 unsigned_channel_update.timestamp -= 10;
1715 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1716 let valid_channel_update = ChannelUpdate {
1717 signature: secp_ctx.sign(&msghash, node_1_privkey),
1718 contents: unsigned_channel_update.clone()
1721 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1723 Err(e) => assert_eq!(e.err, "Update older than last processed update")
1725 unsigned_channel_update.timestamp += 500;
1727 let fake_msghash = hash_to_message!(&zero_hash);
1728 let invalid_sig_channel_update = ChannelUpdate {
1729 signature: secp_ctx.sign(&fake_msghash, node_1_privkey),
1730 contents: unsigned_channel_update.clone()
1733 match net_graph_msg_handler.handle_channel_update(&invalid_sig_channel_update) {
1735 Err(e) => assert_eq!(e.err, "Invalid signature from remote node")
1741 fn handling_network_update() {
1742 let logger = test_utils::TestLogger::new();
1743 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1744 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1745 let network_graph = NetworkGraph::new(genesis_hash);
1746 let net_graph_msg_handler = NetGraphMsgHandler::new(&network_graph, Some(chain_source.clone()), &logger);
1747 let secp_ctx = Secp256k1::new();
1749 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1750 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1751 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1752 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1753 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1754 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1756 let short_channel_id = 0;
1757 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
1760 // There is no nodes in the table at the beginning.
1761 assert_eq!(network_graph.read_only().nodes().len(), 0);
1765 // Announce a channel we will update
1766 let unsigned_announcement = UnsignedChannelAnnouncement {
1767 features: ChannelFeatures::empty(),
1772 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1773 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1774 excess_data: Vec::new(),
1777 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1778 let valid_channel_announcement = ChannelAnnouncement {
1779 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1780 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1781 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1782 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1783 contents: unsigned_announcement.clone(),
1785 let chain_source: Option<&test_utils::TestChainSource> = None;
1786 assert!(network_graph.update_channel_from_announcement(&valid_channel_announcement, &chain_source, &secp_ctx).is_ok());
1787 assert!(network_graph.read_only().channels().get(&short_channel_id).is_some());
1789 let unsigned_channel_update = UnsignedChannelUpdate {
1794 cltv_expiry_delta: 144,
1795 htlc_minimum_msat: 1000000,
1796 htlc_maximum_msat: OptionalField::Absent,
1797 fee_base_msat: 10000,
1798 fee_proportional_millionths: 20,
1799 excess_data: Vec::new()
1801 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1802 let valid_channel_update = ChannelUpdate {
1803 signature: secp_ctx.sign(&msghash, node_1_privkey),
1804 contents: unsigned_channel_update.clone()
1807 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_none());
1809 net_graph_msg_handler.handle_event(&Event::PaymentPathFailed {
1811 payment_hash: PaymentHash([0; 32]),
1812 rejected_by_dest: false,
1813 all_paths_failed: true,
1815 network_update: Some(NetworkUpdate::ChannelUpdateMessage {
1816 msg: valid_channel_update,
1818 short_channel_id: None,
1824 assert!(network_graph.read_only().channels().get(&short_channel_id).unwrap().one_to_two.is_some());
1827 // Non-permanent closing just disables a channel
1829 match network_graph.read_only().channels().get(&short_channel_id) {
1831 Some(channel_info) => {
1832 assert!(channel_info.one_to_two.as_ref().unwrap().enabled);
1836 net_graph_msg_handler.handle_event(&Event::PaymentPathFailed {
1838 payment_hash: PaymentHash([0; 32]),
1839 rejected_by_dest: false,
1840 all_paths_failed: true,
1842 network_update: Some(NetworkUpdate::ChannelClosed {
1844 is_permanent: false,
1846 short_channel_id: None,
1852 match network_graph.read_only().channels().get(&short_channel_id) {
1854 Some(channel_info) => {
1855 assert!(!channel_info.one_to_two.as_ref().unwrap().enabled);
1860 // Permanent closing deletes a channel
1862 net_graph_msg_handler.handle_event(&Event::PaymentPathFailed {
1864 payment_hash: PaymentHash([0; 32]),
1865 rejected_by_dest: false,
1866 all_paths_failed: true,
1868 network_update: Some(NetworkUpdate::ChannelClosed {
1872 short_channel_id: None,
1878 assert_eq!(network_graph.read_only().channels().len(), 0);
1879 // Nodes are also deleted because there are no associated channels anymore
1880 assert_eq!(network_graph.read_only().nodes().len(), 0);
1882 // TODO: Test NetworkUpdate::NodeFailure, which is not implemented yet.
1886 fn getting_next_channel_announcements() {
1887 let network_graph = create_network_graph();
1888 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
1889 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
1890 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
1891 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
1892 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
1893 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
1894 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
1896 let short_channel_id = 1;
1897 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
1899 // Channels were not announced yet.
1900 let channels_with_announcements = net_graph_msg_handler.get_next_channel_announcements(0, 1);
1901 assert_eq!(channels_with_announcements.len(), 0);
1904 // Announce a channel we will update
1905 let unsigned_announcement = UnsignedChannelAnnouncement {
1906 features: ChannelFeatures::empty(),
1911 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
1912 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
1913 excess_data: Vec::new(),
1916 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
1917 let valid_channel_announcement = ChannelAnnouncement {
1918 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
1919 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
1920 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
1921 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
1922 contents: unsigned_announcement.clone(),
1924 match net_graph_msg_handler.handle_channel_announcement(&valid_channel_announcement) {
1930 // Contains initial channel announcement now.
1931 let channels_with_announcements = net_graph_msg_handler.get_next_channel_announcements(short_channel_id, 1);
1932 assert_eq!(channels_with_announcements.len(), 1);
1933 if let Some(channel_announcements) = channels_with_announcements.first() {
1934 let &(_, ref update_1, ref update_2) = channel_announcements;
1935 assert_eq!(update_1, &None);
1936 assert_eq!(update_2, &None);
1943 // Valid channel update
1944 let unsigned_channel_update = UnsignedChannelUpdate {
1949 cltv_expiry_delta: 144,
1950 htlc_minimum_msat: 1000000,
1951 htlc_maximum_msat: OptionalField::Absent,
1952 fee_base_msat: 10000,
1953 fee_proportional_millionths: 20,
1954 excess_data: Vec::new()
1956 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1957 let valid_channel_update = ChannelUpdate {
1958 signature: secp_ctx.sign(&msghash, node_1_privkey),
1959 contents: unsigned_channel_update.clone()
1961 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
1967 // Now contains an initial announcement and an update.
1968 let channels_with_announcements = net_graph_msg_handler.get_next_channel_announcements(short_channel_id, 1);
1969 assert_eq!(channels_with_announcements.len(), 1);
1970 if let Some(channel_announcements) = channels_with_announcements.first() {
1971 let &(_, ref update_1, ref update_2) = channel_announcements;
1972 assert_ne!(update_1, &None);
1973 assert_eq!(update_2, &None);
1980 // Channel update with excess data.
1981 let unsigned_channel_update = UnsignedChannelUpdate {
1986 cltv_expiry_delta: 144,
1987 htlc_minimum_msat: 1000000,
1988 htlc_maximum_msat: OptionalField::Absent,
1989 fee_base_msat: 10000,
1990 fee_proportional_millionths: 20,
1991 excess_data: [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec()
1993 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_channel_update.encode()[..])[..]);
1994 let valid_channel_update = ChannelUpdate {
1995 signature: secp_ctx.sign(&msghash, node_1_privkey),
1996 contents: unsigned_channel_update.clone()
1998 match net_graph_msg_handler.handle_channel_update(&valid_channel_update) {
2004 // Test that announcements with excess data won't be returned
2005 let channels_with_announcements = net_graph_msg_handler.get_next_channel_announcements(short_channel_id, 1);
2006 assert_eq!(channels_with_announcements.len(), 1);
2007 if let Some(channel_announcements) = channels_with_announcements.first() {
2008 let &(_, ref update_1, ref update_2) = channel_announcements;
2009 assert_eq!(update_1, &None);
2010 assert_eq!(update_2, &None);
2015 // Further starting point have no channels after it
2016 let channels_with_announcements = net_graph_msg_handler.get_next_channel_announcements(short_channel_id + 1000, 1);
2017 assert_eq!(channels_with_announcements.len(), 0);
2021 fn getting_next_node_announcements() {
2022 let network_graph = create_network_graph();
2023 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2024 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2025 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2026 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2027 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2028 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
2029 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
2031 let short_channel_id = 1;
2032 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2035 let next_announcements = net_graph_msg_handler.get_next_node_announcements(None, 10);
2036 assert_eq!(next_announcements.len(), 0);
2039 // Announce a channel to add 2 nodes
2040 let unsigned_announcement = UnsignedChannelAnnouncement {
2041 features: ChannelFeatures::empty(),
2046 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
2047 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
2048 excess_data: Vec::new(),
2051 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2052 let valid_channel_announcement = ChannelAnnouncement {
2053 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
2054 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
2055 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
2056 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
2057 contents: unsigned_announcement.clone(),
2059 match net_graph_msg_handler.handle_channel_announcement(&valid_channel_announcement) {
2066 // Nodes were never announced
2067 let next_announcements = net_graph_msg_handler.get_next_node_announcements(None, 3);
2068 assert_eq!(next_announcements.len(), 0);
2071 let mut unsigned_announcement = UnsignedNodeAnnouncement {
2072 features: NodeFeatures::known(),
2077 addresses: Vec::new(),
2078 excess_address_data: Vec::new(),
2079 excess_data: Vec::new(),
2081 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2082 let valid_announcement = NodeAnnouncement {
2083 signature: secp_ctx.sign(&msghash, node_1_privkey),
2084 contents: unsigned_announcement.clone()
2086 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
2091 unsigned_announcement.node_id = node_id_2;
2092 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2093 let valid_announcement = NodeAnnouncement {
2094 signature: secp_ctx.sign(&msghash, node_2_privkey),
2095 contents: unsigned_announcement.clone()
2098 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
2104 let next_announcements = net_graph_msg_handler.get_next_node_announcements(None, 3);
2105 assert_eq!(next_announcements.len(), 2);
2107 // Skip the first node.
2108 let next_announcements = net_graph_msg_handler.get_next_node_announcements(Some(&node_id_1), 2);
2109 assert_eq!(next_announcements.len(), 1);
2112 // Later announcement which should not be relayed (excess data) prevent us from sharing a node
2113 let unsigned_announcement = UnsignedNodeAnnouncement {
2114 features: NodeFeatures::known(),
2119 addresses: Vec::new(),
2120 excess_address_data: Vec::new(),
2121 excess_data: [1; MAX_EXCESS_BYTES_FOR_RELAY + 1].to_vec(),
2123 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2124 let valid_announcement = NodeAnnouncement {
2125 signature: secp_ctx.sign(&msghash, node_2_privkey),
2126 contents: unsigned_announcement.clone()
2128 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
2129 Ok(res) => assert!(!res),
2134 let next_announcements = net_graph_msg_handler.get_next_node_announcements(Some(&node_id_1), 2);
2135 assert_eq!(next_announcements.len(), 0);
2139 fn network_graph_serialization() {
2140 let network_graph = create_network_graph();
2141 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2143 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2144 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2145 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
2146 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
2148 // Announce a channel to add a corresponding node.
2149 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2150 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2151 let unsigned_announcement = UnsignedChannelAnnouncement {
2152 features: ChannelFeatures::known(),
2153 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
2154 short_channel_id: 0,
2157 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, node_1_btckey),
2158 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, node_2_btckey),
2159 excess_data: Vec::new(),
2162 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2163 let valid_announcement = ChannelAnnouncement {
2164 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
2165 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
2166 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
2167 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
2168 contents: unsigned_announcement.clone(),
2170 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
2171 Ok(res) => assert!(res),
2176 let node_id = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2177 let unsigned_announcement = UnsignedNodeAnnouncement {
2178 features: NodeFeatures::known(),
2183 addresses: Vec::new(),
2184 excess_address_data: Vec::new(),
2185 excess_data: Vec::new(),
2187 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2188 let valid_announcement = NodeAnnouncement {
2189 signature: secp_ctx.sign(&msghash, node_1_privkey),
2190 contents: unsigned_announcement.clone()
2193 match net_graph_msg_handler.handle_node_announcement(&valid_announcement) {
2198 let mut w = test_utils::TestVecWriter(Vec::new());
2199 assert!(!network_graph.read_only().nodes().is_empty());
2200 assert!(!network_graph.read_only().channels().is_empty());
2201 network_graph.write(&mut w).unwrap();
2202 assert!(<NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap() == network_graph);
2206 fn calling_sync_routing_table() {
2207 let network_graph = create_network_graph();
2208 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2209 let node_privkey_1 = &SecretKey::from_slice(&[42; 32]).unwrap();
2210 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_privkey_1);
2212 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2213 let first_blocknum = 0;
2214 let number_of_blocks = 0xffff_ffff;
2216 // It should ignore if gossip_queries feature is not enabled
2218 let init_msg = Init { features: InitFeatures::known().clear_gossip_queries() };
2219 net_graph_msg_handler.sync_routing_table(&node_id_1, &init_msg);
2220 let events = net_graph_msg_handler.get_and_clear_pending_msg_events();
2221 assert_eq!(events.len(), 0);
2224 // It should send a query_channel_message with the correct information
2226 let init_msg = Init { features: InitFeatures::known() };
2227 net_graph_msg_handler.sync_routing_table(&node_id_1, &init_msg);
2228 let events = net_graph_msg_handler.get_and_clear_pending_msg_events();
2229 assert_eq!(events.len(), 1);
2231 MessageSendEvent::SendChannelRangeQuery{ node_id, msg } => {
2232 assert_eq!(node_id, &node_id_1);
2233 assert_eq!(msg.chain_hash, chain_hash);
2234 assert_eq!(msg.first_blocknum, first_blocknum);
2235 assert_eq!(msg.number_of_blocks, number_of_blocks);
2237 _ => panic!("Expected MessageSendEvent::SendChannelRangeQuery")
2241 // It should not enqueue a query when should_request_full_sync return false.
2242 // The initial implementation allows syncing with the first 5 peers after
2243 // which should_request_full_sync will return false
2245 let network_graph = create_network_graph();
2246 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2247 let init_msg = Init { features: InitFeatures::known() };
2249 let node_privkey = &SecretKey::from_slice(&[n; 32]).unwrap();
2250 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2251 net_graph_msg_handler.sync_routing_table(&node_id, &init_msg);
2252 let events = net_graph_msg_handler.get_and_clear_pending_msg_events();
2254 assert_eq!(events.len(), 1);
2256 assert_eq!(events.len(), 0);
2264 fn handling_reply_channel_range() {
2265 let network_graph = create_network_graph();
2266 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2267 let node_privkey_1 = &SecretKey::from_slice(&[42; 32]).unwrap();
2268 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_privkey_1);
2270 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2272 // Test receipt of a single reply that should enqueue an SCID query
2273 // matching the SCIDs in the reply
2275 let result = net_graph_msg_handler.handle_reply_channel_range(&node_id_1, ReplyChannelRange {
2277 sync_complete: true,
2279 number_of_blocks: 2000,
2280 short_channel_ids: vec![
2281 0x0003e0_000000_0000, // 992x0x0
2282 0x0003e8_000000_0000, // 1000x0x0
2283 0x0003e9_000000_0000, // 1001x0x0
2284 0x0003f0_000000_0000, // 1008x0x0
2285 0x00044c_000000_0000, // 1100x0x0
2286 0x0006e0_000000_0000, // 1760x0x0
2289 assert!(result.is_ok());
2291 // We expect to emit a query_short_channel_ids message with the received scids
2292 let events = net_graph_msg_handler.get_and_clear_pending_msg_events();
2293 assert_eq!(events.len(), 1);
2295 MessageSendEvent::SendShortIdsQuery { node_id, msg } => {
2296 assert_eq!(node_id, &node_id_1);
2297 assert_eq!(msg.chain_hash, chain_hash);
2298 assert_eq!(msg.short_channel_ids, vec![
2299 0x0003e0_000000_0000, // 992x0x0
2300 0x0003e8_000000_0000, // 1000x0x0
2301 0x0003e9_000000_0000, // 1001x0x0
2302 0x0003f0_000000_0000, // 1008x0x0
2303 0x00044c_000000_0000, // 1100x0x0
2304 0x0006e0_000000_0000, // 1760x0x0
2307 _ => panic!("expected MessageSendEvent::SendShortIdsQuery"),
2313 fn handling_reply_short_channel_ids() {
2314 let network_graph = create_network_graph();
2315 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2316 let node_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2317 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2319 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2321 // Test receipt of a successful reply
2323 let result = net_graph_msg_handler.handle_reply_short_channel_ids_end(&node_id, ReplyShortChannelIdsEnd {
2325 full_information: true,
2327 assert!(result.is_ok());
2330 // Test receipt of a reply that indicates the peer does not maintain up-to-date information
2331 // for the chain_hash requested in the query.
2333 let result = net_graph_msg_handler.handle_reply_short_channel_ids_end(&node_id, ReplyShortChannelIdsEnd {
2335 full_information: false,
2337 assert!(result.is_err());
2338 assert_eq!(result.err().unwrap().err, "Received reply_short_channel_ids_end with no information");
2343 fn handling_query_channel_range() {
2344 let network_graph = create_network_graph();
2345 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2347 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2348 let node_1_privkey = &SecretKey::from_slice(&[42; 32]).unwrap();
2349 let node_2_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2350 let node_1_btckey = &SecretKey::from_slice(&[40; 32]).unwrap();
2351 let node_2_btckey = &SecretKey::from_slice(&[39; 32]).unwrap();
2352 let node_id_1 = PublicKey::from_secret_key(&secp_ctx, node_1_privkey);
2353 let node_id_2 = PublicKey::from_secret_key(&secp_ctx, node_2_privkey);
2354 let bitcoin_key_1 = PublicKey::from_secret_key(&secp_ctx, node_1_btckey);
2355 let bitcoin_key_2 = PublicKey::from_secret_key(&secp_ctx, node_2_btckey);
2357 let mut scids: Vec<u64> = vec![
2358 scid_from_parts(0xfffffe, 0xffffff, 0xffff).unwrap(), // max
2359 scid_from_parts(0xffffff, 0xffffff, 0xffff).unwrap(), // never
2362 // used for testing multipart reply across blocks
2363 for block in 100000..=108001 {
2364 scids.push(scid_from_parts(block, 0, 0).unwrap());
2367 // used for testing resumption on same block
2368 scids.push(scid_from_parts(108001, 1, 0).unwrap());
2371 let unsigned_announcement = UnsignedChannelAnnouncement {
2372 features: ChannelFeatures::known(),
2373 chain_hash: chain_hash.clone(),
2374 short_channel_id: scid,
2379 excess_data: Vec::new(),
2382 let msghash = hash_to_message!(&Sha256dHash::hash(&unsigned_announcement.encode()[..])[..]);
2383 let valid_announcement = ChannelAnnouncement {
2384 node_signature_1: secp_ctx.sign(&msghash, node_1_privkey),
2385 node_signature_2: secp_ctx.sign(&msghash, node_2_privkey),
2386 bitcoin_signature_1: secp_ctx.sign(&msghash, node_1_btckey),
2387 bitcoin_signature_2: secp_ctx.sign(&msghash, node_2_btckey),
2388 contents: unsigned_announcement.clone(),
2390 match net_graph_msg_handler.handle_channel_announcement(&valid_announcement) {
2396 // Error when number_of_blocks=0
2397 do_handling_query_channel_range(
2398 &net_graph_msg_handler,
2401 chain_hash: chain_hash.clone(),
2403 number_of_blocks: 0,
2406 vec![ReplyChannelRange {
2407 chain_hash: chain_hash.clone(),
2409 number_of_blocks: 0,
2410 sync_complete: true,
2411 short_channel_ids: vec![]
2415 // Error when wrong chain
2416 do_handling_query_channel_range(
2417 &net_graph_msg_handler,
2420 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2422 number_of_blocks: 0xffff_ffff,
2425 vec![ReplyChannelRange {
2426 chain_hash: genesis_block(Network::Bitcoin).header.block_hash(),
2428 number_of_blocks: 0xffff_ffff,
2429 sync_complete: true,
2430 short_channel_ids: vec![],
2434 // Error when first_blocknum > 0xffffff
2435 do_handling_query_channel_range(
2436 &net_graph_msg_handler,
2439 chain_hash: chain_hash.clone(),
2440 first_blocknum: 0x01000000,
2441 number_of_blocks: 0xffff_ffff,
2444 vec![ReplyChannelRange {
2445 chain_hash: chain_hash.clone(),
2446 first_blocknum: 0x01000000,
2447 number_of_blocks: 0xffff_ffff,
2448 sync_complete: true,
2449 short_channel_ids: vec![]
2453 // Empty reply when max valid SCID block num
2454 do_handling_query_channel_range(
2455 &net_graph_msg_handler,
2458 chain_hash: chain_hash.clone(),
2459 first_blocknum: 0xffffff,
2460 number_of_blocks: 1,
2465 chain_hash: chain_hash.clone(),
2466 first_blocknum: 0xffffff,
2467 number_of_blocks: 1,
2468 sync_complete: true,
2469 short_channel_ids: vec![]
2474 // No results in valid query range
2475 do_handling_query_channel_range(
2476 &net_graph_msg_handler,
2479 chain_hash: chain_hash.clone(),
2480 first_blocknum: 1000,
2481 number_of_blocks: 1000,
2486 chain_hash: chain_hash.clone(),
2487 first_blocknum: 1000,
2488 number_of_blocks: 1000,
2489 sync_complete: true,
2490 short_channel_ids: vec![],
2495 // Overflow first_blocknum + number_of_blocks
2496 do_handling_query_channel_range(
2497 &net_graph_msg_handler,
2500 chain_hash: chain_hash.clone(),
2501 first_blocknum: 0xfe0000,
2502 number_of_blocks: 0xffffffff,
2507 chain_hash: chain_hash.clone(),
2508 first_blocknum: 0xfe0000,
2509 number_of_blocks: 0xffffffff - 0xfe0000,
2510 sync_complete: true,
2511 short_channel_ids: vec![
2512 0xfffffe_ffffff_ffff, // max
2518 // Single block exactly full
2519 do_handling_query_channel_range(
2520 &net_graph_msg_handler,
2523 chain_hash: chain_hash.clone(),
2524 first_blocknum: 100000,
2525 number_of_blocks: 8000,
2530 chain_hash: chain_hash.clone(),
2531 first_blocknum: 100000,
2532 number_of_blocks: 8000,
2533 sync_complete: true,
2534 short_channel_ids: (100000..=107999)
2535 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2541 // Multiple split on new block
2542 do_handling_query_channel_range(
2543 &net_graph_msg_handler,
2546 chain_hash: chain_hash.clone(),
2547 first_blocknum: 100000,
2548 number_of_blocks: 8001,
2553 chain_hash: chain_hash.clone(),
2554 first_blocknum: 100000,
2555 number_of_blocks: 7999,
2556 sync_complete: false,
2557 short_channel_ids: (100000..=107999)
2558 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2562 chain_hash: chain_hash.clone(),
2563 first_blocknum: 107999,
2564 number_of_blocks: 2,
2565 sync_complete: true,
2566 short_channel_ids: vec![
2567 scid_from_parts(108000, 0, 0).unwrap(),
2573 // Multiple split on same block
2574 do_handling_query_channel_range(
2575 &net_graph_msg_handler,
2578 chain_hash: chain_hash.clone(),
2579 first_blocknum: 100002,
2580 number_of_blocks: 8000,
2585 chain_hash: chain_hash.clone(),
2586 first_blocknum: 100002,
2587 number_of_blocks: 7999,
2588 sync_complete: false,
2589 short_channel_ids: (100002..=108001)
2590 .map(|block| scid_from_parts(block, 0, 0).unwrap())
2594 chain_hash: chain_hash.clone(),
2595 first_blocknum: 108001,
2596 number_of_blocks: 1,
2597 sync_complete: true,
2598 short_channel_ids: vec![
2599 scid_from_parts(108001, 1, 0).unwrap(),
2606 fn do_handling_query_channel_range(
2607 net_graph_msg_handler: &NetGraphMsgHandler<&NetworkGraph, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>,
2608 test_node_id: &PublicKey,
2609 msg: QueryChannelRange,
2611 expected_replies: Vec<ReplyChannelRange>
2613 let mut max_firstblocknum = msg.first_blocknum.saturating_sub(1);
2614 let mut c_lightning_0_9_prev_end_blocknum = max_firstblocknum;
2615 let query_end_blocknum = msg.end_blocknum();
2616 let result = net_graph_msg_handler.handle_query_channel_range(test_node_id, msg);
2619 assert!(result.is_ok());
2621 assert!(result.is_err());
2624 let events = net_graph_msg_handler.get_and_clear_pending_msg_events();
2625 assert_eq!(events.len(), expected_replies.len());
2627 for i in 0..events.len() {
2628 let expected_reply = &expected_replies[i];
2630 MessageSendEvent::SendReplyChannelRange { node_id, msg } => {
2631 assert_eq!(node_id, test_node_id);
2632 assert_eq!(msg.chain_hash, expected_reply.chain_hash);
2633 assert_eq!(msg.first_blocknum, expected_reply.first_blocknum);
2634 assert_eq!(msg.number_of_blocks, expected_reply.number_of_blocks);
2635 assert_eq!(msg.sync_complete, expected_reply.sync_complete);
2636 assert_eq!(msg.short_channel_ids, expected_reply.short_channel_ids);
2638 // Enforce exactly the sequencing requirements present on c-lightning v0.9.3
2639 assert!(msg.first_blocknum == c_lightning_0_9_prev_end_blocknum || msg.first_blocknum == c_lightning_0_9_prev_end_blocknum.saturating_add(1));
2640 assert!(msg.first_blocknum >= max_firstblocknum);
2641 max_firstblocknum = msg.first_blocknum;
2642 c_lightning_0_9_prev_end_blocknum = msg.first_blocknum.saturating_add(msg.number_of_blocks);
2644 // Check that the last block count is >= the query's end_blocknum
2645 if i == events.len() - 1 {
2646 assert!(msg.first_blocknum.saturating_add(msg.number_of_blocks) >= query_end_blocknum);
2649 _ => panic!("expected MessageSendEvent::SendReplyChannelRange"),
2655 fn handling_query_short_channel_ids() {
2656 let network_graph = create_network_graph();
2657 let (secp_ctx, net_graph_msg_handler) = create_net_graph_msg_handler(&network_graph);
2658 let node_privkey = &SecretKey::from_slice(&[41; 32]).unwrap();
2659 let node_id = PublicKey::from_secret_key(&secp_ctx, node_privkey);
2661 let chain_hash = genesis_block(Network::Testnet).header.block_hash();
2663 let result = net_graph_msg_handler.handle_query_short_channel_ids(&node_id, QueryShortChannelIds {
2665 short_channel_ids: vec![0x0003e8_000000_0000],
2667 assert!(result.is_err());
2671 #[cfg(all(test, feature = "unstable"))]
2679 fn read_network_graph(bench: &mut Bencher) {
2680 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
2681 let mut v = Vec::new();
2682 d.read_to_end(&mut v).unwrap();
2684 let _ = NetworkGraph::read(&mut std::io::Cursor::new(&v)).unwrap();
2689 fn write_network_graph(bench: &mut Bencher) {
2690 let mut d = ::routing::router::test_utils::get_route_file().unwrap();
2691 let net_graph = NetworkGraph::read(&mut d).unwrap();
2693 let _ = net_graph.encode();