canic_host/deployment_truth/
model.rs

1use serde::{Deserialize, Serialize};
2
3///
4/// DeploymentPlanV1
5///
6#[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///
23/// DeploymentInventoryV1
24///
25#[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///
40/// DeploymentReceiptV1
41///
42#[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///
61/// DeploymentExecutionContextV1
62///
63#[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///
73/// DeploymentExecutionPreflightV1
74///
75#[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///
90/// DeploymentExecutionPreflightStatusV1
91///
92#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
93pub enum DeploymentExecutionPreflightStatusV1 {
94    Ready,
95    Blocked,
96}
97
98///
99/// DeploymentExecutorBackendV1
100///
101#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
102pub enum DeploymentExecutorBackendV1 {
103    CurrentCli,
104    PocketIc,
105    DirectAgent,
106    Other { name: String },
107}
108
109///
110/// DeploymentExecutorCapabilityV1
111///
112#[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///
124/// ArtifactTransportV1
125///
126#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
127pub enum ArtifactTransportV1 {
128    LocalCli,
129    WasmStore,
130    DirectAgent,
131}
132
133///
134/// StagingReceiptV1
135///
136#[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///
149/// RoleArtifactSourceV1
150///
151#[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///
165/// RolePromotionInputV1
166///
167#[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///
178/// RolePromotionPolicyV1
179///
180#[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///
188/// PromotionPolicyRequirementV1
189///
190#[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///
200/// PromotionPolicyClaimV1
201///
202#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
203pub enum PromotionPolicyClaimV1 {
204    ByteIdenticalWasm,
205    TargetConfigDigest,
206}
207
208///
209/// PromotionPolicyCheckV1
210///
211#[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///
222/// RolePromotionPolicyDecisionV1
223///
224#[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///
236/// PromotionArtifactLevelV1
237///
238#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
239pub enum PromotionArtifactLevelV1 {
240    SealedWasm,
241    SourceBuild,
242}
243
244///
245/// BuildRecipeIdentityV1
246///
247#[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///
267/// BuildMaterializationInputV1
268///
269#[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///
280/// BuildMaterializationResultV1
281///
282#[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///
294/// BuildMaterializationEvidenceV1
295///
296#[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///
311/// PromotionMaterializationIdentityReportV1
312///
313#[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///
325/// RolePromotionMaterializationIdentityV1
326///
327#[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///
347/// PromotionMaterializationOutputGroupV1
348///
349#[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///
360/// PromotionArtifactIdentityReportV1
361///
362#[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///
375/// PromotionArtifactIdentitySummaryV1
376///
377#[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///
388/// PromotionWasmStoreIdentityReportV1
389///
390#[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///
401/// RolePromotionWasmStoreIdentityV1
402///
403#[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///
415/// PromotionWasmStoreCatalogEntryV1
416///
417#[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///
425/// PromotionWasmStoreCatalogVerificationV1
426///
427#[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///
439/// RolePromotionWasmStoreCatalogVerificationV1
440///
441#[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///
455/// PromotionArtifactIdentityGroupV1
456///
457#[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///
472/// RolePromotionArtifactIdentityV1
473///
474#[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///
489/// PromotionArtifactIdentityKindV1
490///
491#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
492pub enum PromotionArtifactIdentityKindV1 {
493    SealedWasm,
494    SealedCompressedWasm,
495    SealedWasmAndCompressedWasm,
496    SourceBuild,
497    Deferred,
498}
499
500///
501/// PromotionReadinessV1
502///
503#[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///
516/// PromotionPlanTransformV1
517///
518#[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///
530/// ArtifactPromotionPlanV1
531///
532#[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///
550/// ArtifactPromotionProvenanceReportV1
551///
552#[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///
579/// ArtifactPromotionExecutionReceiptV1
580///
581#[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///
603/// RolePromotionExecutionReceiptV1
604///
605#[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///
620/// RolePromotionProvenanceV1
621///
622#[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///
637/// PromotionPlanTransformEvidenceV1
638///
639#[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///
649/// PromotionTargetExecutionLineageV1
650///
651#[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///
663/// RolePromotionPlanTransformV1
664///
665#[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///
688/// RolePromotionMaterializationLinkV1
689///
690#[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///
706/// PromotionReadinessStatusV1
707///
708#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
709pub enum PromotionReadinessStatusV1 {
710    Ready,
711    Blocked,
712}
713
714///
715/// RolePromotionReadinessV1
716///
717#[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///
736/// RoleArtifactSourceKindV1
737///
738#[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///
749/// PreviousArtifactReceiptKindV1
750///
751#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
752pub enum PreviousArtifactReceiptKindV1 {
753    DeploymentReceipt,
754    StagingReceipt,
755}
756
757///
758/// AuthorityReceiptV1
759///
760#[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///
781/// AuthorityDryRunEvidenceV1
782///
783#[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///
795/// AuthorityAttemptedActionV1
796///
797#[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///
808/// AuthorityControllerObservationV1
809///
810#[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///
823/// RoleArtifactManifestV1
824///
825#[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///
836/// DeploymentDiffV1
837///
838#[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///
856/// SafetyReportV1
857///
858#[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///
871/// DeploymentCheckV1
872///
873#[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///
884/// LifecycleAuthorityReportV1
885///
886#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
887pub struct LifecycleAuthorityReportV1 {
888    pub schema_version: u32,
889    pub report_id: String,
890    pub check_id: String,
891    pub plan_id: String,
892    pub inventory_id: String,
893    pub authorities: Vec<LifecycleAuthorityV1>,
894    pub external_action_required_count: usize,
895    pub blocked_count: usize,
896}
897
898///
899/// LifecycleAuthorityV1
900///
901#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
902pub struct LifecycleAuthorityV1 {
903    pub subject: String,
904    pub canister_id: Option<String>,
905    pub role: Option<String>,
906    pub control_class: CanisterControlClassV1,
907    pub lifecycle_mode: LifecycleModeV1,
908    pub observed_controllers: Vec<String>,
909    pub expected_deployment_controllers: Vec<String>,
910    pub external_controllers: Vec<String>,
911    pub required_controllers: Vec<String>,
912    pub consent_requirements: Vec<ConsentRequirementV1>,
913    pub allowed_upgrade_modes: Vec<LifecycleUpgradeModeV1>,
914    pub verification_requirements: Vec<LifecycleVerificationRequirementV1>,
915    pub external_action_required: bool,
916    pub blocked: bool,
917    pub blockers: Vec<String>,
918    pub warnings: Vec<String>,
919    pub reason: String,
920}
921
922///
923/// LifecycleModeV1
924///
925#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
926pub enum LifecycleModeV1 {
927    DirectDeploymentAuthority,
928    ProposalRequired,
929    DelegatedInstallRequired,
930    ExternalCompletionOnly,
931    VerifyOnly,
932    MustNotTouch,
933    UnknownUnsafeBlocked,
934}
935
936///
937/// LifecycleUpgradeModeV1
938///
939#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
940pub enum LifecycleUpgradeModeV1 {
941    DirectByDeploymentAuthority,
942    ExternalProposal,
943    ExternalExecution,
944    VerifyExternalCompletion,
945    ObserveOnly,
946    Blocked,
947}
948
949///
950/// LifecycleVerificationRequirementV1
951///
952#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
953pub enum LifecycleVerificationRequirementV1 {
954    LiveInventory,
955    ControllerObservation,
956    ModuleHash,
957    CanonicalEmbeddedConfig,
958    ProtectedCallReadiness,
959}
960
961///
962/// ConsentRequirementV1
963///
964#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
965pub struct ConsentRequirementV1 {
966    pub consent_subject_kind: ConsentSubjectKindV1,
967    pub required_principals: Vec<String>,
968    pub required_controller_set_digest: Option<String>,
969    pub consent_channel_kind: ConsentChannelKindV1,
970    pub required_action: ExternalUpgradeAuthorizationModeV1,
971}
972
973///
974/// ConsentSubjectKindV1
975///
976#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
977pub enum ConsentSubjectKindV1 {
978    UserPrincipal,
979    ProjectHub,
980    GovernanceCanister,
981    CustomerController,
982    DelegatedInstallCanister,
983    MultisigAuthority,
984    UnknownExternalController,
985}
986
987///
988/// ConsentChannelKindV1
989///
990#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
991pub enum ConsentChannelKindV1 {
992    OutOfBand,
993    GeneratedCommand,
994    DelegatedInstall,
995    GovernanceProposal,
996    ApplicationSpecific,
997}
998
999///
1000/// ExternalLifecyclePlanV1
1001///
1002#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1003pub struct ExternalLifecyclePlanV1 {
1004    pub schema_version: u32,
1005    pub lifecycle_plan_id: String,
1006    pub lifecycle_plan_digest: String,
1007    pub lifecycle_authority_report_id: String,
1008    pub deployment_plan_id: String,
1009    pub deployment_plan_digest: String,
1010    pub inventory_id: String,
1011    pub lifecycle_authority_rows: Vec<LifecycleAuthorityV1>,
1012    pub directly_executable_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1013    pub proposed_external_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1014    pub blocked_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1015    pub dependency_blockers: Vec<String>,
1016    pub protected_call_implications: Vec<String>,
1017    pub residual_exposure: Vec<String>,
1018    pub status: ExternalLifecyclePlanStatusV1,
1019}
1020
1021///
1022/// ExternalLifecycleRoleUpgradeV1
1023///
1024#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1025pub struct ExternalLifecycleRoleUpgradeV1 {
1026    pub subject: String,
1027    pub canister_id: Option<String>,
1028    pub role: Option<String>,
1029    pub control_class: CanisterControlClassV1,
1030    pub lifecycle_mode: LifecycleModeV1,
1031    pub required_external_action: Option<String>,
1032    pub blockers: Vec<String>,
1033    pub warnings: Vec<String>,
1034}
1035
1036///
1037/// ExternalLifecyclePlanStatusV1
1038///
1039#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1040pub enum ExternalLifecyclePlanStatusV1 {
1041    Ready,
1042    PendingExternalAction,
1043    Blocked,
1044}
1045
1046///
1047/// ExternalUpgradeProposalReportV1
1048///
1049#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1050pub struct ExternalUpgradeProposalReportV1 {
1051    pub schema_version: u32,
1052    pub report_id: String,
1053    pub lifecycle_plan_id: String,
1054    pub lifecycle_plan_digest: String,
1055    pub deployment_plan_id: String,
1056    pub deployment_plan_digest: String,
1057    pub inventory_id: String,
1058    pub proposals: Vec<ExternalUpgradeProposalV1>,
1059    pub blocked_subjects: Vec<String>,
1060}
1061
1062///
1063/// ExternalUpgradeProposalV1
1064///
1065#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1066pub struct ExternalUpgradeProposalV1 {
1067    pub proposal_id: String,
1068    pub proposal_digest: String,
1069    pub deployment_plan_id: String,
1070    pub deployment_plan_digest: String,
1071    pub lifecycle_plan_id: String,
1072    pub lifecycle_plan_digest: String,
1073    pub promotion_plan_id: Option<String>,
1074    pub promotion_plan_digest: Option<String>,
1075    pub promotion_provenance_id: Option<String>,
1076    pub promotion_provenance_digest: Option<String>,
1077    pub subject: String,
1078    pub canister_id: Option<String>,
1079    pub role: Option<String>,
1080    pub control_class: CanisterControlClassV1,
1081    pub lifecycle_mode: LifecycleModeV1,
1082    pub observed_before_digest: String,
1083    pub current_module_hash: Option<String>,
1084    pub current_canonical_embedded_config_sha256: Option<String>,
1085    pub target_wasm_sha256: Option<String>,
1086    pub target_wasm_gz_sha256: Option<String>,
1087    pub target_installed_module_hash: Option<String>,
1088    pub target_role_artifact_identity: Option<String>,
1089    pub target_canonical_embedded_config_sha256: Option<String>,
1090    pub root_trust_anchor: Option<String>,
1091    pub authority_profile_hash: Option<String>,
1092    pub required_external_action: String,
1093    pub consent_requirements: Vec<ConsentRequirementV1>,
1094    pub allowed_authorization_modes: Vec<ExternalUpgradeAuthorizationModeV1>,
1095    pub verification_requirements: Vec<LifecycleVerificationRequirementV1>,
1096    pub expires_at: Option<String>,
1097    pub supersedes_proposal_id: Option<String>,
1098}
1099
1100///
1101/// ExternalUpgradeAuthorizationModeV1
1102///
1103#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1104pub enum ExternalUpgradeAuthorizationModeV1 {
1105    ConsentForDirectInstall,
1106    DelegatedInstallAuthority,
1107    ExternalControllerExecution,
1108    ObserveAndVerifyOnly,
1109}
1110
1111///
1112/// ExternalUpgradeReceiptV1
1113///
1114#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1115pub struct ExternalUpgradeReceiptV1 {
1116    pub schema_version: u32,
1117    pub receipt_id: String,
1118    pub proposal_id: String,
1119    pub proposal_digest: String,
1120    pub subject: String,
1121    pub canister_id: Option<String>,
1122    pub role: Option<String>,
1123    pub consent_state: ExternalUpgradeConsentStateV1,
1124    pub reported_by: Option<String>,
1125    pub observed_before_module_hash: Option<String>,
1126    pub observed_after_module_hash: Option<String>,
1127    pub observed_after_canonical_embedded_config_sha256: Option<String>,
1128    pub verification_result: ExternalUpgradeVerificationResultV1,
1129    pub verification_notes: Vec<String>,
1130    pub receipt_digest: String,
1131}
1132
1133///
1134/// ExternalUpgradeConsentStateV1
1135///
1136#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1137pub enum ExternalUpgradeConsentStateV1 {
1138    Pending,
1139    Refused,
1140    Delegated,
1141    ExecutedExternally,
1142}
1143
1144///
1145/// ExternalUpgradeVerificationResultV1
1146///
1147#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1148pub enum ExternalUpgradeVerificationResultV1 {
1149    Pending,
1150    Refused,
1151    Verified,
1152    Mismatch,
1153}
1154
1155///
1156/// AuthorityReconciliationPlanV1
1157///
1158#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1159pub struct AuthorityReconciliationPlanV1 {
1160    pub schema_version: u32,
1161    pub plan_id: String,
1162    pub inventory_id: String,
1163    pub authority_profile_hash: Option<String>,
1164    pub canister_actions: Vec<CanisterAuthorityActionV1>,
1165    pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
1166    pub hard_failures: Vec<SafetyFindingV1>,
1167    pub external_actions_required: Vec<AuthorityExternalActionV1>,
1168}
1169
1170///
1171/// AuthorityAutomaticActionV1
1172///
1173#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1174pub struct AuthorityAutomaticActionV1 {
1175    pub subject: String,
1176    pub canister_id: String,
1177    pub role: Option<String>,
1178    pub action: AuthorityActionV1,
1179    pub observed_controllers: Vec<String>,
1180    pub desired_controllers: Vec<String>,
1181    pub controller_delta: AuthorityControllerDeltaV1,
1182    pub reason: String,
1183}
1184
1185///
1186/// AuthorityControllerDeltaV1
1187///
1188#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
1189pub struct AuthorityControllerDeltaV1 {
1190    pub add_controllers: Vec<String>,
1191    pub remove_controllers: Vec<String>,
1192}
1193
1194///
1195/// AuthorityReportV1
1196///
1197#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1198pub struct AuthorityReportV1 {
1199    pub schema_version: u32,
1200    pub report_id: String,
1201    pub check_id: Option<String>,
1202    pub reconciliation_plan_id: String,
1203    pub inventory_id: String,
1204    pub authority_profile_hash: Option<String>,
1205    pub status: SafetyStatusV1,
1206    pub summary: String,
1207    pub counts: AuthorityReportCountsV1,
1208    pub apply_readiness: AuthorityApplyReadinessV1,
1209    pub action_counts: Vec<AuthorityActionCountV1>,
1210    pub control_class_counts: Vec<AuthorityControlClassCountV1>,
1211    pub observation_gaps: Vec<DeploymentObservationGapV1>,
1212    pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
1213    pub hard_failures: Vec<SafetyFindingV1>,
1214    pub external_actions_required: Vec<AuthorityExternalActionV1>,
1215    pub next_actions: Vec<String>,
1216}
1217
1218///
1219/// AuthorityApplyReadinessV1
1220///
1221#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1222pub struct AuthorityApplyReadinessV1 {
1223    pub can_apply_automatically: bool,
1224    pub automatic_action_count: usize,
1225    pub blockers: Vec<AuthorityApplyBlockerV1>,
1226}
1227
1228///
1229/// AuthorityApplyBlockerV1
1230///
1231#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1232pub enum AuthorityApplyBlockerV1 {
1233    UnsafeBlocked,
1234    HardFailures,
1235    ObservationGaps,
1236    ExternalActions,
1237}
1238
1239///
1240/// AuthorityActionCountV1
1241///
1242#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1243pub struct AuthorityActionCountV1 {
1244    pub action: AuthorityActionV1,
1245    pub count: usize,
1246}
1247
1248///
1249/// AuthorityControlClassCountV1
1250///
1251#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1252pub struct AuthorityControlClassCountV1 {
1253    pub control_class: CanisterControlClassV1,
1254    pub count: usize,
1255}
1256
1257///
1258/// AuthorityReportCountsV1
1259///
1260#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1261pub struct AuthorityReportCountsV1 {
1262    pub already_correct: usize,
1263    pub can_apply_automatically: usize,
1264    pub requires_external_action: usize,
1265    pub unsafe_blocked: usize,
1266    pub unknown: usize,
1267    pub hard_failures: usize,
1268}
1269
1270///
1271/// CanisterAuthorityActionV1
1272///
1273#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1274pub struct CanisterAuthorityActionV1 {
1275    pub canister_id: Option<String>,
1276    pub role: Option<String>,
1277    pub control_classification: CanisterControlClassV1,
1278    pub observed_controllers: Vec<String>,
1279    pub desired_controllers: Vec<String>,
1280    pub controller_delta: AuthorityControllerDeltaV1,
1281    pub action: AuthorityActionV1,
1282    pub state: AuthorityReconciliationStateV1,
1283    pub can_apply: bool,
1284    pub reason: String,
1285}
1286
1287///
1288/// AuthorityExternalActionV1
1289///
1290#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1291pub struct AuthorityExternalActionV1 {
1292    pub subject: String,
1293    pub canister_id: Option<String>,
1294    pub role: Option<String>,
1295    pub control_classification: CanisterControlClassV1,
1296    pub state: AuthorityReconciliationStateV1,
1297    pub action: AuthorityActionV1,
1298    pub observed_controllers: Vec<String>,
1299    pub desired_controllers: Vec<String>,
1300    pub controller_delta: AuthorityControllerDeltaV1,
1301    pub reason: String,
1302}
1303
1304///
1305/// AuthorityActionV1
1306///
1307#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1308pub enum AuthorityActionV1 {
1309    None,
1310    AddControllers,
1311    RemoveControllers,
1312    ReplaceControllerSet,
1313    RequiresExternalController,
1314    RequiresDestructiveImportConfirmation,
1315    ObserveOnly,
1316    AdoptPlanAvailable,
1317    BlockedByPolicy,
1318    UnknownObservation,
1319}
1320
1321///
1322/// AuthorityReconciliationStateV1
1323///
1324#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1325pub enum AuthorityReconciliationStateV1 {
1326    AlreadyCorrect,
1327    CanApplyAutomatically,
1328    RequiresExternalAction,
1329    UnsafeBlocked,
1330    Unknown,
1331}
1332
1333///
1334/// DeploymentIdentityV1
1335///
1336#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1337pub struct DeploymentIdentityV1 {
1338    pub deployment_name: String,
1339    pub network: String,
1340    pub root_principal: Option<String>,
1341    pub authority_profile_hash: Option<String>,
1342    pub role_topology_hash: Option<String>,
1343    pub deployment_manifest_digest: Option<String>,
1344    pub canonical_runtime_config_digest: Option<String>,
1345    pub role_embedded_config_set_digest: Option<String>,
1346    pub artifact_set_digest: Option<String>,
1347    pub pool_identity_set_digest: Option<String>,
1348    pub canic_version: Option<String>,
1349    pub ic_memory_version: Option<String>,
1350}
1351
1352///
1353/// TrustDomainV1
1354///
1355#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1356pub struct TrustDomainV1 {
1357    pub root_trust_anchor: Option<String>,
1358    pub migration_from: Option<String>,
1359}
1360
1361///
1362/// AuthorityProfileV1
1363///
1364#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1365pub struct AuthorityProfileV1 {
1366    pub profile_id: String,
1367    pub expected_controllers: Vec<String>,
1368    pub staging_controllers: Vec<String>,
1369    pub emergency_controllers: Vec<String>,
1370}
1371
1372///
1373/// RoleArtifactV1
1374///
1375#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1376pub struct RoleArtifactV1 {
1377    pub role: String,
1378    pub source: ArtifactSourceV1,
1379    pub build_profile: String,
1380    pub wasm_path: Option<String>,
1381    pub wasm_gz_path: Option<String>,
1382    pub wasm_gz_size_bytes: Option<u64>,
1383    pub wasm_sha256: Option<String>,
1384    pub wasm_gz_sha256: Option<String>,
1385    pub wasm_gz_sha256_source: Option<ArtifactDigestSourceV1>,
1386    pub observed_wasm_gz_file_sha256: Option<String>,
1387    pub observed_wasm_gz_file_sha256_source: Option<ArtifactDigestSourceV1>,
1388    pub installed_module_hash: Option<String>,
1389    pub candid_path: Option<String>,
1390    pub candid_sha256: Option<String>,
1391    pub raw_config_sha256: Option<String>,
1392    pub canonical_embedded_config_sha256: Option<String>,
1393    pub embedded_topology_sha256: Option<String>,
1394    pub builder_version: Option<String>,
1395    pub rust_toolchain: Option<String>,
1396    pub package_version: Option<String>,
1397}
1398
1399///
1400/// ArtifactDigestSourceV1
1401///
1402#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1403pub enum ArtifactDigestSourceV1 {
1404    ReleaseSetManifest,
1405    ObservedFileDigest,
1406    InstalledModuleHash,
1407}
1408
1409///
1410/// ArtifactSourceV1
1411///
1412#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1413pub enum ArtifactSourceV1 {
1414    LocalBuild,
1415    ReleaseSet,
1416    WasmStore,
1417    External,
1418    Unknown,
1419}
1420
1421///
1422/// ExpectedCanisterV1
1423///
1424#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1425pub struct ExpectedCanisterV1 {
1426    pub role: String,
1427    pub canister_id: Option<String>,
1428    pub control_class: CanisterControlClassV1,
1429}
1430
1431///
1432/// ObservedCanisterV1
1433///
1434#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1435pub struct ObservedCanisterV1 {
1436    pub canister_id: String,
1437    pub role: Option<String>,
1438    pub control_class: CanisterControlClassV1,
1439    pub controllers: Vec<String>,
1440    pub module_hash: Option<String>,
1441    pub status: Option<String>,
1442    pub root_trust_anchor: Option<String>,
1443    pub canonical_embedded_config_digest: Option<String>,
1444    pub role_assignment_source: Option<String>,
1445}
1446
1447///
1448/// CanisterControlClassV1
1449///
1450#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1451pub enum CanisterControlClassV1 {
1452    DeploymentControlled,
1453    CanicManagedPool,
1454    ExternallyImported,
1455    JointlyControlled,
1456    UserControlled,
1457    UnknownUnsafe,
1458}
1459
1460///
1461/// ExpectedPoolCanisterV1
1462///
1463#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1464pub struct ExpectedPoolCanisterV1 {
1465    pub pool: String,
1466    pub canister_id: Option<String>,
1467    pub role: Option<String>,
1468}
1469
1470///
1471/// ObservedPoolCanisterV1
1472///
1473#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1474pub struct ObservedPoolCanisterV1 {
1475    pub pool: String,
1476    pub canister_id: String,
1477    pub role: Option<String>,
1478    pub control_class: CanisterControlClassV1,
1479}
1480
1481///
1482/// LocalDeploymentConfigV1
1483///
1484#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1485pub struct LocalDeploymentConfigV1 {
1486    pub config_path: Option<String>,
1487    pub raw_config_sha256: Option<String>,
1488    pub canonical_embedded_config_sha256: Option<String>,
1489}
1490
1491///
1492/// ObservedArtifactV1
1493///
1494#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1495pub struct ObservedArtifactV1 {
1496    pub role: String,
1497    pub artifact_path: String,
1498    pub file_sha256: Option<String>,
1499    pub file_sha256_source: Option<ArtifactDigestSourceV1>,
1500    pub payload_sha256: Option<String>,
1501    pub payload_size_bytes: Option<u64>,
1502    pub source: ArtifactSourceV1,
1503}
1504
1505///
1506/// VerifierReadinessExpectationV1
1507///
1508#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1509pub struct VerifierReadinessExpectationV1 {
1510    pub required: bool,
1511    pub expected_role_epochs: Vec<RoleEpochExpectationV1>,
1512}
1513
1514///
1515/// VerifierReadinessObservationV1
1516///
1517#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1518pub struct VerifierReadinessObservationV1 {
1519    pub status: ObservationStatusV1,
1520    pub role_epochs: Vec<RoleEpochObservationV1>,
1521}
1522
1523///
1524/// RoleEpochExpectationV1
1525///
1526#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1527pub struct RoleEpochExpectationV1 {
1528    pub role: String,
1529    pub minimum_epoch: u64,
1530}
1531
1532///
1533/// RoleEpochObservationV1
1534///
1535#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1536pub struct RoleEpochObservationV1 {
1537    pub role: String,
1538    pub observed_epoch: Option<u64>,
1539    pub status: ObservationStatusV1,
1540}
1541
1542///
1543/// DeploymentAssumptionV1
1544///
1545#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1546pub struct DeploymentAssumptionV1 {
1547    pub key: String,
1548    pub description: String,
1549}
1550
1551///
1552/// DeploymentObservationGapV1
1553///
1554#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1555pub struct DeploymentObservationGapV1 {
1556    pub key: String,
1557    pub description: String,
1558}
1559
1560///
1561/// PhaseReceiptV1
1562///
1563#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1564pub struct PhaseReceiptV1 {
1565    pub phase: String,
1566    pub started_at: String,
1567    pub finished_at: Option<String>,
1568    pub attempted_action: String,
1569    pub verified_postcondition: VerifiedPostconditionV1,
1570}
1571
1572///
1573/// VerifiedPostconditionV1
1574///
1575#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1576pub struct VerifiedPostconditionV1 {
1577    pub status: ObservationStatusV1,
1578    pub evidence: Vec<String>,
1579}
1580
1581///
1582/// DeploymentExecutionStatusV1
1583///
1584#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1585pub enum DeploymentExecutionStatusV1 {
1586    NotStarted,
1587    InProgress,
1588    FailedBeforeMutation,
1589    PartiallyApplied,
1590    FailedAfterMutation,
1591    Complete,
1592}
1593
1594///
1595/// DeploymentCommandResultV1
1596///
1597#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1598pub enum DeploymentCommandResultV1 {
1599    NotFinished,
1600    Succeeded,
1601    Failed { code: String, message: String },
1602}
1603
1604///
1605/// RolePhaseReceiptV1
1606///
1607#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1608pub struct RolePhaseReceiptV1 {
1609    pub role: String,
1610    pub phase: String,
1611    pub result: RolePhaseResultV1,
1612    pub previous_module_hash: Option<String>,
1613    pub target_module_hash: Option<String>,
1614    pub observed_module_hash_after: Option<String>,
1615    pub artifact_digest: Option<String>,
1616    pub canonical_embedded_config_sha256: Option<String>,
1617    pub error: Option<String>,
1618}
1619
1620///
1621/// RolePhaseResultV1
1622///
1623#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1624pub enum RolePhaseResultV1 {
1625    Applied,
1626    Failed,
1627    Skipped,
1628    NotAttempted,
1629    VerifiedAlreadyApplied,
1630}
1631
1632///
1633/// DiffItemV1
1634///
1635#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1636pub struct DiffItemV1 {
1637    pub category: String,
1638    pub subject: String,
1639    pub expected: Option<String>,
1640    pub observed: Option<String>,
1641    pub severity: SafetySeverityV1,
1642}
1643
1644///
1645/// ResumeSafetyV1
1646///
1647#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1648pub struct ResumeSafetyV1 {
1649    pub status: SafetyStatusV1,
1650    pub reasons: Vec<String>,
1651}
1652
1653///
1654/// SafetyFindingV1
1655///
1656#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1657pub struct SafetyFindingV1 {
1658    pub code: String,
1659    pub message: String,
1660    pub severity: SafetySeverityV1,
1661    pub subject: Option<String>,
1662}
1663
1664///
1665/// SafetyStatusV1
1666///
1667#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1668pub enum SafetyStatusV1 {
1669    NotEvaluated,
1670    Safe,
1671    Warning,
1672    Blocked,
1673}
1674
1675///
1676/// SafetySeverityV1
1677///
1678#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1679pub enum SafetySeverityV1 {
1680    Info,
1681    Warning,
1682    HardFailure,
1683}
1684
1685///
1686/// ObservationStatusV1
1687///
1688#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1689pub enum ObservationStatusV1 {
1690    NotObserved,
1691    Observed,
1692    Missing,
1693    Inconclusive,
1694}
canic_host/deployment_truth/model.rs

canic_host/deployment_truth/
model.rs
