Merge branch 'main' of github.com:chainwayxyz/citrea-e2e into cleanup-config

Author: jfldde

Cargo.toml

@@ -5,6 +5,7 @@ edition = "2021"
 resolver = "2"
 
 [dependencies]
+alloy-primitives = { version = "0.8.12", default-features = false, features = ["serde"] }
 anyhow = { version = "1.0.68", default-features = false, features = ["std"] }
 async-trait = "0.1.71"
 bitcoin = { version = "0.32.2", features = ["serde", "rand"] }

rust-toolchain.toml

@@ -1,4 +1,4 @@
 [toolchain]
-channel = "1.79"
+channel = "1.81"
 components = ["rustfmt", "rust-src", "clippy"]
 profile = "minimal"

src/bitcoin.rs

@@ -1,5 +1,5 @@
 use std::{
-    collections::HashSet,
+    collections::{HashMap, HashSet},
     fs::File,
     future::Future,
     process::Stdio,
@@ -165,6 +165,16 @@ impl BitcoinNode {
     ) -> bitcoincore_rpc::Result<Vec<bitcoin::BlockHash>> {
         RpcApi::generate(self, block_num, None).await
     }
+
+    pub async fn generate_block(
+        &self,
+        // Address to send the block reward to
+        output: String,
+        // Either raw txs or txids, should be in mempool and in correct order
+        transactions: Vec<String>,
+    ) -> bitcoincore_rpc::Result<HashMap<String, String>> {
+        RpcApi::call(self, "generateblock", &[output.into(), transactions.into()]).await
+    }
 }
 
 #[async_trait]
@@ -273,7 +283,11 @@ impl Restart for BitcoinNode {
         }
     }
 
-    async fn start(&mut self, config: Option<Self::Config>) -> Result<()> {
+    async fn start(
+        &mut self,
+        config: Option<Self::Config>,
+        _extra_args: Option<Vec<String>>,
+    ) -> Result<()> {
         if let Some(config) = config {
             self.config = config;
         }

src/citrea_config/rollup.rs

@@ -163,17 +163,17 @@ impl Default for RollupConfig {
                     32, 64, 64, 227, 100, 193, 15, 43, 236, 156, 31, 229, 0, 161, 205, 76, 36, 124,
                     137, 214, 80, 160, 30, 215, 232, 44, 171, 168, 103, 135, 124, 33,
                 ],
-                // private key [4, 95, 252, 129, 163, 193, 253, 179, 175, 19, 89, 219, 242, 209, 20, 176, 179, 239, 191, 127, 41, 204, 156, 93, 160, 18, 103, 170, 57, 210, 199, 141]
-                // Private Key (WIF): KwNDSCvKqZqFWLWN1cUzvMiJQ7ck6ZKqR6XBqVKyftPZtvmbE6YD
+                // private key E9873D79C6D87DC0FB6A5778633389F4453213303DA61F20BD67FC233AA33262
+                // Private Key (WIF): 5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF
                 sequencer_da_pub_key: vec![
-                    3, 136, 195, 18, 11, 187, 25, 37, 38, 109, 184, 237, 247, 208, 131, 219, 162,
-                    70, 35, 174, 234, 47, 239, 247, 60, 51, 174, 242, 247, 112, 186, 222, 30,
+                    2, 88, 141, 32, 42, 252, 193, 238, 74, 181, 37, 76, 120, 71, 236, 37, 185, 161,
+                    53, 187, 218, 15, 43, 198, 158, 225, 167, 20, 116, 159, 215, 125, 201,
                 ],
-                // private key [117, 186, 249, 100, 208, 116, 89, 70, 0, 54, 110, 91, 17, 26, 29, 168, 248, 107, 46, 254, 45, 34, 218, 81, 200, 216, 33, 38, 160, 252, 172, 114]
-                // Private Key (WIF): L1AZdJXzDGGENBBPZGSL7dKJnwn5xSKqzszgK6CDwiBGThYQEVTo
+                // private key 56D08C2DDE7F412F80EC99A0A328F76688C904BD4D1435281EFC9270EC8C8707
+                // Private Key (WIF): 5JUX9MqyVroDAjP2itrbaenEKNTioGVnnDSYn3PmLgb23TCLWMs
                 prover_da_pub_key: vec![
-                    2, 138, 232, 157, 214, 46, 7, 210, 235, 33, 105, 239, 71, 169, 105, 233, 239,
-                    84, 172, 112, 13, 54, 9, 206, 106, 138, 251, 218, 15, 28, 137, 112, 127,
+                    3, 238, 218, 184, 136, 228, 95, 59, 220, 62, 201, 145, 140, 73, 28, 17, 229,
+                    207, 122, 240, 169, 31, 56, 185, 127, 188, 30, 19, 90, 228, 5, 102, 1,
                 ],
             },
             telemetry: Default::default(),

src/client.rs

@@ -1,5 +1,6 @@
 use std::time::{Duration, SystemTime};
 
+use alloy_primitives::U64;
 use anyhow::{bail, Result};
 use jsonrpsee::{
     core::client::ClientT,
@@ -44,14 +45,16 @@ impl Client {
         Ok(self
             .client
             .request("ledger_getLastScannedL1Height", rpc_params![])
-            .await?)
+            .await
+            .map(|v: U64| v.try_into().expect("U64 to u64 must succeed"))?)
     }
 
     pub async fn ledger_get_head_soft_confirmation_height(&self) -> Result<u64> {
         Ok(self
             .client
             .request("ledger_getHeadSoftConfirmationHeight", rpc_params![])
-            .await?)
+            .await
+            .map(|v: U64| v.try_into().expect("U64 to u64 must succeed"))?)
     }
 
     pub async fn wait_for_l2_block(&self, num: u64, timeout: Option<Duration>) -> Result<()> {

src/config/mod.rs

@@ -42,12 +42,30 @@ impl fmt::Display for DaLayer {
     }
 }
 
