ref: handle to token

Author: LeoPatOZ

README.md

@@ -87,11 +87,11 @@ async fn run_scanner(
 
     let subscription = scanner.subscribe(filter);
 
-    // Start the scanner and get the handle
-    let handle = scanner.start().await?;
+    // Start the scanner and get the token
+    let token = scanner.start().await?;
 
-    // Access the stream using the handle
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token
+    let mut stream = subscription.stream(&token);
 
     // Process messages from the stream
     while let Some(message) = stream.next().await {

examples/historical_scanning/main.rs

@@ -65,10 +65,10 @@ async fn main() -> anyhow::Result<()> {
 
     let subscription = scanner.subscribe(increase_filter);
 
-    let handle = scanner.start().await.expect("failed to start scanner");
+    let token = scanner.start().await.expect("failed to start scanner");
 
-    // Access the stream using the handle (proves scanner is started)
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token (proves scanner is started)
+    let mut stream = subscription.stream(&token);
 
     while let Some(message) = stream.next().await {
         match message {

examples/latest_events_scanning/main.rs

@@ -66,10 +66,10 @@ async fn main() -> anyhow::Result<()> {
         _ = counter_contract.increase().send().await?;
     }
 
-    let handle = scanner.start().await?;
+    let token = scanner.start().await?;
 
-    // Access the stream using the handle (proves scanner is started)
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token (proves scanner is started)
+    let mut stream = subscription.stream(&token);
 
     while let Some(message) = stream.next().await {
         match message {

examples/live_scanning/main.rs

@@ -63,10 +63,10 @@ async fn main() -> anyhow::Result<()> {
 
     let subscription = scanner.subscribe(increase_filter);
 
-    let handle = scanner.start().await.expect("failed to start scanner");
+    let token = scanner.start().await.expect("failed to start scanner");
 
-    // Access the stream using the handle (proves scanner is started)
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token (proves scanner is started)
+    let mut stream = subscription.stream(&token);
 
     _ = counter_contract.increase().send().await?;
 

examples/sync_from_block_scanning/main.rs

@@ -72,10 +72,10 @@ async fn main() -> anyhow::Result<()> {
     let subscription = scanner.subscribe(increase_filter);
 
     info!("Starting sync scanner...");
-    let handle = scanner.start().await.expect("failed to start scanner");
+    let token = scanner.start().await.expect("failed to start scanner");
 
-    // Access the stream using the handle (proves scanner is started)
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token (proves scanner is started)
+    let mut stream = subscription.stream(&token);
 
     info!("Creating live events...");
     for i in 0..2 {

examples/sync_from_latest_scanning/main.rs

@@ -67,10 +67,10 @@ async fn main() -> anyhow::Result<()> {
         _ = counter_contract.increase().send().await?;
     }
 
-    let handle = client.start().await.expect("failed to start scanner");
+    let token = client.start().await.expect("failed to start scanner");
 
-    // Access the stream using the handle (proves scanner is started)
-    let mut stream = subscription.stream(&handle);
+    // Access the stream using the token (proves scanner is started)
+    let mut stream = subscription.stream(&token);
 
     // emit some events for live mode to pick up
     _ = counter_contract.increase().send().await?;

src/event_scanner/mod.rs

@@ -10,4 +10,4 @@ pub use scanner::{
     EventScanner, EventScannerBuilder, Historic, LatestEvents, Live, SyncFromBlock,
     SyncFromLatestEvents,
 };
-pub use stream::{EventSubscription, ScannerHandle};
+pub use stream::{EventSubscription, ScannerToken};

src/event_scanner/scanner/historic.rs

@@ -8,7 +8,7 @@ use super::common::{ConsumerMode, handle_stream};
 use crate::{
     EventScannerBuilder, ScannerError,
     event_scanner::{
-        ScannerHandle,
+        ScannerToken,
         scanner::{EventScanner, Historic},
     },
     robust_provider::IntoRobustProvider,
@@ -87,7 +87,7 @@ impl<N: Network> EventScanner<Historic, N> {
     /// Can error out if the service fails to start.
     ///
     /// [subscribe]: EventScanner::subscribe
-    pub async fn start(self) -> Result<ScannerHandle, ScannerError> {
+    pub async fn start(self) -> Result<ScannerToken, ScannerError> {
         let client = self.block_range_scanner.run()?;
         let stream = client.stream_historical(self.config.from_block, self.config.to_block).await?;
 
@@ -98,7 +98,7 @@ impl<N: Network> EventScanner<Historic, N> {
             handle_stream(stream, &provider, &listeners, ConsumerMode::Stream).await;
         });
 
-        Ok(ScannerHandle::new())
+        Ok(ScannerToken::new())
     }
 }
 

src/event_scanner/scanner/latest.rs

@@ -7,7 +7,7 @@ use alloy::{
 use super::common::{ConsumerMode, handle_stream};
 use crate::{
     EventScannerBuilder, ScannerError,
-    event_scanner::{EventScanner, LatestEvents, ScannerHandle},
+    event_scanner::{EventScanner, LatestEvents, ScannerToken},
     robust_provider::IntoRobustProvider,
 };
 
@@ -91,7 +91,7 @@ impl<N: Network> EventScanner<LatestEvents, N> {
     /// Can error out if the service fails to start.
     ///
     /// [subscribe]: EventScanner::subscribe
-    pub async fn start(self) -> Result<ScannerHandle, ScannerError> {
+    pub async fn start(self) -> Result<ScannerToken, ScannerError> {
         let client = self.block_range_scanner.run()?;
         let stream = client.rewind(self.config.from_block, self.config.to_block).await?;
 
@@ -108,7 +108,7 @@ impl<N: Network> EventScanner<LatestEvents, N> {
             .await;
         });
 
-        Ok(ScannerHandle::new())
+        Ok(ScannerToken::new())
     }
 }
 

src/event_scanner/scanner/live.rs

@@ -3,7 +3,7 @@ use alloy::network::Network;
 use super::common::{ConsumerMode, handle_stream};
 use crate::{
     EventScannerBuilder, ScannerError,
-    event_scanner::{EventScanner, ScannerHandle, scanner::Live},
+    event_scanner::{EventScanner, ScannerToken, scanner::Live},
     robust_provider::IntoRobustProvider,
 };
 
@@ -43,7 +43,7 @@ impl<N: Network> EventScanner<Live, N> {
     /// Can error out if the service fails to start.
     ///
     /// [subscribe]: EventScanner::subscribe
-    pub async fn start(self) -> Result<ScannerHandle, ScannerError> {
+    pub async fn start(self) -> Result<ScannerToken, ScannerError> {
         let client = self.block_range_scanner.run()?;
         let stream = client.stream_live(self.config.block_confirmations).await?;
 
@@ -54,7 +54,7 @@ impl<N: Network> EventScanner<Live, N> {
             handle_stream(stream, &provider, &listeners, ConsumerMode::Stream).await;
         });
 
-        Ok(ScannerHandle::new())
+        Ok(ScannerToken::new())
     }
 }