Skip to content

Commit

Permalink
refactor: change chainid from struct to enum (#250)
Browse files Browse the repository at this point in the history
  • Loading branch information
@eitanm-starkware
eitanm-starkware authored May 15, 2024
1 parent 77ff5a3 commit bb1bf2e
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 45 deletions.
53 changes: 49 additions & 4 deletions src/core.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
#[path = "core_test.rs"]
mod core_test;

use core::fmt::Display;
use std::fmt::Debug;

use derive_more::Display;
use once_cell::sync::Lazy;
use primitive_types::H160;
use serde::{Deserialize, Serialize};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use starknet_crypto::FieldElement;

use crate::crypto::utils::PublicKey;
Expand All @@ -17,12 +18,56 @@ use crate::transaction::{Calldata, ContractAddressSalt};
use crate::{impl_from_through_intermediate, StarknetApiError};

/// A chain id.
#[derive(Clone, Debug, Display, Eq, PartialEq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
pub struct ChainId(pub String);
#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)]
pub enum ChainId {
Mainnet,
Sepolia,
IntegrationSepolia,
Other(String),
}

impl Serialize for ChainId {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_str(&self.to_string())
}
}

impl<'de> Deserialize<'de> for ChainId {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let s = String::deserialize(deserializer)?;
Ok(ChainId::from(s))
}
}
impl From<String> for ChainId {
fn from(s: String) -> Self {
match s.as_ref() {
"SN_MAIN" => ChainId::Mainnet,
"SN_SEPOLIA" => ChainId::Sepolia,
"SN_INTEGRATION_SEPOLIA" => ChainId::IntegrationSepolia,
other => ChainId::Other(other.to_owned()),
}
}
}
impl Display for ChainId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
ChainId::Mainnet => write!(f, "SN_MAIN"),
ChainId::Sepolia => write!(f, "SN_SEPOLIA"),
ChainId::IntegrationSepolia => write!(f, "SN_INTEGRATION_SEPOLIA"),
ChainId::Other(ref s) => write!(f, "{}", s),
}
}
}

impl ChainId {
pub fn as_hex(&self) -> String {
format!("0x{}", hex::encode(&self.0))
format!("0x{}", hex::encode(self.to_string()))
}
}

