Merge branch 'develop' of https://github.com/stacks-network/stacks-core into fix/clippy-ci-stacks-lib-bind-instead-of-map

jferrant · jferrant · commit 2f87f197430d · 2025-01-09T07:57:17.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,15 +16,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 - When a transaction is dropped due to replace-by-fee, the `/drop_mempool_tx` event observer payload now includes `new_txid`, which is the transaction that replaced this dropped transaction. When a transaction is dropped for other reasons, `new_txid` is `null`. [#5381](https://github.com/stacks-network/stacks-core/pull/5381)
 - Nodes will assume that all PoX anchor blocks exist by default, and stall initial block download indefinitely to await their arrival (#5502)
 
-## [3.1.0.0.1]
-
-### Added
-
-- A miner will now generate a tenure-extend when at least 70% of the signers have confirmed that they are willing to allow one, via the new timestamp included in block responses. This allows the miner to refresh its budget in between Bitcoin blocks. ([#5476](https://github.com/stacks-network/stacks-core/discussions/5476))
-
-### Changed
-
-## [3.1.0.0.0]
+## [3.1.0.0.2]
 
 ### Added
 
@@ -33,6 +25,8 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
   - `/v2/clarity/marf/:marf_key_hash`
   - `/v2/clarity/metadata/:principal/:contract_name/:clarity_metadata_key`
 - When a proposed block is validated by a node, the block can be validated even when the block version is different than the node's default ([#5539](https://github.com/stacks-network/stacks-core/pull/5539))
+- A miner will now generate a tenure-extend when at least 70% of the signers have confirmed that they are willing to allow one, via the new timestamp included in block responses. This allows the miner to refresh its budget in between Bitcoin blocks. ([#5476](https://github.com/stacks-network/stacks-core/discussions/5476))
+- Set the epoch to 3.1 in the Clarity DB upon activation.
 
 ### Changed
 
diff --git a/sample/conf/testnet-follower-conf.toml b/sample/conf/testnet-follower-conf.toml
@@ -77,8 +77,8 @@ start_height = 6
 
 [[burnchain.epochs]]
 epoch_name = "3.0"
-start_height = 56_457
+start_height = 1900
 
 [[burnchain.epochs]]
 epoch_name = "3.1"
-start_height = 77_770
+start_height = 2000
diff --git a/sample/conf/testnet-miner-conf.toml b/sample/conf/testnet-miner-conf.toml
@@ -73,8 +73,8 @@ start_height = 6
 
 [[burnchain.epochs]]
 epoch_name = "3.0"
-start_height = 56_457
+start_height = 1900
 
 [[burnchain.epochs]]
 epoch_name = "3.1"
-start_height = 77_770
+start_height = 2000
diff --git a/sample/conf/testnet-signer.toml b/sample/conf/testnet-signer.toml
@@ -75,4 +75,8 @@ start_height = 6
 
 [[burnchain.epochs]]
 epoch_name = "3.0"
-start_height = 56_457
+start_height = 1900
+
+[[burnchain.epochs]]
+epoch_name = "3.1"
+start_height = 2000
diff --git a/stacks-signer/CHANGELOG.md b/stacks-signer/CHANGELOG.md
@@ -15,15 +15,26 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 - Improvements to the stale signer cleanup logic: deletes the prior signer if it has no remaining unprocessed blocks in its database
 - Signers now listen to new block events from the stacks node to determine whether a block has been successfully appended to the chain tip
 
-## [3.1.0.0.1.0]
+# [3.1.0.0.2.1]
 
-### Added
+## Added
+
+## Changed
+
+- Prevent old reward cycle signers from processing block validation response messages that do not apply to blocks from their cycle.
+
+## [3.1.0.0.2.0]
+
+## Added
+
+- **SIP-029 consensus rules, activating in epoch 3.1 at block 875,000** (see [SIP-029](https://github.com/will-corcoran/sips/blob/feat/sip-029-halving-alignment/sips/sip-029/sip-029-halving-alignment.md) for details)
 
 ### Changed
 
 - Added tenure extend timestamp to signer block responses
 - Added tenure_idle_timeout_secs configuration option for determining when a time-based tenure extend will be accepted
 
+
 ## [3.1.0.0.0.0]
 
 ### Added
diff --git a/stacks-signer/src/v0/signer.rs b/stacks-signer/src/v0/signer.rs
@@ -659,6 +659,14 @@ impl Signer {
         // For mutability reasons, we need to take the block_info out of the map and add it back after processing
         let mut block_info = match self.signer_db.block_lookup(&signer_signature_hash) {
             Ok(Some(block_info)) => {
+                if block_info.reward_cycle != self.reward_cycle {
+                    // We are not signing for this reward cycle. Ignore the block.
+                    debug!(
+                        "{self}: Received a block validation response for a different reward cycle. Ignore it.";
+                        "requested_reward_cycle" => block_info.reward_cycle,
+                    );
+                    return None;
+                }
                 if block_info.is_locally_finalized() {
                     debug!("{self}: Received block validation for a block that is already marked as {}. Ignoring...", block_info.state);
                     return None;
@@ -744,6 +752,14 @@ impl Signer {
         }
         let mut block_info = match self.signer_db.block_lookup(&signer_signature_hash) {
             Ok(Some(block_info)) => {
+                if block_info.reward_cycle != self.reward_cycle {
+                    // We are not signing for this reward cycle. Ignore the block.
+                    debug!(
+                        "{self}: Received a block validation response for a different reward cycle. Ignore it.";
+                        "requested_reward_cycle" => block_info.reward_cycle,
+                    );
+                    return None;
+                }
                 if block_info.is_locally_finalized() {
                     debug!("{self}: Received block validation for a block that is already marked as {}. Ignoring...", block_info.state);
                     return None;
diff --git a/stackslib/Cargo.toml b/stackslib/Cargo.toml
@@ -12,7 +12,7 @@ keywords = [ "stacks", "stx", "bitcoin", "crypto", "blockstack", "decentralized"
 readme = "README.md"
 resolver = "2"
 edition = "2021"
-rust-version = "1.61"
+rust-version = "1.80"
 
 [lib]
 name = "blockstack_lib"
diff --git a/stackslib/src/chainstate/burn/operations/delegate_stx.rs b/stackslib/src/chainstate/burn/operations/delegate_stx.rs
@@ -237,7 +237,7 @@ impl StacksMessageCodec for DelegateStxOp {
         } else {
             fd.write_all(&0_u8.to_be_bytes())
                 .map_err(|e| codec_error::WriteError(e))?;
-            fd.write_all(&0_u8.to_be_bytes())
+            fd.write_all(&0_u32.to_be_bytes())
                 .map_err(|e| codec_error::WriteError(e))?;
         }
 
diff --git a/stackslib/src/chainstate/nakamoto/mod.rs b/stackslib/src/chainstate/nakamoto/mod.rs
@@ -3943,7 +3943,11 @@ impl NakamotoChainState {
 
         // is this stacks block the first of a new epoch?
         let (applied_epoch_transition, mut tx_receipts) =
-            StacksChainState::process_epoch_transition(&mut clarity_tx, burn_header_height)?;
+            StacksChainState::process_epoch_transition(
+                &mut clarity_tx,
+                sortition_dbconn.as_burn_state_db(),
+                burn_header_height,
+            )?;
 
         debug!(
             "Setup block: Processed epoch transition";
diff --git a/stackslib/src/chainstate/nakamoto/test_signers.rs b/stackslib/src/chainstate/nakamoto/test_signers.rs
@@ -264,7 +264,7 @@ impl TestSigners {
 
         let aggregate_public_key: Vec<u8> =
             rand::thread_rng().sample_iter(Standard).take(33).collect();
-        self.aggregate_public_key = aggregate_public_key.clone();
+        self.aggregate_public_key.clone_from(&aggregate_public_key);
         aggregate_public_key
     }
 }
diff --git a/stackslib/src/chainstate/stacks/block.rs b/stackslib/src/chainstate/stacks/block.rs
@@ -444,14 +444,14 @@ impl StacksBlock {
         let mut txids = HashMap::new();
         for (i, tx) in txs.iter().enumerate() {
             let txid = tx.txid();
-            if txids.get(&txid).is_some() {
+            if txids.contains_key(&txid) {
                 warn!(
                     "Duplicate tx {}: at index {} and {}",
                     txid,
                     txids.get(&txid).unwrap(),
                     i
                 );
-                test_debug!("{:?}", &tx);
+                test_debug!("{tx:?}");
                 return false;
             }
             txids.insert(txid, i);
diff --git a/stackslib/src/chainstate/stacks/db/blocks.rs b/stackslib/src/chainstate/stacks/db/blocks.rs
@@ -4046,6 +4046,7 @@ impl StacksChainState {
     /// Return (applied?, receipts)
     pub fn process_epoch_transition(
         clarity_tx: &mut ClarityTx,
+        burn_dbconn: &dyn BurnStateDB,
         chain_tip_burn_header_height: u32,
     ) -> Result<(bool, Vec<StacksTransactionReceipt>), Error> {
         // is this stacks block the first of a new epoch?
@@ -4106,14 +4107,29 @@ impl StacksChainState {
                         current_epoch = StacksEpochId::Epoch30;
                     }
                     StacksEpochId::Epoch30 => {
-                        // no special initialization is needed, since only the coinbase emission
-                        // schedule is changing.
+                        receipts.append(&mut clarity_tx.block.initialize_epoch_3_1()?);
                         current_epoch = StacksEpochId::Epoch31;
                     }
                     StacksEpochId::Epoch31 => {
                         panic!("No defined transition from Epoch31 forward")
                     }
                 }
+
+                if current_epoch > StacksEpochId::Epoch2_05 {
+                    // clarity tx should now have the current epoch
+                    assert_eq!(
+                        clarity_tx.block.get_epoch(),
+                        current_epoch,
+                        "FATAL: clarity_tx does not have the current epoch"
+                    );
+
+                    // clarity DB should now have the current epoch
+                    assert_eq!(
+                        clarity_tx.block.get_clarity_db_epoch_version(burn_dbconn)?,
+                        current_epoch,
+                        "FATAL: clarity DB does not report the current epoch"
+                    );
+                }
             }
         }
 
@@ -5200,7 +5216,11 @@ impl StacksChainState {
 
         // is this stacks block the first of a new epoch?
         let (applied_epoch_transition, mut tx_receipts) =
-            StacksChainState::process_epoch_transition(&mut clarity_tx, burn_tip_height)?;
+            StacksChainState::process_epoch_transition(
+                &mut clarity_tx,
+                burn_dbconn,
+                burn_tip_height,
+            )?;
 
         debug!(
             "Setup block: Processed epoch transition at {}/{}",
diff --git a/stackslib/src/chainstate/stacks/index/trie.rs b/stackslib/src/chainstate/stacks/index/trie.rs
@@ -281,7 +281,7 @@ impl Trie {
             )));
         }
 
-        value.path = cur_leaf.path_bytes().clone();
+        value.path.clone_from(cur_leaf.path_bytes());
 
         let leaf_hash = get_leaf_hash(value);
 
diff --git a/stackslib/src/chainstate/stacks/tests/chain_histories.rs b/stackslib/src/chainstate/stacks/tests/chain_histories.rs
@@ -2857,7 +2857,7 @@ pub fn mine_invalid_token_transfers_block(
     );
     builder.force_mine_tx(clarity_tx, &tx1).unwrap();
 
-    if miner.spent_at_nonce.get(&1).is_none() {
+    if !miner.spent_at_nonce.contains_key(&1) {
         miner.spent_at_nonce.insert(1, 11111);
     }
 
@@ -2871,7 +2871,7 @@ pub fn mine_invalid_token_transfers_block(
     );
     builder.force_mine_tx(clarity_tx, &tx2).unwrap();
 
-    if miner.spent_at_nonce.get(&2).is_none() {
+    if !miner.spent_at_nonce.contains_key(&2) {
         miner.spent_at_nonce.insert(2, 22222);
     }
 
diff --git a/stackslib/src/chainstate/stacks/tests/mod.rs b/stackslib/src/chainstate/stacks/tests/mod.rs
@@ -214,7 +214,7 @@ impl TestMinerTrace {
         let mut num_blocks = 0;
         for p in self.points.iter() {
             for miner_id in p.stacks_blocks.keys() {
-                if p.stacks_blocks.get(miner_id).is_some() {
+                if p.stacks_blocks.contains_key(miner_id) {
                     num_blocks += 1;
                 }
             }
@@ -227,7 +227,7 @@ impl TestMinerTrace {
         let mut num_sortitions = 0;
         for p in self.points.iter() {
             for miner_id in p.fork_snapshots.keys() {
-                if p.fork_snapshots.get(miner_id).is_some() {
+                if p.fork_snapshots.contains_key(miner_id) {
                     num_sortitions += 1;
                 }
             }
diff --git a/stackslib/src/clarity_cli.rs b/stackslib/src/clarity_cli.rs
@@ -35,7 +35,7 @@ use stacks_common::types::chainstate::{
 };
 use stacks_common::types::sqlite::NO_PARAMS;
 use stacks_common::util::hash::{bytes_to_hex, Hash160, Sha512Trunc256Sum};
-use stacks_common::util::{cargo_workspace, get_epoch_time_ms, log};
+use stacks_common::util::{get_epoch_time_ms, log};
 
 use crate::burnchains::{Address, PoxConstants, Txid};
 use crate::chainstate::stacks::boot::{
@@ -1950,6 +1950,8 @@ pub fn invoke_command(invoked_by: &str, args: &[String]) -> (i32, Option<serde_j
 mod test {
     use std::path::Path;
 
+    use stacks_common::util::cargo_workspace;
+
     use super::*;
 
     #[test]
diff --git a/stackslib/src/clarity_vm/clarity.rs b/stackslib/src/clarity_vm/clarity.rs
@@ -226,6 +226,21 @@ impl ClarityBlockConnection<'_, '_> {
             None => None,
         }
     }
+
+    /// Load the epoch ID from the clarity DB.
+    /// Used to sanity-check epoch transitions.
+    pub fn get_clarity_db_epoch_version(
+        &mut self,
+        burn_state_db: &dyn BurnStateDB,
+    ) -> Result<StacksEpochId, Error> {
+        let mut db = self.datastore.as_clarity_db(self.header_db, burn_state_db);
+        // NOTE: the begin/roll_back shouldn't be necessary with how this gets used in practice,
+        // but is put here defensively.
+        db.begin();
+        let result = db.get_clarity_epoch_version();
+        db.roll_back()?;
+        Ok(result?)
+    }
 }
 
 impl ClarityInstance {
@@ -822,9 +837,9 @@ impl<'a> ClarityBlockConnection<'a, '_> {
 
             // instantiate costs 2 contract...
             let cost_2_code = if mainnet {
-                &*BOOT_CODE_COSTS_2
+                BOOT_CODE_COSTS_2
             } else {
-                &*BOOT_CODE_COSTS_2_TESTNET
+                BOOT_CODE_COSTS_2_TESTNET
             };
 
             let payload = TransactionPayload::SmartContract(
@@ -1013,7 +1028,7 @@ impl<'a> ClarityBlockConnection<'a, '_> {
             }
 
             /////////////////// .costs-3 ////////////////////////
-            let cost_3_code = &*BOOT_CODE_COSTS_3;
+            let cost_3_code = BOOT_CODE_COSTS_3;
 
             let payload = TransactionPayload::SmartContract(
                 TransactionSmartContract {
@@ -1524,6 +1539,32 @@ impl<'a> ClarityBlockConnection<'a, '_> {
         })
     }
 
+    pub fn initialize_epoch_3_1(&mut self) -> Result<Vec<StacksTransactionReceipt>, Error> {
+        // use the `using!` statement to ensure that the old cost_tracker is placed
+        //  back in all branches after initialization
+        using!(self.cost_track, "cost tracker", |old_cost_tracker| {
+            // epoch initialization is *free*.
+            // NOTE: this also means that cost functions won't be evaluated.
+            self.cost_track.replace(LimitedCostTracker::new_free());
+            self.epoch = StacksEpochId::Epoch31;
+            self.as_transaction(|tx_conn| {
+                // bump the epoch in the Clarity DB
+                tx_conn
+                    .with_clarity_db(|db| {
+                        db.set_clarity_epoch_version(StacksEpochId::Epoch31)?;
+                        Ok(())
+                    })
+                    .unwrap();
+
+                // require 3.1 rules henceforth in this connection as well
+                tx_conn.epoch = StacksEpochId::Epoch31;
+            });
+
+            debug!("Epoch 3.1 initialized");
+            (old_cost_tracker, Ok(vec![]))
+        })
+    }
+
     pub fn start_transaction_processing<'c>(&'c mut self) -> ClarityTransactionConnection<'c, 'a> {
         let store = &mut self.datastore;
         let cost_track = &mut self.cost_track;
diff --git a/stackslib/src/config/mod.rs b/stackslib/src/config/mod.rs
@@ -1438,7 +1438,7 @@ impl BurnchainConfigFile {
             // check magic bytes and set if not defined
             let mainnet_magic = ConfigFile::mainnet().burnchain.unwrap().magic_bytes;
             if self.magic_bytes.is_none() {
-                self.magic_bytes = mainnet_magic.clone();
+                self.magic_bytes.clone_from(&mainnet_magic);
             }
             if self.magic_bytes != mainnet_magic {
                 return Err(format!(
diff --git a/stackslib/src/core/mod.rs b/stackslib/src/core/mod.rs
@@ -496,7 +496,10 @@ pub static STACKS_EPOCH_3_0_MARKER: u8 = 0x0b;
 
 /// Stacks 3.1 epoch marker.  All block-commits in 3.1 must have a memo bitfield with this value
 /// *or greater*.
-pub static STACKS_EPOCH_3_1_MARKER: u8 = 0x0c;
+/// NOTE: it has to be 0x0d because a prior release of 3.1 with 0x0c before activation had a
+/// consensus bug. This forces miners with this buggy release off the network if they are still
+/// running it prior to 3.1 activation.
+pub static STACKS_EPOCH_3_1_MARKER: u8 = 0x0d;
 
 #[test]
 fn test_ord_for_stacks_epoch() {
diff --git a/stackslib/src/core/tests/mod.rs b/stackslib/src/core/tests/mod.rs
@@ -1266,7 +1266,7 @@ fn test_iterate_candidates_concurrent_write_lock() {
     assert_eq!(all_addr_nonces.len(), expected_addr_nonces.len());
 
     for (addr, nonce) in all_addr_nonces {
-        assert!(expected_addr_nonces.get(&addr).is_some());
+        assert!(expected_addr_nonces.contains_key(&addr));
         assert_eq!(nonce, 24);
     }
 }
diff --git a/stackslib/src/net/api/postblock_proposal.rs b/stackslib/src/net/api/postblock_proposal.rs
diff --git a/stackslib/src/net/chat.rs b/stackslib/src/net/chat.rs
diff --git a/stackslib/src/net/httpcore.rs b/stackslib/src/net/httpcore.rs
diff --git a/stackslib/src/net/inv/nakamoto.rs b/stackslib/src/net/inv/nakamoto.rs
diff --git a/stackslib/src/net/p2p.rs b/stackslib/src/net/p2p.rs
diff --git a/stackslib/src/net/relay.rs b/stackslib/src/net/relay.rs
diff --git a/stackslib/src/net/tests/download/nakamoto.rs b/stackslib/src/net/tests/download/nakamoto.rs
diff --git a/stackslib/src/net/tests/httpcore.rs b/stackslib/src/net/tests/httpcore.rs
diff --git a/stackslib/src/net/tests/mempool/mod.rs b/stackslib/src/net/tests/mempool/mod.rs
diff --git a/stackslib/src/net/tests/neighbors.rs b/stackslib/src/net/tests/neighbors.rs

Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ impl StacksMessageCodec for DelegateStxOp {`
`237`	`237`	`} else {`
`238`	`238`	`fd.write_all(&0_u8.to_be_bytes())`
`239`	`239`	`.map_err(\|e\| codec_error::WriteError(e))?;`
`240`		`- fd.write_all(&0_u8.to_be_bytes())`
	`240`	`+ fd.write_all(&0_u32.to_be_bytes())`
`241`	`241`	`.map_err(\|e\| codec_error::WriteError(e))?;`
`242`	`242`	`}`
`243`	`243`
Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,7 @@ impl TestSigners {`
`264`	`264`
`265`	`265`	`let aggregate_public_key: Vec<u8> =`
`266`	`266`	`rand::thread_rng().sample_iter(Standard).take(33).collect();`
`267`		`- self.aggregate_public_key = aggregate_public_key.clone();`
	`267`	`+ self.aggregate_public_key.clone_from(&aggregate_public_key);`
`268`	`268`	`aggregate_public_key`
`269`	`269`	`}`
`270`	`270`	`}`