feat: gateway preparation (#3006)

## What ❔

- adds new fields to DB tables and rust structs
- adds new config variables
- update commitment generator to work with post-gateway
- adds new vm subversion (vm fast is not changed yet)

## Why ❔

prepare for gateway, reduce sync-layer-stable diff

## 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 `zk_supervisor fmt` and `zk_supervisor
lint`.

core/bin/external_node/src/config/mod.rs

@@ -110,7 +110,12 @@ pub(crate) struct RemoteENConfig {
     // the `l2_erc20_bridge_addr` and `l2_shared_bridge_addr` are basically the same contract, but with
     // a different name, with names adapted only for consistency.
     pub l1_shared_bridge_proxy_addr: Option<Address>,
+    /// Contract address that serves as a shared bridge on L2.
+    /// It is expected that `L2SharedBridge` is used before gateway upgrade, and `L2AssetRouter` is used after.
     pub l2_shared_bridge_addr: Option<Address>,
+    /// Address of `L2SharedBridge` that was used before gateway upgrade.
+    /// `None` if chain genesis used post-gateway protocol version.
+    pub l2_legacy_shared_bridge_addr: Option<Address>,
     pub l1_erc20_bridge_proxy_addr: Option<Address>,
     pub l2_erc20_bridge_addr: Option<Address>,
     pub l1_weth_bridge_addr: Option<Address>,
@@ -189,6 +194,7 @@ impl RemoteENConfig {
             l2_erc20_bridge_addr: l2_erc20_default_bridge,
             l1_shared_bridge_proxy_addr: bridges.l1_shared_default_bridge,
             l2_shared_bridge_addr: l2_erc20_shared_bridge,
+            l2_legacy_shared_bridge_addr: bridges.l2_legacy_shared_bridge,
             l1_weth_bridge_addr: bridges.l1_weth_bridge,
             l2_weth_bridge_addr: bridges.l2_weth_bridge,
             base_token_addr,
@@ -218,6 +224,7 @@ impl RemoteENConfig {
             l1_shared_bridge_proxy_addr: Some(Address::repeat_byte(5)),
             l1_weth_bridge_addr: None,
             l2_shared_bridge_addr: Some(Address::repeat_byte(6)),
+            l2_legacy_shared_bridge_addr: Some(Address::repeat_byte(7)),
             l1_batch_commit_data_generator_mode: L1BatchCommitmentMode::Rollup,
             dummy_verifier: true,
         }
@@ -1403,6 +1410,7 @@ impl From<&ExternalNodeConfig> for InternalApiConfig {
                 l2_erc20_default_bridge: config.remote.l2_erc20_bridge_addr,
                 l1_shared_default_bridge: config.remote.l1_shared_bridge_proxy_addr,
                 l2_shared_default_bridge: config.remote.l2_shared_bridge_addr,
+                l2_legacy_shared_bridge: config.remote.l2_legacy_shared_bridge_addr,
                 l1_weth_bridge: config.remote.l1_weth_bridge_addr,
                 l2_weth_bridge: config.remote.l2_weth_bridge_addr,
             },

core/bin/external_node/src/node_builder.rs

@@ -55,6 +55,7 @@ use zksync_node_framework::{
     service::{ZkStackService, ZkStackServiceBuilder},
 };
 use zksync_state::RocksdbStorageOptions;
+use zksync_types::L2_NATIVE_TOKEN_VAULT_ADDRESS;
 
 use crate::{config::ExternalNodeConfig, metrics::framework::ExternalNodeMetricsLayer, Component};
 
@@ -192,11 +193,22 @@ impl ExternalNodeBuilder {
         // compression.
         const OPTIONAL_BYTECODE_COMPRESSION: bool = true;
 
+        let l2_shared_bridge_addr = self
+            .config
+            .remote
+            .l2_shared_bridge_addr
+            .context("Missing `l2_shared_bridge_addr`")?;
+        let l2_legacy_shared_bridge_addr = if l2_shared_bridge_addr == L2_NATIVE_TOKEN_VAULT_ADDRESS
+        {
+            // System has migrated to `L2_NATIVE_TOKEN_VAULT_ADDRESS`, use legacy shared bridge address from main node.
+            self.config.remote.l2_legacy_shared_bridge_addr
+        } else {
+            // System hasn't migrated on `L2_NATIVE_TOKEN_VAULT_ADDRESS`, we can safely use `l2_shared_bridge_addr`.
+            Some(l2_shared_bridge_addr)
+        };
+
         let persistence_layer = OutputHandlerLayer::new(
-            self.config
-                .remote
-                .l2_shared_bridge_addr
-                .expect("L2 shared bridge address is not set"),
+            l2_legacy_shared_bridge_addr,
             self.config.optional.l2_block_seal_queue_capacity,
         )
         .with_pre_insert_txs(true) // EN requires txs to be pre-inserted.

core/bin/snapshots_creator/src/tests.rs

@@ -167,6 +167,7 @@ async fn create_l2_block(
         base_fee_per_gas: 0,
         gas_per_pubdata_limit: 0,
         batch_fee_input: Default::default(),
+        pubdata_params: Default::default(),
         base_system_contracts_hashes: Default::default(),
         protocol_version: Some(Default::default()),
         virtual_blocks: 0,

core/bin/system-constants-generator/src/utils.rs

@@ -9,7 +9,7 @@ use zksync_multivm::{
     interface::{
         storage::{InMemoryStorage, StorageView, WriteStorage},
         tracer::VmExecutionStopReason,
-        L1BatchEnv, L2BlockEnv, SystemEnv, TxExecutionMode, VmExecutionMode, VmFactory,
+        InspectExecutionMode, L1BatchEnv, L2BlockEnv, SystemEnv, TxExecutionMode, VmFactory,
         VmInterface, VmInterfaceExt,
     },
     tracers::dynamic::vm_1_5_0::DynTracer,
@@ -271,8 +271,9 @@ pub(super) fn execute_internal_transfer_test() -> u32 {
         output: tracer_result.clone(),
     }
     .into_tracer_pointer();
+
     let mut vm: Vm<_, HistoryEnabled> = Vm::new(l1_batch, system_env, storage_view.to_rc_ptr());
-    let result = vm.inspect(&mut tracer.into(), VmExecutionMode::Bootloader);
+    let result = vm.inspect(&mut tracer.into(), InspectExecutionMode::Bootloader);
 
     assert!(!result.result.is_failed(), "The internal call has reverted");
     tracer_result.take()
@@ -331,7 +332,7 @@ pub(super) fn execute_user_txs_in_test_gas_vm(
     let mut total_gas_refunded = 0;
     for tx in txs {
         vm.push_transaction(tx);
-        let tx_execution_result = vm.execute(VmExecutionMode::OneTx);
+        let tx_execution_result = vm.execute(InspectExecutionMode::OneTx);
 
         total_gas_refunded += tx_execution_result.refunds.gas_refunded;
         if !accept_failure {
@@ -343,7 +344,7 @@ pub(super) fn execute_user_txs_in_test_gas_vm(
         }
     }
 
-    let result = vm.execute(VmExecutionMode::Bootloader);
+    let result = vm.execute(InspectExecutionMode::Bootloader);
     let metrics = result.get_execution_metrics(None);
 
     VmSpentResourcesResult {

core/bin/zksync_server/src/node_builder.rs

@@ -238,9 +238,7 @@ impl MainNodeBuilder {
         let wallets = self.wallets.clone();
         let sk_config = try_load_config!(self.configs.state_keeper_config);
         let persistence_layer = OutputHandlerLayer::new(
-            self.contracts_config
-                .l2_shared_bridge_addr
-                .context("L2 shared bridge address")?,
+            self.contracts_config.l2_legacy_shared_bridge_addr,
             sk_config.l2_block_seal_queue_capacity,
         )
         .with_protective_reads_persistence_enabled(sk_config.protective_reads_persistence_enabled);
@@ -249,6 +247,8 @@ impl MainNodeBuilder {
             sk_config.clone(),
             try_load_config!(self.configs.mempool_config),
             try_load_config!(wallets.state_keeper),
+            self.contracts_config.l2_da_validator_addr,
+            self.genesis_config.l1_batch_commit_data_generator_mode,
         );
         let db_config = try_load_config!(self.configs.db_config);
         let experimental_vm_config = self

core/lib/basic_types/src/commitment.rs

@@ -1,10 +1,12 @@
+use std::str::FromStr;
+
 use serde::{Deserialize, Serialize};
 use strum::{Display, EnumIter};
 
 use crate::{
     ethabi,
     web3::contract::{Detokenize, Error as ContractError},
-    U256,
+    Address, U256,
 };
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, EnumIter, Display)]
@@ -41,3 +43,23 @@ impl Detokenize for L1BatchCommitmentMode {
         }
     }
 }
+
+impl FromStr for L1BatchCommitmentMode {
+    type Err = &'static str;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "Rollup" => Ok(Self::Rollup),
+            "Validium" => Ok(Self::Validium),
+            _ => {
+                Err("Incorrect l1 batch commitment mode type; expected one of `Rollup`, `Validium`")
+            }
+        }
+    }
+}
+
+#[derive(Default, Copy, Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct PubdataParams {
+    pub l2_da_validator_address: Address,
+    pub pubdata_type: L1BatchCommitmentMode,
+}

core/lib/basic_types/src/protocol_version.rs

@@ -69,6 +69,7 @@ pub enum ProtocolVersionId {
     Version24,
     Version25,
     Version26,
+    Version27,
 }
 
 impl ProtocolVersionId {
@@ -122,6 +123,7 @@ impl ProtocolVersionId {
             ProtocolVersionId::Version24 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
             ProtocolVersionId::Version25 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
             ProtocolVersionId::Version26 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
+            ProtocolVersionId::Version27 => VmVersion::VmGateway,
         }
     }
 
@@ -139,6 +141,10 @@ impl ProtocolVersionId {
         self <= &Self::Version22
     }
 
+    pub fn is_pre_gateway(&self) -> bool {
+        self <= &Self::Version26
+    }
+
     pub fn is_1_4_0(&self) -> bool {
         self >= &ProtocolVersionId::Version18 && self < &ProtocolVersionId::Version20
     }
@@ -278,6 +284,7 @@ impl From<ProtocolVersionId> for VmVersion {
             ProtocolVersionId::Version24 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
             ProtocolVersionId::Version25 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
             ProtocolVersionId::Version26 => VmVersion::Vm1_5_0IncreasedBootloaderMemory,
+            ProtocolVersionId::Version27 => VmVersion::VmGateway,
         }
     }
 }

core/lib/basic_types/src/vm.rs

@@ -16,6 +16,7 @@ pub enum VmVersion {
     Vm1_4_2,
     Vm1_5_0SmallBootloaderMemory,
     Vm1_5_0IncreasedBootloaderMemory,
+    VmGateway,
 }
 
 impl VmVersion {

core/lib/config/src/configs/contracts.rs

@@ -29,7 +29,13 @@ pub struct ContractsConfig {
     pub diamond_proxy_addr: Address,
     pub validator_timelock_addr: Address,
     pub l1_shared_bridge_proxy_addr: Option<Address>,
+    /// Contract address that serves as a shared bridge on L2.
+    /// It is expected that `L2SharedBridge` is used before gateway upgrade, and `L2AssetRouter` is used after.
     pub l2_shared_bridge_addr: Option<Address>,
+    /// Address of `L2SharedBridge` that was used before gateway upgrade.
+    /// `None` if chain genesis used post-gateway protocol version.
+    /// If present it will be used as L2 token deployer address.
+    pub l2_legacy_shared_bridge_addr: Option<Address>,
     pub l1_erc20_bridge_proxy_addr: Option<Address>,
     pub l2_erc20_bridge_addr: Option<Address>,
     pub l1_weth_bridge_proxy_addr: Option<Address>,
@@ -40,6 +46,7 @@ pub struct ContractsConfig {
     // Used by the RPC API and by the node builder in wiring the BaseTokenRatioProvider layer.
     pub base_token_addr: Option<Address>,
     pub chain_admin_addr: Option<Address>,
+    pub l2_da_validator_addr: Option<Address>,
 }
 
 impl ContractsConfig {
@@ -53,6 +60,7 @@ impl ContractsConfig {
             l2_erc20_bridge_addr: Some(Address::repeat_byte(0x0c)),
             l1_shared_bridge_proxy_addr: Some(Address::repeat_byte(0x0e)),
             l2_shared_bridge_addr: Some(Address::repeat_byte(0x0f)),
+            l2_legacy_shared_bridge_addr: Some(Address::repeat_byte(0x19)),
             l1_weth_bridge_proxy_addr: Some(Address::repeat_byte(0x0b)),
             l2_weth_bridge_addr: Some(Address::repeat_byte(0x0c)),
             l2_testnet_paymaster_addr: Some(Address::repeat_byte(0x11)),
@@ -61,6 +69,7 @@ impl ContractsConfig {
             base_token_addr: Some(Address::repeat_byte(0x14)),
             ecosystem_contracts: Some(EcosystemContracts::for_tests()),
             chain_admin_addr: Some(Address::repeat_byte(0x18)),
+            l2_da_validator_addr: Some(Address::repeat_byte(0x1a)),
         }
     }
 }

core/lib/config/src/testonly.rs

@@ -262,13 +262,15 @@ impl Distribution<configs::ContractsConfig> for EncodeDist {
             l2_erc20_bridge_addr: self.sample_opt(|| rng.gen()),
             l1_shared_bridge_proxy_addr: self.sample_opt(|| rng.gen()),
             l2_shared_bridge_addr: self.sample_opt(|| rng.gen()),
+            l2_legacy_shared_bridge_addr: self.sample_opt(|| rng.gen()),
             l1_weth_bridge_proxy_addr: self.sample_opt(|| rng.gen()),
             l2_weth_bridge_addr: self.sample_opt(|| rng.gen()),
             l2_testnet_paymaster_addr: self.sample_opt(|| rng.gen()),
             l1_multicall3_addr: rng.gen(),
             ecosystem_contracts: self.sample(rng),
             base_token_addr: self.sample_opt(|| rng.gen()),
             chain_admin_addr: self.sample_opt(|| rng.gen()),
+            l2_da_validator_addr: self.sample_opt(|| rng.gen()),
         }
     }
 }

core/lib/constants/src/contracts.rs

@@ -135,12 +135,36 @@ pub const EVM_GAS_MANAGER_ADDRESS: Address = H160([
     0x00, 0x00, 0x80, 0x13,
 ]);
 
-/// Note, that the `Create2Factory` is explicitly deployed on a non-system-contract address.
 pub const CREATE2_FACTORY_ADDRESS: Address = H160([
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x01, 0x00, 0x00,
 ]);
 
+pub const L2_GENESIS_UPGRADE_ADDRESS: Address = H160([
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x00, 0x01,
+]);
+
+pub const L2_BRIDGEHUB_ADDRESS: Address = H160([
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x00, 0x02,
+]);
+
+pub const L2_ASSET_ROUTER_ADDRESS: Address = H160([
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x00, 0x03,
+]);
+
+pub const L2_NATIVE_TOKEN_VAULT_ADDRESS: Address = H160([
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x00, 0x04,
+]);
+
+pub const L2_MESSAGE_ROOT_ADDRESS: Address = H160([
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x01, 0x00, 0x05,
+]);
+
 pub const ERC20_TRANSFER_TOPIC: H256 = H256([
     221, 242, 82, 173, 27, 226, 200, 155, 105, 194, 176, 104, 252, 55, 141, 170, 149, 43, 167, 241,
     99, 196, 161, 22, 40, 245, 90, 77, 245, 35, 179, 239,

core/lib/constants/src/lib.rs

@@ -3,6 +3,7 @@ pub mod contracts;
 pub mod crypto;
 pub mod ethereum;
 pub mod fees;
+pub mod message_root;
 pub mod system_context;
 pub mod system_logs;
 pub mod trusted_slots;

core/lib/constants/src/message_root.rs

@@ -0,0 +1,5 @@
+// Position of `FullTree::_height` in `MessageRoot`'s storage layout.
+pub const AGG_TREE_HEIGHT_KEY: usize = 3;
+
+// Position of `FullTree::nodes` in `MessageRoot`'s storage layout.
+pub const AGG_TREE_NODES_KEY: usize = 5;

core/lib/constants/src/system_logs.rs

@@ -1,11 +1,8 @@
 /// The key of the system log with value of the L2->L1 logs tree root hash
 pub const L2_TO_L1_LOGS_TREE_ROOT_KEY: u32 = 0;
 
-/// The key of the system log with value of the state diff hash
-pub const STATE_DIFF_HASH_KEY: u32 = 2;
+/// The key of the system log with value of the state diff hash for pre-gateway protocol versions
+pub const STATE_DIFF_HASH_KEY_PRE_GATEWAY: u32 = 2;
 
-/// The key of the system log with value of the first blob linear hash
-pub const BLOB1_LINEAR_HASH_KEY: u32 = 7;
-
-/// The key of the system log with value of the second blob linear hash
-pub const BLOB2_LINEAR_HASH_KEY: u32 = 8;
+/// The key of the system log with value of the first blob linear hash for pre-gateway protocol versions
+pub const BLOB1_LINEAR_HASH_KEY_PRE_GATEWAY: u32 = 7;

core/lib/contracts/src/lib.rs

@@ -516,6 +516,13 @@ impl BaseSystemContracts {
         BaseSystemContracts::load_with_bootloader(bootloader_bytecode)
     }
 
+    pub fn playground_gateway() -> Self {
+        let bootloader_bytecode = read_zbin_bytecode(
+            "etc/multivm_bootloaders/vm_gateway/playground_batch.yul/playground_batch.yul.zbin",
+        );
+        BaseSystemContracts::load_with_bootloader(bootloader_bytecode)
+    }
+
     pub fn estimate_gas_pre_virtual_blocks() -> Self {
         let bootloader_bytecode = read_zbin_bytecode(
             "etc/multivm_bootloaders/vm_1_3_2/fee_estimate.yul/fee_estimate.yul.zbin",
@@ -586,6 +593,13 @@ impl BaseSystemContracts {
         BaseSystemContracts::load_with_bootloader(bootloader_bytecode)
     }
 
+    pub fn estimate_gas_gateway() -> Self {
+        let bootloader_bytecode = read_zbin_bytecode(
+            "etc/multivm_bootloaders/vm_gateway/fee_estimate.yul/fee_estimate.yul.zbin",
+        );
+        BaseSystemContracts::load_with_bootloader(bootloader_bytecode)
+    }
+
     pub fn hashes(&self) -> BaseSystemContractsHashes {
         BaseSystemContractsHashes {
             bootloader: self.bootloader.hash,