Skip to content

Commit b79ff71

Browse files
TheBlueMattTheBlueMatt
authored
Merge pull request #1812 from valentinewallace/2022-10-chanman-router-param
Parameterize `ChannelManager` by a `Router`
2 parents e1208bf + 19516c0 commit b79ff71

20 files changed

+393
-222
lines changed

‎fuzz/src/chanmon_consistency.rs

+25-5
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ use lightning::chain::transaction::OutPoint;
3838
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
3939
use lightning::chain::keysinterface::{KeyMaterial, KeysInterface, InMemorySigner, Recipient, EntropySource, NodeSigner, SignerProvider};
4040
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
41-
use lightning::ln::channelmanager::{self, ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs, PaymentId};
41+
use lightning::ln::channelmanager::{self, ChainParameters, ChannelDetails, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs, PaymentId};
4242
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
43-
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
43+
use lightning::ln::msgs::{self, CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
4444
use lightning::ln::script::ShutdownScript;
4545
use lightning::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
4646
use lightning::util::errors::APIError;
@@ -49,7 +49,7 @@ use lightning::util::logger::Logger;
4949
use lightning::util::config::UserConfig;
5050
use lightning::util::events::MessageSendEventsProvider;
5151
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
52-
use lightning::routing::router::{Route, RouteHop};
52+
use lightning::routing::router::{InFlightHtlcs, Route, RouteHop, RouteParameters, Router};
5353

5454
use crate::utils::test_logger::{self, Output};
5555
use crate::utils::test_persister::TestPersister;
@@ -85,6 +85,24 @@ impl FeeEstimator for FuzzEstimator {
8585
}
8686
}
8787

88+
struct FuzzRouter {}
89+
90+
impl Router for FuzzRouter {
91+
fn find_route(
92+
&self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
93+
_inflight_htlcs: &InFlightHtlcs
94+
) -> Result<Route, msgs::LightningError> {
95+
Err(msgs::LightningError {
96+
err: String::from("Not implemented"),
97+
action: msgs::ErrorAction::IgnoreError
98+
})
99+
}
100+
fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
101+
fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
102+
fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
103+
fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
104+
}
105+
88106
pub struct TestBroadcaster {}
89107
impl BroadcasterInterface for TestBroadcaster {
90108
fn broadcast_transaction(&self, _tx: &Transaction) { }
@@ -310,7 +328,7 @@ fn check_payment_err(send_err: PaymentSendFailure) {
310328
}
311329
}
312330

313-
type ChanMan = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
331+
type ChanMan<'a> = ChannelManager<Arc<TestChainMonitor>, Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
314332

315333
#[inline]
316334
fn get_payment_secret_hash(dest: &ChanMan, payment_id: &mut u8) -> Option<(PaymentSecret, PaymentHash)> {
@@ -381,6 +399,7 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
381399
pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
382400
let out = SearchingOutput::new(underlying_out);
383401
let broadcast = Arc::new(TestBroadcaster{});
402+
let router = FuzzRouter {};
384403

385404
macro_rules! make_node {
386405
($node_id: expr, $fee_estimator: expr) => { {
@@ -399,7 +418,7 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
399418
network,
400419
best_block: BestBlock::from_genesis(network),
401420
};
402-
(ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
421+
(ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), &router, Arc::clone(&logger), keys_manager.clone(), config, params),
403422
monitor, keys_manager)
404423
} }
405424
}
@@ -433,6 +452,7 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
433452
fee_estimator: $fee_estimator.clone(),
434453
chain_monitor: chain_monitor.clone(),
435454
tx_broadcaster: broadcast.clone(),
455+
router: &router,
436456
logger,
437457
default_config: config,
438458
channel_monitors: monitor_refs,

‎fuzz/src/full_stack.rs

+28-9
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ use lightning::chain::chainmonitor;
3535
use lightning::chain::transaction::OutPoint;
3636
use lightning::chain::keysinterface::{InMemorySigner, Recipient, KeyMaterial, KeysInterface, EntropySource, NodeSigner, SignerProvider};
3737
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
38-
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentId};
38+
use lightning::ln::channelmanager::{ChainParameters, ChannelDetails, ChannelManager, PaymentId};
3939
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
40-
use lightning::ln::msgs::DecodeError;
40+
use lightning::ln::msgs::{self, DecodeError};
4141
use lightning::ln::script::ShutdownScript;
4242
use lightning::routing::gossip::{P2PGossipSync, NetworkGraph};
43-
use lightning::routing::router::{find_route, PaymentParameters, RouteParameters};
43+
use lightning::routing::router::{find_route, InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
4444
use lightning::routing::scoring::FixedPenaltyScorer;
4545
use lightning::util::config::UserConfig;
4646
use lightning::util::errors::APIError;
@@ -127,6 +127,24 @@ impl FeeEstimator for FuzzEstimator {
127127
}
128128
}
129129

