Added properties to automation-registry internal structs to facilitate v1.1 development (#220)

- See ticket Entropy-Foundation/smr-moonshot#1424
- See ticket Entropy-Foundation/smr-moonshot#1823 (comment)
- Made creation of the native version of `AutomationTaskMetaData` backward compatible to avoid any updates on smr-side

Co-authored-by: Aregnaz Harutyunyan <>

Author: aregng

aptos-move/framework/supra-framework/doc/automation_registry.md

@@ -120,6 +120,13 @@ This contract is part of the Supra Framework and is designed to manage automated
 <dd>
  Will be the same as main_config.registry_max_gas_cap, unless updated during the epoch.
 </dd>
+<dt>
+<code>registration_enabled: bool</code>
+</dt>
+<dd>
+ Flag indicating whether the task registration is enabled or paused.
+ If paused a new task registration will fail.
+</dd>
 </dl>
 
 
@@ -403,6 +410,12 @@ Epoch state
 <dd>
  Flag indicating whether the task is active, cancelled or pending.
 </dd>
+<dt>
+<code>locked_fee_for_next_epoch: u64</code>
+</dt>
+<dd>
+ Fee locked for the task estimated for the next epoch at the start of the current epoch.
+</dd>
 </dl>
 
 
@@ -1821,9 +1834,10 @@ Initialization of Automation Registry with configuration parameters is expected
             congestion_threshold_percentage,
             congestion_base_fee_in_quants_per_sec,
             congestion_exponent,
-            task_capacity
+            task_capacity,
         },
-        next_epoch_registry_max_gas_cap: registry_max_gas_cap
+        next_epoch_registry_max_gas_cap: registry_max_gas_cap,
+        registration_enabled: <b>true</b>,
     });
 
     <b>move_to</b>(supra_framework, <a href="automation_registry.md#0x1_automation_registry_AutomationEpochInfo">AutomationEpochInfo</a> {
@@ -2685,6 +2699,7 @@ Registers a new automation task entry.
         state: <a href="automation_registry.md#0x1_automation_registry_PENDING">PENDING</a>,
         registration_time,
         tx_hash,
+        locked_fee_for_next_epoch: 0
     };
 
     <a href="../../supra-stdlib/doc/enumerable_map.md#0x1_enumerable_map_add_value">enumerable_map::add_value</a>(&<b>mut</b> <a href="automation_registry.md#0x1_automation_registry">automation_registry</a>.tasks, task_index, automation_task_metadata);

aptos-move/framework/supra-framework/sources/automation_registry.move

@@ -96,6 +96,9 @@ module supra_framework::automation_registry {
         main_config: AutomationRegistryConfig,
         /// Will be the same as main_config.registry_max_gas_cap, unless updated during the epoch.
         next_epoch_registry_max_gas_cap: u64,
+        /// Flag indicating whether the task registration is enabled or paused.
+        /// If paused a new task registration will fail.
+        registration_enabled: bool,
     }
 
     #[resource_group_member(group = supra_framework::object::ObjectGroup)]
@@ -186,7 +189,9 @@ module supra_framework::automation_registry {
         /// Registration timestamp in seconds
         registration_time: u64,
         /// Flag indicating whether the task is active, cancelled or pending.
-        state: u8
+        state: u8,
+        /// Fee locked for the task estimated for the next epoch at the start of the current epoch.
+        locked_fee_for_next_epoch: u64,
     }
 
     #[event]
@@ -506,9 +511,10 @@ module supra_framework::automation_registry {
                 congestion_threshold_percentage,
                 congestion_base_fee_in_quants_per_sec,
                 congestion_exponent,
-                task_capacity
+                task_capacity,
             },
-            next_epoch_registry_max_gas_cap: registry_max_gas_cap
+            next_epoch_registry_max_gas_cap: registry_max_gas_cap,
+            registration_enabled: true,
         });
 
         move_to(supra_framework, AutomationEpochInfo {
@@ -1051,6 +1057,7 @@ module supra_framework::automation_registry {
             state: PENDING,
             registration_time,
             tx_hash,
+            locked_fee_for_next_epoch: 0
         };
 
         enumerable_map::add_value(&mut automation_registry.tasks, task_index, automation_task_metadata);

types/src/transaction/automation.rs

@@ -202,6 +202,8 @@ pub struct AutomationTaskMetaData {
     pub(crate) registration_time: u64,
     /// Flag indicating whether the task is active.
     pub(crate) is_active: bool,
+    /// Fee locked for the task estimated for the next epoch at the start of the current epoch.
+    pub(crate) locked_fee_for_next_epoch: u64,
 }
 
 impl AutomationTaskMetaData {
@@ -218,6 +220,37 @@ impl AutomationTaskMetaData {
         aux_data: Vec<Vec<u8>>,
         registration_time: u64,
         is_active: bool,
+    ) -> Self {
+        Self::new_with_locked_fee(
+            id,
+            owner,
+            payload_tx,
+            expiry_time,
+            tx_hash,
+            max_gas_amount,
+            gas_price_cap,
+            automation_fee_cap_for_epoch,
+            aux_data,
+            registration_time,
+            is_active,
+            0,
+        )
+    }
+
+    #[allow(clippy::too_many_arguments)]
+    pub fn new_with_locked_fee(
+        id: u64,
+        owner: AccountAddress,
+        payload_tx: Vec<u8>,
+        expiry_time: u64,
+        tx_hash: Vec<u8>,
+        max_gas_amount: u64,
+        gas_price_cap: u64,
+        automation_fee_cap_for_epoch: u64,
+        aux_data: Vec<Vec<u8>>,
+        registration_time: u64,
+        is_active: bool,
+        locked_fee_for_next_epoch: u64,
     ) -> Self {
         Self {
             id,
@@ -231,6 +264,7 @@ impl AutomationTaskMetaData {
             aux_data,
             registration_time,
             is_active,
+            locked_fee_for_next_epoch,
         }
     }
 
@@ -269,4 +303,8 @@ impl AutomationTaskMetaData {
     pub fn id(&self) -> u64 {
         self.id
     }
+
+    pub fn locked_fee_for_next_epoch(&self) -> u64 {
+        self.locked_fee_for_next_epoch
+    }
 }

types/src/unit_tests/automation.rs

@@ -79,6 +79,7 @@ fn automated_txn_builder_from_task_meta() {
         aux_data: vec![],
         registration_time: 1,
         is_active: false,
+        locked_fee_for_next_epoch: 0,
     };
     assert!(AutomatedTransactionBuilder::try_from(task_meta_invalid_payload.clone()).is_err());
 
@@ -149,6 +150,7 @@ fn automated_txn_build() {
         aux_data: vec![],
         registration_time: 1,
         is_active: false,
+        locked_fee_for_next_epoch: 0,
     };
 
     let builder = AutomatedTransactionBuilder::try_from(task_meta.clone()).unwrap();