feat(zk_toolbox): Add external_node consensus support

zk_toolbox/crates/common/src/external_node.rs

@@ -9,6 +9,7 @@ pub fn run(
     config_path: &str,
     secrets_path: &str,
     en_config_path: &str,
+    consensus_args: Vec<String>,
     additional_args: Vec<String>,
 ) -> anyhow::Result<()> {
     let _dir = shell.push_dir(code_path);
@@ -22,6 +23,7 @@ pub fn run(
             --external-node-config-path {en_config_path}
             "
         )
+        .args(consensus_args)
         .args(additional_args)
         .env_remove("RUSTUP_TOOLCHAIN"),
     )

zk_toolbox/crates/config/src/consensus_config.rs

@@ -0,0 +1,7 @@
+use zksync_config::configs::consensus::ConsensusConfig;
+
+use crate::{traits::FileConfigWithDefaultName, CONSENSUS_CONFIG_FILE};
+
+impl FileConfigWithDefaultName for ConsensusConfig {
+    const FILE_NAME: &'static str = CONSENSUS_CONFIG_FILE;
+}

zk_toolbox/crates/config/src/consensus_secrets.rs

@@ -0,0 +1,14 @@
+use std::path::Path;
+
+use xshell::Shell;
+use zksync_config::configs::consensus::ConsensusSecrets;
+use zksync_protobuf_config::decode_yaml_repr;
+
+use crate::traits::ReadConfig;
+
+impl ReadConfig for ConsensusSecrets {
+    fn read(shell: &Shell, path: impl AsRef<Path>) -> anyhow::Result<Self> {
+        let path = shell.current_dir().join(path);
+        decode_yaml_repr::<zksync_protobuf_config::proto::secrets::ConsensusSecrets>(&path, false)
+    }
+}

zk_toolbox/crates/config/src/consts.rs

@@ -11,6 +11,8 @@ pub const GENESIS_FILE: &str = "genesis.yaml";
 
 // Name of external node specific config
 pub const EN_CONFIG_FILE: &str = "external_node.yaml";
+// Name of consensus config
+pub const CONSENSUS_CONFIG_FILE: &str = "consensus_config.yaml";
 pub(crate) const ERC20_CONFIGS_FILE: &str = "erc20.yaml";
 /// Name of the initial deployments config file
 pub(crate) const INITIAL_DEPLOYMENT_FILE: &str = "initial_deployments.yaml";

zk_toolbox/crates/config/src/lib.rs

@@ -25,6 +25,8 @@ mod secrets;
 mod wallet_creation;
 mod wallets;
 
+pub mod consensus_config;
+pub mod consensus_secrets;
 pub mod docker_compose;
 pub mod explorer;
 pub mod explorer_compose;

zk_toolbox/crates/zk_inception/src/commands/external_node/args/run.rs

@@ -1,14 +1,18 @@
 use clap::Parser;
 use serde::{Deserialize, Serialize};
 
