Initial RFC on issue 148

Author: SWvheerden

src/ln/msgs.rs

@@ -25,6 +25,7 @@ use std::error::Error;
 use std::{cmp, fmt};
 use std::io::Read;
 use std::result::Result;
+use std;
 
 use util::{byte_utils, events};
 use util::ser::{Readable, Writeable, Writer};
@@ -563,6 +564,14 @@ pub trait RoutingMessageHandler : Send + Sync {
 	fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
 }
 
+///A trait to describe the API required to access the network topology
+pub trait NetworkAPI : Send + Sync {
+	///This should return a vec of all possible channel announcements or an error
+	fn get_all_channel_announcements(&self)-> Result<Vec<ChannelAnnouncement>, std::fmt::Error>;
+	///This should return a vec of all possible node announcements or an error
+	fn get_all_node_announcements(&self)-> Result<Vec<NodeAnnouncement>, std::fmt::Error>;
+}
+
 pub(crate) struct OnionRealm0HopData {
 	pub(crate) short_channel_id: u64,
 	pub(crate) amt_to_forward: u64,

src/ln/peer_handler.rs

@@ -9,6 +9,7 @@
 use secp256k1::key::{SecretKey,PublicKey};
 
 use ln::msgs;
+use ln::msgs::NetworkAPI;
 use util::ser::{Writeable, Writer, Readable};
 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
 use util::byte_utils;
@@ -130,6 +131,7 @@ pub struct PeerManager<Descriptor: SocketDescriptor> {
 	pending_events: Mutex<Vec<Event>>,
 	our_node_secret: SecretKey,
 	initial_syncs_sent: AtomicUsize,
+	network_api : NetworkAPI,
 	logger: Arc<Logger>,
 }
 
@@ -515,6 +517,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 													if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
 														self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
 														local_features.set_initial_routing_sync();
+														//TODO get and send announcements.
 													}
 													encode_and_send_msg!(msgs::Init {
 														global_features: msgs::GlobalFeatures::new(),

src/ln/router.rs

@@ -13,7 +13,7 @@ use bitcoin::blockdata::opcodes;
 
 use chain::chaininterface::{ChainError, ChainWatchInterface};
 use ln::channelmanager;
-use ln::msgs::{ErrorAction,HandleError,RoutingMessageHandler,NetAddress,GlobalFeatures};
+use ln::msgs::{ErrorAction,HandleError,RoutingMessageHandler,NetAddress,GlobalFeatures, NetworkAPI};
 use ln::msgs;
 use util::ser::Writeable;
 use util::logger::Logger;
@@ -428,6 +428,15 @@ impl RoutingMessageHandler for Router {
 	}
 }
 
+impl NetworkAPI for Router {
+	fn get_all_channel_announcements(&self)-> Result<Vec<msgs::NodeAnnouncement>, std::fmt::Error>{
+		unimplemented!();
+	}
+	fn get_all_node_announcements(&self)-> Result<Vec<msgs::NodeAnnouncement>, std::fmt::Error>{
+		unimplemented!();
+	}
+}
+
 #[derive(Eq, PartialEq)]
 struct RouteGraphNode {
 	pubkey: PublicKey,