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(blockifier_reexecution): allow overriding chain ID explicitly #1974

Merged
merged 1 commit into from
Nov 20, 2024
Merged

refactor(blockifier_reexecution): allow overriding chain ID explicitly #1974

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
78 changes: 58 additions & 20 deletions crates/blockifier_reexecution/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use blockifier_reexecution::state_reader::utils::{
};
use clap::{Args, Parser, Subcommand};
use starknet_api::block::BlockNumber;
use starknet_api::core::ChainId;
use starknet_gateway::config::RpcStateReaderConfig;

/// BlockifierReexecution CLI.
Expand All @@ -24,13 +25,49 @@ pub struct BlockifierReexecutionCliArgs {
command: Command,
}

#[derive(clap::ValueEnum, Clone, Debug)]
enum SupportedChainId {
Mainnet,
Testnet,
Integration,
}

impl From<SupportedChainId> for ChainId {
fn from(chain_id: SupportedChainId) -> Self {
match chain_id {
SupportedChainId::Mainnet => Self::Mainnet,
SupportedChainId::Testnet => Self::Sepolia,
SupportedChainId::Integration => Self::IntegrationSepolia,
}
}
}

#[derive(Clone, Debug, Args)]
struct RpcArgs {
/// Node url.
#[clap(long, short = 'n')]
node_url: String,

/// Optional chain ID (if not provided, it will be guessed from the node url).
#[clap(long, short = 'c')]
chain_id: Option<SupportedChainId>,
}

impl RpcArgs {
fn parse_chain_id(&self) -> ChainId {
self.chain_id
.clone()
.map(ChainId::from)
.unwrap_or(guess_chain_id_from_node_url(self.node_url.as_str()).unwrap())
}
}

