Prepare for Payment Retries in ChannelManager#1862

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
TheBlueMatt merged 4 commits into from
Dec 1, 2022
Merged

Prepare for Payment Retries in ChannelManager#1862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
685b370
Move ScoringRouter methods to Router
valentinewallace Nov 16, 2022
5f49011
Fix typo in ScorerAccountingForInFlightHtlcs
valentinewallace Nov 17, 2022
3f9868f
Move ScorerAccountingForInFlightHtlcs to router + make public
valentinewallace Nov 21, 2022
8a51a79
Move DefaultRouter to router module
valentinewallace Nov 21, 2022
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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
use lightning::ln::msgs::{ChannelMessageHandler, Init};
use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::router::DefaultRouter;
use lightning::util::config::UserConfig;
use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
use lightning::util::ser::Writeable;
use lightning::util::test_utils;
use lightning::util::persist::KVStorePersister;
use lightning_invoice::payment::{InvoicePayer, Retry};
use lightning_invoice::utils::DefaultRouter;
use lightning_persister::FilesystemPersister;
use std::fs;
use std::path::PathBuf;
Expand Down
51 changes: 10 additions & 41 deletions lightning-invoice/src/payment.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
P: Deref,
R: ScoringRouter,
R: Router,
L: Deref,
E: sealed::BaseEventHandler,
T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
fn find_route_with_id(
&self, payer: &PublicKey, route_params: &RouteParameters,
first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
_payment_hash: PaymentHash, _payment_id: PaymentId
) -> Result<Route, LightningError> {
self.find_route(payer, route_params, first_hops, inflight_htlcs)
}
/// Lets the router know that payment through a specific path has failed.
fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
/// Lets the router know that payment through a specific path was successful.
fn notify_payment_path_successful(&self, path: &[&RouteHop]);
/// Lets the router know that a payment probe was successful.
fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
/// Lets the router know that a payment probe failed.
fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
InvoicePayerUsingTime<P, R, L, H, T>
where
P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
use super::*;
use crate::{InvoiceBuilder, Currency};
use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
use bitcoin_hashes::sha256::Hash as Sha256;
use lightning::ln::PaymentPreimage;
use lightning::ln::channelmanager;
use lightning::ln::features::{ChannelFeatures, NodeFeatures};
use lightning::ln::functional_test_utils::*;
use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
use lightning::routing::gossip::{EffectiveCapacity, NodeId};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};

@jkczyzjkczyzNov 30, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.

@valentinewallacevalentinewallaceNov 30, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?

use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::util::test_utils::TestLogger;
use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
})
}
}

impl ScoringRouter for TestRouter {
fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
self.scorer.lock().payment_path_failed(path, short_channel_id);
}
Expand All@@ -1755,9 +1727,7 @@ mod tests {
) -> Result<Route, LightningError> {
Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
}
}

impl ScoringRouter for FailingRouter {
fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
) -> Result<Route, LightningError> {
self.0.borrow_mut().pop_front().unwrap()
}
}
impl ScoringRouter for ManualRouter {

fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down
125 changes: 4 additions & 121 deletions lightning-invoice/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
.collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
L::Target: Logger,
S::Target: for <'a> LockableScore<'a>,
{
network_graph: G,
logger: L,
random_seed_bytes: Mutex<[u8; 32]>,
scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
L::Target: Logger,
S::Target: for <'a> LockableScore<'a>,
{
/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
/// `random_seed_bytes`.
pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
let random_seed_bytes = Mutex::new(random_seed_bytes);
Self { network_graph, logger, random_seed_bytes, scorer }
}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
L::Target: Logger,
S::Target: for <'a> LockableScore<'a>,
{
fn find_route(
&self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
inflight_htlcs: InFlightHtlcs
) -> Result<Route, LightningError> {
let random_seed_bytes = {
let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
*locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
*locked_random_seed_bytes
};

find_route(
payer, params, &self.network_graph, first_hops, &*self.logger,
&ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
&random_seed_bytes
)
}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
L::Target: Logger,
S::Target: for <'a> LockableScore<'a>,
{
fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
self.scorer.lock().payment_path_failed(path, short_channel_id);
}

fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
self.scorer.lock().payment_path_successful(path);
}

fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
self.scorer.lock().probe_successful(path);
}

fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
self.scorer.lock().probe_failed(path, short_channel_id);
}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
scorer: &'a mut S,
/// Maps a channel's short channel id and its direction to the liquidity used up.
inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
ScorerAccountingForInFlightHtlcs {
scorer,
inflight_htlcs
}
}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
source, target, short_channel_id
) {
let usage = ChannelUsage {
inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
..usage
};

self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
} else {
self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
}
}

fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
use core::time::Duration;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Prepare for Payment Retries in ChannelManager#1862

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

TheBlueMatt
merged 4 commits into

from

Dec 1, 2022
 Merged


