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

//! Module: sns::report::live::fetch::proposals
//!
//! Responsibility: fetch SNS governance proposals.
//! Does not own: lookup resolution, cache storage, report assembly, or rendering.
//! Boundary: queries direct, bounded, and paged proposal data from governance.

mod list;
mod single;
use crate::sns::report::{
    SnsHostError, SnsProposalTopicFilter,
    source::{
        MainnetSns, MainnetSnsProposal, MainnetSnsProposalPage, MainnetSnsProposals,
        SnsSourceRequest,
    },
};
use list::{fetch_mainnet_sns_proposal_page_async, fetch_mainnet_sns_proposals_async};
use single::fetch_mainnet_sns_proposal_async;

/// Fetch one SNS governance proposal by id.
pub(in crate::sns::report::live) async fn fetch_mainnet_sns_proposal(
    source: &crate::sns::LiveSnsSource,
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    proposal_id: u64,
) -> Result<MainnetSnsProposal, SnsHostError> {
    fetch_mainnet_sns_proposal_async(source, request, sns, proposal_id).await
}

/// Fetch a bounded SNS governance proposal listing.
pub(in crate::sns::report::live) async fn fetch_mainnet_sns_proposals(
    source: &crate::sns::LiveSnsSource,
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    before_proposal_id: Option<u64>,
    include_status: &[i32],
    topic: SnsProposalTopicFilter,
) -> Result<MainnetSnsProposals, SnsHostError> {
    fetch_mainnet_sns_proposals_async(
        source,
        request,
        sns,
        limit,
        before_proposal_id,
        include_status,
        topic,
    )
    .await
}

/// Fetch one proposal page for complete proposal snapshot refresh.
pub(in crate::sns::report::live) async fn fetch_mainnet_sns_proposal_page(
    source: &crate::sns::LiveSnsSource,
    request: &SnsSourceRequest,
    sns: &MainnetSns,
    limit: u32,
    before_proposal_id: Option<u64>,
) -> Result<MainnetSnsProposalPage, SnsHostError> {
    fetch_mainnet_sns_proposal_page_async(source, request, sns, limit, before_proposal_id).await
}