From: Matt Corallo Date: Tue, 6 Feb 2024 18:53:56 +0000 (+0000) Subject: Note when new HTLC state can be `None` X-Git-Tag: v0.0.123-beta~77^2 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=d1c2e143fe014256ddc4ccf8aa0ec29b38205b19;p=rust-lightning Note when new HTLC state can be `None` --- diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs index d1c7a5ee5..31989a011 100644 --- a/lightning/src/ln/channel.rs +++ b/lightning/src/ln/channel.rs @@ -247,9 +247,14 @@ pub struct InboundHTLCDetails { /// The payment hash. pub payment_hash: PaymentHash, /// The state of the HTLC in the state machine. + /// /// Determines on which commitment transactions the HTLC is included and what message the HTLC is /// waiting for to advance to the next state. + /// /// See [`InboundHTLCStateDetails`] for information on the specific states. + /// + /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new + /// states may result in `None` here. pub state: Option, /// Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed /// from the local commitment transaction and added to the commitment transaction fee. @@ -428,9 +433,14 @@ pub struct OutboundHTLCDetails { /// The payment hash. pub payment_hash: PaymentHash, /// The state of the HTLC in the state machine. + /// /// Determines on which commitment transactions the HTLC is included and what message the HTLC is /// waiting for to advance to the next state. + /// /// See [`OutboundHTLCStateDetails`] for information on the specific states. + /// + /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new + /// states may result in `None` here. pub state: Option, /// The extra fee being skimmed off the top of this HTLC. pub skimmed_fee_msat: Option,