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

//! Module: ic::model::requests::node_provider_rewards
//!
//! Responsibility: bounded official Dashboard node-provider reward request contracts.
//! Does not own: transport, returned reward records, validation, or rendering.
//! Boundary: captures one explicit page, one exact reward id, or one bounded history window.

use serde::Serialize;

///
/// IcNodeProviderRewardListQuery
///
/// One explicitly bounded official Dashboard node-provider reward page query.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcNodeProviderRewardListQuery {
    /// Maximum reward rows requested from the API.
    pub limit: u16,
    /// Zero-based reward-row offset.
    pub offset: u64,
    /// Optional reward-index ceiling returned by an earlier page.
    pub max_reward_index: Option<u64>,
}

impl IcNodeProviderRewardListQuery {
    /// Construct one bounded node-provider reward page query.
    #[must_use]
    pub const fn new(limit: u16, offset: u64, max_reward_index: Option<u64>) -> Self {
        Self {
            limit,
            offset,
            max_reward_index,
        }
    }
}

///
/// IcNodeProviderRewardListRequest
///
/// Request accepted by the bounded official Dashboard node-provider reward list builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct IcNodeProviderRewardListRequest {
    /// Dashboard API v3 base endpoint.
    pub source_endpoint: String,
    /// Collection time as Unix seconds.
    pub now_unix_secs: u64,
    /// Explicit page bounds.
    pub query: IcNodeProviderRewardListQuery,
}

impl IcNodeProviderRewardListRequest {
    /// Construct one bounded live Dashboard node-provider reward list request.
    #[must_use]
    pub fn new(
        source_endpoint: impl Into<String>,
        now_unix_secs: u64,
        query: IcNodeProviderRewardListQuery,
    ) -> Self {
        Self {
            source_endpoint: source_endpoint.into(),
            now_unix_secs,
            query,
        }
    }
}

///
/// IcNodeProviderRewardInfoRequest
///
/// Request accepted by the exact official Dashboard node-provider reward builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct IcNodeProviderRewardInfoRequest {
    /// Dashboard API v3 base endpoint.
    pub source_endpoint: String,
    /// Collection time as Unix seconds.
    pub now_unix_secs: u64,
    /// Exact Dashboard node-provider reward id.
    pub reward_id: u64,
}

impl IcNodeProviderRewardInfoRequest {
    /// Construct one exact live Dashboard node-provider reward request.
    #[must_use]
    pub fn new(source_endpoint: impl Into<String>, now_unix_secs: u64, reward_id: u64) -> Self {
        Self {
            source_endpoint: source_endpoint.into(),
            now_unix_secs,
            reward_id,
        }
    }
}

///
/// IcNodeProviderRewardHistoryQuery
///
/// One explicitly bounded official Dashboard node-provider reward history query.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcNodeProviderRewardHistoryQuery {
    /// Inclusive history start as Unix seconds.
    pub start_unix_secs: u64,
    /// Inclusive history end as Unix seconds.
    pub end_unix_secs: u64,
    /// Requested observation interval in seconds.
    pub step_secs: u32,
}

impl IcNodeProviderRewardHistoryQuery {
    /// Construct one explicit node-provider reward history window.
    #[must_use]
    pub const fn new(start_unix_secs: u64, end_unix_secs: u64, step_secs: u32) -> Self {
        Self {
            start_unix_secs,
            end_unix_secs,
            step_secs,
        }
    }
}

///
/// IcNodeProviderRewardHistoryRequest
///
/// Request accepted by the bounded official Dashboard node-provider reward history builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct IcNodeProviderRewardHistoryRequest {
    /// Dashboard API v3 base endpoint.
    pub source_endpoint: String,
    /// Collection time as Unix seconds.
    pub now_unix_secs: u64,
    /// Explicit history bounds.
    pub query: IcNodeProviderRewardHistoryQuery,
}

impl IcNodeProviderRewardHistoryRequest {
    /// Construct one bounded live Dashboard node-provider reward history request.
    #[must_use]
    pub fn new(
        source_endpoint: impl Into<String>,
        now_unix_secs: u64,
        query: IcNodeProviderRewardHistoryQuery,
    ) -> Self {
        Self {
            source_endpoint: source_endpoint.into(),
            now_unix_secs,
            query,
        }
    }
}