Skip to content

Commit d40751f

Browse files
Add test utilities and integration tests for onion messages
1 parent 608c2f8 commit d40751f

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

lightning/src/ln/onion_message.rs

+103
Original file line numberDiff line numberDiff line change
@@ -699,3 +699,106 @@ pub type SimpleArcOnionMessenger<L> = OnionMessenger<InMemorySigner, Arc<KeysMan
699699
///[`SimpleRefChannelManager`]: crate::ln::channelmanager::SimpleRefChannelManager
700700
///[`SimpleRefPeerManager`]: crate::ln::peer_handler::SimpleRefPeerManager
701701
pub type SimpleRefOnionMessenger<'a, 'b, L> = OnionMessenger<InMemorySigner, &'a KeysManager, &'b L>;
702+
703+
#[cfg(test)]
704+
mod tests {
705+
use chain::keysinterface::{KeysInterface, Recipient};
706+
use ln::msgs::OnionMessageHandler;
707+
use ln::onion_message::{BlindedRoute, Destination, OnionMessenger};
708+
use util::enforcing_trait_impls::EnforcingSigner;
709+
use util::events::{MessageSendEvent, MessageSendEventsProvider};
710+
use util::test_utils;
711+
712+
use bitcoin::network::constants::Network;
713+
use bitcoin::secp256k1::{PublicKey, Secp256k1};
714+
715+
use sync::Arc;
716+
717+
struct MessengerNode {
718+
keys_manager: Arc<test_utils::TestKeysInterface>,
719+
messenger: OnionMessenger<EnforcingSigner, Arc<test_utils::TestKeysInterface>, Arc<test_utils::TestLogger>>,
720+
logger: Arc<test_utils::TestLogger>,
721+
}
722+
723+
impl MessengerNode {
724+
fn get_node_pk(&self) -> PublicKey {
725+
let secp_ctx = Secp256k1::new();
726+
PublicKey::from_secret_key(&secp_ctx, &self.keys_manager.get_node_secret(Recipient::Node).unwrap())
727+
}
728+
}
729+
730+
fn create_nodes(num_messengers: u8) -> Vec<MessengerNode> {
731+
let mut res = Vec::new();
732+
for i in 0..num_messengers {
733+
let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
734+
let seed = [i as u8; 32];
735+
let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet));
736+
res.push(MessengerNode {
737+
keys_manager: keys_manager.clone(),
738+
messenger: OnionMessenger::new(keys_manager, logger.clone()),
739+
logger,
740+
});
741+
}
742+
res
743+
}
744+
745+
fn pass_along_path(path: Vec<&MessengerNode>, expected_path_id: Option<[u8; 32]>) {
746+
let mut prev_node = path[0];
747+
for (idx, node) in path.iter().enumerate().skip(1) {
748+
let events = prev_node.messenger.get_and_clear_pending_msg_events();
749+
assert_eq!(events.len(), 1);
750+
let onion_msg = match &events[0] {
751+
MessageSendEvent::SendOnionMessage { msg, .. } => msg.clone(),
752+
_ => panic!("Unexpected event"),
753+
};
754+
node.messenger.handle_onion_message(&prev_node.get_node_pk(), &onion_msg);
755+
if idx == path.len() - 1 {
756+
node.logger.assert_log_contains(
757+
"lightning::ln::onion_message".to_string(),
758+
format!("Received an onion message with path_id: {:02x?}", expected_path_id).to_string(), 1);
759+
break
760+
}
761+
prev_node = node;
762+
}
763+
}
764+
765+
#[test]
766+
fn one_hop() {
767+
let mut nodes = create_nodes(2);
768+
let (node1, node2) = (nodes.remove(0), nodes.remove(0));
769+
770+
node1.messenger.send_onion_message(vec![], Destination::Node(node2.get_node_pk())).unwrap();
771+
pass_along_path(vec![&node1, &node2], None);
772+
}
773+
774+
#[test]
775+
fn two_unblinded_hops() {
776+
let mut nodes = create_nodes(3);
777+
let (node1, node2, node3) = (nodes.remove(0), nodes.remove(0), nodes.remove(0));
778+
779+
node1.messenger.send_onion_message(vec![node2.get_node_pk()], Destination::Node(node3.get_node_pk())).unwrap();
780+
pass_along_path(vec![&node1, &node2, &node3], None);
781+
}
782+
783+
#[test]
784+
fn two_unblinded_two_blinded() {
785+
let mut nodes = create_nodes(5);
786+
let (node1, node2, node3, node4, node5) = (nodes.remove(0), nodes.remove(0), nodes.remove(0), nodes.remove(0), nodes.remove(0));
787+
788+
let blinded_route = BlindedRoute::new(vec![node4.get_node_pk(), node5.get_node_pk()], &node5.keys_manager).unwrap();
789+
790+
node1.messenger.send_onion_message(vec![node2.get_node_pk(), node3.get_node_pk()], Destination::BlindedRoute(blinded_route)).unwrap();
791+
pass_along_path(vec![&node1, &node2, &node3, &node4, &node5], Some([42; 32]));
792+
}
793+
794+
#[test]
795+
fn three_blinded_hops() {
796+
let mut nodes = create_nodes(4);
797+
let (node1, node2, node3, node4) = (nodes.remove(0), nodes.remove(0), nodes.remove(0), nodes.remove(0));
798+
799+
let blinded_route = BlindedRoute::new(vec![node2.get_node_pk(), node3.get_node_pk(), node4.get_node_pk()], &node4.keys_manager).unwrap();
800+
801+
node1.messenger.send_onion_message(vec![], Destination::BlindedRoute(blinded_route)).unwrap();
802+
pass_along_path(vec![&node1, &node2, &node3, &node4], Some([42; 32]));
803+
}
804+
}

0 commit comments

Comments
 (0)