-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
738 additions
and
636 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| //! CLI arguments for the Hilo Node. | ||
|
|
||
| use std::{fs::File, path::PathBuf, sync::Arc}; | ||
|
|
||
| use clap::Parser; | ||
| use eyre::{bail, Context, Result}; | ||
| use serde_json::from_reader; | ||
| use tracing::debug; | ||
| use url::Url; | ||
|
|
||
| use op_alloy_genesis::RollupConfig; | ||
| use op_alloy_registry::ROLLUP_CONFIGS; | ||
|
|
||
| use hilo_engine::ValidationMode; | ||
|
|
||
| /// The default L2 chain ID to use. This corresponds to OP Mainnet. | ||
| pub const DEFAULT_L2_CHAIN_ID: u64 = 10; | ||
|
|
||
| /// The default L1 RPC URL to use. | ||
| pub const DEFAULT_L1_RPC_URL: &str = "https://cloudflare-eth.com"; | ||
|
|
||
| /// The default L2 RPC URL to use. | ||
| pub const DEFAULT_L2_RPC_URL: &str = "https://optimism.llamarpc.com/"; | ||
|
|
||
| /// The default L1 Beacon Client RPC URL to use. | ||
| pub const DEFAULT_L1_BEACON_CLIENT_URL: &str = "http://localhost:5052/"; | ||
|
|
||
| /// CLI Arguments. | ||
| #[derive(Parser, Clone, Debug)] | ||
| #[command(author, version, about, long_about = None)] | ||
| pub(crate) struct NodeArgs { | ||
| /// A port to serve prometheus metrics on. | ||
| #[clap( | ||
| long, | ||
| short = 'm', | ||
| default_value = "9090", | ||
| help = "The port to serve prometheus metrics on" | ||
| )] | ||
| pub metrics_port: u16, | ||
|
|
||
| /// Chain ID of the L2 network | ||
| #[clap(long = "l2-chain-id", default_value_t = DEFAULT_L2_CHAIN_ID)] | ||
| pub l2_chain_id: u64, | ||
|
|
||
| /// Path to a custom L2 rollup configuration file | ||
| /// (overrides the default rollup configuration from the registry) | ||
| #[clap(long = "hera.l2-config-file")] | ||
| pub l2_config_file: Option<PathBuf>, | ||
|
|
||
| /// RPC URL of an L2 execution client | ||
| #[clap(long = "hera.l2-rpc-url", default_value = DEFAULT_L2_RPC_URL)] | ||
| pub l2_rpc_url: Url, | ||
|
|
||
| /// RPC URL of an L1 execution client | ||
| /// (This is only needed when running in Standalone mode) | ||
| #[clap(long = "hera.l1-rpc-url", default_value = DEFAULT_L1_RPC_URL)] | ||
| pub l1_rpc_url: Url, | ||
|
|
||
| /// URL of an L1 beacon client to fetch blobs | ||
| #[clap(long = "hera.l1-beacon-client-url", default_value = DEFAULT_L1_BEACON_CLIENT_URL)] | ||
| pub l1_beacon_client_url: Url, | ||
|
|
||
| /// URL of the blob archiver to fetch blobs that are expired on | ||
| /// the beacon client but still needed for processing. | ||
| /// | ||
| /// Blob archivers need to implement the `blob_sidecars` API: | ||
| /// <https://ethereum.github.io/beacon-APIs/#/Beacon/getBlobSidecars> | ||
| #[clap(long = "hera.l1-blob-archiver-url")] | ||
| pub l1_blob_archiver_url: Option<Url>, | ||
|
|
||
| /// The payload validation mode to use. | ||
| /// | ||
| /// - Trusted: rely on a trusted synced L2 execution client. Validation happens by fetching the | ||
| /// same block and comparing the results. | ||
| /// - Engine API: use a local or remote engine API of an L2 execution client. Validation | ||
| /// happens by sending the `new_payload` to the API and expecting a VALID response. | ||
| #[clap(long = "hera.validation-mode", default_value = "engine-api")] | ||
| pub validation_mode: ValidationMode, | ||
|
|
||
| /// URL of the engine API endpoint of an L2 execution client. | ||
| #[clap(long = "hera.l2-engine-api-url", env = "L2_ENGINE_API_URL")] | ||
| pub l2_engine_api_url: Url, | ||
|
|
||
| /// JWT secret for the auth-rpc endpoint of the execution client. | ||
| /// This MUST be a valid path to a file containing the hex-encoded JWT secret. | ||
| #[clap(long = "hera.l2-engine-jwt-secret", env = "L2_ENGINE_JWT_SECRET")] | ||
| pub l2_engine_jwt_secret: PathBuf, | ||
|
|
||
| /// The maximum **number of blocks** to keep cached in the chain provider. | ||
| /// | ||
| /// This is used to limit the memory usage of the chain provider. | ||
| /// When the limit is reached, the oldest blocks are discarded. | ||
| #[clap(long = "hera.l1-chain-cache-size", default_value_t = 256)] | ||
| pub l1_chain_cache_size: usize, | ||
| } | ||
|
|
||
| impl NodeArgs { | ||
| /// Get the L2 rollup config, either from a file or the superchain registry. | ||
| #[allow(unused)] | ||
| pub fn get_l2_config(&self) -> Result<Arc<RollupConfig>> { | ||
| match &self.l2_config_file { | ||
| Some(path) => { | ||
| debug!("Loading l2 config from file: {:?}", path); | ||
| let file = File::open(path).wrap_err("Failed to open l2 config file")?; | ||
| Ok(Arc::new(from_reader(file).wrap_err("Failed to read l2 config file")?)) | ||
| } | ||
| None => { | ||
| debug!("Loading l2 config from superchain registry"); | ||
| let Some(cfg) = ROLLUP_CONFIGS.get(&self.l2_chain_id).cloned() else { | ||
| bail!("Failed to find l2 config for chain ID {}", self.l2_chain_id); | ||
| }; | ||
| Ok(Arc::new(cfg)) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.