Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: streamline class info object to match contract class #427

Closed
wants to merge 1 commit into from
Closed

refactor: streamline class info object to match contract class #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 53 additions & 48 deletions crates/blockifier/src/execution/contract_class.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,41 +542,79 @@ fn convert_entry_points_v1(external: &[CasmContractEntryPoint]) -> Vec<EntryPoin

#[derive(Clone, Debug)]
// TODO(Ayelet,10/02/2024): Change to bytes.
pub struct ClassInfo {
contract_class: ContractClass,
sierra_program_length: usize,
abi_length: usize,
pub enum ClassInfo {
V0 {
contract_class: ContractClassV0,
abi_length: usize,
},
V1 {
contract_class: ContractClassV1,
sierra_program_length: usize,
abi_length: usize,
},
NativeV1 {
contract_class: NativeContractClassV1,
sierra_program_length: usize,
abi_length: usize,
},
}

impl TryFrom<starknet_api::contract_class::ClassInfo> for ClassInfo {
type Error = ProgramError;

fn try_from(class_info: starknet_api::contract_class::ClassInfo) -> Result<Self, Self::Error> {
let starknet_api::contract_class::ClassInfo {
contract_class,
sierra_program_length,
abi_length,
} = class_info;

Ok(Self { contract_class: contract_class.try_into()?, sierra_program_length, abi_length })
match class_info {
starknet_api::contract_class::ClassInfo::V0 { contract_class, abi_length } => {
Ok(Self::V0 { contract_class: contract_class.try_into()?, abi_length })
}
starknet_api::contract_class::ClassInfo::V1 {
contract_class,
sierra_program_length,
abi_length,
} => Ok(Self::V1 {
contract_class: contract_class.try_into()?,
sierra_program_length,
abi_length,
}),
}
}
}

impl ClassInfo {
pub fn bytecode_length(&self) -> usize {
self.contract_class.bytecode_length()
match self {
ClassInfo::V0 { contract_class, .. } => contract_class.bytecode_length(),
ClassInfo::V1 { contract_class, .. } => contract_class.bytecode_length(),
ClassInfo::NativeV1 { contract_class: _contract_class, .. } => {
unimplemented!("implement bytecode_length for native contracts.")
}
}
}

pub fn contract_class(&self) -> ContractClass {
self.contract_class.clone()
match self {
ClassInfo::V0 { contract_class, .. } => ContractClass::V0(contract_class.clone()),
ClassInfo::V1 { contract_class, .. } => ContractClass::V1(contract_class.clone()),
ClassInfo::NativeV1 { contract_class, .. } => {
ContractClass::V1Native(contract_class.clone())
}
}
}

pub fn sierra_program_length(&self) -> usize {
self.sierra_program_length
match self {
ClassInfo::V0 { .. } => 0,
ClassInfo::V1 { sierra_program_length, .. } => *sierra_program_length,
ClassInfo::NativeV1 { sierra_program_length, .. } => *sierra_program_length,
}
}

pub fn abi_length(&self) -> usize {
self.abi_length
match self {
ClassInfo::V0 { abi_length, .. } => *abi_length,
ClassInfo::V1 { abi_length, .. } => *abi_length,
ClassInfo::NativeV1 { abi_length, .. } => *abi_length,
}
}

pub fn code_size(&self) -> usize {
Expand All @@ -585,39 +623,6 @@ impl ClassInfo {
* eth_gas_constants::WORD_WIDTH
+ self.abi_length()
}

pub fn new_v1_native(
contract_class: NativeContractClassV1,
sierra_program_length: usize,
abi_length: usize,
) -> Self {
Self {
contract_class: ContractClass::V1Native(contract_class),
sierra_program_length,
abi_length,
}
}

pub fn new_v1(
contract_class: ContractClassV1,
sierra_program_length: usize,
abi_length: usize,
) -> Self {
assert!(sierra_program_length > 0, "Sierra program length must be > 0 for Cairo1");
Self {
contract_class: ContractClass::V1(contract_class),
sierra_program_length,
abi_length,
}
}

pub fn new_v0(contract_class: ContractClassV0, abi_length: usize) -> Self {
Self {
contract_class: ContractClass::V0(contract_class),
sierra_program_length: 0,
abi_length,
}
}
}

// Cairo-native utilities.
Expand Down
7 changes: 3 additions & 4 deletions crates/blockifier/src/transaction/test_utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,14 +376,13 @@ fn create_all_resource_bounds(
pub fn calculate_class_info_for_testing(contract_class: ContractClass) -> ClassInfo {
let abi_length = 100;
match contract_class {
ContractClass::V0(contract_class) => ClassInfo::new_v0(contract_class, abi_length),
ContractClass::V0(contract_class) => ClassInfo::V0 { contract_class, abi_length },
ContractClass::V1(contract_class) => {
let sierra_program_length = 100;
ClassInfo::new_v1(contract_class, sierra_program_length, abi_length)
ClassInfo::V1 { contract_class, sierra_program_length: 100, abi_length }
}
ContractClass::V1Native(contract_class) => {
let sierra_program_length = 100;
ClassInfo::new_v1_native(contract_class, sierra_program_length, abi_length)
ClassInfo::NativeV1 { contract_class, sierra_program_length, abi_length }
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions crates/gateway/src/compilation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use std::sync::Arc;

use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
use cairo_lang_starknet_classes::contract_class::ContractClass as CairoLangContractClass;
use starknet_api::contract_class::{ClassInfo, ContractClass};
use starknet_api::contract_class::ClassInfo;
use starknet_api::rpc_transaction::RpcDeclareTransaction;
use starknet_gateway_types::errors::GatewaySpecError;
use starknet_sierra_compile::cairo_lang_compiler::CairoLangSierraToCasmCompiler;
Expand Down Expand Up @@ -47,8 +47,8 @@ impl GatewayCompiler {

let casm_contract_class = self.compile(cairo_lang_contract_class)?;

Ok(ClassInfo {
contract_class: ContractClass::V1(casm_contract_class),
Ok(ClassInfo::V1 {
contract_class: casm_contract_class,
sierra_program_length: rpc_contract_class.sierra_program.len(),
abi_length: rpc_contract_class.abi.len(),
})
Expand Down
10 changes: 5 additions & 5 deletions crates/native_blockifier/src/py_transaction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,18 +170,18 @@ impl PyClassInfo {
ContractClassV0::try_from_json_string(&py_class_info.raw_contract_class)?;
assert_eq!(py_class_info.sierra_program_length, 0);

ClassInfo::new_v0(contract_class, py_class_info.abi_length)
ClassInfo::V0 { contract_class, abi_length: py_class_info.abi_length }
}
starknet_api::transaction::DeclareTransaction::V2(_)
| starknet_api::transaction::DeclareTransaction::V3(_) => {
let contract_class =
ContractClassV1::try_from_json_string(&py_class_info.raw_contract_class)?;

ClassInfo::new_v1(
ClassInfo::V1 {
contract_class,
py_class_info.sierra_program_length,
py_class_info.abi_length,
)
sierra_program_length: py_class_info.sierra_program_length,
abi_length: py_class_info.abi_length,
}
}
};
Ok(class_info)
Expand Down
16 changes: 8 additions & 8 deletions crates/papyrus_execution/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,15 +736,15 @@ fn to_blockifier_tx(
abi_length,
only_query,
) => {
let class_v0 = deprecated_class.try_into().map_err(
let contract_class = deprecated_class.try_into().map_err(
|e: cairo_vm::types::errors::program_errors::ProgramError| {
ExecutionError::TransactionExecutionError {
transaction_index,
execution_error: e.to_string(),
}
},
)?;
let class_info = ClassInfo::new_v0(class_v0, abi_length);
let class_info = ClassInfo::V0 { contract_class, abi_length };
BlockifierTransaction::from_api(
Transaction::Declare(DeclareTransaction::V0(declare_tx)),
tx_hash,
Expand All @@ -761,8 +761,8 @@ fn to_blockifier_tx(
abi_length,
only_query,
) => {
let class_v0 = deprecated_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::new_v0(class_v0, abi_length);
let contract_class = deprecated_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::V0 { contract_class, abi_length };
BlockifierTransaction::from_api(
Transaction::Declare(DeclareTransaction::V1(declare_tx)),
tx_hash,
Expand All @@ -780,8 +780,8 @@ fn to_blockifier_tx(
abi_length,
only_query,
) => {
let class_v1 = compiled_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::new_v1(class_v1, sierra_program_length, abi_length);
let contract_class = compiled_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::V1 { contract_class, sierra_program_length, abi_length };
BlockifierTransaction::from_api(
Transaction::Declare(DeclareTransaction::V2(declare_tx)),
tx_hash,
Expand All @@ -799,8 +799,8 @@ fn to_blockifier_tx(
abi_length,
only_query,
) => {
let class_v1 = compiled_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::new_v1(class_v1, sierra_program_length, abi_length);
let contract_class = compiled_class.try_into().map_err(BlockifierError::new)?;
let class_info = ClassInfo::V1 { contract_class, sierra_program_length, abi_length };
BlockifierTransaction::from_api(
Transaction::Declare(DeclareTransaction::V3(declare_tx)),
tx_hash,
Expand Down
28 changes: 23 additions & 5 deletions crates/starknet_api/src/contract_class.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,27 @@ impl ContractClass {
/// All relevant information about a declared contract class, including the compiled contract class
/// and other parameters derived from the original declare transaction required for billing.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ClassInfo {
// TODO(Noa): Consider using Arc.
pub contract_class: ContractClass,
pub sierra_program_length: usize,
pub abi_length: usize,
pub enum ClassInfo {
V0 {
// TODO(Noa): Consider using Arc.
contract_class: DeprecatedContractClass,
abi_length: usize,
},
V1 {
// TODO(Noa): Consider using Arc.
contract_class: CasmContractClass,
sierra_program_length: usize,
abi_length: usize,
},
}

impl ClassInfo {
pub fn compiled_class_hash(&self) -> CompiledClassHash {
match self {
ClassInfo::V0 { .. } => panic!("Cairo 0 doesn't have compiled class hash."),
ClassInfo::V1 { contract_class, .. } => {
CompiledClassHash(contract_class.compiled_class_hash())
}
}
}
}
3 changes: 1 addition & 2 deletions crates/starknet_api/src/executable_transaction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,7 @@ impl DeclareTransaction {
| crate::transaction::DeclareTransaction::V0(_) => return true,
};

let contract_class = &self.class_info.contract_class;
let compiled_class_hash = contract_class.compiled_class_hash();
let compiled_class_hash = self.class_info.compiled_class_hash();

compiled_class_hash == supplied_compiled_class_hash
}
Expand Down
Loading