refactor: gateway compiler handle declare tx

starkware-libs · Jul 14, 2024 · b5f3c66 · b5f3c66
1 parent 33dbd4d
commit b5f3c66
Show file tree

Hide file tree

Showing 11 changed files with 8,107 additions and 64 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/gateway/src/compilation.rs b/crates/gateway/src/compilation.rs
@@ -5,6 +5,7 @@ use blockifier::execution::contract_class::{ClassInfo, ContractClass, ContractCl
 use cairo_lang_starknet_classes::casm_contract_class::{
     CasmContractClass, CasmContractEntryPoints,
 };
+use cairo_lang_starknet_classes::contract_class::ContractClass as CairoLangContractClass;
 use starknet_api::core::CompiledClassHash;
 use starknet_api::rpc_transaction::RPCDeclareTransaction;
 use starknet_sierra_compile::compile::compile_sierra_to_casm;
@@ -29,44 +30,40 @@ impl GatewayCompiler {
     /// Formats the contract class for compilation, compiles it, and returns the compiled contract
     /// class wrapped in a [`ClassInfo`].
     /// Assumes the contract class is of a Sierra program which is compiled to Casm.
-    pub fn compile_contract_class(
+    pub fn process_declare_tx(
         &self,
         declare_tx: &RPCDeclareTransaction,
     ) -> GatewayResult<ClassInfo> {
         let RPCDeclareTransaction::V3(tx) = declare_tx;
-        let starknet_api_contract_class = &tx.contract_class;
-        let cairo_lang_contract_class =
-            into_contract_class_for_compilation(starknet_api_contract_class);
+        let rpc_contract_class = &tx.contract_class;
+        let cairo_lang_contract_class = into_contract_class_for_compilation(rpc_contract_class);
 
-        // Compile Sierra to Casm.
+        let casm_contract_class = self.compile(cairo_lang_contract_class)?;
+
+        validate_compiled_class_hash(&casm_contract_class, tx.compiled_class_hash)?;
+        self.validate_casm_class(&casm_contract_class)?;
+
+        into_class_info(
+            casm_contract_class,
+            rpc_contract_class.sierra_program.len(),
+            rpc_contract_class.abi.len(),
+        )
+    }
+
+    /// TODO(Arni): Pass the compilation args from the config.
+    fn compile(
+        &self,
+        cairo_lang_contract_class: CairoLangContractClass,
+    ) -> Result<CasmContractClass, GatewayError> {
         let catch_unwind_result =
             panic::catch_unwind(|| compile_sierra_to_casm(cairo_lang_contract_class));
-        let casm_contract_class = match catch_unwind_result {
-            Ok(compilation_result) => compilation_result?,
+        match catch_unwind_result {
+            Ok(compilation_result) => Ok(compilation_result?),
             Err(_) => {
                 // TODO(Arni): Log the panic.
-                return Err(GatewayError::CompilationError(CompilationUtilError::CompilationPanic));
+                Err(GatewayError::CompilationError(CompilationUtilError::CompilationPanic))
             }
-        };
-        self.validate_casm_class(&casm_contract_class)?;
-
-        let hash_result = CompiledClassHash(casm_contract_class.compiled_class_hash());
-        if hash_result != tx.compiled_class_hash {
-            return Err(GatewayError::CompiledClassHashMismatch {
-                supplied: tx.compiled_class_hash,
-                hash_result,
-            });
         }
-
-        // Convert Casm contract class to Starknet contract class directly.
-        let blockifier_contract_class =
-            ContractClass::V1(ContractClassV1::try_from(casm_contract_class)?);
-        let class_info = ClassInfo::new(
-            &blockifier_contract_class,
-            starknet_api_contract_class.sierra_program.len(),
-            starknet_api_contract_class.abi.len(),
-        )?;
-        Ok(class_info)
     }
 
     // TODO(Arni): Add test.
@@ -101,3 +98,31 @@ fn supported_builtins() -> &'static Vec<String> {
         SUPPORTED_BUILTIN_NAMES.iter().map(|builtin| builtin.to_string()).collect::<Vec<String>>()
     })
 }
+
+/// Returns a [`ClassInfo`] struct from the compiled contract class.
+fn into_class_info(
+    casm_contract_class: CasmContractClass,
+    sierra_program_len: usize,
+    abi_len: usize,
+) -> GatewayResult<ClassInfo> {
+    let blockifier_contract_class =
+        ContractClass::V1(ContractClassV1::try_from(casm_contract_class)?);
+    let class_info = ClassInfo::new(&blockifier_contract_class, sierra_program_len, abi_len)?;
+    Ok(class_info)
+}
+
+/// Validates that the compiled class hash of the compiled contract class matches the supplied
+/// compiled class hash.
+fn validate_compiled_class_hash(
+    casm_contract_class: &CasmContractClass,
+    supplied_compiled_class_hash: CompiledClassHash,
+) -> Result<(), GatewayError> {
+    let compiled_class_hash = CompiledClassHash(casm_contract_class.compiled_class_hash());
+    if compiled_class_hash != supplied_compiled_class_hash {
+        return Err(GatewayError::CompiledClassHashMismatch {
+            supplied: supplied_compiled_class_hash,
+            hash_result: compiled_class_hash,
+        });
+    }
+    Ok(())
+}
diff --git a/crates/gateway/src/compilation_test.rs b/crates/gateway/src/compilation_test.rs
@@ -1,13 +1,19 @@
 use assert_matches::assert_matches;
 use blockifier::execution::contract_class::ContractClass;
 use cairo_lang_starknet_classes::allowed_libfuncs::AllowedLibfuncsError;
-use mempool_test_utils::starknet_api_test_utils::declare_tx;
+use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
+use mempool_test_utils::starknet_api_test_utils::{
+    casm_contract_class, compiled_class_hash, contract_class, declare_tx,
+};
 use rstest::{fixture, rstest};
 use starknet_api::core::CompiledClassHash;
-use starknet_api::rpc_transaction::{RPCDeclareTransaction, RPCTransaction};
+use starknet_api::rpc_transaction::{
+    ContractClass as RpcContractClass, RPCDeclareTransaction, RPCTransaction,
+};
 use starknet_sierra_compile::errors::CompilationUtilError;
+use starknet_sierra_compile::utils::into_contract_class_for_compilation;
 
-use crate::compilation::GatewayCompiler;
+use crate::compilation::{validate_compiled_class_hash, GatewayCompiler};
 use crate::errors::GatewayError;
 
 #[fixture]
@@ -16,18 +22,14 @@ fn gateway_compiler() -> GatewayCompiler {
 }
 
 #[rstest]
-fn test_compile_contract_class_compiled_class_hash_missmatch(gateway_compiler: GatewayCompiler) {
-    let mut tx = assert_matches!(
-        declare_tx(),
-        RPCTransaction::Declare(RPCDeclareTransaction::V3(tx)) => tx
-    );
-    let expected_hash_result = tx.compiled_class_hash;
+fn test_compile_contract_class_compiled_class_hash_mismatch(
+    casm_contract_class: CasmContractClass,
+    compiled_class_hash: CompiledClassHash,
+) {
     let supplied_hash = CompiledClassHash::default();
+    let expected_hash_result = compiled_class_hash;
 
-    tx.compiled_class_hash = supplied_hash;
-    let declare_tx = RPCDeclareTransaction::V3(tx);
-
-    let result = gateway_compiler.compile_contract_class(&declare_tx);
+    let result = validate_compiled_class_hash(&casm_contract_class, supplied_hash);
     assert_matches!(
         result.unwrap_err(),
         GatewayError::CompiledClassHashMismatch { supplied, hash_result }
@@ -36,16 +38,15 @@ fn test_compile_contract_class_compiled_class_hash_missmatch(gateway_compiler: G
 }
 
 #[rstest]
-fn test_compile_contract_class_bad_sierra(gateway_compiler: GatewayCompiler) {
-    let mut tx = assert_matches!(
-        declare_tx(),
-        RPCTransaction::Declare(RPCDeclareTransaction::V3(tx)) => tx
-    );
-    // Truncate the sierra program to trigger an error.
-    tx.contract_class.sierra_program = tx.contract_class.sierra_program[..100].to_vec();
-    let declare_tx = RPCDeclareTransaction::V3(tx);
+fn test_compile_contract_class_bad_sierra(
+    gateway_compiler: GatewayCompiler,
+    mut contract_class: RpcContractClass,
+) {
+    // Create a currupted contract class.
+    contract_class.sierra_program = contract_class.sierra_program[..100].to_vec();
 
-    let result = gateway_compiler.compile_contract_class(&declare_tx);
+    let cairo_lang_contract_class = into_contract_class_for_compilation(&contract_class);
+    let result = gateway_compiler.compile(cairo_lang_contract_class);
     assert_matches!(
         result.unwrap_err(),
         GatewayError::CompilationError(CompilationUtilError::AllowedLibfuncsError(
@@ -55,15 +56,15 @@ fn test_compile_contract_class_bad_sierra(gateway_compiler: GatewayCompiler) {
 }
 
 #[rstest]
-fn test_compile_contract_class(gateway_compiler: GatewayCompiler) {
+fn test_handle_declare_tx(gateway_compiler: GatewayCompiler) {
     let declare_tx = assert_matches!(
         declare_tx(),
         RPCTransaction::Declare(declare_tx) => declare_tx
     );
     let RPCDeclareTransaction::V3(declare_tx_v3) = &declare_tx;
     let contract_class = &declare_tx_v3.contract_class;
 
-    let class_info = gateway_compiler.compile_contract_class(&declare_tx).unwrap();
+    let class_info = gateway_compiler.process_declare_tx(&declare_tx).unwrap();
     assert_matches!(class_info.contract_class(), ContractClass::V1(_));
     assert_eq!(class_info.sierra_program_length(), contract_class.sierra_program.len());
     assert_eq!(class_info.abi_length(), contract_class.abi.len());

diff --git a/crates/gateway/src/gateway.rs b/crates/gateway/src/gateway.rs
@@ -128,7 +128,7 @@ fn process_tx(
     // Compile Sierra to Casm.
     let optional_class_info = match &tx {
         RPCTransaction::Declare(declare_tx) => {
-            Some(gateway_compiler.compile_contract_class(declare_tx)?)
+            Some(gateway_compiler.process_declare_tx(declare_tx)?)
         }
         _ => None,
     };

diff --git a/crates/gateway/src/gateway_test.rs b/crates/gateway/src/gateway_test.rs
@@ -117,7 +117,7 @@ fn calculate_hash(
 ) -> TransactionHash {
     let optional_class_info = match &external_tx {
         RPCTransaction::Declare(declare_tx) => {
-            Some(gateway_compiler.compile_contract_class(declare_tx).unwrap())
+            Some(gateway_compiler.process_declare_tx(declare_tx).unwrap())
         }
         _ => None,
     };

diff --git a/crates/gateway/src/stateful_transaction_validator_test.rs b/crates/gateway/src/stateful_transaction_validator_test.rs
@@ -97,7 +97,7 @@ fn test_stateful_tx_validator(
     let optional_class_info = match &external_tx {
         RPCTransaction::Declare(declare_tx) => Some(
             GatewayCompiler { config: GatewayCompilerConfig {} }
-                .compile_contract_class(declare_tx)
+                .process_declare_tx(declare_tx)
                 .unwrap(),
         ),
         _ => None,
@@ -161,7 +161,7 @@ fn test_skip_stateful_validation(
         // To be sure that the validations were actually skipped, we check that the error came from
         // the blockifier stateful validations, and not from the pre validations since those are
         // executed also when skip_validate is true.
-        assert_matches!(result, Err(StatefulTransactionValidatorError::StatefulValidatorError(err)) 
+        assert_matches!(result, Err(StatefulTransactionValidatorError::StatefulValidatorError(err))
             if !matches!(err, StatefulValidatorError::TransactionPreValidationError(_)));
     }
 }

diff --git a/crates/mempool_test_utils/Cargo.toml b/crates/mempool_test_utils/Cargo.toml
@@ -10,6 +10,8 @@ license.workspace = true
 [dependencies]
 assert_matches.workspace = true
 blockifier.workspace = true
+cairo-lang-starknet-classes.workspace = true
+rstest.workspace = true
 starknet-types-core.workspace = true
 starknet_api.workspace = true
 serde_json.workspace = true

diff --git a/crates/mempool_test_utils/src/lib.rs b/crates/mempool_test_utils/src/lib.rs
@@ -5,6 +5,7 @@ pub mod starknet_api_test_utils;
 
 pub const TEST_FILES_FOLDER: &str = "crates/mempool_test_utils/test_files";
 pub const CONTRACT_CLASS_FILE: &str = "contract_class.json";
+pub const CASM_CONTRACT_CLASS_FILE: &str = "casm_contract_class.json";
 pub const COMPILED_CLASS_HASH_OF_CONTRACT_CLASS: &str =
     "0x01e4f1248860f32c336f93f2595099aaa4959be515e40b75472709ef5243ae17";
 pub const FAULTY_ACCOUNT_CLASS_FILE: &str = "faulty_account.sierra.json";

diff --git a/crates/mempool_test_utils/src/starknet_api_test_utils.rs b/crates/mempool_test_utils/src/starknet_api_test_utils.rs
@@ -6,6 +6,8 @@ use std::path::Path;
 use assert_matches::assert_matches;
 use blockifier::test_utils::contracts::FeatureContract;
 use blockifier::test_utils::{create_trivial_calldata, CairoVersion, NonceManager};
+use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
+use rstest::fixture;
 use serde_json::to_string_pretty;
 use starknet_api::core::{
     calculate_contract_address, ClassHash, CompiledClassHash, ContractAddress, Nonce,
@@ -24,7 +26,8 @@ use starknet_types_core::felt::Felt;
 
 use crate::{
     declare_tx_args, deploy_account_tx_args, get_absolute_path, invoke_tx_args,
-    COMPILED_CLASS_HASH_OF_CONTRACT_CLASS, CONTRACT_CLASS_FILE, TEST_FILES_FOLDER,
+    CASM_CONTRACT_CLASS_FILE, COMPILED_CLASS_HASH_OF_CONTRACT_CLASS, CONTRACT_CLASS_FILE,
+    TEST_FILES_FOLDER,
 };
 
 pub const VALID_L1_GAS_MAX_AMOUNT: u64 = 203483;
@@ -88,11 +91,31 @@ pub fn executable_resource_bounds_mapping() -> ResourceBoundsMapping {
     )
 }
 
-pub fn declare_tx() -> RPCTransaction {
+/// Get the contract class used for testing.
+#[fixture]
+pub fn contract_class() -> ContractClass {
     env::set_current_dir(get_absolute_path(TEST_FILES_FOLDER)).expect("Couldn't set working dir.");
     let json_file_path = Path::new(CONTRACT_CLASS_FILE);
-    let contract_class = serde_json::from_reader(File::open(json_file_path).unwrap()).unwrap();
-    let compiled_class_hash = CompiledClassHash(felt!(COMPILED_CLASS_HASH_OF_CONTRACT_CLASS));
+    serde_json::from_reader(File::open(json_file_path).unwrap()).unwrap()
+}
+
+/// Get the casm contract class corresponding to the contract class used for testing.
+#[fixture]
+pub fn casm_contract_class() -> CasmContractClass {
+    env::set_current_dir(get_absolute_path(TEST_FILES_FOLDER)).expect("Couldn't set working dir.");
+    let json_file_path = Path::new(CASM_CONTRACT_CLASS_FILE);
+    serde_json::from_reader(File::open(json_file_path).unwrap()).unwrap()
+}
+
+/// Get the compiled class hash corresponding to the contract class used for testing.
+#[fixture]
+pub fn compiled_class_hash() -> CompiledClassHash {
+    CompiledClassHash(felt!(COMPILED_CLASS_HASH_OF_CONTRACT_CLASS))
+}
+
+pub fn declare_tx() -> RPCTransaction {
+    let contract_class = contract_class();
+    let compiled_class_hash = compiled_class_hash();
 
     let account_contract = FeatureContract::AccountWithoutValidations(CairoVersion::Cairo1);
     let account_address = account_contract.get_instance_address(0);