canic-core 0.111.0

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

//! Select the public master key used by host-side configuration derivation.
//!
//! This schema contains no cryptographic implementation or runtime key discovery.

use canic_contracts::ids::BuildNetwork;
use serde::{Deserialize, Serialize};
use thiserror::Error;

/// Public master-key environment selected explicitly by the App configuration.

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ChainKeyPublicKeyDerivation {
    Ic,
    Pocketic,
}

/// Host configuration failures that must stop before artifact construction.
#[derive(Clone, Debug, Eq, Error, PartialEq)]
pub enum ChainKeyDerivationError {
    #[error("offline chain-key derivation requires delegated token authentication to be enabled")]
    AuthDisabled,

    #[error(
        "offline chain-key derivation produced a different {field}; remove the stale value or correct the derivation inputs"
    )]
    DerivedValueMismatch { field: &'static str },

    #[error("offline chain-key derivation requires valid hexadecimal bytes in {field}")]
    InvalidHex { field: &'static str },

    #[error("offline chain-key derivation requires root_canister_id to identify a canister")]
    InvalidRoot,

    #[error("offline chain-key derivation requires auth.delegated_tokens.{field}")]
    MissingField { field: &'static str },

    #[error(
        "offline chain-key derivation {derivation:?} cannot be used with build_network {network:?}"
    )]
    NetworkMismatch {
        derivation: ChainKeyPublicKeyDerivation,
        network: BuildNetwork,
    },

    #[error("chain-key derivation paths may contain at most 255 components")]
    PathTooLong,

    #[error("offline chain-key derivation {derivation:?} does not support key_id {key_id}")]
    UnsupportedKey {
        derivation: ChainKeyPublicKeyDerivation,
        key_id: String,
    },
}