-use crate::messages::{MSG_SERVER_ADDITIONAL_ARGS_HELP, MSG_SERVER_COMPONENTS_HELP};
+use crate::messages::{
+    MSG_ENABLE_CONSENSUS_HELP, MSG_SERVER_ADDITIONAL_ARGS_HELP, MSG_SERVER_COMPONENTS_HELP,
+};
 
 #[derive(Debug, Serialize, Deserialize, Parser)]
 pub struct RunExternalNodeArgs {
     #[clap(long)]
     pub reinit: bool,
     #[clap(long, help = MSG_SERVER_COMPONENTS_HELP)]
     pub components: Option<Vec<String>>,
+    #[clap(long, help = MSG_ENABLE_CONSENSUS_HELP, default_missing_value = "true", num_args = 0..=1)]
+    pub enable_consensus: Option<bool>,
     #[clap(long, short)]
     #[arg(trailing_var_arg = true, allow_hyphen_values = true, hide = false, help = MSG_SERVER_ADDITIONAL_ARGS_HELP)]
     pub additional_args: Vec<String>,

zk_toolbox/crates/zk_inception/src/commands/external_node/prepare_configs.rs

@@ -1,17 +1,20 @@
 use std::{path::Path, str::FromStr};
 
 use anyhow::Context;
-use common::{config::global_config, logger};
+use common::{cmd::Cmd, config::global_config, logger};
 use config::{
-    external_node::ENConfig, ports_config, set_rocks_db_config, traits::SaveConfigWithBasePath,
+    external_node::ENConfig,
+    ports_config, set_rocks_db_config,
+    traits::{ReadConfig, SaveConfigWithBasePath},
     update_ports, ChainConfig, EcosystemConfig, SecretsConfig,
 };
-use xshell::Shell;
+use xshell::{cmd, Shell};
 use zksync_basic_types::url::SensitiveUrl;
-use zksync_config::configs::{DatabaseSecrets, L1Secrets};
+use zksync_config::configs::{consensus::ConsensusSecrets, DatabaseSecrets, L1Secrets};
 
 use crate::{
     commands::external_node::args::prepare_configs::{PrepareConfigArgs, PrepareConfigFinal},
+    consts::{CONSENSUS_CONFIG_PATH, CONSENSUS_SECRETS_PATH},
     messages::{
         msg_preparing_en_config_is_done, MSG_CHAIN_NOT_INITIALIZED, MSG_PREPARING_EN_CONFIGS,
     },
@@ -71,8 +74,14 @@ fn prepare_configs(
             .context("da")?
             .next_empty_ports_config(),
     )?;
+
+    let consensus_config_path = config.link_to_code.join(CONSENSUS_CONFIG_PATH);
+    Cmd::new(cmd!(shell, "cp {consensus_config_path} {en_configs_path}")).run()?;
+
+    let consensus_secrets_path = config.link_to_code.join(CONSENSUS_SECRETS_PATH);
+    let consensus_secrets = ConsensusSecrets::read(shell, consensus_secrets_path)?;
     let secrets = SecretsConfig {
-        consensus: None,
+        consensus: Some(consensus_secrets),
         database: Some(DatabaseSecrets {
             server_url: Some(args.db.full_url().into()),
             prover_url: None,

zk_toolbox/crates/zk_inception/src/commands/external_node/run.rs

@@ -32,6 +32,7 @@ async fn run_external_node(
     if args.reinit {
         init::init(shell, chain_config).await?
     }
+    let enable_consensus = args.enable_consensus.unwrap_or(false);
     let server = RunExternalNode::new(args.components.clone(), chain_config)?;
-    server.run(shell, args.additional_args.clone())
+    server.run(shell, enable_consensus, args.additional_args.clone())
 }

zk_toolbox/crates/zk_inception/src/consts.rs

@@ -9,6 +9,9 @@ pub const DEFAULT_PROOF_STORE_DIR: &str = "artifacts";
 pub const BELLMAN_CUDA_DIR: &str = "era-bellman-cuda";
 pub const L2_BASE_TOKEN_ADDRESS: &str = "0x000000000000000000000000000000000000800A";
 
+pub const CONSENSUS_CONFIG_PATH: &str = "etc/env/consensus_config.yaml";
+pub const CONSENSUS_SECRETS_PATH: &str = "etc/env/consensus_secrets.yaml";
+
 /// Path to the JS runtime config for the block-explorer-app docker container to be mounted to
 pub const EXPLORER_APP_DOCKER_CONFIG_PATH: &str = "/usr/src/app/packages/app/dist/config.js";
 pub const EXPLORER_APP_DOCKER_IMAGE: &str = "matterlabs/block-explorer-app";

zk_toolbox/crates/zk_inception/src/external_node.rs

@@ -6,6 +6,7 @@ use config::{
     SecretsConfig,
 };
 use xshell::Shell;
+use zksync_config::configs::consensus::ConsensusConfig;
 
 use crate::messages::MSG_FAILED_TO_RUN_SERVER_ERR;
 
@@ -15,6 +16,7 @@ pub struct RunExternalNode {
     general_config: PathBuf,
     secrets: PathBuf,
     en_config: PathBuf,
+    consensus_config: PathBuf,
 }
 
 impl RunExternalNode {
@@ -29,31 +31,45 @@ impl RunExternalNode {
         let general_config = GeneralConfig::get_path_with_base_path(&en_path);
         let secrets = SecretsConfig::get_path_with_base_path(&en_path);
         let enconfig = ENConfig::get_path_with_base_path(&en_path);
+        let consensus_config = ConsensusConfig::get_path_with_base_path(&en_path);
 
         Ok(Self {
             components,
             code_path: chain_config.link_to_code.clone(),
             general_config,
             secrets,
             en_config: enconfig,
+            consensus_config,
         })
     }
 
-    pub fn run(&self, shell: &Shell, mut additional_args: Vec<String>) -> anyhow::Result<()> {
+    pub fn run(
+        &self,
+        shell: &Shell,
+        enable_consensus: bool,
+        mut additional_args: Vec<String>,
+    ) -> anyhow::Result<()> {
         let code_path = self.code_path.to_str().unwrap();
         let config_general_config = &self.general_config.to_str().unwrap();
         let en_config = &self.en_config.to_str().unwrap();
         let secrets = &self.secrets.to_str().unwrap();
+        let consensus_config = &self.consensus_config.to_str().unwrap();
         if let Some(components) = self.components() {
             additional_args.push(format!("--components={}", components))
         }
+        let mut consensus_args = vec![];
+        if enable_consensus {
+            consensus_args.push("--enable-consensus".to_string());
+            consensus_args.push(format!("--consensus-path={}", consensus_config))
+        }
 
         common::external_node::run(
             shell,
             code_path,
             config_general_config,
             secrets,
             en_config,
+            consensus_args,
             additional_args,
         )
         .context(MSG_FAILED_TO_RUN_SERVER_ERR)

zk_toolbox/crates/zk_inception/src/messages.rs

@@ -218,6 +218,7 @@ pub(super) const MSG_DEPLOYING_PAYMASTER: &str = "Deploying paymaster";
 
 /// Run server related messages
 pub(super) const MSG_SERVER_COMPONENTS_HELP: &str = "Components of server to run";
+pub(super) const MSG_ENABLE_CONSENSUS_HELP: &str = "Enable consensus";
 pub(super) const MSG_SERVER_GENESIS_HELP: &str = "Run server in genesis mode";
 pub(super) const MSG_SERVER_ADDITIONAL_ARGS_HELP: &str =
     "Additional arguments that can be passed through the CLI";