Unified crate for Cairo deps used in Katana (dojoengine#1999)

* unified cairo crate forr katana * update * remove license file field
fishseabowl · May 27, 2024 · 492f5ae · 492f5ae
1 parent 666d835
commit 492f5ae
Show file tree

Hide file tree

Showing 13 changed files with 718 additions and 250 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -69,6 +69,7 @@ dojo-types = { path = "crates/dojo-types" }
 dojo-world = { path = "crates/dojo-world" }
 
 # katana
+katana-cairo = { path = "crates/katana/cairo" }
 katana-codecs = { path = "crates/katana/storage/codecs" }
 katana-codecs-derive = { path = "crates/katana/storage/codecs/derive" }
 katana-core = { path = "crates/katana/core", default-features = false }

diff --git a/crates/katana/cairo/Cargo.toml b/crates/katana/cairo/Cargo.toml
@@ -0,0 +1,19 @@
+[package]
+description = "Collection of Cairo language dependencies that are used throughout Katana. Unifying the Cairo language based dependencies to avoid dependency conflict with the versions used by Dojo."
+edition.workspace = true
+license.workspace = true
+name = "katana-cairo"
+repository.workspace = true
+version.workspace = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+# Use from git instead of crates.io registry so that the workspace patches aren't applied.
+[dependencies]
+cairo-lang-casm = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-lang-runner = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-lang-sierra = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-lang-starknet = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-lang-starknet-classes = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-lang-utils = { git = "https://github.com/starkware-libs/cairo", tag = "v2.6.3" }
+cairo-vm = "0.9.2"
diff --git a/crates/katana/cairo/src/lib.rs b/crates/katana/cairo/src/lib.rs
@@ -0,0 +1,13 @@
+#![warn(unused_crate_dependencies)]
+
+//! Re-export of the Cairo language crates used throughout Katana.
+
+pub mod lang {
+    pub use {
+        cairo_lang_casm as casm, cairo_lang_runner as runner, cairo_lang_sierra as sierra,
+        cairo_lang_starknet as starknet, cairo_lang_starknet_classes as starknet_classes,
+        cairo_lang_utils as utils,
+    };
+}
+
+pub use cairo_vm;
diff --git a/crates/katana/executor/Cargo.toml b/crates/katana/executor/Cargo.toml
@@ -22,8 +22,8 @@ tracing.workspace = true
 alloy-primitives.workspace = true
 
 # blockifier deps
-blockifier = { git = "https://github.com/dojoengine/blockifier", rev = "7d866a24", features = [ "testing" ], optional = true }
-cairo-vm = { workspace = true, optional = true }
+blockifier = { git = "https://github.com/dojoengine/blockifier", rev = "57c11586", features = [ "testing" ], optional = true }
+katana-cairo = { workspace = true, optional = true }
 
 # Disable SIR for now until they support Cairo 2.6.3
 # # starknet_in_rust deps
@@ -33,7 +33,7 @@ cairo-vm = { workspace = true, optional = true }
 
 [dev-dependencies]
 anyhow.workspace = true
-cairo-vm.workspace = true
+katana-cairo.workspace = true
 katana-provider = { workspace = true, features = [ "test-utils" ] }
 katana-rpc-types.workspace = true
 rstest.workspace = true
@@ -46,7 +46,7 @@ criterion.workspace = true
 pprof = { version = "0.13.0", features = [ "criterion", "flamegraph" ] }
 
 [features]
-blockifier = [ "dep:blockifier", "dep:cairo-vm" ]
+blockifier = [ "dep:blockifier", "dep:katana-cairo" ]
 default = [ "blockifier" ]
 # native = [ "sir", "sir/cairo-native" ]
 # sir = [ "dep:sir", "dep:starknet-types-core" ]

diff --git a/crates/katana/executor/benches/utils.rs b/crates/katana/executor/benches/utils.rs
@@ -1,6 +1,6 @@
 use std::collections::HashMap;
 
-use cairo_vm::vm::runners::builtin_runner::{
+use katana_cairo::cairo_vm::vm::runners::builtin_runner::{
     BITWISE_BUILTIN_NAME, EC_OP_BUILTIN_NAME, HASH_BUILTIN_NAME, KECCAK_BUILTIN_NAME,
     OUTPUT_BUILTIN_NAME, POSEIDON_BUILTIN_NAME, RANGE_CHECK_BUILTIN_NAME,
     SEGMENT_ARENA_BUILTIN_NAME, SIGNATURE_BUILTIN_NAME,

diff --git a/crates/katana/executor/src/implementation/blockifier/utils.rs b/crates/katana/executor/src/implementation/blockifier/utils.rs
@@ -26,8 +26,8 @@ use blockifier::transaction::transactions::{
     L1HandlerTransaction,
 };
 use blockifier::versioned_constants::VersionedConstants;
-use cairo_vm::types::errors::program_errors::ProgramError;
-use cairo_vm::vm::runners::cairo_runner::ExecutionResources;
+use katana_cairo::cairo_vm::types::errors::program_errors::ProgramError;
+use katana_cairo::cairo_vm::vm::runners::cairo_runner::ExecutionResources;
 use katana_primitives::env::{BlockEnv, CfgEnv};
 use katana_primitives::fee::TxFeeInfo;
 use katana_primitives::state::{StateUpdates, StateUpdatesWithDeclaredClasses};
@@ -656,7 +656,7 @@ mod tests {
 
     use std::collections::HashSet;
 
-    use cairo_vm::vm::runners::cairo_runner::ExecutionResources;
+    use katana_cairo::cairo_vm::vm::runners::cairo_runner::ExecutionResources;
     use katana_primitives::chain::{ChainId, NamedChainId};
     use starknet_api::core::EntryPointSelector;
     use starknet_api::hash::StarkFelt;

diff --git a/crates/katana/executor/tests/fixtures/mod.rs b/crates/katana/executor/tests/fixtures/mod.rs
@@ -3,7 +3,7 @@ pub mod transaction;
 use std::collections::HashMap;
 
 use alloy_primitives::U256;
-use cairo_vm::vm::runners::builtin_runner::{
+use katana_cairo::cairo_vm::vm::runners::builtin_runner::{
     BITWISE_BUILTIN_NAME, EC_OP_BUILTIN_NAME, HASH_BUILTIN_NAME, KECCAK_BUILTIN_NAME,
     OUTPUT_BUILTIN_NAME, POSEIDON_BUILTIN_NAME, RANGE_CHECK_BUILTIN_NAME,
     SEGMENT_ARENA_BUILTIN_NAME, SIGNATURE_BUILTIN_NAME,

diff --git a/crates/katana/primitives/Cargo.toml b/crates/katana/primitives/Cargo.toml
@@ -9,7 +9,6 @@ version.workspace = true
 [dependencies]
 anyhow.workspace = true
 base64.workspace = true
-cairo-vm.workspace = true
 derive_more.workspace = true
 lazy_static.workspace = true
 rand = { workspace = true, features = [ "small_rng" ] }
@@ -24,10 +23,8 @@ strum_macros.workspace = true
 thiserror.workspace = true
 
 alloy-primitives.workspace = true
-cairo-lang-sierra.workspace = true
-cairo-lang-starknet-classes.workspace = true
-cairo-lang-starknet.workspace = true
 flate2.workspace = true
+katana-cairo.workspace = true
 starknet_api.workspace = true
 
 [dev-dependencies]

diff --git a/crates/katana/primitives/src/class.rs b/crates/katana/primitives/src/class.rs
@@ -1,4 +1,6 @@
-use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
+use katana_cairo::lang::sierra::program::Program;
+use katana_cairo::lang::starknet_classes::casm_contract_class::CasmContractClass;
+use katana_cairo::lang::starknet_classes::contract_class::ContractEntryPoints;
 
 use crate::FieldElement;
 
@@ -17,8 +19,8 @@ pub type DeprecatedCompiledClass = ::starknet_api::deprecated_contract_class::Co
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct SierraProgram {
-    pub program: cairo_lang_sierra::program::Program,
-    pub entry_points_by_type: cairo_lang_starknet_classes::contract_class::ContractEntryPoints,
+    pub program: Program,
+    pub entry_points_by_type: ContractEntryPoints,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq)]

diff --git a/crates/katana/primitives/src/conversion/rpc.rs b/crates/katana/primitives/src/conversion/rpc.rs
@@ -3,7 +3,7 @@ use std::io::{self, Read, Write};
 use std::mem;
 
 use anyhow::{Context, Result};
-use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
+use katana_cairo::lang::starknet_classes::casm_contract_class::CasmContractClass;
 use serde::Deserialize;
 use serde_json::json;
 use serde_with::serde_as;
@@ -186,10 +186,10 @@ pub fn legacy_rpc_to_compiled_class(
 /// [ContractClass](cairo_lang_starknet::contract_class::ContractClass) type.
 fn rpc_to_cairo_contract_class(
     contract_class: &FlattenedSierraClass,
-) -> Result<cairo_lang_starknet_classes::contract_class::ContractClass, std::io::Error> {
+) -> Result<katana_cairo::lang::starknet_classes::contract_class::ContractClass, std::io::Error> {
     let value = serde_json::to_value(contract_class)?;
 
-    Ok(cairo_lang_starknet_classes::contract_class::ContractClass {
+    Ok(katana_cairo::lang::starknet_classes::contract_class::ContractClass {
         abi: serde_json::from_value(value["abi"].clone()).ok(),
         sierra_program: serde_json::from_value(value["sierra_program"].clone())?,
         entry_points_by_type: serde_json::from_value(value["entry_points_by_type"].clone())?,

diff --git a/crates/katana/primitives/src/genesis/json.rs b/crates/katana/primitives/src/genesis/json.rs
@@ -12,8 +12,8 @@ use std::sync::Arc;
 
 use alloy_primitives::U256;
 use base64::prelude::*;
-use cairo_lang_starknet_classes::casm_contract_class::StarknetSierraCompilationError;
-use cairo_vm::types::errors::program_errors::ProgramError;
+use katana_cairo::cairo_vm::types::errors::program_errors::ProgramError;
+use katana_cairo::lang::starknet_classes::casm_contract_class::StarknetSierraCompilationError;
 use serde::de::value::MapAccessDeserializer;
 use serde::de::Visitor;
 use serde::{Deserialize, Serialize};

diff --git a/crates/katana/primitives/src/utils/class.rs b/crates/katana/primitives/src/utils/class.rs
@@ -1,6 +1,6 @@
 use anyhow::Result;
-use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
-use cairo_lang_starknet_classes::contract_class::ContractClass;
+use katana_cairo::lang::starknet_classes::casm_contract_class::CasmContractClass;
+use katana_cairo::lang::starknet_classes::contract_class::ContractClass;
 use serde_json::Value;
 
 use crate::class::{