Prepare for Payment Retries in ChannelManager#1862
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
685b370

Move ScoringRouter methods to Router


valentinewallace Nov 16, 2022
5f49011

Fix typo in ScorerAccountingForInFlightHtlcs


valentinewallace Nov 17, 2022
3f9868f

Move ScorerAccountingForInFlightHtlcs to router + make public


valentinewallace Nov 21, 2022
8a51a79

Move DefaultRouter to router module


valentinewallace Nov 21, 2022

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 numberDiff line numberDiff line change
Expand Up@@ -580,13 +580,13 @@ mod tests {
	use lightning::ln::msgs::{ChannelMessageHandler, Init};
	use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
	use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
	use lightning::routing::router::DefaultRouter;
	use lightning::util::config::UserConfig;
	use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, Retry};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::path::PathBuf;
Expand Down

51 changes: 10 additions & 41 deletions
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//! # use lightning::util::logger::{Logger, Record};
//! # use lightning::util::ser::{Writeable, Writer};
//! # use lightning_invoice::Invoice;
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, ScoringRouter};
//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry};
//! # use secp256k1::PublicKey;
//! # use std::cell::RefCell;
//! # use std::ops::Deref;
Expand DownExpand Up@@ -78,8 +78,6 @@
//! # &self, payer: &PublicKey, params: &RouteParameters,
//! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
//! # ) -> Result<Route, LightningError> { unimplemented!() }
//! # }
//! # impl ScoringRouter for FakeRouter {
//! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
//! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
//! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
Expand DownExpand Up@@ -146,7 +144,7 @@ use crate::prelude::*;
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
use lightning::ln::msgs::LightningError;
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, Router};
use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters, Router};
use lightning::util::events::{Event, EventHandler};
use lightning::util::logger::Logger;
use crate::time_utils::Time;
Expand DownExpand Up@@ -186,7 +184,7 @@ mod sealed {
/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
pub struct InvoicePayerUsingTime<
	P: Deref,
	R: ScoringRouter,
	R: Router,
	L: Deref,
	E: sealed::BaseEventHandler,
	T: Time
Expand DownExpand Up@@ -279,30 +277,6 @@ pub trait Payer {
	fn inflight_htlcs(&self) -> InFlightHtlcs;
}

/// A trait defining behavior for a [`Router`] implementation that also supports scoring channels
/// based on payment and probe success/failure.
///
/// [`Router`]: lightning::routing::router::Router
pub trait ScoringRouter: Router {
	/// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes
	/// `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment.
	fn find_route_with_id(
 &self, payer: &PublicKey, route_params: &RouteParameters,
 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs,
 _payment_hash: PaymentHash, _payment_id: PaymentId
	) -> Result<Route, LightningError> {
 self.find_route(payer, route_params, first_hops, inflight_htlcs)
	}
	/// Lets the router know that payment through a specific path has failed.
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
	/// Lets the router know that payment through a specific path was successful.
	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe was successful.
	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
	/// Lets the router know that a payment probe failed.
	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
}

/// Strategies available to retry payment path failures for an [`Invoice`].
///
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
Expand DownExpand Up@@ -342,7 +316,7 @@ pub enum PaymentError {
	Sending(PaymentSendFailure),
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -656,7 +630,7 @@ fn has_expired(route_params: &RouteParameters) -> bool {
	} else { false }
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: sealed::BaseEventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: sealed::BaseEventHandler, T: Time>
	InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand DownExpand Up@@ -723,7 +697,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, E: EventHandler, T: Time>
impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
	EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
where
	P::Target: Payer,
Expand All@@ -737,7 +711,7 @@ where
	}
}

impl<P: Deref, R: ScoringRouter, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
impl<P: Deref, R: Router, L: Deref, T: Time, F: Future, H: Fn(Event) -> F>
	InvoicePayerUsingTime<P, R, L, H, T>
where
	P::Target: Payer,
Expand All@@ -757,15 +731,15 @@ where
mod tests {
	use super::*;
	use crate::{InvoiceBuilder, Currency};
	use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
	use crate::utils::create_invoice_from_channelmanager_and_duration_since_epoch;
	use bitcoin_hashes::sha256::Hash as Sha256;
	use lightning::ln::PaymentPreimage;
	use lightning::ln::channelmanager;
	use lightning::ln::features::{ChannelFeatures, NodeFeatures};
	use lightning::ln::functional_test_utils::*;
	use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
	use lightning::routing::gossip::{EffectiveCapacity, NodeId};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router};
	use lightning::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, Router, ScorerAccountingForInFlightHtlcs};
@jkczyzjkczyzNov 30, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little strange that we test ScorerAccountingForInFlightHtlcs in this crate still in considers_inflight_htlcs_between_retries. Probably should move the test.
@valentinewallacevalentinewallaceNov 30, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we save that since all of the tests are going to be moving soon?
	use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
	use lightning::util::test_utils::TestLogger;
	use lightning::util::errors::APIError;
