feat: Base Token Fundamentals

Cargo.toml

@@ -32,6 +32,7 @@ members = [
     "core/node/contract_verification_server",
     "core/node/api_server",
     "core/node/tee_verifier_input_producer",
+    "core/node/base_token_adjuster",
     # Libraries
     "core/lib/db_connection",
     "core/lib/zksync_core_leftovers",
@@ -65,6 +66,7 @@ members = [
     "core/lib/web3_decl",
     "core/lib/snapshots_applier",
     "core/lib/crypto_primitives",
+    "core/lib/external_price_api",
     # Test infrastructure
     "core/tests/test_account",
     "core/tests/loadnext",
@@ -260,3 +262,4 @@ zksync_node_consensus = { path = "core/node/consensus" }
 zksync_contract_verification_server = { path = "core/node/contract_verification_server" }
 zksync_node_api_server = { path = "core/node/api_server" }
 zksync_tee_verifier_input_producer = { path = "core/node/tee_verifier_input_producer" }
+zksync_base_token_adjuster = {path = "core/node/base_token_adjuster"}

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

@@ -1332,7 +1332,7 @@ impl From<&ExternalNodeConfig> for InternalApiConfig {
             l2_testnet_paymaster_addr: config.remote.l2_testnet_paymaster_addr,
             req_entities_limit: config.optional.req_entities_limit,
             fee_history_limit: config.optional.fee_history_limit,
-            base_token_address: Some(config.remote.base_token_addr),
+            base_token_address: config.remote.base_token_addr,
             filters_disabled: config.optional.filters_disabled,
             dummy_verifier: config.remote.dummy_verifier,
             l1_batch_commit_data_generator_mode: config.remote.l1_batch_commit_data_generator_mode,

core/bin/zksync_server/src/main.rs

@@ -16,8 +16,9 @@ use zksync_config::{
         L1Secrets, ObservabilityConfig, PrometheusConfig, ProofDataHandlerConfig,
         ProtectiveReadsWriterConfig, Secrets,
     },
-    ApiConfig, ContractVerifierConfig, DBConfig, EthConfig, EthWatchConfig, GasAdjusterConfig,
-    GenesisConfig, ObjectStoreConfig, PostgresConfig, SnapshotsCreatorConfig,
+    ApiConfig, BaseTokenAdjusterConfig, ContractVerifierConfig, DBConfig, EthConfig,
+    EthWatchConfig, GasAdjusterConfig, GenesisConfig, ObjectStoreConfig, PostgresConfig,
+    SnapshotsCreatorConfig,
 };
 use zksync_core_leftovers::{
     genesis_init, is_genesis_needed,
@@ -47,7 +48,7 @@ struct Cli {
     /// Comma-separated list of components to launch.
     #[arg(
         long,
-        default_value = "api,tree,eth,state_keeper,housekeeper,tee_verifier_input_producer,commitment_generator"
+        default_value = "api,tree,eth,state_keeper,housekeeper,tee_verifier_input_producer,commitment_generator,base_token_adjuster"
     )]
     components: ComponentsToRun,
     /// Path to the yaml config. If set, it will be used instead of env vars.
@@ -270,6 +271,7 @@ fn load_env_config() -> anyhow::Result<TempConfigStore> {
         snapshot_creator: SnapshotsCreatorConfig::from_env().ok(),
         protective_reads_writer_config: ProtectiveReadsWriterConfig::from_env().ok(),
         core_object_store: ObjectStoreConfig::from_env().ok(),
+        base_token_adjuster_config: BaseTokenAdjusterConfig::from_env().ok(),
         commitment_generator: None,
         pruning: None,
         snapshot_recovery: None,

core/bin/zksync_server/src/node_builder.rs

@@ -14,6 +14,7 @@ use zksync_node_api_server::{
 };
 use zksync_node_framework::{
     implementations::layers::{
+        base_token_adjuster::BaseTokenAdjusterLayer,
         circuit_breaker_checker::CircuitBreakerCheckerLayer,
         commitment_generator::CommitmentGeneratorLayer,
         consensus::{ConsensusLayer, Mode as ConsensusMode},
@@ -145,11 +146,14 @@ impl MainNodeBuilder {
             .context("Gas adjuster")?;
         let state_keeper_config = try_load_config!(self.configs.state_keeper_config);
         let eth_sender_config = try_load_config!(self.configs.eth);
+        let base_token_adjuster_config = try_load_config!(self.configs.base_token_adjuster);
         let sequencer_l1_gas_layer = SequencerL1GasLayer::new(
             gas_adjuster_config,
             self.genesis_config.clone(),
             state_keeper_config,
             try_load_config!(eth_sender_config.sender).pubdata_sending_mode,
+            base_token_adjuster_config,
+            self.contracts_config.base_token_addr,
         );
         self.node.add_layer(sequencer_l1_gas_layer);
         Ok(self)
@@ -455,6 +459,16 @@ impl MainNodeBuilder {
         Ok(self)
     }
 
+    fn add_base_token_adjuster_layer(mut self) -> anyhow::Result<Self> {
+        let config = try_load_config!(self.configs.base_token_adjuster);
+        self.node.add_layer(BaseTokenAdjusterLayer::new(
+            self.contracts_config.base_token_addr,
+            config,
+        ));
+
+        Ok(self)
+    }
+
     pub fn build(mut self, mut components: Vec<Component>) -> anyhow::Result<ZkStackService> {
         // Add "base" layers (resources and helper tasks).
         self = self
@@ -542,6 +556,9 @@ impl MainNodeBuilder {
                 Component::VmRunnerProtectiveReads => {
                     self = self.add_vm_runner_protective_reads_layer()?;
                 }
+                Component::BaseTokenAdjuster => {
+                    self = self.add_base_token_adjuster_layer()?;
+                }
             }
         }
         Ok(self.node.build()?)

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

@@ -0,0 +1,27 @@
+use std::time::Duration;
+
+use serde::Deserialize;
+
+// By default external APIs shall be polled every 30 seconds for a new price.
+pub const DEFAULT_INTERVAL_MS: u64 = 30_000;
+
+#[derive(Debug, Clone, PartialEq, Deserialize)]
+pub struct BaseTokenAdjusterConfig {
+    /// How often to fetch external APIs for a new ETH<->Base-Token price.
+    pub price_polling_interval_ms: Option<u64>,
+}
+
+impl BaseTokenAdjusterConfig {
+    pub fn for_tests() -> Self {
+        Self {
+            price_polling_interval_ms: Some(DEFAULT_INTERVAL_MS),
+        }
+    }
+
+    pub fn price_polling_interval(&self) -> Duration {
+        match self.price_polling_interval_ms {
+            Some(interval) => Duration::from_millis(interval),
+            None => Duration::from_millis(DEFAULT_INTERVAL_MS),
+        }
+    }
+}

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

@@ -37,7 +37,9 @@ pub struct ContractsConfig {
     pub l2_testnet_paymaster_addr: Option<Address>,
     pub l1_multicall3_addr: Address,
     pub ecosystem_contracts: Option<EcosystemContracts>,
-    pub base_token_addr: Option<Address>,
+    // Used for the RPC API and by the BaseTokenAdjuster. If not set, ETH is the chain's base token
+    // and the "ETH address" is SHARED_BRIDGE_ETHER_TOKEN_ADDRESS.
+    pub base_token_addr: Address,
 }
 
 impl ContractsConfig {
@@ -56,7 +58,7 @@ impl ContractsConfig {
             l2_testnet_paymaster_addr: Some(Address::repeat_byte(0x11)),
             l1_multicall3_addr: Address::repeat_byte(0x12),
             governance_addr: Address::repeat_byte(0x13),
-            base_token_addr: Some(Address::repeat_byte(0x14)),
+            base_token_addr: Address::repeat_byte(0x14),
             ecosystem_contracts: Some(EcosystemContracts::for_tests()),
         }
     }

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

@@ -1,5 +1,6 @@
 use crate::{
     configs::{
+        base_token_adjuster::BaseTokenAdjusterConfig,
         chain::{CircuitBreakerConfig, MempoolConfig, OperationsManagerConfig, StateKeeperConfig},
         fri_prover_group::FriProverGroupConfig,
         house_keeper::HouseKeeperConfig,
@@ -41,4 +42,5 @@ pub struct GeneralConfig {
     pub snapshot_recovery: Option<SnapshotRecoveryConfig>,
     pub pruning: Option<PruningConfig>,
     pub core_object_store: Option<ObjectStoreConfig>,
+    pub base_token_adjuster: Option<BaseTokenAdjusterConfig>,
 }

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

@@ -1,6 +1,7 @@
 // Public re-exports
 pub use self::{
     api::ApiConfig,
+    base_token_adjuster::BaseTokenAdjusterConfig,
     commitment_generator::CommitmentGeneratorConfig,
     contract_verifier::ContractVerifierConfig,
     contracts::{ContractsConfig, EcosystemContracts},
@@ -27,6 +28,7 @@ pub use self::{
 };
 
 pub mod api;
+pub mod base_token_adjuster;
 pub mod chain;
 mod commitment_generator;
 pub mod consensus;

core/lib/config/src/lib.rs

@@ -1,8 +1,9 @@
 #![allow(clippy::upper_case_acronyms, clippy::derive_partial_eq_without_eq)]
 
 pub use crate::configs::{
-    ApiConfig, ContractVerifierConfig, ContractsConfig, DBConfig, EthConfig, EthWatchConfig,
-    GasAdjusterConfig, GenesisConfig, ObjectStoreConfig, PostgresConfig, SnapshotsCreatorConfig,
+    ApiConfig, BaseTokenAdjusterConfig, ContractVerifierConfig, ContractsConfig, DBConfig,
+    EthConfig, EthWatchConfig, GasAdjusterConfig, GenesisConfig, ObjectStoreConfig, PostgresConfig,
+    SnapshotsCreatorConfig,
 };
 
 pub mod configs;

core/lib/dal/migrations/20240611121747_add_base_token_ratio_table.down.sql

@@ -0,0 +1 @@
+DROP TABLE IF EXISTS base_token_ratios;

core/lib/dal/migrations/20240611121747_add_base_token_ratio_table.up.sql

@@ -0,0 +1,11 @@
+CREATE TABLE base_token_ratios (
+    id SERIAL PRIMARY KEY,
+    created_at TIMESTAMP NOT NULL,
+    updated_at TIMESTAMP NOT NULL,
+
+    ratio_timestamp TIMESTAMP NOT NULL,
+    numerator NUMERIC NOT NULL,
+    denominator NUMERIC NOT NULL,
+
+    used_in_l1 BOOLEAN NOT NULL DEFAULT FALSE
+);