+#[derive(Clone, Debug, Default, Copy)]
+pub enum CitreaMode {
+    #[default]
+    Dev,
+    DevAllForks,
+}
+
+impl fmt::Display for CitreaMode {
+    // This trait requires `fmt` with this exact signature.
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            CitreaMode::Dev => write!(f, "dev"),
+            CitreaMode::DevAllForks => write!(f, "dev-all-forks"),
+        }
+    }
+}
+
 #[derive(Clone, Debug)]
 pub struct BaseNodeConfig {
     pub dir: PathBuf,
     pub env: Vec<(&'static str, &'static str)>,
     pub da_layer: DaLayer,
     pub docker_image: Option<String>,
+    pub mode: CitreaMode,
 }
 
 #[derive(Clone, Debug)]
@@ -72,12 +90,14 @@ where
         docker_image: Option<String>,
         dir: PathBuf,
         env: Vec<(&'static str, &'static str)>,
+        mode: CitreaMode,
     ) -> Result<Self> {
         let base = BaseNodeConfig {
             dir: dir.clone(),
             env,
             da_layer: DaLayer::Bitcoin,
             docker_image,
+            mode,
         };
 
         let conf = Self {
@@ -179,6 +199,10 @@ where
     pub fn da_layer(&self) -> &DaLayer {
         &self.base.da_layer
     }
+
+    pub fn mode(&self) -> &CitreaMode {
+        &self.base.mode
+    }
 }
 
 impl<T> LogPathProvider for FullL2NodeConfig<T>

src/config/test_case.rs

@@ -2,6 +2,7 @@ use std::{env, path::PathBuf, time::Duration};
 
 use tempfile::TempDir;
 
+use super::CitreaMode;
 use crate::utils::generate_test_id;
 
 #[derive(Clone, Default)]
@@ -60,6 +61,7 @@ pub struct TestCaseConfig {
     // Defaults to resources/genesis/bitcoin-regtest
     pub genesis_dir: Option<String>,
     pub test_id: String,
+    pub mode: CitreaMode,
 }
 
 impl Default for TestCaseConfig {
@@ -85,6 +87,7 @@ impl Default for TestCaseConfig {
             docker: TestCaseDockerConfig::default(),
             genesis_dir: None,
             test_id,
+            mode: CitreaMode::Dev,
         }
     }
 }

