Module derived_state
Expand description
Experimental derived-state feed scaffold for official stateful extensions. Experimental derived-state feed types for official stateful extensions.
This module is the first code scaffold for the architecture proposed in
docs/architecture/adr/0010-dedicated-derived-state-feed.md.
It defines the feed envelope, event families, checkpoints, and consumer-facing
fault types without yet wiring a runtime producer.
Structs§
- Account
Touch Observed Event - Transaction-derived account-touch metadata for stateful consumers.
- Branch
Reorged Event - Canonical branch switch record for the derived-state feed.
- Checkpoint
Barrier Event - Checkpoint barrier emitted by the derived-state feed.
- Derived
State Checkpoint - Durable checkpoint shape for one derived-state consumer.
- Derived
State Checkpoint Store - Small file-backed checkpoint store for derived-state consumers.
- Derived
State Consumer Fault - Structured consumer fault returned by the feed scaffold.
- Derived
State Consumer Telemetry - Snapshot of one registered derived-state consumer’s live-feed health and counters.
- Derived
State Control Plane State Event - Canonical control-plane snapshot emitted by the derived-state feed.
- Derived
State Feed Envelope - One envelope delivered to a derived-state consumer.
- Derived
State Host - Immutable host for derived-state consumers.
- Derived
State Host Builder - Builder for
DerivedStateHost. - Derived
State Input Freshness - Freshness metadata for one control-plane input in the derived-state feed.
- Derived
State Invalidation Event - Explicit invalidation envelope for replay/reorg-aware consumers.
- Derived
State Persisted Checkpoint - One persisted derived-state consumer snapshot bundled with its durable checkpoint.
- Derived
State Recovery Report - Recovery attempt summary returned by the derived-state host.
- Derived
State Replay Telemetry - Replay backend telemetry snapshot exposed to runtime logs and tests.
- Derived
State TxOutcome Event - Derived-state tx outcome feedback emitted by higher-level services.
- Disk
Derived State Replay Source - Disk-backed replay source for retained derived-state feed envelopes.
- Feed
Sequence - Monotonic sequence number for the derived-state feed within one session.
- Feed
Session Id - One runtime feed session identity.
- Feed
Watermarks - Runtime truth watermarks visible to derived-state consumers.
- InMemory
Derived State Replay Source - In-memory replay source used by the scaffold and tests.
- Slot
Status Changed Event - Slot lifecycle transition record for the derived-state feed.
- Transaction
Applied Event - Decoded transaction apply record for the derived-state feed.
Enums§
- Checkpoint
Barrier Reason - Reasons for emitting a checkpoint barrier.
- Derived
State Consumer Fault Kind - Structured fault categories for authoritative derived-state consumers.
- Derived
State Consumer Recovery State - Recovery state for one derived-state consumer.
- Derived
State Control Plane Quality - Coarse quality classification for the observer-side control plane.
- Derived
State Feed Event - Event families intended for authoritative stateful consumers.
- Derived
State Freshness State - Freshness classification for one control-plane input.
- Derived
State Invalidation Reason - Explicit invalidation reason for derived-state consumers.
- Derived
State Replay Backend - Backend used for retained derived-state replay.
- Derived
State Replay Durability - Durability policy for the disk-backed replay source.
- Derived
State Replay Error - Replay errors returned by derived-state feed sources.
- Derived
State TxOutcome Kind - Outcome classification reported by services layered on top of SOF.
Traits§
- Derived
State Consumer - Stateful consumer interface for the dedicated derived-state feed scaffold.
- Derived
State Replay Source - Ordered replay source for retained derived-state feed envelopes.