#[derive(Debug, Subcommand)]
enum Command {
/// Runs the RPC test.
RpcTest {
/// Node url.
#[clap(long, short = 'n')]
node_url: String,
#[clap(flatten)]
rpc_args: RpcArgs,

/// Block number.
#[clap(long, short = 'b')]
Expand All @@ -39,9 +76,8 @@ enum Command {

/// Writes the RPC queries to json files.
WriteRpcRepliesToJson {
/// Node url.
#[clap(long, short = 'n')]
node_url: String,
#[clap(flatten)]
rpc_args: RpcArgs,

/// Block number.
#[clap(long, short = 'b')]
Expand All @@ -56,9 +92,8 @@ enum Command {

/// Writes the RPC queries of all (selected) blocks to json files.
WriteAll {
/// Node url.
#[clap(long, short = 'n')]
node_url: String,
#[clap(flatten)]
rpc_args: RpcArgs,

/// Block numbers. If not specified, blocks are retrieved from
/// get_block_numbers_for_reexecution().
Expand Down Expand Up @@ -116,11 +151,14 @@ async fn main() {
let args = BlockifierReexecutionCliArgs::parse();

match args.command {
Command::RpcTest { node_url, block_number } => {
println!("Running RPC test for block number {block_number} using node url {node_url}.",);
Command::RpcTest { block_number, rpc_args } => {
println!(
"Running RPC test for block number {block_number} using node url {}.",
rpc_args.node_url
);

let config = RpcStateReaderConfig {
url: node_url.clone(),
url: rpc_args.node_url.clone(),
json_rpc_version: JSON_RPC_VERSION.to_string(),
};

Expand All @@ -131,7 +169,7 @@ async fn main() {
reexecute_and_verify_correctness(ConsecutiveTestStateReaders::new(
BlockNumber(block_number - 1),
Some(config),
guess_chain_id_from_node_url(node_url.as_str()).unwrap(),
rpc_args.parse_chain_id(),
false,
))
})
Expand All @@ -143,7 +181,7 @@ async fn main() {
println!("RPC test passed successfully.");
}

Command::WriteRpcRepliesToJson { node_url, block_number, full_file_path } => {
Command::WriteRpcRepliesToJson { block_number, full_file_path, rpc_args } => {
let full_file_path = full_file_path.unwrap_or(format!(
"./crates/blockifier_reexecution/resources/block_{block_number}/reexecution_data.\
json"
Expand All @@ -156,15 +194,15 @@ async fn main() {
write_block_reexecution_data_to_file(
BlockNumber(block_number),
full_file_path,
node_url.clone(),
guess_chain_id_from_node_url(node_url.as_str()).unwrap(),
rpc_args.node_url.clone(),
rpc_args.parse_chain_id(),
);
})
.await
.unwrap();
}

Command::WriteAll { node_url, block_numbers, directory_path } => {
Command::WriteAll { block_numbers, directory_path, rpc_args } => {
let directory_path =
directory_path.unwrap_or("./crates/blockifier_reexecution/resources".to_string());

Expand All @@ -174,9 +212,9 @@ async fn main() {
// TODO(Aner): Execute in parallel. Requires making the function async, and only the RPC
// calls blocking.
for block_number in block_numbers {
let node_url = node_url.clone();
let full_file_path =
format!("{directory_path}/block_{block_number}/reexecution_data.json");
let (node_url, chain_id) = (rpc_args.node_url.clone(), rpc_args.parse_chain_id());
// RPC calls are "synchronous IO" (see, e.g., https://stackoverflow.com/questions/74547541/when-should-you-use-tokios-spawn-blocking
// for details), so should be executed in a blocking thread.
// TODO(Aner): make only the RPC calls blocking, not the whole function.
Expand All @@ -185,8 +223,8 @@ async fn main() {
write_block_reexecution_data_to_file(
block_number,
full_file_path,
node_url.clone(),
guess_chain_id_from_node_url(node_url.as_str()).unwrap(),
node_url,
chain_id,
)
})
.await
Expand Down
27 changes: 11 additions & 16 deletions crates/blockifier_reexecution/src/state_reader/rpc_https_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,13 @@ const EXAMPLE_L1_HANDLER_TX_HASH: &str =
/// Retrieves the test URL from the `TEST_URL` environment variable,
/// falling back to a default URL if not provided.
fn get_test_url() -> String {
RPC_NODE_URL.clone()
let url = RPC_NODE_URL.clone();
assert_eq!(
guess_chain_id_from_node_url(&url).unwrap(),
ChainId::Mainnet,
"RPC HTTP tests not supported on chains other than mainnet."
);
url
}

/// Retrieves the test block_number from the `TEST_URL` environment variable,
Expand All @@ -88,24 +94,14 @@ pub fn get_test_rpc_config() -> RpcStateReaderConfig {
}

#[fixture]
pub fn test_url() -> String {
get_test_url()
}

#[fixture]
pub fn test_chain_id(test_url: String) -> ChainId {
guess_chain_id_from_node_url(test_url.as_str()).unwrap()
}

#[fixture]
pub fn test_state_reader(test_chain_id: ChainId) -> TestStateReader {
pub fn test_state_reader() -> TestStateReader {
TestStateReader {
rpc_state_reader: RpcStateReader {
config: get_test_rpc_config(),
block_id: get_test_block_id(),
},
retry_config: RetryConfig::default(),
chain_id: test_chain_id,
chain_id: ChainId::Mainnet,
contract_class_mapping_dumper: Arc::new(Mutex::new(None)),
}
}
Expand All @@ -123,9 +119,8 @@ pub fn last_constructed_block(test_block_number: BlockNumber) -> BlockNumber {
#[fixture]
pub fn test_state_readers_last_and_current_block(
last_constructed_block: BlockNumber,
test_chain_id: ChainId,
) -> ConsecutiveTestStateReaders {
ConsecutiveTestStateReaders::new(last_constructed_block, None, test_chain_id, false)
ConsecutiveTestStateReaders::new(last_constructed_block, None, ChainId::Mainnet, false)
}

/// Test that the block info can be retrieved from the RPC server.
Expand Down Expand Up @@ -244,7 +239,7 @@ pub fn test_get_statediff_rpc(test_state_reader: TestStateReader) {
}

#[rstest]
#[case(test_block_number(test_state_reader(test_chain_id(test_url()))).0)]
#[case(test_block_number(test_state_reader()).0)]
#[case(EXAMPLE_DECLARE_V1_BLOCK_NUMBER)]
#[case(EXAMPLE_DECLARE_V2_BLOCK_NUMBER)]
#[case(EXAMPLE_DECLARE_V3_BLOCK_NUMBER)]
Expand Down
Loading