chore(zkstack): Use trait for zkstack config (#4449)

## What ❔

Before for chain/ecosystem trait we had only `link_to_code` and all
other path has been calculated from this link.
Now it's a trait, that allows to implement custom paths for
`link_to_code`, `contracts`, `configs`

## Why ❔

For supporting different ways of initialization, we need to support
different path.
e.g. we have zksync_os, where we will be able to pass custom
`contracts_path`.

For docker based deployment we will be able to calculate custom path
inside containers.


## Is this a breaking change?
- [ ] Yes
- [ ] No

## Operational changes
<!-- Any config changes? Any new flags? Any changes to any scripts? -->
<!-- Please add anything that non-Matter Labs entities running their own
ZK Chain may need to know -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
- [ ] Code has been formatted via `zkstack dev fmt` and `zkstack dev
lint`.

---------

Signed-off-by: Danil <[email protected]>

Author: Deniallugo

zkstack_cli/crates/common/src/contracts.rs

@@ -4,26 +4,26 @@ use xshell::{cmd, Shell};
 
 use crate::cmd::Cmd;
 
-pub fn build_l1_contracts(shell: Shell, link_to_code: &Path) -> anyhow::Result<()> {
-    let _dir_guard = shell.push_dir(link_to_code.join("contracts/l1-contracts"));
+pub fn build_l1_contracts(shell: Shell, link_to_contracts: &Path) -> anyhow::Result<()> {
+    let _dir_guard = shell.push_dir(link_to_contracts.join("l1-contracts"));
     // Do not update era-contract's lockfile to avoid dirty submodule
     // Note, tha the v26 contracts depend on the node_modules to be present at the time of the compilation.
     Cmd::new(cmd!(shell, "yarn install --frozen-lockfile")).run()?;
     Ok(Cmd::new(cmd!(shell, "yarn build:foundry")).run()?)
 }
 
-pub fn build_l1_da_contracts(shell: Shell, link_to_code: &Path) -> anyhow::Result<()> {
-    let _dir_guard = shell.push_dir(link_to_code.join("contracts/da-contracts"));
+pub fn build_l1_da_contracts(shell: Shell, link_to_contracts: &Path) -> anyhow::Result<()> {
+    let _dir_guard = shell.push_dir(link_to_contracts.join("da-contracts"));
     Ok(Cmd::new(cmd!(shell, "forge build")).run()?)
 }
 
-pub fn build_l2_contracts(shell: Shell, link_to_code: &Path) -> anyhow::Result<()> {
-    let _dir_guard = shell.push_dir(link_to_code.join("contracts/l2-contracts"));
+pub fn build_l2_contracts(shell: Shell, link_to_contracts: &Path) -> anyhow::Result<()> {
+    let _dir_guard = shell.push_dir(link_to_contracts.join("l2-contracts"));
     Cmd::new(cmd!(shell, "yarn build:foundry")).run()?;
     Ok(())
 }
 
-pub fn build_system_contracts(shell: Shell, link_to_code: &Path) -> anyhow::Result<()> {
-    let _dir_guard = shell.push_dir(link_to_code.join("contracts/system-contracts"));
+pub fn build_system_contracts(shell: Shell, link_to_contracts: &Path) -> anyhow::Result<()> {
+    let _dir_guard = shell.push_dir(link_to_contracts.join("system-contracts"));
     Ok(Cmd::new(cmd!(shell, "yarn build:foundry")).run()?)
 }

zkstack_cli/crates/config/src/apps.rs

@@ -5,7 +5,7 @@ use xshell::Shell;
 
 use crate::{
     consts::{APPS_CONFIG_FILE, DEFAULT_EXPLORER_PORT, DEFAULT_PORTAL_PORT, LOCAL_CONFIGS_PATH},
-    traits::{FileConfigWithDefaultName, ReadConfig, SaveConfig, ZkStackConfigTrait},
+    traits::{FileConfigTrait, FileConfigWithDefaultName, ReadConfig, SaveConfig},
 };
 
 /// Ecosystem level configuration for the apps (portal and explorer).
@@ -20,7 +20,7 @@ pub struct AppEcosystemConfig {
     pub http_port: u16,
 }
 
-impl ZkStackConfigTrait for AppsEcosystemConfig {}
+impl FileConfigTrait for AppsEcosystemConfig {}
 impl FileConfigWithDefaultName for AppsEcosystemConfig {
     const FILE_NAME: &'static str = APPS_CONFIG_FILE;
 }

zkstack_cli/crates/config/src/chain.rs

@@ -12,17 +12,17 @@ use zksync_basic_types::L2ChainId;
 
 use crate::{
     consts::{
-        CONFIG_NAME, CONTRACTS_FILE, EN_CONFIG_FILE, GENERAL_FILE, GENESIS_FILE,
-        L1_CONTRACTS_FOUNDRY, SECRETS_FILE, WALLETS_FILE,
+        CONFIG_NAME, CONTRACTS_FILE, CONTRACTS_PATH, EN_CONFIG_FILE, GENERAL_FILE, GENESIS_FILE,
+        L1_CONTRACTS_FOUNDRY_INSIDE_CONTRACTS, SECRETS_FILE, WALLETS_FILE,
     },
     create_localhost_wallets,
     gateway::GatewayConfig,
     traits::{
-        FileConfigWithDefaultName, ReadConfig, ReadConfigWithBasePath, SaveConfig,
-        SaveConfigWithBasePath, ZkStackConfigTrait,
+        FileConfigTrait, FileConfigWithDefaultName, ReadConfig, ReadConfigWithBasePath, SaveConfig,
+        SaveConfigWithBasePath,
     },
     ContractsConfig, EcosystemConfig, GatewayChainConfig, GeneralConfig, GenesisConfig,
-    SecretsConfig, WalletsConfig, GATEWAY_CHAIN_FILE,
+    SecretsConfig, WalletsConfig, ZkStackConfigTrait, CONFIGS_PATH, GATEWAY_CHAIN_FILE,
 };
 
 /// Chain configuration file. This file is created in the chain
@@ -61,19 +61,19 @@ pub struct ChainConfig {
     pub chain_id: L2ChainId,
     pub prover_version: ProverMode,
     pub l1_network: L1Network,
-    pub self_path: PathBuf,
-    pub link_to_code: PathBuf,
     pub rocks_db_path: PathBuf,
     pub artifacts: PathBuf,
     pub configs: PathBuf,
     pub external_node_config_path: Option<PathBuf>,
     pub l1_batch_commit_data_generator_mode: L1BatchCommitmentMode,
     pub base_token: BaseToken,
     pub wallet_creation: WalletCreation,
-    pub shell: OnceCell<Shell>,
     pub legacy_bridge: Option<bool>,
     pub evm_emulator: bool,
     pub tight_ports: bool,
+    shell: OnceCell<Shell>,
+    self_path: PathBuf,
+    link_to_code: PathBuf,
 }
 
 #[derive(Debug, Clone)]
@@ -93,6 +93,49 @@ impl Serialize for ChainConfig {
 }
 
 impl ChainConfig {
+    #[allow(clippy::too_many_arguments)]
+    pub fn new(
+        id: u32,
+        name: String,
+        chain_id: L2ChainId,
+        prover_version: ProverMode,
+        l1_network: L1Network,
+        self_path: PathBuf,
+        link_to_code: PathBuf,
+        rocks_db_path: PathBuf,
+        artifacts: PathBuf,
+        configs: PathBuf,
+        external_node_config_path: Option<PathBuf>,
+        l1_batch_commit_data_generator_mode: L1BatchCommitmentMode,
+        base_token: BaseToken,
+        wallet_creation: WalletCreation,
+        shell: OnceCell<Shell>,
+        legacy_bridge: Option<bool>,
+        evm_emulator: bool,
+        tight_ports: bool,
+    ) -> Self {
+        Self {
+            id,
+            name,
+            chain_id,
+            prover_version,
+            l1_network,
+            self_path,
+            link_to_code,
+            rocks_db_path,
+            artifacts,
+            configs,
+            external_node_config_path,
+            l1_batch_commit_data_generator_mode,
+            base_token,
+            wallet_creation,
+            shell,
+            legacy_bridge,
+            evm_emulator,
+            tight_ports,
+        }
+    }
+
     pub(crate) fn get_shell(&self) -> &Shell {
         self.shell.get().expect("Not initialized")
     }
@@ -118,10 +161,6 @@ impl ChainConfig {
         anyhow::bail!("Wallets configs has not been found");
     }
 
-    pub fn get_preexisting_ecosystem_contracts_path(&self) -> PathBuf {
-        todo!()
-    }
-
     pub fn get_contracts_config(&self) -> anyhow::Result<ContractsConfig> {
         ContractsConfig::read_with_base_path(self.get_shell(), &self.configs)
     }
@@ -162,10 +201,6 @@ impl ChainConfig {
         self.configs.join(GATEWAY_CHAIN_FILE)
     }
 
-    pub fn path_to_l1_foundry(&self) -> PathBuf {
-        self.link_to_code.join(L1_CONTRACTS_FOUNDRY)
-    }
-
     pub fn save(&self, shell: &Shell, path: impl AsRef<Path>) -> anyhow::Result<()> {
         let config = self.get_internal();
         config.save(shell, path)
@@ -262,4 +297,23 @@ impl FileConfigWithDefaultName for ChainConfigInternal {
     const FILE_NAME: &'static str = CONFIG_NAME;
 }
 
-impl ZkStackConfigTrait for ChainConfigInternal {}
+impl FileConfigTrait for ChainConfigInternal {}
+
+impl ZkStackConfigTrait for ChainConfig {
+    fn link_to_code(&self) -> PathBuf {
+        self.link_to_code.clone()
+    }
+
+    fn default_configs_path(&self) -> PathBuf {
+        self.link_to_code().join(CONFIGS_PATH)
+    }
+
+    fn contracts_path(&self) -> PathBuf {
+        self.link_to_code().join(CONTRACTS_PATH)
+    }
+
+    fn path_to_l1_foundry(&self) -> PathBuf {
+        self.contracts_path()
+            .join(L1_CONTRACTS_FOUNDRY_INSIDE_CONTRACTS)
+    }
+}

zkstack_cli/crates/config/src/consts.rs

@@ -42,6 +42,7 @@ pub(crate) const LOCAL_CONFIGS_PATH: &str = "configs/";
 pub(crate) const LOCAL_GENERATED_PATH: &str = ".generated/";
 pub(crate) const LOCAL_DB_PATH: &str = "db/";
 pub(crate) const LOCAL_ARTIFACTS_PATH: &str = "artifacts/";
+pub(crate) const CONTRACTS_PATH: &str = "contracts/";
 
 /// Name of apps config file
 pub const APPS_CONFIG_FILE: &str = "apps.yaml";
@@ -105,8 +106,8 @@ pub const EXPLORER_BATCHES_PROCESSING_POLLING_INTERVAL: u64 = 1000;
 /// Path to ecosystem contacts
 pub(crate) const ECOSYSTEM_PATH: &str = "etc/env/ecosystems";
 
-/// Path to l1 contracts foundry folder inside zksync-era
-pub(crate) const L1_CONTRACTS_FOUNDRY: &str = "contracts/l1-contracts";
+pub(crate) const L1_CONTRACTS_FOUNDRY_INSIDE_CONTRACTS: &str = "l1-contracts";
+
 /// Path to proving networks contracts
 pub(crate) const PROVING_NETWORKS_PATH: &str = "proof-manager-contracts";
 /// Path to proving networks contracts deploy script

zkstack_cli/crates/config/src/contracts.rs

@@ -15,7 +15,7 @@ use crate::{
         },
         register_chain::output::RegisterChainOutput,
     },
-    traits::{FileConfigWithDefaultName, ZkStackConfigTrait},
+    traits::{FileConfigTrait, FileConfigWithDefaultName},
 };
 
 #[derive(Debug, Deserialize, Serialize, Clone, Default)]
@@ -215,7 +215,7 @@ impl FileConfigWithDefaultName for ContractsConfig {
     const FILE_NAME: &'static str = CONTRACTS_FILE;
 }
 
-impl ZkStackConfigTrait for ContractsConfig {}
+impl FileConfigTrait for ContractsConfig {}
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
 pub struct EcosystemContracts {
@@ -248,7 +248,7 @@ pub struct EcosystemContracts {
     pub server_notifier_proxy_addr: Option<Address>,
 }
 
-impl ZkStackConfigTrait for EcosystemContracts {}
+impl FileConfigTrait for EcosystemContracts {}
 
 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 pub struct BridgesContracts {

zkstack_cli/crates/config/src/docker_compose.rs

@@ -2,7 +2,7 @@ use std::collections::HashMap;
 
 use serde::{Deserialize, Serialize};
 
-use crate::traits::ZkStackConfigTrait;
+use crate::traits::FileConfigTrait;
 
 #[derive(Debug, Default, Serialize, Deserialize, Clone)]
 pub struct DockerComposeConfig {
@@ -36,7 +36,7 @@ pub struct DockerComposeService {
     pub other: serde_json::Value,
 }
 
-impl ZkStackConfigTrait for DockerComposeConfig {}
+impl FileConfigTrait for DockerComposeConfig {}
 
 impl DockerComposeConfig {
     pub fn add_service(&mut self, name: &str, service: DockerComposeService) {