ic-query 0.72.1

Internet Computer query library for CloudEngine, NNS, SNS, ICRC, system canisters, and public network metadata
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Module: sns::report::cache_paths
//!
//! Responsibility: shared SNS snapshot cache path construction.
//! Does not own: cache reads, writes, refresh locking, or report construction.
//! Boundary: maps SNS root principals and collection names to snapshot-cache paths.

use super::cache_storage::SnsCacheStorageFamily;
use crate::snapshot_cache::{SnapshotJsonPaths, SnapshotKey, snapshot_network_dir};
use std::{
    ffi::OsStr,
    path::{Path, PathBuf},
};

/// Build complete snapshot, lock, and refresh-attempt paths for one SNS root.
pub(in crate::sns::report) fn sns_snapshot_cache_paths<Collection>(
    cache_root: &Path,
    network: &str,
    root_canister_id: &str,
) -> SnapshotJsonPaths
where
    Collection: SnsCacheStorageFamily,
{
    let snapshot_key = SnapshotKey::full("sns", network, root_canister_id, Collection::COLLECTION);
    SnapshotJsonPaths::for_key(cache_root, &snapshot_key)
}

/// Return the network-level SNS snapshot cache directory.
pub(in crate::sns::report) fn sns_snapshot_network_cache_dir(
    cache_root: &Path,
    network: &str,
) -> PathBuf {
    snapshot_network_dir(cache_root, "sns", network)
}

/// Return the refresh-attempt path paired with a complete cache file.
pub(in crate::sns::report) fn sns_attempt_path_for_cache_path(cache_path: &Path) -> PathBuf {
    cache_path.with_file_name(format!(
        "{}.refresh-attempt.json",
        SnapshotKey::scope_file_stem()
    ))
}

/// Return the logical key expected for a complete SNS cache path.
pub(in crate::sns::report) fn sns_snapshot_key_for_cache_path<Collection>(
    network: &str,
    cache_path: &Path,
) -> SnapshotKey
where
    Collection: SnsCacheStorageFamily,
{
    let entity = sns_root_from_cache_path(cache_path)
        .and_then(|name| name.to_str())
        .unwrap_or_default();
    SnapshotKey::full("sns", network, entity, Collection::COLLECTION)
}

/// Borrow the root directory identity shared by discovered snapshot readers.
pub(in crate::sns::report) fn sns_root_from_cache_path(cache_path: &Path) -> Option<&OsStr> {
    cache_path
        .parent()
        .and_then(Path::parent)
        .and_then(Path::file_name)
}