130+
struct FuzzRouter {}
131+
132+
impl Router for FuzzRouter {
133+
fn find_route(
134+
&self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
135+
_inflight_htlcs: &InFlightHtlcs
136+
) -> Result<Route, msgs::LightningError> {
137+
Err(msgs::LightningError {
138+
err: String::from("Not implemented"),
139+
action: msgs::ErrorAction::IgnoreError
140+
})
141+
}
142+
fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
143+
fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
144+
fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
145+
fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
146+
}
147+
130148
struct TestBroadcaster {
131149
txn_broadcasted: Mutex<Vec<Transaction>>,
132150
}
@@ -162,13 +180,13 @@ impl<'a> std::hash::Hash for Peer<'a> {
162180
}
163181
}
164182

165-
type ChannelMan = ChannelManager<
183+
type ChannelMan<'a> = ChannelManager<
166184
Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
167-
Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, Arc<dyn Logger>>;
168-
type PeerMan<'a> = PeerManager<Peer<'a>, Arc<ChannelMan>, Arc<P2PGossipSync<Arc<NetworkGraph<Arc<dyn Logger>>>, Arc<dyn chain::Access>, Arc<dyn Logger>>>, IgnoringMessageHandler, Arc<dyn Logger>, IgnoringMessageHandler>;
185+
Arc<TestBroadcaster>, Arc<KeyProvider>, Arc<FuzzEstimator>, &'a FuzzRouter, Arc<dyn Logger>>;
186+
type PeerMan<'a> = PeerManager<Peer<'a>, Arc<ChannelMan<'a>>, Arc<P2PGossipSync<Arc<NetworkGraph<Arc<dyn Logger>>>, Arc<dyn chain::Access>, Arc<dyn Logger>>>, IgnoringMessageHandler, Arc<dyn Logger>, IgnoringMessageHandler>;
169187

170188
struct MoneyLossDetector<'a> {
171-
manager: Arc<ChannelMan>,
189+
manager: Arc<ChannelMan<'a>>,
172190
monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
173191
handler: PeerMan<'a>,
174192

