Merge branch 'feat/clarity-5' into fix/from-consensus-buff

Author: brice-stacks

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
     }
 

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, _, _| {