Merge branch 'feat/clarity-5' into feat/increase-stack-depth

Author: brice-stacks

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to the versioning scheme outlined in the [README.md](README.md).
 
+## [Unreleased]
+
+### Added
+
+- Setup for epoch 3.4 and Clarity version 5. Epoch 3.4 is currently set to activate at Bitcoin height 3,400,000 (very far in the future) until an activation height is selected. Clarity will activate with epoch 3.4.
+
 ## [3.3.0.0.4]
 
 ### Added

CONTRIBUTING.md

@@ -386,6 +386,25 @@ A test should be marked `#[ignore]` if:
   | `bitcoind`      | tests requiring bitcoin daemon               |
   | `flaky`         | tests that exhibit flaky behavior            |
 
+- **Consensus tests use `insta` to record snapshots** and then compare results across runs to ensure that there are no accidental consensus changes.
+1. Install `insta`:
+
+```bash
+cargo install cargo-insta
+```
+
+2. Run snapshot tests with `insta`:
+
+```bash
+cargo insta test -p stackslib --unreferenced=delete -- chainstate::tests --include-ignored
+```
+
+3. Review/accept snapshot updates:
+
+```bash
+cargo insta review
+```
+
 ## Formatting
 
 PRs will be checked against `rustfmt` and will _fail_ if not properly formatted.

README.md

@@ -79,24 +79,6 @@ cargo nextest run
 
 _On Windows, many tests will fail, mainly due to parallelism. To mitigate the issue you may need to run the tests individually._
 
-**Install `insta` for snapshot tests:**
-
-```bash
-cargo install cargo-insta
-```
-
-**Run snapshot tests with `insta`:**
-
-```bash
-cargo insta test
-```
-
-**Review/accept snapshot updates:**
-
-```bash
-cargo insta review
-```
-
 ## Run the testnet
 
 You can observe the state machine in action locally by running:

clarity/src/vm/tests/proptest_utils.rs

@@ -41,8 +41,8 @@ use crate::vm::database::STXBalance;
 use crate::vm::errors::{ClarityEvalError, VmExecutionError};
 use crate::vm::{ClarityVersion, execute_with_parameters_and_call_in_global_context};
 
-const DEFAULT_EPOCH: StacksEpochId = StacksEpochId::Epoch34;
-const DEFAULT_CLARITY_VERSION: ClarityVersion = ClarityVersion::Clarity5;
+const DEFAULT_EPOCH: StacksEpochId = StacksEpochId::latest();
+const DEFAULT_CLARITY_VERSION: ClarityVersion = ClarityVersion::latest();
 const INITIAL_BALANCE: u128 = 1_000_000_000;
 const UTF8_SNIPPET_MAX_SEGMENTS: usize = 16;
 const UTF8_SIMPLE_ESCAPES: [&str; 6] = ["\\\"", "\\\\", "\\n", "\\t", "\\r", "\\0"];

clarity/src/vm/version.rs

