Add onion message handler

Author: orbitalturtle

src/builder.rs

@@ -14,8 +14,8 @@ use crate::types::{
 use crate::wallet::Wallet;
 use crate::LogLevel;
 use crate::{
-	Config, Node, BDK_CLIENT_CONCURRENCY, BDK_CLIENT_STOP_GAP, DEFAULT_ESPLORA_SERVER_URL,
-	WALLET_KEYS_SEED_LEN,
+	Config, Node, OnionMessageHandler, BDK_CLIENT_CONCURRENCY, BDK_CLIENT_STOP_GAP,
+	DEFAULT_ESPLORA_SERVER_URL, WALLET_KEYS_SEED_LEN,
 };
 
 use lightning::chain::keysinterface::EntropySource;
@@ -42,6 +42,7 @@ use bip39::Mnemonic;
 
 use bitcoin::BlockHash;
 
+use std::collections::VecDeque;
 use std::convert::TryInto;
 use std::default::Default;
 use std::fmt;
@@ -394,11 +395,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 	};
 
 	// Initialize the Logger
-	let log_file_path = format!(
-		"{}/ldk_node_{}.log",
-                log_dir,
-		chrono::offset::Local::now().format("%Y_%m_%d")
-	);
+	let log_file_path =
+		format!("{}/ldk_node_{}.log", log_dir, chrono::offset::Local::now().format("%Y_%m_%d"));
 	let logger = Arc::new(
 		FilesystemLogger::new(log_file_path.clone(), config.log_level)
 			.map_err(|_| BuildError::LoggerSetupFailed)?,
@@ -611,12 +609,15 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 		chain_monitor.watch_channel(funding_outpoint, channel_monitor);
 	}
 
+	let onion_message_handler =
+		Arc::new(OnionMessageHandler { messages: Mutex::new(VecDeque::new()) });
+
 	// Initialize the PeerManager
 	let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
 		Arc::clone(&keys_manager),
 		Arc::clone(&keys_manager),
 		Arc::clone(&logger),
-		IgnoringMessageHandler {},
+		Arc::clone(&onion_message_handler),
 	));
 	let ephemeral_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 
@@ -738,6 +739,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 		scorer,
 		peer_store,
 		payment_store,
-                onion_messenger: onion_messenger,
+		onion_messenger,
+		custom_handler: onion_message_handler,
 	})
 }

src/lib.rs

@@ -128,13 +128,17 @@ use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
 
 use lightning::chain::keysinterface::EntropySource;
 use lightning::chain::Confirm;
+use lightning::io::Read;
 use lightning::ln::channelmanager::{self, PaymentId, RecipientOnionFields, Retry};
+use lightning::ln::msgs::DecodeError;
 use lightning::ln::{PaymentHash, PaymentPreimage};
-use lightning::onion_message::{CustomOnionMessageContents, Destination, OnionMessageContents};
+use lightning::onion_message::{
+	CustomOnionMessageContents, CustomOnionMessageHandler, Destination, OnionMessageContents,
+};
 
-use lightning::util::ser::{Writeable, Writer};
 use lightning::util::config::{ChannelConfig, ChannelHandshakeConfig, UserConfig};
 pub use lightning::util::logger::Level as LogLevel;
+use lightning::util::ser::{Writeable, Writer};
 
 use lightning_background_processor::process_events_async;
 
@@ -152,8 +156,10 @@ use bitcoin::{Address, Txid};
 
 use rand::Rng;
 
+use std::collections::VecDeque;
 use std::default::Default;
 use std::net::ToSocketAddrs;
+use std::ops::Deref;
 use std::sync::{Arc, Mutex, RwLock};
 use std::time::{Duration, Instant, SystemTime};
 
@@ -214,6 +220,34 @@ impl Writeable for UserOnionMessageContents {
 	}
 }
 
+// An extremely basic message handler needed for our integration tests.
+pub struct OnionMessageHandler {
+	pub messages: Mutex<VecDeque<UserOnionMessageContents>>,
+}
+
+impl CustomOnionMessageHandler for OnionMessageHandler {
+	type CustomMessage = UserOnionMessageContents;
+
+	fn handle_custom_message(&self, msg: Self::CustomMessage) {
+		println!("Received a new custom message!");
+		self.messages.lock().unwrap().push_back(msg);
+	}
+
+	fn read_custom_message<R: Read>(
+		&self, message_type: u64, buffer: &mut R,
+	) -> Result<Option<Self::CustomMessage>, DecodeError> {
+		unimplemented!();
+	}
+}
+
+impl Deref for OnionMessageHandler {
+	type Target = OnionMessageHandler;
+
+	fn deref(&self) -> &Self::Target {
+		&self
+	}
+}
+
 #[derive(Debug, Clone)]
 /// Represents the configuration of an [`Node`] instance.
 ///
@@ -309,6 +343,7 @@ pub struct Node<K: KVStore + Sync + Send + 'static> {
 	peer_store: Arc<PeerStore<K, Arc<FilesystemLogger>>>,
 	payment_store: Arc<PaymentStore<K, Arc<FilesystemLogger>>>,
 	onion_messenger: Arc<OnionMessenger>,
+	pub custom_handler: Arc<OnionMessageHandler>,
 }
 
 impl<K: KVStore + Sync + Send + 'static> Node<K> {

src/types.rs

@@ -1,5 +1,6 @@
 use crate::logger::FilesystemLogger;
 use crate::wallet::{Wallet, WalletKeysManager};
+use crate::OnionMessageHandler;
 
 use lightning::chain::chainmonitor;
 use lightning::chain::keysinterface::InMemorySigner;
@@ -84,7 +85,7 @@ pub(crate) type OnionMessenger = lightning::onion_message::OnionMessenger<
 	Arc<WalletKeysManager<bdk::database::SqliteDatabase, Arc<FilesystemLogger>>>,
 	Arc<WalletKeysManager<bdk::database::SqliteDatabase, Arc<FilesystemLogger>>>,
 	Arc<FilesystemLogger>,
-	IgnoringMessageHandler,
+	Arc<OnionMessageHandler>,
 >;
 
 /// The global identifier of a channel.