Expand Down
74 changes: 33 additions & 41 deletions src/transaction_hash.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,40 +104,32 @@ fn get_deprecated_transaction_hashes(
transaction: &Transaction,
transaction_version: &TransactionVersion,
) -> Result<Vec<TransactionHash>, StarknetApiError> {
Ok(
if chain_id == &ChainId("SN_MAIN".to_string())
&& block_number > &MAINNET_TRANSACTION_HASH_WITH_VERSION
{
vec![]
} else {
match transaction {
Transaction::Declare(_) => vec![],
Transaction::Deploy(deploy) => {
vec![get_deprecated_deploy_transaction_hash(
deploy,
Ok(if chain_id == &ChainId::Mainnet && block_number > &MAINNET_TRANSACTION_HASH_WITH_VERSION {
vec![]
} else {
match transaction {
Transaction::Declare(_) => vec![],
Transaction::Deploy(deploy) => {
vec![get_deprecated_deploy_transaction_hash(deploy, chain_id, transaction_version)?]
}
Transaction::DeployAccount(_) => vec![],
Transaction::Invoke(invoke) => match invoke {
InvokeTransaction::V0(invoke_v0) => {
vec![get_deprecated_invoke_transaction_v0_hash(
invoke_v0,
chain_id,
transaction_version,
)?]
}
Transaction::DeployAccount(_) => vec![],
Transaction::Invoke(invoke) => match invoke {
InvokeTransaction::V0(invoke_v0) => {
vec![get_deprecated_invoke_transaction_v0_hash(
invoke_v0,
chain_id,
transaction_version,
)?]
}
InvokeTransaction::V1(_) | InvokeTransaction::V3(_) => vec![],
},
Transaction::L1Handler(l1_handler) => get_deprecated_l1_handler_transaction_hashes(
l1_handler,
chain_id,
transaction_version,
)?,
}
},
)
InvokeTransaction::V1(_) | InvokeTransaction::V3(_) => vec![],
},
Transaction::L1Handler(l1_handler) => get_deprecated_l1_handler_transaction_hashes(
l1_handler,
chain_id,
transaction_version,
)?,
}
})
}

/// Validates the hash of a starknet transaction.
Expand Down Expand Up @@ -274,7 +266,7 @@ fn get_common_deploy_transaction_hash(
None
}
})
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.get_pedersen_hash(),
))
}
Expand Down Expand Up @@ -309,7 +301,7 @@ fn get_common_invoke_transaction_v0_hash(
.chain(&transaction.entry_point_selector.0)
.chain(&HashChain::new().chain_iter(transaction.calldata.0.iter()).get_pedersen_hash())
.chain_if_fn(|| if !is_deprecated { Some(transaction.max_fee.0.into()) } else { None })
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.get_pedersen_hash(),
))
}
Expand All @@ -327,7 +319,7 @@ pub(crate) fn get_invoke_transaction_v1_hash(
.chain(&StarkFelt::ZERO) // No entry point selector in invoke transaction.
.chain(&HashChain::new().chain_iter(transaction.calldata.0.iter()).get_pedersen_hash())
.chain(&transaction.max_fee.0.into())
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.get_pedersen_hash(),
))
Expand Down Expand Up @@ -359,7 +351,7 @@ pub(crate) fn get_invoke_transaction_v3_hash(
.chain(transaction.sender_address.0.key())
.chain(&tip_resource_bounds_hash)
.chain(&paymaster_data_hash)
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.chain(&data_availability_mode)
.chain(&account_deployment_data_hash)
Expand Down Expand Up @@ -442,7 +434,7 @@ fn get_common_l1_handler_transaction_hash(
None
}
})
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain_if_fn(|| {
if version > L1HandlerVersions::AsInvoke {
Some(transaction.nonce.0)
Expand All @@ -467,7 +459,7 @@ pub(crate) fn get_declare_transaction_v0_hash(
.chain(&StarkFelt::ZERO) // No entry point selector in declare transaction.
.chain(&HashChain::new().get_pedersen_hash())
.chain(&transaction.max_fee.0.into())
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.class_hash.0)
.get_pedersen_hash(),
))
Expand All @@ -486,7 +478,7 @@ pub(crate) fn get_declare_transaction_v1_hash(
.chain(&StarkFelt::ZERO) // No entry point selector in declare transaction.
.chain(&HashChain::new().chain(&transaction.class_hash.0).get_pedersen_hash())
.chain(&transaction.max_fee.0.into())
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.get_pedersen_hash(),
))
Expand All @@ -505,7 +497,7 @@ pub(crate) fn get_declare_transaction_v2_hash(
.chain(&StarkFelt::ZERO) // No entry point selector in declare transaction.
.chain(&HashChain::new().chain(&transaction.class_hash.0).get_pedersen_hash())
.chain(&transaction.max_fee.0.into())
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.chain(&transaction.compiled_class_hash.0)
.get_pedersen_hash(),
Expand Down Expand Up @@ -536,7 +528,7 @@ pub(crate) fn get_declare_transaction_v3_hash(
.chain(transaction.sender_address.0.key())
.chain(&tip_resource_bounds_hash)
.chain(&paymaster_data_hash)
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.chain(&data_availability_mode)
.chain(&account_deployment_data_hash)
Expand Down Expand Up @@ -572,7 +564,7 @@ pub(crate) fn get_deploy_account_transaction_v1_hash(
.chain(&StarkFelt::ZERO) // No entry point selector in deploy account transaction.
.chain(&calldata_hash)
.chain(&transaction.max_fee.0.into())
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&transaction.nonce.0)
.get_pedersen_hash(),
))
Expand Down Expand Up @@ -607,7 +599,7 @@ pub(crate) fn get_deploy_account_transaction_v3_hash(
.chain(contract_address.0.key())
.chain(&tip_resource_bounds_hash)
.chain(&paymaster_data_hash)
.chain(&ascii_as_felt(chain_id.0.as_str())?)
.chain(&ascii_as_felt(chain_id.to_string().as_str())?)
.chain(&data_availability_mode)
.chain(&transaction.nonce.0)
.chain(&constructor_calldata_hash)
Expand Down

0 comments on commit bb1bf2e

Please sign in to comment.