Introduce RouteParametersConfig #3342
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,7 +57,7 @@ use crate::types::features::{Bolt12InvoiceFeatures, ChannelFeatures, ChannelType | |
| use crate::types::features::Bolt11InvoiceFeatures; | ||
| #[cfg(trampoline)] | ||
| use crate::routing::gossip::NodeId; | ||
| use crate::routing::router::{BlindedTail, FixedRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, RouteParametersConfig, Router}; | ||
| use crate::ln::onion_payment::{check_incoming_htlc_cltv, create_recv_pending_htlc_info, create_fwd_pending_htlc_info, decode_incoming_update_add_htlc_onion, InboundHTLCErr, NextPacketDetails}; | ||
| use crate::ln::msgs; | ||
| use crate::ln::onion_utils; | ||
|
|
@@ -2096,6 +2096,7 @@ where | |
| /// # use lightning::events::{Event, EventsProvider, PaymentPurpose}; | ||
| /// # use lightning::ln::channelmanager::AChannelManager; | ||
| /// # use lightning::offers::parse::Bolt12SemanticError; | ||
| /// # use lightning::routing::router::RouteParametersConfig; | ||
| /// # | ||
| /// # fn example<T: AChannelManager>(channel_manager: T) -> Result<(), Bolt12SemanticError> { | ||
| /// # let channel_manager = channel_manager.get_cm(); | ||
|
|
@@ -2143,15 +2144,16 @@ where | |
| /// # use lightning::events::{Event, EventsProvider}; | ||
| /// # use lightning::ln::channelmanager::{AChannelManager, PaymentId, RecentPaymentDetails, Retry}; | ||
| /// # use lightning::offers::offer::Offer; | ||
| /// # use lightning::routing::router::RouteParametersConfig; | ||
| /// # | ||
| /// # fn example<T: AChannelManager>( | ||
| /// # channel_manager: T, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>, | ||
| /// # payer_note: Option<String>, retry: Retry, route_params_config: RouteParametersConfig | ||
| /// # ) { | ||
| /// # let channel_manager = channel_manager.get_cm(); | ||
| /// let payment_id = PaymentId([42; 32]); | ||
| /// match channel_manager.pay_for_offer( | ||
| /// offer, quantity, amount_msats, payer_note, payment_id, retry, route_params_config | ||
| /// ) { | ||
| /// Ok(()) => println!("Requesting invoice for offer"), | ||
| /// Err(e) => println!("Unable to request invoice for offer: {:?}", e), | ||
|
|
@@ -2199,16 +2201,17 @@ where | |
| /// # use lightning::events::{Event, EventsProvider}; | ||
| /// # use lightning::ln::channelmanager::{AChannelManager, PaymentId, RecentPaymentDetails, Retry}; | ||
| /// # use lightning::offers::parse::Bolt12SemanticError; | ||
| /// # use lightning::routing::router::RouteParametersConfig; | ||
| /// # | ||
| /// # fn example<T: AChannelManager>( | ||
| /// # channel_manager: T, amount_msats: u64, absolute_expiry: Duration, retry: Retry, | ||
| /// # route_params_config: RouteParametersConfig | ||
| /// # ) -> Result<(), Bolt12SemanticError> { | ||
| /// # let channel_manager = channel_manager.get_cm(); | ||
| /// let payment_id = PaymentId([42; 32]); | ||
| /// let refund = channel_manager | ||
| /// .create_refund_builder( | ||
| /// amount_msats, absolute_expiry, payment_id, retry, route_params_config | ||
| /// )? | ||
| /// # ; | ||
| /// # // Needed for compiling for c_bindings | ||
|
|
@@ -9983,7 +9986,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => { | |
| /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments | ||
| pub fn create_refund_builder( | ||
| &$self, amount_msats: u64, absolute_expiry: Duration, payment_id: PaymentId, | ||
| retry_strategy: Retry, route_params_config: RouteParametersConfig | ||
| ) -> Result<$builder, Bolt12SemanticError> { | ||
| let node_id = $self.get_our_node_id(); | ||
| let expanded_key = &$self.inbound_payment_key; | ||
|
|
@@ -10008,7 +10011,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => { | |
| let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry); | ||
| $self.pending_outbound_payments | ||
| .add_new_awaiting_invoice( | ||
| payment_id, expiration, retry_strategy, route_params_config, None, | ||
| ) | ||
| .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?; | ||
|
|
||
|
|
@@ -10184,7 +10187,7 @@ where | |
| pub fn pay_for_offer( | ||
| &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>, | ||
| payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry, | ||
| route_params_config: RouteParametersConfig | ||
| ) -> Result<(), Bolt12SemanticError> { | ||
|
There was a problem hiding this comment. OK no needed option here but: what do you think about having the function call like struct OfferParams {
quantity: Option<u64>,
amount_msats: Option<u64>,
manual_routing_params: Option<ManualRoutingParameters>,
}I think is a lot of more verbose in this way, but I also this that this will be a lot of cleaner. Now I do not think this will fit well in this PR maybe can be a followup one, but with this patter, it is possible to hide future updates to offers (e.g: recurrence or market place feature) without breaking too much the code There was a problem hiding this comment. I think this is a great improvement! It will help keep the function signature cleaner while remaining maintainable for future parameter increases. Maybe we can take this in a follow-up. @TheBlueMatt, what do you think? |
||
| self.pay_for_offer_intern(offer, quantity, amount_msats, payer_note, payment_id, None, |invoice_request, nonce| { | ||
| let expiration = StaleExpiration::TimerTicks(1); | ||
|
|
@@ -10195,7 +10198,7 @@ where | |
| }; | ||
| self.pending_outbound_payments | ||
| .add_new_awaiting_invoice( | ||
| payment_id, expiration, retry_strategy, route_params_config, | ||
| Some(retryable_invoice_request) | ||
| ) | ||
| .map_err(|_| Bolt12SemanticError::DuplicatePaymentId) | ||
|
|
@@ -10428,14 +10431,14 @@ where | |
| #[cfg(feature = "dnssec")] | ||
| pub fn pay_for_offer_from_human_readable_name( | ||
| &self, name: HumanReadableName, amount_msats: u64, payment_id: PaymentId, | ||
| retry_strategy: Retry, route_params_config: RouteParametersConfig, | ||
| dns_resolvers: Vec<Destination>, | ||
| ) -> Result<(), ()> { | ||
| let (onion_message, context) = | ||
| self.hrn_resolver.resolve_name(payment_id, name, &*self.entropy_source)?; | ||
| let reply_paths = self.create_blinded_paths(MessageContext::DNSResolver(context))?; | ||
| let expiration = StaleExpiration::TimerTicks(1); | ||
| self.pending_outbound_payments.add_new_awaiting_offer(payment_id, expiration, retry_strategy, route_params_config, amount_msats)?; | ||
| let message_params = dns_resolvers | ||
| .iter() | ||
| .flat_map(|destination| reply_paths.iter().map(move |path| (path, destination))) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: For stuff like this where rustfmt requires we blow up our code to cover 20 lines we should really create intermediate variables to see if we can avoid it.