canic-core 0.26.6

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
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

use crate::dto::{
    prelude::*,
    rpc::{CyclesRequest, CyclesResponse, Request, Response},
};

pub mod proof;

pub use proof::{DelegatedGrant, DelegatedGrantProof, DelegatedGrantScope, RoleAttestationProof};

//
// CapabilityVersion
//

pub const CAPABILITY_VERSION_V1: u16 = 1;

//
// ProofVersion
//

pub const PROOF_VERSION_V1: u16 = 1;

//
// CapabilityService
//

#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
pub enum CapabilityService {
    Root,
}

//
// CapabilityRequestMetadata
//

#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
pub struct CapabilityRequestMetadata {
    pub request_id: [u8; 16],
    pub nonce: [u8; 16],
    pub issued_at: u64,
    pub ttl_seconds: u32,
}

//
// CapabilityProofBlob
//

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub struct CapabilityProofBlob {
    pub proof_version: u16,
    pub capability_hash: [u8; 32],
    pub payload: Vec<u8>,
}

//
// CapabilityProof
//

#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq)]
pub enum CapabilityProof {
    Structural,
    RoleAttestation(CapabilityProofBlob),
    DelegatedGrant(CapabilityProofBlob),
}

//
// RootCapabilityEnvelopeV1
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct RootCapabilityEnvelopeV1 {
    pub service: CapabilityService,
    pub capability_version: u16,
    pub capability: Request,
    pub proof: CapabilityProof,
    pub metadata: CapabilityRequestMetadata,
}

//
// RootCapabilityResponseV1
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct RootCapabilityResponseV1 {
    pub response: Response,
}

//
// NonrootCyclesCapabilityEnvelopeV1
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct NonrootCyclesCapabilityEnvelopeV1 {
    pub service: CapabilityService,
    pub capability_version: u16,
    pub capability: CyclesRequest,
    pub proof: CapabilityProof,
    pub metadata: CapabilityRequestMetadata,
}

//
// NonrootCyclesCapabilityResponseV1
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct NonrootCyclesCapabilityResponseV1 {
    pub response: CyclesResponse,
}