src/framework.rs

@@ -321,7 +321,7 @@ fn generate_test_config<T: TestCase>(
         RollupConfig {
             da: BitcoinServiceConfig {
                 da_private_key: Some(
-                    "045FFC81A3C1FDB3AF1359DBF2D114B0B3EFBF7F29CC9C5DA01267AA39D2C78D".to_string(),
+                    "E9873D79C6D87DC0FB6A5778633389F4453213303DA61F20BD67FC233AA33262".to_string(),
                 ),
                 node_url: format!("http://{}/wallet/{}", da_config.node_url, node_kind),
                 tx_backup_dir: tx_backup_dir.display().to_string(),
@@ -356,7 +356,7 @@ fn generate_test_config<T: TestCase>(
         RollupConfig {
             da: BitcoinServiceConfig {
                 da_private_key: Some(
-                    "75BAF964D074594600366E5B111A1DA8F86B2EFE2D22DA51C8D82126A0FCAC72".to_string(),
+                    "56D08C2DDE7F412F80EC99A0A328F76688C904BD4D1435281EFC9270EC8C8707".to_string(),
                 ),
                 node_url: format!("http://{}/wallet/{}", da_config.node_url, node_kind),
                 tx_backup_dir: tx_backup_dir.display().to_string(),
@@ -437,6 +437,7 @@ fn generate_test_config<T: TestCase>(
             citrea_docker_image.clone(),
             sequencer_dir,
             env.sequencer(),
+            test_case.mode,
         )?,
         batch_prover: FullBatchProverConfig::new(
             NodeKind::BatchProver,
@@ -445,6 +446,7 @@ fn generate_test_config<T: TestCase>(
             citrea_docker_image.clone(),
             batch_prover_dir,
             env.batch_prover(),
+            test_case.mode,
         )?,
         light_client_prover: FullLightClientProverConfig::new(
             NodeKind::LightClientProver,
@@ -453,6 +455,7 @@ fn generate_test_config<T: TestCase>(
             citrea_docker_image.clone(),
             light_client_prover_dir,
             env.light_client_prover(),
+            test_case.mode,
         )?,
         full_node: FullFullNodeConfig::new(
             NodeKind::FullNode,
@@ -461,6 +464,7 @@ fn generate_test_config<T: TestCase>(
             citrea_docker_image,
             full_node_dir,
             env.full_node(),
+            test_case.mode,
         )?,
         test_case,
     })

src/node.rs

@@ -9,7 +9,7 @@ use std::{
     time::{Duration, SystemTime},
 };
 
-use anyhow::{bail, Context};
+use anyhow::{anyhow, bail, Context};
 use async_trait::async_trait;
 use bitcoincore_rpc::{Auth, Client as BitcoinClient};
 use serde::Serialize;
@@ -22,8 +22,8 @@ use tracing::{debug, info, trace};
 use crate::{
     client::Client,
     config::{
-        BatchProverConfig, BitcoinConfig, DockerConfig, EmptyConfig, FullL2NodeConfig,
-        LightClientProverConfig, SequencerConfig,
+        BatchProverConfig, BitcoinConfig, DockerConfig, EmptyConfig,
+        FullL2NodeConfig, LightClientProverConfig, SequencerConfig,
     },
     docker::DockerEnv,
     log_provider::LogPathProvider,
@@ -114,7 +114,7 @@ where
         })
     }
 
-    fn spawn(config: &FullL2NodeConfig<C>) -> Result<SpawnOutput> {
+    fn spawn(config: &FullL2NodeConfig<C>, extra_args: Option<Vec<String>>) -> Result<SpawnOutput> {
         let citrea = get_citrea_path()?;
 
         let kind = config.kind();
@@ -134,6 +134,7 @@ where
 
         Command::new(citrea)
             .args(get_citrea_args(config))
+            .args(extra_args.unwrap_or_default())
             .envs(config.env())
             .stdout(Stdio::from(stdout_file))
             .stderr(Stdio::from(stderr_file))
@@ -200,8 +201,8 @@ where
 
     async fn spawn(config: &Self::Config, docker: &Arc<Option<DockerEnv>>) -> Result<SpawnOutput> {
         match docker.as_ref() {
-            Some(docker) if docker.citrea() => docker.spawn(config.clone().into()).await,
-            _ => Self::spawn(config),
+            Some(docker) if docker.citrea() => docker.spawn(config.to_owned().into()).await,
+            _ => Self::spawn(config, None),
         }
     }
 
@@ -212,18 +213,20 @@ where
     async fn wait_for_ready(&self, timeout: Option<Duration>) -> Result<()> {
         let start = Instant::now();
         let timeout = timeout.unwrap_or(Duration::from_secs(30));
-        while start.elapsed() < timeout {
-            if self
-                .client
-                .ledger_get_head_soft_confirmation_height()
-                .await
-                .is_ok()
-            {
-                return Ok(());
-            }
+        let mut response = Err(anyhow!("initial response value"));
+
+        while response.is_err() && (start.elapsed() < timeout) {
+            response = self.client.ledger_get_head_soft_confirmation_height().await;
             sleep(Duration::from_millis(500)).await;
         }
-        anyhow::bail!("TODO failed to become ready within the specified timeout",)
+        match response {
+            Ok(_) => return Ok(()),
+            Err(e) => anyhow::bail!(
+                "{} failed to become ready within the specified timeout, latest ledger_get_head_soft_confirmation_height error: {}",
+                self.config.kind(),
+                e
+            )
+        }
     }
 
     fn client(&self) -> &Self::Client {
@@ -258,7 +261,11 @@ where
         Ok(())
     }
 
-    async fn start(&mut self, new_config: Option<Self::Config>) -> Result<()> {
+    async fn start(
+        &mut self,
+        new_config: Option<Self::Config>,
+        extra_args: Option<Vec<String>>,
+    ) -> Result<()> {
         let config = self.config_mut();
 
         if let Some(new_config) = new_config {
@@ -279,7 +286,7 @@ where
         copy_directory(old_dir, &new_dir)?;
         config.set_dir(new_dir);
 
-        *self.spawn_output() = Self::spawn(config)?;
+        *self.spawn_output() = Self::spawn(config, extra_args)?;
         self.wait_for_ready(None).await
     }
 }
@@ -292,7 +299,7 @@ where
     let rollup_config_args = config.get_rollup_config_args();
 
     [
-        vec!["--dev".to_string()],
+        vec![format!("--{}", config.mode())],
         vec!["--da-layer".to_string(), config.da_layer().to_string()],
         node_config_args,
         rollup_config_args,

src/traits.rs

@@ -68,11 +68,19 @@ pub trait NodeT: Send {
 #[async_trait]
 pub trait Restart: NodeT + Send {
     async fn wait_until_stopped(&mut self) -> Result<()>;
-    async fn start(&mut self, new_config: Option<Self::Config>) -> Result<()>;
+    async fn start(
+        &mut self,
+        new_config: Option<Self::Config>,
+        extra_args: Option<Vec<String>>,
+    ) -> Result<()>;
 
     // Default implementation to support waiting for node to be fully shutdown and brough back up with new config.
-    async fn restart(&mut self, new_config: Option<Self::Config>) -> Result<()> {
+    async fn restart(
+        &mut self,
+        new_config: Option<Self::Config>,
+        extra_args: Option<Vec<String>>,
+    ) -> Result<()> {
         self.wait_until_stopped().await?;
-        self.start(new_config).await
+        self.start(new_config, extra_args).await
     }
 }