Skip to content

Use &mut self in invoice updaters, not take-self-return-Self #1331

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2022
Merged

Use &mut self in invoice updaters, not take-self-return-Self #1331

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions lightning-invoice/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,9 +610,9 @@ impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T,
impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False> {
/// Sets the payment secret and relevant features.
pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True> {
let features = InvoiceFeatures::empty()
.set_variable_length_onion_required()
.set_payment_secret_required();
let mut features = InvoiceFeatures::empty();
features.set_variable_length_onion_required();
features.set_payment_secret_required();
self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
self.tagged_fields.push(TaggedField::Features(features));
self.set_flags()
Expand All @@ -622,13 +622,11 @@ impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T,
impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True> {
/// Sets the `basic_mpp` feature as optional.
pub fn basic_mpp(mut self) -> Self {
self.tagged_fields = self.tagged_fields
.drain(..)
.map(|field| match field {
TaggedField::Features(f) => TaggedField::Features(f.set_basic_mpp_optional()),
_ => field,
})
.collect();
for field in self.tagged_fields.iter_mut() {
if let TaggedField::Features(f) = field {
f.set_basic_mpp_optional();
}
}
self
}
}
Expand Down
28 changes: 16 additions & 12 deletions lightning/src/ln/features.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,15 +318,13 @@ mod sealed {

impl <T: $feature> Features<T> {
/// Set this feature as optional.
pub fn $optional_setter(mut self) -> Self {
pub fn $optional_setter(&mut self) {
<T as $feature>::set_optional_bit(&mut self.flags);
self
}

/// Set this feature as required.
pub fn $required_setter(mut self) -> Self {
pub fn $required_setter(&mut self) {
<T as $feature>::set_required_bit(&mut self.flags);
self
}
Comment on lines -321 to 328
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we still support the chained-notation by taking a &mut self and returning &Self?

Copy link
Collaborator Author

@TheBlueMatt TheBlueMatt Feb 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I'd tried that and realized you still have to declare the variable but you're right, you can at least then be able to chain two setters which is nice. That said, its hard to map that in language bindings, cause we don't have first-class support for references in client languages.

Copy link
Contributor

Choose a reason for hiding this comment

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

In addition to the updated mutators, I wonder if we should have a different notation for initialization. Something like:

let features = InvoiceFeatures:from_bits(VariableLengthOnion::required() | PaymentSecret::required());

Would still need to do it in such away that it could be checked at compile time, of course.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yea, that'd be cool, I'd think we'd have to use macros, tho maybe we can override |, as ugly as that is.


/// Checks if this feature is supported.
Expand Down Expand Up @@ -506,7 +504,9 @@ impl InvoiceFeatures {
/// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
/// [`find_route`]: crate::routing::router::find_route
pub(crate) fn for_keysend() -> InvoiceFeatures {
InvoiceFeatures::empty().set_variable_length_onion_optional()
let mut res = InvoiceFeatures::empty();
res.set_variable_length_onion_optional();
res
}
}

Expand Down Expand Up @@ -838,11 +838,13 @@ mod tests {
assert!(!features.requires_unknown_bits());
assert!(!features.supports_unknown_bits());

let features = ChannelFeatures::empty().set_unknown_feature_required();
let mut features = ChannelFeatures::empty();
features.set_unknown_feature_required();
assert!(features.requires_unknown_bits());
assert!(features.supports_unknown_bits());

let features = ChannelFeatures::empty().set_unknown_feature_optional();
let mut features = ChannelFeatures::empty();
features.set_unknown_feature_optional();
assert!(!features.requires_unknown_bits());
assert!(features.supports_unknown_bits());
}
Expand Down Expand Up @@ -886,17 +888,18 @@ mod tests {
fn convert_to_context_with_unknown_flags() {
// Ensure the `from` context has fewer known feature bytes than the `to` context.
assert!(InvoiceFeatures::known().flags.len() < NodeFeatures::known().flags.len());
let invoice_features = InvoiceFeatures::known().set_unknown_feature_optional();
let mut invoice_features = InvoiceFeatures::known();
invoice_features.set_unknown_feature_optional();
assert!(invoice_features.supports_unknown_bits());
let node_features: NodeFeatures = invoice_features.to_context();
assert!(!node_features.supports_unknown_bits());
}

#[test]
fn set_feature_bits() {
let features = InvoiceFeatures::empty()
.set_basic_mpp_optional()
.set_payment_secret_required();
let mut features = InvoiceFeatures::empty();
features.set_basic_mpp_optional();
features.set_payment_secret_required();
assert!(features.supports_basic_mpp());
assert!(!features.requires_basic_mpp());
assert!(features.requires_payment_secret());
Expand Down Expand Up @@ -938,7 +941,8 @@ mod tests {
fn test_channel_type_mapping() {
// If we map an InvoiceFeatures with StaticRemoteKey optional, it should map into a
// required-StaticRemoteKey ChannelTypeFeatures.
let init_features = InitFeatures::empty().set_static_remote_key_optional();
let mut init_features = InitFeatures::empty();
init_features.set_static_remote_key_optional();
let converted_features = ChannelTypeFeatures::from_counterparty_init(&init_features);
assert_eq!(converted_features, ChannelTypeFeatures::only_static_remote_key());
assert!(!converted_features.supports_any_optional_bits());
Expand Down
3 changes: 2 additions & 1 deletion lightning/src/routing/router.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2369,7 +2369,8 @@ mod tests {
let scorer = test_utils::TestScorer::with_penalty(0);

// Disable nodes 1, 2, and 8 by requiring unknown feature bits
let unknown_features = NodeFeatures::known().set_unknown_feature_required();
let mut unknown_features = NodeFeatures::known();
unknown_features.set_unknown_feature_required();
add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[0], unknown_features.clone(), 1);
add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[1], unknown_features.clone(), 1);
add_or_update_node(&net_graph_msg_handler, &secp_ctx, &privkeys[7], unknown_features.clone(), 1);
Expand Down