Skip to content

Make InvoicePayer's Router Deref #1960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 17, 2023
Merged

Make InvoicePayer's Router Deref #1960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1133,7 +1133,7 @@ mod tests {
// Initiate the background processors to watch each node.
let data_dir = nodes[0].persister.get_data_dir();
let persister = Arc::new(Persister::new(data_dir));
let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes, Arc::clone(&nodes[0].scorer));
let router = Arc::new(DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes, Arc::clone(&nodes[0].scorer)));
let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, Arc::clone(&nodes[0].logger), |_: _| {}, Retry::Attempts(2)));
let event_handler = Arc::clone(&invoice_payer);
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
Expand Down
66 changes: 35 additions & 31 deletions lightning-invoice/src/payment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
//! # let router = FakeRouter {};
//! # let scorer = RefCell::new(FakeScorer {});
//! # let logger = FakeLogger {};
//! let invoice_payer = InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
//! let invoice_payer = InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));
//!
//! let invoice = "...";
//! if let Ok(invoice) = invoice.parse::<Invoice>() {
Expand Down Expand Up @@ -184,12 +184,13 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
P: Deref,
R: Router,
R: Deref,
L: Deref,
E: sealed::BaseEventHandler,
T: Time
> where
P::Target: Payer,
R::Target: Router,
L::Target: Logger,
{
payer: P,
Expand Down Expand Up @@ -316,10 +317,11 @@ pub enum PaymentError {
Sending(PaymentSendFailure),
}

impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Deref, L: Deref, E: sealed::BaseEventHandler, T: Time>
InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
R::Target: Router,
L::Target: Logger,
{
/// Creates an invoice payer that retries failed payment paths.
Expand Down Expand Up @@ -630,10 +632,11 @@ fn has_expired(route_params: &RouteParameters) -> bool {
} else { false }
}

impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Deref, L: Deref, E: sealed::BaseEventHandler, T: Time>
InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
R::Target: Router,
L::Target: Logger,
{
/// Returns a bool indicating whether the processed event should be forwarded to a user-provided
Expand Down Expand Up @@ -697,10 +700,11 @@ where
}
}

impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Deref, L: Deref, E: EventHandler, T: Time>
EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
R::Target: Router,
L::Target: Logger,
{
fn handle_event(&self, event: Event) {
Expand All @@ -711,10 +715,11 @@ where
}
}

impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Deref, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
InvoicePayerUsingTime<P, R, L, H, T>
where
P::Target: Payer,
R::Target: Router,
L::Target: Logger,
{
/// Intercepts events required by the [`InvoicePayer`] and forwards them to the underlying event
Expand Down Expand Up @@ -746,7 +751,6 @@ mod tests {
use secp256k1::{SecretKey, PublicKey, Secp256k1};
use std::cell::RefCell;
use std::collections::VecDeque;
use std::ops::DerefMut;
use std::time::{SystemTime, Duration};
use crate::time_utils::tests::SinceEpoch;
use crate::DEFAULT_EXPIRY_TIME;
Expand Down Expand Up @@ -831,7 +835,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(0));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -859,7 +863,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -903,7 +907,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

assert!(invoice_payer.pay_invoice(&invoice).is_ok());
}
Expand All @@ -924,7 +928,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(PaymentId([1; 32]));
let event = Event::PaymentPathFailed {
Expand Down Expand Up @@ -968,7 +972,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1027,7 +1031,7 @@ mod tests {
type InvoicePayerUsingSinceEpoch <P, R, L, E> = InvoicePayerUsingTime::<P, R, L, E, SinceEpoch>;

let invoice_payer =
InvoicePayerUsingSinceEpoch::new(&payer, router, &logger, event_handler, Retry::Timeout(Duration::from_secs(120)));
InvoicePayerUsingSinceEpoch::new(&payer, &router, &logger, event_handler, Retry::Timeout(Duration::from_secs(120)));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1066,7 +1070,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1097,7 +1101,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_preimage = PaymentPreimage([1; 32]);
let invoice = expired_invoice(payment_preimage);
Expand All @@ -1121,7 +1125,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1161,7 +1165,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1194,7 +1198,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
assert_eq!(*payer.attempts.borrow(), 1);
Expand Down Expand Up @@ -1229,7 +1233,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(0));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());

Expand Down Expand Up @@ -1267,7 +1271,7 @@ mod tests {
let router = FailingRouter {};
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, |_: Event| {}, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, |_: Event| {}, Retry::Attempts(0));

let payment_preimage = PaymentPreimage([1; 32]);
let invoice = invoice(payment_preimage);
Expand All @@ -1290,7 +1294,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, |_: Event| {}, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, |_: Event| {}, Retry::Attempts(0));

match invoice_payer.pay_invoice(&invoice) {
Err(PaymentError::Sending(_)) => {},
Expand All @@ -1313,7 +1317,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(0));

let payment_id =
Some(invoice_payer.pay_zero_value_invoice(&invoice, final_value_msat).unwrap());
Expand All @@ -1335,7 +1339,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(0));

let payment_preimage = PaymentPreimage([1; 32]);
let invoice = invoice(payment_preimage);
Expand Down Expand Up @@ -1365,7 +1369,7 @@ mod tests {
let router = TestRouter::new(TestScorer::new());
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_pubkey(
pubkey, payment_preimage, final_value_msat, final_cltv_expiry_delta
Expand Down Expand Up @@ -1420,7 +1424,7 @@ mod tests {
let router = TestRouter::new(scorer);
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
let event = Event::PaymentPathFailed {
Expand Down Expand Up @@ -1455,7 +1459,7 @@ mod tests {
let router = TestRouter::new(scorer);
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

let payment_id = invoice_payer.pay_invoice(&invoice).unwrap();
let event = Event::PaymentPathSuccessful {
Expand Down Expand Up @@ -1498,7 +1502,7 @@ mod tests {
let router = TestRouter::new(scorer);
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(0));

// Make first invoice payment.
invoice_payer.pay_invoice(&payment_invoice).unwrap();
Expand Down Expand Up @@ -1552,7 +1556,7 @@ mod tests {
let router = TestRouter::new(scorer);
let logger = TestLogger::new();
let invoice_payer =
InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
InvoicePayer::new(&payer, &router, &logger, event_handler, Retry::Attempts(2));

// Fail 1st path, leave 2nd path inflight
let payment_id = Some(invoice_payer.pay_invoice(&payment_invoice).unwrap());
Expand Down Expand Up @@ -2077,7 +2081,7 @@ mod tests {
router.expect_find_route(Ok(route.clone()));

let event_handler = |_: Event| { panic!(); };
let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
let invoice_payer = InvoicePayer::new(nodes[0].node, &router, nodes[0].logger, event_handler, Retry::Attempts(1));

assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
&nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
Expand Down Expand Up @@ -2122,7 +2126,7 @@ mod tests {
router.expect_find_route(Ok(route.clone()));

let event_handler = |_: Event| { panic!(); };
let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
let invoice_payer = InvoicePayer::new(nodes[0].node, &router, nodes[0].logger, event_handler, Retry::Attempts(1));

assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
&nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
Expand Down Expand Up @@ -2203,7 +2207,7 @@ mod tests {
let event_checker = expected_events.borrow_mut().pop_front().unwrap();
event_checker(event);
};
let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
let invoice_payer = InvoicePayer::new(nodes[0].node, &router, nodes[0].logger, event_handler, Retry::Attempts(1));

assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
&nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
Expand Down