Struct SnapshotClient

pub struct SnapshotClient { /* private fields */ }

Aggregator client for the snapshot artifact

Implementations

impl SnapshotClient

pub fn new( aggregator_client: Arc<dyn AggregatorClient>, http_file_downloader: Arc<dyn FileDownloader>, ancillary_verifier: Option<Arc<AncillaryVerifier>>, feedback_sender: FeedbackSender, logger: Logger, ) -> Self

Constructs a new SnapshotClient.

pub async fn list(&self) -> MithrilResult<Vec<SnapshotListItem>>

Return a list of available snapshots

pub async fn get(&self, digest: &str) -> MithrilResult<Option<Snapshot>>

Get the given snapshot data. If it cannot be found, a None is returned.

pub async fn download_unpack_full( &self, snapshot: &Snapshot, target_dir: &Path, ) -> MithrilResult<()>

Download and unpack the given snapshot, including its ancillary files, to the given directory

Ancillary files are the files that are not signed by Mithril but are needed to enable fast They include the last ledger state snapshot and the last immutable file.

NOTE: The target directory should already exist, and the user running the binary must have read/write access to it.

pub async fn download_unpack( &self, snapshot: &Snapshot, target_dir: &Path, ) -> MithrilResult<()>

Download and unpack the given immutable files of the snapshot to the given directory

Ancillary files are not included in this operation, if they are needed, use download_unpack_full instead.

NOTE: The target directory should already exist, and the user running the binary must have read/write access to it.

pub async fn add_statistics(&self, snapshot: &Snapshot) -> MithrilResult<()>

Increments the aggregator snapshot download statistics