Move unit test for monotonically increasing counter native function (#17885)

Author: vusirikala

aptos-move/framework/aptos-framework/doc/transaction_context.md

@@ -41,6 +41,7 @@
 -  [Function `inner_entry_function_payload`](#0x1_transaction_context_inner_entry_function_payload)
 -  [Function `monotonically_increasing_counter`](#0x1_transaction_context_monotonically_increasing_counter)
 -  [Function `monotonically_increasing_counter_internal`](#0x1_transaction_context_monotonically_increasing_counter_internal)
+-  [Function `monotonically_increasing_counter_internal_for_test_only`](#0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only)
 -  [Specification](#@Specification_1)
     -  [Function `get_txn_hash`](#@Specification_1_get_txn_hash)
     -  [Function `get_transaction_hash`](#@Specification_1_get_transaction_hash)
@@ -59,6 +60,7 @@
     -  [Function `entry_function_payload_internal`](#@Specification_1_entry_function_payload_internal)
     -  [Function `multisig_payload_internal`](#@Specification_1_multisig_payload_internal)
     -  [Function `monotonically_increasing_counter_internal`](#@Specification_1_monotonically_increasing_counter_internal)
+    -  [Function `monotonically_increasing_counter_internal_for_test_only`](#@Specification_1_monotonically_increasing_counter_internal_for_test_only)
 
 
 <pre><code><b>use</b> <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error">0x1::error</a>;
@@ -997,6 +999,7 @@ Returns a monotonically increasing counter value that combines timestamp, transa
 session counter, and local counter into a 128-bit value.
 Format: <code>&lt;reserved_byte (8 bits)&gt; || timestamp_us (64 bits) || transaction_index (32 bits) || session_counter (8 bits) || local_counter (16 bits)</code>
 The function aborts if the local counter overflows (after 65535 calls in a single session).
+When compiled for testing, this function bypasses feature checks and returns a simplified counter value.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter">monotonically_increasing_counter</a>(): u128
@@ -1009,10 +1012,12 @@ The function aborts if the local counter overflows (after 65535 calls in a singl
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter">monotonically_increasing_counter</a>(): u128 {
-    <b>assert</b>!(<a href="../../aptos-stdlib/../move-stdlib/doc/features.md#0x1_features_transaction_context_extension_enabled">features::transaction_context_extension_enabled</a>(), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_invalid_state">error::invalid_state</a>(<a href="transaction_context.md#0x1_transaction_context_ETRANSACTION_CONTEXT_EXTENSION_NOT_ENABLED">ETRANSACTION_CONTEXT_EXTENSION_NOT_ENABLED</a>));
-    <b>assert</b>!(<a href="../../aptos-stdlib/../move-stdlib/doc/features.md#0x1_features_is_monotonically_increasing_counter_enabled">features::is_monotonically_increasing_counter_enabled</a>(), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_invalid_state">error::invalid_state</a>(<a href="transaction_context.md#0x1_transaction_context_EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED">EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED</a>));
-    <b>let</b> timestamp_us = <a href="timestamp.md#0x1_timestamp_now_microseconds">timestamp::now_microseconds</a>();
-    <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal">monotonically_increasing_counter_internal</a>(timestamp_us)
+    <b>if</b> (__COMPILE_FOR_TESTING__) {
+        <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only">monotonically_increasing_counter_internal_for_test_only</a>()
+    } <b>else</b> {
+        <b>assert</b>!(<a href="../../aptos-stdlib/../move-stdlib/doc/features.md#0x1_features_is_monotonically_increasing_counter_enabled">features::is_monotonically_increasing_counter_enabled</a>(), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_invalid_state">error::invalid_state</a>(<a href="transaction_context.md#0x1_transaction_context_EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED">EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED</a>));
+        <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal">monotonically_increasing_counter_internal</a>(<a href="timestamp.md#0x1_timestamp_now_microseconds">timestamp::now_microseconds</a>())
+    }
 }
 </code></pre>
 
@@ -1040,6 +1045,31 @@ The function aborts if the local counter overflows (after 65535 calls in a singl
 
 
 
+</details>
+
+<a id="0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only"></a>
+
+## Function `monotonically_increasing_counter_internal_for_test_only`
+
+Test-only version of monotonically_increasing_counter that returns increasing values
+without requiring a user transaction context. This allows unit tests to verify
+the monotonically increasing behavior.
+
+
+<pre><code><b>fun</b> <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only">monotonically_increasing_counter_internal_for_test_only</a>(): u128
+</code></pre>
+
+
+
+<details>
+<summary>Implementation</summary>
+
+
+<pre><code><b>native</b> <b>fun</b> <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only">monotonically_increasing_counter_internal_for_test_only</a>(): u128;
+</code></pre>
+
+
+
 </details>
 
 <a id="@Specification_1"></a>
@@ -1376,6 +1406,22 @@ The function aborts if the local counter overflows (after 65535 calls in a singl
 
 
 
+<pre><code><b>pragma</b> opaque;
+</code></pre>
+
+
+
+<a id="@Specification_1_monotonically_increasing_counter_internal_for_test_only"></a>
+
+### Function `monotonically_increasing_counter_internal_for_test_only`
+
+
+<pre><code><b>fun</b> <a href="transaction_context.md#0x1_transaction_context_monotonically_increasing_counter_internal_for_test_only">monotonically_increasing_counter_internal_for_test_only</a>(): u128
+</code></pre>
+
+
+
+
 <pre><code><b>pragma</b> opaque;
 </code></pre>
 

aptos-move/framework/aptos-framework/sources/transaction_context.move

@@ -193,14 +193,22 @@ module aptos_framework::transaction_context {
     /// session counter, and local counter into a 128-bit value.
     /// Format: `<reserved_byte (8 bits)> || timestamp_us (64 bits) || transaction_index (32 bits) || session_counter (8 bits) || local_counter (16 bits)`
     /// The function aborts if the local counter overflows (after 65535 calls in a single session).
+    /// When compiled for testing, this function bypasses feature checks and returns a simplified counter value.
     public fun monotonically_increasing_counter(): u128 {
-        assert!(features::transaction_context_extension_enabled(), error::invalid_state(ETRANSACTION_CONTEXT_EXTENSION_NOT_ENABLED));
-        assert!(features::is_monotonically_increasing_counter_enabled(), error::invalid_state(EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED));
-        let timestamp_us = timestamp::now_microseconds();
-        monotonically_increasing_counter_internal(timestamp_us)
+        if (__COMPILE_FOR_TESTING__) {
+            monotonically_increasing_counter_internal_for_test_only()
+        } else {
+            assert!(features::is_monotonically_increasing_counter_enabled(), error::invalid_state(EMONOTONICALLY_INCREASING_COUNTER_NOT_ENABLED));
+            monotonically_increasing_counter_internal(timestamp::now_microseconds())
+        }
     }
     native fun monotonically_increasing_counter_internal(timestamp_us: u64): u128;
 
+    /// Test-only version of monotonically_increasing_counter that returns increasing values
+    /// without requiring a user transaction context. This allows unit tests to verify
+    /// the monotonically increasing behavior.
+    native fun monotonically_increasing_counter_internal_for_test_only(): u128;
+
     #[test_only]
     public fun new_entry_function_payload(
         account_address: address,
@@ -295,4 +303,15 @@ module aptos_framework::transaction_context {
         // expected to fail with the error code of `invalid_state(E_TRANSACTION_CONTEXT_NOT_AVAILABLE)`
         let _multisig = multisig_payload();
     }
+
+    #[test]
+    fun test_monotonically_increasing_counter() {
+        let counter1 = monotonically_increasing_counter();
+        let counter2 = monotonically_increasing_counter();
+        let counter3 = monotonically_increasing_counter();
+
+        // Verify that the increment is exactly 1 (since only local_counter changes in test mode)
+        assert!(counter2 == counter1 + 1, 2);
+        assert!(counter3 == counter2 + 1, 3);
+    }
 }

aptos-move/framework/aptos-framework/sources/transaction_context.spec.move

@@ -113,4 +113,9 @@ spec aptos_framework::transaction_context {
         //TODO: temporary mockup
         pragma opaque;
     }
+
+    spec monotonically_increasing_counter_internal_for_test_only(): u128 {
+        //TODO: temporary mockup
+        pragma opaque;
+    }
 }

aptos-move/framework/src/natives/transaction_context.rs

@@ -182,12 +182,46 @@ fn native_monotonically_increasing_counter_internal(
         monotonically_increasing_counter |= local_counter;
         Ok(smallvec![Value::u128(monotonically_increasing_counter)])
     } else {
+        // When transaction context is not available, return an error
         Err(SafeNativeError::Abort {
             abort_code: error::invalid_state(abort_codes::ETRANSACTION_CONTEXT_NOT_AVAILABLE),
         })
     }
 }
 
+/***************************************************************************************************
+ * native fun monotonically_increasing_counter_internal_for_test_only
+ *
+ *   gas cost: base_cost
+ *
+ *   This is a test-only version that returns increasing counter values without requiring
+ *   a user transaction context. Used when COMPILE_FOR_TESTING flag is enabled.
+ *
+ **************************************************************************************************/
+fn native_monotonically_increasing_counter_internal_for_test_only(
+    context: &mut SafeNativeContext,
+    _ty_args: Vec<Type>,
+    _args: VecDeque<Value>,
+) -> SafeNativeResult<SmallVec<[Value; 1]>> {
+    context.charge(TRANSACTION_CONTEXT_MONOTONICALLY_INCREASING_COUNTER_BASE)?;
+
+    let transaction_context = context
+        .extensions_mut()
+        .get_mut::<NativeTransactionContext>();
+    if transaction_context.local_counter == u16::MAX {
+        return Err(SafeNativeError::Abort {
+            abort_code: error::invalid_state(
+                abort_codes::EMONOTONICALLY_INCREASING_COUNTER_OVERFLOW,
+            ),
+        });
+    }
+    transaction_context.local_counter += 1;
+    let local_counter = transaction_context.local_counter as u128;
+
+    // For testing, return just the local counter value to verify monotonically increasing behavior
+    Ok(smallvec![Value::u128(local_counter)])
+}
+
 /***************************************************************************************************
  * native fun get_script_hash
  *
@@ -471,6 +505,10 @@ pub fn make_all(
             "monotonically_increasing_counter_internal",
             native_monotonically_increasing_counter_internal,
         ),
+        (
+            "monotonically_increasing_counter_internal_for_test_only",
+            native_monotonically_increasing_counter_internal_for_test_only,
+        ),
         ("get_txn_hash", native_get_txn_hash),
         ("sender_internal", native_sender_internal),
         (

aptos-move/framework/tests/move_unit_test.rs

@@ -39,6 +39,7 @@ fn run_tests_for_pkg(path_to_pkg: impl Into<String>, use_latest_language: bool)
         full_model_generation: true, // Run extended checks also on test code
         ..Default::default()
     };
+
     if use_latest_language {
         let latest_build_options = BuildOptions::default().set_latest_language();
         build_config.compiler_config.bytecode_version = latest_build_options.bytecode_version;