zebra-scan 0.1.0-alpha.15

Shielded transaction scanner for the Zcash blockchain
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! Types and method implementations for [`ScanTask`]

use std::sync::Arc;

use color_eyre::Report;
use tokio::task::JoinHandle;

use zebra_state::ChainTipChange;

use crate::storage::Storage;

mod commands;
mod executor;
pub mod scan;

pub use commands::ScanTaskCommand;

#[cfg(any(test, feature = "proptest-impl"))]
pub mod tests;

#[derive(Debug, Clone)]
/// Scan task handle and command channel sender
pub struct ScanTask {
    /// [`JoinHandle`] of scan task
    pub handle: Arc<JoinHandle<Result<(), Report>>>,

    /// Task command channel sender
    pub cmd_sender: tokio::sync::mpsc::Sender<ScanTaskCommand>,
}

/// The size of the command channel buffer
const SCAN_TASK_BUFFER_SIZE: usize = 100;

impl ScanTask {
    /// Spawns a new [`ScanTask`].
    pub fn spawn(db: Storage, state: scan::State, chain_tip_change: ChainTipChange) -> Self {
        // TODO: Use a bounded channel or move this logic to the scan service or another service.
        let (cmd_sender, cmd_receiver) = tokio::sync::mpsc::channel(SCAN_TASK_BUFFER_SIZE);

        Self {
            handle: Arc::new(scan::spawn_init(db, state, chain_tip_change, cmd_receiver)),
            cmd_sender,
        }
    }
}