chore: formatting / clippy, #5971

Author: fdefelici

stacks-signer/src/v0/signer.rs

@@ -52,7 +52,7 @@ use crate::client::{ClientError, SignerSlotID, StackerDB, StacksClient};
 use crate::config::{SignerConfig, SignerConfigMode};
 use crate::runloop::SignerResult;
 use crate::signerdb::{BlockInfo, BlockState, SignerDb};
-use crate::v0::signer_state::NewBurnBlock;
+use crate::v0::signer_state::{NewBurnBlock, TxReplayScopeOpt};
 use crate::Signer as SignerTrait;
 
 /// A global variable that can be used to make signers repeat their proposal
@@ -125,12 +125,8 @@ pub struct Signer {
     pub global_state_evaluator: GlobalStateEvaluator,
     /// Whether to validate blocks with replay transactions
     pub validate_with_replay_tx: bool,
-    /// TODO: To understand if keep this as a "local" state
-    ///       or if add this to the State Machine update
     /// Scope of Tx Replay in terms of Burn block boundaries
-    /// - .0 is the fork originating the tx replay,
-    /// - .1 is the canonical burnchain tip when Tx Replay begun
-    pub tx_replay_scope: Option<(NewBurnBlock, NewBurnBlock)>,
+    pub tx_replay_scope: TxReplayScopeOpt,
 }
 
 impl std::fmt::Display for SignerMode {
@@ -270,7 +266,7 @@ impl SignerTrait<SignerMessage> for Signer {
 
         let mut prior_state = self.local_state_machine.clone();
         if self.reward_cycle <= current_reward_cycle {
-            self.local_state_machine.handle_pending_update(&self.signer_db, stacks_client, 
+            self.local_state_machine.handle_pending_update(&self.signer_db, stacks_client,
                 &self.proposal_config,
                 &mut self.tx_replay_scope)
                 .unwrap_or_else(|e| error!("{self}: failed to update local state machine for pending update"; "err" => ?e));

stacks-signer/src/v0/signer_state.rs

@@ -88,6 +88,11 @@ pub struct NewBurnBlock {
     pub consensus_hash: ConsensusHash,
 }
 
+/// Scope of Tx Replay in terms of Burn block boundaries
+/// - tuple.0 is the fork originating the tx replay,
+/// - tuple.1 is the canonical burnchain tip when Tx Replay begun
+pub type TxReplayScopeOpt = Option<(NewBurnBlock, NewBurnBlock)>;
+
 impl LocalStateMachine {
     /// Initialize a local state machine by querying the local stacks-node
     ///  and signerdb for the current sortition information
@@ -192,7 +197,7 @@ impl LocalStateMachine {
         db: &SignerDb,
         client: &StacksClient,
         proposal_config: &ProposalEvalConfig,
-        tx_replay_scope: &mut Option<(NewBurnBlock, NewBurnBlock)>,
+        tx_replay_scope: &mut TxReplayScopeOpt,
     ) -> Result<(), SignerChainstateError> {
         let LocalStateMachine::Pending { update, .. } = self else {
             return self.check_miner_inactivity(db, client, proposal_config);
@@ -502,7 +507,7 @@ impl LocalStateMachine {
         client: &StacksClient,
         proposal_config: &ProposalEvalConfig,
         mut expected_burn_block: Option<NewBurnBlock>,
-        tx_replay_scope: &mut Option<(NewBurnBlock, NewBurnBlock)>,
+        tx_replay_scope: &mut TxReplayScopeOpt,
     ) -> Result<(), SignerChainstateError> {
         // set self to uninitialized so that if this function errors,
         //  self is left as uninitialized.
@@ -913,11 +918,8 @@ impl LocalStateMachine {
         expected_burn_block: &NewBurnBlock,
         prior_state_machine: &SignerStateMachine,
         is_in_tx_replay_mode: bool,
-        tx_replay_scope: &Option<(NewBurnBlock, NewBurnBlock)>,
-    ) -> Result<
-        Option<(Vec<StacksTransaction>, Option<(NewBurnBlock, NewBurnBlock)>)>,
-        SignerChainstateError,
-    > {
+        tx_replay_scope: &TxReplayScopeOpt,
+    ) -> Result<Option<(Vec<StacksTransaction>, TxReplayScopeOpt)>, SignerChainstateError> {
         if expected_burn_block.burn_block_height > prior_state_machine.burn_block_height {
             // no bitcoin fork, because we're advancing the burn block height
             return Ok(None);
@@ -953,7 +955,7 @@ impl LocalStateMachine {
             let updated_replay_set;
             let updated_scope_opt;
             if let Some(replay_set) =
-                self.compute_forked_txs_set(db, client, expected_burn_block, &past_tip)?
+                self.compute_forked_txs_set(db, client, expected_burn_block, past_tip)?
             {
                 let scope = (expected_burn_block.clone(), past_tip.clone());
 
@@ -1048,17 +1050,16 @@ impl LocalStateMachine {
                 ))
             .cloned()
             .collect::<Vec<_>>();
-        let scope_opt;
-        if forked_txs.len() > 0 {
+        let scope_opt = if !forked_txs.is_empty() {
             let scope = (expected_burn_block.clone(), potential_replay_tip);
             info!("Tx Replay: replay set updated with {} tx(s)", forked_txs.len();
             "tx_replay_set" => ?forked_txs,
             "tx_replay_scope" => ?scope);
-            scope_opt = Some(scope);
+            Some(scope)
         } else {
             info!("Tx Replay: no transactions to be replayed.");
-            scope_opt = None;
-        }
+            None
+        };
         Ok(Some((forked_txs, scope_opt)))
     }
 

testnet/stacks-node/src/tests/signer/v0.rs

@@ -3732,7 +3732,7 @@ fn tx_replay_disagreement() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay reject a proposal with partial replayed transactions,
+/// Demonstrates Tx Replay reject a proposal with partial replayed transactions,
 /// when not due to a Tenure Extend
 ///
 /// The test flow is:
@@ -4149,7 +4149,7 @@ fn tx_replay_rejected_when_forking_across_reward_cycle() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay state is kept by Signers after a fork
+/// Demonstrates Tx Replay state is kept by Signers after a fork
 /// occurred before the miner start replaying transactions
 ///
 /// The test flow is:
@@ -4487,7 +4487,7 @@ fn tx_replay_with_fork_after_empty_tenures_before_starting_replaying_txs() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay Set to be updated from a deepest fork
+/// Demonstrates Tx Replay Set to be updated from a deepest fork
 /// than the one that made Tx Replay to start
 ///
 /// The test flow is:
@@ -4660,7 +4660,7 @@ fn tx_replay_with_fork_causing_replay_set_to_be_updated() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay Set to be cleared from a deepest fork
+/// Demonstrates Tx Replay Set to be cleared from a deepest fork
 /// than the one that made Tx Replay to start, that led to
 /// previous reward cylce
 ///
@@ -4809,7 +4809,7 @@ fn tx_replay_with_fork_causing_replay_to_be_cleared_due_to_cycle() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay restart from scratch while it is in progress
+/// Demonstrates Tx Replay restart from scratch while it is in progress
 /// (partially replayed a subset of transaction) and a fork occurs.
 /// In this case, partial replay is allowed because of tenure extend,
 /// due to Tenure Budget exceeded.
@@ -5024,7 +5024,7 @@ fn tx_replay_with_fork_middle_replay_while_tenure_extending() {
 
 #[test]
 #[ignore]
-/// Demostrate Tx Replay restart from scratch while it is in progress
+/// Demonstrates Tx Replay restart from scratch while it is in progress
 /// (partially replayed a subset of transaction), other transactions
 /// are submitted, and then a fork occurs.
 /// In this case, partial replay is allowed because of tenure extend,