mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 07:17:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Clarify the in-flight HTLC state-tracking structs a bit.

Browse source 
This also renames PendingForwardHTLCInfo to PendingHTLCInfo since
it now also encompasses Pending *Received* HTLCs.
This commit is contained in:
Matt Corallo 2020-01-01 15:56:03 -05:00
parent 3670dd086c
commit 72e32e7af6
2 changed files with 39 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lightning/src/ln/channel.rs
View file

@ -19,7 +19,7 @@ use ln::features::{ChannelFeatures, InitFeatures};
use ln::msgs; use ln::msgs;
use ln::msgs::{DecodeError, OptionalField, DataLossProtect}; use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
use ln::channelmonitor::ChannelMonitor; use ln::channelmonitor::ChannelMonitor;
use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT}; use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use ln::chan_utils::{LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys}; use ln::chan_utils::{LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys};
use ln::chan_utils; use ln::chan_utils;
use chain::chaininterface::{FeeEstimator,ConfirmationTarget}; use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
@ -269,7 +269,7 @@ pub(super) struct Channel<ChanSigner: ChannelKeys> {
monitor_pending_funding_locked: bool, monitor_pending_funding_locked: bool,
monitor_pending_revoke_and_ack: bool, monitor_pending_revoke_and_ack: bool,
monitor_pending_commitment_signed: bool, monitor_pending_commitment_signed: bool,
monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
// pending_update_fee is filled when sending and receiving update_fee // pending_update_fee is filled when sending and receiving update_fee
@ -1986,7 +1986,7 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
/// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail, /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
/// generating an appropriate error *after* the channel state has been updated based on the /// generating an appropriate error *after* the channel state has been updated based on the
/// revoke_and_ack message. /// revoke_and_ack message.
pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor<ChanSigner>), ChannelError<ChanSigner>> { pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor<ChanSigner>), ChannelError<ChanSigner>> {
if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state")); return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
} }
@ -2292,7 +2292,7 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
/// which failed. The messages which were generated from that call which generated the /// which failed. The messages which were generated from that call which generated the
/// monitor update failure must *not* have been sent to the remote end, and must instead /// monitor update failure must *not* have been sent to the remote end, and must instead
/// have been dropped. They will be regenerated when monitor_updating_restored is called. /// have been dropped. They will be regenerated when monitor_updating_restored is called.
pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) { pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0); assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
self.monitor_pending_revoke_and_ack = resend_raa; self.monitor_pending_revoke_and_ack = resend_raa;
self.monitor_pending_commitment_signed = resend_commitment; self.monitor_pending_commitment_signed = resend_commitment;
@ -2306,7 +2306,7 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
/// Indicates that the latest ChannelMonitor update has been committed by the client /// Indicates that the latest ChannelMonitor update has been committed by the client
/// successfully and we should restore normal operation. Returns messages which should be sent /// successfully and we should restore normal operation. Returns messages which should be sent
/// to the remote side. /// to the remote side.
pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) { pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) {
assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32); assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32); self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);

64
lightning/src/ln/channelmanager.rs
View file

