ic-query 0.30.14

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Module: nns::registry::replay::authentication
//!
//! Responsibility: preserve authenticated replay across live and retained-evidence paths.
//! Does not own: certificate verification, replay mechanics, persistence, or assurance policy.
//! Boundary: only complete sessions composed entirely from built-in verification can be sealed.

use super::{
    NnsRegistryReplayError, NnsRegistryReplayProgress, NnsRegistryReplaySession,
    NnsRegistryReplaySessionLimits,
};
use crate::nns::registry::NnsAuthenticatedRegistryDeltaBatch;

///
/// NnsAuthenticatedRegistryReplayBuilder
///
/// Bounded in-memory replay that admits only locally reauthenticated retained batches.
///

#[derive(Debug, Eq, PartialEq)]
pub struct NnsAuthenticatedRegistryReplayBuilder {
    session: NnsRegistryReplaySession,
}

impl NnsAuthenticatedRegistryReplayBuilder {
    /// Create a version-zero authenticated replay builder with explicit cumulative limits.
    #[must_use]
    pub const fn new(limits: NnsRegistryReplaySessionLimits) -> Self {
        Self {
            session: NnsRegistryReplaySession::new(limits),
        }
    }

    /// Atomically admit one exact report already qualified by local reauthentication.
    pub fn apply_batch(
        &mut self,
        batch: &NnsAuthenticatedRegistryDeltaBatch<'_>,
    ) -> Result<NnsRegistryReplayProgress, NnsRegistryReplayError> {
        self.session.apply_prevalidated_batch(batch.report())
    }

    /// Return authenticated replay progress without exposing an ordinary mutable session.
    #[must_use]
    pub const fn replay_session(&self) -> &NnsRegistryReplaySession {
        &self.session
    }

    /// Seal a complete exact-target replay session, rejecting incomplete retained evidence.
    pub fn into_authenticated_replay_session(
        self,
    ) -> Result<NnsAuthenticatedRegistryReplaySession, NnsRegistryReplayError> {
        NnsAuthenticatedRegistryReplaySession::from_verified_complete(self.session)
    }
}

///
/// NnsAuthenticatedRegistryReplaySession
///
/// Complete replay session whose every batch passed ic-query's mainnet-root-key verifier.
///

#[derive(Debug, Eq, PartialEq)]
pub struct NnsAuthenticatedRegistryReplaySession {
    session: NnsRegistryReplaySession,
}

impl NnsAuthenticatedRegistryReplaySession {
    pub(super) fn from_verified_complete(
        session: NnsRegistryReplaySession,
    ) -> Result<Self, NnsRegistryReplayError> {
        if !session.is_complete()
            || session.root_key_digest().is_none()
            || session.evidence_chain_digest().is_none()
            || session.complete_state_digest().is_none()
        {
            return Err(
                NnsRegistryReplayError::AuthenticationRequiresCompleteSession {
                    selected_version: session.selected_version(),
                    through_version: session.state().through_version(),
                },
            );
        }
        Ok(Self { session })
    }

    /// Return the complete exact-target replay session authenticated by the built-in source.
    #[must_use]
    pub const fn replay_session(&self) -> &NnsRegistryReplaySession {
        &self.session
    }

    /// Consume the authenticated wrapper and deliberately discard its type-level capability.
    #[must_use]
    pub fn into_replay_session(self) -> NnsRegistryReplaySession {
        self.session
    }
}