Merge pull request #7195 from brice-stacks/feat/pox-wf-locking

pox-locking

Author: brice-stacks

changelog.d/pox-locking-v5.added

@@ -0,0 +1 @@
+Add support to the pox-locking library for PoX-5.

clarity/src/vm/database/clarity_db.rs

@@ -201,6 +201,7 @@ pub trait BurnStateDB {
     fn get_v3_unlock_height(&self) -> u32;
     fn get_pox_3_activation_height(&self) -> u32;
     fn get_pox_4_activation_height(&self) -> u32;
+    fn get_pox_5_activation_height(&self) -> u32;
 
     /// Returns the *burnchain block height* for the `sortition_id` is associated with.
     fn get_burn_block_height(&self, sortition_id: &SortitionId) -> Option<u32>;
@@ -419,6 +420,10 @@ impl BurnStateDB for NullBurnStateDB {
         u32::MAX
     }
 
+    fn get_pox_5_activation_height(&self) -> u32 {
+        u32::MAX
+    }
+
     fn get_pox_prepare_length(&self) -> u32 {
         panic!("NullBurnStateDB should not return PoX info");
     }
@@ -1068,6 +1073,16 @@ impl ClarityDatabase<'_> {
         }
     }
 
+    /// Return the height for PoX v4 -> v5 auto unlocks
+    ///   from the burn state db
+    pub fn get_v4_unlock_height(&mut self) -> Result<u32, VmExecutionError> {
+        if self.get_clarity_epoch_version()? >= StacksEpochId::Epoch40 {
+            Ok(self.burn_state_db.get_pox_5_activation_height())
+        } else {
+            Ok(u32::MAX)
+        }
+    }
+
     /// Return the block height for a given tenure height
     ///   if the block information is queryable for the tenure height.
     /// The block information for a given tenure height is queryable iff:
@@ -2346,13 +2361,15 @@ impl<'a> ClarityDatabase<'a> {
                 cur_burn_height,
                 self.get_v1_unlock_height(),
                 self.get_v2_unlock_height()?,
-                self.get_v3_unlock_height()?
+                self.get_v3_unlock_height()?,
+                self.get_v4_unlock_height()?,
             )?,
             stx_balance.has_unlockable_tokens_at_burn_block(
                 cur_burn_height,
                 self.get_v1_unlock_height(),
                 self.get_v2_unlock_height()?,
-                self.get_v3_unlock_height()?
+                self.get_v3_unlock_height()?,
+                self.get_v4_unlock_height()?,
             )
         );
 
@@ -2380,13 +2397,15 @@ impl<'a> ClarityDatabase<'a> {
                 cur_burn_height,
                 self.get_v1_unlock_height(),
                 self.get_v2_unlock_height()?,
-                self.get_v3_unlock_height()?
+                self.get_v3_unlock_height()?,
+                self.get_v4_unlock_height()?,
             )?,
             stx_balance.has_unlockable_tokens_at_burn_block(
                 cur_burn_height,
                 self.get_v1_unlock_height(),
                 self.get_v2_unlock_height()?,
-                self.get_v3_unlock_height()?
+                self.get_v3_unlock_height()?,
+                self.get_v4_unlock_height()?,
             )
         );