ic-query 0.40.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
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

//! Module: nns::governance::request
//!
//! Responsibility: describe one direct NNS Governance report collection.
//! Does not own: live transport, report assembly, or persistence policy.
//! Boundary: keeps caller intent separate from source-returned provenance.

use crate::subnet_catalog::format_utc_timestamp_secs;
use serde::{Deserialize, Serialize};

///
/// NnsGovernanceSourceSelection
///
/// Transport selected for one direct NNS Governance collection.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(tag = "source_transport", rename_all = "snake_case")]
pub enum NnsGovernanceSourceSelection {
    /// Submit an ordinary unreplicated query through one replica endpoint.
    ReplicaQuery {
        /// Replica endpoint selected by the caller.
        endpoint: String,
        /// Collector identity recorded in report provenance.
        fetched_by: String,
    },
    /// Execute a replicated inter-canister call from the current canister.
    ReplicatedInterCanisterCall,
}

///
/// NnsGovernanceRequest
///
/// Network, timestamp, and transport selection for one Governance report.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct NnsGovernanceRequest {
    /// Network to query.
    pub network: String,
    /// UTC collection timestamp recorded in the report.
    pub fetched_at: String,
    /// Requested source transport.
    pub source: NnsGovernanceSourceSelection,
}

impl NnsGovernanceRequest {
    /// Create a replica-query request with an explicit UTC timestamp.
    #[must_use]
    pub fn replica_query(
        network: impl Into<String>,
        endpoint: impl Into<String>,
        fetched_at: impl Into<String>,
        fetched_by: impl Into<String>,
    ) -> Self {
        Self {
            network: network.into(),
            fetched_at: fetched_at.into(),
            source: NnsGovernanceSourceSelection::ReplicaQuery {
                endpoint: endpoint.into(),
                fetched_by: fetched_by.into(),
            },
        }
    }

    /// Create a replica-query request from a Unix collection timestamp.
    #[must_use]
    pub fn replica_query_from_unix_secs(
        network: impl Into<String>,
        endpoint: impl Into<String>,
        fetched_at_unix_secs: u64,
        fetched_by: impl Into<String>,
    ) -> Self {
        Self::replica_query(
            network,
            endpoint,
            format_utc_timestamp_secs(fetched_at_unix_secs),
            fetched_by,
        )
    }

    /// Create a replicated inter-canister-call request with an explicit UTC timestamp.
    #[must_use]
    pub fn replicated_inter_canister_call(
        network: impl Into<String>,
        fetched_at: impl Into<String>,
    ) -> Self {
        Self {
            network: network.into(),
            fetched_at: fetched_at.into(),
            source: NnsGovernanceSourceSelection::ReplicatedInterCanisterCall,
        }
    }

    /// Create a replicated inter-canister-call request from a Unix collection timestamp.
    #[must_use]
    pub fn replicated_inter_canister_call_from_unix_secs(
        network: impl Into<String>,
        fetched_at_unix_secs: u64,
    ) -> Self {
        Self::replicated_inter_canister_call(
            network,
            format_utc_timestamp_secs(fetched_at_unix_secs),
        )
    }
}