@@ -39,7 +39,7 @@ impl fmt::Display for ClarityVersion {
 }
 
 impl ClarityVersion {
-    pub fn latest() -> ClarityVersion {
+    pub const fn latest() -> ClarityVersion {
         ClarityVersion::Clarity4
     }
 

stacks-node/src/tests/nakamoto_integrations.rs

@@ -14198,6 +14198,20 @@ fn test_epoch_3_3_activation() {
     naka_conf.node.pox_sync_sample_secs = 180;
     naka_conf.burnchain.max_rbf = 10_000_000;
 
+    // Remove epochs beyond 3.3 for this test and extend epoch 3.3 to max height
+    {
+        let epochs = naka_conf
+            .burnchain
+            .epochs
+            .as_mut()
+            .expect("Missing burnchain epochs in config");
+        epochs.truncate_after(StacksEpochId::Epoch33);
+        epochs
+            .get_mut(StacksEpochId::Epoch33)
+            .expect("Missing epoch 3.3 in config")
+            .end_height = STACKS_EPOCH_MAX;
+    }
+
     let sender_signer_sk = Secp256k1PrivateKey::random();
     let sender_signer_addr = tests::to_addr(&sender_signer_sk);
     let mut signers = TestSigners::new(vec![sender_signer_sk.clone()]);

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

@@ -51,7 +51,7 @@ use stacks::core::test_util::{
     insert_tx_in_mempool, make_contract_call, make_contract_publish,
     make_stacks_transfer_serialized,
 };
-use stacks::core::{StacksEpochId, CHAIN_ID_TESTNET};
+use stacks::core::{StacksEpochId, CHAIN_ID_TESTNET, STACKS_EPOCH_MAX};
 use stacks::libstackerdb::StackerDBChunkData;
 use stacks::net::api::getsigner::GetSignerResponse;
 use stacks::net::api::postblock_proposal::{
@@ -2803,14 +2803,10 @@ fn mock_sign_epoch_25() {
         |node_config| {
             node_config.miner.pre_nakamoto_mock_signing = true;
             let epochs = node_config.burnchain.epochs.as_mut().unwrap();
+            epochs.truncate_after(StacksEpochId::Epoch30);
             epochs[StacksEpochId::Epoch25].end_height = 251;
             epochs[StacksEpochId::Epoch30].start_height = 251;
-            epochs[StacksEpochId::Epoch30].end_height = 265;
-            epochs[StacksEpochId::Epoch31].start_height = 265;
-            epochs[StacksEpochId::Epoch31].end_height = 285;
-            epochs[StacksEpochId::Epoch32].start_height = 285;
-            epochs[StacksEpochId::Epoch32].end_height = 305;
-            epochs[StacksEpochId::Epoch33].start_height = 305;
+            epochs[StacksEpochId::Epoch30].end_height = STACKS_EPOCH_MAX;
         },
         None,
         None,
@@ -2925,14 +2921,10 @@ fn multiple_miners_mock_sign_epoch_25() {
         |config| {
             config.miner.pre_nakamoto_mock_signing = true;
             let epochs = config.burnchain.epochs.as_mut().unwrap();
+            epochs.truncate_after(StacksEpochId::Epoch30);
             epochs[StacksEpochId::Epoch25].end_height = 251;
             epochs[StacksEpochId::Epoch30].start_height = 251;
-            epochs[StacksEpochId::Epoch30].end_height = 265;
-            epochs[StacksEpochId::Epoch31].start_height = 265;
-            epochs[StacksEpochId::Epoch31].end_height = 285;
-            epochs[StacksEpochId::Epoch32].start_height = 285;
-            epochs[StacksEpochId::Epoch32].end_height = 305;
-            epochs[StacksEpochId::Epoch33].start_height = 305;
+            epochs[StacksEpochId::Epoch30].end_height = STACKS_EPOCH_MAX;
         },
         |_| {},
     );

stackslib/src/chainstate/nakamoto/coordinator/tests.rs

@@ -1073,6 +1073,8 @@ fn block_info_tests(use_primary_testnet: bool) {
             ClarityVersion::Clarity2 => panic!("Clarity2 not supported in this test"),
             ClarityVersion::Clarity3 => &clar3_contract_id,
             ClarityVersion::Clarity4 => &clar4_contract_id,
+            // Later versions of Clarity are just running the same code as Clarity4 for now
+            // so it's not necessary to test them all individually here.
             ClarityVersion::Clarity5 => panic!("Clarity5 not supported in this test"),
         };
         peer.with_db_state(|sortdb, chainstate, _, _| {

stackslib/src/chainstate/stacks/block.rs

@@ -586,10 +586,17 @@ impl StacksBlock {
             }
         }
         if let TransactionPayload::SmartContract(_, ref version_opt) = &tx.payload {
-            if version_opt.is_some() && epoch_id < StacksEpochId::Epoch21 {
-                // not supported
-                error!("Versioned smart contracts not supported before Stacks 2.1");
-                return false;
+            if let Some(version) = version_opt {
+                if epoch_id < StacksEpochId::Epoch21 {
+                    // not supported
+                    error!("Versioned smart contracts not supported before Stacks 2.1"; "txid" => %tx.txid());
+                    return false;
+                }
+                if *version > ClarityVersion::default_for_epoch(epoch_id) {
+                    // not supported
+                    error!("Smart contract version {version} not supported in Epoch {epoch_id}"; "txid" => %tx.txid());
+                    return false;
+                }
             }
         }
         if let TransactionPayload::TenureChange(..) = &tx.payload {
@@ -2075,6 +2082,38 @@ mod test {
         );
     }
 
+    #[test]
+    fn test_validate_transaction_static_epoch_rejects_future_clarity_version() {
+        let privk = StacksPrivateKey::random();
+        let origin_auth = TransactionAuth::Standard(
+            TransactionSpendingCondition::new_singlesig_p2pkh(StacksPublicKey::from_private(
+                &privk,
+            ))
+            .unwrap(),
+        );
+
+        let tx_future_clarity = StacksTransaction::new(
+            TransactionVersion::Testnet,
+            origin_auth,
+            TransactionPayload::SmartContract(
+                TransactionSmartContract {
+                    name: ContractName::try_from("future-clarity").unwrap(),
+                    code_body: StacksString::from_str("(print \"hi\")").unwrap(),
+                },
+                Some(ClarityVersion::Clarity5),
+            ),
+        );
+
+        assert!(!StacksBlock::validate_transaction_static_epoch(
+            &tx_future_clarity,
+            StacksEpochId::Epoch33
+        ));
+        assert!(StacksBlock::validate_transaction_static_epoch(
+            &tx_future_clarity,
+            StacksEpochId::Epoch34
+        ));
+    }
+
     // TODO:
     // * size limits
 }

stackslib/src/chainstate/tests/snapshots/blockstack_lib__chainstate__tests__runtime_analysis_tests__runtime_check_error_kind_type_value_error_cdeploy.snap

@@ -124,7 +124,7 @@ expression: result
     ),
   )),
   Success(ExpectedBlockOutput(
-    marf_hash: "d97ac1a81d416d203e31c2d2dd5df5799678570ae74437b634f81893655d9d7f",
+    marf_hash: "81565262f144b87f9a1e18dff14d76c347aea39af8ae479eb4550685d19274eb",
     evaluated_epoch: Epoch34,
     transactions: [
       ExpectedTransactionOutput(
@@ -137,24 +137,24 @@ expression: result
           )),
         )),
         cost: ExecutionCost(
-          write_length: 317,
+          write_length: 61,
           write_count: 2,
           read_length: 1,
           read_count: 1,
-          runtime: 21506,
+          runtime: 11778,
         ),
       ),
     ],
     total_block_cost: ExecutionCost(
-      write_length: 317,
+      write_length: 61,
       write_count: 2,
       read_length: 1,
       read_count: 1,
-      runtime: 21506,
+      runtime: 11778,
     ),
   )),
   Success(ExpectedBlockOutput(
-    marf_hash: "4c4d05e4f21378260832a34e3fdbbe2a41690d1d652146a116b2d59f9b6f7ee8",
+    marf_hash: "f495dd8ffa77bc1eb67ac5f4ce1c6b33265052b0097268a8dfa0f85418476263",
     evaluated_epoch: Epoch34,
     transactions: [
       ExpectedTransactionOutput(
@@ -167,24 +167,24 @@ expression: result
           )),
         )),
         cost: ExecutionCost(
-          write_length: 317,
+          write_length: 61,
           write_count: 2,
           read_length: 1,
           read_count: 1,
-          runtime: 21505,
+          runtime: 11777,
         ),
       ),
     ],
     total_block_cost: ExecutionCost(
-      write_length: 317,
+      write_length: 61,
       write_count: 2,
       read_length: 1,
       read_count: 1,
-      runtime: 21505,
+      runtime: 11777,
     ),
   )),
   Success(ExpectedBlockOutput(
-    marf_hash: "be35362c8a84c147289373b6d9760a3fc5099562cbe5d29d9a4399cac0126d99",
+    marf_hash: "64469320b976be3dbc1c33ac4bdb30a79a1970913efda5d47d906e4f66b2cdd4",
     evaluated_epoch: Epoch34,
     transactions: [
       ExpectedTransactionOutput(
@@ -197,24 +197,24 @@ expression: result
           )),
         )),
         cost: ExecutionCost(
-          write_length: 317,
+          write_length: 61,
           write_count: 2,
           read_length: 1,
           read_count: 1,
-          runtime: 21505,
+          runtime: 11777,
         ),
       ),
     ],
     total_block_cost: ExecutionCost(
-      write_length: 317,
+      write_length: 61,
       write_count: 2,
       read_length: 1,
       read_count: 1,
-      runtime: 21505,
+      runtime: 11777,
     ),
   )),
   Success(ExpectedBlockOutput(
-    marf_hash: "9fdaef3be137cc6eb023d8783478afb25ad4cbbc2b0063f54fa17a9f943c3c8c",
+    marf_hash: "58b8bf7b6c0e7ab4c37bf5fc81d98bd0f67c7be14c8d89dfbb379472753c28c6",
     evaluated_epoch: Epoch34,
     transactions: [
       ExpectedTransactionOutput(
@@ -227,24 +227,24 @@ expression: result
           )),
         )),
         cost: ExecutionCost(
-          write_length: 317,
+          write_length: 61,
           write_count: 2,
           read_length: 1,
           read_count: 1,
-          runtime: 21505,
+          runtime: 11777,
         ),
       ),
     ],
     total_block_cost: ExecutionCost(
-      write_length: 317,
+      write_length: 61,
       write_count: 2,
       read_length: 1,
       read_count: 1,
-      runtime: 21505,
+      runtime: 11777,
     ),
   )),
   Success(ExpectedBlockOutput(
-    marf_hash: "038c5362749db3ffdf88a56f598e823b02abd27c01c97552efe6102c1b280532",
+    marf_hash: "ee614f81fb04d25637dd7347ec1146739236fcdc8ef76ee6bb6763d80e545281",
     evaluated_epoch: Epoch34,
     transactions: [
       ExpectedTransactionOutput(
@@ -257,20 +257,20 @@ expression: result
           )),
         )),
         cost: ExecutionCost(
-          write_length: 317,
+          write_length: 61,
           write_count: 2,
           read_length: 1,
           read_count: 1,
-          runtime: 21505,
+          runtime: 11777,
         ),
       ),
     ],
     total_block_cost: ExecutionCost(
-      write_length: 317,
+      write_length: 61,
       write_count: 2,
       read_length: 1,
       read_count: 1,
-      runtime: 21505,
+      runtime: 11777,
     ),
   )),
 ]