dig-epoch 0.1.0

DIG L2 epoch geometry, phase machine, manager, and checkpoint competition types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! # `types::dfsp` — DFSP epoch-boundary type definitions
//!
//! **Introduced by:** `STR-002` — Module hierarchy (SPEC §13).
//!
//! **Future owner:**
//! [`TYP-004`](../../../docs/requirements/domains/epoch_types/specs/TYP-004.md)
//! — the seven DFSP epoch-boundary types enumerated by SPEC §3.14:
//!
//! 1. `DfspCloseSnapshot`
//! 2. `DfspExecutionStageV1`
//! 3. `DfspEpochBurnContextV1`
//! 4. `DfspEpochBurnPolicyV1`
//! 5. `DfspEpochBurnPolicyScheduleEntryV1`
//! 6. `DfspEpochStorageProofEvaluationContextV1`
//! 7. `DfspEpochIssuancePreviewV1`
//!
//! **Spec reference:** [`SPEC.md` §3.14](../../../docs/resources/SPEC.md).
//!
//! ## Relationship to `src/dfsp.rs`
//!
//! This module owns the **type surface** of DFSP. The **processing
//! functions** (burn policy evaluation, operations digest, commitment
//! digest, namespace rollup, tail roots, activation control) live in
//! [`crate::dfsp`] per STR-002's Implementation Notes. Both modules must
//! exist simultaneously — the `types` variant is the one reachable at
//! `dig_epoch::types::dfsp::*`.
//!
//! ## Status at STR-002
//!
//! Empty aside from the [`STR_002_MODULE_PRESENT`] sentinel.

/// Sentinel marker proving the module exists and is reachable at
/// `dig_epoch::types::dfsp::STR_002_MODULE_PRESENT`.
///
/// Exercised by the STR-002 integration test — see
/// [`tests/crate_structure/str_002_test.rs`](../../../tests/crate_structure/str_002_test.rs).
#[doc(hidden)]
pub const STR_002_MODULE_PRESENT: () = ();

use chia_protocol::Bytes32;
use serde::{Deserialize, Serialize};

use crate::error::EpochError;

// -----------------------------------------------------------------------------
// TYP-004 — DfspCloseSnapshot
// -----------------------------------------------------------------------------

/// DFSP state snapshot captured at epoch close, before archival.
///
/// Spec ref: SPEC §3.6 / TYP-004.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub struct DfspCloseSnapshot {
    /// Collateral registry SMT root at close.
    pub collateral_registry_root: Bytes32,
    /// CID lifecycle state root at close.
    pub cid_state_root: Bytes32,
    /// Node registry SMT root at close.
    pub node_registry_root: Bytes32,
    /// Cumulative namespace root at close.
    pub namespace_epoch_root: Bytes32,
    /// Total DFSP issuance this epoch (mojos).
    pub dfsp_issuance_total: u64,
    /// Active CIDs at close.
    pub active_cid_count: u32,
    /// Active storage nodes at close.
    pub active_node_count: u32,
}

impl DfspCloseSnapshot {
    /// Serializes with bincode. Infallible for well-formed structs.
    pub fn to_bytes(&self) -> Vec<u8> {
        bincode::serialize(self).expect("DfspCloseSnapshot serialization should never fail")
    }

    /// Deserializes from bincode bytes, returning `EpochError::InvalidData` on failure.
    pub fn from_bytes(bytes: &[u8]) -> Result<Self, EpochError> {
        bincode::deserialize(bytes).map_err(|e| EpochError::InvalidData(e.to_string()))
    }
}