feat(zk_toolbox): Add update command

zk_toolbox/crates/common/src/git.rs

@@ -29,3 +29,9 @@ pub fn submodule_update(shell: &Shell, link_to_code: PathBuf) -> anyhow::Result<
     .run()?;
     Ok(())
 }
+
+pub fn pull(shell: &Shell, link_to_code: PathBuf) -> anyhow::Result<()> {
+    let _dir_guard = shell.push_dir(link_to_code);
+    Cmd::new(cmd!(shell, "git pull")).run()?;
+    Ok(())
+}

zk_toolbox/crates/config/src/chain.rs

@@ -104,6 +104,10 @@ impl ChainConfig {
         self.configs.join(GENERAL_FILE)
     }
 
+    pub fn path_to_genesis_config(&self) -> PathBuf {
+        self.configs.join(GENESIS_FILE)
+    }
+
     pub fn path_to_secrets_config(&self) -> PathBuf {
         self.configs.join(SECRETS_FILE)
     }

zk_toolbox/crates/config/src/consts.rs

@@ -3,23 +3,23 @@ use types::ChainId;
 /// Name of the main configuration file
 pub(crate) const CONFIG_NAME: &str = "ZkStack.yaml";
 /// Name of the wallets file
-pub(crate) const WALLETS_FILE: &str = "wallets.yaml";
+pub const WALLETS_FILE: &str = "wallets.yaml";
 /// Name of the secrets config file
-pub(crate) const SECRETS_FILE: &str = "secrets.yaml";
+pub const SECRETS_FILE: &str = "secrets.yaml";
 /// Name of the general config file
-pub(crate) const GENERAL_FILE: &str = "general.yaml";
+pub const GENERAL_FILE: &str = "general.yaml";
 /// Name of the genesis config file
-pub(crate) const GENESIS_FILE: &str = "genesis.yaml";
+pub const GENESIS_FILE: &str = "genesis.yaml";
 
 // Name of external node specific config
-pub(crate) const EN_CONFIG_FILE: &str = "external_node.yaml";
+pub const EN_CONFIG_FILE: &str = "external_node.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";
 /// Name of the erc20 deployments config file
 pub(crate) const ERC20_DEPLOYMENT_FILE: &str = "erc20_deployments.yaml";
 /// Name of the contracts file
-pub(crate) const CONTRACTS_FILE: &str = "contracts.yaml";
+pub const CONTRACTS_FILE: &str = "contracts.yaml";
 /// Main repository for the ZKsync project
 pub const ZKSYNC_ERA_GIT_REPO: &str = "https://github.com/matter-labs/zksync-era";
 /// Name of the docker-compose file inside zksync repository

zk_toolbox/crates/config/src/lib.rs

@@ -1,5 +1,5 @@
 pub use chain::*;
-pub use consts::{DOCKER_COMPOSE_FILE, ZKSYNC_ERA_GIT_REPO};
+pub use consts::*;
 pub use contracts::*;
 pub use ecosystem::*;
 pub use file_config::*;

zk_toolbox/crates/zk_inception/src/commands/mod.rs

@@ -6,3 +6,4 @@ pub mod ecosystem;
 pub mod external_node;
 pub mod prover;
 pub mod server;
+pub mod update;

zk_toolbox/crates/zk_inception/src/commands/update.rs

