canic-core 0.100.99

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: api::authority_restore
//!
//! Responsibility: expose authority snapshot/restore-fence workflows to generated endpoints.
//! Does not own: authentication, history proof, transition validation, or persistence.
//! Boundary: converts internal workflow failures into the public Canic error contract.

use crate::{
    cdk::types::Principal,
    dto::{
        authority_restore::{AuthorityRestoreFenceStatusResponse, AuthoritySnapshotRequest},
        error::Error,
    },
    workflow::runtime::authority_restore::AuthorityRestoreWorkflow,
};

/// Public facade for controller-owned authority snapshot fencing.
pub struct AuthorityRestoreApi;

impl AuthorityRestoreApi {
    #[doc(hidden)]
    pub fn initialize(authority_canister: Principal) -> Result<(), Error> {
        AuthorityRestoreWorkflow::initialize(authority_canister).map_err(Into::into)
    }

    /// Return the authority's durable snapshot-fence state.
    pub fn status() -> Result<AuthorityRestoreFenceStatusResponse, Error> {
        AuthorityRestoreWorkflow::status().map_err(Into::into)
    }

    /// Seal ordinary mutation before an external authority snapshot is captured.
    pub async fn prepare_snapshot(
        request: AuthoritySnapshotRequest,
    ) -> Result<AuthorityRestoreFenceStatusResponse, Error> {
        AuthorityRestoreWorkflow::prepare_snapshot(request)
            .await
            .map_err(Into::into)
    }

    /// Resume the live authority only when its independent history still matches the seal.
    pub async fn resume_snapshot(
        request: AuthoritySnapshotRequest,
    ) -> Result<AuthorityRestoreFenceStatusResponse, Error> {
        AuthorityRestoreWorkflow::resume_snapshot(request)
            .await
            .map_err(Into::into)
    }
}