refactor: Reverse node framework dependency (#3986)

## What ❔

Refactors node framework as a lower-level dependency for other crates,
rather than the other way around.

## Why ❔

- Simplifies maintenance on its own.
- Opens room for future improvements, e.g. light structured concurrency
for tasks, integration with the config system etc.

## Is this a breaking change?

- [ ] Yes
- [ ] No

## Operational changes

No operational changes.

## Checklist

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

Author: slowli

core/Cargo.lock

@@ -14,7 +14,6 @@ members = [
   "bin/genesis_generator",
   "bin/zksync_tee_prover",
   # Node services
-  "node/node_framework",
   "node/proof_data_handler",
   "node/block_reverter",
   "node/commitment_generator",
@@ -60,7 +59,9 @@ members = [
   "lib/mempool",
   "lib/merkle_tree",
   "lib/mini_merkle_tree",
+  "lib/node_framework",
   "lib/node_framework_derive",
+  "lib/shared_resources",
   "lib/object_store",
   "lib/prover_interface",
   "lib/queued_job_processor",
@@ -317,8 +318,9 @@ zksync_task_management = { version = "28.2.0-non-semver-compat", path = "lib/tas
 zk_os_merkle_tree = { version = "28.2.0-non-semver-compat", path = "lib/zk_os_merkle_tree" }
 
 # Framework and components
-zksync_node_framework = { version = "28.2.0-non-semver-compat", path = "node/node_framework" }
+zksync_node_framework = { version = "28.2.0-non-semver-compat", path = "lib/node_framework" }
 zksync_node_framework_derive = { version = "28.2.0-non-semver-compat", path = "lib/node_framework_derive" }
+zksync_shared_resources = { version = "28.2.0-non-semver-compat", path = "lib/shared_resources" }
 zksync_eth_watch = { version = "28.2.0-non-semver-compat", path = "node/eth_watch" }
 zksync_shared_metrics = { version = "28.2.0-non-semver-compat", path = "node/shared_metrics" }
 zksync_proof_data_handler = { version = "28.2.0-non-semver-compat", path = "node/proof_data_handler" }

core/Cargo.toml

@@ -14,24 +14,27 @@ publish = false
 [dependencies]
 zksync_core_leftovers.workspace = true
 zksync_commitment_generator.workspace = true
-zksync_dal.workspace = true
-zksync_db_connection.workspace = true
+zksync_dal = { workspace = true, features = ["node_framework"] }
 zksync_config.workspace = true
 zksync_protobuf_config.workspace = true
 zksync_env_config.workspace = true
-zksync_eth_client.workspace = true
+zksync_eth_client = { workspace = true, features = ["node_framework"] }
 zksync_storage.workspace = true
 zksync_state.workspace = true
 zksync_contracts.workspace = true
 zksync_l1_contract_interface.workspace = true
 zksync_snapshots_applier.workspace = true
-zksync_object_store.workspace = true
-zksync_health_check.workspace = true
-zksync_web3_decl.workspace = true
+zksync_object_store = { workspace = true, features = ["node_framework"] }
+zksync_health_check = { workspace = true, features = ["node_framework"] }
+zksync_web3_decl = { workspace = true, features = ["node_framework"] }
 zksync_types.workspace = true
 zksync_block_reverter.workspace = true
+zksync_da_clients.workspace = true
+zksync_gateway_migrator.workspace = true
+zksync_logs_bloom_backfill.workspace = true
 zksync_node_genesis.workspace = true
 zksync_node_fee_model.workspace = true
+zksync_node_storage_init.workspace = true
 zksync_node_db_pruner.workspace = true
 zksync_eth_sender.workspace = true
 zksync_state_keeper.workspace = true
@@ -42,7 +45,7 @@ zksync_node_sync.workspace = true
 zksync_node_api_server.workspace = true
 zksync_node_consensus.workspace = true
 zksync_node_framework.workspace = true
-zksync_vlog.workspace = true
+zksync_vlog = { workspace = true, features = ["node_framework"] }
 
 zksync_concurrency.workspace = true
 zksync_consensus_roles.workspace = true

core/bin/external_node/Cargo.toml

@@ -976,9 +976,9 @@ impl OptionalENConfig {
         Duration::from_secs(self.pruning_data_retention_sec)
     }
 
-    pub fn bridge_addresses_refresh_interval(&self) -> Option<Duration> {
+    pub fn bridge_addresses_refresh_interval(&self) -> Duration {
         self.bridge_addresses_refresh_interval_sec
-            .map(|n| Duration::from_secs(n.get()))
+            .map_or_else(|| Duration::from_secs(30), |n| Duration::from_secs(n.get()))
     }
 
     #[cfg(test)]

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

@@ -1,8 +1,10 @@
 use std::time::Duration;
 
-use zksync_dal::{ConnectionPool, Core, CoreDal as _};
+use zksync_dal::{
+    node::{MasterPool, PoolResource},
+    ConnectionPool, Core, CoreDal as _,
+};
 use zksync_node_framework::{
-    implementations::resources::pools::{MasterPool, PoolResource},
     FromContext, IntoContext, StopReceiver, Task, TaskId, WiringError, WiringLayer,
 };
 use zksync_types::{L1ChainId, L2ChainId, SLChainId};

core/bin/external_node/src/metrics/framework.rs

@@ -2,7 +2,8 @@
 //! as well as an interface to run the node with the specified components.
 
 use anyhow::{bail, Context as _};
-use zksync_block_reverter::NodeRole;
+use zksync_block_reverter::{node::BlockReverterLayer, NodeRole};
+use zksync_commitment_generator::node::CommitmentGeneratorLayer;
 use zksync_config::{
     configs::{
         api::{HealthCheckConfig, MerkleTreeApiConfig},
@@ -12,59 +13,45 @@ use zksync_config::{
     },
     DAClientConfig, PostgresConfig,
 };
+use zksync_consistency_checker::node::ConsistencyCheckerLayer;
+use zksync_da_clients::node::{
+    AvailWiringLayer, CelestiaWiringLayer, EigenWiringLayer, NoDAClientWiringLayer,
+    ObjectStorageClientWiringLayer,
+};
+use zksync_dal::node::{PoolsLayerBuilder, PostgresMetricsLayer};
+use zksync_eth_client::node::BridgeAddressesUpdaterLayer;
+use zksync_gateway_migrator::node::SettlementLayerData;
+use zksync_logs_bloom_backfill::node::LogsBloomBackfillLayer;
 use zksync_metadata_calculator::{
+    node::{MetadataCalculatorLayer, TreeApiClientLayer, TreeApiServerLayer},
     MerkleTreeReaderConfig, MetadataCalculatorConfig, MetadataCalculatorRecoveryConfig,
 };
-use zksync_node_api_server::web3::{state::InternalApiConfigBase, Namespace};
-use zksync_node_framework::{
-    implementations::layers::{
-        batch_status_updater::BatchStatusUpdaterLayer,
-        block_reverter::BlockReverterLayer,
-        commitment_generator::CommitmentGeneratorLayer,
-        consensus::ExternalNodeConsensusLayer,
-        consistency_checker::ConsistencyCheckerLayer,
-        da_clients::{
-            avail::AvailWiringLayer, celestia::CelestiaWiringLayer, eigen::EigenWiringLayer,
-            no_da::NoDAClientWiringLayer, object_store::ObjectStorageClientWiringLayer,
-        },
-        data_availability_fetcher::DataAvailabilityFetcherLayer,
-        healtcheck_server::HealthCheckLayer,
-        logs_bloom_backfill::LogsBloomBackfillLayer,
-        main_node_client::MainNodeClientLayer,
-        main_node_fee_params_fetcher::MainNodeFeeParamsFetcherLayer,
-        metadata_calculator::{MetadataCalculatorLayer, TreeApiServerLayer},
-        node_storage_init::{
-            external_node_strategy::{ExternalNodeInitStrategyLayer, SnapshotRecoveryConfig},
-            NodeStorageInitializerLayer,
-        },
-        pools_layer::PoolsLayerBuilder,
-        postgres::PostgresLayer,
-        prometheus_exporter::PrometheusExporterLayer,
-        pruning::PruningLayer,
-        query_eth_client::QueryEthClientLayer,
-        reorg_detector::ReorgDetectorLayer,
-        settlement_layer_client::SettlementLayerClientLayer,
-        settlement_layer_data,
-        settlement_layer_data::SettlementLayerData,
-        sigint::SigintHandlerLayer,
-        state_keeper::{
-            external_io::ExternalIOLayer, main_batch_executor::MainBatchExecutorLayer,
-            output_handler::OutputHandlerLayer, StateKeeperLayer,
-        },
-        sync_state_updater::SyncStateUpdaterLayer,
-        tree_data_fetcher::TreeDataFetcherLayer,
-        validate_chain_ids::ValidateChainIdsLayer,
-        web3_api::{
-            caches::MempoolCacheLayer,
-            server::{Web3ServerLayer, Web3ServerOptionalConfig},
-            tree_api_client::TreeApiClientLayer,
-            tx_sender::{PostgresStorageCachesConfig, TxSenderLayer},
-            tx_sink::ProxySinkLayer,
-        },
+use zksync_node_api_server::{
+    node::{
+        HealthCheckLayer, MempoolCacheLayer, PostgresStorageCachesConfig, ProxySinkLayer,
+        TxSenderLayer, Web3ServerLayer, Web3ServerOptionalConfig,
     },
-    service::{ZkStackService, ZkStackServiceBuilder},
+    web3::{state::InternalApiConfigBase, Namespace},
+};
+use zksync_node_consensus::node::ExternalNodeConsensusLayer;
+use zksync_node_db_pruner::node::PruningLayer;
+use zksync_node_fee_model::node::MainNodeFeeParamsFetcherLayer;
+use zksync_node_framework::service::{ZkStackService, ZkStackServiceBuilder};
+use zksync_node_storage_init::{
+    node::{external_node_strategy::ExternalNodeInitStrategyLayer, NodeStorageInitializerLayer},
+    SnapshotRecoveryConfig,
 };
+use zksync_node_sync::node::{
+    BatchStatusUpdaterLayer, DataAvailabilityFetcherLayer, ExternalIOLayer, SyncStateUpdaterLayer,
+    TreeDataFetcherLayer, ValidateChainIdsLayer,
+};
+use zksync_reorg_detector::node::ReorgDetectorLayer;
 use zksync_state::RocksdbStorageOptions;
+use zksync_state_keeper::node::{MainBatchExecutorLayer, OutputHandlerLayer, StateKeeperLayer};
+use zksync_vlog::node::{PrometheusExporterLayer, SigintHandlerLayer};
+use zksync_web3_decl::node::{
+    MainNodeClientLayer, QueryEthClientLayer, SettlementLayerClientLayer,
+};
 
 use crate::{config::ExternalNodeConfig, metrics::framework::ExternalNodeMetricsLayer, Component};
 
@@ -131,7 +118,7 @@ impl ExternalNodeBuilder {
     }
 
     fn add_postgres_layer(mut self) -> anyhow::Result<Self> {
-        self.node.add_layer(PostgresLayer);
+        self.node.add_layer(PostgresMetricsLayer);
         Ok(self)
     }
 
@@ -150,14 +137,15 @@ impl ExternalNodeBuilder {
     }
 
     fn add_settlement_layer_data(mut self) -> anyhow::Result<Self> {
-        self.node
-            .add_layer(SettlementLayerData::new(settlement_layer_data::ENConfig {
+        self.node.add_layer(SettlementLayerData::new(
+            zksync_gateway_migrator::node::ENConfig {
                 l1_specific_contracts: self.config.l1_specific_contracts(),
                 l1_chain_contracts: self.config.l1_settelment_contracts(),
                 l2_contracts: self.config.l2_contracts(),
                 chain_id: self.config.required.l2_chain_id,
                 gateway_rpc_url: self.config.optional.gateway_url.clone(),
-            }));
+            },
+        ));
         Ok(self)
     }
 
@@ -315,8 +303,7 @@ impl ExternalNodeBuilder {
     }
 
     fn add_batch_status_updater_layer(mut self) -> anyhow::Result<Self> {
-        let layer = BatchStatusUpdaterLayer;
-        self.node.add_layer(layer);
+        self.node.add_layer(BatchStatusUpdaterLayer);
         Ok(self)
     }
 
@@ -365,7 +352,6 @@ impl ExternalNodeBuilder {
 
     fn add_data_availability_fetcher_layer(mut self) -> anyhow::Result<Self> {
         self.node.add_layer(DataAvailabilityFetcherLayer);
-
         Ok(self)
     }
 
@@ -506,6 +492,13 @@ impl ExternalNodeBuilder {
         Ok(self)
     }
 
+    fn add_bridge_addresses_updater_layer(mut self) -> anyhow::Result<Self> {
+        self.node.add_layer(BridgeAddressesUpdaterLayer {
+            refresh_interval: self.config.optional.bridge_addresses_refresh_interval(),
+        });
+        Ok(self)
+    }
+
     fn web3_api_optional_config(&self) -> Web3ServerOptionalConfig {
         // The refresh interval should be several times lower than the pruning removal delay, so that
         // soft-pruning will timely propagate to the API server.
@@ -519,10 +512,6 @@ impl ExternalNodeBuilder {
             response_body_size_limit: Some(self.config.optional.max_response_body_size()),
             with_extended_tracing: self.config.optional.extended_rpc_tracing,
             pruning_info_refresh_interval: Some(pruning_info_refresh_interval),
-            bridge_addresses_refresh_interval: self
-                .config
-                .optional
-                .bridge_addresses_refresh_interval(),
             polling_interval: Some(self.config.optional.polling_interval()),
             websocket_requests_per_minute_limit: None, // To be set by WS server layer method if required.
             replication_lag_limit: None,               // TODO: Support replication lag limit
@@ -661,6 +650,7 @@ impl ExternalNodeBuilder {
                 Component::HttpApi => {
                     self = self
                         .add_sync_state_updater_layer()?
+                        .add_bridge_addresses_updater_layer()?
                         .add_mempool_cache_layer()?
                         .add_tree_api_client_layer()?
                         .add_main_node_fee_params_fetcher_layer()?
@@ -670,6 +660,7 @@ impl ExternalNodeBuilder {
                 Component::WsApi => {
                     self = self
                         .add_sync_state_updater_layer()?
+                        .add_bridge_addresses_updater_layer()?
                         .add_mempool_cache_layer()?
                         .add_tree_api_client_layer()?
                         .add_main_node_fee_params_fetcher_layer()?

core/bin/external_node/src/node_builder.rs

@@ -1,27 +1,20 @@
 use std::sync::Arc;
 
 use tokio::sync::oneshot;
-use zksync_health_check::AppHealthCheck;
+use zksync_health_check::{node::AppHealthCheckResource, AppHealthCheck};
 use zksync_node_framework::{
-    implementations::{
-        layers::{
-            main_node_client::MainNodeClientLayer, query_eth_client::QueryEthClientLayer,
-            settlement_layer_client::SettlementLayerClientLayer, sigint::SigintHandlerLayer,
-        },
-        resources::{
-            eth_interface::{
-                EthInterfaceResource, SettlementLayerClient, SettlementLayerClientResource,
-            },
-            healthcheck::AppHealthCheckResource,
-            main_node_client::MainNodeClientResource,
-        },
-    },
-    service::ServiceContext,
-    task::TaskKind,
-    FromContext, IntoContext, StopReceiver, Task, TaskId, WiringError, WiringLayer,
+    service::ServiceContext, task::TaskKind, FromContext, IntoContext, StopReceiver, Task, TaskId,
+    WiringError, WiringLayer,
 };
 use zksync_types::{L1ChainId, L2ChainId};
-use zksync_web3_decl::client::{MockClient, L1, L2};
+use zksync_vlog::node::SigintHandlerLayer;
+use zksync_web3_decl::{
+    client::{MockClient, L1, L2},
+    node::{
+        EthInterfaceResource, MainNodeClientLayer, MainNodeClientResource, QueryEthClientLayer,
+        SettlementLayerClient, SettlementLayerClientLayer,
+    },
+};
 
 use super::ExternalNodeBuilder;
 
@@ -174,16 +167,14 @@ struct MockSettlementLayerClientLayer {
 #[async_trait::async_trait]
 impl WiringLayer for MockSettlementLayerClientLayer {
     type Input = ();
-    type Output = SettlementLayerClientResource;
+    type Output = SettlementLayerClient;
 
     fn layer_name(&self) -> &'static str {
         // We don't care about values, we just want to hijack the layer name.
         SettlementLayerClientLayer::new("https://example.com".parse().unwrap(), None).layer_name()
     }
 
     async fn wire(self, _: Self::Input) -> Result<Self::Output, WiringError> {
-        Ok(SettlementLayerClientResource(SettlementLayerClient::L1(
-            Box::new(self.client),
-        )))
+        Ok(SettlementLayerClient::L1(Box::new(self.client)))
     }
 }

core/bin/external_node/src/tests/framework.rs

@@ -52,7 +52,7 @@ async fn external_node_basics(components_str: &'static str) {
             );
 
             let node = node.build(env.components.0.into_iter().collect())?;
-            node.run(None)?;
+            node.run(())?;
             anyhow::Ok(())
         })
         .join()
@@ -124,7 +124,7 @@ async fn node_reacts_to_stop_signal_during_initial_reorg_detection() {
             );
 
             let node = node.build(env.components.0.into_iter().collect())?;
-            node.run(None)?;
+            node.run(())?;
             anyhow::Ok(())
         })
         .join()

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

@@ -2,8 +2,7 @@ use std::sync::Arc;
 
 use tempfile::TempDir;
 use tokio::sync::oneshot;
-use zksync_dal::{ConnectionPoolBuilder, Core, CoreDal};
-use zksync_db_connection::connection_pool::TestTemplate;
+use zksync_dal::{ConnectionPool, CoreDal};
 use zksync_eth_client::clients::MockSettlementLayer;
 use zksync_health_check::AppHealthCheck;
 use zksync_node_genesis::{insert_genesis_batch, GenesisBatchParams, GenesisParams};
@@ -56,10 +55,7 @@ impl TestEnvironment {
 
         // Simplest case to mock: the EN already has a genesis L1 batch / L2 block, and it's the only L1 batch / L2 block
         // in the network.
-        let test_db: ConnectionPoolBuilder<Core> =
-            TestTemplate::empty().unwrap().create_db(100).await.unwrap();
-        let connection_pool = test_db.build().await.unwrap();
-        // let singleton_pool_builder = ConnectionPool::singleton(connection_pool.database_url().clone());
+        let connection_pool = ConnectionPool::test_pool().await;
         let mut storage = connection_pool.connection().await.unwrap();
         let genesis_params = insert_genesis_batch(&mut storage, &GenesisParams::mock())
             .await