Skip to content

Commit e74f243

Browse files
jkczyzjkczyz
committed
Rename InvoicePayment to Bolt11InvoicePayment
PaymentPurpose will be expanded to include BOLT 12 payment context. Rename the InvoicePayment variant accordinly before new variants are added.
1 parent 09ce1b5 commit e74f243

File tree

7 files changed

+53
-49
lines changed

7 files changed

+53
-49
lines changed

‎lightning/src/events/mod.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ use crate::prelude::*;
4949
/// spontaneous payment or a "conventional" lightning payment that's paying an invoice.
5050
#[derive(Clone, Debug, PartialEq, Eq)]
5151
pub enum PaymentPurpose {
52-
/// Information for receiving a payment that we generated an invoice for.
53-
InvoicePayment {
52+
/// A payment for a BOLT 11 invoice.
53+
Bolt11InvoicePayment {
5454
/// The preimage to the payment_hash, if the payment hash (and secret) were fetched via
5555
/// [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
5656
/// [`ChannelManager::claim_funds`].
@@ -79,14 +79,14 @@ impl PaymentPurpose {
7979
/// Returns the preimage for this payment, if it is known.
8080
pub fn preimage(&self) -> Option<PaymentPreimage> {
8181
match self {
82-
PaymentPurpose::InvoicePayment { payment_preimage, .. } => *payment_preimage,
82+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => *payment_preimage,
8383
PaymentPurpose::SpontaneousPayment(preimage) => Some(*preimage),
8484
}
8585
}
8686
}
8787

8888
impl_writeable_tlv_based_enum!(PaymentPurpose,
89-
(0, InvoicePayment) => {
89+
(0, Bolt11InvoicePayment) => {
9090
(0, payment_preimage, option),
9191
(2, payment_secret, required),
9292
};
@@ -1059,7 +1059,9 @@ impl Writeable for Event {
10591059
let mut payment_secret = None;
10601060
let payment_preimage;
10611061
match &purpose {
1062-
PaymentPurpose::InvoicePayment { payment_preimage: preimage, payment_secret: secret } => {
1062+
PaymentPurpose::Bolt11InvoicePayment {
1063+
payment_preimage: preimage, payment_secret: secret
1064+
} => {
10631065
payment_secret = Some(secret);
10641066
payment_preimage = *preimage;
10651067
},
@@ -1325,7 +1327,7 @@ impl MaybeReadable for Event {
13251327
(10, counterparty_skimmed_fee_msat_opt, option),
13261328
});
13271329
let purpose = match payment_secret {
1328-
Some(secret) => PaymentPurpose::InvoicePayment {
1330+
Some(secret) => PaymentPurpose::Bolt11InvoicePayment {
13291331
payment_preimage,
13301332
payment_secret: secret
13311333
},

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,11 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
173173
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
174174
assert_eq!(via_channel_id, Some(channel_id));
175175
match &purpose {
176-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
176+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
177177
assert!(payment_preimage.is_none());
178178
assert_eq!(payment_secret_1, *payment_secret);
179179
},
180-
_ => panic!("expected PaymentPurpose::InvoicePayment")
180+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
181181
}
182182
},
183183
_ => panic!("Unexpected event"),
@@ -554,11 +554,11 @@ fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
554554
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
555555
assert_eq!(via_channel_id, Some(channel_id));
556556
match &purpose {
557-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
557+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
558558
assert!(payment_preimage.is_none());
559559
assert_eq!(payment_secret_2, *payment_secret);
560560
},
561-
_ => panic!("expected PaymentPurpose::InvoicePayment")
561+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
562562
}
563563
},
564564
_ => panic!("Unexpected event"),
@@ -672,11 +672,11 @@ fn test_monitor_update_fail_cs() {
672672
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
673673
assert_eq!(via_channel_id, Some(channel_id));
674674
match &purpose {
675-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
675+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
676676
assert!(payment_preimage.is_none());
677677
assert_eq!(our_payment_secret, *payment_secret);
678678
},
679-
_ => panic!("expected PaymentPurpose::InvoicePayment")
679+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
680680
}
681681
},
682682
_ => panic!("Unexpected event"),
@@ -1683,11 +1683,11 @@ fn test_monitor_update_fail_claim() {
16831683
assert_eq!(via_channel_id, Some(channel_id));
16841684
assert_eq!(via_user_channel_id, Some(42));
16851685
match &purpose {
1686-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1686+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
16871687
assert!(payment_preimage.is_none());
16881688
assert_eq!(payment_secret_2, *payment_secret);
16891689
},
1690-
_ => panic!("expected PaymentPurpose::InvoicePayment")
1690+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
16911691
}
16921692
},
16931693
_ => panic!("Unexpected event"),
@@ -1699,11 +1699,11 @@ fn test_monitor_update_fail_claim() {
16991699
assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
17001700
assert_eq!(via_channel_id, Some(channel_id));
17011701
match &purpose {
1702-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1702+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
17031703
assert!(payment_preimage.is_none());
17041704
assert_eq!(payment_secret_3, *payment_secret);
17051705
},
1706-
_ => panic!("expected PaymentPurpose::InvoicePayment")
1706+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
17071707
}
17081708
},
17091709
_ => panic!("Unexpected event"),

‎lightning/src/ln/channelmanager.rs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1464,12 +1464,12 @@ where
14641464
/// // On the event processing thread
14651465
/// channel_manager.process_pending_events(&|event| match event {
14661466
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
1467-
/// PaymentPurpose::InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
1467+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
14681468
/// assert_eq!(payment_hash, known_payment_hash);
14691469
/// println!("Claiming payment {}", payment_hash);
14701470
/// channel_manager.claim_funds(payment_preimage);
14711471
/// },
1472-
/// PaymentPurpose::InvoicePayment { payment_preimage: None, .. } => {
1472+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
14731473
/// println!("Unknown payment hash: {}", payment_hash);
14741474
/// },
14751475
/// PaymentPurpose::SpontaneousPayment(payment_preimage) => {
@@ -1564,11 +1564,11 @@ where
15641564
/// // On the event processing thread
15651565
/// channel_manager.process_pending_events(&|event| match event {
15661566
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
1567-
/// PaymentPurpose::InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
1567+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
15681568
/// println!("Claiming payment {}", payment_hash);
15691569
/// channel_manager.claim_funds(payment_preimage);
15701570
/// },
1571-
/// PaymentPurpose::InvoicePayment { payment_preimage: None, .. } => {
1571+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
15721572
/// println!("Unknown payment hash: {}", payment_hash);
15731573
/// },
15741574
/// // ...
@@ -1716,12 +1716,12 @@ where
17161716
/// // On the event processing thread
17171717
/// channel_manager.process_pending_events(&|event| match event {
17181718
/// Event::PaymentClaimable { payment_hash, purpose, .. } => match purpose {
1719-
/// PaymentPurpose::InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
1719+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(payment_preimage), .. } => {
17201720
/// assert_eq!(payment_hash, known_payment_hash);
17211721
/// println!("Claiming payment {}", payment_hash);
17221722
/// channel_manager.claim_funds(payment_preimage);
17231723
/// },
1724-
/// PaymentPurpose::InvoicePayment { payment_preimage: None, .. } => {
1724+
/// PaymentPurpose::Bolt11InvoicePayment { payment_preimage: None, .. } => {
17251725
/// println!("Unknown payment hash: {}", payment_hash);
17261726
/// },
17271727
/// // ...
@@ -5433,7 +5433,7 @@ where
54335433
let mut payment_claimable_generated = false;
54345434
let is_keysend = match $purpose {
54355435
events::PaymentPurpose::SpontaneousPayment(_) => true,
5436-
events::PaymentPurpose::InvoicePayment { .. } => false,
5436+
events::PaymentPurpose::Bolt11InvoicePayment { .. } => false,
54375437
};
54385438
let mut claimable_payments = self.claimable_payments.lock().unwrap();
54395439
if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
@@ -5548,7 +5548,7 @@ where
55485548
fail_htlc!(claimable_htlc, payment_hash);
55495549
}
55505550
}
5551-
let purpose = events::PaymentPurpose::InvoicePayment {
5551+
let purpose = events::PaymentPurpose::Bolt11InvoicePayment {
55525552
payment_preimage: payment_preimage.clone(),
55535553
payment_secret: payment_data.payment_secret,
55545554
};
@@ -5574,7 +5574,7 @@ where
55745574
&payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
55755575
fail_htlc!(claimable_htlc, payment_hash);
55765576
} else {
5577-
let purpose = events::PaymentPurpose::InvoicePayment {
5577+
let purpose = events::PaymentPurpose::Bolt11InvoicePayment {
55785578
payment_preimage: inbound_payment.get().payment_preimage,
55795579
payment_secret: payment_data.payment_secret,
55805580
};
@@ -8881,9 +8881,9 @@ where
88818881
/// [`PaymentHash`] and [`PaymentPreimage`] for you.
88828882
///
88838883
/// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
8884-
/// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
8885-
/// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
8886-
/// passed directly to [`claim_funds`].
8884+
/// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::Bolt11InvoicePayment`] with
8885+
/// its [`PaymentPurpose::Bolt11InvoicePayment::payment_preimage`] field filled in. That should
8886+
/// then be passed directly to [`claim_funds`].
88878887
///
88888888
/// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
88898889
///
@@ -8903,8 +8903,8 @@ where
89038903
/// [`claim_funds`]: Self::claim_funds
89048904
/// [`PaymentClaimable`]: events::Event::PaymentClaimable
89058905
/// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
8906-
/// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
8907-
/// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
8906+
/// [`PaymentPurpose::Bolt11InvoicePayment`]: events::PaymentPurpose::Bolt11InvoicePayment
8907+
/// [`PaymentPurpose::Bolt11InvoicePayment::payment_preimage`]: events::PaymentPurpose::Bolt11InvoicePayment::payment_preimage
89088908
/// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
89098909
pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
89108910
min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
@@ -12103,7 +12103,7 @@ where
1210312103
let purpose = match &htlcs[0].onion_payload {
1210412104
OnionPayload::Invoice { _legacy_hop_data, payment_context: _ } => {
1210512105
if let Some(hop_data) = _legacy_hop_data {
12106-
events::PaymentPurpose::InvoicePayment {
12106+
events::PaymentPurpose::Bolt11InvoicePayment {
1210712107
payment_preimage: match pending_inbound_payments.get(&payment_hash) {
1210812108
Some(inbound_payment) => inbound_payment.payment_preimage,
1210912109
None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {

‎lightning/src/ln/functional_test_utils.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2129,7 +2129,7 @@ pub fn check_payment_claimable(
21292129
assert_eq!(expected_recv_value, *amount_msat);
21302130
assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
21312131
match purpose {
2132-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2132+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
21332133
assert_eq!(&expected_payment_preimage, payment_preimage);
21342134
assert_eq!(expected_payment_secret, *payment_secret);
21352135
},
@@ -2606,7 +2606,7 @@ pub fn do_pass_along_path<'a, 'b, 'c>(args: PassAlongPathArgs) -> Option<Event>
26062606
assert!(onion_fields.is_some());
26072607
assert_eq!(onion_fields.as_ref().unwrap().custom_tlvs, custom_tlvs);
26082608
match &purpose {
2609-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2609+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
26102610
assert_eq!(expected_preimage, *payment_preimage);
26112611
assert_eq!(our_payment_secret.unwrap(), *payment_secret);
26122612
assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
@@ -2768,7 +2768,7 @@ pub fn pass_claimed_payment_along_route<'a, 'b, 'c, 'd>(args: ClaimAlongRouteArg
27682768
ref htlcs,
27692769
.. }
27702770
| Event::PaymentClaimed {
2771-
purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2771+
purpose: PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(preimage), ..},
27722772
ref htlcs,
27732773
amount_msat,
27742774
..
@@ -2780,7 +2780,7 @@ pub fn pass_claimed_payment_along_route<'a, 'b, 'c, 'd>(args: ClaimAlongRouteArg
27802780
fwd_amt_msat = amount_msat;
27812781
},
27822782
Event::PaymentClaimed {
2783-
purpose: PaymentPurpose::InvoicePayment { .. },
2783+
purpose: PaymentPurpose::Bolt11InvoicePayment { .. },
27842784
payment_hash,
27852785
amount_msat,
27862786
ref htlcs,

‎lightning/src/ln/functional_tests.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2039,11 +2039,11 @@ fn test_channel_reserve_holding_cell_htlcs() {
20392039
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
20402040
assert_eq!(via_channel_id, Some(chan_2.2));
20412041
match &purpose {
2042-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2042+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
20432043
assert!(payment_preimage.is_none());
20442044
assert_eq!(our_payment_secret_21, *payment_secret);
20452045
},
2046-
_ => panic!("expected PaymentPurpose::InvoicePayment")
2046+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
20472047
}
20482048
},
20492049
_ => panic!("Unexpected event"),
@@ -2055,11 +2055,11 @@ fn test_channel_reserve_holding_cell_htlcs() {
20552055
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
20562056
assert_eq!(via_channel_id, Some(chan_2.2));
20572057
match &purpose {
2058-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2058+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
20592059
assert!(payment_preimage.is_none());
20602060
assert_eq!(our_payment_secret_22, *payment_secret);
20612061
},
2062-
_ => panic!("expected PaymentPurpose::InvoicePayment")
2062+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
20632063
}
20642064
},
20652065
_ => panic!("Unexpected event"),
@@ -3954,11 +3954,11 @@ fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken
39543954
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
39553955
assert_eq!(via_channel_id, Some(channel_id));
39563956
match &purpose {
3957-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3957+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
39583958
assert!(payment_preimage.is_none());
39593959
assert_eq!(payment_secret_1, *payment_secret);
39603960
},
3961-
_ => panic!("expected PaymentPurpose::InvoicePayment")
3961+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
39623962
}
39633963
},
39643964
_ => panic!("Unexpected event"),
@@ -4319,11 +4319,11 @@ fn test_drop_messages_peer_disconnect_dual_htlc() {
43194319
Event::PaymentClaimable { ref payment_hash, ref purpose, .. } => {
43204320
assert_eq!(payment_hash_2, *payment_hash);
43214321
match &purpose {
4322-
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4322+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
43234323
assert!(payment_preimage.is_none());
43244324
assert_eq!(payment_secret_2, *payment_secret);
43254325
},
4326-
_ => panic!("expected PaymentPurpose::InvoicePayment")
4326+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
43274327
}
43284328
},
43294329
_ => panic!("Unexpected event"),
@@ -8388,10 +8388,10 @@ fn test_preimage_storage() {
83888388
match events[0] {
83898389
Event::PaymentClaimable { ref purpose, .. } => {
83908390
match &purpose {
8391-
PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
8391+
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => {
83928392
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
83938393
},
8394-
_ => panic!("expected PaymentPurpose::InvoicePayment")
8394+
_ => panic!("expected PaymentPurpose::Bolt11InvoicePayment")
83958395
}
83968396
},
83978397
_ => panic!("Unexpected event"),

‎lightning/src/ln/offers_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ fn claim_bolt12_payment<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, path: &[&Node<'a, '
155155
let recipient = &path[path.len() - 1];
156156
match get_event!(recipient, Event::PaymentClaimable) {
157157
Event::PaymentClaimable {
158-
purpose: PaymentPurpose::InvoicePayment {
158+
purpose: PaymentPurpose::Bolt11InvoicePayment {
159159
payment_preimage: Some(payment_preimage), ..
160160
}, ..
161161
} => claim_payment(node, path, payment_preimage),

‎lightning/src/ln/payment_tests.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2142,9 +2142,11 @@ fn do_accept_underpaying_htlcs_config(num_mpp_parts: usize) {
21422142
assert_eq!(skimmed_fee_msat * num_mpp_parts as u64, counterparty_skimmed_fee_msat);
21432143
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
21442144
match purpose {
2145-
crate::events::PaymentPurpose::InvoicePayment { payment_preimage: ev_payment_preimage,
2146-
payment_secret: ev_payment_secret, .. } =>
2147-
{
2145+
crate::events::PaymentPurpose::Bolt11InvoicePayment {
2146+
payment_preimage: ev_payment_preimage,
2147+
payment_secret: ev_payment_secret,
2148+
..
2149+
} => {
21482150
assert_eq!(payment_preimage, ev_payment_preimage.unwrap());
21492151
assert_eq!(payment_secret, *ev_payment_secret);
21502152
},

0 commit comments

Comments
 (0)