[AN-Issue-1346] Introduced means to custimize automation transaction …

…handling

- Added separate flow for automation transaction handling. It differes
from user transaction flow only by custom validation step of
inner-payload of automation transaction

- Added validation logic for the automation transaction inner-payload

- Introuced specific StatusCode for failures during automation
transaction inner-payload validation. They are qualified as verification
status type and will lead to have transaction kept and the account will
be charged.

api/src/transactions.rs

@@ -29,6 +29,7 @@ use aptos_api_types::{
     MAX_RECURSIVE_TYPES_ALLOWED, U64,
 };
 use aptos_crypto::{hash::CryptoHash, signing_message};
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     account_address::AccountAddress,
     mempool_status::MempoolStatusCode,
@@ -1031,7 +1032,10 @@ impl TransactionsApi {
                         })?;
                 // Verify the signed transaction
                 match signed_transaction.payload() {
-                    TransactionPayload::EntryFunction(entry_function) => {
+                    TransactionPayload::Automation(
+                        AutomationTransactionPayload::EntryFunction(entry_function),
+                    )
+                    | TransactionPayload::EntryFunction(entry_function) => {
                         TransactionsApi::validate_entry_function_payload_format(
                             ledger_info,
                             entry_function,
@@ -1380,7 +1384,10 @@ impl TransactionsApi {
                 format!("Script::{}", txn.committed_hash()).to_string()
             },
             TransactionPayload::ModuleBundle(_) => "ModuleBundle::unknown".to_string(),
-            TransactionPayload::EntryFunction(entry_function) => FunctionStats::function_to_key(
+            TransactionPayload::Automation(AutomationTransactionPayload::EntryFunction(
+                entry_function,
+            ))
+            | TransactionPayload::EntryFunction(entry_function) => FunctionStats::function_to_key(
                 entry_function.module(),
                 &entry_function.function().into(),
             ),

api/types/src/convert.rs

@@ -21,6 +21,7 @@ use aptos_crypto::{hash::CryptoHash, HashValue};
 use aptos_logger::{sample, sample::SampleRate};
 use aptos_resource_viewer::AptosValueAnnotator;
 use aptos_storage_interface::DbReader;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     access_path::{AccessPath, Path},
     chain_id::ChainId,
@@ -177,8 +178,8 @@ impl<'a, S: StateView> MoveConverter<'a, S> {
         data: TransactionOnChainData,
     ) -> Result<Transaction> {
         use aptos_types::transaction::Transaction::{
-            BlockEpilogue, BlockMetadata, BlockMetadataExt, GenesisTransaction, StateCheckpoint,
-            UserTransaction, AutomatedTransaction
+            AutomatedTransaction, BlockEpilogue, BlockMetadata, BlockMetadataExt,
+            GenesisTransaction, StateCheckpoint, UserTransaction,
         };
         let aux_data = self
             .db
@@ -277,7 +278,7 @@ impl<'a, S: StateView> MoveConverter<'a, S> {
         use aptos_types::transaction::TransactionPayload::*;
         let ret = match payload {
             Script(s) => TransactionPayload::ScriptPayload(s.try_into()?),
-            EntryFunction(fun) => {
+            Automation(AutomationTransactionPayload::EntryFunction(fun)) | EntryFunction(fun) => {
                 let (module, function, ty_args, args) = fun.into_inner();
                 let func_args = self
                     .inner

aptos-move/aptos-debugger/src/aptos_debugger.rs

@@ -4,6 +4,7 @@
 use anyhow::{bail, format_err, Result};
 use aptos_gas_profiling::{GasProfiler, TransactionGasLog};
 use aptos_rest_client::Client;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     account_address::AccountAddress,
     state_store::TStateView,
@@ -99,6 +100,7 @@ impl AptosDebugger {
             |gas_meter| {
                 let gas_profiler = match txn.payload() {
                     TransactionPayload::Script(_) => GasProfiler::new_script(gas_meter),
+                    TransactionPayload::Automation(AutomationTransactionPayload::EntryFunction(entry_func)) |
                     TransactionPayload::EntryFunction(entry_func) => GasProfiler::new_function(
                         gas_meter,
                         entry_func.module().clone(),

aptos-move/aptos-vm/src/aptos_vm.rs

@@ -39,6 +39,7 @@ use aptos_logger::{enabled, prelude::*, Level};
 use aptos_metrics_core::TimerHelper;
 #[cfg(any(test, feature = "testing"))]
 use aptos_types::state_store::StateViewId;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     account_config::{self, new_block_event_key, AccountResource},
     block_executor::{
@@ -835,6 +836,7 @@ impl AptosVM {
             },
             TransactionPayload::EntryFunction(entry_fn) => {
                 session.execute(|session| {
+                    // TODO To enclosed payload validation as well before actually executing the entry function
                     self.validate_and_execute_entry_function(
                         resolver,
                         session,
@@ -878,6 +880,74 @@ impl AptosVM {
             traversal_context,
         )
     }
+    fn execute_automation_transaction<'a, 'r, 'l>(
+        &'l self,
+        resolver: &'r impl AptosMoveResolver,
+        mut session: UserSession<'r, 'l>,
+        gas_meter: &mut impl AptosGasMeter,
+        traversal_context: &mut TraversalContext<'a>,
+        txn_data: &TransactionMetadata,
+        payload: &'a AutomationTransactionPayload,
+        log_context: &AdapterLogSchema,
+        new_published_modules_loaded: &mut bool,
+        change_set_configs: &ChangeSetConfigs,
+    ) -> Result<(VMStatus, VMOutput), VMStatus> {
+        fail_point!("aptos_vm::execute_script_or_entry_function", |_| {
+            Err(VMStatus::Error {
+                status_code: StatusCode::UNKNOWN_INVARIANT_VIOLATION_ERROR,
+                sub_status: Some(move_core_types::vm_status::sub_status::unknown_invariant_violation::EPARANOID_FAILURE),
+                message: None,
+            })
+        });
+
+        gas_meter.charge_intrinsic_gas_for_transaction(txn_data.transaction_size())?;
+        if txn_data.is_keyless() {
+            gas_meter.charge_keyless()?;
+        }
+
+        match payload {
+            AutomationTransactionPayload::EntryFunction(entry_fn) => {
+                // TODO: check entry function argument representing payload to be valid entry-function as well.
+                session.execute(|session| {
+                    self.validate_and_execute_entry_function(
+                        resolver,
+                        session,
+                        gas_meter,
+                        traversal_context,
+                        txn_data.senders(),
+                        entry_fn,
+                        txn_data,
+                    )
+                })?;
+            },
+        };
+
+        session.execute(|session| {
+            self.resolve_pending_code_publish(
+                session,
+                gas_meter,
+                traversal_context,
+                new_published_modules_loaded,
+            )
+        })?;
+
+        let epilogue_session = self.charge_change_set_and_respawn_session(
+            session,
+            resolver,
+            gas_meter,
+            change_set_configs,
+            txn_data,
+        )?;
+
+        self.success_transaction_cleanup(
+            epilogue_session,
+            gas_meter,
+            txn_data,
+            log_context,
+            change_set_configs,
+            traversal_context,
+        )
+    }
 
     fn charge_change_set(
         &self,
@@ -1742,6 +1812,18 @@ impl AptosVM {
             TransactionPayload::ModuleBundle(_) => {
                 unwrap_or_discard!(Err(deprecated_module_bundle!()))
             },
+            TransactionPayload::Automation(automation_payload) => self
+                .execute_automation_transaction(
+                    resolver,
+                    user_session,
+                    gas_meter,
+                    &mut traversal_context,
+                    &txn_data,
+                    automation_payload,
+                    log_context,
+                    &mut new_published_modules_loaded,
+                    change_set_configs,
+                ),
         };
 
         let gas_usage = txn_data
@@ -2258,14 +2340,14 @@ impl AptosVM {
         )?;
 
         match payload {
-            TransactionPayload::Script(_) | TransactionPayload::EntryFunction(_) => {
-                transaction_validation::run_script_prologue(
-                    session,
-                    txn_data,
-                    log_context,
-                    traversal_context,
-                )
-            },
+            TransactionPayload::Script(_)
+            | TransactionPayload::EntryFunction(_)
+            | TransactionPayload::Automation(_) => transaction_validation::run_script_prologue(
+                session,
+                txn_data,
+                log_context,
+                traversal_context,
+            ),
             TransactionPayload::Multisig(multisig_payload) => {
                 // Still run script prologue for multisig transaction to ensure the same tx
                 // validations are still run for this multisig execution tx, which is submitted by

aptos-move/aptos-vm/src/transaction_metadata.rs

@@ -7,6 +7,7 @@
 use aptos_crypto::HashValue;
 use aptos_gas_algebra::{FeePerGasUnit, Gas, NumBytes};
 use aptos_types::transaction::automated_transaction::AutomatedTransaction;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     account_address::AccountAddress,
     chain_id::ChainId,
@@ -34,6 +35,7 @@ pub struct TransactionMetadata {
     pub is_keyless: bool,
     pub entry_function_payload: Option<EntryFunction>,
     pub multisig_payload: Option<Multisig>,
+    pub automation_payload: Option<AutomationTransactionPayload>,
     pub txn_app_hash: Vec<u8>,
 }
 
@@ -68,6 +70,7 @@ impl TransactionMetadata {
                 // Deprecated. Return an empty vec because we cannot do anything
                 // else here, only `unreachable!` otherwise.
                 TransactionPayload::ModuleBundle(_) => vec![],
+                TransactionPayload::Automation(_) => vec![],
             },
             script_size: match txn.payload() {
                 TransactionPayload::Script(s) => (s.code().len() as u64).into(),
@@ -84,6 +87,10 @@ impl TransactionMetadata {
                 TransactionPayload::Multisig(m) => Some(m.clone()),
                 _ => None,
             },
+            automation_payload: match txn.payload() {
+                TransactionPayload::Automation(a) => Some(a.clone()),
+                _ => None,
+            },
             txn_app_hash: HashValue::sha3_256_of(
                 &bcs::to_bytes(&txn).expect("Unable to serialize SignedTransaction"),
             )
@@ -169,6 +176,9 @@ impl TransactionMetadata {
                 .map(|entry_func| entry_func.as_entry_function_payload()),
             self.multisig_payload()
                 .map(|multisig| multisig.as_multisig_payload()),
+            self.automation_payload
+                .as_ref()
+                .and_then(|e| e.as_entry_function_payload()),
             self.txn_app_hash.clone(),
         )
     }
@@ -197,6 +207,7 @@ impl From<&AutomatedTransaction> for TransactionMetadata {
                 _ => None,
             },
             multisig_payload: None,
+            automation_payload: None,
             txn_app_hash: txn.hash().to_vec(),
         }
     }

aptos-move/e2e-tests/src/executor.rs

@@ -22,6 +22,7 @@ use aptos_gas_meter::{StandardGasAlgebra, StandardGasMeter};
 use aptos_gas_profiling::{GasProfiler, TransactionGasLog};
 use aptos_gas_schedule::{AptosGasParameters, InitialGasSchedule, LATEST_GAS_FEATURE_VERSION};
 use aptos_keygen::KeyGen;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::{
     account_config::{
         new_block_event_key, AccountResource, CoinInfoResource, CoinStoreResource, NewBlockEvent,
@@ -684,7 +685,10 @@ impl FakeExecutor {
             |gas_meter| {
                 let gas_profiler = match txn.payload() {
                     TransactionPayload::Script(_) => GasProfiler::new_script(gas_meter),
-                    TransactionPayload::EntryFunction(entry_func) => GasProfiler::new_function(
+                    TransactionPayload::Automation(
+                        AutomationTransactionPayload::EntryFunction(entry_func),
+                    )
+                    | TransactionPayload::EntryFunction(entry_func) => GasProfiler::new_function(
                         gas_meter,
                         entry_func.module().clone(),
                         entry_func.function().to_owned(),

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

@@ -395,6 +395,34 @@ fn native_multisig_payload_internal(
     }
 }
 
+fn native_automation_payload_internal(
+    context: &mut SafeNativeContext,
+    mut _ty_args: Vec<Type>,
+    _args: VecDeque<Value>,
+) -> SafeNativeResult<SmallVec<[Value; 1]>> {
+    context.charge(TRANSACTION_CONTEXT_ENTRY_FUNCTION_PAYLOAD_BASE)?;
+
+    let user_transaction_context_opt = get_user_transaction_context_opt_from_context(context);
+
+    if let Some(transaction_context) = user_transaction_context_opt {
+        if let Some(entry_function_payload) = transaction_context.automation_payload() {
+            let num_bytes = num_bytes_from_entry_function_payload(&entry_function_payload);
+            context.charge(
+                TRANSACTION_CONTEXT_ENTRY_FUNCTION_PAYLOAD_PER_BYTE_IN_STR
+                    * NumBytes::new(num_bytes as u64),
+            )?;
+            let payload = create_entry_function_payload(entry_function_payload);
+            Ok(smallvec![create_option_some_value(payload)])
+        } else {
+            Ok(smallvec![create_option_none()])
+        }
+    } else {
+        Err(SafeNativeError::Abort {
+            abort_code: error::invalid_state(abort_codes::ETRANSACTION_CONTEXT_NOT_AVAILABLE),
+        })
+    }
+}
+
 fn get_user_transaction_context_opt_from_context<'a>(
     context: &'a SafeNativeContext,
 ) -> &'a Option<UserTransactionContext> {
@@ -432,6 +460,10 @@ pub fn make_all(
             "multisig_payload_internal",
             native_multisig_payload_internal,
         ),
+        (
+            "automation_payload_internal",
+            native_automation_payload_internal,
+        ),
         ("txn_app_hash_internal", native_txn_app_hash_internal),
     ];
 

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

@@ -132,6 +132,14 @@ module supra_framework::transaction_context {
     }
     native fun entry_function_payload_internal(): Option<EntryFunctionPayload>;
 
+    /// Returns the automation transaction entry function payload if the current transaction has such a payload. Otherwise, return `None`.
+    /// This function aborts if called outside of the transaction prologue, execution, or epilogue phases.
+    public fun automation_payload(): Option<EntryFunctionPayload> {
+        assert!(features::transaction_context_extension_enabled(), error::invalid_state(ETRANSACTION_CONTEXT_EXTENSION_NOT_ENABLED));
+        automation_payload_internal()
+    }
+    native fun automation_payload_internal(): Option<EntryFunctionPayload>;
+
     /// Returns the original transaction hash calculated on the raw-bytes.
     /// This function aborts if called outside of the transaction prologue, execution, or epilogue phases.
     public fun txn_app_hash(): vector<u8> {
@@ -268,6 +276,13 @@ module supra_framework::transaction_context {
         let _multisig = multisig_payload();
     }
 
+    #[test]
+    #[expected_failure(abort_code=196609, location = Self)]
+    fun test_call_automation_payload() {
+        // expected to fail with the error code of `invalid_state(E_TRANSACTION_CONTEXT_NOT_AVAILABLE)`
+        let _automation = automation_payload();
+    }
+
     #[test]
     #[expected_failure(abort_code=196609, location = Self)]
     fun test_call_txn_app_hash() {

consensus/src/transaction_shuffler/fairness/conflict_key/entry_fun.rs

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::transaction_shuffler::fairness::conflict_key::ConflictKey;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::transaction::{SignedTransaction, TransactionPayload};
 use move_core_types::{identifier::Identifier, language_storage::ModuleId};
 
@@ -17,7 +18,10 @@ pub enum EntryFunKey {
 impl ConflictKey<SignedTransaction> for EntryFunKey {
     fn extract_from(txn: &SignedTransaction) -> Self {
         match txn.payload() {
-            TransactionPayload::EntryFunction(entry_fun) => {
+            TransactionPayload::Automation(AutomationTransactionPayload::EntryFunction(
+                entry_fun,
+            ))
+            | TransactionPayload::EntryFunction(entry_fun) => {
                 let module_id = entry_fun.module();
                 if module_id.address().is_special() {
                     // Exempt framework modules

consensus/src/transaction_shuffler/fairness/conflict_key/entry_fun_module.rs

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::transaction_shuffler::fairness::conflict_key::ConflictKey;
+use aptos_types::transaction::automation::AutomationTransactionPayload;
 use aptos_types::transaction::{SignedTransaction, TransactionPayload};
 use move_core_types::language_storage::ModuleId;
 
@@ -15,7 +16,10 @@ pub enum EntryFunModuleKey {
 impl ConflictKey<SignedTransaction> for EntryFunModuleKey {
     fn extract_from(txn: &SignedTransaction) -> Self {
         match txn.payload() {
-            TransactionPayload::EntryFunction(entry_fun) => {
+            TransactionPayload::Automation(AutomationTransactionPayload::EntryFunction(
+                entry_fun,
+            ))
+            | TransactionPayload::EntryFunction(entry_fun) => {
                 let module_id = entry_fun.module();
 
                 if module_id.address().is_special() {