From bcb0c53ff84b0071243baf32c1aa6e82fe46157c Mon Sep 17 00:00:00 2001 From: Mariusz Klochowicz Date: Wed, 3 Nov 2021 17:12:33 +1030 Subject: [PATCH] Rename `MustRefund` Cfd state to `PendingRefund` For consistency with PendingClose, PendingCommit, PendingCet - it's analogous to them, but applies to refund transaction. --- daemon/src/cfd_actors.rs | 2 +- daemon/src/model/cfd.rs | 26 +++++++++++++------------- daemon/src/monitor.rs | 2 +- daemon/src/oracle.rs | 2 +- daemon/src/to_sse_event.rs | 10 +++++----- frontend/src/components/Types.tsx | 8 ++++---- 6 files changed, 25 insertions(+), 25 deletions(-) diff --git a/daemon/src/cfd_actors.rs b/daemon/src/cfd_actors.rs index 6355c14..111c938 100644 --- a/daemon/src/cfd_actors.rs +++ b/daemon/src/cfd_actors.rs @@ -88,7 +88,7 @@ where if let CfdState::OpenCommitted { .. } = cfd.state { try_cet_publication(&mut cfd, conn, wallet, update_sender).await?; - } else if let CfdState::MustRefund { .. } = cfd.state { + } else if let CfdState::PendingRefund { .. } = cfd.state { let signed_refund_tx = cfd.refund_tx()?; let txid = wallet .send(wallet::TryBroadcastTransaction { diff --git a/daemon/src/model/cfd.rs b/daemon/src/model/cfd.rs index d6bb1f8..e6c3624 100644 --- a/daemon/src/model/cfd.rs +++ b/daemon/src/model/cfd.rs @@ -276,7 +276,7 @@ pub enum CfdState { // TODO: Can be extended with CetStatus /// The CFD contract's refund transaction was published but it not final yet - MustRefund { common: CfdStateCommon, dlc: Dlc }, + PendingRefund { common: CfdStateCommon, dlc: Dlc }, /// The Cfd was refunded and the refund transaction reached finality /// @@ -328,7 +328,7 @@ impl CfdState { } pub fn must_refund(dlc: Dlc) -> Self { - Self::MustRefund { + Self::PendingRefund { common: CfdStateCommon::default(), dlc, } @@ -455,7 +455,7 @@ impl CfdState { CfdState::PendingOpen { common, .. } => common, CfdState::Open { common, .. } => common, CfdState::OpenCommitted { common, .. } => common, - CfdState::MustRefund { common, .. } => common, + CfdState::PendingRefund { common, .. } => common, CfdState::Refunded { common, .. } => common, CfdState::SetupFailed { common, .. } => common, CfdState::PendingCommit { common, .. } => common, @@ -511,7 +511,7 @@ impl fmt::Display for CfdState { CfdState::OpenCommitted { .. } => { write!(f, "Open Committed") } - CfdState::MustRefund { .. } => { + CfdState::PendingRefund { .. } => { write!(f, "Must Refund") } CfdState::Refunded { .. } => { @@ -835,11 +835,11 @@ impl Cfd { let dlc = if let OpenCommitted { dlc, .. } = self.state.clone() { dlc } else if let Open { dlc, .. } | PendingOpen { dlc, .. } = self.state.clone() { - tracing::debug!(%order_id, "Was in unexpected state {}, jumping ahead to MustRefund", self.state); + tracing::debug!(%order_id, "Was in unexpected state {}, jumping ahead to PendingRefund", self.state); dlc } else { bail!( - "Cannot transition to MustRefund because of unexpected state {}", + "Cannot transition to PendingRefund because of unexpected state {}", self.state ) }; @@ -983,10 +983,10 @@ impl Cfd { } pub fn refund_tx(&self) -> Result { - let dlc = if let CfdState::MustRefund { dlc, .. } = self.state.clone() { + let dlc = if let CfdState::PendingRefund { dlc, .. } = self.state.clone() { dlc } else { - bail!("Refund transaction can only be constructed when in state MustRefund, but we are currently in {}", self.state.clone()) + bail!("Refund transaction can only be constructed when in state PendingRefund, but we are currently in {}", self.state.clone()) }; let sig_hash = spending_tx_sighash( @@ -1132,7 +1132,7 @@ impl Cfd { } pub fn is_must_refund(&self) -> bool { - matches!(self.state.clone(), CfdState::MustRefund { .. }) + matches!(self.state.clone(), CfdState::PendingRefund { .. }) } pub fn is_pending_commit(&self) -> bool { @@ -1171,7 +1171,7 @@ impl Cfd { | CfdState::Rejected { .. } | CfdState::ContractSetup { .. } | CfdState::Closed { .. } - | CfdState::MustRefund { .. } + | CfdState::PendingRefund { .. } | CfdState::Refunded { .. } | CfdState::SetupFailed { .. } => None, } @@ -1211,7 +1211,7 @@ impl Cfd { | CfdState::PendingCommit { .. } | CfdState::Closed { .. } | CfdState::OpenCommitted { .. } - | CfdState::MustRefund { .. } + | CfdState::PendingRefund { .. } | CfdState::Refunded { .. } | CfdState::SetupFailed { .. } => None, } @@ -1239,7 +1239,7 @@ impl Cfd { | CfdState::PendingCet { .. } | CfdState::Closed { .. } | CfdState::OpenCommitted { .. } - | CfdState::MustRefund { .. } + | CfdState::PendingRefund { .. } | CfdState::Refunded { .. } | CfdState::SetupFailed { .. } => None, } @@ -1252,7 +1252,7 @@ impl Cfd { /// undecided pub fn payout(&self) -> Option { // early exit in case of refund scenario - if let CfdState::MustRefund { dlc, .. } | CfdState::Refunded { dlc, .. } = + if let CfdState::PendingRefund { dlc, .. } | CfdState::Refunded { dlc, .. } = self.state.clone() { return Some(dlc.refund_amount(self.role())); diff --git a/daemon/src/monitor.rs b/daemon/src/monitor.rs index 58a4cb5..48b9dcf 100644 --- a/daemon/src/monitor.rs +++ b/daemon/src/monitor.rs @@ -132,7 +132,7 @@ impl Actor { actor.monitor_commit_refund_timelock(¶ms, cfd.order.id); actor.monitor_refund_finality(¶ms,cfd.order.id); } - CfdState::MustRefund { dlc, .. } => { + CfdState::PendingRefund { dlc, .. } => { let params = MonitorParams::from_dlc_and_timelocks(dlc.clone(), cfd.refund_timelock_in_blocks()); actor.cfds.insert(cfd.order.id, params.clone()); diff --git a/daemon/src/oracle.rs b/daemon/src/oracle.rs index 3ba7bbb..d4d73df 100644 --- a/daemon/src/oracle.rs +++ b/daemon/src/oracle.rs @@ -86,7 +86,7 @@ impl Actor { // Final states | CfdState::Closed { .. } - | CfdState::MustRefund { .. } + | CfdState::PendingRefund { .. } | CfdState::Refunded { .. } | CfdState::SetupFailed { .. } => () } diff --git a/daemon/src/to_sse_event.rs b/daemon/src/to_sse_event.rs index 4fcd2f0..049e7e8 100644 --- a/daemon/src/to_sse_event.rs +++ b/daemon/src/to_sse_event.rs @@ -208,7 +208,7 @@ pub enum CfdState { IncomingRollOverProposal, OutgoingRollOverProposal, Closed, - MustRefund, + PendingRefund, Refunded, SetupFailed, } @@ -405,7 +405,7 @@ fn to_cfd_state( model::cfd::CfdState::PendingOpen { .. } => CfdState::PendingOpen, model::cfd::CfdState::Open { .. } => CfdState::Open, model::cfd::CfdState::OpenCommitted { .. } => CfdState::OpenCommitted, - model::cfd::CfdState::MustRefund { .. } => CfdState::MustRefund, + model::cfd::CfdState::PendingRefund { .. } => CfdState::PendingRefund, model::cfd::CfdState::Refunded { .. } => CfdState::Refunded, model::cfd::CfdState::SetupFailed { .. } => CfdState::SetupFailed, model::cfd::CfdState::PendingCommit { .. } => CfdState::PendingCommit, @@ -454,7 +454,7 @@ fn to_tx_url_list(state: model::cfd::CfdState, network: Network) -> Vec { } => { vec![tx_ub.collaborative_close(collaborative_close.tx.txid())] } - MustRefund { dlc, .. } => vec![tx_ub.lock(&dlc), tx_ub.commit(&dlc), tx_ub.refund(&dlc)], + PendingRefund { dlc, .. } => vec![tx_ub.lock(&dlc), tx_ub.commit(&dlc), tx_ub.refund(&dlc)], Refunded { dlc, .. } => vec![tx_ub.refund(&dlc)], OutgoingOrderRequest { .. } | IncomingOrderRequest { .. } @@ -538,8 +538,8 @@ mod tests { assert_eq!(json, "\"Open\""); let json = serde_json::to_string(&CfdState::OpenCommitted).unwrap(); assert_eq!(json, "\"OpenCommitted\""); - let json = serde_json::to_string(&CfdState::MustRefund).unwrap(); - assert_eq!(json, "\"MustRefund\""); + let json = serde_json::to_string(&CfdState::PendingRefund).unwrap(); + assert_eq!(json, "\"PendingRefund\""); let json = serde_json::to_string(&CfdState::Refunded).unwrap(); assert_eq!(json, "\"Refunded\""); let json = serde_json::to_string(&CfdState::SetupFailed).unwrap(); diff --git a/frontend/src/components/Types.tsx b/frontend/src/components/Types.tsx index d658fc5..a7b7e80 100644 --- a/frontend/src/components/Types.tsx +++ b/frontend/src/components/Types.tsx @@ -95,7 +95,7 @@ export class State { return "Rollover Proposed"; case StateKey.OUTGOING_ROLL_OVER_PROPOSAL: return "Rollover Proposed"; - case StateKey.MUST_REFUND: + case StateKey.PENDING_REFUND: return "Refunding"; case StateKey.REFUNDED: return "Refunded"; @@ -124,7 +124,7 @@ export class State { case StateKey.PENDING_COMMIT: case StateKey.OPEN_COMMITTED: - case StateKey.MUST_REFUND: + case StateKey.PENDING_REFUND: case StateKey.PENDING_CET: case StateKey.PENDING_CLOSE: return orange; @@ -158,7 +158,7 @@ export class State { case StateKey.OPEN: case StateKey.PENDING_COMMIT: case StateKey.OPEN_COMMITTED: - case StateKey.MUST_REFUND: + case StateKey.PENDING_REFUND: case StateKey.OUTGOING_SETTLEMENT_PROPOSAL: case StateKey.OUTGOING_ROLL_OVER_PROPOSAL: case StateKey.PENDING_CET: @@ -208,7 +208,7 @@ const enum StateKey { INCOMING_SETTLEMENT_PROPOSAL = "IncomingSettlementProposal", OUTGOING_ROLL_OVER_PROPOSAL = "OutgoingRollOverProposal", INCOMING_ROLL_OVER_PROPOSAL = "IncomingRollOverProposal", - MUST_REFUND = "MustRefund", + PENDING_REFUND = "PendingRefund", REFUNDED = "Refunded", SETUP_FAILED = "SetupFailed", CLOSED = "Closed",