minor code cleanup

edg-l · edg-l · commit 0502bc84a627 · 2023-08-31T14:35:30.000+02:00
diff --git a/src/core/contract_address/deprecated_contract_address.rs b/src/core/contract_address/deprecated_contract_address.rs
@@ -169,7 +169,6 @@ impl serde_json::ser::Formatter for PythonDefaultFormatter {
 
 #[derive(serde::Deserialize, serde::Serialize)]
 #[serde(deny_unknown_fields)]
-
 pub struct CairoContractDefinition<'a> {
     /// Contract ABI, which has no schema definition.
     pub abi: serde_json::Value,
@@ -257,7 +256,7 @@ pub(crate) fn compute_hinted_class_hash(
                 None => {}
             }
             // We don't know what this type is supposed to be, but if its missing it is null.
-            if let Some(serde_json::Value::Null) = vals.get_mut("flow_tracking_data") {
+            if vals.get("flow_tracking_data") == Some(&serde_json::Value::Null) {
                 vals.remove("flow_tracking_data");
             }
 
diff --git a/src/definitions/block_context.rs b/src/definitions/block_context.rs
@@ -85,7 +85,7 @@ impl StarknetOsConfig {
     /// * `chain_id` - [`Felt252`] of the configured chain.
     /// * `fee_token_address` - Address of the token used when paying fees.
     /// * `gas_price` - Price of gas.
-    pub fn new(chain_id: Felt252, fee_token_address: Address, gas_price: u128) -> Self {
+    pub const fn new(chain_id: Felt252, fee_token_address: Address, gas_price: u128) -> Self {
         StarknetOsConfig {
             chain_id,
             fee_token_address,
@@ -139,7 +139,7 @@ impl BlockContext {
     ///     Example: for block number 6351, this includes the blocks 5327, 5328, ..., 6340, 6341.
     /// * `enforce_l1_handler_fee` - Whether to enforce the L1 handler fee.
     #[allow(clippy::too_many_arguments)]
-    pub fn new(
+    pub const fn new(
         starknet_os_config: StarknetOsConfig,
         contract_storage_commitment_tree_height: u64,
         global_state_commitment_tree_height: u64,
diff --git a/src/execution/gas_usage.rs b/src/execution/gas_usage.rs
@@ -105,7 +105,7 @@ pub fn get_message_segment_lenght(
 /// # Returns:
 ///
 /// The on-chain data segment length
-pub fn get_onchain_data_segment_length(
+pub const fn get_onchain_data_segment_length(
     n_modified_contracts: usize,
     n_storage_changes: usize,
     n_deployments: usize,
@@ -159,7 +159,7 @@ pub fn get_log_message_to_l1_emissions_cost(l2_to_l1_messages: &[L2toL1MessageIn
 /// # Returns:
 ///
 /// The cost of event emissions.
-pub fn get_event_emission_cost(topics: usize, l1_handler_payload_size: usize) -> usize {
+pub const fn get_event_emission_cost(topics: usize, l1_handler_payload_size: usize) -> usize {
     GAS_PER_LOG
         + (topics + N_DEFAULT_TOPICS) * GAS_PER_LOG_TOPIC
         + l1_handler_payload_size * GAS_PER_LOG_DATA_WORD
diff --git a/src/execution/mod.rs b/src/execution/mod.rs
@@ -494,7 +494,7 @@ pub struct TransactionExecutionInfo {
 }
 
 impl TransactionExecutionInfo {
-    pub fn new(
+    pub const fn new(
         validate_info: Option<CallInfo>,
         call_info: Option<CallInfo>,
         revert_error: Option<String>,
@@ -553,7 +553,7 @@ impl TransactionExecutionInfo {
         }
     }
 
-    pub fn new_without_fee_info(
+    pub const fn new_without_fee_info(
         validate_info: Option<CallInfo>,
         call_info: Option<CallInfo>,
         revert_error: Option<String>,
diff --git a/src/hash_utils.rs b/src/hash_utils.rs
@@ -125,9 +125,9 @@ pub fn compute_hash_on_elements(vec: &[Felt252]) -> Result<Felt252, HashError> {
     let felt_result = felt_vec
         .into_iter()
         .reduce(|x, y| pedersen_hash(&x, &y))
-        .ok_or(HashError::FailedToComputeHash(
-            "Failed to compute Pedersen hash.".to_string(),
-        ))?;
+        .ok_or_else(|| {
+            HashError::FailedToComputeHash("Failed to compute Pedersen hash.".to_string())
+        })?;
 
     let result = Felt252::from_bytes_be(&felt_result.to_bytes_be());
     Ok(result)
diff --git a/src/runner/mod.rs b/src/runner/mod.rs
@@ -69,7 +69,7 @@ impl<H> StarknetRunner<H>
 where
     H: HintProcessor + HintProcessorPostRun,
 {
-    pub fn new(cairo_runner: CairoRunner, vm: VirtualMachine, hint_processor: H) -> Self {
+    pub const fn new(cairo_runner: CairoRunner, vm: VirtualMachine, hint_processor: H) -> Self {
         StarknetRunner {
             cairo_runner,
             vm,
diff --git a/src/services/api/contract_classes/deprecated_contract_class.rs b/src/services/api/contract_classes/deprecated_contract_class.rs
@@ -36,7 +36,7 @@ pub struct ContractEntryPoint {
 }
 
 impl ContractEntryPoint {
-    pub fn new(selector: Felt252, offset: usize) -> ContractEntryPoint {
+    pub const fn new(selector: Felt252, offset: usize) -> ContractEntryPoint {
         ContractEntryPoint { selector, offset }
     }
 }
diff --git a/src/state/in_memory_state_reader.rs b/src/state/in_memory_state_reader.rs
@@ -15,7 +15,7 @@ use std::collections::HashMap;
 ///
 /// This implementation is used for testing and debugging.
 /// It uses HashMaps to store the data.
-#[derive(Debug, MutGetters, Getters, PartialEq, Clone, Default)]
+#[derive(Debug, MutGetters, Getters, PartialEq, Eq, Clone, Default)]
 pub struct InMemoryStateReader {
     #[getset(get_mut = "pub")]
     pub address_to_class_hash: HashMap<Address, ClassHash>,
@@ -39,7 +39,7 @@ impl InMemoryStateReader {
     /// - `class_hash_to_contract_class` - A HashMap from class hashes to their contract classes.
     /// - `casm_contract_classes` - A [CasmClassCache].
     /// - `class_hash_to_compiled_class_hash` - A HashMap from class hashes to their compiled class hashes.
-    pub fn new(
+    pub const fn new(
         address_to_class_hash: HashMap<Address, ClassHash>,
         address_to_nonce: HashMap<Address, Felt252>,
         address_to_storage: HashMap<StorageEntry, Felt252>,
diff --git a/src/state/mod.rs b/src/state/mod.rs
@@ -35,7 +35,7 @@ pub struct BlockInfo {
 }
 
 impl BlockInfo {
-    pub fn empty(sequencer_address: Address) -> Self {
+    pub const fn empty(sequencer_address: Address) -> Self {
         BlockInfo {
             block_number: 0, // To do: In cairo-lang, this value is set to -1
             block_timestamp: 0,
@@ -44,7 +44,7 @@ impl BlockInfo {
         }
     }
 
-    pub fn validate_legal_progress(
+    pub const fn validate_legal_progress(
         &self,
         next_block_info: &BlockInfo,
     ) -> Result<(), TransactionError> {
@@ -102,7 +102,7 @@ impl ExecutionResourcesManager {
     }
 }
 
-#[derive(Default, Clone, PartialEq, Debug, Getters)]
+#[derive(Default, Clone, PartialEq, Eq, Debug, Getters)]
 #[getset(get = "pub")]
 pub struct StateDiff {
     pub(crate) address_to_class_hash: HashMap<Address, ClassHash>,
@@ -112,7 +112,7 @@ pub struct StateDiff {
 }
 
 impl StateDiff {
-    pub fn new(
+    pub const fn new(
         address_to_class_hash: HashMap<Address, ClassHash>,
         address_to_nonce: HashMap<Address, Felt252>,
         class_hash_to_compiled_class: HashMap<ClassHash, CompiledClass>,
diff --git a/src/state/state_cache.rs b/src/state/state_cache.rs
@@ -41,7 +41,7 @@ impl StateCache {
     #[allow(clippy::too_many_arguments)]
 
     /// Create a new StateCache with given initial and written values for testing
-    pub fn new(
+    pub const fn new(
         class_hash_initial_values: HashMap<Address, ClassHash>,
         compiled_class_hash_initial_values: HashMap<ClassHash, CompiledClass>,
         nonce_initial_values: HashMap<Address, Felt252>,
@@ -82,7 +82,7 @@ impl StateCache {
 
     /// Creates a new instance of `StateCache` for testing purposes with the provided initial values and writes.
     #[allow(clippy::too_many_arguments)]
-    pub fn new_for_testing(
+    pub const fn new_for_testing(
         class_hash_initial_values: HashMap<Address, [u8; 32]>,
         compiled_class_hash_initial_values: HashMap<ClassHash, CompiledClass>,
         nonce_initial_values: HashMap<Address, Felt252>,
diff --git a/src/syscalls/business_logic_syscall_handler.rs b/src/syscalls/business_logic_syscall_handler.rs
@@ -258,7 +258,7 @@ impl<'a, S: StateReader> BusinessLogicSyscallHandler<'a, S> {
             .map_err(|err| SyscallHandlerError::ExecutionError(err.to_string()))?;
 
         let call_info = call_info.ok_or(SyscallHandlerError::ExecutionError(
-            revert_error.unwrap_or("Execution error".to_string()),
+            revert_error.unwrap_or_else(|| "Execution error".to_string()),
         ))?;
 
         let retdata_maybe_reloc = call_info
@@ -376,7 +376,7 @@ impl<'a, S: StateReader> BusinessLogicSyscallHandler<'a, S> {
             .map_err(|_| StateError::ExecutionEntryPoint())?;
 
         let call_info = call_info.ok_or(StateError::CustomError(
-            revert_error.unwrap_or("Execution error".to_string()),
+            revert_error.unwrap_or_else(|| "Execution error".to_string()),
         ))?;
 
         self.internal_calls.push(call_info.clone());
diff --git a/src/syscalls/deprecated_business_logic_syscall_handler.rs b/src/syscalls/deprecated_business_logic_syscall_handler.rs
@@ -452,7 +452,7 @@ impl<'a, S: StateReader> DeprecatedBLSyscallHandler<'a, S> {
             .map_err(|e| SyscallHandlerError::ExecutionError(e.to_string()))?;
 
         let call_info = call_info.ok_or(SyscallHandlerError::ExecutionError(
-            revert_error.unwrap_or("Execution error".to_string()),
+            revert_error.unwrap_or_else(|| "Execution error".to_string()),
         ))?;
 
         let retdata = call_info.retdata.clone();
@@ -461,7 +461,7 @@ impl<'a, S: StateReader> DeprecatedBLSyscallHandler<'a, S> {
         Ok(retdata)
     }
 
-    pub(crate) fn get_block_info(&self) -> &BlockInfo {
+    pub(crate) const fn get_block_info(&self) -> &BlockInfo {
         &self.block_context.block_info
     }
 
diff --git a/src/syscalls/deprecated_syscall_response.rs b/src/syscalls/deprecated_syscall_response.rs
@@ -60,7 +60,7 @@ pub(crate) struct DeprecatedGetBlockNumberResponse {
 }
 
 impl DeprecatedCallContractResponse {
-    pub(crate) fn new(retdata_size: usize, retdata: Relocatable) -> Self {
+    pub(crate) const fn new(retdata_size: usize, retdata: Relocatable) -> Self {
         Self {
             retdata_size,
             retdata,
@@ -86,19 +86,19 @@ pub(crate) struct DeprecatedDeployResponse {
 }
 
 impl DeprecatedGetTxInfoResponse {
-    pub fn new(tx_info: Relocatable) -> Self {
+    pub const fn new(tx_info: Relocatable) -> Self {
         DeprecatedGetTxInfoResponse { tx_info }
     }
 }
 
 impl DeprecatedGetBlockTimestampResponse {
-    pub(crate) fn new(block_timestamp: u64) -> Self {
+    pub(crate) const fn new(block_timestamp: u64) -> Self {
         DeprecatedGetBlockTimestampResponse { block_timestamp }
     }
 }
 
 impl DeprecatedGetSequencerAddressResponse {
-    pub(crate) fn new(sequencer_address: Address) -> Self {
+    pub(crate) const fn new(sequencer_address: Address) -> Self {
         Self { sequencer_address }
     }
 }
@@ -111,32 +111,32 @@ impl DeprecatedGetCallerAddressResponse {
 }
 
 impl DeprecatedGetTxSignatureResponse {
-    pub fn new(signature: Relocatable, signature_len: usize) -> Self {
+    pub const fn new(signature: Relocatable, signature_len: usize) -> Self {
         DeprecatedGetTxSignatureResponse {
             signature,
             signature_len,
         }
     }
 }
 impl DeprecatedGetContractAddressResponse {
-    pub fn new(contract_address: Address) -> Self {
+    pub const fn new(contract_address: Address) -> Self {
         DeprecatedGetContractAddressResponse { contract_address }
     }
 }
 
 impl DeprecatedStorageReadResponse {
-    pub fn new(value: Felt252) -> Self {
+    pub const fn new(value: Felt252) -> Self {
         DeprecatedStorageReadResponse { value }
     }
 }
 
 impl DeprecatedGetBlockNumberResponse {
-    pub(crate) fn new(block_number: u64) -> Self {
+    pub(crate) const fn new(block_number: u64) -> Self {
         Self { block_number }
     }
 }
 impl DeprecatedDeployResponse {
-    pub(crate) fn new(
+    pub(crate) const fn new(
         contract_address: Felt252,
         constructor_retdata_size: Felt252,
         constructor_retdata: Relocatable,
diff --git a/src/syscalls/syscall_response.rs b/src/syscalls/syscall_response.rs
@@ -76,7 +76,7 @@ impl SyscallResponse {
 // ----------------------
 
 /// Represents the response of get_block_timestamp syscall.
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct GetBlockTimestampResponse {
     /// The block timestamp.
     pub timestamp: Felt252,
@@ -104,7 +104,7 @@ pub struct FailureReason {
 }
 
 /// Represents the response of call_contract syscall
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct CallContractResponse {
     /// The retdata segment start.
     pub retdata_start: Relocatable,
@@ -113,14 +113,14 @@ pub struct CallContractResponse {
 }
 
 /// Represents the response of get_block_hash syscall
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct GetBlockHashResponse {
     /// The returned hash.
     pub block_hash: Felt252,
 }
 
 /// Represents the response of the `keccak` syscall
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct KeccakResponse {
     /// The returned hash.
     pub hash_low: Felt252,
diff --git a/src/transaction/deploy.rs b/src/transaction/deploy.rs
@@ -125,7 +125,7 @@ impl Deploy {
     }
 
     /// Returns the class hash of the deployed contract
-    pub fn class_hash(&self) -> ClassHash {
+    pub const fn class_hash(&self) -> ClassHash {
         self.contract_hash
     }
 
@@ -351,7 +351,7 @@ mod tests {
             class_hash_bytes
         );
 
-        let storage_key = calculate_sn_keccak("owner".as_bytes());
+        let storage_key = calculate_sn_keccak(b"owner");
 
         assert_eq!(
             state
diff --git a/src/transaction/invoke_function.rs b/src/transaction/invoke_function.rs
@@ -1174,9 +1174,7 @@ mod tests {
     fn test_reverted_transaction_wrong_entry_point() {
         let internal_invoke_function = InvokeFunction {
             contract_address: Address(0.into()),
-            entry_point_selector: Felt252::from_bytes_be(&calculate_sn_keccak(
-                "factorial_".as_bytes(),
-            )),
+            entry_point_selector: Felt252::from_bytes_be(&calculate_sn_keccak(b"factorial_")),
             entry_point_type: EntryPointType::External,
             calldata: vec![],
             tx_type: TransactionType::InvokeFunction,
diff --git a/src/utils.rs b/src/utils.rs
@@ -585,7 +585,6 @@ mod test {
     }
 
     #[test]
-
     fn subtract_mappings_test() {
         let mut a = HashMap::new();
         let mut b = HashMap::new();
@@ -634,7 +633,6 @@ mod test {
     }
 
     #[test]
-
     fn to_cache_state_storage_mapping_test() {
         let mut storage: HashMap<(Address, ClassHash), Felt252> = HashMap::new();
         let address1: Address = Address(1.into());

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,6 @@ impl serde_json::ser::Formatter for PythonDefaultFormatter {`
`169`	`169`
`170`	`170`	`#[derive(serde::Deserialize, serde::Serialize)]`
`171`	`171`	`#[serde(deny_unknown_fields)]`
`172`		`-`
`173`	`172`	`pub struct CairoContractDefinition<'a> {`
`174`	`173`	`/// Contract ABI, which has no schema definition.`
`175`	`174`	`pub abi: serde_json::Value,`
`@@ -257,7 +256,7 @@ pub(crate) fn compute_hinted_class_hash(`
`257`	`256`	`None => {}`
`258`	`257`	`}`
`259`	`258`	`// We don't know what this type is supposed to be, but if its missing it is null.`
`260`		`- if let Some(serde_json::Value::Null) = vals.get_mut("flow_tracking_data") {`
	`259`	`+ if vals.get("flow_tracking_data") == Some(&serde_json::Value::Null) {`
`261`	`260`	`vals.remove("flow_tracking_data");`
`262`	`261`	`}`
`263`	`262`
Original file line number	Diff line number	Diff line change
`@@ -494,7 +494,7 @@ pub struct TransactionExecutionInfo {`
`494`	`494`	`}`
`495`	`495`
`496`	`496`	`impl TransactionExecutionInfo {`
`497`		`- pub fn new(`
	`497`	`+ pub const fn new(`
`498`	`498`	`validate_info: Option<CallInfo>,`
`499`	`499`	`call_info: Option<CallInfo>,`
`500`	`500`	`revert_error: Option<String>,`
`@@ -553,7 +553,7 @@ impl TransactionExecutionInfo {`
`553`	`553`	`}`
`554`	`554`	`}`
`555`	`555`
`556`		`- pub fn new_without_fee_info(`
	`556`	`+ pub const fn new_without_fee_info(`
`557`	`557`	`validate_info: Option<CallInfo>,`
`558`	`558`	`call_info: Option<CallInfo>,`
`559`	`559`	`revert_error: Option<String>,`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ impl<H> StarknetRunner<H>`
`69`	`69`	`where`
`70`	`70`	`H: HintProcessor + HintProcessorPostRun,`
`71`	`71`	`{`
`72`		`- pub fn new(cairo_runner: CairoRunner, vm: VirtualMachine, hint_processor: H) -> Self {`
	`72`	`+ pub const fn new(cairo_runner: CairoRunner, vm: VirtualMachine, hint_processor: H) -> Self {`
`73`	`73`	`StarknetRunner {`
`74`	`74`	`cairo_runner,`
`75`	`75`	`vm,`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ pub struct ContractEntryPoint {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`impl ContractEntryPoint {`
`39`		`- pub fn new(selector: Felt252, offset: usize) -> ContractEntryPoint {`
	`39`	`+ pub const fn new(selector: Felt252, offset: usize) -> ContractEntryPoint {`
`40`	`40`	`ContractEntryPoint { selector, offset }`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ pub struct BlockInfo {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`impl BlockInfo {`
`38`		`- pub fn empty(sequencer_address: Address) -> Self {`
	`38`	`+ pub const fn empty(sequencer_address: Address) -> Self {`
`39`	`39`	`BlockInfo {`
`40`	`40`	`block_number: 0, // To do: In cairo-lang, this value is set to -1`
`41`	`41`	`block_timestamp: 0,`
`@@ -44,7 +44,7 @@ impl BlockInfo {`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
`47`		`- pub fn validate_legal_progress(`
	`47`	`+ pub const fn validate_legal_progress(`
`48`	`48`	`&self,`
`49`	`49`	`next_block_info: &BlockInfo,`
`50`	`50`	`) -> Result<(), TransactionError> {`
`@@ -102,7 +102,7 @@ impl ExecutionResourcesManager {`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
`105`		`-#[derive(Default, Clone, PartialEq, Debug, Getters)]`
	`105`	`+#[derive(Default, Clone, PartialEq, Eq, Debug, Getters)]`
`106`	`106`	`#[getset(get = "pub")]`
`107`	`107`	`pub struct StateDiff {`
`108`	`108`	`pub(crate) address_to_class_hash: HashMap<Address, ClassHash>,`
`@@ -112,7 +112,7 @@ pub struct StateDiff {`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`impl StateDiff {`
`115`		`- pub fn new(`
	`115`	`+ pub const fn new(`
`116`	`116`	`address_to_class_hash: HashMap<Address, ClassHash>,`
`117`	`117`	`address_to_nonce: HashMap<Address, Felt252>,`
`118`	`118`	`class_hash_to_compiled_class: HashMap<ClassHash, CompiledClass>,`