@@ -182,7 +200,7 @@ struct MoneyLossDetector<'a> {
182200
}
183201
impl<'a> MoneyLossDetector<'a> {
184202
pub fn new(peers: &'a RefCell<[bool; 256]>,
185-
manager: Arc<ChannelMan>,
203+
manager: Arc<ChannelMan<'a>>,
186204
monitor: Arc<chainmonitor::ChainMonitor<EnforcingSigner, Arc<dyn chain::Filter>, Arc<TestBroadcaster>, Arc<FuzzEstimator>, Arc<dyn Logger>, Arc<TestPersister>>>,
187205
handler: PeerMan<'a>) -> Self {
188206
MoneyLossDetector {
@@ -380,6 +398,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
380398
let fee_est = Arc::new(FuzzEstimator {
381399
input: input.clone(),
382400
});
401+
let router = FuzzRouter {};
383402

384403
macro_rules! get_slice {
385404
($len: expr) => {
@@ -424,7 +443,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
424443
network,
425444
best_block: BestBlock::from_genesis(network),
426445
};
427-
let channelmanager = Arc::new(ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params));
446+
let channelmanager = Arc::new(ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), &router, Arc::clone(&logger), keys_manager.clone(), config, params));
428447
// Adding new calls to `KeysInterface::get_secure_random_bytes` during startup can change all the
429448
// keys subsequently generated in this test. Rather than regenerating all the messages manually,
430449
// it's easier to just increment the counter here so the keys don't change.

‎lightning-background-processor/src/lib.rs

+19-12
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ use lightning::ln::channelmanager::ChannelManager;
2222
use lightning::ln::msgs::{ChannelMessageHandler, OnionMessageHandler, RoutingMessageHandler};
2323
use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescriptor};
2424
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
25+
use lightning::routing::router::Router;
2526
use lightning::routing::scoring::WriteableScore;
2627
use lightning::util::events::{Event, EventHandler, EventsProvider};
2728
use lightning::util::logger::Logger;
@@ -342,6 +343,7 @@ pub async fn process_events_async<
342343
T: 'static + Deref + Send + Sync,
343344
K: 'static + Deref + Send + Sync,
344345
F: 'static + Deref + Send + Sync,
346+
R: 'static + Deref + Send + Sync,
345347
G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
346348
L: 'static + Deref + Send + Sync,
347349
P: 'static + Deref + Send + Sync,
@@ -353,7 +355,7 @@ pub async fn process_events_async<
353355
EventHandler: Fn(Event) -> EventHandlerFuture,
354356
PS: 'static + Deref + Send,
355357
M: 'static + Deref<Target = ChainMonitor<<K::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
356-
CM: 'static + Deref<Target = ChannelManager<CW, T, K, F, L>> + Send + Sync,
358+
CM: 'static + Deref<Target = ChannelManager<CW, T, K, F, R, L>> + Send + Sync,
357359
PGS: 'static + Deref<Target = P2PGossipSync<G, CA, L>> + Send + Sync,
358360
RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
359361
UMH: 'static + Deref + Send + Sync,
@@ -374,13 +376,14 @@ where
374376
T::Target: 'static + BroadcasterInterface,
375377
K::Target: 'static + KeysInterface,
376378
F::Target: 'static + FeeEstimator,
379+
R::Target: 'static + Router,
377380
L::Target: 'static + Logger,
378381
P::Target: 'static + Persist<<K::Target as SignerProvider>::Signer>,
379382
CMH::Target: 'static + ChannelMessageHandler,
380383
OMH::Target: 'static + OnionMessageHandler,
381384
RMH::Target: 'static + RoutingMessageHandler,
382385
UMH::Target: 'static + CustomMessageHandler,
383-
PS::Target: 'static + Persister<'a, CW, T, K, F, L, SC>,
386+
PS::Target: 'static + Persister<'a, CW, T, K, F, R, L, SC>,
384387
{
385388
let mut should_break = true;
386389
let async_event_handler = |event| {
@@ -460,6 +463,7 @@ impl BackgroundProcessor {
460463
T: 'static + Deref + Send + Sync,
461464
K: 'static + Deref + Send + Sync,
462465
F: 'static + Deref + Send + Sync,
466+
R: 'static + Deref + Send + Sync,
463467
G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
464468
L: 'static + Deref + Send + Sync,
465469
P: 'static + Deref + Send + Sync,
@@ -470,7 +474,7 @@ impl BackgroundProcessor {
470474
EH: 'static + EventHandler + Send,
471475
PS: 'static + Deref + Send,
472476
M: 'static + Deref<Target = ChainMonitor<<K::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
473-
CM: 'static + Deref<Target = ChannelManager<CW, T, K, F, L>> + Send + Sync,
477+
CM: 'static + Deref<Target = ChannelManager<CW, T, K, F, R, L>> + Send + Sync,
474478
PGS: 'static + Deref<Target = P2PGossipSync<G, CA, L>> + Send + Sync,
475479
RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
476480
UMH: 'static + Deref + Send + Sync,
@@ -488,13 +492,14 @@ impl BackgroundProcessor {
488492
T::Target: 'static + BroadcasterInterface,
489493
K::Target: 'static + KeysInterface,
490494
F::Target: 'static + FeeEstimator,
495+
R::Target: 'static + Router,
491496
L::Target: 'static + Logger,
492497
P::Target: 'static + Persist<<K::Target as SignerProvider>::Signer>,
493498
CMH::Target: 'static + ChannelMessageHandler,
494499
OMH::Target: 'static + OnionMessageHandler,
495500
RMH::Target: 'static + RoutingMessageHandler,
496501
UMH::Target: 'static + CustomMessageHandler,
497-
PS::Target: 'static + Persister<'a, CW, T, K, F, L, SC>,
502+
PS::Target: 'static + Persister<'a, CW, T, K, F, R, L, SC>,
498503
{
499504
let stop_thread = Arc::new(AtomicBool::new(false));
500505
let stop_thread_clone = stop_thread.clone();
@@ -579,6 +584,7 @@ mod tests {
579584
use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
580585
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
581586
use lightning::routing::router::DefaultRouter;
587+
use lightning::routing::scoring::{ProbabilisticScoringParameters, ProbabilisticScorer};
582588
use lightning::util::config::UserConfig;
583589
use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
584590
use lightning::util::ser::Writeable;
@@ -593,7 +599,6 @@ mod tests {
593599
use std::time::Duration;
594600
use bitcoin::hashes::Hash;
595601
use bitcoin::TxMerkleNode;
596-
use lightning::routing::scoring::{FixedPenaltyScorer};
597602
use lightning_rapid_gossip_sync::RapidGossipSync;
598603
use super::{BackgroundProcessor, GossipSync, FRESHNESS_TIMER};
599604

@@ -625,7 +630,7 @@ mod tests {
625630
network_graph: Arc<NetworkGraph<Arc<test_utils::TestLogger>>>,
626631
logger: Arc<test_utils::TestLogger>,
627632
best_block: BestBlock,
628-
scorer: Arc<Mutex<FixedPenaltyScorer>>,
633+
scorer: Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestLogger>>>>,
629634
}
630635

631636
impl Node {
@@ -722,24 +727,26 @@ mod tests {
722727
for i in 0..num_nodes {
723728
let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
724729
let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
725-
let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
726730
let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
727-
let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
728-
let seed = [i as u8; 32];
729731
let network = Network::Testnet;
730732
let genesis_block = genesis_block(network);
733+
let network_graph = Arc::new(NetworkGraph::new(genesis_block.header.block_hash(), logger.clone()));
734+
let params = ProbabilisticScoringParameters::default();
735+
let scorer = Arc::new(Mutex::new(ProbabilisticScorer::new(params, network_graph.clone(), logger.clone())));
736+
let seed = [i as u8; 32];
737+
let router = Arc::new(DefaultRouter::new(network_graph.clone(), logger.clone(), seed, scorer.clone()));
738+
let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
739+
let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
731740
let now = Duration::from_secs(genesis_block.header.time as u64);
732741
let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
733742
let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
734743
let best_block = BestBlock::from_genesis(network);
735744
let params = ChainParameters { network, best_block };
736-
let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
737-
let network_graph = Arc::new(NetworkGraph::new(genesis_block.header.block_hash(), logger.clone()));
745+
let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), router.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
738746
let p2p_gossip_sync = Arc::new(P2PGossipSync::new(network_graph.clone(), Some(chain_source.clone()), logger.clone()));
739747
let rapid_gossip_sync = Arc::new(RapidGossipSync::new(network_graph.clone()));
740748
let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new()), onion_message_handler: IgnoringMessageHandler{}};
741749
let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(Recipient::Node).unwrap(), 0, &seed, logger.clone(), IgnoringMessageHandler{}));
742-
let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
743750
let node = Node { node: manager, p2p_gossip_sync, rapid_gossip_sync, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block, scorer };
744751
nodes.push(node);
745752
}

‎lightning-block-sync/src/init.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
4949
/// use lightning::chain::chaininterface::FeeEstimator;
5050
/// use lightning::chain::keysinterface;
5151
/// use lightning::chain::keysinterface::KeysInterface;
52-
/// use lightning::ln::channelmanager::ChannelManager;
53-
/// use lightning::ln::channelmanager::ChannelManagerReadArgs;
52+
/// use lightning::ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
53+
/// use lightning::routing::router::Router;
5454
/// use lightning::util::config::UserConfig;
5555
/// use lightning::util::logger::Logger;
5656
/// use lightning::util::ser::ReadableArgs;
@@ -64,6 +64,7 @@ BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
6464
/// K: KeysInterface,
6565
/// T: BroadcasterInterface,
6666
/// F: FeeEstimator,
67+
/// R: Router,
6768
/// L: Logger,
6869
/// C: chain::Filter,
6970
/// P: chainmonitor::Persist<K::Signer>,
@@ -74,6 +75,7 @@ BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
7475
/// keys_manager: &K,
7576
/// tx_broadcaster: &T,
7677
/// fee_estimator: &F,
78+
/// router: &R,
7779
/// logger: &L,
7880
/// persister: &P,
7981
/// ) {
@@ -90,11 +92,12 @@ BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
9092
/// fee_estimator,
9193
/// chain_monitor,
9294
/// tx_broadcaster,
95+
/// router,
9396
/// logger,
9497
/// config,
9598
/// vec![&mut monitor],
9699
/// );
97-
/// <(BlockHash, ChannelManager<&ChainMonitor<K::Signer, &C, &T, &F, &L, &P>, &T, &K, &F, &L>)>::read(
100+
/// <(BlockHash, ChannelManager<&ChainMonitor<K::Signer, &C, &T, &F, &L, &P>, &T, &K, &F, &R, &L>)>::read(
98101
/// &mut Cursor::new(&serialized_manager), read_args).unwrap()
99102
/// };
100103
///

0 commit comments

Comments
 (0)