Expand DownExpand Up@@ -1726,9 +1700,7 @@ mod tests {
 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
 })
 }
	}

	impl ScoringRouter for TestRouter {
 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
 }
Expand All@@ -1755,9 +1727,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 }
	}

	impl ScoringRouter for FailingRouter {
 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand DownExpand Up@@ -2045,8 +2015,7 @@ mod tests {
 ) -> Result<Route, LightningError> {
 self.0.borrow_mut().pop_front().unwrap()
 }
	}
	impl ScoringRouter for ManualRouter {

 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}

 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
Expand Down

125 changes: 4 additions & 121 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
//! Convenient utilities to create an invoice.

use crate::{CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError};
use crate::payment::{Payer, ScoringRouter};
use crate::payment::Payer;

use crate::{prelude::*, Description, InvoiceDescription, Sha256};
use bech32::ToBase32;
use bitcoin_hashes::{Hash, sha256};
use bitcoin_hashes::Hash;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, KeysInterface};
Expand All@@ -14,15 +14,12 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, P
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::ln::msgs::LightningError;
use lightning::routing::gossip::{NetworkGraph, NodeId, RoutingFees};
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop, RouteParameters, find_route, RouteHop, Router};
use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
use lightning::routing::gossip::RoutingFees;
use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
use lightning::util::logger::Logger;
use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;
use crate::sync::Mutex;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
Expand DownExpand Up@@ -524,72 +521,6 @@ fn filter_channels<L: Deref>(
 .collect::<Vec<RouteHint>>()
}

/// A [`Router`] implemented using [`find_route`].
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	network_graph: G,
	logger: L,
	random_seed_bytes: Mutex<[u8; 32]>,
	scorer: S
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	/// Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
	/// `random_seed_bytes`.
	pub fn new(network_graph: G, logger: L, random_seed_bytes: [u8; 32], scorer: S) -> Self {
 let random_seed_bytes = Mutex::new(random_seed_bytes);
 Self { network_graph, logger, random_seed_bytes, scorer }
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn find_route(
 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 inflight_htlcs: InFlightHtlcs
	) -> Result<Route, LightningError> {
 let random_seed_bytes = {
 let mut locked_random_seed_bytes = self.random_seed_bytes.lock().unwrap();
 *locked_random_seed_bytes = sha256::Hash::hash(&*locked_random_seed_bytes).into_inner();
 *locked_random_seed_bytes
 };

 find_route(
 payer, params, &self.network_graph, first_hops, &*self.logger,
 &ScorerAccountingForInFlightHtlcs::new(&mut self.scorer.lock(), inflight_htlcs),
 &random_seed_bytes
 )
	}
}

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> ScoringRouter for DefaultRouter<G, L, S> where
	L::Target: Logger,
	S::Target: for <'a> LockableScore<'a>,
{
	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().payment_path_failed(path, short_channel_id);
	}

	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().payment_path_successful(path);
	}

	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
 self.scorer.lock().probe_successful(path);
	}

	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
 self.scorer.lock().probe_failed(path, short_channel_id);
	}
}

impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Payer for ChannelManager<M, T, K, F, L>
where
	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
Expand DownExpand Up@@ -632,54 +563,6 @@ where
	fn inflight_htlcs(&self) -> InFlightHtlcs { self.compute_inflight_htlcs() }
}


/// Used to store information about all the HTLCs that are inflight across all payment attempts.
pub(crate) struct ScorerAccountingForInFlightHtlcs<'a, S: Score> {
	scorer: &'a mut S,
	/// Maps a channel's short channel id and its direction to the liquidity used up.
	inflight_htlcs: InFlightHtlcs,
}

impl<'a, S: Score> ScorerAccountingForInFlightHtlcs<'a, S> {
	pub(crate) fn new(scorer: &'a mut S, inflight_htlcs: InFlightHtlcs) -> Self {
 ScorerAccountingForInFlightHtlcs {
 scorer,
 inflight_htlcs
 }
	}
}

#[cfg(c_bindings)]
impl<'a, S:Score> lightning::util::ser::Writeable for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> { self.scorer.write(writer) }
}

impl<'a, S: Score> Score for ScorerAccountingForInFlightHtlcs<'a, S> {
	fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 {
 if let Some(used_liqudity) = self.inflight_htlcs.used_liquidity_msat(
 source, target, short_channel_id
 ) {
 let usage = ChannelUsage {
 inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity,
 ..usage
 };

 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 } else {
 self.scorer.channel_penalty_msat(short_channel_id, source, target, usage)
 }
	}

	fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn payment_path_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }

	fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) { unreachable!() }

	fn probe_successful(&mut self, _path: &[&RouteHop]) { unreachable!() }
}


#[cfg(test)]
mod test {
	use core::time::Duration;
Expand Down
Loading