@@ -0,0 +1,155 @@
+use std::path::Path;
+
+use anyhow::Context;
+use common::{
+    git::{pull, submodule_update},
+    logger,
+    spinner::Spinner,
+};
+use config::{ChainConfig, EcosystemConfig, GENERAL_FILE, GENESIS_FILE};
+use xshell::Shell;
+
+use crate::messages::{
+    msg_diff_genesis_config, msg_updating_chain, MSG_CHAIN_NOT_FOUND_ERR,
+    MSG_PULLING_ZKSYNC_CODE_SPINNER, MSG_SHOW_DIFF, MSG_SHOW_DIFF_ADDED_FIELDS,
+    MSG_UPDATING_GENERAL_CONFIG, MSG_UPDATING_SUBMODULES_SPINNER, MSG_UPDATING_ZKSYNC,
+    MSG_ZKSYNC_UPDATED,
+};
+
+#[derive(Default)]
+struct ConfigDiff {
+    pub value_diff: serde_yaml::Mapping,
+    pub added_fields: serde_yaml::Mapping,
+}
+
+pub fn run(shell: &Shell) -> anyhow::Result<()> {
+    logger::info(MSG_UPDATING_ZKSYNC);
+    let ecosystem = EcosystemConfig::from_file(shell)?;
+    let link_to_code = ecosystem.link_to_code.clone();
+
+    let spinner = Spinner::new(MSG_PULLING_ZKSYNC_CODE_SPINNER);
+    pull(shell, link_to_code.clone())?;
+    spinner.finish();
+    let spinner = Spinner::new(MSG_UPDATING_SUBMODULES_SPINNER);
+    submodule_update(shell, link_to_code.clone())?;
+    spinner.finish();
+
+    let general_config = serde_yaml::from_str(
+        &shell.read_file(ecosystem.get_default_configs_path().join(GENERAL_FILE))?,
+    )?;
+
+    let genesis_config = serde_yaml::from_str(
+        &shell.read_file(ecosystem.get_default_configs_path().join(GENESIS_FILE))?,
+    )?;
+
+    for chain in ecosystem.list_of_chains() {
+        logger::info(msg_updating_chain(&chain));
+        let chain = ecosystem
+            .load_chain(Some(chain))
+            .context(MSG_CHAIN_NOT_FOUND_ERR)?;
+        update_chain(shell, &chain, &general_config, &genesis_config)?;
+    }
+
+    logger::outro(MSG_ZKSYNC_UPDATED);
+
+    Ok(())
+}
+
+fn merge_yaml_internal(
+    a: &mut serde_yaml::Value,
+    b: serde_yaml::Value,
+    current_key: serde_yaml::Value,
+    diff: &mut ConfigDiff,
+) -> anyhow::Result<()> {
+    match (a, b) {
+        (serde_yaml::Value::Mapping(a), serde_yaml::Value::Mapping(b)) => {
+            for (key, value) in b {
+                if a.contains_key(&key) {
+                    merge_yaml_internal(a.get_mut(&key).unwrap(), value, key, diff)?;
+                } else {
+                    a.insert(key.clone(), value.clone());
+                    diff.added_fields.insert(key, value);
+                }
+            }
+        }
+        (a, b) => {
+            if a != &b {
+                diff.value_diff.insert(current_key, b);
+            }
+        }
+    }
+    Ok(())
+}
+
+fn merge_yaml(a: &mut serde_yaml::Value, b: serde_yaml::Value) -> anyhow::Result<ConfigDiff> {
+    let mut diff = ConfigDiff::default();
+    merge_yaml_internal(a, b, "".into(), &mut diff)?;
+    Ok(diff)
+}
+
+fn save_updated_config(
+    shell: &Shell,
+    config: serde_yaml::Value,
+    path: &Path,
+    diff: ConfigDiff,
+) -> anyhow::Result<()> {
+    if diff.added_fields.is_empty() {
+        return Ok(());
+    }
+
+    logger::info(MSG_SHOW_DIFF_ADDED_FIELDS);
+    for (key, value) in diff.added_fields {
+        let key = key.as_str().unwrap();
+        logger::info(format!("{}: {:?}", key, value));
+    }
+
+    let general_config = serde_yaml::to_string(&config)?;
+    shell.write_file(path, general_config)?;
+
+    Ok(())
+}
+
+fn check_diff(diff: &ConfigDiff, msg: &str) -> anyhow::Result<()> {
+    if diff.value_diff.is_empty() && diff.added_fields.is_empty() {
+        return Ok(());
+    }
+
+    logger::warn(msg);
+    logger::info(MSG_SHOW_DIFF);
+    for (key, value) in diff.added_fields.iter() {
+        let key = key.as_str().unwrap();
+        logger::info(format!("{}: {:?}", key, value));
+    }
+    for (key, value) in diff.value_diff.iter() {
+        let key = key.as_str().unwrap();
+        logger::info(format!("{}: {:?}", key, value));
+    }
+
+    Ok(())
+}
+
+fn update_chain(
+    shell: &Shell,
+    chain: &ChainConfig,
+    general: &serde_yaml::Value,
+    genesis: &serde_yaml::Value,
+) -> anyhow::Result<()> {
+    logger::info(MSG_UPDATING_GENERAL_CONFIG);
+    let current_general_config_path = chain.path_to_general_config();
+    let mut current_general_config =
+        serde_yaml::from_str(&shell.read_file(current_general_config_path.clone())?)?;
+    let diff = merge_yaml(&mut current_general_config, general.clone())?;
+    save_updated_config(
+        shell,
+        current_general_config,
+        &current_general_config_path,
+        diff,
+    )?;
+
+    let mut current_genesis_config =
+        serde_yaml::from_str(&shell.read_file(chain.path_to_genesis_config())?)?;
+    let diff = merge_yaml(&mut current_genesis_config, genesis.clone())?;
+    check_diff(&diff, &msg_diff_genesis_config(&chain.name))?;
+
+    Ok(())
+}

zk_toolbox/crates/zk_inception/src/main.rs

@@ -53,6 +53,8 @@ pub enum InceptionSubcommands {
     /// Run contract verifier
     #[command(subcommand)]
     ContractVerifier(ContractVerifierCommands),
+    /// Update zkSync
+    Update,
 }
 
 #[derive(Parser, Debug)]
@@ -110,6 +112,7 @@ async fn run_subcommand(inception_args: Inception, shell: &Shell) -> anyhow::Res
         InceptionSubcommands::ContractVerifier(args) => {
             commands::contract_verifier::run(shell, args).await?
         }
+        InceptionSubcommands::Update => commands::update::run(shell)?,
     }
     Ok(())
 }

zk_toolbox/crates/zk_inception/src/messages.rs

@@ -317,3 +317,24 @@ pub(super) fn msg_binary_already_exists(name: &str, version: &str) -> String {
 pub(super) fn msg_downloading_binary_spinner(name: &str, version: &str) -> String {
     format!("Downloading {} {} binary", name, version)
 }
+
+/// Update related messages
+
+pub(super) const MSG_UPDATING_ZKSYNC: &str = "Updating ZkSync";
+pub(super) const MSG_ZKSYNC_UPDATED: &str = "ZkSync updated successfully";
+pub(super) const MSG_PULLING_ZKSYNC_CODE_SPINNER: &str = "Pulling zksync-era repo...";
+pub(super) const MSG_UPDATING_SUBMODULES_SPINNER: &str = "Updating submodules...";
+pub(super) const MSG_UPDATING_GENERAL_CONFIG: &str = "Updating general config";
+pub(super) const MSG_SHOW_DIFF_ADDED_FIELDS: &str = "Added the following values:";
+pub(super) const MSG_SHOW_DIFF: &str = "Found differences in the following fields:";
+
+pub(super) fn msg_diff_genesis_config(chain: &str) -> String {
+    format!(
+        "Found differences between chain {} and era genesis configs. Consider updating the chain {} genesis config and re-running genesis.",
+        chain, chain
+    )
+}
+
+pub(super) fn msg_updating_chain(chain: &str) -> String {
+    format!("Updating chain: {}", chain)
+}