X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fevents.rs;h=14ab5ee3c4b83ebd3dff5e00d05daf5e597ea1e4;hb=dfd56793a77fa92ed36f6951dcb4e93c250376c4;hp=ef0c619b02e9f7a1b03cd6dd14b439e7799264dc;hpb=998cdc0865a0d59bf5166f68a71c84f843fe6c9f;p=rust-lightning

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index ef0c619b..14ab5ee3 100644
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -21,7 +21,7 @@ use ln::features::ChannelTypeFeatures;
 use ln::msgs;
 use ln::msgs::DecodeError;
 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
-use routing::network_graph::NetworkUpdate;
+use routing::gossip::NetworkUpdate;
 use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
 use routing::router::{RouteHop, RouteParameters};
 
@@ -66,6 +66,14 @@ pub enum PaymentPurpose {
 	SpontaneousPayment(PaymentPreimage),
 }
 
+impl_writeable_tlv_based_enum!(PaymentPurpose,
+	(0, InvoicePayment) => {
+		(0, payment_preimage, option),
+		(2, payment_secret, required),
+	};
+	(2, SpontaneousPayment)
+);
+
 #[derive(Clone, Debug, PartialEq)]
 /// The reason the channel was closed. See individual variants more details.
 pub enum ClosureReason {
@@ -180,8 +188,9 @@ pub enum Event {
 		/// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
 		user_channel_id: u64,
 	},
-	/// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
-	/// [`ChannelManager::claim_funds`] to get it....
+	/// Indicates we've received (an offer of) money! Just gotta dig out that payment preimage and
+	/// feed it to [`ChannelManager::claim_funds`] to get it....
+	///
 	/// Note that if the preimage is not known, you should call
 	/// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
 	/// network congestion.
@@ -200,11 +209,35 @@ pub enum Event {
 		/// not stop you from registering duplicate payment hashes for inbound payments.
 		payment_hash: PaymentHash,
 		/// The value, in thousandths of a satoshi, that this payment is for.
-		amt: u64,
+		amount_msat: u64,
 		/// Information for claiming this received payment, based on whether the purpose of the
 		/// payment is to pay an invoice or to send a spontaneous payment.
 		purpose: PaymentPurpose,
 	},
+	/// Indicates a payment has been claimed and we've received money!
+	///
+	/// This most likely occurs when [`ChannelManager::claim_funds`] has been called in response
+	/// to an [`Event::PaymentReceived`]. However, if we previously crashed during a
+	/// [`ChannelManager::claim_funds`] call you may see this event without a corresponding
+	/// [`Event::PaymentReceived`] event.
+	///
+	/// # Note
+	/// LDK will not stop an inbound payment from being paid multiple times, so multiple
+	/// `PaymentReceived` events may be generated for the same payment. If you then call
+	/// [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentReceived`] you may get
+	/// multiple `PaymentClaimed` events.
+	///
+	/// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
+	PaymentClaimed {
+		/// The payment hash of the claimed payment. Note that LDK will not stop you from
+		/// registering duplicate payment hashes for inbound payments.
+		payment_hash: PaymentHash,
+		/// The value, in thousandths of a satoshi, that this payment is for.
+		amount_msat: u64,
+		/// The purpose of this claimed payment, i.e. whether the payment was for an invoice or a
+		/// spontaneous payment.
+		purpose: PaymentPurpose,
+	},
 	/// Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
 	/// and we got back the payment preimage for it).
 	///
@@ -304,10 +337,9 @@ pub enum Event {
 		/// payment route.
 		///
 		/// Should be applied to the [`NetworkGraph`] so that routing decisions can take into
-		/// account the update. [`NetGraphMsgHandler`] is capable of doing this.
+		/// account the update.
 		///
-		/// [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
-		/// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
+		/// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
 		network_update: Option<NetworkUpdate>,
 		/// For both single-path and multi-path payments, this is set if all paths of the payment have
 		/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
@@ -331,6 +363,10 @@ pub enum Event {
 		path: Vec<RouteHop>,
 		/// The channel responsible for the failed payment path.
 		///
+		/// Note that for route hints or for the first hop in a path this may be an SCID alias and
+		/// may not refer to a channel in the public network graph. These aliases may also collide
+		/// with channels in the public network graph.
+		///
 		/// If this is `Some`, then the corresponding channel should be avoided when the payment is
 		/// retried. May be `None` for older [`Event`] serializations.
 		short_channel_id: Option<u64>,
@@ -393,7 +429,8 @@ pub enum Event {
 		/// transaction.
 		claim_from_onchain_tx: bool,
 	},
-	/// Used to indicate that a channel with the given `channel_id` is in the process of closure.
+	/// Used to indicate that a previously opened channel with the given `channel_id` is in the
+	/// process of closure.
 	ChannelClosed  {
 		/// The channel_id of the channel which has been closed. Note that on-chain transactions
 		/// resolving the channel are likely still awaiting confirmation.
@@ -462,6 +499,12 @@ pub enum Event {
 		/// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
 		/// 0.0.106.
 		///
+		/// Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type,
+		/// the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
+		/// 0.0.107. Channels setting this type also need to get manually accepted via
+		/// [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`],
+		/// or will be rejected otherwise.
+		///
 		/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 		channel_type: ChannelTypeFeatures,
 	},
@@ -475,7 +518,7 @@ impl Writeable for Event {
 				// We never write out FundingGenerationReady events as, upon disconnection, peers
 				// drop any channels which have not yet exchanged funding_signed.
 			},
-			&Event::PaymentReceived { ref payment_hash, ref amt, ref purpose } => {
+			&Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose } => {
 				1u8.write(writer)?;
 				let mut payment_secret = None;
 				let payment_preimage;
@@ -491,7 +534,7 @@ impl Writeable for Event {
 				write_tlv_fields!(writer, {
 					(0, payment_hash, required),
 					(2, payment_secret, option),
-					(4, amt, required),
+					(4, amount_msat, required),
 					(6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
 					(8, payment_preimage, option),
 				});
@@ -584,6 +627,14 @@ impl Writeable for Event {
 				// We never write the OpenChannelRequest events as, upon disconnection, peers
 				// drop any channels which have not yet exchanged funding_signed.
 			},
+			&Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose } => {
+				19u8.write(writer)?;
+				write_tlv_fields!(writer, {
+					(0, payment_hash, required),
+					(2, purpose, required),
+					(4, amount_msat, required),
+				});
+			},
 			// Note that, going forward, all new events must only write data inside of
 			// `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
 			// data via `write_tlv_fields`.
@@ -602,12 +653,12 @@ impl MaybeReadable for Event {
 					let mut payment_hash = PaymentHash([0; 32]);
 					let mut payment_preimage = None;
 					let mut payment_secret = None;
-					let mut amt = 0;
+					let mut amount_msat = 0;
 					let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
 					read_tlv_fields!(reader, {
 						(0, payment_hash, required),
 						(2, payment_secret, option),
-						(4, amt, required),
+						(4, amount_msat, required),
 						(6, _user_payment_id, option),
 						(8, payment_preimage, option),
 					});
@@ -621,7 +672,7 @@ impl MaybeReadable for Event {
 					};
 					Ok(Some(Event::PaymentReceived {
 						payment_hash,
-						amt,
+						amount_msat,
 						purpose,
 					}))
 				};
@@ -784,6 +835,25 @@ impl MaybeReadable for Event {
 				// Value 17 is used for `Event::OpenChannelRequest`.
 				Ok(None)
 			},
+			19u8 => {
+				let f = || {
+					let mut payment_hash = PaymentHash([0; 32]);
+					let mut purpose = None;
+					let mut amount_msat = 0;
+					read_tlv_fields!(reader, {
+						(0, payment_hash, required),
+						(2, purpose, ignorable),
+						(4, amount_msat, required),
+					});
+					if purpose.is_none() { return Ok(None); }
+					Ok(Some(Event::PaymentClaimed {
+						payment_hash,
+						purpose: purpose.unwrap(),
+						amount_msat,
+					}))
+				};
+				f()
+			},
 			// Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
 			// Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
 			// reads.
@@ -838,12 +908,12 @@ pub enum MessageSendEvent {
 		/// The message which should be sent.
 		msg: msgs::FundingSigned,
 	},
-	/// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
-	SendFundingLocked {
+	/// Used to indicate that a channel_ready message should be sent to the peer with the given node_id.
+	SendChannelReady {
 		/// The node_id of the node which should receive these message(s)
 		node_id: PublicKey,
-		/// The funding_locked message which should be sent.
-		msg: msgs::FundingLocked,
+		/// The channel_ready message which should be sent.
+		msg: msgs::ChannelReady,
 	},
 	/// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
 	SendAnnouncementSignatures {