Make the PaymentSecret in PaymentReceived events non-Optional

Author: TheBlueMatt

lightning/src/ln/chanmon_update_fail_tests.rs

@@ -208,7 +208,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
 	match events_3[0] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(payment_hash_1, *payment_hash);
-			assert_eq!(Some(payment_secret_1), *payment_secret);
+			assert_eq!(payment_secret_1, *payment_secret);
 			assert_eq!(amt, 1000000);
 		},
 		_ => panic!("Unexpected event"),
@@ -576,7 +576,7 @@ fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
 	match events_5[0] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(payment_hash_2, *payment_hash);
-			assert_eq!(Some(payment_secret_2), *payment_secret);
+			assert_eq!(payment_secret_2, *payment_secret);
 			assert_eq!(amt, 1000000);
 		},
 		_ => panic!("Unexpected event"),
@@ -690,7 +690,7 @@ fn test_monitor_update_fail_cs() {
 	match events[0] {
 		Event::PaymentReceived { payment_hash, payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(payment_hash, our_payment_hash);
-			assert_eq!(Some(our_payment_secret), payment_secret);
+			assert_eq!(our_payment_secret, payment_secret);
 			assert_eq!(amt, 1000000);
 		},
 		_ => panic!("Unexpected event"),

lightning/src/ln/channelmanager.rs

@@ -2014,7 +2014,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 											} else if total_value == payment_data.total_msat {
 												new_events.push(events::Event::PaymentReceived {
 													payment_hash,
-													payment_secret: Some(payment_data.payment_secret),
+													payment_secret: payment_data.payment_secret,
 													amt: total_value,
 													user_payment_id: inbound_payment.get().user_payment_id,
 												});

lightning/src/ln/functional_test_utils.rs

@@ -943,7 +943,7 @@ macro_rules! expect_payment_received {
 		match events[0] {
 			Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 				assert_eq!($expected_payment_hash, *payment_hash);
-				assert_eq!(Some($expected_payment_secret), *payment_secret);
+				assert_eq!($expected_payment_secret, *payment_secret);
 				assert_eq!($expected_recv_value, amt);
 			},
 			_ => panic!("Unexpected event"),
@@ -1011,7 +1011,7 @@ pub fn pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path
 				match events_2[0] {
 					Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 						assert_eq!(our_payment_hash, *payment_hash);
-						assert_eq!(Some(our_payment_secret), *payment_secret);
+						assert_eq!(our_payment_secret, *payment_secret);
 						assert_eq!(amt, recv_value);
 					},
 					_ => panic!("Unexpected event"),

lightning/src/ln/functional_tests.rs

@@ -2072,15 +2072,15 @@ fn test_channel_reserve_holding_cell_htlcs() {
 	match events[0] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(our_payment_hash_21, *payment_hash);
-			assert_eq!(Some(our_payment_secret_21), *payment_secret);
+			assert_eq!(our_payment_secret_21, *payment_secret);
 			assert_eq!(recv_value_21, amt);
 		},
 		_ => panic!("Unexpected event"),
 	}
 	match events[1] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(our_payment_hash_22, *payment_hash);
-			assert_eq!(Some(our_payment_secret_22), *payment_secret);
+			assert_eq!(our_payment_secret_22, *payment_secret);
 			assert_eq!(recv_value_22, amt);
 		},
 		_ => panic!("Unexpected event"),
@@ -3648,7 +3648,7 @@ fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
 	match events_2[0] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
 			assert_eq!(payment_hash_1, *payment_hash);
-			assert_eq!(Some(payment_secret_1), *payment_secret);
+			assert_eq!(payment_secret_1, *payment_secret);
 			assert_eq!(amt, 1000000);
 		},
 		_ => panic!("Unexpected event"),
@@ -3985,7 +3985,7 @@ fn test_drop_messages_peer_disconnect_dual_htlc() {
 	match events_5[0] {
 		Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _, user_payment_id: _ } => {
 			assert_eq!(payment_hash_2, *payment_hash);
-			assert_eq!(Some(payment_secret_2), *payment_secret);
+			assert_eq!(payment_secret_2, *payment_secret);
 		},
 		_ => panic!("Unexpected event"),
 	}

lightning/src/util/events.rs

@@ -63,14 +63,15 @@ pub enum Event {
 		payment_hash: PaymentHash,
 		/// The "payment secret". This authenticates the sender to the recipient, preventing a
 		/// number of deanonymization attacks during the routing process.
-		/// As nodes upgrade, the invoices you provide should likely migrate to setting the
-		/// payment_secret feature to required, at which point you should fail_backwards any HTLCs
-		/// which have a None here.
-		/// Until then, however, values of None should be ignored, and only incorrect Some values
-		/// should result in an HTLC fail_backwards.
-		/// Note that, in any case, this value must be passed as-is to any fail or claim calls as
-		/// the HTLC index includes this value.
-		payment_secret: Option<PaymentSecret>,
+		/// It is provided here for your reference, however its accuracy is enforced directly by
+		/// [`ChannelManager`] using the values you previously provided to
+		/// [`ChannelManager::get_payment_secret_preimage`] or
+		/// [`ChannelManager::get_payment_secret`].
+		///
+		/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+		/// [`ChannelManager::get_payment_secret_preimage`]: crate::ln::channelmanager::ChannelManager::get_payment_secret_preimage
+		/// [`ChannelManager::get_payment_secret`]: crate::ln::channelmanager::ChannelManager::get_payment_secret
+		payment_secret: PaymentSecret,
 		/// The value, in thousandths of a satoshi, that this payment is for. Note that you must
 		/// compare this to the expected value before accepting the payment (as otherwise you are
 		/// providing proof-of-payment for less than the value you expected!).