feat(gateway): Migration to Gateway (#3654)

## What ❔

Support migration to Gateway. That will be done through restart. 

There are few major changes in server

1. Contracats config now splitted to 3 configs: 
a. L1SpecificConfig - Stuff that exists only on l1 and will never be
migrated to gateway
  b. L2Contracts - Contracts that were deployed on l2
c. ChainSpecificContracts - Contracts that deployed on l1 and on gateway
2. L1 specific contracts and L2 contracts, for now, should be specified
in contracts config, manually. In a future we will be able to load them
as well
3. ChainSpecificContracts, are loading from the Settlement Layer, no
need to specify
4. There are no configuration for settlement layer. The settlement layer
known during the start of the node and the source of truth is contracts
both on l1 and settlement layer.
5. Server constantly checks that settlement layer has not changed. If it
chaged, server will wait until all processed transaction are sent and
confirmed and the necessary contracts are deployed to l1. After that
server will be killed. We assume that kubernetes will restart the server
6. During the start server checks the settlement layer and download the
necessary contracts config, later on almost all components of the system
are manipulating only with settlement layer client and config. Only eth
watcher knows about both layers.


External Node:
1. During the sync with the server External node verifies the
transaction on l1 for consistency. Once consistency checker is
panicking, external node crashes
2. During the start External node checks the latest eth txs in db and
depends on it setup the system to work either on Gateway or on L1



Migration process
1. Operator call the server notifier contract and this contract will
send the message to server, that all commit operations, should be
stopped
2. Server stops the commit operations, but continue to work in all other
parts
3. Operator call the migrate to gateway function on contracts
4. Once the migration is executed both on l1 and gateway, server will
crash
5. During the next start server will load all necessary contracts and
continue to work


## Why ❔

The migration to settlement layer should be smooth. Without necessary of
manual restarts and setting the contracts, it will drastically increase
the mistakes, especially with multiple chains in operation.




## Is this a breaking change?
- [ ] Yes
- [x] 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. -->

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

---------

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

Author: Deniallugo

.github/workflows/ci-core-reusable.yml

@@ -415,27 +415,32 @@ jobs:
           ci_run zkstack server --ignore-prerequisites --chain gateway &> ${{ env.SERVER_LOGS_DIR }}/gateway.log &
           ci_run zkstack server wait --ignore-prerequisites --verbose --chain gateway
 
+      - name: Build test dependencies
+        run: |
+          ci_run zkstack dev test build
+
       - name: Migrate chains to gateway
         if: matrix.use_gateway_chain == 'WITH_GATEWAY'
         run: |
-          ci_run zkstack chain migrate-to-gateway --chain era --gateway-chain-name gateway
+          ci_run zkstack dev test gateway-migration --to-gateway  --chain era --no-deps
           ci_run zkstack chain migrate-to-gateway --chain validium --gateway-chain-name gateway
           ci_run zkstack chain migrate-to-gateway --chain custom_token --gateway-chain-name gateway
           ci_run zkstack chain migrate-to-gateway --chain consensus --gateway-chain-name gateway
 
       - name: Migrate back era
         if: matrix.use_gateway_chain == 'WITH_GATEWAY'
         run: |
-          ci_run zkstack chain migrate-from-gateway --chain era --gateway-chain-name gateway
+          ci_run zkstack dev test gateway-migration --from-gateway --chain era --no-deps
 
       - name: Migrate to gateway again
         if: matrix.use_gateway_chain == 'WITH_GATEWAY'
         run: |
-          ci_run zkstack chain migrate-to-gateway --chain era --gateway-chain-name gateway
+          ci_run zkstack dev test gateway-migration --to-gateway --chain era --no-deps
+          ci_run pkill -9 zksync_server
+          ci_run zkstack server --ignore-prerequisites --chain gateway &> ${{ env.SERVER_LOGS_DIR }}/gateway.log &
+          ci_run zkstack server wait --ignore-prerequisites --verbose --chain gateway
+
 
-      - name: Build test dependencies
-        run: |
-          ci_run zkstack dev test build
 
       - name: Build tested binaries
         run: |

chains/era/ZkStack.yaml

@@ -12,3 +12,4 @@ base_token:
   nominator: 1
   denominator: 1
 wallet_creation: Localhost
+evm_emulator: false

core/Cargo.lock

@@ -40,6 +40,7 @@ members = [
   "node/external_proof_integration_api",
   "node/logs_bloom_backfill",
   "node/da_clients",
+  "node/gateway_migrator",
   "node/zk_os_tree_manager",
   # Libraries
   "lib/db_connection",
@@ -335,3 +336,4 @@ zksync_contract_verification_server = { version = "27.1.0-non-semver-compat", pa
 zksync_node_api_server = { version = "27.1.0-non-semver-compat", path = "node/api_server" }
 zksync_base_token_adjuster = { version = "27.1.0-non-semver-compat", path = "node/base_token_adjuster" }
 zksync_logs_bloom_backfill = { version = "27.1.0-non-semver-compat", path = "node/logs_bloom_backfill" }
+zksync_gateway_migrator = { version = "27.1.0-non-semver-compat", path = "node/gateway_migrator" }

core/Cargo.toml

@@ -21,6 +21,7 @@ zksync_object_store.workspace = true
 zksync_types.workspace = true
 zksync_block_reverter.workspace = true
 zksync_vlog.workspace = true
+zksync_contracts.workspace = true
 
 anyhow.workspace = true
 clap = { workspace = true, features = ["derive"] }

core/bin/block_reverter/Cargo.toml

@@ -9,24 +9,24 @@ use tokio::{
 use zksync_block_reverter::{
     eth_client::{
         clients::{Client, PKSigningClient, L1},
-        EthInterface,
+        contracts_loader::{get_settlement_layer_from_l1, load_settlement_layer_contracts},
     },
     BlockReverter, BlockReverterEthConfig, NodeRole,
 };
 use zksync_config::{
     configs::{
         chain::NetworkConfig, wallets::Wallets, BasicWitnessInputProducerConfig, DatabaseSecrets,
-        GatewayChainConfig, GeneralConfig, L1Secrets, ObservabilityConfig,
-        ProtectiveReadsWriterConfig,
+        GeneralConfig, L1Secrets, ObservabilityConfig, ProtectiveReadsWriterConfig,
     },
     ContractsConfig, DBConfig, EthConfig, GenesisConfig, PostgresConfig,
 };
+use zksync_contracts::getters_facet_contract;
 use zksync_core_leftovers::temp_config_store::read_yaml_repr;
 use zksync_dal::{ConnectionPool, Core};
 use zksync_env_config::{object_store::SnapshotsObjectStoreConfig, FromEnv};
 use zksync_object_store::ObjectStoreFactory;
 use zksync_protobuf_config::proto;
-use zksync_types::{Address, L1BatchNumber};
+use zksync_types::{settlement::SettlementLayer, Address, L1BatchNumber, L2_BRIDGEHUB_ADDRESS};
 
 #[derive(Debug, Parser)]
 #[command(author = "Matter Labs", version, about = "Block revert utility", long_about = None)]
@@ -203,7 +203,6 @@ async fn main() -> anyhow::Result<()> {
 
     let gas_adjuster = eth_sender.gas_adjuster.context("gas_adjuster")?;
     let default_priority_fee_per_gas = gas_adjuster.default_priority_fee_per_gas;
-    let settlement_mode = gas_adjuster.settlement_mode;
 
     let database_secrets = match &secrets_config {
         Some(secrets_config) => secrets_config
@@ -235,33 +234,55 @@ async fn main() -> anyhow::Result<()> {
         }
     };
 
-    let (sl_rpc_url, sl_diamond_proxy, sl_validator_timelock) = if settlement_mode.is_gateway() {
-        // Gateway config is required to be provided by file for now.
-        let gateway_chain_config: GatewayChainConfig =
-            read_yaml_repr::<proto::gateway::GatewayChainConfig>(
-                &opts
-                    .gateway_chain_path
-                    .context("Genesis config path not provided")?,
-            )
-            .context("failed decoding genesis YAML config")?;
+    let l1_client: Client<L1> = Client::http(l1_secrets.l1_rpc_url)
+        .context("Ethereum client")?
+        .build();
 
-        let gateway_url = l1_secrets
-            .gateway_rpc_url
-            .context("Gateway URL not found")?;
+    let sl_l1_contracts = load_settlement_layer_contracts(
+        &l1_client,
+        contracts.bridgehub_proxy_addr,
+        zksync_network_id,
+        None,
+    )
+    .await?
+    // If None has been returned, in case of pre v27 upgrade, use the contracts from configs
+    .unwrap_or_else(|| contracts.settlement_layer_specific_contracts());
+    let settlement_mode = get_settlement_layer_from_l1(
+        &l1_client,
+        sl_l1_contracts.chain_contracts_config.diamond_proxy_addr,
+        &getters_facet_contract(),
+    )
+    .await?;
 
-        (
-            gateway_url,
-            gateway_chain_config.diamond_proxy_addr,
-            gateway_chain_config.validator_timelock_addr,
-        )
-    } else {
-        (
-            l1_secrets.l1_rpc_url,
-            contracts.diamond_proxy_addr,
-            contracts.validator_timelock_addr,
-        )
+    let (client, contracts, chain_id) = match settlement_mode {
+        SettlementLayer::L1(chain_id) => (l1_client, sl_l1_contracts, chain_id),
+        SettlementLayer::Gateway(chain_id) => {
+            let gateway_client: Client<L1> = Client::http(
+                l1_secrets
+                    .gateway_rpc_url
+                    .context("Gateway url is not presented in config")?,
+            )
+            .context("Gateway client")?
+            .build();
+
+            let sl_contracts = load_settlement_layer_contracts(
+                &gateway_client,
+                L2_BRIDGEHUB_ADDRESS,
+                zksync_network_id,
+                None,
+            )
+            .await?
+            .context("No chain has been deployed")?;
+            (gateway_client, sl_contracts, chain_id)
+        }
     };
 
+    let sl_diamond_proxy = contracts.chain_contracts_config.diamond_proxy_addr;
+    let sl_validator_timelock = contracts
+        .ecosystem_contracts
+        .validator_timelock_addr
+        .expect("Should be presented");
+
     let config = BlockReverterEthConfig::new(
         &eth_sender,
         sl_diamond_proxy,
@@ -284,12 +305,8 @@ async fn main() -> anyhow::Result<()> {
             json,
             operator_address,
         } => {
-            let sl_client = Client::<L1>::http(sl_rpc_url)
-                .context("Ethereum client")?
-                .build();
-
             let suggested_values = block_reverter
-                .suggested_values(&sl_client, &config, operator_address)
+                .suggested_values(&client, &config, operator_address)
                 .await?;
             if json {
                 println!("{}", serde_json::to_string(&suggested_values)?);
@@ -302,7 +319,6 @@ async fn main() -> anyhow::Result<()> {
             priority_fee_per_gas,
             nonce,
         } => {
-            let sl_client = Client::http(sl_rpc_url).context("Ethereum client")?.build();
             let reverter_private_key = if let Some(wallets_config) = wallets_config {
                 wallets_config
                     .eth_sender
@@ -313,24 +329,20 @@ async fn main() -> anyhow::Result<()> {
             } else {
                 #[allow(deprecated)]
                 eth_sender
-                    .sender
+                    .get_eth_sender_config_for_sender_layer_data_layer()
                     .context("eth_sender_config")?
                     .private_key()
                     .context("eth_sender_config.private_key")?
                     .context("eth_sender_config.private_key is not set")?
             };
 
             let priority_fee_per_gas = priority_fee_per_gas.unwrap_or(default_priority_fee_per_gas);
-            let l1_chain_id = sl_client
-                .fetch_chain_id()
-                .await
-                .context("cannot fetch Ethereum chain ID")?;
             let sl_client = PKSigningClient::new_raw(
                 reverter_private_key,
                 sl_diamond_proxy,
                 priority_fee_per_gas,
-                l1_chain_id,
-                Box::new(sl_client),
+                chain_id,
+                Box::new(client),
             );
 
             block_reverter