Merge pull request #6802 from brice-stacks/feat/clarity-5

feat: add epoch 3.4 and Clarity5

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.

clarity-types/src/types/signatures.rs

@@ -455,7 +455,8 @@ impl TypeSignature {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => self.admits_type_v2_1(other),
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => self.admits_type_v2_1(other),
             StacksEpochId::Epoch10 => Err(ClarityTypeError::UnsupportedEpoch(*epoch)),
         }
     }
@@ -663,7 +664,8 @@ impl TypeSignature {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => self.canonicalize_v2_1(),
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => self.canonicalize_v2_1(),
         }
     }
 
@@ -1002,7 +1004,8 @@ impl TypeSignature {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => Self::least_supertype_v2_1(a, b),
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => Self::least_supertype_v2_1(a, b),
             StacksEpochId::Epoch10 => Err(ClarityTypeError::UnsupportedEpoch(*epoch)),
         }
     }

clarity/src/vm/analysis/mod.rs

@@ -150,7 +150,8 @@ pub fn run_analysis(
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => {
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => {
                 TypeChecker2_1::run_pass(&epoch, &mut contract_analysis, db, build_type_map)
             }
             StacksEpochId::Epoch10 => {

clarity/src/vm/analysis/type_checker/mod.rs

@@ -47,7 +47,8 @@ impl FunctionType {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => self.check_args_2_1(accounting, args, clarity_version),
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => self.check_args_2_1(accounting, args, clarity_version),
             StacksEpochId::Epoch10 => Err(StaticCheckErrorKind::ExpectsRejectable(
                 "Epoch10 is not supported".into(),
             )
@@ -74,7 +75,8 @@ impl FunctionType {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32
-            | StacksEpochId::Epoch33 => {
+            | StacksEpochId::Epoch33
+            | StacksEpochId::Epoch34 => {
                 self.check_args_by_allowing_trait_cast_2_1(db, clarity_version, func_args)
             }
             StacksEpochId::Epoch10 => Err(StaticCheckErrorKind::ExpectsRejectable(
@@ -96,6 +98,8 @@ fn is_reserved_word_v3(word: &str) -> bool {
 pub fn is_reserved_word(word: &str, version: ClarityVersion) -> bool {
     match version {
         ClarityVersion::Clarity1 | ClarityVersion::Clarity2 => false,
-        ClarityVersion::Clarity3 | ClarityVersion::Clarity4 => is_reserved_word_v3(word),
+        ClarityVersion::Clarity3 | ClarityVersion::Clarity4 | ClarityVersion::Clarity5 => {
+            is_reserved_word_v3(word)
+        }
     }
 }

clarity/src/vm/analysis/type_checker/v2_1/contexts.rs

@@ -40,12 +40,13 @@ impl TraitContext {
     pub fn new(clarity_version: ClarityVersion) -> TraitContext {
         match clarity_version {
             ClarityVersion::Clarity1 => Self::Clarity1(HashMap::new()),
-            ClarityVersion::Clarity2 | ClarityVersion::Clarity3 | ClarityVersion::Clarity4 => {
-                Self::Clarity2 {
-                    defined: HashSet::new(),
-                    all: HashMap::new(),
-                }
-            }
+            ClarityVersion::Clarity2
+            | ClarityVersion::Clarity3
+            | ClarityVersion::Clarity4
+            | ClarityVersion::Clarity5 => Self::Clarity2 {
+                defined: HashSet::new(),
+                all: HashMap::new(),
+            },
         }
     }
 

clarity/src/vm/analysis/type_checker/v2_1/tests/contracts.rs

@@ -2545,7 +2545,10 @@ fn clarity_trait_experiments_downcast_literal_2(
         })
         .unwrap_err();
     match version {
-        ClarityVersion::Clarity2 | ClarityVersion::Clarity3 | ClarityVersion::Clarity4 => {
+        ClarityVersion::Clarity2
+        | ClarityVersion::Clarity3
+        | ClarityVersion::Clarity4
+        | ClarityVersion::Clarity5 => {
             assert!(err.starts_with("ExpectedCallableType(PrincipalType)"))
         }
         ClarityVersion::Clarity1 => {
@@ -2747,7 +2750,10 @@ fn clarity_trait_experiments_trait_cast_incompatible(
                 assert!(err.starts_with("TypeError(CallableType(Trait(TraitIdentifier"))
             }
         }
-        ClarityVersion::Clarity2 | ClarityVersion::Clarity3 | ClarityVersion::Clarity4 => {
+        ClarityVersion::Clarity2
+        | ClarityVersion::Clarity3
+        | ClarityVersion::Clarity4
+        | ClarityVersion::Clarity5 => {
             assert!(err.starts_with("IncompatibleTrait"))
         }
     }

clarity/src/vm/ast/mod.rs

@@ -478,14 +478,14 @@ mod test {
             write_length: u64::MAX,
             runtime: 1,
         };
-        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::Epoch33, limit);
+        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::latest(), limit);
 
         let err = build_ast(
             &QualifiedContractIdentifier::transient(),
             "(define-constant my-const u1)",
             &mut tracker,
-            ClarityVersion::Clarity4,
-            StacksEpochId::Epoch33,
+            ClarityVersion::latest(),
+            StacksEpochId::latest(),
         )
         .unwrap_err();
 
@@ -508,14 +508,14 @@ mod test {
             write_length: u64::MAX,
             runtime: expected_ast_parse_cost,
         };
-        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::Epoch33, limit);
+        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::latest(), limit);
 
         let err = build_ast(
             &QualifiedContractIdentifier::transient(),
             "(define-constant a 0)(define-constant b 1)", // no dependency = 0 graph edge
             &mut tracker,
-            ClarityVersion::Clarity4,
-            StacksEpochId::Epoch33,
+            ClarityVersion::latest(),
+            StacksEpochId::latest(),
         )
         .expect_err("Expected parse error, but found success!");
 
@@ -540,14 +540,14 @@ mod test {
             write_length: u64::MAX,
             runtime: expected_ast_parse_cost,
         };
-        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::Epoch33, limit);
+        let mut tracker = LimitedCostTracker::new_with_limit(StacksEpochId::latest(), limit);
 
         let err = build_ast(
             &QualifiedContractIdentifier::transient(),
             "(define-constant a 0)(define-constant b a)", // 1 dependency = 1 graph edge
             &mut tracker,
-            ClarityVersion::Clarity4,
-            StacksEpochId::Epoch33,
+            ClarityVersion::latest(),
+            StacksEpochId::latest(),
         )
         .expect_err("Expected parse error, but found success!");
 
@@ -573,8 +573,8 @@ mod test {
             &QualifiedContractIdentifier::transient(),
             &contract,
             &mut (),
-            ClarityVersion::Clarity4,
-            StacksEpochId::Epoch33,
+            ClarityVersion::latest(),
+            StacksEpochId::latest(),
         )
         .expect_err("Expected parse error, but found success!");
 
@@ -595,8 +595,8 @@ mod test {
             &QualifiedContractIdentifier::transient(),
             &contract,
             &mut (),
-            ClarityVersion::Clarity4,
-            StacksEpochId::Epoch33,
+            ClarityVersion::latest(),
+            StacksEpochId::latest(),
         )
         .expect_err("Expected parse error, but found success!");
 

clarity/src/vm/costs/mod.rs

@@ -851,7 +851,7 @@ impl LimitedCostTracker {
             | StacksEpochId::Epoch30
             | StacksEpochId::Epoch31
             | StacksEpochId::Epoch32 => COSTS_3_NAME.to_string(),
-            StacksEpochId::Epoch33 => COSTS_4_NAME.to_string(),
+            StacksEpochId::Epoch33 | StacksEpochId::Epoch34 => COSTS_4_NAME.to_string(),
         };
         Ok(result)
     }

clarity/src/vm/functions/mod.rs

@@ -61,6 +61,8 @@ macro_rules! switch_on_global_epoch {
                 StacksEpochId::Epoch32 => $Epoch205Version(args, env, context),
                 // Note: We reuse 2.05 for 3.3.
                 StacksEpochId::Epoch33 => $Epoch205Version(args, env, context),
+                // Note: We reuse 2.05 for 3.4.
+                StacksEpochId::Epoch34 => $Epoch205Version(args, env, context),
             }
         }
     };