1use serde::{Deserialize, Serialize};
2
3#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
7pub struct DeploymentPlanV1 {
8 pub schema_version: u32,
9 pub plan_id: String,
10 pub deployment_identity: DeploymentIdentityV1,
11 pub trust_domain: TrustDomainV1,
12 pub fleet_template: String,
13 pub runtime_variant: String,
14 pub authority_profile: AuthorityProfileV1,
15 pub role_artifacts: Vec<RoleArtifactV1>,
16 pub expected_canisters: Vec<ExpectedCanisterV1>,
17 pub expected_pool: Vec<ExpectedPoolCanisterV1>,
18 pub expected_verifier_readiness: VerifierReadinessExpectationV1,
19 pub unresolved_assumptions: Vec<DeploymentAssumptionV1>,
20}
21
22#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
26pub struct DeploymentInventoryV1 {
27 pub schema_version: u32,
28 pub inventory_id: String,
29 pub observed_at: String,
30 pub observed_identity: Option<DeploymentIdentityV1>,
31 pub local_config: LocalDeploymentConfigV1,
32 pub observed_canisters: Vec<ObservedCanisterV1>,
33 pub observed_pool: Vec<ObservedPoolCanisterV1>,
34 pub observed_artifacts: Vec<ObservedArtifactV1>,
35 pub observed_verifier_readiness: VerifierReadinessObservationV1,
36 pub unresolved_observations: Vec<DeploymentObservationGapV1>,
37}
38
39#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
43pub struct DeploymentReceiptV1 {
44 pub schema_version: u32,
45 pub operation_id: String,
46 pub plan_id: String,
47 pub execution_context: Option<DeploymentExecutionContextV1>,
48 pub operation_status: DeploymentExecutionStatusV1,
49 pub started_at: String,
50 pub finished_at: Option<String>,
51 pub operator_principal: Option<String>,
52 pub root_principal: Option<String>,
53 pub previous_observed_deployment_epoch: Option<u64>,
54 pub phase_receipts: Vec<PhaseReceiptV1>,
55 pub role_phase_receipts: Vec<RolePhaseReceiptV1>,
56 pub final_inventory_id: Option<String>,
57 pub command_result: DeploymentCommandResultV1,
58}
59
60#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
64pub struct DeploymentExecutionContextV1 {
65 pub workspace_root: Option<String>,
66 pub icp_root: Option<String>,
67 pub artifact_roots: Vec<String>,
68 pub backend: DeploymentExecutorBackendV1,
69 pub backend_capabilities: Vec<DeploymentExecutorCapabilityV1>,
70}
71
72#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
76pub struct DeploymentExecutionPreflightV1 {
77 pub schema_version: u32,
78 pub plan_id: String,
79 pub safety_report_id: String,
80 pub authority_plan_id: String,
81 pub backend: DeploymentExecutorBackendV1,
82 pub status: DeploymentExecutionPreflightStatusV1,
83 pub planned_phases: Vec<String>,
84 pub required_capabilities: Vec<DeploymentExecutorCapabilityV1>,
85 pub missing_capabilities: Vec<DeploymentExecutorCapabilityV1>,
86 pub blockers: Vec<SafetyFindingV1>,
87}
88
89#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
93pub enum DeploymentExecutionPreflightStatusV1 {
94 Ready,
95 Blocked,
96}
97
98#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
102pub enum DeploymentExecutorBackendV1 {
103 CurrentCli,
104 PocketIc,
105 DirectAgent,
106 Other { name: String },
107}
108
109#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
113pub enum DeploymentExecutorCapabilityV1 {
114 CreateCanister,
115 CanisterStatus,
116 UpdateSettings,
117 InstallCode,
118 Call,
119 Query,
120 StageArtifact,
121}
122
123#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
127pub enum ArtifactTransportV1 {
128 LocalCli,
129 WasmStore,
130 DirectAgent,
131}
132
133#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
137pub struct StagingReceiptV1 {
138 pub schema_version: u32,
139 pub role: String,
140 pub artifact_identity: String,
141 pub transport: ArtifactTransportV1,
142 pub wasm_store_locator: Option<String>,
143 pub prepared_chunk_hashes: Vec<String>,
144 pub published_chunk_count: usize,
145 pub verified_postcondition: VerifiedPostconditionV1,
146}
147
148#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
152pub struct RoleArtifactSourceV1 {
153 pub role: String,
154 pub kind: RoleArtifactSourceKindV1,
155 pub locator: Option<String>,
156 pub previous_receipt_kind: Option<PreviousArtifactReceiptKindV1>,
157 pub previous_receipt_lineage_digest: Option<String>,
158 pub expected_wasm_sha256: Option<String>,
159 pub expected_wasm_gz_sha256: Option<String>,
160 pub expected_candid_sha256: Option<String>,
161 pub expected_canonical_embedded_config_sha256: Option<String>,
162}
163
164#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
168pub struct RolePromotionInputV1 {
169 pub role: String,
170 pub promotion_level: PromotionArtifactLevelV1,
171 pub source: RoleArtifactSourceV1,
172 pub require_byte_identical_wasm: bool,
173 pub require_target_embedded_config: bool,
174 pub target_store_has_artifact: Option<bool>,
175}
176
177#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
181pub struct RolePromotionPolicyV1 {
182 pub role: String,
183 pub allowed_promotion_levels: Vec<PromotionArtifactLevelV1>,
184 pub requirements: Vec<PromotionPolicyRequirementV1>,
185}
186
187#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
191pub enum PromotionPolicyRequirementV1 {
192 SameSourceRevision,
193 SameCargoFeatures,
194 TargetConfigDigest,
195 ByteIdenticalWasm,
196 SealedBytes,
197}
198
199#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
203pub enum PromotionPolicyClaimV1 {
204 ByteIdenticalWasm,
205 TargetConfigDigest,
206}
207
208#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
212pub struct PromotionPolicyCheckV1 {
213 pub schema_version: u32,
214 pub check_id: String,
215 pub promotion_policy_check_digest: String,
216 pub status: PromotionReadinessStatusV1,
217 pub roles: Vec<RolePromotionPolicyDecisionV1>,
218 pub blockers: Vec<SafetyFindingV1>,
219}
220
221#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
225pub struct RolePromotionPolicyDecisionV1 {
226 pub role: String,
227 pub requested_promotion_level: PromotionArtifactLevelV1,
228 pub allowed_promotion_levels: Vec<PromotionArtifactLevelV1>,
229 pub requirements: Vec<PromotionPolicyRequirementV1>,
230 pub claims: Vec<PromotionPolicyClaimV1>,
231 pub level_allowed: bool,
232 pub policy_satisfied: bool,
233}
234
235#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
239pub enum PromotionArtifactLevelV1 {
240 SealedWasm,
241 SourceBuild,
242}
243
244#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
248pub struct BuildRecipeIdentityV1 {
249 pub recipe_id: String,
250 pub source_kind: RoleArtifactSourceKindV1,
251 pub source_revision: String,
252 pub source_tree_clean: bool,
253 pub package_or_role_selector: String,
254 pub cargo_profile: String,
255 pub cargo_features_digest: String,
256 pub cargo_lock_digest: String,
257 pub rust_toolchain: String,
258 pub builder_version: String,
259 pub target_triple: String,
260 pub linker_identity: String,
261 pub deterministic_build_mode: String,
262 pub wasm_opt_version: String,
263 pub compression_identity: String,
264}
265
266#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
270pub struct BuildMaterializationInputV1 {
271 pub materialization_input_id: String,
272 pub build_recipe_id: String,
273 pub canonical_embedded_config_sha256: String,
274 pub network: String,
275 pub root_trust_anchor: String,
276 pub runtime_variant: String,
277}
278
279#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
283pub struct BuildMaterializationResultV1 {
284 pub materialization_result_id: String,
285 pub build_recipe_id: String,
286 pub materialization_input_digest: String,
287 pub wasm_sha256: String,
288 pub wasm_gz_sha256: String,
289 pub installed_module_hash: String,
290 pub candid_sha256: String,
291}
292
293#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
297pub struct BuildMaterializationEvidenceV1 {
298 pub schema_version: u32,
299 pub evidence_id: String,
300 pub materialization_evidence_digest: String,
301 pub recipe: BuildRecipeIdentityV1,
302 pub materialization_input: BuildMaterializationInputV1,
303 pub materialization_result: BuildMaterializationResultV1,
304 pub computed_materialization_input_digest: String,
305 pub recipe_id_matches_input: bool,
306 pub recipe_id_matches_result: bool,
307 pub materialization_input_digest_matches_result: bool,
308}
309
310#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
314pub struct PromotionMaterializationIdentityReportV1 {
315 pub schema_version: u32,
316 pub report_id: String,
317 pub materialization_identity_report_digest: String,
318 pub status: PromotionReadinessStatusV1,
319 pub roles: Vec<RolePromotionMaterializationIdentityV1>,
320 pub output_groups: Vec<PromotionMaterializationOutputGroupV1>,
321 pub blockers: Vec<SafetyFindingV1>,
322}
323
324#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
328pub struct RolePromotionMaterializationIdentityV1 {
329 pub role: String,
330 pub evidence_id: String,
331 pub materialization_evidence_digest: String,
332 pub recipe_id: String,
333 pub materialization_input_id: String,
334 pub materialization_result_id: String,
335 pub materialization_input_digest: String,
336 pub canonical_embedded_config_sha256: String,
337 pub network: String,
338 pub root_trust_anchor: String,
339 pub runtime_variant: String,
340 pub wasm_sha256: String,
341 pub wasm_gz_sha256: String,
342 pub installed_module_hash: String,
343 pub candid_sha256: String,
344}
345
346#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
350pub struct PromotionMaterializationOutputGroupV1 {
351 pub output_identity_key: String,
352 pub roles: Vec<String>,
353 pub wasm_sha256: String,
354 pub wasm_gz_sha256: String,
355 pub installed_module_hash: String,
356 pub candid_sha256: String,
357}
358
359#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
363pub struct PromotionArtifactIdentityReportV1 {
364 pub schema_version: u32,
365 pub report_id: String,
366 pub artifact_identity_report_digest: String,
367 pub status: PromotionReadinessStatusV1,
368 pub summary: PromotionArtifactIdentitySummaryV1,
369 pub roles: Vec<RolePromotionArtifactIdentityV1>,
370 pub identity_groups: Vec<PromotionArtifactIdentityGroupV1>,
371 pub blockers: Vec<SafetyFindingV1>,
372}
373
374#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
378pub struct PromotionArtifactIdentitySummaryV1 {
379 pub role_count: usize,
380 pub identity_group_count: usize,
381 pub shared_identity_group_count: usize,
382 pub digest_pinned_role_count: usize,
383 pub source_build_role_count: usize,
384 pub deferred_identity_role_count: usize,
385}
386
387#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
391pub struct PromotionWasmStoreIdentityReportV1 {
392 pub schema_version: u32,
393 pub report_id: String,
394 pub wasm_store_identity_report_digest: String,
395 pub status: PromotionReadinessStatusV1,
396 pub roles: Vec<RolePromotionWasmStoreIdentityV1>,
397 pub blockers: Vec<SafetyFindingV1>,
398}
399
400#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
404pub struct RolePromotionWasmStoreIdentityV1 {
405 pub role: String,
406 pub artifact_identity: String,
407 pub transport: ArtifactTransportV1,
408 pub wasm_store_locator: Option<String>,
409 pub prepared_chunk_hashes: Vec<String>,
410 pub published_chunk_count: usize,
411 pub verified_postcondition: VerifiedPostconditionV1,
412}
413
414#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
418pub struct PromotionWasmStoreCatalogEntryV1 {
419 pub locator: String,
420 pub artifact_identity: String,
421 pub published_chunk_count: usize,
422}
423
424#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
428pub struct PromotionWasmStoreCatalogVerificationV1 {
429 pub schema_version: u32,
430 pub verification_id: String,
431 pub wasm_store_catalog_verification_digest: String,
432 pub wasm_store_identity_report_id: String,
433 pub status: PromotionReadinessStatusV1,
434 pub roles: Vec<RolePromotionWasmStoreCatalogVerificationV1>,
435 pub blockers: Vec<SafetyFindingV1>,
436}
437
438#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
442pub struct RolePromotionWasmStoreCatalogVerificationV1 {
443 pub role: String,
444 pub wasm_store_locator: String,
445 pub expected_artifact_identity: String,
446 pub observed_artifact_identity: Option<String>,
447 pub expected_published_chunk_count: usize,
448 pub observed_published_chunk_count: Option<usize>,
449 pub catalog_entry_present: bool,
450 pub catalog_matches: bool,
451 pub catalog_observation_digest: String,
452}
453
454#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
458pub struct PromotionArtifactIdentityGroupV1 {
459 pub identity_key: String,
460 pub identity_kind: PromotionArtifactIdentityKindV1,
461 pub roles: Vec<String>,
462 pub source_kinds: Vec<RoleArtifactSourceKindV1>,
463 pub source_locators: Vec<String>,
464 pub digest_pinned: bool,
465 pub wasm_sha256: Option<String>,
466 pub wasm_gz_sha256: Option<String>,
467 pub candid_sha256: Option<String>,
468 pub canonical_embedded_config_sha256: Option<String>,
469}
470
471#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
475pub struct RolePromotionArtifactIdentityV1 {
476 pub role: String,
477 pub promotion_level: PromotionArtifactLevelV1,
478 pub source_kind: RoleArtifactSourceKindV1,
479 pub source_locator: Option<String>,
480 pub identity_kind: PromotionArtifactIdentityKindV1,
481 pub digest_pinned: bool,
482 pub wasm_sha256: Option<String>,
483 pub wasm_gz_sha256: Option<String>,
484 pub candid_sha256: Option<String>,
485 pub canonical_embedded_config_sha256: Option<String>,
486}
487
488#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
492pub enum PromotionArtifactIdentityKindV1 {
493 SealedWasm,
494 SealedCompressedWasm,
495 SealedWasmAndCompressedWasm,
496 SourceBuild,
497 Deferred,
498}
499
500#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
504pub struct PromotionReadinessV1 {
505 pub schema_version: u32,
506 pub readiness_id: String,
507 pub promotion_readiness_digest: String,
508 pub target_plan_id: String,
509 pub status: PromotionReadinessStatusV1,
510 pub roles: Vec<RolePromotionReadinessV1>,
511 pub blockers: Vec<SafetyFindingV1>,
512 pub warnings: Vec<SafetyFindingV1>,
513}
514
515#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
519pub struct PromotionPlanTransformV1 {
520 pub schema_version: u32,
521 pub transform_id: String,
522 pub target_plan_id: String,
523 pub promoted_plan_id: String,
524 pub promotion_plan_lineage_digest: String,
525 pub promoted_plan: DeploymentPlanV1,
526 pub roles: Vec<RolePromotionPlanTransformV1>,
527}
528
529#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
533pub struct ArtifactPromotionPlanV1 {
534 pub schema_version: u32,
535 pub plan_id: String,
536 pub artifact_promotion_plan_digest: String,
537 pub generated_at: String,
538 pub status: PromotionReadinessStatusV1,
539 pub target_plan_id: String,
540 pub promoted_plan_id: String,
541 pub promotion_plan_lineage_digest: String,
542 pub readiness: PromotionReadinessV1,
543 pub artifact_identity_report: PromotionArtifactIdentityReportV1,
544 pub transform: PromotionPlanTransformV1,
545 pub target_execution_lineage: Option<PromotionTargetExecutionLineageV1>,
546 pub blockers: Vec<SafetyFindingV1>,
547}
548
549#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
553pub struct ArtifactPromotionProvenanceReportV1 {
554 pub schema_version: u32,
555 pub report_id: String,
556 pub status: PromotionReadinessStatusV1,
557 pub artifact_promotion_plan_id: String,
558 pub artifact_promotion_plan_digest: String,
559 pub target_plan_id: String,
560 pub promoted_plan_id: String,
561 pub promotion_plan_lineage_digest: String,
562 pub provenance_report_digest: String,
563 pub readiness_id: String,
564 pub artifact_identity_report_id: String,
565 pub transform_id: String,
566 pub target_execution_lineage_id: Option<String>,
567 pub wasm_store_identity_report_id: Option<String>,
568 pub wasm_store_identity_report_digest: Option<String>,
569 pub wasm_store_catalog_verification_id: Option<String>,
570 pub wasm_store_catalog_verification_digest: Option<String>,
571 pub materialization_identity_report_id: Option<String>,
572 pub materialization_identity_report_digest: Option<String>,
573 pub execution_attempted: bool,
574 pub roles: Vec<RolePromotionProvenanceV1>,
575 pub blockers: Vec<SafetyFindingV1>,
576}
577
578#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
582pub struct ArtifactPromotionExecutionReceiptV1 {
583 pub schema_version: u32,
584 pub receipt_id: String,
585 pub execution_receipt_digest: String,
586 pub artifact_promotion_plan_id: String,
587 pub artifact_promotion_plan_digest: String,
588 pub provenance_report_id: String,
589 pub provenance_report_digest: String,
590 pub provenance_status: PromotionReadinessStatusV1,
591 pub promoted_plan_id: String,
592 pub promotion_plan_lineage_digest: String,
593 pub operation_id: String,
594 pub operation_status: DeploymentExecutionStatusV1,
595 pub command_result: DeploymentCommandResultV1,
596 pub started_at: String,
597 pub finished_at: Option<String>,
598 pub deployment_receipt: DeploymentReceiptV1,
599 pub roles: Vec<RolePromotionExecutionReceiptV1>,
600}
601
602#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
606pub struct RolePromotionExecutionReceiptV1 {
607 pub role: String,
608 pub promotion_level: PromotionArtifactLevelV1,
609 pub materialization_evidence_id: Option<String>,
610 pub materialization_evidence_digest: Option<String>,
611 pub wasm_store_locator: Option<String>,
612 pub wasm_store_catalog_observation_digest: Option<String>,
613 pub role_phase_result: Option<RolePhaseResultV1>,
614 pub artifact_digest: Option<String>,
615 pub observed_module_hash_after: Option<String>,
616 pub canonical_embedded_config_sha256: Option<String>,
617}
618
619#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
623pub struct RolePromotionProvenanceV1 {
624 pub role: String,
625 pub promotion_level: PromotionArtifactLevelV1,
626 pub source_kind: RoleArtifactSourceKindV1,
627 pub artifact_identity_changed: bool,
628 pub embedded_config_changed: bool,
629 pub target_materialization_preserved: bool,
630 pub materialization_evidence_id: Option<String>,
631 pub materialization_evidence_digest: Option<String>,
632 pub wasm_store_locator: Option<String>,
633 pub wasm_store_catalog_observation_digest: Option<String>,
634}
635
636#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
640pub struct PromotionPlanTransformEvidenceV1 {
641 pub schema_version: u32,
642 pub evidence_id: String,
643 pub promotion_plan_transform_evidence_digest: String,
644 pub generated_at: String,
645 pub transform: PromotionPlanTransformV1,
646}
647
648#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
652pub struct PromotionTargetExecutionLineageV1 {
653 pub schema_version: u32,
654 pub lineage_id: String,
655 pub generated_at: String,
656 pub target_execution_lineage_digest: String,
657 pub transform: PromotionPlanTransformV1,
658 pub execution_preflight: DeploymentExecutionPreflightV1,
659 pub execution_attempted: bool,
660}
661
662#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
666pub struct RolePromotionPlanTransformV1 {
667 pub role: String,
668 pub promotion_level: PromotionArtifactLevelV1,
669 pub source_kind: RoleArtifactSourceKindV1,
670 pub source_locator: Option<String>,
671 pub artifact_source_before: ArtifactSourceV1,
672 pub artifact_source_after: ArtifactSourceV1,
673 pub wasm_sha256_before: Option<String>,
674 pub wasm_sha256_after: Option<String>,
675 pub wasm_gz_sha256_before: Option<String>,
676 pub wasm_gz_sha256_after: Option<String>,
677 pub candid_sha256_before: Option<String>,
678 pub candid_sha256_after: Option<String>,
679 pub canonical_embedded_config_sha256_before: Option<String>,
680 pub canonical_embedded_config_sha256_after: Option<String>,
681 pub artifact_identity_changed: bool,
682 pub embedded_config_changed: bool,
683 pub target_materialization_preserved: bool,
684 pub source_build_materialization: Option<RolePromotionMaterializationLinkV1>,
685}
686
687#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
691pub struct RolePromotionMaterializationLinkV1 {
692 pub role: String,
693 pub evidence_id: String,
694 pub materialization_evidence_digest: String,
695 pub recipe_id: String,
696 pub materialization_input_id: String,
697 pub materialization_result_id: String,
698 pub materialization_input_digest: String,
699 pub wasm_sha256: String,
700 pub wasm_gz_sha256: String,
701 pub installed_module_hash: String,
702 pub candid_sha256: String,
703}
704
705#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
709pub enum PromotionReadinessStatusV1 {
710 Ready,
711 Blocked,
712}
713
714#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
718pub struct RolePromotionReadinessV1 {
719 pub role: String,
720 pub promotion_level: PromotionArtifactLevelV1,
721 pub source_kind: RoleArtifactSourceKindV1,
722 pub source_locator: Option<String>,
723 pub source_wasm_sha256: Option<String>,
724 pub source_wasm_gz_sha256: Option<String>,
725 pub target_wasm_sha256: Option<String>,
726 pub target_wasm_gz_sha256: Option<String>,
727 pub source_canonical_embedded_config_sha256: Option<String>,
728 pub target_canonical_embedded_config_sha256: Option<String>,
729 pub byte_identical_wasm: Option<bool>,
730 pub embedded_config_identical: Option<bool>,
731 pub target_store_has_artifact: Option<bool>,
732 pub restage_required: bool,
733}
734
735#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
739pub enum RoleArtifactSourceKindV1 {
740 WorkspacePackage,
741 PublishedPackage,
742 LocalWasm,
743 LocalWasmGz,
744 PreviousReceiptArtifact,
745 CanonicalWasmStoreDefault,
746}
747
748#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
752pub enum PreviousArtifactReceiptKindV1 {
753 DeploymentReceipt,
754 StagingReceipt,
755}
756
757#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
761pub struct AuthorityReceiptV1 {
762 pub schema_version: u32,
763 pub operation_id: String,
764 pub check_id: Option<String>,
765 pub reconciliation_plan_id: String,
766 pub authority_report_id: String,
767 pub inventory_id: String,
768 pub authority_profile_hash: Option<String>,
769 pub operation_status: DeploymentExecutionStatusV1,
770 pub started_at: String,
771 pub finished_at: Option<String>,
772 pub attempted_actions: Vec<AuthorityAttemptedActionV1>,
773 pub verified_controller_observations: Vec<AuthorityControllerObservationV1>,
774 pub hard_failures: Vec<SafetyFindingV1>,
775 pub unresolved_observation_gaps: Vec<DeploymentObservationGapV1>,
776 pub unresolved_external_actions: Vec<AuthorityExternalActionV1>,
777 pub command_result: DeploymentCommandResultV1,
778}
779
780#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
784pub struct AuthorityDryRunEvidenceV1 {
785 pub schema_version: u32,
786 pub evidence_id: String,
787 pub check_id: String,
788 pub generated_at: String,
789 pub reconciliation_plan: AuthorityReconciliationPlanV1,
790 pub authority_report: AuthorityReportV1,
791 pub authority_receipt: AuthorityReceiptV1,
792}
793
794#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
798pub struct AuthorityAttemptedActionV1 {
799 pub subject: String,
800 pub canister_id: Option<String>,
801 pub role: Option<String>,
802 pub action: AuthorityActionV1,
803 pub result: RolePhaseResultV1,
804 pub error: Option<String>,
805}
806
807#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
811pub struct AuthorityControllerObservationV1 {
812 pub subject: String,
813 pub canister_id: Option<String>,
814 pub role: Option<String>,
815 pub state: AuthorityReconciliationStateV1,
816 pub action: AuthorityActionV1,
817 pub observed_controllers: Vec<String>,
818 pub desired_controllers: Vec<String>,
819 pub controller_delta: AuthorityControllerDeltaV1,
820}
821
822#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
826pub struct RoleArtifactManifestV1 {
827 pub schema_version: u32,
828 pub manifest_id: String,
829 pub network: String,
830 pub artifact_root: Option<String>,
831 pub role_artifacts: Vec<RoleArtifactV1>,
832 pub unresolved_artifacts: Vec<DeploymentObservationGapV1>,
833}
834
835#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
839pub struct DeploymentDiffV1 {
840 pub schema_version: u32,
841 pub plan_identity: DeploymentIdentityV1,
842 pub observed_identity: Option<DeploymentIdentityV1>,
843 pub artifact_diff: Vec<DiffItemV1>,
844 pub controller_diff: Vec<DiffItemV1>,
845 pub pool_diff: Vec<DiffItemV1>,
846 pub embedded_config_diff: Vec<DiffItemV1>,
847 pub module_hash_diff: Vec<DiffItemV1>,
848 pub verifier_readiness_diff: Vec<DiffItemV1>,
849 pub resume_safety: ResumeSafetyV1,
850 pub hard_failures: Vec<SafetyFindingV1>,
851 pub warnings: Vec<SafetyFindingV1>,
852 pub resumable_phases: Vec<String>,
853}
854
855#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
859pub struct SafetyReportV1 {
860 pub schema_version: u32,
861 pub report_id: String,
862 pub diff_id: Option<String>,
863 pub status: SafetyStatusV1,
864 pub summary: String,
865 pub hard_failures: Vec<SafetyFindingV1>,
866 pub warnings: Vec<SafetyFindingV1>,
867 pub next_actions: Vec<String>,
868}
869
870#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
874pub struct DeploymentCheckV1 {
875 pub schema_version: u32,
876 pub check_id: String,
877 pub plan: DeploymentPlanV1,
878 pub inventory: DeploymentInventoryV1,
879 pub diff: DeploymentDiffV1,
880 pub report: SafetyReportV1,
881}
882
883#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
887pub struct AuthorityReconciliationPlanV1 {
888 pub schema_version: u32,
889 pub plan_id: String,
890 pub inventory_id: String,
891 pub authority_profile_hash: Option<String>,
892 pub canister_actions: Vec<CanisterAuthorityActionV1>,
893 pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
894 pub hard_failures: Vec<SafetyFindingV1>,
895 pub external_actions_required: Vec<AuthorityExternalActionV1>,
896}
897
898#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
902pub struct AuthorityAutomaticActionV1 {
903 pub subject: String,
904 pub canister_id: String,
905 pub role: Option<String>,
906 pub action: AuthorityActionV1,
907 pub observed_controllers: Vec<String>,
908 pub desired_controllers: Vec<String>,
909 pub controller_delta: AuthorityControllerDeltaV1,
910 pub reason: String,
911}
912
913#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
917pub struct AuthorityControllerDeltaV1 {
918 pub add_controllers: Vec<String>,
919 pub remove_controllers: Vec<String>,
920}
921
922#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
926pub struct AuthorityReportV1 {
927 pub schema_version: u32,
928 pub report_id: String,
929 pub check_id: Option<String>,
930 pub reconciliation_plan_id: String,
931 pub inventory_id: String,
932 pub authority_profile_hash: Option<String>,
933 pub status: SafetyStatusV1,
934 pub summary: String,
935 pub counts: AuthorityReportCountsV1,
936 pub apply_readiness: AuthorityApplyReadinessV1,
937 pub action_counts: Vec<AuthorityActionCountV1>,
938 pub control_class_counts: Vec<AuthorityControlClassCountV1>,
939 pub observation_gaps: Vec<DeploymentObservationGapV1>,
940 pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
941 pub hard_failures: Vec<SafetyFindingV1>,
942 pub external_actions_required: Vec<AuthorityExternalActionV1>,
943 pub next_actions: Vec<String>,
944}
945
946#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
950pub struct AuthorityApplyReadinessV1 {
951 pub can_apply_automatically: bool,
952 pub automatic_action_count: usize,
953 pub blockers: Vec<AuthorityApplyBlockerV1>,
954}
955
956#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
960pub enum AuthorityApplyBlockerV1 {
961 UnsafeBlocked,
962 HardFailures,
963 ObservationGaps,
964 ExternalActions,
965}
966
967#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
971pub struct AuthorityActionCountV1 {
972 pub action: AuthorityActionV1,
973 pub count: usize,
974}
975
976#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
980pub struct AuthorityControlClassCountV1 {
981 pub control_class: CanisterControlClassV1,
982 pub count: usize,
983}
984
985#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
989pub struct AuthorityReportCountsV1 {
990 pub already_correct: usize,
991 pub can_apply_automatically: usize,
992 pub requires_external_action: usize,
993 pub unsafe_blocked: usize,
994 pub unknown: usize,
995 pub hard_failures: usize,
996}
997
998#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1002pub struct CanisterAuthorityActionV1 {
1003 pub canister_id: Option<String>,
1004 pub role: Option<String>,
1005 pub control_classification: CanisterControlClassV1,
1006 pub observed_controllers: Vec<String>,
1007 pub desired_controllers: Vec<String>,
1008 pub controller_delta: AuthorityControllerDeltaV1,
1009 pub action: AuthorityActionV1,
1010 pub state: AuthorityReconciliationStateV1,
1011 pub can_apply: bool,
1012 pub reason: String,
1013}
1014
1015#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1019pub struct AuthorityExternalActionV1 {
1020 pub subject: String,
1021 pub canister_id: Option<String>,
1022 pub role: Option<String>,
1023 pub control_classification: CanisterControlClassV1,
1024 pub state: AuthorityReconciliationStateV1,
1025 pub action: AuthorityActionV1,
1026 pub observed_controllers: Vec<String>,
1027 pub desired_controllers: Vec<String>,
1028 pub controller_delta: AuthorityControllerDeltaV1,
1029 pub reason: String,
1030}
1031
1032#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1036pub enum AuthorityActionV1 {
1037 None,
1038 AddControllers,
1039 RemoveControllers,
1040 ReplaceControllerSet,
1041 RequiresExternalController,
1042 RequiresDestructiveImportConfirmation,
1043 ObserveOnly,
1044 AdoptPlanAvailable,
1045 BlockedByPolicy,
1046 UnknownObservation,
1047}
1048
1049#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1053pub enum AuthorityReconciliationStateV1 {
1054 AlreadyCorrect,
1055 CanApplyAutomatically,
1056 RequiresExternalAction,
1057 UnsafeBlocked,
1058 Unknown,
1059}
1060
1061#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1065pub struct DeploymentIdentityV1 {
1066 pub deployment_name: String,
1067 pub network: String,
1068 pub root_principal: Option<String>,
1069 pub authority_profile_hash: Option<String>,
1070 pub role_topology_hash: Option<String>,
1071 pub deployment_manifest_digest: Option<String>,
1072 pub canonical_runtime_config_digest: Option<String>,
1073 pub role_embedded_config_set_digest: Option<String>,
1074 pub artifact_set_digest: Option<String>,
1075 pub pool_identity_set_digest: Option<String>,
1076 pub canic_version: Option<String>,
1077 pub ic_memory_version: Option<String>,
1078}
1079
1080#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1084pub struct TrustDomainV1 {
1085 pub root_trust_anchor: Option<String>,
1086 pub migration_from: Option<String>,
1087}
1088
1089#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1093pub struct AuthorityProfileV1 {
1094 pub profile_id: String,
1095 pub expected_controllers: Vec<String>,
1096 pub staging_controllers: Vec<String>,
1097 pub emergency_controllers: Vec<String>,
1098}
1099
1100#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1104pub struct RoleArtifactV1 {
1105 pub role: String,
1106 pub source: ArtifactSourceV1,
1107 pub build_profile: String,
1108 pub wasm_path: Option<String>,
1109 pub wasm_gz_path: Option<String>,
1110 pub wasm_gz_size_bytes: Option<u64>,
1111 pub wasm_sha256: Option<String>,
1112 pub wasm_gz_sha256: Option<String>,
1113 pub wasm_gz_sha256_source: Option<ArtifactDigestSourceV1>,
1114 pub observed_wasm_gz_file_sha256: Option<String>,
1115 pub observed_wasm_gz_file_sha256_source: Option<ArtifactDigestSourceV1>,
1116 pub installed_module_hash: Option<String>,
1117 pub candid_path: Option<String>,
1118 pub candid_sha256: Option<String>,
1119 pub raw_config_sha256: Option<String>,
1120 pub canonical_embedded_config_sha256: Option<String>,
1121 pub embedded_topology_sha256: Option<String>,
1122 pub builder_version: Option<String>,
1123 pub rust_toolchain: Option<String>,
1124 pub package_version: Option<String>,
1125}
1126
1127#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1131pub enum ArtifactDigestSourceV1 {
1132 ReleaseSetManifest,
1133 ObservedFileDigest,
1134 InstalledModuleHash,
1135}
1136
1137#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1141pub enum ArtifactSourceV1 {
1142 LocalBuild,
1143 ReleaseSet,
1144 WasmStore,
1145 External,
1146 Unknown,
1147}
1148
1149#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1153pub struct ExpectedCanisterV1 {
1154 pub role: String,
1155 pub canister_id: Option<String>,
1156 pub control_class: CanisterControlClassV1,
1157}
1158
1159#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1163pub struct ObservedCanisterV1 {
1164 pub canister_id: String,
1165 pub role: Option<String>,
1166 pub control_class: CanisterControlClassV1,
1167 pub controllers: Vec<String>,
1168 pub module_hash: Option<String>,
1169 pub status: Option<String>,
1170 pub root_trust_anchor: Option<String>,
1171 pub canonical_embedded_config_digest: Option<String>,
1172 pub role_assignment_source: Option<String>,
1173}
1174
1175#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1179pub enum CanisterControlClassV1 {
1180 DeploymentControlled,
1181 CanicManagedPool,
1182 ExternallyImported,
1183 JointlyControlled,
1184 UserControlled,
1185 UnknownUnsafe,
1186}
1187
1188#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1192pub struct ExpectedPoolCanisterV1 {
1193 pub pool: String,
1194 pub canister_id: Option<String>,
1195 pub role: Option<String>,
1196}
1197
1198#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1202pub struct ObservedPoolCanisterV1 {
1203 pub pool: String,
1204 pub canister_id: String,
1205 pub role: Option<String>,
1206 pub control_class: CanisterControlClassV1,
1207}
1208
1209#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1213pub struct LocalDeploymentConfigV1 {
1214 pub config_path: Option<String>,
1215 pub raw_config_sha256: Option<String>,
1216 pub canonical_embedded_config_sha256: Option<String>,
1217}
1218
1219#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1223pub struct ObservedArtifactV1 {
1224 pub role: String,
1225 pub artifact_path: String,
1226 pub file_sha256: Option<String>,
1227 pub file_sha256_source: Option<ArtifactDigestSourceV1>,
1228 pub payload_sha256: Option<String>,
1229 pub payload_size_bytes: Option<u64>,
1230 pub source: ArtifactSourceV1,
1231}
1232
1233#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1237pub struct VerifierReadinessExpectationV1 {
1238 pub required: bool,
1239 pub expected_role_epochs: Vec<RoleEpochExpectationV1>,
1240}
1241
1242#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1246pub struct VerifierReadinessObservationV1 {
1247 pub status: ObservationStatusV1,
1248 pub role_epochs: Vec<RoleEpochObservationV1>,
1249}
1250
1251#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1255pub struct RoleEpochExpectationV1 {
1256 pub role: String,
1257 pub minimum_epoch: u64,
1258}
1259
1260#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1264pub struct RoleEpochObservationV1 {
1265 pub role: String,
1266 pub observed_epoch: Option<u64>,
1267 pub status: ObservationStatusV1,
1268}
1269
1270#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1274pub struct DeploymentAssumptionV1 {
1275 pub key: String,
1276 pub description: String,
1277}
1278
1279#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1283pub struct DeploymentObservationGapV1 {
1284 pub key: String,
1285 pub description: String,
1286}
1287
1288#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1292pub struct PhaseReceiptV1 {
1293 pub phase: String,
1294 pub started_at: String,
1295 pub finished_at: Option<String>,
1296 pub attempted_action: String,
1297 pub verified_postcondition: VerifiedPostconditionV1,
1298}
1299
1300#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1304pub struct VerifiedPostconditionV1 {
1305 pub status: ObservationStatusV1,
1306 pub evidence: Vec<String>,
1307}
1308
1309#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1313pub enum DeploymentExecutionStatusV1 {
1314 NotStarted,
1315 InProgress,
1316 FailedBeforeMutation,
1317 PartiallyApplied,
1318 FailedAfterMutation,
1319 Complete,
1320}
1321
1322#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1326pub enum DeploymentCommandResultV1 {
1327 NotFinished,
1328 Succeeded,
1329 Failed { code: String, message: String },
1330}
1331
1332#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1336pub struct RolePhaseReceiptV1 {
1337 pub role: String,
1338 pub phase: String,
1339 pub result: RolePhaseResultV1,
1340 pub previous_module_hash: Option<String>,
1341 pub target_module_hash: Option<String>,
1342 pub observed_module_hash_after: Option<String>,
1343 pub artifact_digest: Option<String>,
1344 pub canonical_embedded_config_sha256: Option<String>,
1345 pub error: Option<String>,
1346}
1347
1348#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1352pub enum RolePhaseResultV1 {
1353 Applied,
1354 Failed,
1355 Skipped,
1356 NotAttempted,
1357 VerifiedAlreadyApplied,
1358}
1359
1360#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1364pub struct DiffItemV1 {
1365 pub category: String,
1366 pub subject: String,
1367 pub expected: Option<String>,
1368 pub observed: Option<String>,
1369 pub severity: SafetySeverityV1,
1370}
1371
1372#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1376pub struct ResumeSafetyV1 {
1377 pub status: SafetyStatusV1,
1378 pub reasons: Vec<String>,
1379}
1380
1381#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1385pub struct SafetyFindingV1 {
1386 pub code: String,
1387 pub message: String,
1388 pub severity: SafetySeverityV1,
1389 pub subject: Option<String>,
1390}
1391
1392#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1396pub enum SafetyStatusV1 {
1397 NotEvaluated,
1398 Safe,
1399 Warning,
1400 Blocked,
1401}
1402
1403#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1407pub enum SafetySeverityV1 {
1408 Info,
1409 Warning,
1410 HardFailure,
1411}
1412
1413#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1417pub enum ObservationStatusV1 {
1418 NotObserved,
1419 Observed,
1420 Missing,
1421 Inconclusive,
1422}