ic-query 0.47.2

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

//! Module: subnet_catalog::host::paths
//!
//! Responsibility: construct subnet catalog cache and lock paths under the cache root.
//!
//! Does not own: cache read/write behavior, refresh policy, or network validation.
//!
//! Boundary: centralizes on-disk path shape for subnet catalog host operations.

use std::path::{Path, PathBuf};

/// Returns the complete catalog JSON path for a network.
#[must_use]
pub fn subnet_catalog_path(cache_root: &Path, network: &str) -> PathBuf {
    cache_root
        .join("nns")
        .join(network)
        .join("subnet-catalog")
        .join("catalog.json")
}

/// Returns the refresh lock path for a network catalog.
#[must_use]
pub fn subnet_catalog_refresh_lock_path(cache_root: &Path, network: &str) -> PathBuf {
    cache_root
        .join("nns")
        .join(network)
        .join("subnet-catalog")
        .join("refresh.lock")
}

/// Returns the bounded Registry history transcript path for a network catalog.
#[must_use]
pub fn subnet_catalog_history_path(cache_root: &Path, network: &str) -> PathBuf {
    subnet_catalog_path(cache_root, network).with_file_name("history.json")
}

/// Returns the short-lived writer lock path for a network catalog's history.
#[must_use]
pub fn subnet_catalog_history_lock_path(cache_root: &Path, network: &str) -> PathBuf {
    subnet_catalog_path(cache_root, network).with_file_name("history.lock")
}