Yaziciahmet/light client type (#13)

* Rename Prover namespace to BatchProver

* Add light client type

* Separate batch and light client prover configs

* Add citrea light client proving config

* lint

* Remove unused dep

* Minor cleanup

* Fix comment

* Lint

Author: yaziciahmet

Cargo.toml

@@ -11,6 +11,8 @@ bitcoin = { version = "0.32.2", features = ["serde", "rand"] }
 bitcoincore-rpc = { version = "0.18.0" }
 bollard = { version = "0.17.1" }
 futures = "0.3"
+hex = { version = "0.4.3", default-features = false, features = ["serde"] }
+jsonrpsee = { version = "0.24.2", features = ["http-client", "ws-client"] }
 log = "0.4"
 rand = "0.8"
 serde = { version = "1.0.192", default-features = false, features = ["alloc", "derive"] }
@@ -19,13 +21,10 @@ tempfile = "3.8"
 tokio = { version = "1.39", features = ["full"] }
 toml = "0.8.0"
 which = "6.0.1"
-jsonrpsee = { version = "0.24.2", features = ["http-client", "ws-client"] }
-hex = { version = "0.4.3", default-features = false, features = ["serde"] }
 
 # Citrea dependencies
 sov-ledger-rpc = { git = "https://github.com/chainwayxyz/citrea", rev = "82bf52d", default-features = false, features = ["client"] }
 sov-rollup-interface = { git = "https://github.com/chainwayxyz/citrea", rev = "82bf52d" }
-syn = { version = "1.0", features = ["full", "extra-traits"] }
 
 [patch.crates-io]
 bitcoincore-rpc = { version = "0.18.0", git = "https://github.com/chainwayxyz/rust-bitcoincore-rpc.git", rev = "0ae498d" }

Makefile

@@ -29,14 +29,13 @@ lint:  ## cargo check and clippy. Skip clippy on guest code since it's not suppo
 	dprint check
 	cargo +nightly fmt --all --check
 	cargo check --all-targets --all-features
-	$(MAKE) check-fuzz
-	SKIP_GUEST_BUILD=1 cargo clippy --all-targets --all-features
+	cargo clippy --all-targets --all-features
 
 lint-fix:  ## dprint fmt, cargo fmt, fix and clippy. Skip clippy on guest code since it's not supported by risc0
 	dprint fmt
 	cargo +nightly fmt --all
 	cargo fix --allow-dirty
-	SKIP_GUEST_BUILD=1 cargo clippy --fix --allow-dirty
+	cargo clippy --fix --allow-dirty
 
 docs:  ## Generates documentation locally
 	cargo doc --open

src/prover.rs renamed to src/batch_prover.rs

@@ -1,19 +1,20 @@
 use std::time::SystemTime;
 
-use super::{config::FullProverConfig, Result};
-use crate::node::Node;
 use anyhow::bail;
 use log::debug;
 use tokio::time::{sleep, Duration};
 
-pub type Prover = Node<FullProverConfig>;
+use super::{config::FullBatchProverConfig, Result};
+use crate::node::Node;
+
+pub type BatchProver = Node<FullBatchProverConfig>;
 
-impl Prover {
+impl BatchProver {
     pub async fn wait_for_l1_height(&self, height: u64, timeout: Option<Duration>) -> Result<()> {
         let start = SystemTime::now();
         let timeout = timeout.unwrap_or(Duration::from_secs(600));
         loop {
-            debug!("Waiting for prover height {}", height);
+            debug!("Waiting for batch prover height {}", height);
             let latest_block = self.client.ledger_get_last_scanned_l1_height().await?;
 
             if latest_block >= height {
@@ -22,7 +23,7 @@ impl Prover {
 
             let now = SystemTime::now();
             if start + timeout <= now {
-                bail!("Timeout. Latest prover L1 height is {}", latest_block);
+                bail!("Timeout. Latest batch prover L1 height is {}", latest_block);
             }
 
             sleep(Duration::from_secs(1)).await;

src/bitcoin.rs

@@ -128,7 +128,10 @@ impl BitcoinNode {
     async fn load_wallets(&self) {
         let _ = self.load_wallet(&NodeKind::Bitcoin.to_string()).await;
         let _ = self.load_wallet(&NodeKind::Sequencer.to_string()).await;
-        let _ = self.load_wallet(&NodeKind::Prover.to_string()).await;
+        let _ = self.load_wallet(&NodeKind::BatchProver.to_string()).await;
+        let _ = self
+            .load_wallet(&NodeKind::LightClientProver.to_string())
+            .await;
     }
 
     // Switch this over to Node signature once we add support for docker to citrea nodes

src/citrea_config/prover.rs renamed to src/citrea_config/batch_prover.rs

@@ -32,7 +32,7 @@ impl<'de> Deserialize<'de> for ProverGuestRunConfig {
 
 /// Prover configuration
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
-pub struct ProverConfig {
+pub struct BatchProverConfig {
     /// Prover run mode
     pub proving_mode: ProverGuestRunConfig,
     /// Average number of commitments to prove
@@ -41,7 +41,7 @@ pub struct ProverConfig {
     pub enable_recovery: bool,
 }
 
-impl Default for ProverConfig {
+impl Default for BatchProverConfig {
     fn default() -> Self {
         Self {
             proving_mode: ProverGuestRunConfig::Execute,
@@ -53,12 +53,13 @@ impl Default for ProverConfig {
 
 #[cfg(test)]
 mod tests {
-    use std::io::Write;
+    use std::{
+        fs::File,
+        io::{Read, Write},
+        path::Path,
+    };
 
     use serde::de::DeserializeOwned;
-    use std::fs::File;
-    use std::io::Read;
-    use std::path::Path;
     use tempfile::NamedTempFile;
 
     use super::*;
@@ -91,8 +92,8 @@ mod tests {
 
         let config_file = create_config_from(config);
 
-        let config: ProverConfig = from_toml_path(config_file.path()).unwrap();
-        let expected = ProverConfig {
+        let config: BatchProverConfig = from_toml_path(config_file.path()).unwrap();
+        let expected = BatchProverConfig {
             proving_mode: ProverGuestRunConfig::Skip,
             proof_sampling_number: 500,
             enable_recovery: true,

src/citrea_config/light_client_prover.rs

@@ -0,0 +1,75 @@
+use serde::{Deserialize, Serialize};
+
+use super::batch_prover::ProverGuestRunConfig;
+
+/// Light client prover configuration
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
+pub struct LightClientProverConfig {
+    /// Prover run mode
+    pub proving_mode: ProverGuestRunConfig,
+    /// Average number of commitments to prove
+    pub proof_sampling_number: usize,
+    /// If true prover will try to recover ongoing proving sessions
+    pub enable_recovery: bool,
+}
+
+impl Default for LightClientProverConfig {
+    fn default() -> Self {
+        Self {
+            proving_mode: ProverGuestRunConfig::Execute,
+            proof_sampling_number: 0,
+            enable_recovery: true,
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::{
+        fs::File,
+        io::{Read, Write},
+        path::Path,
+    };
+
+    use serde::de::DeserializeOwned;
+    use tempfile::NamedTempFile;
+
+    use super::*;
+
+    /// Reads toml file as a specific type.
+    pub fn from_toml_path<P: AsRef<Path>, R: DeserializeOwned>(path: P) -> anyhow::Result<R> {
+        let mut contents = String::new();
+        {
+            let mut file = File::open(path)?;
+            file.read_to_string(&mut contents)?;
+        }
+        let result: R = toml::from_str(&contents)?;
+
+        Ok(result)
+    }
+
+    fn create_config_from(content: &str) -> NamedTempFile {
+        let mut config_file = NamedTempFile::new().unwrap();
+        config_file.write_all(content.as_bytes()).unwrap();
+        config_file
+    }
+
+    #[test]
+    fn test_correct_prover_config() {
+        let config = r#"
+            proving_mode = "skip"
+            proof_sampling_number = 500
+            enable_recovery = true
+        "#;
+
+        let config_file = create_config_from(config);
+
+        let config: LightClientProverConfig = from_toml_path(config_file.path()).unwrap();
+        let expected = LightClientProverConfig {
+            proving_mode: ProverGuestRunConfig::Skip,
+            proof_sampling_number: 500,
+            enable_recovery: true,
+        };
+        assert_eq!(config, expected);
+    }
+}

src/citrea_config/mod.rs

@@ -3,8 +3,9 @@
 // Should ideally be automatically kept in sync somehow but manually copied here for the time being.
 // Configs are stable and not expected to change much.
 
+pub(crate) mod batch_prover;
 pub(crate) mod bitcoin;
-pub(crate) mod prover;
+pub(crate) mod light_client_prover;
 pub(crate) mod rollup;
 pub(crate) mod sequencer;
 

src/citrea_config/rollup.rs

@@ -14,6 +14,8 @@ pub struct RunnerConfig {
     /// Number of blocks to request during sync
     #[serde(default = "default_sync_blocks_count")]
     pub sync_blocks_count: u64,
+    /// Configurations for pruning
+    pub pruning_config: Option<PruningConfig>,
 }
 
 /// RPC configuration.
@@ -118,3 +120,16 @@ pub struct FullNodeConfig<BitcoinServiceConfig> {
     /// Important pubkeys
     pub public_keys: RollupPublicKeys,
 }
+
+/// A configuration type to define the behaviour of the pruner.
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PruningConfig {
+    /// Defines the number of blocks from the tip of the chain to remove.
+    pub distance: u64,
+}
+
+impl Default for PruningConfig {
+    fn default() -> Self {
+        Self { distance: 256 }
+    }
+}

src/citrea_config/sequencer.rs

@@ -74,9 +74,8 @@ mod tests {
 
     use tempfile::NamedTempFile;
 
-    use crate::citrea_config::from_toml_path;
-
     use super::*;
+    use crate::citrea_config::from_toml_path;
 
     fn create_config_from(content: &str) -> NamedTempFile {
         let mut config_file = NamedTempFile::new().unwrap();

src/client.rs

@@ -1,8 +1,8 @@
 use std::time::{Duration, SystemTime};
 
 use anyhow::{bail, Result};
-use jsonrpsee::core::client::ClientT;
 use jsonrpsee::{
+    core::client::ClientT,
     http_client::{HttpClient, HttpClientBuilder},
     rpc_params,
 };