ic-query 0.88.0

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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Module: nns::inventory_request
//!
//! Responsibility: define shared request contracts for Registry-derived NNS inventory reports.
//! Does not own: family-specific filters, source calls, cache IO, or report projection.
//! Boundary: keeps identical cache, list, info, and refresh provenance from drifting by family.

use std::path::PathBuf;

///
/// NnsInventoryCacheRequest
///
/// Shared cache identity for Registry-derived NNS inventory reports.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsInventoryCacheRequest {
    pub cache_root: PathBuf,
    pub network: String,
}

impl NnsInventoryCacheRequest {
    #[must_use]
    pub fn new(cache_root: impl Into<PathBuf>, network: impl Into<String>) -> Self {
        Self {
            cache_root: cache_root.into(),
            network: network.into(),
        }
    }
}

///
/// NnsInventoryListRequest
///
/// Shared request for a complete Registry-derived NNS inventory report.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsInventoryListRequest {
    pub cache: NnsInventoryCacheRequest,
    pub source_endpoint: String,
    pub now_unix_secs: u64,
}

impl NnsInventoryListRequest {
    #[must_use]
    pub fn new(
        cache: NnsInventoryCacheRequest,
        source_endpoint: impl Into<String>,
        now_unix_secs: u64,
    ) -> Self {
        Self {
            cache,
            source_endpoint: source_endpoint.into(),
            now_unix_secs,
        }
    }
}

#[cfg(feature = "nns-host")]
impl NnsInventoryListRequest {
    /// Derive live collection provenance; cached reports retain their stored provenance.
    #[must_use]
    pub fn source_request(&self) -> crate::report::CollectionSourceRequest {
        crate::report::CollectionSourceRequest::from_unix_secs(
            &self.cache.network,
            &self.source_endpoint,
            self.now_unix_secs,
            "ic-query",
        )
    }
}

///
/// NnsInventoryInfoRequest
///
/// Shared request for one Registry-derived NNS inventory row selected by id or prefix.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsInventoryInfoRequest {
    pub cache: NnsInventoryCacheRequest,
    pub source_endpoint: String,
    pub input: String,
    pub now_unix_secs: u64,
}

impl NnsInventoryInfoRequest {
    #[cfg(feature = "nns-host")]
    pub(in crate::nns) fn to_list_request(&self) -> NnsInventoryListRequest {
        NnsInventoryListRequest {
            cache: self.cache.clone(),
            source_endpoint: self.source_endpoint.clone(),
            now_unix_secs: self.now_unix_secs,
        }
    }

    #[must_use]
    pub fn new(
        cache: NnsInventoryCacheRequest,
        source_endpoint: impl Into<String>,
        input: impl Into<String>,
        now_unix_secs: u64,
    ) -> Self {
        Self {
            cache,
            source_endpoint: source_endpoint.into(),
            input: input.into(),
            now_unix_secs,
        }
    }
}

///
/// NnsInventoryRefreshRequest
///
/// Shared host request for refreshing one Registry-derived NNS inventory cache.
///

#[cfg(feature = "nns-host")]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsInventoryRefreshRequest {
    pub cache: NnsInventoryCacheRequest,
    pub source_endpoint: String,
    pub now_unix_secs: u64,

    pub dry_run: bool,
    pub output_path: Option<PathBuf>,
}

#[cfg(feature = "nns-host")]
impl NnsInventoryRefreshRequest {
    #[must_use]
    pub fn new(
        cache: NnsInventoryCacheRequest,
        source_endpoint: impl Into<String>,
        now_unix_secs: u64,
    ) -> Self {
        Self {
            cache,
            source_endpoint: source_endpoint.into(),
            now_unix_secs,

            dry_run: false,
            output_path: None,
        }
    }

    #[must_use]
    pub const fn with_dry_run(mut self, dry_run: bool) -> Self {
        self.dry_run = dry_run;
        self
    }

    #[must_use]
    pub fn with_output_path(mut self, output_path: impl Into<PathBuf>) -> Self {
        self.output_path = Some(output_path.into());
        self
    }
}