@ -57,15 +57,19 @@ use std::ops::Deref;
// forward the HTLC with information it will give back to us when it does so, or if it should Fail // forward the HTLC with information it will give back to us when it does so, or if it should Fail
// the HTLC with the relevant message for the Channel to handle giving to the remote peer. // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
// //
// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill // with it to track where it came from (in case of onwards-forward error), waiting a random delay
// the HTLC backwards along the relevant path). // before we forward it.
//
// We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
// relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
// to either fail-backwards or fulfill the HTLC backwards along the relevant path).
// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
// our payment, which we can use to decode errors or inform the user that the payment was sent. // our payment, which we can use to decode errors or inform the user that the payment was sent.
/// Stores the info we will need to send when we want to forward an HTLC onwards
#[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
pub(super) struct PendingForwardHTLCInfo { pub(super) struct PendingHTLCInfo {
onion_packet: Option<msgs::OnionPacket>, onion_packet: Option<msgs::OnionPacket>,
incoming_shared_secret: [u8; 32], incoming_shared_secret: [u8; 32],
payment_hash: PaymentHash, payment_hash: PaymentHash,
@ -83,10 +87,22 @@ pub(super) enum HTLCFailureMsg {
/// Stores whether we can't forward an HTLC or relevant forwarding info /// Stores whether we can't forward an HTLC or relevant forwarding info
#[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
pub(super) enum PendingHTLCStatus { pub(super) enum PendingHTLCStatus {
Forward(PendingForwardHTLCInfo), Forward(PendingHTLCInfo),
Fail(HTLCFailureMsg), Fail(HTLCFailureMsg),
} }
pub(super) enum HTLCForwardInfo {
AddHTLC {
prev_short_channel_id: u64,
prev_htlc_id: u64,
forward_info: PendingHTLCInfo,
},
FailHTLC {
htlc_id: u64,
err_packet: msgs::OnionErrorPacket,
},
}
/// Tracks the inbound corresponding to an outbound HTLC /// Tracks the inbound corresponding to an outbound HTLC
#[derive(Clone, PartialEq)] #[derive(Clone, PartialEq)]
pub(super) struct HTLCPreviousHopData { pub(super) struct HTLCPreviousHopData {
@ -231,18 +247,6 @@ impl MsgHandleErrInternal {
/// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100; const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
pub(super) enum HTLCForwardInfo {
AddHTLC {
prev_short_channel_id: u64,
prev_htlc_id: u64,
forward_info: PendingForwardHTLCInfo,
},
FailHTLC {
htlc_id: u64,
err_packet: msgs::OnionErrorPacket,
},
}
/// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
/// be sent in the order they appear in the return value, however sometimes the order needs to be /// be sent in the order they appear in the return value, however sometimes the order needs to be
/// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
@ -262,7 +266,7 @@ pub(super) struct ChannelHolder<ChanSigner: ChannelKeys> {
/// short channel id -> forward infos. Key of 0 means payments received /// short channel id -> forward infos. Key of 0 means payments received
/// Note that while this is held in the same mutex as the channels themselves, no consistency /// Note that while this is held in the same mutex as the channels themselves, no consistency
/// guarantees are made about the existence of a channel with the short id here, nor the short /// guarantees are made about the existence of a channel with the short id here, nor the short
/// ids in the PendingForwardHTLCInfo! /// ids in the PendingHTLCInfo!
pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>, pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
/// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and /// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and
/// can be failed/claimed by the user /// can be failed/claimed by the user
@ -574,7 +578,7 @@ macro_rules! handle_monitor_err {
} else if $resend_commitment { "commitment" } } else if $resend_commitment { "commitment" }
else if $resend_raa { "RAA" } else if $resend_raa { "RAA" }
else { "nothing" }, else { "nothing" },
(&$failed_forwards as &Vec<(PendingForwardHTLCInfo, u64)>).len(), (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
(&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len()); (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
if !$resend_commitment { if !$resend_commitment {
debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa); debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
@ -969,7 +973,7 @@ impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M,
// instead we stay symmetric with the forwarding case, only responding (after a // instead we stay symmetric with the forwarding case, only responding (after a
// delay) once they've send us a commitment_signed! // delay) once they've send us a commitment_signed!
PendingHTLCStatus::Forward(PendingForwardHTLCInfo { PendingHTLCStatus::Forward(PendingHTLCInfo {
onion_packet: None, onion_packet: None,
payment_hash: msg.payment_hash.clone(), payment_hash: msg.payment_hash.clone(),
short_channel_id: 0, short_channel_id: 0,
@ -1021,7 +1025,7 @@ impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M,
}, },
}; };
PendingHTLCStatus::Forward(PendingForwardHTLCInfo { PendingHTLCStatus::Forward(PendingHTLCInfo {
onion_packet: Some(outgoing_packet), onion_packet: Some(outgoing_packet),
payment_hash: msg.payment_hash.clone(), payment_hash: msg.payment_hash.clone(),
short_channel_id: short_channel_id, short_channel_id: short_channel_id,
@ -1032,7 +1036,7 @@ impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M,
}; };
channel_state = Some(self.channel_state.lock().unwrap()); channel_state = Some(self.channel_state.lock().unwrap());
if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info { if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned(); let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
let forwarding_id = match id_option { let forwarding_id = match id_option {
@ -2158,7 +2162,7 @@ impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M,
// If the update_add is completely bogus, the call will Err and we will close, // If the update_add is completely bogus, the call will Err and we will close,
// but if we've sent a shutdown and they haven't acknowledged it yet, we just // but if we've sent a shutdown and they haven't acknowledged it yet, we just
// want to reject the new HTLC and fail it backwards instead of forwarding. // want to reject the new HTLC and fail it backwards instead of forwarding.
if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info { if let PendingHTLCStatus::Forward(PendingHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
let chan_update = self.get_channel_update(chan.get()); let chan_update = self.get_channel_update(chan.get());
pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
channel_id: msg.channel_id, channel_id: msg.channel_id,
@ -2289,7 +2293,7 @@ impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M,
} }
#[inline] #[inline]
fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) { fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingHTLCInfo, u64)>)]) {
for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards { for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
let mut forward_event = None; let mut forward_event = None;
if !pending_forwards.is_empty() { if !pending_forwards.is_empty() {
@ -3016,7 +3020,7 @@ impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send> Ch
const SERIALIZATION_VERSION: u8 = 1; const SERIALIZATION_VERSION: u8 = 1;
const MIN_SERIALIZATION_VERSION: u8 = 1; const MIN_SERIALIZATION_VERSION: u8 = 1;
impl Writeable for PendingForwardHTLCInfo { impl Writeable for PendingHTLCInfo {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> { fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
self.onion_packet.write(writer)?; self.onion_packet.write(writer)?;
self.incoming_shared_secret.write(writer)?; self.incoming_shared_secret.write(writer)?;
@ -3028,9 +3032,9 @@ impl Writeable for PendingForwardHTLCInfo {
} }
} }
impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo { impl<R: ::std::io::Read> Readable<R> for PendingHTLCInfo {
fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> { fn read(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
Ok(PendingForwardHTLCInfo { Ok(PendingHTLCInfo {
onion_packet: Readable::read(reader)?, onion_packet: Readable::read(reader)?,
incoming_shared_secret: Readable::read(reader)?, incoming_shared_secret: Readable::read(reader)?,
payment_hash: Readable::read(reader)?, payment_hash: Readable::read(reader)?,