ic-query 0.25.2

Internet Computer query library for 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

//! Module: nns::source
//!
//! Responsibility: identify the built-in live NNS source adapter.
//! Does not own: source capability traits, report projection, or cache policy.
//! Boundary: one adapter implements the capability traits owned by each NNS report family.

use crate::{
    ic_registry::MainnetRegistryFetchRequest, network::enforce_mainnet_network_with,
    subnet_catalog::format_utc_timestamp_secs,
};

///
/// LiveNnsSource
///
/// Built-in live adapter for supported NNS Registry and governance report capabilities.
///

#[derive(Clone, Copy, Debug, Default)]
pub struct LiveNnsSource;

///
/// NnsSourceRequest
///
/// Network and collection provenance shared by NNS source capabilities.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsSourceRequest {
    /// Network to collect.
    pub network: String,
    /// Replica endpoint used for the query.
    pub endpoint: String,
    /// UTC collection timestamp recorded in the report.
    pub fetched_at: String,
    /// Collector identity recorded in the report.
    pub fetched_by: String,
}

impl NnsSourceRequest {
    /// Create source settings for one NNS collection.
    #[must_use]
    pub fn new(
        network: impl Into<String>,
        endpoint: impl Into<String>,
        fetched_at: impl Into<String>,
        fetched_by: impl Into<String>,
    ) -> Self {
        Self {
            network: network.into(),
            endpoint: endpoint.into(),
            fetched_at: fetched_at.into(),
            fetched_by: fetched_by.into(),
        }
    }

    /// Create source settings from a Unix collection timestamp.
    #[must_use]
    pub fn from_unix_secs(
        network: impl Into<String>,
        endpoint: impl Into<String>,
        fetched_at_unix_secs: u64,
        fetched_by: impl Into<String>,
    ) -> Self {
        Self::new(
            network,
            endpoint,
            format_utc_timestamp_secs(fetched_at_unix_secs),
            fetched_by,
        )
    }
}

pub fn mainnet_registry_fetch_request<Error>(
    request: &NnsSourceRequest,
    unsupported_network: impl FnOnce(String) -> Error,
) -> Result<MainnetRegistryFetchRequest, Error> {
    enforce_mainnet_network_with(&request.network, unsupported_network)?;
    let mut fetch_request = MainnetRegistryFetchRequest::new(request.fetched_at.clone());
    fetch_request.endpoint.clone_from(&request.endpoint);
    fetch_request.fetched_by.clone_from(&request.fetched_by);
    Ok(fetch_request)
}