feat: Implement gas relay mode and inclusion data for data attestation (

#3070) ## What ❔ This PR adds gas relay API support for gasless submission to the Avail network, it also provides the attestation implementation necessary for data attestation. ## Why ❔ Gas relay API support is required for Avail partners that choose to pay in a different token. Data attestation ensures that arbitrary tx data cannot be used for rollup finality and that no data withholding attack can occur. ## Checklist - [X] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [X] Documentation comments have been added / updated. - [X] Code has been formatted via `zk fmt` and `zk lint`. Supersedes #2987 --------- Co-authored-by: vibhurajeev <[email protected]> Co-authored-by: dimazhornyk <[email protected]> Co-authored-by: Dima Zhornyk <[email protected]>
matter-labs · Oct 24, 2024 · 561fc1b · 561fc1b
1 parent 4629450
commit 561fc1b
Show file tree

Hide file tree

Showing 15 changed files with 512 additions and 97 deletions.
diff --git a/.gitignore b/.gitignore
@@ -115,6 +115,7 @@ prover/data/keys/setup_*
 # ZK Stack CLI
 chains/era/configs/*
 chains/gateway/*
+chains/avail/*
 configs/*
 era-observability/
 core/tests/ts-integration/deployments-zk

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -110,6 +110,7 @@ backon = "0.4.4"
 bigdecimal = "0.4.5"
 bincode = "1"
 blake2 = "0.10"
+bytes = "1"
 chrono = "0.4"
 clap = "4.2.2"
 codegen = "0.2.0"
@@ -155,7 +156,7 @@ rayon = "1.3.1"
 regex = "1"
 reqwest = "0.12"
 rlp = "0.5"
-rocksdb = "0.21.0"
+rocksdb = "0.21"
 rustc_version = "0.4.0"
 rustls = "0.23"
 secp256k1 = { version = "0.27.0", features = ["recovery", "global-context"] }

diff --git a/core/lib/basic_types/src/api_key.rs b/core/lib/basic_types/src/api_key.rs
@@ -0,0 +1,20 @@
+use std::str::FromStr;
+
+use secrecy::{ExposeSecret, Secret};
+
+#[derive(Debug, Clone)]
+pub struct APIKey(pub Secret<String>);
+
+impl PartialEq for APIKey {
+    fn eq(&self, other: &Self) -> bool {
+        self.0.expose_secret().eq(other.0.expose_secret())
+    }
+}
+
+impl FromStr for APIKey {
+    type Err = anyhow::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        Ok(APIKey(s.parse()?))
+    }
+}
diff --git a/core/lib/basic_types/src/lib.rs b/core/lib/basic_types/src/lib.rs
@@ -24,6 +24,7 @@ use serde::{de, Deserialize, Deserializer, Serialize};
 
 #[macro_use]
 mod macros;
+pub mod api_key;
 pub mod basic_fri_types;
 pub mod commitment;
 pub mod network;

diff --git a/core/lib/config/src/configs/da_client/avail.rs b/core/lib/config/src/configs/da_client/avail.rs
@@ -1,16 +1,38 @@
 use serde::Deserialize;
-use zksync_basic_types::seed_phrase::SeedPhrase;
+use zksync_basic_types::{api_key::APIKey, seed_phrase::SeedPhrase};
+
+pub const AVAIL_GAS_RELAY_CLIENT_NAME: &str = "GasRelay";
+pub const AVAIL_FULL_CLIENT_NAME: &str = "FullClient";
+
+#[derive(Clone, Debug, PartialEq, Deserialize)]
+#[serde(tag = "avail_client")]
+pub enum AvailClientConfig {
+    FullClient(AvailDefaultConfig),
+    GasRelay(AvailGasRelayConfig),
+}
 
 #[derive(Clone, Debug, PartialEq, Deserialize)]
 pub struct AvailConfig {
-    pub api_node_url: String,
     pub bridge_api_url: String,
-    pub app_id: u32,
     pub timeout: usize,
+    #[serde(flatten)]
+    pub config: AvailClientConfig,
+}
+
+#[derive(Clone, Debug, PartialEq, Deserialize)]
+pub struct AvailDefaultConfig {
+    pub api_node_url: String,
+    pub app_id: u32,
+}
+
+#[derive(Clone, Debug, PartialEq, Deserialize)]
+pub struct AvailGasRelayConfig {
+    pub gas_relay_api_url: String,
     pub max_retries: usize,
 }
 
 #[derive(Clone, Debug, PartialEq)]
 pub struct AvailSecrets {
     pub seed_phrase: Option<SeedPhrase>,
+    pub gas_relay_api_key: Option<APIKey>,
 }
diff --git a/core/lib/config/src/testonly.rs b/core/lib/config/src/testonly.rs
@@ -3,6 +3,7 @@ use std::num::NonZeroUsize;
 use rand::{distributions::Distribution, Rng};
 use secrecy::Secret;
 use zksync_basic_types::{
+    api_key::APIKey,
     basic_fri_types::CircuitIdRoundTuple,
     commitment::L1BatchCommitmentMode,
     network::Network,
@@ -17,7 +18,12 @@ use zksync_crypto_primitives::K256PrivateKey;
 
 use crate::{
     configs::{
-        self, da_client::DAClientConfig::Avail, external_price_api_client::ForcedPriceClientConfig,
+        self,
+        da_client::{
+            avail::{AvailClientConfig, AvailDefaultConfig},
+            DAClientConfig::Avail,
+        },
+        external_price_api_client::ForcedPriceClientConfig,
     },
     AvailConfig,
 };
@@ -935,11 +941,12 @@ impl Distribution<configs::en_config::ENConfig> for EncodeDist {
 impl Distribution<configs::da_client::DAClientConfig> for EncodeDist {
     fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> configs::da_client::DAClientConfig {
         Avail(AvailConfig {
-            api_node_url: self.sample(rng),
             bridge_api_url: self.sample(rng),
-            app_id: self.sample(rng),
             timeout: self.sample(rng),
-            max_retries: self.sample(rng),
+            config: AvailClientConfig::FullClient(AvailDefaultConfig {
+                api_node_url: self.sample(rng),
+                app_id: self.sample(rng),
+            }),
         })
     }
 }
@@ -948,6 +955,7 @@ impl Distribution<configs::secrets::DataAvailabilitySecrets> for EncodeDist {
     fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> configs::secrets::DataAvailabilitySecrets {
         configs::secrets::DataAvailabilitySecrets::Avail(configs::da_client::avail::AvailSecrets {
             seed_phrase: Some(SeedPhrase(Secret::new(self.sample(rng)))),
+            gas_relay_api_key: Some(APIKey(Secret::new(self.sample(rng)))),
         })
     }
 }

diff --git a/core/lib/env_config/src/da_client.rs b/core/lib/env_config/src/da_client.rs
@@ -2,19 +2,34 @@ use std::env;
 
 use zksync_config::configs::{
     da_client::{
-        avail::AvailSecrets, DAClientConfig, AVAIL_CLIENT_CONFIG_NAME,
-        OBJECT_STORE_CLIENT_CONFIG_NAME,
+        avail::{
+            AvailClientConfig, AvailSecrets, AVAIL_FULL_CLIENT_NAME, AVAIL_GAS_RELAY_CLIENT_NAME,
+        },
+        DAClientConfig, AVAIL_CLIENT_CONFIG_NAME, OBJECT_STORE_CLIENT_CONFIG_NAME,
     },
     secrets::DataAvailabilitySecrets,
+    AvailConfig,
 };
 
 use crate::{envy_load, FromEnv};
 
 impl FromEnv for DAClientConfig {
     fn from_env() -> anyhow::Result<Self> {
-        let client_tag = std::env::var("DA_CLIENT")?;
+        let client_tag = env::var("DA_CLIENT")?;
         let config = match client_tag.as_str() {
-            AVAIL_CLIENT_CONFIG_NAME => Self::Avail(envy_load("da_avail_config", "DA_")?),
+            AVAIL_CLIENT_CONFIG_NAME => Self::Avail(AvailConfig {
+                bridge_api_url: env::var("DA_BRIDGE_API_URL").ok().unwrap(),
+                timeout: env::var("DA_TIMEOUT")?.parse()?,
+                config: match env::var("DA_AVAIL_CLIENT_TYPE")?.as_str() {
+                    AVAIL_FULL_CLIENT_NAME => {
+                        AvailClientConfig::FullClient(envy_load("da_avail_full_client", "DA_")?)
+                    }
+                    AVAIL_GAS_RELAY_CLIENT_NAME => {
+                        AvailClientConfig::GasRelay(envy_load("da_avail_gas_relay", "DA_")?)
+                    }
+                    _ => anyhow::bail!("Unknown Avail DA client type"),
+                },
+            }),
             OBJECT_STORE_CLIENT_CONFIG_NAME => {
                 Self::ObjectStore(envy_load("da_object_store", "DA_")?)
             }
@@ -30,11 +45,21 @@ impl FromEnv for DataAvailabilitySecrets {
         let client_tag = std::env::var("DA_CLIENT")?;
         let secrets = match client_tag.as_str() {
             AVAIL_CLIENT_CONFIG_NAME => {
-                let seed_phrase = env::var("DA_SECRETS_SEED_PHRASE")
-                    .ok()
-                    .map(|s| s.parse())
-                    .transpose()?;
-                Self::Avail(AvailSecrets { seed_phrase })
+                let seed_phrase: Option<zksync_basic_types::seed_phrase::SeedPhrase> =
+                    env::var("DA_SECRETS_SEED_PHRASE")
+                        .ok()
+                        .map(|s| s.parse().unwrap());
+                let gas_relay_api_key: Option<zksync_basic_types::api_key::APIKey> =
+                    env::var("DA_SECRETS_GAS_RELAY_API_KEY")
+                        .ok()
+                        .map(|s| s.parse().unwrap());
+                if seed_phrase.is_none() && gas_relay_api_key.is_none() {
+                    anyhow::bail!("No secrets provided for Avail DA client");
+                }
+                Self::Avail(AvailSecrets {
+                    seed_phrase,
+                    gas_relay_api_key,
+                })
             }
             _ => anyhow::bail!("Unknown DA client name: {}", client_tag),
         };
@@ -47,7 +72,10 @@ impl FromEnv for DataAvailabilitySecrets {
 mod tests {
     use zksync_config::{
         configs::{
-            da_client::{DAClientConfig, DAClientConfig::ObjectStore},
+            da_client::{
+                avail::{AvailClientConfig, AvailDefaultConfig},
+                DAClientConfig::{self, ObjectStore},
+            },
             object_store::ObjectStoreMode::GCS,
         },
         AvailConfig, ObjectStoreConfig,
@@ -91,14 +119,14 @@ mod tests {
         bridge_api_url: &str,
         app_id: u32,
         timeout: usize,
-        max_retries: usize,
     ) -> DAClientConfig {
         DAClientConfig::Avail(AvailConfig {
-            api_node_url: api_node_url.to_string(),
             bridge_api_url: bridge_api_url.to_string(),
-            app_id,
             timeout,
-            max_retries,
+            config: AvailClientConfig::FullClient(AvailDefaultConfig {
+                api_node_url: api_node_url.to_string(),
+                app_id,
+            }),
         })
     }
 
@@ -107,11 +135,13 @@ mod tests {
         let mut lock = MUTEX.lock();
         let config = r#"
             DA_CLIENT="Avail"
-            DA_API_NODE_URL="localhost:12345"
+            DA_AVAIL_CLIENT_TYPE="FullClient"
+
             DA_BRIDGE_API_URL="localhost:54321"
-            DA_APP_ID="1"
             DA_TIMEOUT="2"
-            DA_MAX_RETRIES="3"
+
+            DA_API_NODE_URL="localhost:12345"
+            DA_APP_ID="1"
         "#;
 
         lock.set_env(config);
@@ -124,7 +154,6 @@ mod tests {
                 "localhost:54321",
                 "1".parse::<u32>().unwrap(),
                 "2".parse::<usize>().unwrap(),
-                "3".parse::<usize>().unwrap(),
             )
         );
     }
@@ -139,15 +168,18 @@ mod tests {
 
         lock.set_env(config);
 
-        let actual = match DataAvailabilitySecrets::from_env().unwrap() {
-            DataAvailabilitySecrets::Avail(avail) => avail.seed_phrase,
+        let (actual_seed, actual_key) = match DataAvailabilitySecrets::from_env().unwrap() {
+            DataAvailabilitySecrets::Avail(avail) => (avail.seed_phrase, avail.gas_relay_api_key),
         };
 
         assert_eq!(
-            actual.unwrap(),
-            "bottom drive obey lake curtain smoke basket hold race lonely fit walk"
-                .parse()
-                .unwrap()
+            (actual_seed.unwrap(), actual_key),
+            (
+                "bottom drive obey lake curtain smoke basket hold race lonely fit walk"
+                    .parse()
+                    .unwrap(),
+                None
+            )
         );
     }
 }
diff --git a/core/lib/protobuf_config/src/da_client.rs b/core/lib/protobuf_config/src/da_client.rs
@@ -1,10 +1,10 @@
 use anyhow::Context;
-use zksync_config::{
-    configs::{
-        da_client::DAClientConfig::{Avail, ObjectStore},
-        {self},
+use zksync_config::configs::{
+    self,
+    da_client::{
+        avail::{AvailClientConfig, AvailConfig, AvailDefaultConfig, AvailGasRelayConfig},
+        DAClientConfig::{Avail, ObjectStore},
     },
-    AvailConfig,
 };
 use zksync_protobuf::{required, ProtoRepr};
 
@@ -18,15 +18,31 @@ impl ProtoRepr for proto::DataAvailabilityClient {
 
         let client = match config {
             proto::data_availability_client::Config::Avail(conf) => Avail(AvailConfig {
-                api_node_url: required(&conf.api_node_url)
-                    .context("api_node_url")?
-                    .clone(),
                 bridge_api_url: required(&conf.bridge_api_url)
                     .context("bridge_api_url")?
                     .clone(),
-                app_id: *required(&conf.app_id).context("app_id")?,
                 timeout: *required(&conf.timeout).context("timeout")? as usize,
-                max_retries: *required(&conf.max_retries).context("max_retries")? as usize,
+                config: match conf.config.as_ref() {
+                    Some(proto::avail_config::Config::FullClient(full_client_conf)) => {
+                        AvailClientConfig::FullClient(AvailDefaultConfig {
+                            api_node_url: required(&full_client_conf.api_node_url)
+                                .context("api_node_url")?
+                                .clone(),
+                            app_id: *required(&full_client_conf.app_id).context("app_id")?,
+                        })
+                    }
+                    Some(proto::avail_config::Config::GasRelay(gas_relay_conf)) => {
+                        AvailClientConfig::GasRelay(AvailGasRelayConfig {
+                            gas_relay_api_url: required(&gas_relay_conf.gas_relay_api_url)
+                                .context("gas_relay_api_url")?
+                                .clone(),
+                            max_retries: *required(&gas_relay_conf.max_retries)
+                                .context("max_retries")?
+                                as usize,
+                        })
+                    }
+                    None => return Err(anyhow::anyhow!("Invalid Avail DA configuration")),
+                },
             }),
             proto::data_availability_client::Config::ObjectStore(conf) => {
                 ObjectStore(object_store_proto::ObjectStore::read(conf)?)
@@ -41,11 +57,22 @@ impl ProtoRepr for proto::DataAvailabilityClient {
             Avail(config) => Self {
                 config: Some(proto::data_availability_client::Config::Avail(
                     proto::AvailConfig {
-                        api_node_url: Some(config.api_node_url.clone()),
                         bridge_api_url: Some(config.bridge_api_url.clone()),
-                        app_id: Some(config.app_id),
                         timeout: Some(config.timeout as u64),
-                        max_retries: Some(config.max_retries as u64),
+                        config: match &config.config {
+                            AvailClientConfig::FullClient(conf) => Some(
+                                proto::avail_config::Config::FullClient(proto::AvailClientConfig {
+                                    api_node_url: Some(conf.api_node_url.clone()),
+                                    app_id: Some(conf.app_id),
+                                }),
+                            ),
+                            AvailClientConfig::GasRelay(conf) => Some(
+                                proto::avail_config::Config::GasRelay(proto::AvailGasRelayConfig {
+                                    gas_relay_api_url: Some(conf.gas_relay_api_url.clone()),
+                                    max_retries: Some(conf.max_retries as u64),
+                                }),
+                            ),
+                        },
                     },
                 )),
             },