fix: export only the necessary types from root crate

Author: 0xNeshi

examples/sync_from_latest_scanning/main.rs

@@ -1,9 +1,6 @@
 use alloy::{network::Ethereum, providers::ProviderBuilder, sol, sol_types::SolEvent};
 use alloy_node_bindings::Anvil;
-use event_scanner::{
-    EventFilter,
-    event_scanner::{EventScannerBuilder, Message},
-};
+use event_scanner::{EventFilter, EventScannerBuilder, Message};
 
 use tokio_stream::StreamExt;
 use tracing::{error, info};

src/event_scanner/scanner.rs

@@ -212,6 +212,7 @@ impl EventScannerBuilder<Unspecified> {
     ///
     /// This method returns a builder that must be further narrowed down:
     /// ```rust,no_run
+    /// # use event_scanner::EventScannerBuilder;
     /// // Sync from block mode
     /// EventScannerBuilder::sync().from_block(1_000_000);
     /// // Sync from latest events mode

src/event_scanner/scanner/sync.rs

@@ -25,14 +25,14 @@ impl EventScannerBuilder<Synchronize> {
     ///
     /// ```no_run
     /// # use alloy::network::Ethereum;
-    /// # use event_scanner::{EventFilter, EventScanner, Message};
+    /// # use event_scanner::{EventFilter, EventScannerBuilder, Message};
     /// # use tokio_stream::StreamExt;
     /// #
     /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
     /// # let ws_url = "ws://localhost:8545".parse()?;
     /// # let contract_address = alloy::primitives::address!("0xd8dA6BF26964af9d7eed9e03e53415d37aa96045");
     /// // Fetch the latest 10 events, then stream new events continuously
-    /// let mut scanner = EventScanner::sync()
+    /// let mut scanner = EventScannerBuilder::sync()
     ///     .from_latest(10)
     ///     .connect_ws::<Ethereum>(ws_url)
     ///     .await?;

src/lib.rs

@@ -1,11 +1,16 @@
 pub mod block_range_scanner;
-pub mod error;
-pub mod event_scanner;
+
 #[cfg(any(test, feature = "test-utils"))]
 pub mod test_utils;
-pub mod types;
+
+mod error;
+mod event_scanner;
+mod types;
 
 pub use error::ScannerError;
 pub use types::{ScannerMessage, ScannerStatus};
 
-pub use event_scanner::{EventFilter, EventScannerBuilder, Message};
+pub use event_scanner::{
+    EventFilter, EventScanner, EventScannerBuilder, Historic, LatestEvents, Live, Message,
+    SyncFromBlock, SyncFromLatestEvents,
+};

tests/common.rs

@@ -15,11 +15,8 @@ use alloy::{
 };
 use alloy_node_bindings::{Anvil, AnvilInstance};
 use event_scanner::{
-    EventFilter, EventScannerBuilder, Message,
-    event_scanner::{
-        EventScanner, Historic, LatestEvents, Live, SyncFromBlock, SyncFromLatestEvents,
-    },
-    test_utils::LogMetadata,
+    EventFilter, EventScanner, EventScannerBuilder, Historic, LatestEvents, Live, Message,
+    SyncFromBlock, SyncFromLatestEvents, test_utils::LogMetadata,
 };
 use tokio_stream::wrappers::ReceiverStream;
 

tests/historic_to_live/basic.rs

@@ -1,5 +1,5 @@
 use alloy::{eips::BlockNumberOrTag, primitives::U256};
-use event_scanner::{assert_next, types::ScannerStatus};
+use event_scanner::{ScannerStatus, assert_next};
 
 use crate::common::{TestCounter, setup_sync_scanner};
 

tests/historic_to_live/from_latest.rs

@@ -1,7 +1,7 @@
 use alloy::providers::ext::AnvilApi;
 
 use crate::common::{TestCounter, TestCounterExt, setup_sync_from_latest_scanner};
-use event_scanner::{assert_next, test_utils::LogMetadata, types::ScannerStatus};
+use event_scanner::{ScannerStatus, assert_next, test_utils::LogMetadata};
 
 #[tokio::test]
 async fn scan_latest_then_live_happy_path_no_duplicates() -> anyhow::Result<()> {

tests/historic_to_live/reorg.rs

@@ -1,7 +1,7 @@
 use std::{sync::Arc, time::Duration};
 
 use alloy::{eips::BlockNumberOrTag, providers::ext::AnvilApi};
-use event_scanner::{Message, types::ScannerStatus};
+use event_scanner::{Message, ScannerStatus};
 use tokio::{sync::Mutex, time::timeout};
 use tokio_stream::StreamExt;