Project Overview
Aura is a fully peer-to-peer, private communication system that operates without dedicated servers. It uses a web-of-trust architecture to provide discovery, data availability, account recovery, and graceful async protocol evolution.
Threshold signatures are used to abstract keys from devices. The network topology between logical users reflects social relationships, forming encrypted mesh that provides discovery, availability, and recovery. State converges through CRDT journals without central coordination, while session-typed choreographic protocols ensure safe multi-party execution.
How Aura Works
In Aura, all actors are authorities. An authority is an opaque cryptographic actor that may represent a person, a device group, or a shared context. External observers see only public keys and signed operations. This enables unlinkable participation across contexts.
State is append-only facts in journals. Each authority maintains its own journal. Shared contexts have journals written by multiple participants. Facts accumulate through CRDT merge and views are derived by reduction.
Side effects flow through explicit traits. Cryptography, storage, networking, and time are accessed only through effect handlers. This enables deterministic simulation and cross-platform portability.
Multi-party coordination uses session-typed choreographies. A global protocol specifies message flow. Each party's local behavior is projected from the global view.
Authorization passes through a layered guard chain. Before any message leaves, capabilities are verified, flow budgets are charged, and facts are committed atomically.
Aura separates key generation from agreement. Fast paths provide immediate usability while durable shared state is always consensus-finalized.
For the complete architecture, see System Architecture.
Documentation Index
The documents below cover theory, technical components, implementation guidance, and project organization.
1. Foundation
Theoretical Model establishes the formal calculus, algebraic types, and semilattice semantics underlying the system.
System Architecture describes the 8-layer architecture, effect patterns, and choreographic protocol structure.
Privacy and Information Flow Contract specifies consent-based privacy with trust boundaries, flow budgets, and leakage tracking.
Distributed Systems Contract defines safety and liveness guarantees, synchrony assumptions, and adversarial tolerance.
2. Core Systems
Cryptography documents primitives, key derivation, threshold signatures, and VSS schemes.
Identifiers and Boundaries defines the identifier types and their privacy-preserving properties.
Authority and Identity describes opaque authorities, commitment trees, and relational context structure.
Journal specifies fact-based journals, validation rules, and deterministic reduction flows.
Authorization covers capability semantics, Biscuit token integration, and guard chain authorization.
Effect System documents effect traits, handler design, and context propagation.
Runtime describes lifecycle management, guard chain execution, and service composition.
User Flow Harness defines the shared UX contract, authoritative observation rules, and browser freshness model for parity-critical harness flows.
Ownership Model defines the four ownership categories, capability-gated authority, terminality rules, and the workspace crate inventory.
Consensus specifies single-shot agreement for non-monotone operations with witness attestation.
Operation Categories defines A/B/C operation tiers, K1/K2/K3 key generation, and agreement levels.
MPST and Choreography covers multi-party session types and choreographic protocol projection.
Transport and Information Flow specifies guard chain enforcement, secure channels, and flow receipts.
Aura Messaging Protocol (AMP) documents reliable async messaging with acknowledgment and ordering patterns.
Network Anonymity documents anonymous path routing, bootstrap re-entry records, and reply-block semantics.
Rendezvous Architecture covers context-scoped peer discovery and encrypted envelope exchange.
Relational Contexts specifies guardian bindings, recovery grants, and cross-authority journals.
Database Architecture defines the query layer using journals, Biscuit predicates, and CRDT views.
Social Architecture describes the three-tier model of messages, homes, and neighborhoods.
Distributed Maintenance Architecture covers snapshots, garbage collection, and system evolution.
CLI and Terminal User Interface specifies command-line and TUI interfaces for Aura operations.
Test Infrastructure Reference documents test fixtures, mock handlers, and scenario builders.
Simulation Infrastructure Reference covers deterministic simulation with virtual time and fault injection.
Formal Verification Reference describes Quint model checking and Lean theorem proving integration.
3. Developer Guides
Getting Started Guide provides a starting point for developers new to the codebase.
Effects and Handlers Guide covers the algebraic effect system, handler implementation, and platform support.
Choreography Development Guide explains choreographic protocol design, CRDTs, and distributed coordination.
Testing Guide covers test patterns, fixtures, conformance testing, and runtime harness.
User Flow Harness explains the determinism model for shared-flow harness execution, revisioned observation, and trace conformance.
Simulation Guide explains deterministic simulation for debugging and property verification.
Verification Guide documents Quint model checking and Lean proof workflows.
System Internals Guide covers guard chain internals, service patterns, and reactive scheduling.
Distributed Maintenance Guide covers operational concerns including snapshots and system upgrades.
Capability Vocabulary Inventory inventories authorization capability strings and their migration targets.
4. Project Meta
UX Flow Coverage Report tracks harness and scenario coverage for user-visible flows.
Verification Coverage Report tracks formal verification status across Quint specs and Lean proofs.
Project Structure documents the 8-layer crate architecture and dependency relationships.
System Architecture
This document gives an intuitive overview of Aura's architecture, covering core abstractions, information flow and component interactions. Formal definitions live in Theoretical Model. Crate organization are documented in Project Structure.
Overview
Aura distributes identity and trust across devices and social relationships to enable private peer-to-peer communication.
The system is designed to operate without dedicated servers. Discovery, availability, and recovery are provided by the web of trust. Peers relay messages for one another based on social proximity. Without centralized routing, no single party can observe all traffic or deny service.
flowchart TB
subgraph Authorities
A1[Authority A]
A2[Authority B]
end
subgraph State
J1[Journal A]
J2[Journal B]
JC[Context Journal]
end
subgraph Enforcement
GC[Guard Chain]
FB[Flow Budget]
end
subgraph Effects
EF[Effect System]
TR[Transport]
end
A1 --> J1
A2 --> J2
A1 & A2 --> JC
J1 & J2 & JC --> GC
GC --> FB
FB --> EF
EF --> TR
This diagram shows the primary data flow. Authorities own journals that store facts. The guard chain enforces authorization before any transport effect. The effect system provides the abstraction layer for all operations.
Every operation flows through the effect system. Every state change is replicated through journals. Every external action is authorized through guards. These three invariants define the architectural contract.
1. State Model
1.1 Dual semilattice
Aura state consists of two complementary semilattices. Facts form a join-semilattice where information accumulates through the join operation. Capabilities form a meet-semilattice where authority restricts through the meet operation.
#![allow(unused)] fn main() { struct Journal { facts: FactSet, // join-semilattice (⊔) frontier: CapFrontier, // meet-semilattice (⊓) } }
The Journal type keeps these dimensions separate. Facts can only grow. Capabilities can only shrink. This dual monotonicity provides convergence guarantees for replicated state.
Facts represent evidence that accumulates over time. Examples include signed operations, attestations, flow budget charges, and consensus commits. Once a fact is added, it cannot be removed. Garbage collection uses tombstones and reduction rather than deletion.
Capabilities represent authority that restricts over time. First-party capability vocabulary is declared in typed families owned by the crates that define the behavior. The system evaluates Biscuit tokens against policy to derive the current capability frontier. Delegation can only attenuate. No operation can widen capability scope. Token issuance is explicit, and guard snapshots carry evaluated frontiers rather than declared capability families. See Theoretical Model for formal definitions of these lattices.
1.2 Journals and namespaces
The journal is the canonical state mechanism. All durable state is represented as facts in journals. Views are derived by reducing accumulated facts.
Journals are partitioned into namespaces. Authority namespaces store facts owned by a single authority. Context namespaces store facts shared across authorities participating in a relational context. Facts in one namespace cannot reference or affect facts in another namespace. Cross-namespace coordination requires explicit protocols.
Facts are content-addressed immutable records. Each fact includes a type identifier, payload, attestation, and metadata. Facts accumulate through CRDT merge. Duplicate facts are deduplicated by content hash. Conflicting facts are resolved by type-specific merge rules.
Attestations prove that an authority endorsed the fact. Threshold signatures require multiple devices to attest. Single-device signatures are used for local facts. See Journal for the complete specification.
1.3 State reduction
State reduction computes views from accumulated facts. Reducers are pure functions that transform fact sets into derived state. Reduction is deterministic and reproducible.
Reduction runs on demand or is cached for performance. Cached views are invalidated when new facts arrive. The reduction pipeline supports incremental updates for large fact sets. See Journal for the reduction architecture.
1.4 Content addressing
All Aura artifacts are identified by the hash of their DAG-CBOR canonical encoding. Published digests are immutable. Journal merges and payload downloads verify digests before accepting data. See Theoretical Model for the content addressing contract.
2. Identity and Trust
2.1 Authorities
An authority is an opaque cryptographic actor. External parties see only public keys and signed facts. Internal device structure is hidden. This abstraction provides unlinkability across contexts.
flowchart LR
subgraph External View
PK[Threshold Public Key]
end
subgraph Authority [Internal Structure]
direction TB
CT[Commitment Tree]
subgraph Devices
direction LR
D1[Device 1<br/>Share 1]
D2[Device 2<br/>Share 2]
D3[Device 3<br/>Share 3]
end
CT --> Devices
end
Devices -.->|2-of-3 signing| PK
style Authority fill:transparent,stroke:#888,stroke-dasharray: 5 5
Account authorities maintain device membership using commitment trees. The journal stores signed tree operations as facts. Reduction reconstructs the canonical tree state from accumulated facts. FROST provides the threshold signature scheme. DKG distributes key shares without a trusted dealer. Key rotation and resharing maintain security as devices join or leave. See Cryptography for threshold details.
2.2 Relational contexts
Relational contexts are shared journals for cross-authority state. Each context has its own namespace and does not reveal participants to external observers. Participation is expressed by writing relational facts. Profile data, nicknames, and relationship state live in context journals. See Authority and Identity for commitment tree details and Relational Contexts for context patterns.
2.3 Contextual identity
Identity is scoped to contexts. A device can participate in many contexts without linking them. Each context derives independent keys through deterministic key derivation. This prevents cross-context correlation by external observers. See Identifiers and Boundaries for identifier semantics.
2.4 Social topology
Aura organizes social structure into three tiers. Messages are communication contexts for direct and group conversations. Homes are semi-public communities capped by storage constraints. Neighborhoods are collections of homes connected via 1-hop links.
The social topology shapes routing, relay selection, and governance. Authorities prefer relays operated by trusted peers within their home or neighborhood. Storage allocation is bounded per home, producing natural scarcity that scales with social investment. Local governance is encoded as capability-gated policy facts within each home's journal.
Access levels to a home follow the topology. Full access applies within the home. Partial access applies across 1-hop neighborhood links. Limited access applies at greater distances. See Social Architecture for the complete model.
3. Effects and Time
3.1 Effect system
Effect traits define async capabilities with explicit context. Handlers implement these traits for specific environments. The effect system provides the abstraction layer between application logic and runtime behavior.
flowchart TB
subgraph L3["Composite"]
direction LR
TRE[TreeEffects] ~~~ CHE[ChoreographyExt]
end
subgraph L2["Application"]
direction LR
JE[JournalEffects] ~~~ AE[AuthorizationEffects] ~~~ FE[FlowBudgetEffects] ~~~ LE[LeakageEffects]
end
subgraph L1["Infrastructure"]
direction LR
CE[CryptoEffects] ~~~ NE[NetworkEffects] ~~~ SE[StorageEffects] ~~~ TE[TimeEffects] ~~~ RE[RandomEffects]
end
L1 --> L2 --> L3
Infrastructure effects wrap OS primitives including cryptography, networking, storage, time, and randomness. Application effects encode domain logic including journal operations, authorization, flow budgets, and leakage tracking. Composite effects combine lower layers for commitment tree operations and choreography execution.
Application code must not call system time, randomness, or IO directly. These operations must flow through effect traits. This constraint enables deterministic testing and simulation. See Effect System for the full specification.
3.2 Time domains
The time system provides four domains for different use cases. PhysicalClock uses wall-clock time for cooldowns, receipts, and liveness. LogicalClock uses vector and Lamport clocks for causal ordering. OrderClock uses opaque tokens for deterministic ordering without temporal leakage. Range uses earliest and latest bounds for validity windows.
Time access happens exclusively through effect traits. Application code does not call system time directly. Cross-domain comparisons require explicit policy. See Effect System for time domain details.
3.3 Context propagation
Every async call chain carries an EffectContext that identifies the authority, context, session, and execution mode. Guards access context to make authorization decisions. Handlers access context to route operations to the correct namespace. See Effect System for the context model.
4. Authorization and Enforcement
4.1 Guard chain
All transport sends pass through a guard chain before any network effect. The chain enforces authorization, budget accounting, journal coupling, and leakage tracking in a fixed sequence:
CapabilityGuard → FlowBudgetGuard → JournalCouplingGuard → LeakageTrackingGuard → TransportEffects
Each guard must succeed before the next executes. Failure at any guard blocks the send. This order enforces the charge-before-send invariant. See Authorization for the full guard chain specification.
4.2 Capability model
Authorization uses Biscuit tokens with cryptographic attenuation. Capabilities can only be restricted, never expanded. Delegation chains are verifiable without contacting the issuer.
CapabilityGuard evaluates Biscuit tokens against required capabilities. It verifies that the sender has authority to perform the requested operation. Biscuit caveats can restrict scope, time, or target. See Authorization for token structure and evaluation.
4.3 Flow budgets and receipts
Flow budgets track message emission per context and peer. Only spent and epoch values are stored as facts. The limit is computed at runtime from capability evaluation through the meet-semilattice. This keeps replicated state minimal while enabling runtime limit computation.
FlowBudgetGuard charges budgets and emits receipts before each send. Budget charges are atomic with receipt generation. If spent + cost > limit, the send is blocked locally with no observable behavior. Epoch rotation resets counters through new epoch facts.
Receipts include context, sender, receiver, epoch, cost, and a hash chain link. The chain provides accountability for multi-hop message forwarding. Relays validate upstream receipts before forwarding and charge their own budgets before emitting. See Transport and Information Flow for receipt verification.
4.4 Context isolation and leakage tracking
Contexts provide information flow boundaries. Keys are derived per-context. Facts are scoped to namespaces. Cross-context flow requires explicit bridge protocols.
LeakageTrackingGuard records privacy budget usage per observer class. Observer classes include relationship, group, neighbor, and external. Operations that exceed leakage budgets are blocked. See Privacy and Information Flow Contract for the leakage model.
5. Protocols
5.1 Choreographic protocols
Choreographies define global protocols using multi-party session types. A global type describes the entire protocol from an overview perspective. Each message specifies sender, receiver, payload type, and guard annotations.
Annotations compile into guard chain requirements: guard_capability is the
canonical namespaced capability string admitted at the DSL boundary,
flow_cost specifies budget charges, journal_facts specifies facts to
commit, and leak specifies leakage budget allocation.
Projection extracts each role's local view from the global type. The local view specifies what messages the role sends and receives. Execution interprets the local view against the effect system. See MPST and Choreography for projection rules and the global type grammar.
5.2 Telltale Protocol Machine
Production choreography execution uses the Telltale protocol machine with a host bridge. Startup is manifest-driven and admitted by construction. Execution is bounded by deterministic step budgets derived from weighted measures of the local session type. The budget removes wall-clock coupling from safety enforcement and keeps bound checks replay-deterministic across native and WASM conformance lanes.
The protocol machine supports canonical, hardening, and parity profiles. The canonical profile runs at concurrency 1 as the reference behavior. Hardening profiles test edge cases. Parity profiles compare native and WASM execution. See MPST and Choreography for runtime details.
5.3 Consensus and agreement
Aura Consensus provides single-shot agreement for non-monotone operations. Monotone operations use CRDT merge without consensus. Non-monotone operations such as key rotation, membership changes, and authoritative state transitions require consensus.
Operations are classified into categories A, B, and C. Category A uses CRDTs with immediate local effect. Category B shows pending state until agreement. Category C blocks until the consensus ceremony completes. See Operation Categories for classification rules.
The fast path completes in one round trip when witnesses agree on prestate. The fallback path activates when witnesses disagree or the initiator stalls. Bounded gossip propagates evidence until a quorum forms. Both paths yield the same CommitFact format.
CommitFact represents a consensus decision. It binds prestate hash, operation hash, participant set, threshold signature, and timestamp. CommitFacts are inserted into the relevant journal namespace. The prestate binding prevents reusing signatures across unrelated operations. Consensus failures fall back to gossip. Network partitions delay but do not corrupt state. See Consensus for protocol details.
5.4 Invitation lifecycle
Invitations establish new relationships. Contact invitations create direct messaging contexts. Channel invitations grant access to home channels. Guardian invitations bind recovery relationships.
Invitation creation is authorization-gated. Only the sender can cancel. Only the receiver can accept or decline. No invitation is resolved twice. Terminal states (accepted, declined, cancelled, expired) are immutable. Accepted invitations are backed by journal facts. Ceremony initiation is gated on acceptance. See Relational Contexts for invitation patterns.
5.5 Recovery
Device recovery uses guardian protocols. Guardians hold encrypted recovery shares established through relational contexts. A threshold of guardians can restore account access by contributing their shares.
Recovery operates through the same consensus and session-type infrastructure as other protocols. The recovered authority retains its identity while rotating to new key material. See Relational Contexts for recovery architecture.
6. Communication
6.1 Secure channels
SecureChannel provides encrypted, authenticated communication between two authorities. Channels use context-scoped keys derived through deterministic key derivation. Channel state is not stored in journals. Channels are established through rendezvous or direct connection. See Rendezvous Architecture for channel establishment.
6.2 Rendezvous
Rendezvous enables authorities to find each other without centralized directories. Rendezvous servers are untrusted relays that cannot read message content. Authorities publish encrypted envelopes that peers can retrieve. The social topology provides routing hints based on home and neighborhood membership. See Rendezvous Architecture for the full protocol.
6.3 Asynchronous messaging
AMP provides patterns for reliable asynchronous messaging. Messages may arrive out of order. Delivery may be delayed by offline peers. AMP handles acknowledgment, retry, and ordering. Channels support both synchronous request-response and asynchronous fire-and-forget patterns. See Aura Messaging Protocol for details.
6.4 Anti-entropy
Journal state converges through anti-entropy after network partitions. Each peer periodically exchanges fact digests with its neighbors, identifies gaps, and selectively transfers missing facts. Because journals are CRDTs, merging facts from any peer is safe regardless of ordering. This process runs continuously in the background without coordination or agreement and ensures that connected peers eventually share the same fact set.
7. Runtime and Ownership
7.1 Ownership model
Aura uses four ownership categories to prevent multiple layers from co-owning the same semantic truth: Pure for reducers and validators, MoveOwned for handle and session transfer, ActorOwned for long-lived mutable runtime state, and Observed for projections and UI reads. Parity-critical mutation must be capability-gated. Parity-critical operations must terminate explicitly with typed success, failure, or cancellation. Errors are classified by recoverability and propagated through Result types. See Ownership Model for the full contract.
7.2 Structured concurrency
Actor-owned state is managed through a hierarchical task supervisor. Each service owns a rooted task group. Child tasks inherit cancellation from parents. Shutdown is hierarchical and parent-driven. All mutation of actor-owned state flows through bounded typed ingress rather than shared mutable access.
Session and endpoint transfer uses move-owned capabilities with monotone generation counters that reject stale access. Delegation atomically transfers the owner record and capability. This separation keeps supervision (who manages the lifecycle) distinct from session ownership (who may act on the state). See Runtime for the structured concurrency model.
7.3 Reactive state
The system uses reactive signals for state propagation. Journal fact changes flow through reducers to signals. Signals expose derived state to UI observers. The flow is unidirectional: facts are the source of truth, views are derived, and subscribers receive the latest state when they poll.
Subscription to an unregistered signal is a typed failure. Lagging subscribers may miss intermediate updates and resume from a newer snapshot. Reactive delivery is a transport for authoritative snapshots, not an alternate owner of semantic truth.
7.4 Workflow ownership
User-facing operations such as sending a message, accepting an invitation, or rotating a key are executed as workflows that progress through typed lifecycle phases to a terminal outcome. Each workflow has one authoritative lifecycle owner. Frontend and harness layers may submit commands and observe results, but they do not publish terminal truth. Ownership transfers through explicit handoff before the workflow begins awaited work. See Ownership Model for the semantic owner protocol.
8. Maintenance and Evolution
8.1 Snapshots and garbage collection
Snapshots bound storage size. A snapshot proposal announces a target epoch and a digest of the journal prefix. Devices verify the digest and contribute threshold signatures to complete the snapshot. Devices then prune facts and blobs whose epochs fall below the snapshot epoch. This pruning does not affect correctness because the snapshot represents a complete prefix.
8.2 OTA upgrades
OTA separates release distribution from activation. Release propagation is multi-directional and eventual. Activation is scope-bound and uses explicit epoch fences. Soft forks preserve compatibility. Hard forks require threshold-signed activation ceremonies scoped to the affected authority or context. See Distributed Maintenance Architecture for the full upgrade model.
8.3 Epoch fencing
Epochs gate budget resets, receipt validity, and upgrade activation. Epoch rotation inserts a new epoch fact into the journal. All replicas treat an epoch change as effective once they observe it in the journal. This avoids hard clock synchronization requirements. Receipts are valid only within their epoch. Old epoch receipts cannot be replayed.
References
- Theoretical Model: formal calculus and semilattice semantics
- Privacy and Information Flow Contract: leakage budgets and privacy layers
- Distributed Systems Contract: safety, liveness, and consistency guarantees
- Cryptography: threshold signatures and key management
- Identifiers and Boundaries: identifier semantics
- Authority and Identity: commitment trees and relational contexts
- Effect System: effect traits and time domains
- Runtime: lifecycle management and service composition
- Journal: fact storage and reduction
- Authorization: guard chain and Biscuit integration
- Consensus: single-shot agreement protocol
- Operation Categories: A/B/C classification
- MPST and Choreography: session types and projection
- Transport and Information Flow: transport semantics
- Aura Messaging Protocol: reliable async messaging
- Rendezvous Architecture: peer discovery and channel establishment
- Relational Contexts: cross-authority state and recovery
- Social Architecture: homes, neighborhoods, and governance
- Distributed Maintenance Architecture: snapshots, GC, and OTA
- Ownership Model: ownership categories and semantic owner protocol
- Project Structure: crate organization and dependency graph
Theoretical Model
This document establishes the complete mathematical foundation for Aura's distributed system architecture. It presents the formal calculus, algebraic/session types, and semilattice semantics that underlie all system components.
Overview
Aura's theoretical foundation rests on four mathematical pillars:
- Aura Calculus () provides the core computational model for communication, state, and trust.
- Algebraic Types structure state as semilattices with monotonic properties.
- Multi-Party Session Types specify choreographic protocols with safety guarantees.
- CRDT Semantics enable conflict-free replication with convergence proofs.
The combination forms a privacy-preserving, spam-resistant, capability-checked distributed λ-calculus that enforces information flow budget across all operations.
Shared Terms and Notation
This section defines shared terminology and notation for core contracts. Use this section when writing Theoretical Model, Privacy and Information Flow Contract, and Distributed Systems Contract.
Core Entities
| Symbol / Term | Type | Description |
|---|---|---|
| , | AuthorityId | Authority identifiers |
ContextId | Context identifier | |
Epoch | Epoch number | |
| authority | An account authority | |
| context | A relational or authority namespace keyed by ContextId | |
| peer authority | A remote authority in a context | |
| member | An authority in a home's threshold authority set | |
| participant | An authority granted home access but not in the threshold set | |
| moderator | A member with moderation designation for a home |
Access and Topology
| Term | Description |
|---|---|
Full | Same-home access (0 hops) |
Partial | 1-hop neighborhood access |
Limited | 2-hop-or-greater and disconnected access |
| 1-hop link | Direct home-to-home neighborhood edge |
| n-hop | Multi-edge path (2-hop, 3-hop, etc.) |
| Shared Storage | Community storage pool |
| pinned | Fact attribute for retained content |
Flow Budget and Receipts
Use for a flow budget for context and peer authority .
| Field | Type / Storage | Description |
|---|---|---|
| FlowBudget | ||
spent | Replicated fact | Monotone counter of consumed budget |
epoch | Replicated fact | Current epoch identifier |
limit | Derived at runtime | From capability evaluation and policy |
| Receipt | ||
ctx | ContextId | Context scope |
src | AuthorityId | Sending authority |
dst | AuthorityId | Receiving authority |
epoch | Epoch | Validity window |
cost | u32 | Budget charge |
nonce | u64 | Replay prevention |
prev_hash | Hash32 | Links receipts in per-hop chain |
sig | Signature | Cryptographic proof |
Observers, Time, and Delay
| Symbol | Category | Description |
|---|---|---|
| Observer | Relationship (direct relationship observer) | |
| Observer | Group (group member observer) | |
| Observer | Neighbor (neighborhood observer) | |
| Observer | External (external/network observer) | |
| CRDT/state | Local state deltas (NOT network delay) | |
| Network | Network delay bounds under partial synchrony | |
GST | Timing | Global Stabilization Time |
Leakage tuple order:
Invariant Naming
Use InvariantXxx names for implementation and proof references.
If a prose alias exists, include it once, then reference the invariant name.
Guard Chain Order
| Order | Component | Role |
|---|---|---|
| 1 | CapGuard | Capability verification |
| 2 | FlowGuard | Budget enforcement |
| 3 | JournalCoupler | Fact commitment |
| 4 | TransportEffects | Message transmission |
This order defines ChargeBeforeSend.
1. Aura Calculus ()
1.1 Syntax
We define programs as effectful, session-typed processes operating over semilattice-structured state.
Terms:
Facts (Join-Semilattice):
Capabilities (Meet-Semilattice):
Contexts:
Contexts are opaque UUIDs representing authority journals or relational contexts. Keys for transport sessions and DKD outputs are scoped to these identifiers. The identifier itself never leaks participants. See Identifiers and Boundaries for canonical definitions.
Messages:
Message extraction functions (used by operational rules):
A process configuration:
This represents a running session with fact-state , capability frontier derived from verified Biscuit tokens and local policy, and privacy context .
1.2 Judgments
Under typing context , expression has type and may perform effects .
Effect set:
1.3 Operational Semantics
State evolution:
Capability-guarded actions:
Each side effect or message action carries a required capability predicate .
The function attn applies the Biscuit token's caveats to the local frontier. Biscuit attenuation never widens authority. The operation remains meet-monotone even though the token data lives outside the journal.
Context isolation:
No reduction may combine messages of distinct contexts:
Here is shorthand for the budget predicate derived from journal facts and Biscuit-imposed limits for context :
Implementations realize this by merging a FlowBudget charge fact before send (see §2.3 and §5.3) while evaluating Biscuit caveats inside the guard chain. The side condition is enforced by the same monotone laws as other effects even though capability data itself is not stored in the CRDT.
1.4 Algebraic Laws (Invariants)
- Monotonic Growth:
- Monotonic Restriction:
- Safety: Every side effect requires .
- Context Separation: For any two contexts , no observable trace relates their internal state unless a bridge protocol is typed for .
- Compositional Confluence: and
2. Core Algebraic Types
2.1 Foundation Objects
#![allow(unused)] fn main() { // Capabilities describe Biscuit caveats. They form a meet-semilattice but are evaluated outside the CRDT. type Cap // partially ordered set (≤), with meet ⊓ and top ⊤ type Policy // same carrier as Cap, representing sovereign policy // Facts are join-semilattice elements (accumulation only grows them). type Fact // partially ordered set (≤), with join ⊔ and bottom ⊥ // Journal state is only a Cv/Δ/CmRDT over facts. struct Journal { facts: Fact, // Cv/Δ/CmRDT carrier with ⊔ } // Context identifiers are opaque (authority namespace or relational context). struct ContextId(Uuid); struct Epoch(u64); // monotone, context-scoped struct FlowBudget { limit: u64, spent: u64, epoch: Epoch }; struct Receipt { ctx: ContextId, src: AuthorityId, dst: AuthorityId, epoch: Epoch, cost: u32, nonce: u64, prev_hash: Hash32, sig: Signature }; // Typed messages carry effects and proofs under a context. struct Msg<Ctx, Payload, Version> { ctx: Ctx, // ContextId chosen by relationship payload: Payload, // typed by protocol role/state ver: Version, // semantic version nego auth: AuthTag, // signatures/MACs/AEAD tags biscuit: Option<Biscuit>, // optional attenuated capability } }
These type definitions establish the foundation for Aura's formal model. The Cap and Policy types form meet-semilattices for capability evaluation. The Fact type forms a join-semilattice for accumulating evidence. The Journal contains only facts and inherits join-semilattice properties. Messages are typed and scoped to contexts to ensure isolation.
The type Cap represents the evaluation lattice used by Biscuit. Refinement operations (caveats, delegation) can only reduce authority through the meet operation.
The type Fact represents facts as join-semilattice elements. Accumulation operations can only add information through the join operation.
Journals replicate only facts. Capability evaluations run locally by interpreting Biscuit tokens plus policy. This keeps authorization independent of the replicated CRDT while preserving the same meet monotonicity at runtime.
Contexts (ContextId) define privacy partitions. Messages never cross partition boundaries without explicit protocol support. See Identifiers and Boundaries for precise identifier semantics and Relational Contexts for implementation patterns.
2.2 Content Addressing Contract
All Aura artifacts are identified by the hash of their canonical encoding. This includes facts, snapshot blobs, cache metadata, and upgrade manifests.
Structures are serialized using canonical CBOR with sorted maps and deterministic integer width. The helper function hash_canonical(bytes) computes digests when needed.
Once a digest is published, the bytes for that artifact cannot change. New content requires a new digest and a new fact in the journal.
Snapshots and upgrade bundles stored outside the journal are referenced solely by their digest. Downloaders verify the digest before accepting the payload. Journal merges compare digests and reject mismatches before updating state. See Distributed Maintenance Architecture for the complete fact-to-state pipeline.
2.3 Effect Signatures
Core effect families provide the runtime contract:
-- Read/append mergeable state
class JournalEffects (m : Type → Type) where
read_facts : m Fact
merge_facts : Fact → m Unit
-- Biscuit verification + guard evaluation
class AuthorizationEffects (m : Type → Type) where
evaluate_guard : Biscuit → CapabilityPredicate → m Cap
derive_cap : ContextId → m Cap -- cached policy frontier
-- Cryptography and key mgmt (abstracted to swap FROST, AEAD, DR, etc.)
class CryptoEffects (m : Type → Type) where
sign_threshold : Bytes → m SigWitness
aead_seal : K_box → Plain → m Cipher
aead_open : K_box → Cipher → m (Option Plain)
commitment_step : ContextId → m ContextId
-- Transport (unified)
class TransportEffects (m : Type → Type) where
send : PeerId → Msg Ctx P V → m Unit
recv : m (Msg Ctx Any V)
connect : PeerId → m Channel
These effect signatures define the interface between protocols and the runtime. The JournalEffects family handles state operations. The AuthorizationEffects family verifies Biscuit tokens and fuses them with local policy. The CryptoEffects family handles cryptographic operations. The TransportEffects family handles network communication.
2.4 Guards and Observability Invariants
Every observable side effect is mediated by a guard chain fully described in Authorization:
- CapGuard:
- FlowGuard:
headroom(ctx, cost)wherecharge(ctx, peer, cost, epoch)succeeds and yields aReceipt - JournalCoupler: commit of attested facts is atomic with the send
Named invariants used across documents:
- Charge-Before-Send: FlowGuard must succeed before any transport send.
- No-Observable-Without-Charge: there is no event without a preceding successful .
- Deterministic-Replenishment:
limit(ctx)is computed deterministically from capability evaluation. The valuespent(stored as journal facts) is join-monotone. Epochs gate resets.
-- Time & randomness for simulation/proofs
class TimeEffects (m : Type → Type) where
now : m Instant
sleep : Duration → m Unit
class RandEffects (m : Type → Type) where
sample : Dist → m Val
-- Privacy budgets (relationship, group, neighbor, external observers)
class LeakageEffects (m : Type → Type) where
record_leakage : ObserverClass → Number → m Unit
remaining_budget : ObserverClass → m Number
The TimeEffects and RandEffects families support simulation and testing. The LeakageEffects family enforces privacy budget constraints.
The LeakageEffects implementation is the runtime hook that enforces the annotations introduced in the session grammar. The system wires it through the effect system so choreographies cannot exceed configured budgets.
Information Flow Budgets (Spam + Privacy)
Each context and peer authority pair carries a flow budget to couple spam resistance with privacy guarantees. This pair is written as . Keys and receipts are authority-scoped. Devices are internal to an authority and never appear in flow-budget state.
#![allow(unused)] fn main() { struct FlowBudget { spent: u64, // monotone counter (join = max) limit: u64, // capability-style guard (meet = min) } // Logical key: (ContextId, AuthorityId) -> FlowBudget // Receipts: (ctx, src_authority, dst_authority, epoch, cost, nonce) }
The FlowBudget struct tracks message emission through two components:
- The
spentfield is stored in the journal as facts and increases through join operations - The
limitfield is derived from capability evaluation (Biscuit tokens + local policy) and decreases through meet operations
Only spent counters live in the journal as facts, inheriting join-semilattice properties. The limit is computed at runtime by evaluating Biscuit tokens and local policy through the capability meet-semilattice, consistent with the principle that capabilities are evaluated outside the CRDT.
Sending a message deducts a fixed flow_cost from the local budget before the effect executes. If , the effect runtime blocks the send.
Budget charge facts (incrementing spent) are emitted to the journal during send operations. The limit value is deterministically computed from the current capability frontier, ensuring all replicas with the same tokens and policy derive the same limit. Receipts bind to AuthorityId for both src/dst and use nonce chains per (ctx, src, epoch) to maintain charge-before-send proofs without leaking device structure.
Multi-hop forwarding charges budgets hop-by-hop. Relays attach a signed Receipt that proves the previous hop still had headroom. Receipts are scoped to the same context so they never leak to unrelated observers.
2.5 Semantic Laws
Join laws apply to facts. These operations are associative, commutative, and idempotent. If and after we have , then with respect to the facts partial order.
Meet laws apply to capabilities. These operations are associative, commutative, and idempotent. Applying Biscuit caveats corresponds to multiplying by under and never increases authority.
Cap-guarded effects enforce non-interference. For any effect guarded by capability predicate , executing from is only permitted if .
Context isolation prevents cross-context flow. If two contexts are not explicitly bridged by a typed protocol, no flows into .
3. Multi-Party Session Type Algebra
3.1 Global Type Grammar (G)
The global choreography type describes the entire protocol from a bird's-eye view. Aura extends vanilla MPST with capability guards, journal coupling, and leakage budgets:
Conventions:
- means "role checks , applies , records leakage , sends to , then continues with ."
- performs the same sequence for broadcasts.
- means "execute and concurrently."
- means "role decides which branch to take, affecting all participants."
- binds recursion variable in .
Note on : the journal delta may include budget-charge updates (incrementing spent for the active epoch) and receipt acknowledgments. Projection ensures these updates occur before any transport effect so "no observable without charge" holds operationally.
Note on : check_caps and refine_caps are implemented via AuthorizationEffects. Sends verify Biscuit chains (with optional cached evaluations) before touching transport. Receives cache new tokens by refining the local capability frontier. Neither operation mutates the journal. All capability semantics stay outside the CRDT.
3.2 Local Type Grammar (L)
After projection, each role executes a local session type (binary protocol) augmented with effect sequencing:
3.3 Projection Function ()
The projection function extracts role 's local view from global choreography :
By convention, an annotation at a global step induces per-side deltas and . Unless otherwise specified by a protocol, we take (symmetric journal updates applied at both endpoints).
Point-to-point projection:
- If (sender):
- If (receiver):
- Otherwise:
Broadcast projection:
- If (sender):
- Otherwise (receiver):
Parallel composition:
where is the merge operator (sequential interleaving if no conflicts)
Choice projection:
- If (decider):
- If (observer):
Recursion projection:
- If :
- If :
Base cases:
3.4 Duality and Safety
For binary session types, duality ensures complementary behavior:
Property: If Alice's local type is , then Bob's local type is for their communication to be type-safe.
3.5 Session Type Safety Guarantees
The projection process ensures:
- Deadlock Freedom: No circular dependencies in communication
- Type Safety: Messages have correct types at send/receive
- Communication Safety: Every send matches a receive
- Progress: Protocols always advance (no livelocks)
- Agreement: All participants agree on the chosen branch and protocol state (modulo permitted interleavings of independent actions)
3.6 Turing Completeness vs Safety Restrictions
The MPST algebra is Turing complete when recursion () is unrestricted. However, well-typed programs intentionally restrict expressivity to ensure critical safety properties:
- Termination: Protocols that always complete (no infinite loops)
- Deadlock Freedom: No circular waiting on communication
- Progress: Protocols always advance to next state
Telltale-backed session runtimes balance expressivity and safety through guarded recursion constructs.
3.7 Free Algebra View (Choreography as Initial Object)
You can think of the choreography language as a small set of protocol-building moves:
Generators:
- and
Taken together, these moves form a free algebra: the language carries just enough structure to compose protocols, but no extra operational behavior. The effect runtime is the target algebra that gives these moves concrete meaning.
Projection (from a global protocol to each role) followed by interpretation (running it against the effect runtime) yields one canonical way to execute any choreography.
The "free" (initial) property is what keeps this modular. Because the choreographic layer only expresses structure, any effect runtime that respects those composition laws admits exactly one interpretation of a given protocol. This allows swapping or layering handlers without changing choreographies.
The system treats computation and communication symmetrically. A step is the same transform whether it happens locally or across the network. If the sender and receiver are the same role, the projection collapses the step into a local effect call. If they differ, it becomes a message exchange with the same surrounding journal/guard/leak actions. Protocol authors write global transforms, the interpreter decides local versus remote at time of projection.
3.8 Algebraic Effects and the Interpreter
Aura treats protocol execution as interpretation over an algebraic effect interface. After projecting a global choreography to each role, a polymorphic interpreter walks the role's AST and dispatches each operation to AuraEffectSystem via explicit effect handlers. The core actions are exactly the ones defined by the calculus and effect signatures in this document: merge (facts grow by ), refine (caps shrink by ), send/recv (context-scoped communication), and leakage/budget metering. The interpreter enforces the lattice laws and guard predicates while executing these actions in the order dictated by the session type.
Because the interface is algebraic, there is a single semantics regardless of execution strategy. This enables two interchangeable modes:
- Static compilation: choreographies lower to direct effect calls with zero runtime overhead.
- Dynamic interpretation: choreographies execute through the runtime interpreter for flexibility and tooling.
Both preserve the same program structure and checks. The choice becomes an implementation detail. This also captures the computation/communication symmetry. A choreographic step describes a typed transform. If the sender and receiver are the same role, projection collapses the step to a local effect invocation. If they differ, the interpreter performs a network send/receive with the same surrounding merge/check_caps/refine/record_leak sequence. Protocol authors reason about transforms. The interpreter decides locality at projection time.
4. CRDT Semantic Foundations
4.1 CRDT Type System
Aura implements four CRDT variants to handle different consistency requirements.
#![allow(unused)] fn main() { // State-based (CvRDT) - Full state synchronization pub trait JoinSemilattice: Clone { fn join(&self, other: &Self) -> Self; } pub trait Bottom { fn bottom() -> Self; } pub trait CvState: JoinSemilattice + Bottom {} // Delta CRDTs - Incremental state synchronization pub trait Delta: Clone { fn join_delta(&self, other: &Self) -> Self; } pub trait DeltaProduce<S> { fn delta_from(old: &S, new: &S) -> Self; } // Operation-based (CmRDT) - Causal operation broadcast pub trait CausalOp { type Id: Clone; type Ctx: Clone; fn id(&self) -> Self::Id; fn ctx(&self) -> &Self::Ctx; } pub trait CmApply<Op> { fn apply(&mut self, op: Op); } pub trait Dedup<I> { fn seen(&self, id: &I) -> bool; fn mark_seen(&mut self, id: I); } // Meet-based CRDTs - Constraint propagation pub trait MeetSemilattice: Clone { fn meet(&self, other: &Self) -> Self; } pub trait Top { fn top() -> Self; } pub trait MvState: MeetSemilattice + Top {} }
The type system enforces mathematical properties. CvState types must satisfy associativity, commutativity, and idempotency for join operations. MvState types satisfy the same laws for meet operations.
4.2 Convergence Proofs
Each CRDT type provides specific convergence guarantees:
CvRDT Convergence: Under eventual message delivery, all replicas converge to the least upper bound of their updates.
Proof sketch: Let states be replica states after all updates. The final state is . By associativity and commutativity of join, this value is unique regardless of message ordering.
Delta-CRDT Convergence: Equivalent to CvRDT but with bandwidth optimization through incremental updates.
CmRDT Convergence: Under causal message delivery and deduplication, all replicas apply the same set of operations.
Proof sketch: Causal delivery ensures operations are applied in a consistent order respecting dependencies. Deduplication prevents double-application. Commutativity ensures that concurrent operations can be applied in any order with the same result.
Meet-CRDT Convergence: All replicas converge to the greatest lower bound of their constraints.
4.3 Authority-Specific Applications
Authority journals use join-semilattice facts for evidence accumulation. Facts include AttestedOp records proving commitment tree operations occurred. Multiple attestations of the same operation join to the same fact.
Relational context journals use both join operations for shared facts and meet operations for consensus constraints. The prestate model ensures all authorities agree on initial conditions before applying operations.
Biscuit capability evaluation uses meet operations outside the CRDT. Token caveats restrict authority through intersection without affecting replicated state.
4.4 Message Schemas for Authority Synchronization
#![allow(unused)] fn main() { // Tagged message types for different synchronization patterns #[derive(Clone)] pub enum SyncMsgKind { FullState, Delta, Op, Constraint } pub type AuthorityStateMsg = (AuthorityFacts, SyncMsgKind); pub type ContextStateMsg = (ContextFacts, SyncMsgKind); pub type FactDelta = (Vec<Fact>, SyncMsgKind); #[derive(Clone)] pub struct AuthenticatedOp { pub op: TreeOp, pub attestation: ThresholdSig, pub ctx: ContextId } // Anti-entropy protocol support pub type FactDigest = Vec<Hash32>; pub type MissingFacts = Vec<Fact>; }
These message types support different synchronization strategies. Authority namespaces primarily use delta synchronization for efficiency. Relational context namespaces use operation-based synchronization to preserve consensus ordering.
4.5 Authority Synchronization Protocols
Authority Fact Synchronization: Authorities exchange facts using delta-based gossip for efficiency.
Relational context consensus: Contexts use operation-based synchronization to preserve consensus ordering.
Anti-Entropy Recovery: Peers detect missing facts through digest comparison and request specific items.
These protocols ensure eventual consistency across authority boundaries while maintaining context isolation. Facts are scoped to their originating authority or relational context.
4.6 Implementation Verification
Aura provides property verification for CRDT implementations through several mechanisms.
Property-Based Testing: Implementations include QuickCheck properties verifying semilattice laws. Tests generate random sequences of operations and verify associativity, commutativity, and idempotency.
Convergence Testing: Integration tests simulate network partitions and verify that replicas converge after partition healing. Tests measure convergence time and verify final state consistency.
Formal Verification: Critical CRDT implementations include formal proofs using the Quint specification language. Proofs verify that implementation behavior matches mathematical specifications.
Safety Guarantees: Session type projection ensures communication safety and deadlock freedom. Semilattice laws guarantee convergence under eventual message delivery. Meet operations ensure that capability restrictions are monotonic and cannot be bypassed.
5. Information Flow Contract (Privacy + Spam)
5.1 Privacy Layers
For any trace of observable messages:
- Unlinkability:
- Non-amplification: Information visible to observer class is monotone in authorized capabilities:
- Leakage Bound: For each observer , .
- Flow Budget Soundness (Named):
- Charge-Before-Send
- No-Observable-Without-Charge
- Deterministic-Replenishment
- Convergence: Within a fixed epoch and after convergence, across replicas .
5.2 Web-of-Trust Model
Let where vertices are accounts. Edges carry relationship contexts and delegation fragments.
- Each edge defines a pairwise context with derived keys
- Delegations are meet-closed elements , scoped to contexts
- The effective capability at is:
WoT invariants:
- Compositionality: Combining multiple delegations uses (never widens)
- Local sovereignty: is always in the meet. can only reduce authority further
- Projection: For any protocol projection to , guard checks refer to
5.3 Flow Budget Contract
The unified information-flow budget regulates emission rate/volume and observable leakage. The budget system combines join-semilattice facts (for spent counters) with meet-semilattice capability evaluation (for limit computation). For any context and peer :
- Charge-Before-Send: A send or forward is permitted only if a budget charge succeeds first. If charging fails, the step blocks locally and emits no network observable.
- No-Observable-Without-Charge: For any trace , there is no event labeled without a preceding successful charge for in the same epoch.
- Receipt soundness: A relay accepts a packet only with a valid per-hop
Receipt(context-scoped, epoch-bound, signed) and sufficient local headroom. Otherwise it drops locally. - Deterministic limit computation: is computed deterministically from Biscuit tokens and local policy via meet operations. is stored as journal facts and is join-monotone. Upon epoch rotation, resets through new epoch facts.
- Context scope: Budget facts and receipts are scoped to . They neither leak nor apply across distinct contexts (non-interference).
- Composition with caps: A transport effect requires both and (see §1.3). Either guard failing blocks the effect.
- Convergence bound: Within a fixed epoch and after convergence, across replicas , where each replica's limit is computed from its local capability evaluation.
6. Application Model
Every distributed protocol is defined as a multi-party session type with role projections:
When executed, each role instantiates a handler:
Handlers compose algebraically over by distributing operations over semilattice state transitions. This yields an effect runtime capable of:
- key-ceremony coordination (threshold signatures)
- gossip and rendezvous (context-isolated send/recv)
- distributed indexing (merge facts, meet constraints)
- garbage collection (join-preserving retractions)
7. Interpretation
Under this calculus, we can make the following interpretation:
The Semilattice Layer
The join-semilattice (Facts) captures evidence and observations (trust and information flow). Examples: delegations/attestations, quorum proofs, ceremony transcripts, flow receipts, and monotone spent counters.
The meet-semilattice (Capabilities) captures enforcement limits and constraints (trust and information flow). Examples: the sovereign policy lattice, Biscuit token caveats, leak bounds, and consent gates. See Authorization for implementation details. Flow budget limits are derived from capability evaluation, not stored as facts. This lattice is evaluated locally rather than stored in the journal, but it obeys the same algebra.
Effective authority and headroom are computed from both lattices:
The Session-Typed Process Layer
This layer guarantees communication safety and progress. It projects global types with annotations into local programs, ensuring deadlock freedom, communication safety, branch agreement, and aligning capability checks, journal updates, and leakage accounting with each send/recv.
The Effect Handler Layer
The Effect Handler system provides operational semantics and composability. It realizes merge/refine/send/recv as algebraic effects, enforces lattice monotonicity ( facts, caps), guard predicates, and budget/leakage metering, and composes via explicit dependency injection across crypto, storage, and transport layers.
The Privacy Contract
The privacy contract defines which transitions are observationally equivalent. Under context isolation and budgeted leakage, traces that differ only by in-context reorderings or by merges/refinements preserving observer-class budgets and effective capabilities are indistinguishable. No cross-context flow occurs without a typed bridge.
Together, these form a privacy-preserving, capability-checked distributed λ-calculus.
System Contracts
- Privacy and Information Flow Contract - Unified information-flow budgets, privacy layers, leakage tracking, and adversary analysis
- Distributed Systems Contract - Safety, liveness, consistency guarantees, synchrony assumptions, and failure handling
See Also
- Aura System Architecture - Implementation patterns and runtime layering
- Journal - Fact storage and CRDT semantics
- Authorization - Biscuit evaluation and guard chaining
- Identifiers and Boundaries - Canonical identifier definitions
- Distributed Maintenance Architecture - Reducer pipelines for authorities and contexts
Privacy and Information Flow Contract
This contract specifies Aura's privacy and information-flow model. It defines privacy boundaries, leakage budgets, and required privacy properties. Privacy boundaries align with social relationships rather than technical perimeters.
Violations occur when information crosses trust boundaries without consent. Acceptable flows consume explicitly budgeted headroom.
This document complements Distributed Systems Contract, which covers safety, liveness, and consistency. Together these contracts define the full set of invariants protocol authors must respect.
Verification of these properties uses Quint model checking (verification/quint/) and Lean 4 theorem proofs (verification/lean/). See Verification Coverage Report for current status.
1. Scope
The contract applies to information flows across privacy boundaries:
- Flow budgets: Per-context per-peer spending limits enforced before transport
- Leakage tracking: Metadata exposure accounting by observer class
- Context isolation: Separation of identities and journals across contexts
- Receipt chains: Multi-hop forwarding accountability
- Epoch boundaries: Isolation of budget and receipt state between logical budget epochs (AMP-style generations and windows)
- Service families:
Establish,Move, andHoldas the privacy-relevant service surfaces - Selector retrieval: Capability-derived retrieval without identity-addressed mailbox polling
- Hold custody: Neighborhood-scoped opaque retention with bounded retrieval authority
Related specifications: Authorization, Transport and Information Flow, and Theoretical Model. Shared notation appears in Theoretical Model.
1.1 Terminology Alignment
This contract uses shared terminology from Theoretical Model.
- Home role terms:
Member,Participant,Moderator(only members can be moderators) - Access-level terms:
Full,Partial,Limited - Storage terms:
Shared Storageandallocation - Pinning term:
pinnedas a fact attribute
1.2 Contract Vocabulary
observer: any party that can learn information from traffic, custody, or local state exposureauthoritative: part of replicated truth rather than local runtime interpretationretrieval: recovery of an object through bounded authority rather than identity-addressed deliverycustody: opaque best-effort retention of a non-authoritative objectaccountability evidence: bounded evidence used to verify that a service action occurred
1.3 Assumptions
- Cryptographic primitives are secure at configured key sizes.
- Local runtimes enforce guard-chain ordering before transport sends.
- Epoch updates and budget facts eventually propagate through anti-entropy.
- The service-family model is part of the active privacy contract.
- Privacy-mode deployments use encrypted envelopes and the fixed adaptive policy.
- Debug and simulation modes are excluded from production privacy claims.
1.4 Non-goals
- This contract does not guarantee traffic-analysis resistance against global passive adversaries without encrypted envelopes and sufficiently regular cover behavior.
- This contract does not define social policy decisions such as who should trust whom.
- This contract does not treat
Holdcustody as authoritative durable storage. - This contract does not guarantee durable delivery from custody services.
- This contract does not guarantee that debug or simulation modes preserve production privacy properties.
2. Privacy Philosophy
Traditional privacy systems offer only complete isolation or complete exposure. Aura treats privacy as relational. Sharing information with trusted parties is a consented disclosure, not a privacy violation.
2.1 Core Principles
- Consensual disclosure: Joining a group or establishing a relationship implies consent to share coordination information
- Contextual identity: Deterministic Key Derivation presents different identities in different contexts, and only relationship parties can link them
- Neighborhood visibility: Gossip neighbors observe encrypted envelope metadata, bounded by flow budgets and context isolation
- Service trust is social: social planes may admit or weight providers, but provider trust must not become visible service shape
- Communication privacy is envelope-level: descriptors, routes, retrieval, and retention behavior must remain socially neutral at the network boundary
2.2 Privacy Layers
| Boundary | Required Property | Forbidden Outcome |
|---|---|---|
| Identity | Contexts use distinct identity material | Cross-context identity reuse |
| Relationship | Relationship discovery stays decentralized | Global directory disclosure |
| Group | Group participation remains group-scoped | Cross-group membership disclosure |
| Content | Unauthorized observers cannot learn plaintext | Plaintext disclosure outside consented boundaries |
| Metadata | Exposure stays budgeted by observer class | Unbounded metadata leakage |
| Retrieval | Parity-critical retrieval is not identity-addressed | Mailbox-identity disclosure on retrieval paths |
| Custody | Custody remains opaque and non-authoritative | Treating custody as replicated truth |
2.3 Service-Family Boundary
Establish, Move, and Hold are the privacy-relevant service families. They describe service behavior, not social role. A provider may be admitted because of neighborhood membership, direct friendship, bounded introduction evidence, or descriptor fallback, but the service interface must not reveal which reason dominated.
Trust evidence may affect Permit and runtime-local weighting. It must not appear as route shape, descriptor kind, retrieval shape, retention tier, or wire-visible policy class. Coarse selection tiers are local runtime derivations and are not canonical shared state.
3. Budgeted Send Invariant
Transport observables require prior local authorization, accounting, and fact-coupling.
Budget state is monotone within its active epoch. Over-budget sends must remain local. Receipt validity is epoch-scoped and old receipts must not be replayable in new epochs. Budget epochs are logical and follow the AMP ratchet model: receipt generations must fall inside the receiver-anchored window, the receiver advances the epoch by the spacing rule, and the window (allowance) resolves from per-peer override, context policy, then default (see Transport and Information Flow §3.1).
Forwarding is hop-local. Each hop must validate the required upstream accountability state before emitting downstream transport.
4. Leakage Tracking
4.1 Observer Classes
Information leakage is tracked per observer class:
| Observer | May Observe | Must Not Learn |
|---|---|---|
Relationship | Full context content by consent | Undisclosed contexts |
Group | Group-scoped content | Other group memberships by default |
Neighbor | Encrypted envelope metadata | Plaintext content and endpoint identity |
Custody | Opaque held objects, selectors, and retention behavior | Depositor identity and mailbox identity |
External | Network-level patterns | Protected content and protected endpoint identity |
4.2 Leakage Budget
Each observer class has a leakage budget separate from flow budgets.
Leakage is charged before any operation that exposes information to the observer class.
Custody observers are special. They may see that an opaque object is deposited, retained, expired, or retrieved. They must not learn mailbox identity or depositor identity from that flow.
4.3 Policy Modes
| Policy | Required Behavior | Allowed Exposure |
|---|---|---|
Deny | Reject unbudgeted exposure | None |
DefaultBudget(n) | Apply bounded default headroom | Up to n units |
LegacyPermissive | Allow unbounded exposure | Migration-only exception |
5. Privacy Boundaries
5.1 Relationship Boundary
Within a direct relationship, both parties have consented to share coordination information:
- Visible: Context-specific identity, online status, message content
- Hidden: Activity in other contexts, identity linkage across contexts
- Violation: cross-context identity reuse or disclosure of undisclosed contexts
5.2 Neighborhood Boundary
Gossip neighbors forward encrypted traffic:
- Visible: Envelope size (fixed), rotating rtags, timing patterns
- Hidden: Content, ultimate sender/receiver, rtag-to-identity mapping
- Violation: disclosure of plaintext content or protected endpoint identity
5.3 Group Boundary
Group participants share group-scoped information:
- Visible: Member identities (within group), group content, threshold operations
- Hidden: Member identities outside group, other group memberships
- Violation: disclosure of unrelated group membership through group participation
5.4 External Boundary
External observers have no relationship with you:
- In privacy mode: protected Aura traffic patterns and timing are visible
- In passthrough mode: direct Aura connectivity is visible
- Violation: treating basic availability deployment as a stronger privacy claim
5.5 Retrieval Boundary
Retrieval is not identity-addressed at the network boundary.
- Visible to intermediaries: selector traffic shape and reply-path usage
- Hidden from intermediaries: mailbox identity, semantic object meaning, and direct reverse identity
- Violation: identity-addressed retrieval on parity-critical paths
5.6 Custody Boundary
Hold providers operate on opaque custody objects rather than authoritative truth.
- Visible to the holder: bounded retention requests, opaque held objects, selector usage, and storage pressure
- Hidden from the holder under onion routing: specific depositor identity and mailbox identity
- Violation: treating custody state as authoritative truth or varying retention by social distance
6. Time Domain Semantics
Time handling affects privacy through leakage:
| Variant | Purpose | Privacy Impact |
|---|---|---|
PhysicalClock | Guard charging, receipts, cooldowns | Leaks wall-clock via receipts |
LogicalClock | CRDT causality, journal ordering | No wall-clock leakage |
OrderClock | Privacy-preserving total order | Opaque tokens (no temporal meaning) |
Range | Validity windows, disputes | Bounded uncertainty from physical |
- Cross-domain time comparison must be explicit.
- Privacy-preserving flows must not expose physical time unless that exposure is part of the contract.
7. Adversarial Model
7.1 Direct Relationship
A party in a direct relationship may observe the full contents of that relationship context by consent.
- Must not: learn undisclosed contexts or link identity across contexts
- Contract boundary: relationship consent does not widen to other contexts
7.2 Group Insider
A group member may observe group-scoped activity by consent.
- Must not: learn other group memberships or unrelated identities
- Contract boundary: group visibility remains group-scoped
7.3 Gossip Neighbor
Devices forwarding traffic may observe protected metadata.
- Must not: decrypt content, identify protected endpoints, or map routing tags to identity
- Contract boundary: neighbor visibility remains budgeted metadata only
7.4 Network Observer
A network observer may observe connectivity and timing patterns.
- Must not: gain stronger privacy guarantees than the active deployment mode provides
- Contract boundary: privacy claims vary with the active protection mode
7.5 Compromised Device
A compromised device may reveal its local share and replicated state.
- Must not: unilaterally satisfy threshold requirements or derive protected root material
- Contract boundary: single-device compromise does not imply full authority compromise
8. External Observer Limits
Stronger privacy claims against external observers require sufficiently regular protected network behavior.
Basic availability deployments do not claim those stronger bounds. Routing and budgeting must also limit metadata concentration at any single relay or hub.
9. Required Properties
9.1 Identity and Key Separation
- Contexts must not share reusable identity material.
- Key derivation must remain domain-separated.
- Keys must not be reused across contexts.
9.2 Transport Privacy
- Protected transport must use authenticated encrypted envelopes.
- Transport observables must remain budgeted by observer class.
- Accountability return paths must not require direct reverse identity.
9.3 Send Authorization
- No transport observable may occur without prior local authorization and accounting.
- Failed authorization or charging must remain local.
- Forwarding must validate the required receipt or accountability state before onward transport.
9.4 Retrieval and Custody
- Parity-critical retrieval must use bounded retrieval authority.
- Parity-critical retrieval must not use identity-addressed mailbox polling.
Holdcustody must remain opaque and non-authoritative.- Uniform retention policy must not vary by social distance.
- Applications that require guaranteed durability must use authoritative replicated state rather than
Hold.
9.5 Accountability and Local Consequences
- Accountability evidence must be verified by the relevant local verifier before any local consequence is applied.
- Local scoring, reciprocal budget, and admission effects apply only after successful verification.
- Accountability traffic must not become a new global visibility layer.
9.6 Secret Material and Error Channels
- Secret material must not be stored in plaintext.
- Guard failures must return bounded, typed errors only.
- Error payloads must not include raw context payload, peer identity material, or decrypted content.
- Remote peers must not infer internal failure causes beyond allowed protocol-level status codes.
10. References
Distributed Systems Contract covers safety, liveness, and consistency.
Theoretical Model covers the formal calculus and semilattice laws.
System Architecture describes runtime layering and the guard chain.
Authorization covers authorization, budgeting, and Biscuit integration.
Transport and Information Flow documents transport semantics and receipts.
Relational Contexts documents cross-authority state and context isolation.
Verification Coverage Report tracks formal verification status.
Distributed Systems Contract
This contract specifies Aura's distributed systems model. It defines the safety, liveness, and consistency guarantees provided by the architecture. It also documents the synchrony assumptions and adversarial capabilities the system tolerates.
This contract complements Privacy and Information Flow Contract, which focuses on metadata and privacy budgets. Together these contracts define the full set of invariants protocol authors must respect.
Formal verification of these properties uses Quint model checking (verification/quint/) and Lean 4 theorem proofs (verification/lean/). See Verification Coverage Report for current status.
1. Scope
The contract applies to the following aspects of the system.
Effect handlers and protocols operate within the 8-layer architecture described in System Architecture. Journals and reducers are covered by this contract. The journal specification appears in Authority and Identity and Journal. Aura Consensus is documented in Consensus.
Relational contexts and rendezvous flows fall under this contract. Relational contexts are specified in Relational Contexts. Transport semantics appear in Transport and Information Flow. Rendezvous flows are detailed in Rendezvous Architecture. Shared notation appears in Theoretical Model.
1.1 Terminology Alignment
This contract uses shared terminology from Theoretical Model.
- Consensus role terms:
witnessfor consensus attestation,signerfor FROST share holders - Social-role terms:
Member,Participant,Moderator - Access terms:
AccessLevel(Full,Partial,Limited) - Topology terms:
1-hopandn-hoppaths
1.2 Contract Vocabulary
authoritative: part of replicated truth and subject to convergence requirementsprotocol object: an execution object that supports transport or coordination without becoming replicated truthruntime-local: state owned by a local runtime and not treated as authoritativeaccountability witness: bounded evidence that a service action occurredcustody failure: loss, eviction, or retrieval miss for a non-authoritative held object
1.3 Assumptions
- Cryptographic primitives remain secure at configured parameters.
- Partial synchrony eventually holds after GST, with bounded
Δ_net. - Honest participants execute the guard chain in the required order.
- Anti-entropy exchange eventually delivers missing facts to connected peers.
1.4 Non-goals
- This contract does not provide global linearizability across all operations.
- This contract does not guarantee progress during permanent partitions.
- This contract does not guarantee metadata secrecy without privacy controls defined in Privacy and Information Flow Contract.
- This contract does not guarantee that runtime-local caches reflect authoritative truth at all times.
- This contract does not guarantee durable custody from
Holdservices.
1.5 Service Object Classes
Distributed behavior depends on three object classes with different contracts:
- authoritative shared objects
- transport and protocol objects
- runtime-derived local state
Only authoritative shared objects participate in replicated truth. Transport and protocol objects support execution. Runtime-derived local state remains non-authoritative and local to the runtime that owns it.
2. Safety Guarantees
2.1 Journal CRDT Properties
Facts merge via set union and never retract. Journals satisfy the semilattice laws:
- Commutativity:
merge(j1, j2) ≡ merge(j2, j1) - Associativity:
merge(merge(j1, j2), j3) ≡ merge(j1, merge(j2, j3)) - Idempotence:
merge(j, j) ≡ j
Reduction is deterministic. Identical fact sets produce identical states. No two facts share the same nonce within a namespace (InvariantNonceUnique).
2.2 Charge-Before-Send
Every transport observable is preceded by local authorization, accounting, and fact-coupling checks. No packet is emitted without a successful local decision.
Flow budgets satisfy monotonicity: charging never increases available budget (monotonic_decrease). Charging the exact remaining amount results in zero budget (exact_charge).
2.3 Consensus Agreement
For any pair (cid, prestate_hash) there is at most one commit fact (InvariantUniqueCommitPerInstance). Fallback gossip plus FROST signatures prevent divergent commits. Byzantine witnesses cannot force multiple commits for the same instance.
Commits require threshold participation (InvariantCommitRequiresThreshold). Equivocating witnesses are excluded from threshold calculations (InvariantEquivocatorsExcluded).
2.3.1 Fault Assumptions
Consensus safety depends on declared threshold and fault bounds.
Threshold signatures require the configured threshold of distinct valid shares. Safety requires fault assumptions that remain within the bound declared for the active ceremony. Different ceremonies may declare different admissible fault bounds.
2.4 Evidence CRDT
The evidence system tracks votes and equivocations as a grow-only CRDT:
- Monotonicity: Votes and equivocator sets only grow under merge
- Commit preservation:
mergepreserves existing commit facts - Semilattice laws: Evidence merge is commutative, associative, and idempotent
2.5 Equivocation Detection
The system detects witnesses who vote for conflicting results:
- Soundness: Detection only reports actual equivocation (no false positives)
- Completeness: All equivocations are detectable given sufficient evidence
- Honest safety: Honest witnesses are never falsely accused
Types like HasEquivocated and HasEquivocatedInSet exclude conflicting shares from consensus. See Consensus.
2.6 FROST Threshold Signatures
Threshold signatures satisfy binding and consistency properties:
- Share binding: Shares are cryptographically bound to
(consensus_id, result_id, prestate_hash) - Threshold requirement: Aggregation requires at least k shares from distinct signers
- Session consistency: All shares in an aggregation have the same session
- Determinism: Same shares always produce the same signature
2.7 Context Isolation
Messages scoped to ContextId never leak into other contexts. Contexts may be explicitly bridged through typed protocols only. See Theoretical Model. Each authority maintains separate journals per context to enforce this isolation.
2.8 Transport Layer
Beyond context isolation, transport satisfies:
- Flow budget non-negativity: Spent never exceeds limit (
InvariantFlowBudgetNonNegative) - Sequence monotonicity: Message sequence numbers strictly increase (
InvariantSequenceMonotonic) - Fact backing: Every sent message has a corresponding journal fact (
InvariantSentMessagesHaveFacts)
2.9 Deterministic Reduction Order
Commitment tree operations resolve conflicts using the stable ordering described in Authority and Identity. This ordering is derived from the cryptographic identifiers and facts stored in the journal. Conflicts are always resolved in the same way across all replicas.
2.10 Receipt Chain
Multi-hop forwarding requires signed receipts. Downstream peers reject messages lacking a chain rooted in their relational context. See Transport and Information Flow. This prevents unauthorized message propagation.
2.11 Onion Accountability Verification
Onion-routed accountability must preserve anonymous reverse delivery of bounded witnesses.
Verifier roles are explicit and local. Local runtime consequences such as scoring, reciprocal budget, and admission preference apply only after verification succeeds.
Accountability return paths use typed single-use reply blocks. MoveReceiptReplyBlock, HoldDepositReplyBlock, HoldRetrievalReplyBlock, and HoldAuditReplyBlock are scoped proof-return capabilities. They are not generic reverse channels.
Witness traffic must return through the shared movement substrate when onion routing is active. Direct callback assumptions are not part of the privacy-mode contract.
2.12 Hold Service Profiles
Hold is a shared custody service surface. Profile-specific retrieval or retention semantics are allowed.
All Hold services must preserve the common custody invariants. Custody remains opaque, non-authoritative, selector-driven, and best-effort.
DeferredDeliveryHold and CacheReplicaHold are named profiles over one custody substrate. DeferredDeliveryHold uses retrieve-once semantics and re-deposit on miss. CacheReplicaHold uses retention-window-governed replica semantics.
Applications that need durable truth must use journals, consensus, or another authoritative replicated state path. Hold does not provide durable custody.
3. Protocol-Specific Guarantees
3.1 DKG and Resharing
Distributed key generation and resharing satisfy:
- Threshold bounds:
1 ≤ t ≤ nwhere t is threshold and n is participant count - Phase consistency: Commitment counts match protocol phase
- Share timing: Shares distributed only after commitment verification
3.2 Invitation Flows
Invitation lifecycle satisfies authorization invariants:
- Sender authority: Only sender can cancel an invitation
- Receiver authority: Only receiver can accept or decline
- Single resolution: No invitation resolved twice
- Terminal immutability: Terminal status (accepted/declined/cancelled/expired) is permanent
- Fact backing: Accepted invitations have corresponding journal facts
- Ceremony gating: Ceremonies only initiated for accepted invitations
3.3 Epoch Validity
Epochs enforce temporal boundaries:
- Receipt validity window: Receipts only valid within their epoch
- Replay prevention: Old epoch receipts cannot be replayed in new epochs
3.4 Cross-Protocol Safety
Concurrent protocol execution (e.g., Recovery∥Consensus) satisfies:
- No deadlock: Interleaved execution always makes progress
- Revocation enforcement: Revoked devices excluded from all protocols
4. Liveness Guarantees
4.1 Fast-Path Consensus
Fast-path consensus completes within bounded delay when the fast-path witness and network assumptions hold.
4.2 Fallback Consensus
Fallback consensus eventually completes under partial synchrony when the fallback quorum and delivery assumptions hold.
4.3 Anti-Entropy
Journals converge under eventual delivery. CRDT merges reconcile fact sets even after partitions.
4.4 Rendezvous
Offer and answer envelopes flood gossip neighborhoods. Secure channels can be established as long as at least one bidirectional path remains between parties. See Rendezvous Architecture.
4.5 Flow Budgets
Flow-budget progress is conditional. If future epoch state restores positive headroom and epoch updates converge, local budget enforcement eventually grants headroom. Budget exhaustion remains temporary only under these assumptions.
Liveness requires that each authority eventually receives messages from its immediate neighbors. This is the eventual delivery assumption. Liveness also requires that clocks do not drift unboundedly. This is necessary for epoch rotation and receipt expiry.
4.6 Hold Availability
Hold availability is neighborhood-scoped and selector-driven. It is not a guarantee that any specific holder remains available.
Liveness for Hold requires that the runtime can find some admissible holder within the neighborhood-scoped provider set. Retrieval miss and re-deposit are expected recovery behaviors. They are not contract violations by themselves.
The runtime may choose a bounded rotating subset of holders inside the wider neighborhood-scoped provider set. This bounded operational set does not narrow the interface scope. Retention treatment must remain uniform across neighborhood deposits.
5. Time System
Aura uses a unified TimeStamp with domain-specific comparison:
- Reflexivity:
compare(policy, t, t) = eq - Transitivity:
compare(policy, a, b) = lt ∧ compare(policy, b, c) = lt → compare(policy, a, c) = lt - Privacy: Physical time hidden when
ignorePhysical = true
Time variants include PhysicalClock (wall time), LogicalClock (vector/Lamport), OrderClock (opaque ordering tokens), and Range (validity windows).
6. Synchrony and Timing Model
Aura assumes partial synchrony. There exists a bound Δ_net on message delay and processing time once the network stabilizes. This bound may be unknown before stabilization occurs.
Before stabilization, progress may stall. After stabilization, protocols that depend on eventual delivery and bounded delay may resume progress.
Flow budget epochs are logical, using AMP-style generations, windows and spacing (see Transport and Information Flow §3.1); no clock decides which budget epoch is in force. Where other epochs use time-based rotation, it relies on loosely synchronized clocks. The journal remains the source of truth for observed epoch state.
7. Adversarial Model
7.1 Network Adversary
A network adversary may delay or drop traffic and may control a subset of links.
- Must not: break cryptography or forge valid accountability material without the required local authorization and signatures
- Contract boundary: safety holds only within the declared fault bounds for the active ceremony
7.2 Byzantine Witness
A Byzantine witness may equivocate or refuse to participate.
- Must not: cause multiple commits for the same consensus instance while the declared fault assumptions hold
- Contract boundary: equivocation is detectable and excluded from valid threshold outcomes
7.3 Malicious Relay
A malicious relay may drop, delay, or refuse to forward envelopes.
- Must not: read protected payload content or forge valid forwarding accountability
- Contract boundary: relay failure may reduce liveness but must not violate transport safety or accountability rules
7.4 Malicious Hold Provider
A malicious hold provider may evict, refuse retrieval, or under-serve after accepting custody.
- Must not: turn custody objects into authoritative state or obtain legitimate service credit without successful witness verification
- Contract boundary: custody failure affects availability, not authoritative truth
7.5 Device Compromise
A compromised device may reveal its local share and journal copy.
- Must not: satisfy threshold requirements on its own or rewrite authoritative history unilaterally
- Contract boundary: device compromise is recoverable if the remaining threshold and recovery assumptions still hold
8. Consistency Model
| Surface | Required Guarantee | Explicit Non-guarantee |
|---|---|---|
| Journal | Replicas that observe the same fact set converge to the same state | Immediate global agreement |
| Consensus-scoped operation | Honest replicas agree on the committed result for that operation | A single global linearizable log |
| Transport | Transport safety does not depend on causal delivery ordering | Global transport-level causal order |
| Local replica view | Locally observed facts remain monotone | Instant reflection of all remote facts |
9. Failure Handling
Failure classes are distinct:
- authoritative state failure
- custody failure
- runtime-local cache or selection failure
Allowed failure:
- temporary loss of progress during partition or instability
- custody miss, eviction, or re-deposit
- runtime-local cache invalidation or reselection
Forbidden failure:
- divergent authoritative truth for the same committed operation
- treating custody state as authoritative replicated truth
- exposing internal failure causes through remote error detail
Local-only failure:
- authorization failure
- budget exhaustion
- runtime-local cache or selection failure
9.1 Error-Channel Privacy Requirements
- Runtime errors must use bounded enums and redacted payloads.
- Error paths must not include plaintext message content, raw capability tokens, or cross-context identifiers.
- Remote peers may observe protocol-level status outcomes only, not internal guard-stage diagnostics.
10. References
System Architecture describes runtime layering.
Authorization describes authorization and budgeting ordering.
Theoretical Model covers the formal calculus and semilattice laws.
Authority and Identity documents reduction ordering.
Journal and Distributed Maintenance Architecture cover fact storage and convergence.
Relational Contexts documents cross-authority state.
Consensus describes fast path and fallback consensus.
Transport and Information Flow documents transport semantics.
Authorization covers authorization and budgeting sequencing.
Verification Coverage Report tracks formal verification status.
Cryptography
This document describes the cryptographic architecture in Aura. It defines layer responsibilities, code organization patterns, security invariants, and compliance requirements for cryptographic operations.
Distributed FROST package construction exchanges public signing commitments, never private nonce bundles. A participant signs only after matching the native and outer signing messages to its independently admitted intent, and matching the public package, complete selected participant inventory, local share and threshold to its admitted policy. The native public key package does not encode the threshold; its presence alone cannot establish quorum policy. Runtime ownership must additionally enforce durable one-use nonce consumption and the original admitted execution window. Public commitment data does not grant that ownership.
FROST aggregation requires exactly one supplied signature share per selected participant. Extra shares cannot be ignored. The native commitment inventory and message must match the outer package; malformed shares and audited-library aggregation failures retain their concrete causes.
1. Overview
Aura's cryptographic architecture follows the 8-layer system design with strict separation of concerns.
- Layer 1 (
aura-core): Type wrappers, trait definitions, pure functions - Layer 3 (
aura-effects): Production implementations with real crypto libraries - Layer 8 (
aura-testkit): Mock implementations for deterministic testing
This separation ensures that cryptographic operations are auditable, testable, and maintainable. Security review focuses on a small number of files rather than scattered usage throughout the codebase.
2. Layer Responsibilities
2.1 Layer 1: aura-core
The aura-core crate provides cryptographic foundations without direct side effects.
Type Wrappers
Type wrappers live in crates/aura-core/src/crypto/ed25519.rs.
#![allow(unused)] fn main() { pub struct Ed25519SigningKey(pub [u8; 32]); pub struct Ed25519VerifyingKey(pub [u8; 32]); pub struct Ed25519Signature(pub [u8; 64]); }
These wrappers use fixed-size arrays for type safety and delegate to ed25519_dalek internally. They expose a stable API independent of the underlying library. They enable future algorithm migration without changing application code. They provide type safety across crate boundaries.
Effect Traits
Effect trait definitions live in crates/aura-core/src/effects/. The CryptoCoreEffects trait inherits from RandomCoreEffects and provides core cryptographic operations.
#![allow(unused)] fn main() { #[async_trait] pub trait CryptoCoreEffects: RandomCoreEffects + Send + Sync { // Key derivation async fn kdf_derive(&self, ikm: &[u8], salt: &[u8], info: &[u8], output_len: u32) -> Result<Vec<u8>, CryptoError>; async fn derive_key(&self, master_key: &[u8], context: &KeyDerivationContext) -> Result<Vec<u8>, CryptoError>; // Ed25519 signatures async fn ed25519_generate_keypair(&self) -> Result<(Vec<u8>, Vec<u8>), CryptoError>; async fn ed25519_sign(&self, message: &[u8], private_key: &[u8]) -> Result<Vec<u8>, CryptoError>; async fn ed25519_verify(&self, message: &[u8], signature: &[u8], public_key: &[u8]) -> Result<bool, CryptoError>; // Utility methods fn is_simulated(&self) -> bool; fn crypto_capabilities(&self) -> Vec<String>; fn constant_time_eq(&self, a: &[u8], b: &[u8]) -> bool; fn secure_zero(&self, data: &mut [u8]); } }
The CryptoExtendedEffects trait provides additional operations with default implementations that return errors:
#![allow(unused)] fn main() { #[async_trait] pub trait CryptoExtendedEffects: CryptoCoreEffects + Send + Sync { // Unified signing API async fn generate_signing_keys(&self, threshold: u16, max_signers: u16) -> Result<SigningKeyGenResult, CryptoError>; async fn generate_signing_keys_with(&self, method: KeyGenerationMethod, threshold: u16, max_signers: u16) -> Result<SigningKeyGenResult, CryptoError>; async fn sign_with_key(&self, message: &[u8], key_package: &[u8], mode: SigningMode) -> Result<Vec<u8>, CryptoError>; async fn verify_signature(&self, message: &[u8], signature: &[u8], public_key_package: &[u8], mode: SigningMode) -> Result<bool, CryptoError>; // FROST threshold signatures async fn frost_generate_keys(&self, threshold: u16, max_signers: u16) -> Result<FrostKeyGenResult, CryptoError>; async fn frost_generate_nonces(&self, key_package: &[u8]) -> Result<FrostNonces, CryptoError>; async fn frost_create_public_signing_package(&self, message: &[u8], commitments: &[FrostPublicCommitment], public_key_package: &[u8], threshold: u16) -> Result<FrostSigningPackage, CryptoError>; async fn frost_sign_share_for_message(&self, package: &FrostSigningPackage, local_key_share: &[u8], nonces: RetiredFrostNonces, expected_message: &[u8], expected_public_key_package: &[u8], expected_threshold: u16) -> Result<Vec<u8>, CryptoError>; async fn frost_aggregate_signatures(&self, signing_package: &FrostSigningPackage, signature_shares: &[Vec<u8>]) -> Result<Vec<u8>, CryptoError>; async fn frost_verify(&self, message: &[u8], signature: &[u8], group_public_key: &[u8]) -> Result<bool, CryptoError>; async fn ed25519_public_key(&self, private_key: &[u8]) -> Result<Vec<u8>, CryptoError>; // Symmetric encryption async fn chacha20_encrypt(&self, plaintext: &[u8], key: &[u8; 32], nonce: &[u8; 12]) -> Result<Vec<u8>, CryptoError>; async fn chacha20_decrypt(&self, ciphertext: &[u8], key: &[u8; 32], nonce: &[u8; 12]) -> Result<Vec<u8>, CryptoError>; async fn aes_gcm_encrypt(&self, plaintext: &[u8], key: &[u8; 32], nonce: &[u8; 12]) -> Result<Vec<u8>, CryptoError>; async fn aes_gcm_decrypt(&self, ciphertext: &[u8], key: &[u8; 32], nonce: &[u8; 12]) -> Result<Vec<u8>, CryptoError>; // Key rotation and conversion async fn frost_rotate_keys(&self, old_shares: &[Vec<u8>], old_threshold: u16, new_threshold: u16, new_max_signers: u16) -> Result<FrostKeyGenResult, CryptoError>; async fn convert_ed25519_to_x25519_public(&self, ed25519_public_key: &[u8]) -> Result<[u8; 32], CryptoError>; async fn convert_ed25519_to_x25519_private(&self, ed25519_private_key: &[u8]) -> Result<[u8; 32], CryptoError>; } pub trait CryptoEffects: CryptoCoreEffects + CryptoExtendedEffects {} }
The core trait provides key derivation and Ed25519 signatures. The extended trait provides unified signing that routes between single-signer and threshold modes, FROST threshold operations, symmetric encryption, and key conversion. Hashing is not included because it is a pure operation. Use aura_core::hash::hash() for synchronous hashing instead.
The RandomCoreEffects trait provides cryptographically secure random number generation.
#![allow(unused)] fn main() { #[async_trait] pub trait RandomCoreEffects: Send + Sync { async fn random_bytes(&self, len: usize) -> Vec<u8>; async fn random_bytes_32(&self) -> [u8; 32]; async fn random_u64(&self) -> u64; } #[async_trait] pub trait RandomExtendedEffects: RandomCoreEffects + Send + Sync { async fn random_range(&self, min: u64, max: u64) -> u64; async fn random_uuid(&self) -> Uuid; } }
The core trait provides basic random generation. The extended trait adds range and UUID generation with default implementations. All randomness flows through these traits for testability and simulation.
Pure functions in crates/aura-core/src/crypto/ implement hash functions, signature verification, and other deterministic operations. These require no side effects and can be called directly.
2.2 Layer 3: aura-effects
The aura-effects crate contains the only production implementations that directly use cryptographic libraries.
The production handler lives in crates/aura-effects/src/crypto.rs. RealCryptoHandler can operate with OS entropy (production) or with a seed (deterministic testing). It implements all methods from CryptoCoreEffects and RandomCoreEffects.
The following direct imports are allowed in Layer 3:
ed25519_dalekfrost_ed25519chacha20poly1305aes_gcmgetrandomrand_core::OsRngrand_chachablake3
2.3 Threshold Lifecycle (K1/K2/K3) and Transcript Binding
Aura separates key generation from agreement/finality:
- K1: Single-signer (Ed25519). No DKG required.
- K2: Dealer-based DKG. A trusted coordinator produces dealer packages.
- K3: Consensus-finalized DKG. The BFT-DKG transcript is finalized by consensus.
Transcript hashing uses the following rules:
- All DKG transcripts are hashed using canonical DAG‑CBOR encoding.
DkgTranscriptCommitbindstranscript_hash,prestate_hash, andoperation_hash.
Dealer packages (K2) follow these rules:
- Deterministic dealer packages are acceptable in trusted settings.
- Dealer packages must include encrypted shares for every participant.
BFT‑DKG (K3) follows these rules:
- A transcript is only usable once consensus finalizes the commit fact.
- All K3 ceremonies must reference the finalized transcript (hash or blob ref).
2.4 Layer 8: aura-testkit
The aura-testkit crate provides mock implementations for deterministic testing.
The mock handler lives in crates/aura-testkit/src/stateful_effects/crypto.rs. MockCryptoHandler uses a seed and counter for deterministic behavior, enabling reproducible test results, simulation of edge cases, and faster test execution.
3. Usage Boundary
Application code accesses cryptographic operations exclusively through effect traits. Direct imports of cryptographic libraries are forbidden outside Layer 3 handlers. Randomness flows through RandomCoreEffects for testability and simulation. See Effects and Handlers Guide for usage patterns and anti-patterns.
4. Allowed Locations
Direct cryptographic library usage is restricted to the following locations.
| Location | Allowed Libraries | Purpose |
|---|---|---|
aura-core/src/crypto/* | ed25519_dalek, frost_ed25519 | Type wrappers |
aura-core/src/types/authority.rs | ed25519_dalek | Authority trait types |
aura-effects/src/* | All crypto libs | Production handlers |
aura-effects/src/noise.rs | snow | Noise Protocol implementation |
aura-testkit/* | All crypto libs | Test infrastructure |
**/tests/*, *_test.rs | OsRng | Test-only randomness |
#[cfg(test)] modules | OsRng | Test-only randomness |
5. Security Invariants
The cryptographic architecture maintains these invariants.
- All production crypto operations flow through
RealCryptoHandler - Security review focuses on Layer 3 handlers, not scattered usage
- All crypto is controllable via mock handlers for testing
- Private keys remain in wrapper types, not exposed as raw bytes
- Production randomness comes from OS entropy via
OsRng - Identity and key bytes decoded from a remote payload are untrusted until checked against an authoritative local key source. A signature by the same key that signed an imported invitation proves continuity of that invitation, not trusted device identity.
- A response is constructed from a completed signature over its canonical transcript; production response construction does not create an unsigned placeholder.
- Imported authority tree operations require the verifying package and threshold policy of their parent epoch from an authenticated source. A matching parent commitment, a sibling transport session, or a key delivered beside the operation does not authenticate the operation. An enrolling device needs an explicit, ceremony-bound trust bootstrap before it can adopt a baseline tree. Required parent-policy reads distinguish absent records from storage and decoding failures. Participant inventory is complete and unique, and single-signer policy has exactly one participant and a threshold of one. An unreadable trusted record cannot authorize migration to a substitute verifier.
- A transport receipt signed under a key carried in the receipt proves transcript integrity under that key. It does not authenticate the
AuthorityIdin the envelope. Promoting the source to verified authority or device identity requires comparison with an independently trusted key and an authenticated authority/device binding. A nonzero nonce is not replay protection without a checked replay state.
6. Signing Modes
Aura supports two signing modes to handle different account configurations.
6.1 SigningMode Enum
#![allow(unused)] fn main() { pub enum SigningMode { SingleSigner, // Standard Ed25519 for 1-of-1 Threshold, // FROST for m-of-n where m >= 2 } }
The SingleSigner mode is used for new user onboarding with single device accounts. It is also used for bootstrap scenarios before multi-device setup and for simple personal accounts that do not need threshold security.
The Threshold mode is used for multi-device accounts such as 2-of-3 or 3-of-5 configurations. It is also used for guardian-protected accounts and group decisions requiring multiple approvals.
6.2 Why Two Modes?
FROST requires at least 2 signers. For 1-of-1 configurations, we use standard Ed25519.
Ed25519 uses the same curve as FROST and produces compatible signatures for verification. Single signatures do not require nonce coordination or aggregation.
6.3 API Usage
The unified signing API selects between SingleSigner and Threshold modes based on the threshold parameter. For implementation patterns, see Effects and Handlers Guide.
6.4 Storage Separation
Single-signer and threshold keys use separate storage paths managed by SecureStorageEffects. Path conventions are documented in Effects and Handlers Guide.
7. FROST and Threshold Signatures
Aura provides a unified threshold signing architecture for all scenarios requiring m-of-n signatures where m >= 2.
7.1 Architecture Layers
The trait definition lives in aura-core/src/effects/threshold.rs.
#![allow(unused)] fn main() { #[async_trait] pub trait ThresholdSigningEffects: Send + Sync { async fn bootstrap_authority(&self, authority: &AuthorityId) -> Result<PublicKeyPackage, ThresholdSigningError>; async fn sign(&self, context: SigningContext) -> Result<ThresholdSignature, ThresholdSigningError>; async fn threshold_config(&self, authority: &AuthorityId) -> Option<ThresholdConfig>; async fn threshold_state(&self, authority: &AuthorityId) -> Option<ThresholdState>; async fn has_signing_capability(&self, authority: &AuthorityId) -> bool; async fn public_key_package(&self, authority: &AuthorityId) -> Option<PublicKeyPackage>; async fn rotate_keys(&self, authority: &AuthorityId, new_threshold: u16, new_total_participants: u16, participants: &[ParticipantIdentity]) -> Result<(u64, Vec<Vec<u8>>, PublicKeyPackage), ThresholdSigningError>; async fn commit_key_rotation(&self, authority: &AuthorityId, new_epoch: u64) -> Result<(), ThresholdSigningError>; async fn rollback_key_rotation(&self, authority: &AuthorityId, failed_epoch: u64) -> Result<(), ThresholdSigningError>; } }
The trait provides methods for bootstrapping authorities, signing operations, querying configurations and state, checking capabilities, and key rotation lifecycle management.
Context types live in aura-core/src/threshold/context.rs.
#![allow(unused)] fn main() { pub struct SigningContext { pub authority: AuthorityId, pub operation: SignableOperation, pub approval_context: ApprovalContext, } pub enum SignableOperation { TreeOp(TreeOp), RecoveryApproval { target: AuthorityId, new_root: TreeCommitment }, GroupProposal { group: AuthorityId, action: GroupAction }, Message { domain: String, payload: Vec<u8> }, OTAActivation { ceremony_id: [u8; 32], upgrade_hash: [u8; 32], prestate_hash: [u8; 32], activation_epoch: Epoch, ready: bool }, } pub enum ApprovalContext { SelfOperation, RecoveryAssistance { recovering: AuthorityId, session_id: String }, GroupDecision { group: AuthorityId, proposal_id: String }, ElevatedOperation { operation_type: String, value_context: Option<String> }, } }
The SignableOperation enum defines what is being signed. Its OTA activation variant should be interpreted as scoped activation approval evidence. activation_epoch is meaningful only when the chosen scope actually owns an epoch fence. The ApprovalContext enum provides context for audit and display purposes.
The service implementation lives in aura-agent/src/runtime/services/threshold_signing.rs. ThresholdSigningService manages per-authority signing state and key storage using SecureStorageEffects for key material persistence.
Bootstrap preserves an existing signing identity. Recovery loads the persisted active epoch, policy, participants and public package instead of regenerating epoch-zero keys. Invalid or incomplete persisted material is a recovery failure and cannot authorize replacement keys. Decrypting an existing signing share is a read-only operation on its wrapping key; a missing key or failed storage read must not create new wrapping material. A setup code signed before recovery must retain the same verifier afterward.
An enrollment response must verify under the exact provisional signing package, epoch, mode and threshold policy selected by explicit user transfer. The initiator retains that statement, its canonical digest and ceremony binding before starting response owners; proof material supplied by the responder cannot choose the expected verifier. Restored records retain the original package and validity bounds. Missing legacy verifier state requires a new transfer rather than self-certifying a response's key.
The setup validity interval governs admission to issuance. A successfully retained ceremony may verify a response after setup expiry within the invitation/ceremony's own response deadline; expiry does not substitute another key or grant a new issuance. These deadlines are distinct from nonce consumption and atomic activation, whose durable receipts remain separate requirements.
Historical setup-response signing is limited to a retained, admitted setup request and its exact invitation/ceremony transcript. Possession of an old encrypted key does not authorize signing after local revocation, cancellation or completion. A response permit requires authenticated initiator-manifest provenance, a durable setup admission receipt and current owner-controlled lifecycle eligibility. It cannot accept an arbitrary payload, domain or epoch. Setup admission must not infer validity from another device's exact wall-clock timestamp; each owner's recorded admission evidence governs its validity gate.
For a threshold setup policy, response signing requires the authenticated historical participant inventory and its quorum under the same narrow response permit. Single-signer fallback cannot satisfy that policy. Retained shares remain available while authorized pending requests need them; expiry, cancellation, revocation and terminal outcomes govern retirement without removing active keys.
A retained local threshold share must match its authenticated signer identity, threshold policy, group verifying key and verifying share. Its signing scalar must derive that same verifying share, and the public package must contain the exact authenticated participant inventory. Package decoding alone does not establish these properties. Native FROST public packages do not encode a threshold; a conversion default is not policy evidence. Membership in a prior epoch cannot authorize signing after removal from the current participant set.
Initial signing-key readiness is distinct from bootstrap genesis completion. A pending genesis record binds the authority, physical device, epoch-zero public package digest and initialization phase before key persistence. Completion binds the authenticated, durably indexed device-creation operation. A failed genesis commit cannot publish a usable signing context. Recovery may resume creation only from a matching pending initialization; legacy keys with missing or conflicting creation evidence require explicit recovery rather than a new leaf.
Low-level primitives live in aura-core/src/crypto/tree_signing.rs. This module defines FROST types and pure coordination logic. It re-exports frost_ed25519 types for type safety.
The handler in aura-effects/src/crypto.rs implements FROST key generation and signing. This is the only location with direct frost_ed25519 library calls.
7.2 Serialized Size Invariants (FROST)
Aura treats the postcard serialization of FROST round-one data as canonical and fixed-size. This prevents malleability and makes invalid encodings unrepresentable at the boundary.
SigningNonces(secret) must serialize to exactly 138 bytesSigningCommitments(public) must serialize to exactly 69 bytes
These sizes are enforced in aura-core/src/crypto/tree_signing.rs and mirrored in aura-core/src/constants.rs. See Distributed Maintenance Guide for update procedures when upstream encodings change.
7.3 Lifecycle Taxonomy (Key Generation vs Agreement)
Aura separates key generation from agreement/finality:
- K1: Local/Single-Signer (no DKG)
- K2: Dealer-Based DKG (trusted coordinator)
- K3: Quorum/BFT-DKG (consensus-finalized transcript)
Agreement modes are orthogonal:
- A1: Provisional (usable immediately, not final)
- A2: Coordinator Soft-Safe (bounded divergence + convergence cert)
- A3: Consensus-Finalized (unique, durable, non-forkable)
Leader selection (lottery/round seed/fixed coordinator) and pipelining are orthogonal optimizations, not agreement modes.
7.4 Usage Pattern
High-level signing operations use AppCore or direct ThresholdSigningEffects trait calls. See Effects and Handlers Guide for recommended patterns.
7.5 Threshold PRF for Shared Symmetric Keys
FROST DKG leaves the group secret s unknown to every participant, so a symmetric key that all members of a relational context share (AMP channel base keys, AMP §4) is derived with a DDH-based threshold PRF over the DKG shares rather than from any public value.
H(x)hashes the input to a prime-order Ed25519 point whose discrete log is unknown (domain-separated try-and-increment; canonical decoding rejects identity and small-order points).- Participant
iwith shares_ipublishesσ_i = s_i · H(x)and a Chaum-Pedersen proof thatlog_B(Y_i) = log_H(σ_i)for its public verifying shareY_i = s_i · B. Partials that do not verify are discarded, so a faulty member cannot corrupt the key. - Any threshold of verified partials from distinct participants combine by Lagrange interpolation at zero to
s · H(x); the key isKDF(s · H(x), x). Every member derives the same key, and data available to non-members (the group verifying key, verifying shares,x) does not determine it. - The proof nonce comes from
RandomEffects; the primitive is pure and lives inaura-core::crypto::threshold_prf.
7.6 FROST Minimum Threshold
FROST requires threshold >= 2. Calling frost_generate_keys(1, 1) returns an error. For single-signer scenarios, use generate_signing_keys(1, 1) which routes to Ed25519 automatically.
8. Extensibility
The wrapper and trait abstraction enables algorithm migration and HSM integration without changing application code. Migration procedures are documented in Distributed Maintenance Guide.
See Also
- Effect System for effect trait patterns
- Project Structure for 8-layer architecture
- Effects and Handlers Guide for handler implementation guidance
Independently transferred enrollment manifest
The current version-three manifest requires an explicit final active verifier inventory. Enrollment transfer version four requires the original setup binding and invitee authority. Acceptance requires the exact manifest digest; persisted activation version three requires its signed epoch fence, original baseline and that digest. Omitted or null required evidence fails decoding. Obsolete enrollment transport, manifest and activation representations are not admitted.
Enrollment baseline admission requires a signed EnrollmentTrustManifest and an independently transferred initiator verifier statement. The verifier statement binds the subject authority, physical initiator device, and confirmation key. A key embedded in an invitation or manifest cannot establish this pin. Decoding a transfer statement does not authorize admission; the explicit app transfer owner selects it.
The signed manifest binds the exact setup nonce and digest, reserved invitation and ceremony identifiers, actual provisional invitee authority and physical device, pending epoch, encrypted participant share, public package, canonical provisional threshold policy, and complete ordered baseline digest. Every attested baseline operation requires an exact parent epoch, commitment, signing node, group verifier, ordered participant inventory, threshold, signing mode, and agreement policy from that independently authenticated inventory. Replay checks each signature and reduction before any baseline/key mutation, rejects unused or missing inventory, and requires the exact final commitment. An epoch root key is not proof of an arbitrary node verifier.
Runtime admission rechecks the actual locally retained exported setup request and its signed policy bounds. The immutable secure admission record retains the selected verifier and original local admission time; recovery re-verifies its evidence rather than deserializing a trusted witness. Missing, corrupt, expired, mismatched, or legacy unbound evidence fails closed. Admission is a ceremony-scoped bootstrap permission, not authority adoption, durable peer membership, or permission to use retired signing shares. Acceptance binds the issuer-retained exact manifest digest in addition to the setup and ceremony binding.
Committed enrollment confirmation receipts
An invitee activation requires an issuer-pinned signed committed confirmation bound to the exact independently admitted enrollment manifest, invitation, ceremony, physical device and pending epoch. A cached accepted status, unsigned confirmation or received signing package is insufficient. The committed confirmation and original admitted budget acknowledgement are retained in an immutable authenticated local receipt before activation.
Recovery verifies the original transfer signature, exact baseline and setup binding, the actual committed confirmation signature, and the recorded original budget state before producing activation evidence. Historical verification is scoped to that retained receipt; it grants no historical signing authority and cannot extend an admission window. Actual retained share, public package and canonical provisional configuration must match the signed manifest. Generic rotation activation cannot consume an enrollment import generation, and activation cannot roll back a later retained epoch.
Enrollment verifier origin enforcement
Retained enrollment response verification uses the independently retained setup verifier. Enrollment control verification uses the sealed independently admitted manifest. A remote key field and a trusted-looking local name do not establish either origin. Domain manifest signature verification establishes integrity under the explicitly independent input key and does not establish admission or current membership. Lexical test-only scopes do not relax production verifier contracts.
Public enrollment configuration digest
The enrollment manifest's pending configuration digest is a Hash32 content hash of the exact issued configuration encoding. It is public commitment material, not a threshold configuration or secret signing share. Its canonical encoding remains the original 32-byte array representation. Admission and generation validation compare this digest with freshly computed hashes of exact retained bytes; the digest alone confers no authority.
Enrollment signing roster and authenticated topology
Enrollment keeps the original independently pinned signing quorum separate from the authenticated tree child topology. A signed AddLeaf changes observed child edges before the original signing key attests the RotateEpoch activation fence. Verification retains the exact signed quorum minimum and signer-roster upper bound while deriving topology cardinality solely from authenticated branch and leaf-parent edges. A verification projection does not materialize a canonical branch. A policy already materialized by authenticated tree operations remains an independent minimum; invalid or incompatible canonical policy metadata fails closed and requires an authenticated policy transition rather than a local repair. Missing node-specific verifier inventory cannot be replaced with the epoch root package.
Individual participant possession proofs
An individual possession proof authenticates a transcript under one exact participant verifier from the independently authenticated current signing inventory. A FROST verifying share is distinct from the aggregate group key. Proof verification under a share does not satisfy the authority quorum or authorize an epoch transition. The signed transcript binds the protocol and version, subject ceremony and proposal, physical participant, active epoch, signing mode and index, and exact group package commitment. Legacy unbound responses cannot acquire current participant authority.
The primitive preserves canonical FROST scalar encoding and uses the standard ciphersuite Schnorr nonce/challenge/signature operations. A scalar is never reinterpreted as an Ed25519 seed. Runtime authorization additionally requires held current generation and tree custody and canonical physical membership.
Required active signing material
The runtime effect signer selects its epoch, policy, participant, and public package from required retained state under signing-generation custody. Missing or malformed state is a source-bearing failure. A solo signature additionally requires agreement between the retained public package and the public key derived by the cryptographic effect from the selected private package. A local share does not establish quorum; multi-party signing requires its owned threshold-agreement producer. Historical enrollment confirmation keys remain selected only by the retained original issuance witness.
Legacy bootstrap representation migration
A legacy epoch-zero participant representation may change from the authority's Guardian identifier to its authenticated physical Device identifier only while preserving the original signing secret and public package. Admission requires the authenticated original creation operation and its durable commit evidence. The converted canonical policy binds an immutable original migration decision; required signing and recovery reject missing or contradictory decision evidence. This representation migration provides neither a new signing epoch nor quorum agreement and does not renew any enrollment validity window.
Final active enrollment verifier inventory
Manifest v2 authenticates a final active exact-node verifier inventory separately from the historical parents that validate baseline operations. Each tuple binds the final epoch and tree commitment, signing node, mode, ordered participant roster, quorum, agreement and actual public package. Historical signatures do not promote an old package into a later epoch. Version-1 manifests preserve their original bytes and signature domain as historical evidence; a missing final inventory cannot authorize a new enrollment peer response.
Imported historical public verifier continuity
An imported authority's historical verifier inventory is evidence from its independently pinned enrollment manifest and authenticated committed transition. Its durable archive binds the physical profile/device, original admission, subject, invitation, manifest digest and committed history digest. Recovery revalidates the original admission and committed proof before granting access to archived verifier evidence. Possession of serialized public tuples is insufficient. The imported pending generation extends that evidence only when its exact public package and canonical provisional policy match the original signed commitments. Historical evidence does not certify absence of a later revocation, and it does not authorize substitution of an epoch root package for another signing node.
Archive v2 retains the imported pending generation's exact public package and canonical provisional policy from the original authenticated invitation, at its verified committed head. Verification can therefore continue after private share retirement without reconstructing public trust from a missing native key record. An already verified extension at that same epoch may use the same exact root verifier at its authenticated parent head; this does not grant trust to another node or epoch. Immutable v1 archives retain their original bytes and do not confer v2 admission. V2 publication requires explicit revalidation of the original locally retained confirmed receipt and uses a separate versioned namespace.
Threshold enrollment issuer evidence
A locally retained threshold participant package proves ownership of one exact share under the authenticated active policy. It is not a completed threshold signature and cannot authorize a solo enrollment manifest. Required issuer selection distinguishes missing quorum ownership from malformed signing policy, missing retained material, and private/public mismatch. Enrollment issuance after a threshold epoch requires a completed signature from the owned multi-party signing protocol, bound to the original allocation window and authenticated final verifier inventory.
The threshold policy domain permits k = 1 with multiple participants. The selected FROST backend requires at least two signers. A retained threshold package with k = 1 therefore reports an explicit backend capability failure; it is never normalized to a solo package or a higher threshold. Native backend operations retain their actual InvalidMinSigners failure.
Public signature input provenance
Bounded parsing of a public package and signature has typed input-encoding failures and does not establish signature validity, authority or quorum custody. Enrollment setup possession validates those encodings before invoking the verification effect. Malformed peer encodings and an invalid signature verdict are request rejection; an effect-provider verification failure retains its original required-runtime cause.
Unified threshold verification accepts the canonical native FROST public key package. The low-level FROST verification primitive accepts the extracted group verifying point. These inputs are distinct and have no repair fallback.
Deterministic random stream custody
Cloning a runtime crypto subsystem retains the same deterministic random stream owner. Draws through any clone consume that one stream in execution order; cloning cannot duplicate the next nonce or key-generation sequence. Separately constructed simulations with the same seed retain independent owners and reproduce the same sequence when their draw ordering matches. Concurrent scheduling does not imply a deterministic assignment of draws to individual callers.
Allocation-owned wrapping secrets
Permanent immutable wrapping records retain their original protection. An allocation-owned wrapping secret has a separately acknowledged immutable birth and a first-decision lifetime. Positive and negative decisions are mutually exclusive. Negative retirement removes normal live access only after the original provider acknowledges its tombstone; copied old ciphertext and backup erasure are separate guarantees. Existing permanent records cannot be relabeled as retirable allocations.
Private allocation lifetime persistence encoding
The selected filesystem lifetime provider serializes its private ledger record only to produce authenticated encrypted persistence. Serialized and decrypted plaintext buffers require zeroizing ownership; the decoded record zeroizes its secret field on drop. The codec does not provide logging, cloning, or public secret export. Its serialization derives require an explicit scoped security justification and the security policy gate. Retirement acknowledgement denies subsequent ledger reads; this does not prove cryptographic erasure of historical ciphertext copies decryptable under the retained profile key.
Secret field decoding itself requires zeroizing ownership and a bounded byte sequence. This applies before complete record construction, including malformed secret elements and failures in subsequent fields; record-level Drop alone is insufficient. Existing authenticated JSON byte-array encoding remains compatible.
Lifetime record plaintext serialization uses one zeroizing allocation from its first encoded byte. Encoding cannot release secret-bearing intermediate growth allocations. Authenticated envelope limits include magic, nonce and AEAD tag; codec failures retain their original serialization cause.
Platform-selected allocation lifetime custody
A production platform credential provider may issue allocation lifetime custody only from the same exclusive profile and credential namespace owner that was selected for ordinary secure records. A filesystem fallback, another keyring namespace, or a newly constructed provider cannot stand in for that owner. The provider must authenticate a bounded whole-profile allocation inventory before handing out any recovered allocation. Each inventory entry binds its original allocation identity, scope, provider identity and protected record; serialized references and directory names confer no authority. Missing, unknown, conflicting or unauthenticated entries fail closed. A previously completed handoff cannot be interpreted as a fresh empty profile after loss of its inventory.
Birth, first decision and negative retirement are durable, ordered transitions under the selected namespace lock. A birth is acknowledged only when its exact protected bytes and inventory binding can be recovered together after a crash. The first positive or negative decision is immutable; replay of the same decision is idempotent, while an opposite or byte-different decision fails. Negative retirement requires that original negative decision and returns an acknowledgment only after a recoverable tombstone denies live reads. An interruption between credential-store and inventory publication must be reconciled from authenticated original intent, never by generating a new allocation, discarding an unknown credential, or treating a partial write as success. Native provider failures remain typed and retain their original cause.
The credential store and profile inventory are separate durability domains. Their implementation must prove crash recovery across every interleaving and must not assume that a credential-store write is an atomic transaction with a profile file. A provider acknowledgment states only its documented local persistence contract; it does not prove erasure from backups or resistance to rollback of the complete local profile and credential namespace.
Participant envelope ownership across runtime consumers
A participant package's version selects its canonical authenticated decoder. Legacy version 1 binds authority, epoch and participant; allocation version 2 also requires the original selected-provider allocation custody. Retained setup verification and threshold-signing retrieval use that same decoder. A consumer cannot reinterpret an allocation envelope as a legacy package, accept raw package bytes as envelope evidence, or discard the concrete codec/provider failure while selecting an alternate identity.
Protected initial lifetime publications retain recoverable target-bound staged ciphertext through process death. Recovery requires the original physical owner, authenticated ciphertext and independently retained original lifecycle binding before acknowledgment. Once-live target loss cannot be repaired from an old stage; conflicting first-decision evidence is retained and rejected.
Original invitation transfer signer
A non-enrollment invitation transfer and its issuer response use the original locally retained physical signing identity. Its binding includes the original invitation identifier, recipient, context, creation time, canonical public payload, physical device, signing epoch and verifier. The binding is retained from fresh issuance before publication and is immutable. Restart and rotation recovery validate the original binding and exact original private package. Missing original evidence is a required failure; recovery cannot select an active replacement or infer an epoch from a peer-supplied public key. The retained identity selects signing material and does not authorize a response decision or establish current membership. Enrollment transfer remains governed by its separately pinned manifest and original-window authorization.
Required invitation response cryptography
Canonical invitation response transcripts distinguish evaluated invalid signatures from cryptographic provider failures. Required signing, verification and response encoding failures preserve their original error source; provider failure does not prove that a response is invalid or absent.
Selected-provider initialization inventories staged entries throughout its bounded record tree before allocating original lifetime evidence. Inventory memory and\nstructural depth are bounded; ordinary record count is not clamped. Only target-bound initialization candidates at their exact retained parent are eligible for subsequent cryptographic validation; names alone never authorize publication. Unknown staged evidence is retained and rejects initialization. Root handoff requires an exhausted stage inventory. A publication conflict discovered after observation retains the original ciphertext and native conflict cause.
A post-link original publication can temporarily have exactly two names for one private ciphertext inode. Recovery recognizes that pair only at the exact original target and matching stage, verifies its original owner evidence and bytes, acknowledges the target, then removes the stage. Other aliases and missing once-live targets do not authorize restoration. Ordinary required readers remain unaliased; this exception is private to original initialization.
Required transcript codec failures
Required local invitation signature boundaries retain the canonical transcript codec cause through a process-local error chain. The required encoder preserves the existing domain/schema/payload wire envelope; encoding failure occurs before signing or verification. Invalid signature results remain distinct from a failed cryptographic provider invocation.
Required invitation import validity uses the selected physical-time provider and
the canonical expiration boundary: an invitation is expired when now >= expiry.
A failed required observation preserves its original provider cause and cannot
produce a validated import, persist an invitation, or authorize subsequent
issuance or publication. An observational clock fallback cannot satisfy this
required validity check. Physical expiration remains local validity evidence,
never distributed ordering or renewed ceremony time.
Native authentication challenge issuance and signed-response verification require the selected physical-time provider. Provider failures retain their native causes. An issuance clock failure cannot create a pending challenge; failed required verification cannot publish an authenticated result or fact. The original signed expiry is excluded from the validity interval, consistently with authentication guards and views; retries cannot replace that endpoint with a newly constructed window.
Guardian recovery key reads require the original private and public pair. A missing half or a mismatched pair cannot authorize replacement. Fresh allocation and required reads share the actual runtime's exclusive keypair lease, and fresh allocation publishes its identity capability only after both storage writes acknowledge. This lease does not itself establish restart authority for an interrupted fresh allocation or distinguish complete historical key loss from an unused profile; those require separate durable lifetime evidence.
Original initialization successor custody
Interrupted initial checkpoint publication may complete only the original empty Preparing to Ready, Ready to Handed, and protected lifecycle Preparing to Handed transitions. Eligibility requires the actual selected profile owner, original immutable birth and phase-dependent seals. Observed ciphertext grants no mutation authority. Exposed allocations, pending decisions, foreign owners, or missing original proof prevent promotion.
Before cutover, a bounded authenticated journal retains both exact original ciphertexts and physical inode identities. Acknowledged predecessor and successor custody precedes atomic exchange. Exchange preserves any displaced current target; conflicting source/target evidence is never deleted as repair. Success requires both installed and displaced identities to match, directory acknowledgment, and no-replace archival of original evidence. Historical transaction records remain authenticated against the original birth; they cannot authorize live checkpoint restoration or a new root. Ordinary secure records keep their existing alias rules; only closed private initialization custody admits the additional retained links.
Recovery of mutable checkpoints after allocation exposure and a builder execution window around native profile IO are separate required contracts.
Ready validation authenticates each archived journal and then requires its exact original and successor ciphertexts at the retained predecessor, successor and displaced paths, with the original device/inode identities. Same ciphertext under a foreign inode is rejected. Custody paths without an authenticated active or archived journal fail closed; native alias layout alone does not authorize readiness.
Required archived-custody validation also rejects ciphertext corruption at each of the three retained paths, preserving the original birth and current root checkpoint bytes without replacement.
Runtime quorum custody
Possession of retained dealer shares does not authorize a runtime to manufacture a quorum. A raw signing context cannot establish distributed signing ownership. Required local key material is validated before an unavailable quorum owner is reported; malformed and missing material remain distinct native failures. Each admitted distributed signing participant controls its own share and one-use nonce.
Explicit enrollment transcript quorum
Current enrollment signing intent version 4 declares five ordered domains: the exact trust manifest, public version 4 invitation transport, initial version 2 enrollment Request control transcript, original issuer return mailbox statement, and finite negative terminal policy. The first four are initiation signature domains. The return statement binds the approved manifest and a public retrieval-credential commitment; the credential remains in issuer custody. Initial Request fields derive from that manifest and its transcript digest. The version 1 policy binds the same manifest digest and exactly Rejected, Cancelled, TimedOut, ChoreographyFailed, RuntimeFailed and Superseded. Public validation checks exact version, domain order, manifest, transport, initial Request and return-mailbox binding; unsupported or substituted declarations cannot gain consent.
The policy is conditional consent, not an initiation signature or evidence that an outcome occurred. Only the original runtime owner may combine its actual protected first negative decision with retained approved participant custody to sign the matching version 2 Failed control, with no committed operations. Committed controls require their separate original protected positive decision and participant custody. Neither policy grants arbitrary transcript signing, durable membership, current receiver freshness or reconstructed native custody.
The public coordinator accepts the actual typed security transcript. Its canonical required encoding must equal the original approved domain bytes before a round starts. Manifest version selection and native codec causes remain intact; raw message bytes cannot construct this signing policy.
Aggregate verification retains an active typed authority threshold key derived from the independently approved native public package and epoch. Enrollment verification retains its original sealed final inventory, issued manifest or retained generation; copied verifier bytes cannot substitute for that owner.
Each active physical participant retains only its own protected share and one-use nonce. Packet authentication proves possession of the exact individual verifying share from independently authenticated current ordered public material; it is not a whole-authority signature or user consent. Aggregate signatures must verify against the independently retained current group package. Each approved transcript domain has distinct immutable approval/nonce retirement evidence.
Confirmed imported key activation
The original signed imported share and pending configuration remain immutable. Confirmed activation retains a distinct immutable encrypted envelope, binding its original protected receipt, physical device, subject, epoch, manifest digest, share commitment and exact pending configuration. Its birth is recorded before publication; loss after birth cannot create a replacement nonce or envelope. Reactivation acknowledges the same reverified envelope. Final agreement is derived from the confirmed generation without changing the original signed configuration. Corrupt or missing original evidence fails closed.
Confirmed import wrapping secrets have managed allocation lifetime ownership. Their scope version 2 binds the original verified receipt's manifest digest, subject, physical device, epoch, ceremony, invitation and exact share commitment. Birth, read and positive sealing require that genuine original confirmation; a permanent legacy wrapping key cannot substitute for this custody. An existing original allocation prohibits replacement birth even if envelope publication was interrupted before its separate birth anchor was published.
Enrollment proposal purpose binding
Device epoch proposal transcript version 2 uses domain
aura.sync.device-epoch.proposal.v2. Enrollment purpose binds the exact original
manifest digest and enrolling device, separately from the existing recipient
device. Rotation and Removal are distinct purposes. The authenticated proposal
also binds its participant, epoch, key-package/configuration/public-package
hashes and encrypted-package binding. A valid signature for another purpose,
manifest or enrolling device cannot authorize this enrollment. Individual
participant possession proofs remain distinct from authority quorum signatures
and original user approval.
Identifiers and Boundaries
This reference defines the identifiers that appear in Aura documents. Every other document should reuse these definitions instead of restating partial variants. Each identifier preserves structural privacy by design.
1. Authority Identifiers
| Identifier | Type | Purpose |
|---|---|---|
AuthorityId | Uuid | Journal namespace for an authority. Does not leak operator or membership metadata. All public keys, commitment trees, and attested operations reduce under this namespace. Guardians are identified by their own AuthorityId. |
DeviceId | Uuid | Device within a threshold account. Each device holds shares of the root key. Visible only inside the authority namespace. |
AccountId | Uuid | Legacy identifier being replaced by AuthorityId. Exists for backward compatibility. |
2. Context Identifiers
| Identifier | Type | Purpose |
|---|---|---|
ContextId | Uuid | Relational context or derived subcontext. Opaque on the wire, appears only inside encrypted envelopes and receipts. Never encodes participant lists or roles. Flow budgets and leakage metrics scope to (ContextId, peer) pairs. |
SessionId | Uuid | Choreographic protocol execution instance. Pairs a ContextId with a nonce. Not long-lived. Expires when protocol completes or times out. |
DkdContextId | { app_label: String, fingerprint: [u8; 32] } | Deterministic Key Derivation context. Combines application label with fingerprint to scope derived keys across application boundaries. |
3. Communication Identifiers
| Identifier | Type | Purpose |
|---|---|---|
ChannelId | Hash32 | AMP messaging substream scoped under a relational context. Opaque. Does not reveal membership or topology. |
MessageId | Uuid | Individual message within a channel. Scoped under a ChannelId. |
RelayId | [u8; 32] | Pairwise communication context derived from X25519 keys. Foundation for RID message contexts. |
GroupId | [u8; 32] | Threshold group communication context derived from group membership. Foundation for GID message contexts. |
MessageContext | enum { Relay, Group, DkdContext } | Unifies the three privacy context types. Enforces mutual exclusivity. Cross-partition routing requires explicit bridge operations. |
ConnectionId | Uuid | Network connection identifier with privacy-preserving properties. Does not encode endpoint information. |
4. Content Identifiers
| Identifier | Type | Purpose |
|---|---|---|
ContentId | { hash: Hash32, size: Option<u64> } | Hash of canonical content bytes (files, documents, encrypted payloads, CRDT state). Any party can verify integrity by hashing and comparing. |
ChunkId | { hash: Hash32, sequence: Option<u32> } | Storage-layer chunk identifier. Multiple chunks may comprise a single ContentId. Enables content-addressable storage with deduplication. |
Hash32 | [u8; 32] | Raw 32-byte BLAKE3 cryptographic hash. Foundation for all content addressing. Provides collision and preimage resistance. |
DataId | String | Stored data chunk identifier with type prefixes (data:uuid, encrypted:uuid). Enables heterogeneous storage addressing. |
5. Journal Identifiers
| Identifier | Type | Purpose |
|---|---|---|
FactId | [u8; 32] | Content-addressed fact identifier derived from fact hash. Enables deduplication and integrity verification. |
FactTypeId | String | Registered fact type discriminator. Each domain crate declares its own type IDs for schema-aware encoding and reduction. |
FactOpId | [u8; 32] | Attested operation identifier within the journal. |
EventId | Uuid | Event identifier within the effect API system. Used in audit logs and debugging. |
OperationId | Uuid | Operation tracking identifier. |
6. Consensus Identifiers
| Identifier | Type | Purpose |
|---|---|---|
ConsensusId | Hash32 | Consensus instance identifier derived from prestate hash, operation hash, and nonce. Binds operations to prestates through hash commitment. See Consensus. |
FrostParticipantId | NonZeroU16 | Threshold signing participant. Must be non-zero for FROST protocol compatibility. Scoped to signing sessions. |
7. Social Topology Identifiers
| Identifier | Type | Purpose |
|---|---|---|
HomeId | Hash32 | Home in the social topology. Each user resides in exactly one home. See Social Architecture. |
NeighborhoodId | Hash32 | Neighborhood (collection of homes with 1-hop link relationships). Enables governance and traversal policies. |
8. Tree Identifiers
| Identifier | Type | Purpose |
|---|---|---|
LeafId | u32 | Authority-internal leaf node in the commitment tree. Stable across tree modifications and epoch rotations. Used for internal topology, proofs, and key-rotation bookkeeping. See Authority and Identity. |
ProposalId | Hash32 | Snapshot proposal identifier. Enables proposal deduplication and verification during tree operations. |
9. Ceremony and Recovery Identifiers
| Identifier | Type | Purpose |
|---|---|---|
CeremonyId | String | Guardian ceremony identifier for key-rotation and enrollment flows. |
RecoveryId | String | Recovery ceremony identifier for guardian-based recovery flows. |
InvitationId | String | Invitation identifier for relationship and enrollment invites. |
10. Membership Identifiers
| Identifier | Type | Purpose |
|---|---|---|
MemberId | String | Member identifier within groups or organizational structures. |
IndividualId | String | Individual person or entity within the identity system. Can be derived from a DeviceId or DKD context. |
RelationshipId | [u8; 32] | Identifies a specific relationship between two authorities. |
11. Accountability Structures
Receipt
Receipt is the accountability record emitted by FlowGuard. It contains context, source authority, destination authority, epoch, cost, nonce, chained hash, and signature. Receipts prove that upstream participants charged their budget before forwarding. No receipt includes device identifiers or user handles.
Fields: ctx: ContextId, src: AuthorityId, dst: AuthorityId, epoch: Epoch, cost: FlowCost, nonce: FlowNonce, prev: Hash32, sig: ReceiptSig.
See Transport and Information Flow for receipt propagation.
12. Derived Keys
Aura derives per-context cryptographic keys from reduced account state and ContextId. Derived keys never surface on the wire. They only exist inside effect handlers to encrypt payloads, generate commitment tree secrets, or run DKD.
The derivation inputs never include device identifiers. Derived keys inherit the privacy guarantees of AuthorityId and ContextId. The derivation function uses derive(account_root, app_id, context_label) and is deterministic but irreversible.
See Also
Authority and Identity describes the authority model in detail. Relational Contexts covers cross-authority relationships. Transport and Information Flow documents receipt chains and flow budgets. Social Architecture defines homes and neighborhoods.
Authority and Identity
This document describes the architecture of authorities and identity in Aura. It defines the authority model, account state machine, commitment tree structure, and relational identity model. Identity emerges through shared contexts rather than as a global property of keys.
1. Authority Model
An authority is a cryptographic actor represented by a public key. An authority hides its internal structure. An authority may contain one or more devices. An authority is the smallest unit that can sign facts or capabilities.
An authority has an internal journal namespace. The journal namespace stores facts relevant to that authority. The authority derives its state from deterministic reduction of that fact set.
Devices are not exclusive to a single authority. A single device may hold threshold shares for multiple authorities at the same time. Joining a new authority adds signing capability for that authority without removing any existing authority memberships.
1.1 Authority Types and Membership Terms
Aura uses three authority types:
User: individual authorityHome: group authority that acceptsUserauthorities as membersNeighborhood: group authority that acceptsHomeauthorities as members
Home membership terminology is:
Member: authority in the home's threshold authority setParticipant: authority granted access to the home without threshold membershipModerator: optional designation granted to a member for moderation operations
AuthorityId (see Identifiers and Boundaries) selects the journal namespace associated with the authority. The identifier does not encode structure or membership. The authority publishes its current public key and root commitment inside its own journal.
Authorities can interact with other authorities through Relational Contexts. These interactions do not change the authority's internal structure. The authority remains isolated except where relational state is explicitly shared.
2. Account Authorities
An account authority is an authority with long term state. An account maintains device membership through its commitment tree. An account contains its own journal namespace. An account evolves through attested operations stored as facts.
The commitment tree defines device membership and threshold policies. The journal stores facts that represent signed tree operations. The reduction function reconstructs the canonical tree state from the accumulated fact set.
An account authority exposes a single public key derived from the commitment tree root. The authority never exposes device structure. The account state changes only when an attested operation appears in the journal.
Aura supports multiple key generation methods for account authorities. K1 uses single-signer local key generation. K2 uses dealer-based DKG with a trusted coordinator. K3 uses quorum/BFT DKG with consensus-finalized transcripts. These are orthogonal to agreement modes (A1 provisional, A2 coordinator soft-safe, A3 consensus-finalized). Durable shared authority state must be finalized via A3.
#![allow(unused)] fn main() { pub trait Authority: Send + Sync { fn authority_id(&self) -> AuthorityId; fn public_key(&self) -> Ed25519VerifyingKey; fn root_commitment(&self) -> Hash32; async fn sign_operation(&self, operation: &[u8]) -> Result<Signature>; fn get_threshold(&self) -> u16; fn active_device_count(&self) -> usize; } }
The Authority trait provides the external interface for authority operations. The trait exposes only the public key, root commitment, and signing capabilities. The internal device structure remains hidden from external consumers.
An account authority derives context specific keys using deterministic key derivation. These derived authorities represent application scoped identities. See Effects and Handlers Guide for implementation examples.
3. Account State Machine
The TreeState structure represents the materialized state of an account at a specific epoch.
#![allow(unused)] fn main() { pub struct TreeState { pub epoch: Epoch, pub root_commitment: TreeHash32, pub branches: BTreeMap<NodeIndex, BranchNode>, pub leaves: BTreeMap<LeafId, LeafNode>, leaf_commitments: BTreeMap<LeafId, TreeHash32>, tree_topology: TreeTopology, branch_signing_keys: BTreeMap<NodeIndex, BranchSigningKey>, } }
The epoch field is monotonically increasing. The root_commitment is the hash of the entire tree structure. The branches map stores branch nodes by index. The leaves map stores leaf nodes by ID.
The leaf_commitments map caches leaf commitment hashes. The tree_topology tracks parent-child relationships. The branch_signing_keys map stores FROST group public keys for verification.
For the authority-internal reducer implementation (AuthorityTreeState), topology is explicitly materialized as ordered binary edges with parent pointers. Active leaves are canonically sorted by LeafId, paired in stable order, and assigned deterministic branch indices (NodeIndex(0) root, then breadth-first). This allows path-local commitment recomputation for non-structural updates while preserving deterministic replay semantics.
TreeState is derived state and is never stored directly in the journal. It is computed on-demand from the OpLog via the reduction function.
#![allow(unused)] fn main() { pub struct TreeStateSummary { epoch: Epoch, commitment: Hash32, threshold: u16, device_count: u32, } }
The TreeStateSummary provides a public view with only epoch, commitment, threshold, and device count. This summary hides internal device structure for external consumers while the full TreeState is used for internal operations.
4. Commitment Tree Structure
A commitment tree contains branch nodes and leaf nodes. A leaf node represents a device or guardian inside the account. A branch node represents a subpolicy with threshold requirements. The root node defines the account-level threshold policy.
Node Kinds
#![allow(unused)] fn main() { pub enum NodeKind { Leaf(LeafNode), Branch, } }
This type defines leaf and branch variants. The Leaf variant contains a LeafNode with device information. The Branch variant is a marker indicating an internal node.
Leaf and Branch Nodes
#![allow(unused)] fn main() { pub struct LeafNode { pub leaf_id: LeafId, pub device_id: DeviceId, pub role: LeafRole, pub public_key: LeafPublicKey, pub meta: LeafMetadata, } pub enum LeafRole { Device, Guardian, } }
The LeafNode structure stores device information required for threshold signing. The leaf_id is a stable identifier across tree modifications. The device_id identifies the device within the authority. The role distinguishes devices from guardians.
#![allow(unused)] fn main() { pub struct BranchNode { pub node: NodeIndex, pub policy: Policy, pub commitment: TreeHash32, } }
The BranchNode structure stores policy data for internal nodes. The node field is the branch index. The policy defines the threshold requirement. The commitment is the cryptographic hash of the branch structure.
#![allow(unused)] fn main() { pub struct BranchSigningKey { pub group_public_key: [u8; 32], pub key_epoch: Epoch, } }
A BranchSigningKey stores the FROST group public key for threshold signing at a branch node. The key_epoch tracks when the key was established via DKG. Signing keys are updated when membership changes under the branch or when policy changes affect the signing group.
5. Tree Topology
The TreeTopology structure tracks parent-child relationships for efficient navigation.
#![allow(unused)] fn main() { pub struct TreeTopology { parent_pointers: BTreeMap<NodeIndex, NodeIndex>, children_pointers: BTreeMap<NodeIndex, BTreeSet<NodeIndex>>, leaf_parents: BTreeMap<LeafId, NodeIndex>, root_node: Option<NodeIndex>, } }
The parent_pointers map links nodes to their parents. The children_pointers map links parents to their children. The leaf_parents map links leaves to their parent branches. The root_node tracks the root of the tree.
This structure enables efficient path-to-root traversal and affected node computation during commitment updates.
graph TD
R["Root Commitment<br/>(policy)"]
L1["Branch<br/>(threshold)"]
L2["Branch<br/>(threshold)"]
A["Leaf A<br/>(device)"]
B["Leaf B<br/>(device)"]
C["Leaf C<br/>(guardian)"]
D["Leaf D<br/>(device)"]
R --> L1
R --> L2
L1 --> A
L1 --> B
L2 --> C
L2 --> D
Each node commitment is computed over its ordered children plus its policy metadata. The root commitment is used in key derivation and verification. Leaves represent device shares. Branches represent threshold policies.
6. Policies
A branch node contains a threshold policy. A policy describes the number of required signatures for authorization.
#![allow(unused)] fn main() { pub enum Policy { Any, Threshold { m: u16, n: u16 }, All, } }
The Any policy accepts one signature from any device under that branch. The Threshold policy requires m signatures out of n devices. The All policy requires all devices under the branch.
Policies form a meet semilattice where the meet operation selects the stricter of two policies.
#![allow(unused)] fn main() { impl Policy { pub fn required_signers(&self, child_count: usize) -> Result<u16, PolicyError> { match self { Policy::Any => Ok(1), Policy::All => Ok(child_count as u16), Policy::Threshold { m, n } => { if child_count as u16 != *n { return Err(PolicyError::ChildCountMismatch { expected: *n, actual: child_count as u16 }); } Ok(*m) } } } } }
The required_signers method derives the concrete threshold from the policy given the current child count. It returns an error if the child count does not match the policy's expected total. This is used during signature verification to determine how many signers must have participated.
7. Tree Operations
Tree operations modify the commitment tree. Each operation references a parent epoch and parent commitment. Each operation is signed through threshold signing.
#![allow(unused)] fn main() { pub enum TreeOpKind { AddLeaf { leaf: LeafNode, under: NodeIndex }, RemoveLeaf { leaf: LeafId, reason: u8 }, ChangePolicy { node: NodeIndex, new_policy: Policy }, RotateEpoch { affected: Vec<NodeIndex> }, } }
The AddLeaf operation inserts a new leaf under a branch. The RemoveLeaf operation removes an existing leaf with a reason code. The ChangePolicy operation updates the policy of a branch. The RotateEpoch operation increments the epoch for affected nodes and invalidates derived context keys.
#![allow(unused)] fn main() { pub struct TreeOp { pub parent_epoch: Epoch, pub parent_commitment: TreeHash32, pub op: TreeOpKind, pub version: u16, } }
The TreeOp structure binds an operation to its parent state. The parent_epoch and parent_commitment prevent replay attacks. The version field enables protocol upgrades.
#![allow(unused)] fn main() { pub struct AttestedOp { pub op: TreeOp, pub agg_sig: Vec<u8>, pub signer_count: u16, } }
The agg_sig field stores the FROST aggregate signature. The signer_count records how many devices contributed. The signature validates under the parent root commitment. Devices refuse to sign if the local tree state does not match.
8. Tree Operation Verification
Tree operations use a two-phase verification model that separates cryptographic verification from state consistency checking.
8.1 Cryptographic Verification
The verify_attested_op function performs cryptographic signature checking only.
#![allow(unused)] fn main() { pub fn verify_attested_op( attested: &AttestedOp, signing_key: &BranchSigningKey, threshold: u16, current_epoch: Epoch, ) -> Result<(), VerificationError>; }
Verification checks that the signer count meets the threshold requirement. It computes the binding message including the group public key. It verifies the FROST aggregate signature. Verification is self-contained and can be performed offline.
8.2 State Consistency Check
The check_attested_op function performs full verification plus TreeState consistency.
#![allow(unused)] fn main() { pub fn check_attested_op<S: TreeStateView>( state: &S, attested: &AttestedOp, target_node: NodeIndex, ) -> Result<(), CheckError>; }
Check verifies the operation cryptographically. It ensures the signing key exists for the target node. It validates that the operation epoch and parent commitment match state.
An imported operation is admissible only when its parent-epoch verifying key and threshold policy have authenticated provenance independent of the operation being imported. A device with no local parent key must first receive an authenticated enrollment baseline and its verifier chain. Import validates each operation against the previous reduced state and rejects the complete uncommitted batch if any signature, parent binding, or transition is invalid. Duplicate operations may be treated idempotently; peer-supplied keys cannot establish the trust anchor.
8.3 TreeStateView Trait
#![allow(unused)] fn main() { pub trait TreeStateView { fn get_signing_key(&self, node: NodeIndex) -> Option<&BranchSigningKey>; fn get_policy(&self, node: NodeIndex) -> Option<&Policy>; fn child_count(&self, node: NodeIndex) -> usize; fn current_epoch(&self) -> Epoch; fn current_commitment(&self) -> TreeHash32; } }
This trait abstracts over TreeState for verification. It enables verification without a direct dependency on the journal crate.
8.4 Binding Message Security
#![allow(unused)] fn main() { pub fn compute_binding_message( attested: &AttestedOp, current_epoch: Epoch, group_public_key: &[u8; 32], ) -> Vec<u8>; }
The binding message contains a domain separator, parent epoch and commitment for replay prevention, protocol version, current epoch, group public key, and serialized operation content. Including the group public key ensures signatures are bound to a specific signing group.
8.5 Error Types
Verification produces two error categories. VerificationError covers cryptographic issues: missing signing keys, insufficient signers, signature failures, epoch mismatches, and parent commitment mismatches. CheckError covers state consistency issues: verification failures, key epoch mismatches, and missing nodes or policies.
9. Reduction and Conflict Resolution
The account journal is a join semilattice. It stores AttestedOp facts. All replicas merge fact sets using set union. The commitment tree state is recovered using deterministic reduction.
Reduction applies the following rules. Group operations by parent state using ParentKey (epoch + commitment tuple). Select a single winner using a deterministic ordering based on operation hash. Discard superseded operations. Apply winners in parent epoch order.
Conflicts arise when multiple operations reference the same parent epoch and commitment. The reduction algorithm resolves conflicts using a total order on operations. The winning operation applies. Losing operations are ignored.
The reduction algorithm builds a DAG from operations, performs topological sort with tie-breaking, and applies operations sequentially to build the final TreeState.
Conflict resolution uses operation hash as the tie-breaker. When multiple operations share the same parent, they are sorted by hash and the maximum hash wins. This ensures deterministic winner selection across all replicas.
graph TD
OpLog["OpLog<br/>(CRDT OR-set of AttestedOp)"]
Verify["verify_attested_op()"]
Check["check_attested_op()"]
Reduce["reduce()"]
TreeState["TreeState<br/>(derived on-demand)"]
OpLog -->|cryptographic| Verify
Verify -->|state consistency| Check
Check -->|valid ops| Reduce
Reduce -->|derives| TreeState
This diagram shows the data flow from OpLog to TreeState. Operations are verified cryptographically first. Then they are checked for state consistency. Valid operations are reduced to produce the materialized TreeState.
10. Epochs and Derived Keys
The epoch is an integer stored in the tree state that scopes deterministic key derivation. Derived keys depend on the current epoch. Rotation invalidates previous derived keys. The RotateEpoch operation updates the epoch for selected subtrees.
Epochs also scope flow budgets and context presence tickets. All context identities must refresh when the epoch changes.
Derived context keys bind relationship data to the account state. The deterministic key derivation function uses the commitment tree root commitment and epoch. This ensures that all devices compute the same context keys. Derived keys do not modify the tree state.
11. Operators and Devices
An operator controls an authority by operating its devices. An operator is not represented in the protocol. Devices are internal to the authority and hold share material required for signing.
Devices produce partial signatures during threshold signing. The operator coordinates these partial signatures to produce the final signature.
The commitment tree manages device membership. The AddLeaf and RemoveLeaf operations modify device presence in the authority. Device identifiers do not appear outside the authority. No external party can link devices to authorities.
When a device is enrolled or replaced, Aura performs session delegation alongside tree updates. Runtime delegation transfers active protocol session ownership to the receiving device authority and records a SessionDelegation fact for auditability. The commitment tree update (AddLeaf/RemoveLeaf) remains the source of truth for membership, while delegation preserves in-flight protocol continuity during migration.
12. Relational Identity Model
Aura defines identity as contextual and relational. Identity exists only inside a specific relationship and does not exist globally. Authorities represent cryptographic actors rather than people. Identity emerges when two authorities form a shared context.
A shared context exists inside a relational context. A relational context stores relational facts that define how two authorities relate. Profile data may appear in a relational context if both authorities choose to share it. This profile data is scoped to that context.
ContextId (see Identifiers and Boundaries) identifies a relational context. It does not encode membership. It does not reveal which authorities participate. The context stores only the relational facts required by the participants.
Identity inside a context may include nickname suggestions or other profile attributes. These values are private to that context. See Identifiers and Boundaries for context isolation mechanisms. Nicknames (local mappings) allow a device to associate multiple authorities with a single local contact.
13. Authority Relationships
Authorities interact through relational contexts to create shared state. Relational contexts do not modify authority structure. Each relational context has its own journal. Facts in the relational context reference commitments of participating authorities.
Authorities may form long lived or ephemeral relationships. These relationships do not affect global identity. The authority model ensures that each relationship remains isolated.
graph TD
A[Authority A] --> C(Context)
B[Authority B] --> C(Context)
This diagram shows two authorities interacting through a relational context. The context holds the relational facts that define the relationship. Neither authority exposes its internal structure to the other.
14. Privacy and Isolation
Authorities reveal no internal structure and contexts do not reveal participants. Identity exists only where authorities choose to share information. Nicknames remain local to devices. There is no global identifier for people or devices.
Every relationship is private to its participants. Each relationship forms its own identity layer. Authorities can operate in many contexts without linking those contexts together.
15. Interaction with Consensus
Consensus is used when a tree operation must have strong agreement across a committee. Consensus produces a commit fact containing a threshold signature. This fact becomes an attested operation in the journal.
Consensus is used when multiple devices must agree on the same prestate. Simple device-initiated changes may use local threshold signing. The account journal treats both cases identically.
Consensus references the root commitment and epoch of the account. This binds the commit fact to the current state.
16. Security Properties
The commitment tree provides fork resistance. Devices refuse to sign under mismatched parent commitments. The reduction function ensures that all replicas converge. Structural opacity hides device membership from external parties.
The threshold signature scheme prevents unauthorized updates. All operations must be signed by the required number of devices. An attacker cannot forge signatures or bypass policies.
The tree design ensures that no external party can identify device structure. The only visible values are the epoch and the root commitment.
17. Implementation Architecture
17.1 Critical Invariants
The implementation enforces these rules.
- TreeState is never stored in the journal. It is always derived on-demand via reduction.
- OpLog is the only persisted tree data. All tree state can be recovered from the operation log.
- Reduction is deterministic across all replicas. The same OpLog always produces the same TreeState.
- DeviceId is authority-internal only. It is never exposed in public APIs.
17.2 Data Flow
graph TD
A["Tree Operation Initiated"]
B["TreeOperationProcessor validates"]
C["Convert to AttestedOp fact"]
D["Journal stores fact"]
E["verify_attested_op (crypto)"]
F["check_attested_op (state)"]
G["reduce processes valid facts"]
H["apply_operation builds TreeState"]
I["TreeState materialized"]
A --> B
B --> C
C --> D
D --> E
E --> F
F --> G
G --> H
H --> I
This diagram shows the complete lifecycle of a tree operation from initiation to materialization.
17.3 Key Module Locations
Implementation files are in aura-journal/src/commitment_tree/.
state.rs: TreeState structure and TreeStateView implementationreduction.rs: Deterministic reduction algorithmoperations.rs: TreeOperationProcessor and TreeStateQueryapplication.rs: Operation application to TreeStatecompaction.rs: Garbage collection of superseded operationsattested_ops.rs: AttestedOp fact handling
Verification code is in aura-core/src/tree/verification.rs. Type definitions are in aura-core/src/tree/types.rs and aura-core/src/tree/policy.rs.
See Also
- Journal System for fact semantics and reduction flows
- Relational Contexts for cross-authority relationship management
- Consensus for threshold signing and agreement
- Identifiers and Boundaries for context isolation mechanisms
- Cryptographic Architecture for FROST and signing modes
- Effects and Handlers Guide for practical implementation patterns
- Privacy and Information Flow for privacy guarantees
Enrollment roster decision custody
Device enrollment key generation is authorized by a held authenticated current-tree decision and the independently granted invitee setup. The physical issuer is a current Device member, the new device is not yet a member, and active signing epoch/configuration agree with the verified tree. The complete ordered signing roster and prestate are derived within generation-before-tree custody and retained through original issuer registration. Raw identifiers, participant vectors, observed tree state, and missing-current-device repair do not authorize rotation. A historical allocation can authorize negative secret retirement without conferring current live enrollment authority.
Bootstrap participant consistency
A new physical single-device authority bootstrap represents its sole signer as that actual Device participant and commits a matching signed Device genesis leaf. Authority identifiers and guardian participants do not substitute for physical membership. Historical guardian-labeled bootstrap configuration requires independently verified original genesis/device/key evidence before migration can confer physical signer representation; successful historical signing alone is insufficient enrollment authority.
Original enrollment reservation evidence
An enrollment reservation retains the original invitation identifier, subject, physical issuer device and creation time before signing generation allocation. The original immutable reservation is operation identity and clock evidence, not an enrollment authorization. Recovery eligibility requires the retained independent setup grant, original allocated window and generation, and authenticated current membership. Recovery cannot replace the original creation time or deadline with a later observation.
Enrollment setup validity attenuation
An issued enrollment manifest is bounded by its selected, independently
verified setup grant. Its expiry must be strictly after that grant's issuance
and no later than its expiry. Shortening validity is allowed; extending it is a
typed SetupValidity rejection before signing. This bound complements the
original registered execution interval and cannot renew that interval on retry
or recovery.
Effect System
Overview
Aura uses algebraic effects to abstract system capabilities. Effect traits define abstract interfaces for cryptography, storage, networking, time, and randomness. Handlers implement these traits with concrete behavior. Context propagation ensures consistent execution across async boundaries.
This document covers effect trait design, handler patterns, and the context model. See Runtime for lifecycle management, service composition, and guard chain execution. See Ownership Model for the repo-wide Pure/MoveOwned/ActorOwned/Observed taxonomy.
The aura-agent runtime uses structured concurrency with explicit session ownership. Session-bound effects execute only under the current owner via canonical ingress. For complete details on async ownership, session ownership, typed runtime errors, and instrumentation policy, see crates/aura-agent/ARCHITECTURE.md.
The runtime contract is intentionally split:
- actor services supervise long-lived runtime structure
- move semantics govern session and endpoint ownership
Effect execution that touches session state belongs to the second category, not the first.
Typed Error Sources
Effect failures converted into AuraError retain their original concrete cause
as the immediate standard std::error::Error::source. Cloning the error preserves
that cause and its nested source chain. Shared storage of a cause does not add a
wrapper node to the chain. Source objects are process-local: serialization keeps
the error category and message and intentionally omits the source chain.
Native app/runtime boundaries preserve the same source contract. A
RuntimeBridgeError carries a structural failure category and the actual
underlying error; diagnostic wording cannot determine an idempotent success,
retry, authorization result, or protocol confirmation. Foreign callback
payloads explicitly omit process-local sources. Their diagnostic representation
does not constitute native failure provenance and cannot reconstruct it.
Ownership At Effect Boundaries
Effect traits sit at an ownership boundary and should preserve the repo-wide ownership model rather than hide it.
- Effect trait definitions in
aura-coreare primarilyPure. - Long-lived mutable async ownership belongs to
ActorOwnedruntime services, not to effect trait definitions or ad hoc handler-local state. - Exclusive authority transfer belongs to
MoveOwnedhandles, owner tokens, or transfer records rather than shared mutable rewrites. - Effect handlers may implement capabilities, but parity-critical mutation and publication should remain capability-gated in the exposed API shape.
Practical implications:
- define trait methods so callers can preserve typed ownership and typed failure
- do not use effect handlers as a loophole for bypassing authority checks
- do not let observation-facing layers gain semantic mutation power through convenience helpers
- ensure long-running effect-driven flows report typed terminal outcomes rather than implicit success or silent hangs
- prefer the canonical
aura-coreownership vocabulary at effect-facing boundaries:OperationContextfor move-owned workflow ownership- exact progress/terminal publication wrappers plus consumed
TerminalPublisherfor lifecycle OwnedTaskSpawner,OwnedShutdownToken, andBoundedActorIngressfor actor-owned task and ingress boundaries
Effect Traits
Aura defines effect traits as abstract interfaces for system capabilities. Core traits expose essential functionality. Extended traits expose optional operations and coordinated behaviors. Each trait is independent and does not assume global state.
Core traits include CryptoCoreEffects, NetworkCoreEffects, StorageCoreEffects, time domain traits, RandomCoreEffects, and JournalEffects. Extended traits include CryptoExtendedEffects, NetworkExtendedEffects, StorageExtendedEffects, RandomExtendedEffects, and system-level traits such as SystemEffects and ChoreographicEffects.
#![allow(unused)] fn main() { #[async_trait] pub trait CryptoCoreEffects: RandomCoreEffects + Send + Sync { async fn ed25519_sign( &self, message: &[u8], private_key: &[u8], ) -> Result<Vec<u8>, CryptoError>; async fn ed25519_verify( &self, message: &[u8], signature: &[u8], public_key: &[u8], ) -> Result<bool, CryptoError>; async fn kdf_derive( &self, ikm: &[u8], salt: &[u8], info: &[u8], output_len: u32, ) -> Result<Vec<u8>, CryptoError>; } }
This example shows a core effect trait for cryptographic operations. Traits contain async methods for compatibility with async runtimes. Extension traits add optional capabilities without forcing all handlers to implement them. The hash() function is intentionally pure in aura-core::hash rather than an effect because it is deterministic and side-effect-free.
Time Traits
The legacy monolithic TimeEffects trait is replaced by domain-specific traits. PhysicalTimeEffects returns wall-clock time with uncertainty and provides sleep operations. LogicalClockEffects advances and reads causal vector clocks and Lamport scalars. OrderClockEffects produces opaque total order tokens without temporal meaning.
Callers select the domain appropriate to their semantics. Guards and transport use physical time. CRDT operations use logical clocks. Privacy-preserving ordering uses order tokens.
Cross-domain comparisons are explicit via TimeStamp::compare(policy). Total ordering across domains must use OrderTime or consensus sequencing. Direct SystemTime::now() or chrono usage is forbidden outside effect implementations.
Time Domain System
The unified TimeStamp type provides five domains for different use cases.
| Domain | Effect Trait | Primary Use |
|---|---|---|
PhysicalClock | PhysicalTimeEffects | Wall time, cooldowns, receipts, liveness |
LogicalClock | LogicalClockEffects | Causal ordering, CRDT merge, happens-before |
OrderClock | OrderClockEffects | Deterministic ordering without timing leakage |
Range | PhysicalTimeEffects + policy | Validity windows with bounded skew |
ProvenancedTime | TimeComparison | Attested timestamps for consensus |
Application code accesses time exclusively through effect traits. Direct SystemTime::now() calls are forbidden outside effect implementations. Cross-domain comparisons require explicit TimeStamp::compare(policy). OrderClock must not leak timing information.
Timeout And Backoff Contract
Timeout and backoff behavior is part of the ownership model. Each parity-critical async path must identify a deadline owner, retry policy owner, and terminal consequence. See Effects and Handlers Guide for timeout patterns and Ownership Model for timeout ownership rules.
Threshold Signing
Aura provides a unified ThresholdSigningEffects trait in aura-core/src/effects/threshold.rs for all threshold signing scenarios. The trait supports multi-device personal signing, guardian recovery approvals, and group operation approvals.
The trait uses a unified SigningContext that pairs a SignableOperation with an ApprovalContext. This design allows the same FROST signing machinery to handle all scenarios with proper audit context. The ThresholdSigningService in aura-agent provides the production implementation.
Key components include ThresholdSigningEffects for async signing operations, lifecycle traits for provisional and consensus modes, and AppCore.sign_tree_op() for high-level signing. See Cryptography for detailed threshold signature architecture.
When to Create Effect Traits
New effect traits are warranted when multiple crates need the same async capability and the operation involves OS integration or external state. Convenience wrappers belong in composite extension traits rather than new base traits. See Effects and Handlers Guide for trait design guidance.
Database Effects
Database operations use existing StorageEffects, JournalEffects, and AuthorizationEffects rather than a dedicated DatabaseEffects trait. See Database Architecture for query patterns.
Handler Design
Handlers are stateless per-request processors. They do not store global state. The handler taxonomy includes stateless infrastructure handlers, application handlers, typed composite handlers, and type-erased composite handlers. See Effects and Handlers Guide for implementation patterns.
Unified Encrypted Storage
Aura uses StorageEffects as the single persistence interface in application code. The production runtime wires StorageEffects through a unified encryption-at-rest wrapper. FilesystemStorageHandler provides raw bytes persistence. RealSecureStorageHandler uses Keychain or TPM for master-key persistence.
EncryptedStorage implements StorageEffects by encrypting and decrypting transparently. It generates or loads the master key on first use. Runtime assembly remains synchronous.
#![allow(unused)] fn main() { use aura_effects::{ EncryptedStorage, EncryptedStorageConfig, FilesystemStorageHandler, RealCryptoHandler, RealSecureStorageHandler, }; use std::sync::Arc; let secure = Arc::new(RealSecureStorageHandler::with_base_path(base_path.clone())); let storage = EncryptedStorage::new( FilesystemStorageHandler::from_path(base_path.clone()), Arc::new(RealCryptoHandler::new()), secure, EncryptedStorageConfig::default(), ); }
This example shows the encryption wrapper assembly. RealCryptoHandler lives in aura-effects and implements CryptoCoreEffects. Storage configuration controls encryption enablement and opaque naming. Application code uses StorageEffects without knowledge of encryption details.
Context Model
The effect system propagates an EffectContext through async tasks. The context carries authority identity, context scope, session identification, execution mode, and metadata. No ambient state exists.
#![allow(unused)] fn main() { pub struct EffectContext { authority_id: AuthorityId, context_id: ContextId, session_id: SessionId, execution_mode: ExecutionMode, metadata: HashMap<String, String>, } }
This structure defines the operation-scoped effect context. The context flows through all effect calls and identifies which authority, context, and session the operation belongs to. The execution_mode controls handler selection for production versus test environments.
Context propagation uses scoped execution. A task local stores the current context. Nested tasks inherit the context. This ensures consistent behavior across async boundaries.
ReactiveEffects Trait
The ReactiveEffects trait provides type-safe signal-based state management. Signals are phantom-typed identifiers that reference reactive state. The phantom type ensures compile-time type safety.
#![allow(unused)] fn main() { pub struct Signal<T> { id: SignalId, _phantom: PhantomData<T>, } #[async_trait] pub trait ReactiveEffects: Send + Sync { async fn read<T>(&self, signal: &Signal<T>) -> Result<T, ReactiveError> where T: Clone + Send + Sync + 'static; async fn emit<T>(&self, signal: &Signal<T>, value: T) -> Result<(), ReactiveError> where T: Clone + Send + Sync + 'static; fn subscribe<T>(&self, signal: &Signal<T>) -> Result<SignalStream<T>, ReactiveError> where T: Clone + Send + Sync + 'static; async fn register<T>(&self, signal: &Signal<T>, initial: T) -> Result<(), ReactiveError> where T: Clone + Send + Sync + 'static; async fn ensure_registered<T>(&self, signal: &Signal<T>, initial: T) -> Result<(), ReactiveError> where T: Clone + Send + Sync + 'static; } }
The read method returns the current value. The emit method updates the value. The subscribe method returns a stream of changes. The register method creates a new signal and rejects a duplicate ID. ensure_registered creates a missing signal while preserving the value and subscriptions of a matching existing signal; a different value type under the same ID is an error. See Runtime for reactive scheduling implementation. Subscribing an unregistered signal fails fast. Aura does not permit "dead stream" subscription success for missing registrations.
QueryEffects Trait
The QueryEffects trait provides typed Datalog queries with capability-based authorization. Queries implement the Query trait which defines typed access to journal facts.
#![allow(unused)] fn main() { pub trait Query: Send + Sync + Clone + 'static { type Result: Clone + Send + Sync + Default + 'static; fn to_datalog(&self) -> DatalogProgram; fn required_capabilities(&self) -> Vec<QueryCapability>; fn dependencies(&self) -> Vec<FactPredicate>; fn parse(bindings: DatalogBindings) -> Result<Self::Result, QueryParseError>; fn query_id(&self) -> String; } #[async_trait] pub trait QueryEffects: Send + Sync { async fn query<Q: Query>(&self, query: &Q) -> Result<Q::Result, QueryError>; async fn query_raw(&self, program: &DatalogProgram) -> Result<DatalogBindings, QueryError>; fn subscribe<Q: Query>(&self, query: &Q) -> QuerySubscription<Q::Result>; async fn check_capabilities(&self, caps: &[QueryCapability]) -> Result<(), QueryError>; async fn invalidate(&self, predicate: &FactPredicate); } }
The Query trait converts queries to Datalog programs and defines capability requirements. The QueryEffects trait executes queries and manages subscriptions. Query isolation levels control consistency requirements. See Database Architecture for complete query system documentation.
A query-bound signal is active only after its initial query and signal emission succeed. Failed binding leaves no partial query subscription; retry keeps any existing signal value and subscribers and installs the binding once the query succeeds.
Determinism Rules
Effect boundaries determine native and WASM conformance parity. Protocol code must follow these rules to ensure deterministic execution.
The pure transition core requires identical outputs given the same input stream. No hidden state may affect observable behavior. All state must flow through explicit effect calls. Non-determinism is permitted only through explicit algebraic effects. Time comes from time traits. Randomness comes from RandomEffects. Storage comes from StorageEffects.
Conformance lanes compare logical steps rather than wall-clock timing. Time-dependent behavior uses simulated time through effect handlers. Conformance artifacts use canonical encoding with deterministic field ordering. See Testing Guide for conformance testing patterns.
Session-Local VM Bridge Effects
Production choreography execution uses a narrow synchronous bridge trait at the Aura and Telltale boundary. VmBridgeEffects in aura-core exposes only immediate session-local queue and snapshot operations. It does not expose async transport, storage, or journal methods.
This split exists because Telltale host callbacks are synchronous. The callback path may enqueue outbound payloads, record blocked receive edges, consume branch choices, and snapshot scheduler signals. It must not perform network I/O or journal work directly.
Async host work resumes outside the VM step boundary in Layer 6 runtime services. vm_host_bridge observes VmBridgeEffects state, performs transport and guard-chain work, and injects completed results back into the VM. This preserves deterministic VM progression while keeping Aura's runtime async.
aura-agent runtime code preserves this boundary through canonical ingress and explicit session ownership. Network callbacks, timers, and background tasks route typed session-ingress messages to the current local owner. Each active session has exactly one owner at any time.
That owner may be hosted by an actor, but the effect-routing rule is still ownership-based: session-bound effects execute because the caller is the current owner, not merely because it runs inside a service actor.
The runtime must also distinguish owner identity from owner capability:
- owner identity identifies the current fragment/session owner
- owner capability authorizes specific session-bound effects within fragment scope
Both checks matter for effect routing, especially across delegation boundaries.
See System Internals Guide for VM bridge implementation patterns and crates/aura-agent/ARCHITECTURE.md for the complete ownership model.
Layer Placement
The effect system spans several crates with strict dependency boundaries. aura-core defines effect traits, identifiers, and core data structures. It contains no implementations.
aura-effects contains stateless and single-party effect handlers. It provides default implementations for cryptography, storage, networking, and randomness. aura-protocol contains orchestrated and multi-party behavior. It bridges session types to effect calls.
aura-agent assembles handlers into runnable systems. It configures effect pipelines for production environments. aura-simulator provides deterministic execution with simulated time, networking, and controlled failure injection.
Performance
Aura includes several performance optimizations. Parallel initialization reduces startup time. Caching handlers reduce repeated computation. Buffer pools reduce memory allocation. The effect system avoids OS threads for WASM compatibility.
#![allow(unused)] fn main() { let builder = EffectSystemBuilder::new() .with_handler(Arc::new(RealCryptoHandler)) .with_parallel_init(); }
This snippet shows parallel initialization of handlers. The builder pattern allows flexible handler composition. Lazy initialization creates handlers on first use. Async tasks and cooperative scheduling provide efficient execution.
Testing Support
The effect system supports deterministic testing through mock handlers. A simulated runtime provides control over time and network behavior. The simulator exposes primitives to inject delays or failures.
#![allow(unused)] fn main() { let system = TestRuntime::new() .with_mock_crypto() .with_deterministic_time() .build(); }
This snippet creates a test runtime with mock handlers for all effects. It provides deterministic time and network control. Tests use in-memory storage and mock networking to execute protocols without side effects. See Test Infrastructure Reference for test patterns.
Local timeout failure identity
Local budget failures distinguish policy rejection, clock unavailability, deadline expiry, and attempt exhaustion. A required clock failure remains observable through the standard error source chain and cannot be treated as deadline evidence. Native clock causes are omitted from serialized diagnostic errors. The local timeout result retains operation failures as distinct typed causes.
Storage profile exclusivity and immutable publication
Profile storage ownership is a move-owned infrastructure lease covering one physical profile lifetime. It does not authorize domain actions. Cooperative persistent writers require the same profile owner; unsupported exclusivity is a typed failure. Resource release on cancellation or process death permits a new owner, whose durable recovery still requires authenticated domain evidence.
Immutable secure publication has two outcomes: Created acknowledges complete encrypted and durable publication; AlreadyExists identifies an existing record without proving equality or trust. Publication does not replace existing bytes. A failure after publication can leave a complete record, so recovery validates the original stored record rather than assuming rollback. Backends without these transactional guarantees report unsupported semantics explicitly. Multi-record profile handoff requires a separately owned durable transaction and recovery contract; a runtime mutex or several atomic file replacements do not establish that contract.
The selected production provider's private concrete lease, rather than an arbitrary core trait implementation, establishes physical profile ownership. Persistent writer clones retain that resource owner. Browser ownership is scoped to the actual origin and storage namespace through Web Locks; immutable records require strict-durability IndexedDB transaction completion. Historical plaintext secret namespaces cannot authorize fresh signing-state creation. Shared platform credential namespaces need their own supported ownership contract; filesystem-profile ownership does not substitute for it.
Local timeout observation contract
A local timeout owner preserves its original deadline and the greatest required physical-clock observation across awaited operations, timer completion, retries, and child deadlines. Physical-clock rollback terminates that owner as a required service failure; it does not extend its allowance or imply deadline expiration. Observation contention is an ownership failure. Successful timer completion latches exhaustion. Persisted timeout state must include and validate the original window, observation, rollback, and exhaustion state; missing state cannot reconstruct an active allowance.
Window coordinate separation
Physical timeout intervals and receipt-generation intervals share checked half-open arithmetic with distinct sealed coordinate types. A coordinate cannot cross domains. A valid interval alone grants no observation, admission or persistence authority. Physical execution windows have positive millisecond extent and a fixed representable deadline; empty generation allowances admit no receipts. Restored owner state must preserve its original bound interval and observation history.
Required enhanced-time scheduling propagates actual provider query and sleep failures. A failed timer does not constitute deadline expiration or successful wake-up. Native source traversal retains the concrete time-effect error through runtime scheduling and effect-system forwarding.
VM bridge delivery custody
Synchronous VM callbacks enqueue frames; asynchronous transport delivery requires
an exclusive VmBridgeSendLease. Queue snapshots are observations and do not
remove frames. The lease retains the oldest frame through the awaited send and
removes it only after acknowledgment. Concurrent enqueue preserves FIFO order,
and a second delivery owner fails explicitly. Providers without this contract
reject owned delivery instead of emulating it by draining a queue.
Dropping an in-flight lease retains the frame with an unknown delivery outcome. Unknown delivery blocks automatic replay; it requires protocol reconciliation or terminal session teardown. A native definitely-unsent result may release the frame for an owned retry. Display text cannot establish that result. These states are local delivery custody, not peer consensus or durable receipt proof.
Required choreography clock and timeout effects preserve their native source
through ChoreographyError::RequiredTime. Failed clock reads do not provide
timestamps or expiry evidence. Session cleanup remains required when its clock
observation fails; the runtime retains both primary and secondary typed failures.
Secure storage distinguishes atomic initial publication of mutable owner state
(secure_create_mutable) from lifetime-immutable evidence
(secure_store_immutable). Both preserve an existing record and acknowledge a
new publication; an interrupted call requires rereading the actual original.
Atomic creation alone does not authorize later mutation or generation renewal.
Providers without the atomic-create contract return a typed unsupported failure.
Secure publication classes
Secure storage distinguishes atomic initial mutable publication from lifetime immutable publication. Both preserve an existing original. Mutable records permit subsequent updates under their domain owner. Immutable records carry authenticated provider protection in the same atomic publication and reject generic replacement, deletion, and key-generation writes. Legacy sealing preserves the exact original bytes. A capability list or caller-supplied retirement label cannot override lifetime protection. Unsupported providers fail with a typed error. Interrupted writes have an uncertain publication outcome; successful retries validate and acknowledge the original record. Ordinary storage has no authority over the secure provider's physical subtree.
An enrollment mailbox record may acquire a retirement birth only in its first immutable publication. The birth must be authorized by the original approved issuer registration under its independently retained baseline and setup proof, and bound to the actual selected profile provider, exact record location and bytes, and the registration's signed expiry. A later registration, raw signed bytes, self-certified signer package, or caller-selected expiry cannot amend an existing immutable record. Issuer credential and setup records published before the registration is signed require separate original birth authority; the registration cannot retroactively authorize their deletion.
Required secure retrieval reports an absent record through a typed logical
absence cause with the exact requested location. This differs from a provider
I/O failure, whose concrete native cause remains intact. Observational existence
checks may report false; required absence cannot authorize replacement keys,
default signing policy or a weaker record selection.
The crypto extended effect exposes individual participant-key proof signing separately from authority threshold signing. A handler that lacks this primitive returns a typed unsupported cause; it cannot fabricate a proof or substitute a group signature. The stateless handler signs the supplied actual package, while the runtime owner supplies current-device/epoch/ceremony authorization.
Required runtime construction adapters preserve native initialization causes in both production and testing/simulation presets. Returning-profile authorization failure cannot be converted into a flat runtime diagnostic or treated as fresh credential absence. Serialized presentation remains separate from the native source chain used to diagnose the failing provider or verification boundary.
Fixed window attenuation and restore
A physical timeout window may be narrowed to an earlier authenticated deadline while preserving its original start and clock observation owner. Attenuation does not observe a synthetic timestamp, allocate a new allowance, or modify the original interval. A child retains its own sticky exhaustion; parent and child share high-water and rollback evidence. Restoring a child requires the exact attenuated bounds and matching acknowledged clock history. It must preserve exhaustion and cannot enlarge either deadline.
These pure continuity checks do not establish checkpoint provenance or runtime admission. The domain owner must authenticate the policy, retain actual custody, and acknowledge the original and attenuated snapshots through its required checkpoint path. Generation/epoch windows do not authorize physical expiry.
Selected-provider allocation custody
Allocation references are observations, not authority. A selected physical profile owner transfers opaque whole-inventory custody before runtime sharing. Provider transitions dispatch through the retained original backend and preserve actual storage, codec and cryptographic failures. Recovery may complete an acknowledged pre-live birth using its original retained evidence. Missing once-live allocation or checkpoint evidence fails closed. Unsupported selected providers fail structurally; provider substitution does not repair custody.
Selected provider migration contract
A legacy selected profile may adopt allocation lifetime custody only through its original exclusive physical provider owner and original retained decryption material. Required bounded inventory authentication precedes immutable root birth acknowledgment. Existing permanent secret policy and ciphertext are preserved. The independently acknowledged completed-handoff evidence prevents missing live checkpoint data from being treated as a new or unmigrated profile. Recovery retains original allocation identity and first-decision history; a serialized locator grants no recovery authority.
A provider acknowledgment confirms its transactional persistence contract. It does not attest physical media erasure, external backup deletion, or absence of a complete rollback of all local evidence.
Selected provider continuity
An explicitly configured effect provider remains the source of its required operations after shared runtime ownership transfer. Shared crypto handles preserve extended operations as well as core operations; shared ownership cannot substitute optional defaults for the selected implementation. Required provider faults retain their original cause across persistence, journal and network adapter boundaries. Such faults do not authorize implicit selection of a default provider. Ordinary storage customization preserves encrypted storage and the independent selected secure profile's lifetime custody.
Required invitation transcript encoding and Guardian cryptographic calls retain process-local native error sources. A verified invalid signature is a boolean rejection; codec failure or selected cryptographic provider failure is a typed error and cannot be converted into absence or a successful response. Native sources are local diagnostic evidence, not serialized protocol authority.
Newly composed diagnostics and retained causes
A diagnostic category and message contain no causal provenance or mutation authority. Attaching a native failure to a new diagnostic preserves the original concrete standard error and its existing source chain. Existing cause-bearing errors and terminal outcomes are not converted to source-free diagnostics or overwritten by a later cause. Cloning a cause-bearing error preserves its original native source identity.
Deterministic entropy admission
A production assembly rejects an explicit deterministic entropy seed before acquiring profile custody or invoking configured providers. Simulated cryptographic handlers and deterministic random streams require a private seed capability admitted from the actual nonproduction execution mode. Selecting a custom cryptographic handler does not bypass this admission decision.
Absolute physical deadline observations
PhysicalTimeEffects::wait_until_physical_deadline accepts a
WindowPosition<PhysicalMillis> for an existing fixed endpoint. Its successful
result is an actual selected-provider observation at or beyond that endpoint.
It neither allocates a new window nor proves domain completion. Registration
must not depend on an awaited caller clock read or a caller's cached timestamp.
The selected provider owns timer cancellation and preserves native clock/timer
failures. A provider lacking this contract returns AbsoluteDeadlineUnsupported;
it cannot silently substitute a relative sleep. Native error sources are
process-local and are omitted from serialized diagnostics.
Terminal resource acknowledgment requires the original observation lease, required current time, window validation and checkpoint to complete within the same absolute endpoint. Expiry or provider failure cannot publish success. A fixed-endpoint witness can latch expiry without a second awaited clock read. Domain owners retain responsibility for the actual manager/task/disposal proof.
Runtime
Overview
The Aura runtime assembles effect handlers into working systems. It manages lifecycle, executes the guard chain, schedules reactive updates, and exposes services through AuraAgent. The AppCore provides a unified interface for all frontends.
This document covers runtime composition and execution. See Effect System for trait definitions and handler design. See Ownership Model for the repo-wide ownership taxonomy. The aura-agent crate-level runtime contract, including structured concurrency, canonical ingress, ownership, typed errors, and CI policy gates, lives in crates/aura-agent/ARCHITECTURE.md.
That contract is intentionally opinionated about the split of responsibilities:
- actor services own long-lived runtime supervision, lifecycle, and maintenance
- move semantics own session and endpoint ownership transfer
Those are related concerns, but they are not the same abstraction boundary.
For shared semantic operations, the split is stricter still:
aura-app::workflowsowns authoritative semantic lifecycle publicationaura-agentowns long-lived runtime actors and readiness/state coordination- frontend crates and the harness submit through sanctioned handoff boundaries and observe authoritative publication afterward
No runtime, frontend, or harness path should keep a parallel terminal publication helper once the shared workflow owner has taken over.
The same visibility rule applies to runtime-owned mutation helpers. Raw VM admission helpers, fragment ownership registry mutation, and the mutable reconfiguration controller stay inside aura-agent runtime internals. Shared consumers go through sanctioned ingress, session-owner, or manager surfaces.
Enrollment setup export belongs to the signing runtime owner. Device identity, key epoch, mode, policy and package are one coherent snapshot; frontend or harness identity staging cannot substitute for this snapshot. The runtime verifies and retains the signed request before returning its code. Export failures preserve typed time, readiness, admission, proof and storage causes across the app's runtime bridge. Signing recovery preserves prior verifier identity and fails closed on incomplete persisted material, as specified in Cryptography.
Signing-material preparation, activation, recovery and rollback have one serialized lifecycle owner. Activation validates the prospective context and local membership before persisting the active epoch and exposing the context. An active or historical epoch cannot be rolled back as a failed pending rotation. Existing pending material cannot be silently replaced by a second preparation for the same epoch.
Bootstrap publishes its signing context only after genesis completion. Its pending/complete record is independent of the active key epoch, so persisted keys cannot turn a failed tree commit into readiness on retry. A cached tree operation without its persisted operation and index entry is insufficient completion evidence. Legacy migration requires an existing authenticated creation witness; restoration cannot silently recreate a missing lineage.
Adaptive Privacy Runtime Ownership
Adaptive privacy policy is runtime-owned local state, not shared truth.
- the
Neighborhood PlaneandWeb of Trust Planeprovide permit and candidate inputs - rendezvous descriptor views provide service-surface advertisement inputs
SelectionManagerServicefuses those inputs with local health and budget signals into runtime-localLocalSelectionProfileandSelectionStateLocalHealthObserverServiceowns smoothing, hysteresis, and local health snapshotsMoveManagerowns bounded movement queues, replay windows, flush scheduling, congestion state, and the current routing profile used forMoveEnvelopedeliveryHoldManagerowns held-object custody, selector rotation, bounded holder residency, local Hold GC, verified witness handling, and neighborhood-scoped provider scoringAnonymousPathManagerowns reusable anonymous established-path lifecycle and protected encrypted establish-session stateCoverTrafficGeneratorServiceowns cover-floor planning and reserved cover budget
This split is strict:
- final route, holder, and path reuse decisions are runtime-local
- those decisions must not be published as authoritative facts or descriptor fields
- retrieval, cover, accountability replies, and ordinary movement share one
MoveEnvelopefamily where applicable rather than regaining separate transport families
The production adaptive policy is fixed by deployment rather than user configuration. The current fixed policy uses path-diversity floor 2, cover floor 2 packets per second, delay gain denominator 3, neighborhood hold retention window 120s, and retrieval-capability rotation beginning 10s before expiry. Development and simulation may tune those values, but production nodes do not expose per-user privacy knobs.
LocalRoutingProfile::passthrough() remains the pre-privacy baseline. It uses mixing depth 0, delay 0, cover rate 0, and path diversity 1. Hold remains active under passthrough because custody and selector retrieval are availability services rather than privacy-profile parameters.
Transparent Onion Quarantine
transparent_onion is a debug, test, and simulation tool only.
- it may expose transparent anonymous setup and envelope headers for inspection
- the production runtime path is encrypted; transparent objects exist only on the explicit debug/simulation feature surface
- it must remain excluded from parity-critical harness and shared-flow lanes
- production policy ownership does not change when the feature is enabled
- the feature must not become an implicit dependency of browser, TUI, or conformance behavior
Ownership Categories In The Runtime
The runtime is the main place where Aura's ownership categories become concrete:
- long-lived runtime services, supervisors, readiness coordinators, and caches
are
ActorOwned - session, endpoint, and delegation transfer surfaces are
MoveOwned - runtime views, projections, and exported state are
Observed - reducers, validators, and typed contracts remain
Pure
Two runtime rules follow from that split:
- Actor mailboxes are for mutation of actor-owned state, not as a substitute for move-style ownership transfer.
- Runtime-facing lifecycle and readiness publication should be capability-gated and should terminate explicitly with typed success, failure, or cancellation.
- Long-lived mutable async domains should be declared through
#[aura_macros::actor_owned(...)], and small parity-critical runtime lifecycle enums should prefer#[aura_macros::ownership_lifecycle(...)]over hand-written transition helpers.
Instrumentation Contract
All long-lived runtime services emit structured events from the following families: runtime startup/shutdown, service lifecycle transition, task spawn/completion/failure/abort, session claim/release/failure, ingress accepted/rejected/dropped, delegation start/commit/rollback/reject, link boundary route/reject, concurrency profile select/fallback, and invariant violation.
Required fields include service, task, session_id, fragment_key, owner, from_owner, to_owner, profile, error_kind, and correlation_id where applicable. These families ensure that runtime behavior is reconstructible from structured logs. Envelope admission, delegation witnesses, and fallback decisions must all be visible in instrumentation output.
Structured Concurrency
aura-agent uses structured concurrency as the only production async model.
Rules:
- Every long-lived async subsystem has one named owner.
- Every owner has one rooted task group.
- Child tasks belong to exactly one task group.
- Detached fire-and-forget tasks are forbidden in production runtime code.
- Shutdown is hierarchical and parent-driven.
Runtime shutdown ordering remains an orchestration-level invariant, not a compile-time type property. Aura keeps a targeted integration check for the final shutdown sequence in aura-agent::runtime::system:
- stop the reactive pipeline
- cancel the runtime task tree
- tear down services
- shut down the lifecycle manager
That check is governance for the final runtime owner graph, not a replacement for the compile-time ownership model.
See System Internals Guide for implementation patterns and preferred primitives.
Lifecycle Management
aura-agent uses an explicit service lifecycle contract with authoritative service states, structured task ownership, and deterministic teardown. The crate-level runtime contract in crates/aura-agent/ARCHITECTURE.md is the source of truth.
All long-lived services implement a shared lifecycle state machine:
new: Initial state before startup.starting: Initialization in progress.Running: Actor alive and command path available.stopping: Graceful shutdown in progress.Stopped: No live owned tasks and no live command handling.Failed: Observable failure state.
Long-lived runtimes periodically prune caches and stale in-memory state through owned service actors and supervised task groups. Domain crates expose cleanup APIs but do not self-schedule. The agent runtime owns the scheduling model.
Required periodic work terminates with typed success, failure, or cancellation. A timer or callback failure remains a failed task with its concrete source and must be observable through owning service health and drain. An invalid interval policy fails before invoking domain work. Intentional callback completion is distinct from a failed callback. Supervisor clock failures are distinct from observed drain deadline expiry.
Task-group supervision covers descendants even after callers drop their group handles. Shutdown closes admission across the owned subtree before waiting; late submissions cannot schedule work. Forced abort requests cancellation but does not establish drain. Task registrations remain active until the owned future and its resources have actually dropped. Descendant failures propagate to ancestor health and retain their original cause. Group depth, live groups and active tasks have explicit admission bounds; dead group entries are pruned.
See System Internals Guide for service lifecycle implementation.
Runtime Timeout Policy
A choreography receive owns its local deadline for the lifetime of that receive future. Inbox notifications cannot renew it, and dropping the future leaves no registered timer resource. Required clock and sleep observations determine expiry through the shared typed timeout budget. A zero configured receive timeout remains immediate when no matching message is already queued.
Choreography session admission requires a successful physical clock read before installing session state or task bindings. A failed read is a typed required-time failure with its original source; zero is not substitute clock evidence. Session retirement removes owned session resources even if its required clock read fails. The clock failure remains primary, and any retirement failure is retained as a separate typed cause. Duration metrics are updated only when the required observation exists. Receive-timeout issuance and waiting preserve native time-effect causes through the choreography error boundary.
Runtime timeout behavior must preserve Aura's time-system contract:
- physical time drives local waiting, retry, and backoff policy
- logical, order, and provenanced time remain semantic ordering tools
- runtime owners publish typed timeout failure when local waiting is exhausted
- required clock and backoff failures retain their actual cause and remain distinct from deadline expiry; an unavailable clock cannot fabricate an observed deadline or authorize timeout retry
- pending invitation lookup errors remain required failures even when observed pending or accepted history exists; history recovery requires a typed readiness exhaustion outcome, and clock or policy failures cannot select it
- runtime-to-app deadline errors retain the typed deadline cause through the standard error source chain; semantic observers classify deadlines from that cause rather than matching display text
- harness and simulation may scale timeout policy, but they should not invent a different semantic model
In practice this means:
- long-lived owners should consume a remaining timeout budget across nested stages instead of resetting fresh wall-clock literals at each call site
- enrollment retries and child VM attempts remain bounded by the ceremony's original deadline; restoration does not grant a new acceptance window
- retry loops should use shared backoff policy rather than duplicated sleeps
- timeout policy belongs to owner/coordinator code, not UI observation layers
- reducing timeout duration in tests or harness mode is acceptable. Changing what timeout means is not.
- runtime-facing workflow/task boundaries should carry
OperationTimeoutBudget,OwnedShutdownToken, andOwnedTaskSpawnerrather than rawDuration, raw cancellation traits, or ad hoc spawn helpers - parity-critical runtime waits should consume strong typed authoritative references once context is known. They must not re-derive ownership or context from weaker ids inside later readiness/wait helpers.
Runtime Authority Discipline
Runtime-owned coordinators follow the same authority rule as app workflows:
- resolve authoritative typed input once at the boundary
- carry that typed input through later parity-critical readiness, retry, and terminal steps
- do not re-resolve context from raw ids after authoritative handoff
- do not keep fallback/default repair helpers on parity-critical paths
If a later step needs context, the API should require the strong typed reference rather than accepting a raw identifier and looking it up again.
Guard Chain Execution
The runtime enforces guard chain sequencing defined in Authorization. Each projected choreography message expands to three phases. First, snapshot preparation gathers capability frontier, budget headroom, and metadata. Second, pure guard evaluation runs synchronously over the snapshot. Third, command interpretation executes the resulting effect commands.
flowchart LR
A[Snapshot prep] -->|async| B[Guard eval]
B -->|sync| C[Interpreter]
C -->|async| D[Transport]
This diagram shows the guard execution flow. Snapshot preparation is async. Guard evaluation is pure and synchronous. Command interpretation is async and performs actual I/O.
GuardSnapshot
The runtime prepares a GuardSnapshot immediately before entering the guard chain. It contains every stable datum a guard may inspect while remaining read-only.
#![allow(unused)] fn main() { pub struct GuardSnapshot { pub now: TimeStamp, pub caps: Cap, pub budgets: FlowBudgetView, pub metadata: MetadataView, pub rng_seed: [u8; 32], } }
Guards evaluate synchronously against this snapshot and the incoming request. They cannot mutate state or perform I/O. This keeps guard evaluation deterministic, replayable, and WASM-compatible.
EffectCommands
Guards do not execute side effects directly. Instead, they return EffectCommand items for the interpreter to run. Each command is a minimal description of work.
#![allow(unused)] fn main() { pub enum EffectCommand { ChargeBudget { context: ContextId, authority: AuthorityId, peer: AuthorityId, amount: FlowCost, }, AppendJournal { entry: JournalEntry }, RecordLeakage { bits: u32 }, StoreMetadata { key: String, value: String }, SendEnvelope { to: NetworkAddress, peer_id: Option<uuid::Uuid>, envelope: Vec<u8> }, GenerateNonce { bytes: usize }, } }
Commands describe what happened rather than how. Interpreters can batch, cache, or reorder commands as long as the semantics remain intact. This vocabulary keeps the guard interface simple.
EffectInterpreter
The EffectInterpreter trait encapsulates async execution of commands. Production runtimes hook it to aura-effects handlers. The simulator hooks deterministic interpreters that record events instead of hitting the network.
#![allow(unused)] fn main() { #[async_trait] pub trait EffectInterpreter: Send + Sync { async fn execute(&self, cmd: EffectCommand) -> Result<EffectResult>; fn interpreter_type(&self) -> &'static str; } }
ProductionEffectInterpreter performs real I/O for storage, transport, and journal. SimulationEffectInterpreter records deterministic events and consumes simulated time. This design lets the guard chain enforce authorization, flow budgets, and journal coupling without leaking implementation details.
Reactive Scheduling
The ReactiveScheduler in aura-agent processes journal facts and drives UI signal updates. It receives facts from multiple sources including journal commits, network receipts, and timers. It batches them in a 5ms window and drives all signal updates.
Intent → Fact Commit → FactPredicate → Query Invalidation → Signal Emit → UI Update
This flow shows how facts propagate to UI. Services emit facts rather than directly mutating view state. The scheduler processes fact batches and updates registered signal views. This eliminates dual-write bugs where different signal sources could desync.
Signal Views
Domain signals are driven by signal views in the reactive scheduler. ChatSignalView, ContactsSignalView, and InvitationsSignalView process facts and emit full state snapshots to their respective signals.
The six observed entity projections (chat, contacts, homes, invitations, recovery, and neighborhood) have one typed publication path through aura-app::ProjectionOwner. A synchronous delta updates the current graph value atomically and returns the committed value with a source revision. A full replacement derived from an earlier snapshot must compare that revision before publication; stale replacements do not emit. Failed deltas leave the graph value unchanged. AppCore copies a projection into ViewState only when its source revision is newer than the last copy, so a delayed refresh cannot regress the render snapshot.
App-owned navigation transitions that pair a homes selection with a neighborhood position share a gate with the homes mirror. The mirror revalidates the homes source revision after reconciliation and retries when a runtime publication arrives during the transition. The gate serializes local paired transitions; runtime publications remain graph-owned and are reconciled at the next mirror pass.
#![allow(unused)] fn main() { // Define application signals pub static CHAT_SIGNAL: LazyLock<Signal<ChatState>> = LazyLock::new(|| Signal::new("app:chat")); // Bind signal to query at initialization pub async fn register_app_signals_with_queries<R: ReactiveEffects>( handler: &R, ) -> Result<(), ReactiveError> { handler.register_query(&*CHAT_SIGNAL, ChatQuery::default()).await?; Ok(()) } }
This example shows signal definition and query binding. Signals are defined as static lazy values. They are bound to queries during initialization. When facts change, queries invalidate and signals update automatically.
Fact Processing
The scheduler integrates with the effect system through fact sinks. Facts flow from journal commits through the scheduler to signal views.
#![allow(unused)] fn main() { // In RuntimeSystem (aura-agent) effect_system.attach_fact_sink(pipeline.fact_sender()); // The scheduler processes fact batches and updates signal views. }
Terminal screens subscribe and automatically receive updates. This enables push-based UI updates without polling.
UnifiedHandler
The UnifiedHandler composes Query and Reactive effects into a single cohesive handler. It holds a QueryHandler, a shared ReactiveHandler, and an optional capability context.
The commit_fact method adds a fact and invalidates affected queries. The query method checks capabilities and executes the query. BoundSignal<Q> pairs a signal with its source query for registration and invalidation tracking.
Service Pattern
The runtime uses a three-tier service architecture. Domain crates define stateless handlers that produce pure GuardOutcome plans without performing I/O. The agent layer wraps these handlers with services that gather snapshots, run guard evaluation, and interpret effect commands. The agent exposes services through typed accessor methods on AuraAgent, with a ServiceRegistry holding Arc references initialized at startup.
See System Internals Guide for the handler/service/API implementation pattern.
Session Management
The runtime manages the lifecycle of distributed protocols. Choreographies define protocol logic. Sessions represent single stateful executions of choreographies. The runtime uses structured concurrency with explicit session ownership.
Session Ownership
Each active session or fragment has exactly one current local owner. The owner is either a per-session actor or an authoritative choreography runtime loop. This invariant is enforced through the canonical ingress pattern.
This is the move-semantics side of the runtime model:
- one current owner
- explicit transfer
- stale-owner rejection
- owner-routed session effects
Owner identity and capability are separate:
- ownership says who currently controls the fragment
- capability says what fragment-scoped work that owner may perform
Network, timer, and external events are queued before touching session state. Session ownership and task ownership move together. Session-bound effects execute only under the current owner.
The owner may be implemented by an actor, but the transfer of ownership is still an explicit move boundary rather than shared actor state.
See Choreography Development Guide for session ownership implementation.
Ownership Transitions
Owner-visible state transitions:
Unowned -> ClaimedClaimed -> RunningRunning -> DelegatingOutDelegatingOut -> ReleasedRunning -> StoppingStopping -> StoppedAny -> Failed
No transition may create overlapping owners.
Session Interface
The SessionManagementEffects trait provides the abstract interface for all session operations. Application logic remains decoupled from the underlying implementation. Sessions can use in-memory or persistent state.
Session State
Concrete implementations act as the engine for the session system. Each session maintains:
SessionIdfor unique identification.SessionStatusindicating the current phase.Epochfor coordinating state changes.- Participant list.
Session creation and lifecycle are managed as choreographic protocols. The SessionLifecycleChoreography in aura-protocol ensures consistency across all participants.
Telltale Integration
Aura executes production choreography sessions through the Telltale protocol machine in Layer 6. Production startup is manifest-driven. Generated CompositionManifest metadata defines the protocol id, required capabilities, determinism profile reference, link constraints, and delegation constraints for each choreography. AuraChoreoEngine runs admitted protocol-machine sessions and exposes deterministic trace, replay, and envelope-validation APIs.
Aura is aligned with Telltale 10.0.0's public runtime model rather than a private compatibility surface. Runtime admission, canonical finalization, semantic handoff, and runtime-upgrade execution all use public protocol-machine concepts. Delegation witnesses now carry Telltale-native ownership receipts and post-upgrade reconfiguration snapshots rather than Aura-local transition wrappers. Fail-closed receipt and authority handling is explicit at Aura's runtime boundaries, and timeout expiry is modeled from issued timeout witnesses rather than from late elapsed-time inference. For the upstream capability/finalization/runtime-upgrade contract, read Telltale docs/38_capability_model.md.
Runtime ownership is fragment-scoped. One admitted protocol fragment has one local owner at a time. A choreography without link metadata is one fragment. A choreography with link metadata yields one fragment per linked bundle. Ownership claims, transfer, and release flow through AuraEffectSystem and ReconfigurationManager.
This is why the runtime uses both abstractions at once:
- actor services for host-side runtime structure
- explicit move-style ownership for fragment/session transfer
When delegation changes ownership, the runtime must also define whether the moved capability is transferred intact or attenuated to a narrower scope. That decision is part of the protocol/runtime contract, not a host-side convenience choice.
The synchronous callback boundary is VmBridgeEffects. AuraVmEffectHandler and AuraQueuedVmBridgeHandler use it for session-local payload queues, blocked receive snapshots, branch choices, and scheduler signals. Async transport, guard-chain execution, journal coupling, and storage remain outside protocol-machine callbacks in vm_host_bridge and service loops.
A received frame (BlockedVmReceive) is not Clone, and delivering it consumes it. The engine, not the caller, assigns each frame its inbound sequence: AuraChoreoEngine keeps one SequenceOwner per session edge, and that owner admits exactly the next sequence for each delivered frame. Replay-enforcing protocol profiles run Telltale in CommunicationReplayMode::Nullifier through the single seam protocol_replay_mode, so a duplicate frame faults as DuplicateIdentity. Fully deterministic profiles (which Telltale does not allow with nullifiers) enforce the engine-assigned per-edge sequence instead. Telltale 17 derives that nullifier with its built-in non-cryptographic model; Task 208 tracks a pluggable crypto-hash model.
Dynamic reconfiguration follows the same rule. Runtime code must go through ReconfigurationManager for link and delegation so bundle evidence, capability admission, and coherence checks are enforced before any transfer occurs.
Dynamic reconfiguration also carries typed upgrade artifacts end to end. When a delegation also performs a runtime upgrade, Aura persists the delegation fact, records the typed upgrade request/execution pair, and rejects missing source ownership or invalid upgrade evidence rather than repairing state implicitly.
Runtime Profiles
Telltale protocol-machine execution is configured through two profile axes:
AuraVmHardeningProfilecontrols safety posture:Dev(assertions + full trace),Ci(strict allow-lists + replay),Prod(safety checks with bounded overhead).AuraVmParityProfilecontrols deterministic cross-target lanes:NativeCooperative(native baseline) andWasmCooperative(WASM lane), both using cooperative scheduling and strict effect determinism.
Determinism and scheduler policy are protocol-driven. Admission resolves the protocol class, applies the configured determinism tier and replay mode, validates the selected runtime profile, and chooses scheduler controls. Production code should not mutate these settings directly after admission.
Mixed workloads are allowed. Cooperative and threaded fragments may coexist in the same runtime. The contract is per fragment.
See System Internals Guide for VM configuration patterns.
Boundary Review Checklist
Changes to VM/Aura boundaries require review against the checklist in System Internals Guide.
Concurrency Profiles and Envelope Admission
aura-agent recognizes three runtime concurrency profiles for choreography work:
- Canonical: Exact single-owner reference path. Telltale canonical execution at concurrency
n = 1is the reference behavior. - EnvelopeAdmitted: Disjoint or admitted work preserving safety-visible meaning. Higher concurrency is a refinement only when it stays inside the admitted envelope relation.
- Fallback: Immediate degradation to canonical execution when envelope admission fails.
Correctness never depends on uncontrolled host scheduling. If the runtime cannot show that a path is envelope-safe, it serializes execution.
Envelope Admission Contract
Operational envelope admission is a runtime gate, not a comment-level convention. The runtime must record and enforce:
- which determinism / concurrency profile was requested
- which evidence or certificate admitted the profile
- whether execution stayed canonical or entered an admitted refinement
- why fallback occurred when admission failed
Safety-visible observations must remain equivalent to the canonical reference. Every admitted step must have a declared witness path. Profile-side obligations must be checked before execution widens.
Link and Delegate Boundaries
Link Boundary
link is a static composition boundary. Linked bundles define ownership boundaries as well as composition boundaries. Linked protocols remain session-disjoint unless composition explicitly shares state. Cross-boundary effect routing is explicit. Ad hoc shared mutable state across linked boundaries is forbidden. link must preserve Telltale coherence and harmony obligations at runtime, not just compile-time compatibility.
A boundary object must carry enough information to answer:
- which bundle/fragment boundary this effect belongs to
- which owner capability scope is valid at that boundary
- whether a route crosses a boundary that requires explicit reconfiguration handling
Wrong-boundary routing is a runtime error and must be rejected before the VM observes the step.
Delegate Boundary
delegate is an ownership-transfer boundary. Endpoint/session ownership transfer is atomic. Capability/effect context transfers with the endpoint. Stale-owner access after delegation is forbidden. Ambiguous local ownership is rejected before the VM observes the transfer. Fragment ownership and session footprint state move with the transfer rather than lagging behind it.
Transfer and attenuation are separate concepts:
- transfer changes the authoritative owner
- attenuation narrows the capability scope that moves with the new owner
If the runtime cannot state which one is happening and under which protocol rule, it must reject the delegation path.
A successful delegation must move one owned bundle: session owner record, owner capability, protocol fragment ownership, runtime footprint / reconfiguration state, and delegation audit witness. If these do not move together, the transfer is incomplete and must be treated as a runtime error.
Theorem-pack / Invariant Alignment
The runtime must preserve coherence-sensitive session and edge state, harmony-sensitive reconfiguration steps, adequacy-relevant observable traces, determinism-profile obligations, and replay / communication identity stability across async ingress. Advanced runtime modes should be capability- and evidence-gated. Missing invariant evidence must cause rejection or fallback, never silent widening.
Fact Registry
The FactRegistry provides domain-specific fact type registration and reduction for reactive scheduling. It lives in aura-journal and is integrated via AuraEffectSystem::fact_registry(). Registered domains include Chat for message threading, Invitation for device invitations, Contact for relationship management, and Moderation for home and mute facts.
Reactive subscription policy is explicit:
- signal source revisions are distinct from frontend semantic and render revisions; exports observing the same graph compare source revisions directly, while independent LAN runtimes compare each export to its own
AppCoresource revision and require their entity sets to converge - application signal setup ensures every required signal individually; retry after partial setup preserves registered values and subscriptions
- query-bound signal setup registers the same required signal set; a failed query binding leaves no partial binding and a later retry can attach it without resetting the signal
- runtime refresh hooks attach one receiver per required signal and acknowledge every listener's startup before reporting readiness; failure rolls back the group and permits retry with a typed reactive failure
- chat and recovery have initial replay mirrors during hook installation; the runtime recovery projection also has an owned listener that copies later
RECOVERY_SIGNALrevisions into the app view, so exported snapshots converge after replay - each attached signal has one owned refresh loop: it receives an update, completes one refresh pass, then receives again; a second task cannot race that signal's refresh or clear its pending work
- detaching an
AppCoreruntime cancels its hook group before another generation attaches - subscribing to an unregistered signal fails fast with
ReactiveError::SignalNotFound - there is no implicit wait-for-registration or dead-stream fallback
- subscriber delivery is eventually consistent rather than lossless
- if a subscriber lags behind the bounded broadcast buffer, intermediate values may be dropped and the subscriber resumes from a newer snapshot after a lag warning is logged
- a refresh pass reads current authoritative state after its trigger; updates that arrive during the pass remain in the bounded stream, and the next receive runs another pass against current state even if intermediate snapshots were dropped
Production code obtains the registry via effect_system.fact_registry(). Tests may use build_fact_registry() for isolation. The registry assembly stays in Layer 6 rather than Layer 1.
See Effects and Handlers Guide for fact registration patterns.
Delivery Policy
The DeliveryPolicy trait enables domain crates to define custom acknowledgment retention and garbage collection behavior. This keeps policy decisions in the appropriate layer while the journal provides generic ack storage.
Domain crates implement the trait to control acknowledgment lifecycle. Key methods include min_retention and max_retention for time bounds, requires_ack to check tracking needs, and can_gc to determine GC eligibility.
#![allow(unused)] fn main() { let chat_policy = ChatDeliveryPolicy { min_retention: Duration::from_secs(30 * 24 * 60 * 60), max_retention: Duration::from_secs(90 * 24 * 60 * 60), }; effect_system.register_delivery_policy("chat", Arc::new(chat_policy)); }
This example shows domain-specific retention configuration. Chat messages retain acks for 30 to 90 days. Different domains can have vastly different retention needs. The maintenance system uses registered policies during GC passes.
AppCore
The AppCore in aura-app provides a unified portable interface for all frontend platforms. It is headless and runtime-agnostic. It can run without a runtime bridge for offline or demo modes. It can be wired to a concrete runtime via the RuntimeBridge trait.
Architecture
AppCore sits between frontends and a runtime bridge.
flowchart TB
subgraph Frontends
A[TUI]
B[CLI]
C[iOS]
D[Web]
end
A --> E[AppCore]
B --> E
C --> E
D --> E
E --> F[RuntimeBridge]
F --> G[AuraAgent]
This diagram shows the AppCore architecture. Frontends import UI-facing types from aura-app. They may additionally depend on a runtime crate to obtain a concrete RuntimeBridge. This keeps aura-app portable while allowing multiple runtime backends.
Construction Modes
AppCore supports two construction modes: demo/offline mode (no runtime bridge, for development and testing) and production mode (wired to a concrete RuntimeBridge for full effect system capabilities).
See Hello World Guide for AppCore usage.
Reactive Flow
All state changes flow through the reactive pipeline. Services emit facts rather than directly mutating view state. UI subscribes to signals using signal.for_each(). This preserves push semantics and avoids polling.
Local Intent ───┐
│
Service Result ─┼──► Fact ──► Journal ──► Reduce ──► ViewState
│ │
Remote Sync ────┘ ↓
Signal<T> ──► UI
This flow shows the push-based reactive model. Facts from any source flow through the journal. Reduction computes view state. Signals push updates to UI subscribers.
Runtime Access
When AppCore has a runtime, it provides access to runtime-backed operations through the RuntimeBridge trait. The runtime bridge exposes async capabilities while keeping aura-app decoupled from any specific runtime implementation. Frontends import app-facing types from aura-app and runtime types from aura-agent directly.
Enrollment restart and activation ownership
Enrollment recovery follows active signing-context restoration. Service startup alone does not establish signing readiness. An active enrollment retains its canonical invitation, original start time and deadline, participant inventory, prestate, setup binding, and exact pending signing-generation identity. Restoring those records does not establish acceptance. Original signed responses must be reverified against their retained setup verifier before an acceptance capability can be restored.
Activation owns one ceremony decision lease from its eligibility check through terminal settlement. Required durable preparation identifies the exact signed tree operation. Once irreversible preparation is retained, cancellation and timeout may not replace its owner; restart reconciles that exact operation and generation without adding a duplicate leaf. First terminal decisions are durably retained before becoming visible, and historical result observation grants no activation capability.
An enrollment allocation owns its reserved invitation identity before pending keys become visible. Completing registration establishes a process-local capability for launching the canonical initiator. Failed or unissued generation retirement retains the original decision, rejects already prepared activation, and releases the generation only after required key deletion succeeds. A historical retirement receipt permits observation of the original decision and never deletion of a later generation that reused its epoch.
Enrollment acceptance binds the original setup and the independently admitted signed trust manifest. Recovery selects the expected manifest and confirmation verifier from issuer-owned retention, revalidates the actual signed response at its original admission time, and does not deserialize an acceptance capability. Local serialization is not a guarantee of exclusive profile ownership between concurrent processes.
Durable enrollment time windows
Retirement after original enrollment cancellation requires the sealed original terminal decision, the same registered allocation and runtime, and the original authorized negative-cleanup window. Completed retirement writes remain in their original receipt destination before readiness is published, independently of later observation failure. This retention does not change signing authority or establish a full resource acknowledgment: that acknowledgment requires original-window validation and durable cleanup evidence.
Enrollment execution retains the original allocated local deadline and acknowledged clock history across retries and restart. A child allowance cannot replace its parent's durable window. Required clock observations and sticky failures are durably acknowledged before protocol progression or terminal result publication. Missing retained observation state is a required recovery failure. A reimport preserves its original admitted window. Historical completed evidence retains its immutable acknowledged window and cannot grant fresh protocol or signing authority.
An authentic rollback reported by the original selected provider's required timer irreversibly refuses positive execution under that budget. Returning the native timer failure preserves its concrete cause independently of the shared refusal history. Clones, child budgets and validated serialized recovery retain that history, including when snapshot access was contended; later forward time cannot renew the original allowance. Retaining local refusal does not establish durable acknowledgment or authorize a replacement cleanup window.
The original durable allocation birth records pending execution in the same bound clock record before handing out a usable root. Only the actual in-process birth acknowledgment transfers that nonserialized root custody. Initial provider time may establish the allocation deadline; no required observation of an existing window or potentially state-changing operation may precede the pending acknowledgment. Restart with pending state refuses positive execution; a previously usable budget cannot be restored across an unacknowledged observation. An uncertain, failed, or stalled allocation publication grants no usable root or semantic success. Nested children retain the same pending root and may persist its observation high-water mark, but cannot clear it.
Only the original move-owned root may settle pending execution. Positive settlement requires independent domain completion and actual disposal of its own sealed child subtree, followed by the original durable acknowledgment. The currently executing root task is outside that subtree. Task-group disposal is a repeatable observation, not root completion authority: cancelled, never-executed, failed, or incompletely cleaned-up children cannot establish positive completion. Dropping a bounded disposal observation retains the seal and pending root custody. Failure or endpoint exhaustion preserves refusal without allocating a new positive window or awaiting an unbounded post-expiry checkpoint.
Owned ceremony maintenance terminates with a typed failure when required clock, storage, or timer effects fail. Health projections may describe that outcome, while the runtime retains its original error source.
Native identity query failures
Required native identity and settings queries retain structural runtime failures and original IO/codec causes. Missing optional account configuration remains explicit absence; corruption cannot be interpreted as absence. Device inventory is derived from canonical device leaves, including a current device only when it is present there. Presentation contact counts and uninitialized threshold summaries do not prove runtime readiness.
Native failure projection
Native runtime error category survives workflow context wrapping. Required settings queries and mutations accept structural native errors at their workflow failure boundary; source-free diagnostic errors do not satisfy that contract. Foreign notification payloads preserve a stable native code at their terminal projection boundary. Crypto and serialization failures remain distinct from Internal; semantic failures classify them as failed commands rather than fabricated timeout or invalid argument evidence.
Native semantic failure codes
Native runtime crypto, serialization, storage, journal, and reactive failures have distinct semantic codes. Category-preserving workflow wrappers retain concrete error sources; foreign/shared operation snapshots retain the stable category code and operation domain. Generic crypto failure does not imply an authorization decision.
Shared window contracts and admission phases
Physical execution and receipt-generation allowance use domain-separated checked half-open interval arithmetic. Physical owners retain a fixed positive-millisecond deadline; flow owners retain authorized generation progression and current/previous epoch policy. Serialized interval bounds are arithmetic evidence only. They do not admit protocol execution or confer signing authority.
Enrollment allocation retains the original window before execution becomes live. An interrupted allocation can retain its missing initial clock only while neither immutable live-boundary evidence nor canonical registration evidence exists, and only from the exact secure original allocation. The immutable live-boundary marker precedes registry insertion. Once that boundary is retained, missing clock history is a required failure; recovery cannot reconstruct a duration or start from current time. A historical record can acquire missing live-boundary evidence only when its original secure allocation and clock both validate.
Checkpoint acknowledgment preserves exact allocation identity and the same shared clock and exhaustion owner. The durable maximum observation and sticky failures cannot regress. The registry retains allocation continuity through the required checkpoint write. Terminal decisions may advance for the same allocation; they do not authorize a renewed window, and historical completed evidence does not grant fresh execution.
Native account bootstrap failures
Account bootstrap never treats a failed configuration read as absent configuration. Required signing initialization propagates original native faults under its bounded operation window. Failure publication projects the native semantic category and returns the original error, preserving both failures if terminal publication itself fails. Account configuration and authority-record persistence remain separate writes and are not claimed as one transaction.
Selected-profile physical resource binding
An exclusively owned native filesystem profile binds its lifetime ownership to actual lock and directory resources. Every attached writer and clone retains that physical directory binding; changing process working directory or replacing a pathname cannot reauthorize a different directory. A filesystem secure provider admits its wrapping key only under the selected owner's physical directory and retains the original provider key. Invalid persisted key material fails closed without replacement.
Reads and mutations reject descendant directory aliases. Durable acknowledgment concerns the actual held data and directory resources. An interrupted or failed acknowledgment can leave an uncertain publication outcome and requires validation of the canonical record. These single-record guarantees do not imply atomicity across selected-profile metadata, enrollment handoff, admission receipts, and signing activation. That multi-record transition requires its own durable recovery owner.
Required timeout checkpoints preserve storage and codec causes in TimeoutBudgetError::CheckpointFailure. This failure does not represent clock unavailability or elapsed time. Native and semantic classification follows its retained cause; unclassified checkpoint faults remain internal. Serialized diagnostics omit native error sources and grant no checkpoint authority.
Required one-shot runtime work
Enrollment issuer cleanup retains the original accepted task control across cancelled or failed reconciliation. Once the exact cancelled generation is retired, any remaining resource reconciliation uses that same control and its original authorized negative-cleanup window. Actual reconciliation failure and final selected-provider validation remain independently required. Observing already completed resource disposal grants no positive domain completion or new execution authority.
Required owned tasks retain their concrete execution failure in supervisor health and drain. Terminal lifecycle settlement does not erase that failure. If terminal publication also fails, both causes remain available, with the original execution cause preserved in the standard error chain and the secondary publication cause retained as typed evidence.
Sync command service ownership requires source-preserving timer, shutdown-signal and runtime supervision outcomes. Every daemon run exit awaits service stop. Failed execution remains primary when stop also fails, with a separately retained typed cleanup cause. A failed timer or backward physical clock cannot publish a tick or successful shutdown. Native terminal diagnostics retain concrete sources; cloned source-bearing errors compare retained source identity rather than matching message text.
VM host send ownership
The runtime owns one exclusive pending-send lease per VM bridge flush. It marks a frame in flight immediately before the transport await, acknowledges only a successful send, and retains failed or unattempted frames in their original order. New callbacks enqueue behind retained frames. Cancellation or an ambiguous failure leaves an unknown delivery outcome and prevents automatic replay on that bridge. Configuration failure before delivery leaves frames pending. Native session-not-started and destination-unreachable failures occur before delivery and retain replay eligibility; retry still requires the protocol owner's original admitted time window and exact request contract.
Enrollment failure receipt ownership
An invitee publishes a failed enrollment readout only after verifying the issuer's pinned signed terminal control and acknowledging the original owned window checkpoint. The immutable failure receipt binds the exact manifest, invitation, ceremony, physical device, signed reason, and frozen acknowledged clock snapshot. Failure and confirmation receipts occupy distinct namespaces; contradictory receipts are rejected. Repeated reads revalidate the original admission and signed evidence without allocating another duration or issuing activation authority.
An issuer records rejection only from a verified refusal capability and under the same terminal decision gate as commitment and cancellation. The first persisted terminal decision is immutable. Closing the VM is required on both success and failure; a secondary close failure remains available structurally alongside the original execution error.
Parallel window observations
Parallel children of a physical timeout owner share observation ordering as well as the original high-water mark and expiry state. Each required physical read, its high-water update, and its durable acknowledgment form one owned sequence. A later query cannot overtake an earlier incomplete query and fabricate rollback from scheduling. Cancellation releases observation ownership; genuine backward clock movement remains a sticky failure and the original deadline is unchanged.
Required refresh failure ownership
Runtime-backed app refresh attachments retain their first source-bearing failure independently of instrumentation. Signal receipt, required refresh, and interval-provider failures have distinct typed stages, cancel the attachment, and fail runtime supervision. A failed attachment is not active readiness. Intentional attachment cancellation completes successfully. Reattachment cannot erase the enclosing runtime generation's retained supervision failure.
Bounded attempt teardown
Selecting a bounded-attempt timeout cancels the borrowed operation, while its owner retains the runtime resources needed for required teardown. The owner closes the actual VM before returning or retrying. Closing does not renew the operation window or authorize additional business work. A failed close remains a typed terminal task failure alongside the original execution cause.
Signed enrollment failure diagnostics
Native enrollment failures retain the verified terminal reason independently of flat foreign diagnostics and preserve the original typed standard error source. Rejected, cancelled, timed-out, choreography-failed, runtime-failed, and superseded outcomes have distinct semantic projections. A remote signed failure reason does not claim the original remote provider exception or grant retry, activation, membership, or adoption authority. Diagnostic text cannot reconstruct a reason or an authenticated terminal capability.
Live pending enrollment registration custody
An initial pending enrollment registration belongs to the still-held physical signing-generation reservation. Its bindings and participant policy must match that allocation, and it cannot inject accepted participants or a prior terminal decision. The registration must continue the immutable original allocation's start, deadline and budget observation history. Recovery uses independently revalidated original durable evidence rather than manufacturing a live reservation from stored identifiers.
Persistent enrollment allocation authorization
A held physical signing-generation reservation authorizes initial persistent enrollment allocation. Plain ceremony identifiers, policies or snapshots cannot substitute for that owner even when a reservation for the same generation exists. Generic guardian registration and nonpersistent state-model registration remain distinct from persistent enrollment admission. Verified recovery restores original evidence through its recovery owner and cannot reset the allocated lifetime through fresh generic registration.
Enrollment sender cancellation reads its required persisted sender record and
the exact retained issued manifest. Guard preparation precedes the terminal
CAS; local InvitationCancelled publication follows the actual durable
Failed(Cancelled) first decision. A different first terminal decision cannot
be changed, and a failed cancellation cannot publish a canceled invitation.
The resulting negative capability is bound to that invitation and ceremony;
it grants neither device membership nor profile activation. Cancellation
preserves the original deadline and acknowledged clock observations, including
sticky expiry and rollback. Required record, codec, guard, budget, and clock
failures retain their native cause and cannot be interpreted as absence.
Before negative resource acknowledgment, the durable clock checkpoint retains the latest history of the original positive interval, including rollback detected after its earlier checkpoint write. The live history must continue the retained interval, highwater and sticky refusal evidence. Negative cleanup retains its separately born original budget; persistence and readback must succeed before acknowledgment. Reopening a terminal cancellation restores negative observations and cannot recreate positive execution authority.
Pre-live enrollment clock continuity
Recovery of a device enrollment allocation uses protected original allocation and signing-generation evidence under the same runtime generation owner. A ceremony identifier selects that original; caller state cannot replace its start, deadline, or observation history. Live admission must checkpoint eligibility against the original clock before publication and reject terminated or expired allocations. Clock and generation profiles are owned mutable records with atomic initial publication. First terminal and retirement decisions remain lifetime-protected immutable evidence; a competing decision cannot be overwritten during recovery.
Cancellation preparation consumes required sender-record custody and borrows retained issued control; observed invitation values cannot substitute. Both retain the exact native runtime owner. Guard-issued preparation and the tracker-issued negative terminal token must agree with the publication runtime, including when authority and physical device identifiers are equal. A different runtime cannot sign through borrowed control or publish its cancellation. The required regular sender-record decoder rejects records larger than 1 MiB before decoding; oversized and malformed data remain distinct typed failures.
Required sender enrollment custody combines the bounded regular record with its separately retained secure original payload. Secure reads, decoding and exact immutable metadata comparison must succeed before custody is minted; a redacted record alone cannot substitute. Only regular lifecycle status overlays the retained original. The regular decoder is bounded to 1 MiB and the retained secret decoder to 4 MiB. Cancellation status publication redacts the hydrated payload again and preserves the secure original bytes.
Supervised execution identity comes from successful bounded registry admission, not from a caller identifier or an executor thread. Each registered future poll and destructor has its original owned identity; nested scopes restore their caller and cancellation cannot leave an ambient owner installed. Identity is stable across suspension and executor migration and distinguishes sibling groups with identical local task counters. Native and browser choreography session bindings use that identity for supervised tasks. Identity observation grants no ability to admit a task or enter an execution scope, and identity carries no cryptographic peer, membership or signing authority.
Forced VM owner retirement
Session owner authority includes the physical identity of the actual claim or transfer. Session IDs, labels, generations and scopes are read-only observations and cannot reconstruct that authority. A capability from another runtime is invalid even when all of those observations are identical. Copying a current capability retains its original claim; transfer invalidates all copies of the previous claim.
A dropped move-owned VM session retires its exact registered choreography owner and local fragment custody synchronously. Owner generation and scope validation share the ownership-transfer lock order, so stale handles cannot retire a newer owner. This resource retirement supplies no signed terminal decision and performs no asynchronous close or physical-time observation. Ordinary paths retain the required explicit close contract. Unknown transport delivery remains unknown; retirement neither acknowledges nor replays pending frames.
Registered task destructors retain concrete retirement failures in the existing service task health owner before cancellation completion and idle publication. Task poll identity scopes remain lexical during destructors.
Enrollment negative terminal notification
Authenticated enrollment cancellation uses the separately admitted finite
aura.invitation.device_enrollment_terminal_notice protocol. Its session identity
is domain separated from the request/response session and binds the original
invitation and admitted manifest digest. A notification never advances the
request/response VM's program counter. The wire envelope is untrusted: only the
independently pinned issuer signature and exact original manifest, invitation,
ceremony and physical-device bindings issue negative terminal evidence.
The issuer sends only after the durable cancelled terminal decision. The receiver's listener belongs to the existing invitation service task tree and shares the original admitted window's lease, checkpoint and observations. It retains a distinct immutable signed failure receipt before reporting failure. Negative evidence cannot authorize device adoption or committed recovery. Cancellation and ordinary response races close their actual owned session slots; forced drop retires exact session custody without claiming asynchronous close or terminal evidence. Required failure causes remain in native observation and service task health. Notification retries retain the original deadline and only reconcile definitely unsent, exactly scoped transport failures.
Exact notice identity and bounded execution
The original registered enrollment window retains a single sealed notice identity from the actual retained issued control. It binds the canonical manifest transcript and digest, including signed expiry, to the original runtime and registered generation. Clones use the same binding; rebinding to a different digest, transcript or expiry fails closed. Admitted notice guards match the retained original expiry explicitly. No serialized value constructs this runtime-local binding.
Enrollment progression preserves its original lexical owner and acceptance window across delegated work. Caller futures have a bounded size independent of executor stack settings; delegation cannot acquire a second execution owner or extend the original window.
Signed notice validity attenuation
Issuer notice execution is bounded by both the original registered ceremony interval and signed manifest validity. An original owner derives its child endpoint from one acknowledged physical observation; a later read cannot shift that endpoint forward. The child shares original lease, observations and checkpoint, and never renews the registration. An already elapsed manifest validity is a retained typed domain expiry, not an invented clock failure or retryable transport diagnosis. Active cancellation checks this signed validity before the durable terminal CAS. Already-cancelled idempotent local replay retains the first decision without authorizing a new expired notification.
Required session teardown failures
Required VM close and runtime choreography close retain their concrete producer errors through the standard error source chain. Forced retirement retains a VM close failure even when exact ownership retirement succeeds. If both fail, the close failure is primary and the ownership failure remains separately typed. Cleanup failure cannot acknowledge successful terminal publication or remote delivery. A provider that exposes only textual lifecycle detail retains that limitation; wrapping it does not establish additional structured evidence.
Enrollment custody ordering
All enrollment publication and activation owners share one physical signing custody order: generation, tracker decision, then tree mutation. A composite runtime capability retains the actual generation and decision guards for the same effect system and tracker; a foreign runtime, a deserialized record or a caller-supplied lock cannot manufacture that custody. Fresh roster preparation, original allocation recovery and activation retain this owner through their tree decision. Registration and supersession reuse the held decision instead of reacquiring it. Verified signing activation requires the same physical generation capability and does not acquire that guard a second time. Readiness, immutable receipts and canonical identifiers remain evidence, rather than substitutes for a held lifecycle owner.
Original cancellation preparation scope
An active enrollment cancellation observes the actual original registered clock and checkpoint owner. Its preparation authority is distinct from protocol execution admission: it does not reacquire the execution lease or admit another VM session. Required guard preparation, first terminal decision and local publication share the original fixed deadline attenuated to signed validity. Required observation acknowledgment precedes continuation, and a replaced clock or allocation fails closed.
The complete cancellation ingress request has a separate local bound of five seconds, covering selector lookup, active preparation and historical negative publication. Active preparation is additionally bounded by the original registered/signed interval; the tighter bound stops continuation. Neither bound can extend enrollment validity or authorize protocol execution. An existing durable Cancelled decision supplies a negative publication capability, preserving the first decision and original interval without reopening execution or permitting new expired notification signing.
An enrollment registration handoff retains the actual runtime owner reference. Original protected record validation and matching logical identifiers alone do not permit a different runtime to consume that live registration capability. The generation decision lease can end after durable registration; the physical owner binding continues through protocol and deferred delivery admission.
Targeted VM disposal acknowledgment
Required VM retirement disposes only the owned target session, including live or blocked coroutines, scheduling eligibility, handoffs and scoped communication and resource state. Unrelated sessions remain usable. Host metadata removal follows the actual backend acknowledgment. The cooperative backend retains stable coroutine IDs through its existing index rebuild; the threaded backend validates and rebuilds its explicit ID index after removal.
Threaded worker execution is joined by the engine's synchronous worker scope before exclusive disposal begins. Acknowledgment means no target job remains; it does not require destroying the shared pool or other sessions. Naturally terminal session status and epoch are preserved, and repeated disposal returns its original compact acknowledgment. New close epoch advancement is checked only for a genuinely active target.
Concrete backend failure remains in the standard native source chain. Required closure cannot succeed by parsing or suppressing an unsupported error, merely removing host metadata, or disposing an entire engine containing other sessions. Historical compact summaries and diagnostic traces follow the dependency's explicit archive policy. Shared global guard state is not claimed as exclusively owned by the target session. VM disposal is local cleanup and does not establish remote delivery, a signed terminal decision or protocol completion.
Final active enrollment inventory custody
An enrollment duplicate-start observation requires both the original canonical invitation binding and the still-live task registration admitted from its original execution root. A missing root, busy lease, recovered phase record, cancelled task, or rejected spawn cannot establish that execution is running. Repeated observation neither creates another task nor renews the original provider or deadline. Running observations confer no execution or terminal acknowledgment authority and become unusable when their registration ceases to be live.
The issuer captures final active verification material while the original generation, tracker decision and tree reservation remains held. The exporter requires that sealed capture and compares the exact manifest binding before signing; caller-supplied manifest tuples do not authorize export. Receiver admission requires the signed final inventory and authenticates its roster against baseline membership. Existing-peer recording retains its original registered issuance capability rather than reloading weaker identifiers. Exact nonroot package persistence remains required before nonroot enrollment can be admitted; an absent provider fails closed and cannot be replaced by the root package.
Cancelled enrollment notification recovery
Post-bootstrap recovery distinguishes a retained Cancelled first decision from an active enrollment registration. Pending generation secrets remain retired. A separate move-owned notice capability binds the independently retained issued manifest, actual runtime, immutable first decision, original clock checkpoint and original execution semaphore. It authorizes only the finite signed terminal-notice protocol; it grants no Request, Accept, Confirm, activation or membership authority.
Notification eligibility ends at the earlier of the original registered deadline and the signed manifest expiry. Restoring a terminal decision does not renew either bound. Required observation and checkpoint acknowledgment precede signing and continuation. Signing uses the currently owned issuer identity only while its key still matches the independently retained issuer verifier. Known original or signed expiry completes the finite recovery owner with a typed eligibility-ended disposition and prevents further sends. Required clock, checkpoint, signer, transport and teardown faults retain their original typed cause through task failure and drain. Both preserve the Cancelled decision.
Failed enrollment generation retirement
A failed generation retires its required secret inventory before publishing and acknowledging the exact immutable retirement receipt. That receipt makes retirement retries idempotent. The original protected allocation record remains immutable evidence; generic secure deletion cannot release or rewrite it. An explicitly mutable pending slot has a separate owned release contract. Immutable participant wrapping secrets likewise require an explicit retirement lifetime. Fresh allocation ownership must distinguish that history from its live pending slot, including when the next canonical epoch is unchanged by a failed ceremony.
Enrollment allocation history and live epoch slots
An enrollment allocation's original ordered policy, independent setup binding, reserved invitation, prestate and clock interval are immutable history. Its registered first decision has a separate immutable seal. An epoch-addressed mutable live slot identifies the currently held allocation; neither its phase flag nor its participant vector independently authorizes registration or recovery. Required reads compare the slot against its protected original history and registered seal before exposing a live generation capability. A registered seal acknowledged before an interrupted slot update remains the first decision.
Retirement releases the mutable slot only after required cleanup and the exact completed cleanup receipt are acknowledged. A negative decision recorded before cleanup does not certify that cleanup completed. Replaying that decision permits only cleanup of the same original generation, never resumed signing. Original allocation and registration evidence remains protected when a later ceremony allocates the same pending epoch. Legacy protected epoch records require explicit original-history validation before migration into a separate mutable slot.
Participant wrapping secrets require generation-specific lifetime ownership. Their creator custody must survive reconstruction under the original selected profile and distinguish two ceremonies at the same pending epoch. A generic Delete capability, namespace match or caller-supplied digest does not authorize retirement of such a secret.
Admitted enrollment clock publication
The original invitee admission interval is retained as immutable evidence, separate from the mutable highwater checkpoint. Fresh admission retains the full signed manifest interval beginning at the original recorded admission time. Explicit migration of a legacy clock preserves its actually recorded attenuation; it cannot extend that interval to the newer fresh policy.
Finishing an interrupted initial publication requires the original protected admission, cryptographic revalidation and exclusive execution custody of the actual runtime. It may publish only the original clock bytes. Required observation and reimport do not allocate clocks. The immutable first-live decision ends this initial completion authority: subsequent missing original or checkpoint records fail closed, rather than deriving another clock from the current time. Required publication, reread and checkpoint faults retain their concrete causes.
Enrollment signing and response policies
An enrollment generation commits its signing threshold and ordered signing roster separately from the remote response policy. The local issuer belongs to the signing roster and is not a remote responder. The original allocation fixes the response threshold and responder count before registration; subsequent registration, recovery and interrupted completion compare those committed values exactly. A signing threshold does not become response-policy evidence through clamping recovered records. Historical allocations lacking a distinct protected response-policy commitment require explicit proved migration before live reuse.
Historical enrollment response-policy evidence
An old allocation without a distinct response commitment may acquire a separate immutable supplement only from its original protected allocation and original protected tracker registration. The supplement binds the exact bytes of both records and retains the registration's response threshold and count directly. Original subject, ceremony, epoch, prestate, setup and responder roster must agree. Missing original proof cannot be replaced by arithmetic on the signing threshold or a reconstructed participant count.
Explicit migration holds the actual generation owner. Required reads validate the supplement and its original evidence without writing new authority. Neither old allocation bytes nor the original clock interval are changed. Deserializing an old allocation cannot reconstruct this verified supplemental authority; missing or contradictory supplemental evidence fails closed.
Verified enrollment parent heads
A commitment change within an epoch does not change the original signing-key policy. An enrollment AddLeaf followed by RotateEpoch therefore has an intermediate original-epoch parent head. Required verifier inventory captures that exact parent only after its operation cryptographically verifies against the independently admitted node key and policy. Neither an epoch match nor a public package template independently authorizes a new parent commitment.
Sealed committed-transition and local-extension evidence retains the captured inventory. Archive consumers require that evidence and its original manifest binding before exposing verifier data. The immutable archive continues binding the complete original committed-history digest and admitted public policies; operation verification reconstructs exact intermediate heads. A replayed fence, another node/epoch, substituted policy or divergent history cannot supply the required evidence.
Registered notice identity assignment
A registered enrollment window retains one runtime-local notice identity binding for its original manifest digest, canonical transcript and expiration. Repeated submission must compare all three fields against that original assignment; contradictory submission cannot replace it. This binding is not decoded from peer or storage data and does not establish signing authority or freshness on its own.
Registered enrollment execution-window admission requires the original registered generation capability, bound to its actual runtime, tracker and signed canonical invitation. An observed ceremony snapshot or a ceremony identifier alone cannot reacquire execution custody. Pre-live allocation clock ownership and registered execution ownership remain distinct stages.
Original enrollment allocation policy
Device enrollment has a maximum original allocation interval of 600,000 physical milliseconds. A signed quorum request must be validated against this same policy. A longer setup-code validity interval cannot widen that allocation. Signed expiry attenuates the active child while preserving the original interval and its retained observation continuity.
Enrollment allocation lifetime ownership
Enrollment wrapping births retain the authenticated rotation plan and original immutable allocation scope. Read, activation and retirement capabilities bind to the actual runtime registry. Negative cleanup retains original generation and first-decision custody through provider acknowledgment before releasing the generation. Restart recovers that original custody and deadline; same-epoch reissuance cannot be retired by replaying an earlier allocation's negative owner.
Configured provider fidelity
An explicitly configured runtime effect provider remains the provider for its required operations throughout assembly and service ownership. Ordinary storage configuration preserves unified encryption at rest and does not replace secure allocation custody. A configured provider failure remains a failure of that operation with its native cause. It cannot authorize selecting an implicit default provider. Configured transport selection precedes emission; receive absence permits inspection of another configured provider, while a typed fault terminates that attempt. Synchronous and asynchronous builders have the same provider-fidelity contract.
Rendezvous identity selection failures
Local rendezvous descriptor and channel identity material is bound to the selected runtime's active physical participant and epoch policy. The retained identity context authorizes the canonical package read. Failure of that read retains its concrete cause and prevents publication or channel preparation; a companion package or historical epoch cannot replace failed authoritative material. Contact response signing retains the original issued identity under the same required physical package-read contract.
Filesystem lifetime initialization may finish an acknowledged pre-link intent only under original selected profile custody and protected pre-live origin. Staged observations do not count as acknowledged once-live metadata. Recovery preserves the original root and finishes Preparing/Birth/Ready/Handed ordering without a new root allocation; ambiguous, conflicting or missing live evidence returns a retained failure.
Contact, guardian and channel invitation issuance captures its original physical signer under the fresh reservation before publication. Subsequent export, response and profile reopen load that protected identity and canonical sender record; neither active-epoch replacement nor a historical search can repair missing original evidence. The identity capability binds the actual runtime, physical device, original epoch, invitation digest and public verifier. Export preserves native selected-provider signing failures through its typed error chain.
Initial staged-publication recovery retains the opened source through link, linked-target identity and ciphertext validation, then acknowledges the target before removing staged evidence. Conflict or substitution cannot acknowledge handoff. Interruption after link and before staged-name removal may leave two names for one original private ciphertext inode. Only the exact original source/target pair, authenticated under held profile custody, admits this initialization exception; unrelated aliases and missing once-live targets fail. Target acknowledgement precedes stage removal and its directory acknowledgement. Stage inventories and exact target-prefix lookup stream entries under retained directory descriptors, without imposing a total ordinary-record cap. Traversal bounds follow the secure-storage namespace/key/subkey layout; full native scan latency remains proportional to the stored directory inventory.
Required shutdown completion provenance
Closing runtime admission establishes Stopping, not completed shutdown. A shutdown request observing an already closed owner fails with its native state and cannot publish Stopped. Recorded task-tree, service or lifecycle teardown failures retain Stopping. Only the internal successful completion path publishes Stopped; an observed activity handle cannot mint that state. The complete admitted-operation and owned-service drainage protocol remains a separate prerequisite for profile handoff.
Contact confirmation operation windows
A Contact confirmation continuation retains the original acceptance operation's attenuated physical interval and observation owner. Retrying the same signed acceptance cannot renew that interval. Physical rollback after observed progress is a required failure even when the new timestamp is later than the original start. Required clock and sleep failures retain their native causes and do not become invitation expiry. A runtime-owned decision lease serializes required imported-state verification and the resulting materialization and status publication.
Required current identity signing availability
A supported active threshold identity reports quorum-service unavailability only after its current native public verifier, exact ordered physical participant policy and actual local encrypted share have been validated together. Malformed or unsupported native packages remain cryptographic failures; missing local backing records remain storage failures with their original record location. A local share alone never establishes completed group signing.
Guardian recovery pair access is serialized by the original runtime's private keypair lease. A response identity capability retains that runtime and its zeroizing private bytes; partial or mismatched original evidence fails before response publication. Both fresh writes must acknowledge before capability issuance. The in-process lease is not a durable recovery witness for interrupted initial pair publication or complete historical loss.
Required regular imported-invitation reads and terminal decisions share the original runtime's imported-invitation decision lease across Contact and Guardian handlers. Required Guardian response code reads bounded stored metadata, retains native read/codec failures, and checks the imported invocation binding before allocating recovery keys or opening the VM. A cached invitation cannot turn failed backing reads into absence. VM, canonical codec, physical clock and confirmation storage failures retain process-local original causes.
Guardian sender-code context and the receiver-local materialized context are distinct. The response binds retained original payload fields and actual receiver authority while retaining original code context/version as import evidence; re-encoding a receiver-local projection cannot reconstruct the original code.
Guardian principal and receiver operations establish their original effect-backed physical window before the first required import, key, or VM await. Preparation and the VM loop consume the same budget and observation owner; waiting for import custody cannot start a new window. Required clock/provider failures retain native causes. Expiration/cancellation is failure evidence and does not acknowledge session disposal or authorize a runtime/profile transfer.
Guardian VM terminal processing consumes the actual owned session and requires its close acknowledgment before a successful return. A failed primary operation and failed close retain both typed process-local causes; standard source traversal follows the primary, while the terminal failure retains cleanup separately. The primary timeout category survives a combined failure. Outer-window cancellation may still force owner retirement; it is failure evidence, never close ACK or completed runtime/profile drain.
Original runtime shutdown window and retained operation admission
Public invitation, authentication, chat, OTA, recovery and session mutations retain one admission lease from their actual runtime until completion or cancellation. Admission closure and operation count changes are atomic. Each runtime admits at most 256 simultaneous public operations; exhaustion rejects before mutation and only the original lease's destruction releases its slot. This local resource policy grants no ceremony, signing, or membership authority.
Shutdown closes admission and owns one required physical resource window of 30 seconds. It settles admitted operations before stopping their reactive publication scheduler, then waits for actual supervised descendant destruction and required service teardown under that same original window. Failed clock, checkpoint, deadline, service, or destruction evidence withholds successful stopped publication. Forced abort requests do not constitute destruction ACK. Cancellation does not reopen the original runtime.
This shutdown contract does not establish transferable profile custody. Unleased advanced effects, lower signing/bridge mutation routes, current membership validation, provider-preserving profile reassembly and genuine quorum signing require their own completed ownership boundaries.
Runtime admission observations expose state without authority to close admission or publish shutdown completion. Closure remains internal to runtime ownership; external callers use the sanctioned shutdown operation. Runtime operation leases are issued through declaration-layer proof boundaries and retain the actual activity gate; a foreign gate cannot authorize an original runtime continuation.
Original runtime service-stop continuation
Successful public admission closure creates a move-only shutdown window tied to the actual gate, effect system and task root. Required service disposal and health acknowledgments consume that same original resource window; the common service helper cannot allocate another deadline. Authority termination is published only after all required pipeline, task-tree, service-health and lifecycle acknowledgments, within the original window. Provider, deadline and authority-state failures retain their native causes and withhold successful runtime termination.
This contract does not authorize profile transfer. Internal service cleanup windows and whole provider/registry/RNG reassembly require their own completed owner integration before a full handoff can be acknowledged.
Exact reactive publication observation
An exact processing target is issued by the original scheduler ingress after accepted ordered enqueue. Its queue envelope and retained processing observation are bound to that same ingress owner. The scheduler acknowledges only after all registered views complete the selected batch. Retained highwater allows exact completed targets to be observed despite coalesced or missed diagnostic notifications. Original scheduler failures retain their native causes for pending targets. Processing acknowledgment establishes completion of configured view updates; canonical commit provenance and protocol eligibility remain bound to their respective runtime-issued evidence.
Required Chat mutation and processing share one admitted operation owner and its original physical resource window. Runtime startup shares one physical resource window across service admission, start, health and required initial replay. Startup readiness requires that replay's exact target to be processed. Failed partial startup owns cleanup of its admitted services and retains primary and secondary failures. Optional descriptor publication has subsidiary supervision and cannot delay primary startup readiness. Latency diagnostics explicitly represent unavailable measurement rather than inventing physical timestamps.
Canonical runtime ingress retains the exact runtime captured by pipeline construction. A standalone scheduler cannot authorize runtime attachment, and a foreign runtime cannot adopt another pipeline's processing acknowledgment. Processing completion does not assert successful signal emission or application semantic readiness. Observers retain receive-only diagnostic subscriptions; a diagnostic notification never supplies publication sequence or processing authority.
Runtime-issued command services
A public command's startup admission is handed into the actual registered runtime service before the startup lease is released. Long-lived service lifetime is owned by the runtime task root, rather than an ordinary admitted operation held while awaiting user input. Each required command round has one original effect-backed resource interval shared by its helper awaits. The local public-operation resource policy is thirty seconds; it cannot replace or renew a signed protocol interval or a stronger existing operation window.
Managed command cleanup acknowledges actual service stop and task completion under the original shutdown owner before disposal of reactive processing and root tasks. Required cleanup failure withholds whole-runtime completion.
Local cleanup deadlines and terminal evidence
A resource deadline is a local physical-time budget chosen by its authoritative owner. It cannot establish causal/protocol ordering, consensus finality, shared Range validity, or distributed completion. Service progress publication requires actual disposal/task acknowledgment and a bounded required observation under the original shutdown owner. Observation-lock acquisition, clock access and checkpoint retain that same fixed endpoint and selected provider. Expired, unsupported or failed provider observations cannot publish successful cleanup. Frontends and observers cannot substitute another clock, allocate a replacement window, or turn timeout diagnostics into domain completion evidence.
Prepared enrollment quorum ownership
Preparation retains the original issuer generation/tree reservation and protected physical window while explicit participants approve the exact versioned intent. An approved participant belongs to its actual active runtime/profile and current native ordered signing policy. Provisional or merely matching authority ids cannot provide participant custody; missing, malformed and foreign material remain typed failures.
The issuer transfers only a restricted HeldIssuerCompletionObserver to its
registered completion holder. This move-only observer retains the original
protected clock/checkpoint continuation and exact result/task observation; it
carries no execution permit, arbitrary executor, child, nonce or raw-clock API.
The actual issuer task keeps execution custody. Participant and issuer task
handles remain owned by bounded runtime ingress until actual group destruction
acknowledgment under their original windows. Capacity is admitted before spawning.
Registry collisions and shutdown failures preserve original concrete causes and
never treat dropped handles as successful drainage.
A retained initial Request signature is immutable, independently reverified and bound to the exact issued manifest, original runtime and current native signing policy. Required execution eligibility expires with the original protected window; cached signatures cannot renew it. Successful initial quorum initiation does not prove later confirmation quorum, complete enrollment or restart custody.
Device quorum signing for tree operations
An authority signature whose current policy needs more than one device (a tree
operation or a typed message such as a device-rotation proposal or commit) is
produced by ThresholdSigningService::sign_with_device_quorum. The coordinating
device sends each co-signer a request carrying the full signing context, proven
with the coordinator's own share. The co-signer authenticates it against the
coordinator's verifying share in its own retained current package, recomputes
the exact message from its own state, and only then consults its consent policy.
Every round packet is share-proven in both directions. Nonces exist only in
memory after consent and are consumed by the one share they produce. A threshold
of one signs locally; a raw sign call never starts a distributed round.
Consent is a device-local setting (DeviceSigningConsent): escalate to the user
on that device (the default) or sign automatically after verification. It is
stored locally, never replicated, and consulted on every request. An escalated
request waits as a pending signing request until the user approves or declines
it. A decline is a share-proven cancel that fails the coordinator's operation
with a typed refusal. Granular per-operation rules are future work.
A device-rotation participant accepts with a proof of its current share, which the initiator checks against that device's verifying share. It stores its new share wrapped like every other participant share. Both devices then activate the same rotated package. The commit is the participant's final step: an applied, verified commit completes its session.
Confirmed import activation custody
Only the original durable confirmed enrollment capability can publish its activation envelope. Key readers retain that original receipt or the reverified committed profile receipt; raw authority, epoch and participant identifiers only check the held reference. A committed profile may supply read custody for its original device before reopening, but active subject signing still requires the actual adopted runtime identity and explicit original-device approval. The separate envelope leaves immutable signed import bytes unchanged. The original birth anchor prevents missing-envelope recovery from refreshing nonce or key custody. Repeated handoff reuses and verifies the exact original envelope, and required readers preserve provider and codec sources.
Confirmed activation wrapping custody uses the same native allocation manager as issuer generation custody, with distinct confirmed import origins on the sealed birth and positive capabilities. Required reads verify the original receipt, imported generation and exact allocation reference. A recovered original scope without its required envelope is a storage failure; retry or reopening cannot allocate a replacement wrapping secret for that scope.
Consuming enrollment execution and terminal custody
Admitted, held-issuer, registered and approved-signing execution require their actual original durable Pending birth. The consuming root retains its native material acquisition, task admission and protocol continuation. Closed requires its independent domain evidence, exact sealed descendant disposal and original durable acknowledgment. Approved-signing completion additionally binds the actual native participant completion to the same approved intent and effect owner. A successful checkpoint alone, transcript bytes, task disposal or a historical Closed record cannot reconstruct that authority.
Negative or unresolved execution retains the completed operation, actual
checkpoint disposition, first native failure and independent final validation
without minting a new cleanup owner. Cleanup belongs to the originally retained
negative-only custody, including partial acquisition and refused task admission.
Observation cancellation does not release that obligation, renew the physical
endpoint or recover signing authority. Packet progress and completed native IO
remain in their original holder before final validation; unresolved started sends
cannot be replaced by another send under a reconstructed owner. Opaque disposal
observations identify the exact original required task and grant no terminal
authority. The original runtime and approved finite negative policy remain
required for conditional negative signing (100_crypto.md).
Journal
This document describes the journal architecture and state reduction system in Aura. It explains how journals implement CRDT semantics, how facts are structured, and how reduction produces deterministic state for account authorities and relational contexts.
It describes the reduction pipeline, flow budget semantics, and integration with the effect system. It defines the invariants that ensure correctness. See Maintenance for the end-to-end snapshot and garbage collection pipeline.
Hybrid Journal Model (Facts + Capabilities)
Aura’s journal state is a composite of:
- Fact Journal: the canonical, namespaced CRDT of immutable facts.
- Capability Frontier: the current capability lattice for the namespace.
- Composite journal view: the runtime carries facts and capabilities together when evaluating effects.
The fact journal is stored and merged as a semilattice. Capabilities are refined via meet. The runtime always treats these as orthogonal dimensions of state.
1. Journal Namespaces
Aura maintains a separate journal namespace for each authority and each relational context. A journal namespace stores all facts relevant to the entity it represents. A namespace is identified by an AuthorityId (see Authority and Identity) or a ContextId and no namespace shares state with another. Identifier definitions appear in Identifiers and Boundaries.
A journal namespace evolves through fact insertion. Facts accumulate monotonically. No fact is removed except through garbage collection rules that preserve logical meaning.
#![allow(unused)] fn main() { pub struct Journal { pub namespace: JournalNamespace, pub facts: BTreeSet<Fact>, } pub enum JournalNamespace { Authority(AuthorityId), Context(ContextId), } }
This type defines a journal as a namespaced set of facts. The namespace identifies whether this journal tracks an authority's commitment tree or a relational context. The journal is a join semilattice under set union where merging two journals produces a new journal containing all facts from both inputs. Journals with different namespaces cannot be merged.
2. Fact Model
Facts represent immutable events or operations that contribute to the state of a namespace. Facts have ordering tokens, timestamps, and content. Facts do not contain device identifiers used for correctness.
#![allow(unused)] fn main() { pub struct Fact { pub order: OrderTime, pub timestamp: TimeStamp, pub content: FactContent, } pub enum FactContent { AttestedOp(AttestedOp), Relational(RelationalFact), Snapshot(SnapshotFact), RendezvousReceipt { envelope_id: [u8; 32], authority_id: AuthorityId, timestamp: TimeStamp, signature: Vec<u8>, }, } }
The order field provides an opaque, privacy-preserving total order for deterministic fact ordering in the BTreeSet. The timestamp field provides semantic time information for application logic. Facts implement Ord via the OrderTime field. Do not use TimeStamp for cross-domain indexing or total ordering. Use OrderTime or consensus/session sequencing instead.
This model supports account operations, relational context operations, snapshots, and rendezvous receipts. Each fact is self contained. Facts are validated before insertion into a namespace.
Bootstrap genesis completion requires an authenticated device-creation
AttestedOp under the retained epoch-zero key, together with its durable
operation bytes and tree index entry. An in-memory reducer/cache entry alone
cannot prove commit after a failed storage write. A persisted completion record
binds the exact creation-operation digest; matching device IDs without matching
keys and signed creation evidence cannot establish bootstrap readiness.
2.2 Protocol-Level vs Domain-Level Relational Facts
RelationalFact has only two variants:
Protocol(ProtocolRelationalFact): Protocol-level facts that must live inaura-journalbecause reduction semantics depend on them.Generic { .. }: Extensibility hook for domain facts (DomainFact+FactReducer).
Criteria for ProtocolRelationalFact (all must hold):
- Reduction-coupled: the fact directly affects core reduction invariants in
reduce_context()(not just a view). - Cross-domain: the fact’s semantics are shared across multiple protocols or layers.
- Non-derivable: the state cannot be reconstructed purely via
FactReducer+RelationalFact::Generic.
If a fact does not meet all three criteria, it must be implemented as a domain fact and stored via RelationalFact::Generic.
Enforcement:
- All protocol facts are defined in
crates/aura-journal/src/protocol_facts.rs. - Any new protocol fact requires a doc update in this section and a matching reduction rule.
2.1 Domain Fact Contract
Domain facts are the extensibility mechanism for feature crates. They are stored as RelationalFact::Generic envelopes and reduced by registered FactReducers. Every domain fact family follows the canonical domain fact model of §4.2.1: one derive codec, one declared schema version, registration in the agent FactRegistry, and a reduction that is a pure function of the fact set.
3. Semilattice Structure
Journals use a join semilattice. The semilattice uses set union as the join operator with partial order defined by subset inclusion. The journal never removes facts during merge. Every merge operation increases or preserves the fact set.
The join semilattice ensures convergence across replicas. Any two replicas that exchange facts eventually converge to identical fact sets. All replicas reduce the same fact set to the same state.
The merge operation asserts namespace equality, unions the fact sets, and returns the combined journal. The result is monotonic and convergent.
4. Reduction Pipeline
Aura maintains two replicated state machines. Account journals describe commitment trees for authorities. Relational context journals describe cross-authority coordination. Both use the same fact-only semilattice and deterministic reducers.
flowchart TD
A[Ledger append] --> B[Journal merge];
B --> C[Group by parent];
C --> D[Resolve conflicts via max hash];
D --> E[Apply operations in topological order];
E --> F[Recompute commitments bottom-up];
Ledger append writes facts durably. Journal merge unions the fact set. Reducers group operations by parent commitment, resolve conflicts deterministically using max hash tie-breaking, and then apply winners in topological order. The final step recomputes commitments bottom-up which downstream components treat as the canonical state.
4.1 Fact Production
Account operations originate from local threshold signing or Aura Consensus. Relational context operations always run through Aura Consensus because multiple authorities must agree on the prestate. Each successful operation produces an AttestedOp fact. Receipts that must be retained for accountability are stored as RendezvousReceipt facts scoped to the context that emitted them. Implementations must only emit facts after verifying signatures and parent commitments.
4.2 Determinism Invariants
The reduction pipeline maintains strict determinism:
- No HashMap iteration: All maps use BTreeMap for consistent ordering
- No system time: OrderTime tokens provide opaque ordering
- No floating point: All arithmetic uses exact integer/fixed-point
- Pure functions only: Reducers have no side effects
These properties are verified by test_reduction_determinism() which confirms all fact permutations produce identical state.
4.2.1 Canonical Domain Fact Model
Facts reach replicas late, duplicated and out of order through sync. A domain fact family is therefore reduced by a pure function of its fact set: every permutation of the same facts yields the same state, and neither arrival order nor physical time decides an outcome.
Encoding, versioning and registration
Each domain fact type has one shape and one codec.
- Derive codec. The type uses
#[derive(DomainFact)](aura-macros). The derive writes a DAG-CBORFactEnvelopeand decodes only DAG-CBOR. Hand-writtenimpl DomainFactblocks and JSON envelopes are not used. The sharedaura-coredecode helpers reject a JSON envelope withFactError::NonCanonicalEncoding. - One schema version.
#[domain_fact(type_id = ..., schema_version = N)]declares the only version, carried by the envelope. Decoding accepts exactlyN. When the shape changes, the version is bumped and the old shape is replaced, not decoded: there is no supported-version range, no legacy decoder and no compatibility shim. The payload carries no version field of its own, and the type id carries no version suffix. - Type id and context. The type id is a plain string (a literal, a
*_FACT_TYPE_IDconstant or a zero-argument accessor), unique across the registry and listed incrates/aura-agent/src/fact_types.rs. The derive'scontextorcontext_fnnames the fact'sContextId. - Keys and registration. Reducers and views address facts through the family's
FactKeyhelpers, never ad hoc strings. Each type is registered with itsFactReducerinbuild_fact_registry(crates/aura-agent/src/fact_registry.rs); a Layer 2 crate that cannot depend onaura-journalis registered through a transparent derive wrapper in a higher crate (maintenance facts useaura-sync::MaintenanceJournalFact).
Reduction patterns
aura-journal::causal_reduction provides the shared rules. A family composes them; it does not reimplement them.
- Tagged observed-remove set. An add is identified by its tag. A reversal names the tags of the adds of the same key that its writer observed. The set keeps every add that no reversal revokes, so a concurrent add the reversal's writer did not observe survives. Contacts (existence per owner and contact), web-of-trust introductions, home bans and mutes, and social lifecycle pairs use this pattern.
- Multi-value register. A write names the writes of the same key it supersedes. The register keeps every write that no observing write supersedes and that is not causally before another write. The family resolves the remaining concurrent writes by an explicit domain policy, then by causal order. Contact nicknames and read-receipt policy, access overrides, storage readings and chat message revisions use this pattern.
- Episodes. State that can end and restart, such as a friendship, a channel membership or a home neighborhood join, is a sequence of episodes. A terminal fact ends the episodes its writer observed, and only a fact that starts a new episode re-admits the subject. A late or replayed fact from an ended episode cannot reopen it.
- Explicit terminal precedence. Families whose outcomes are terminal rather than reversible, such as recovery and invitation outcomes, define a total precedence over terminal states and resolve ties by causal order or canonical bytes. Protocol facts follow the same rule: AMP channel bootstraps resolve to the smallest
bootstrap_id, then full fact order.
Causal stamps and time
A reversible or overwritable fact carries aura_core::time::CausalMetadata, stamped by the writer before commit:
clock: the writer'sLogicalClockafter observing every fact of the family it holds.revokes: for a reversal, the tags of the observed adds of the same key.supersedes: for a register write, the tags of the observed writes of the same key.
The tag itself is not carried. Every reader derives it as the hash of the fact's type id and canonical re-encoding, which names the author and includes the clock. A peer cannot claim another fact's tag to revoke or shadow it, and distinct content never shares a tag.
Writers obtain the metadata through RuntimeBridge::causal_stamp(CausalStampKey), which advances the runtime's logical clock past the family's committed facts for that key. CausalStampKey names the family and key: HomeGovernance, Contact, Friendship, Chat and InvitationOutcome.
Causal order (causal_cmp) is happens-before, then TimeStamp::sort_compare with OrderingPolicy::DeterministicTieBreak, then causal depth, Lamport scalar and tag. It is the tie-break of last resort and the order for display. Physical time is for user-visible timestamps and expiry only. Expiry is evaluated at query time against a caller-supplied instant, never during reduction.
Verification and enforcement
assert_permutation_invariant is the shared test harness: it reduces every permutation of a small fact set and requires identical state. Every reversible family keeps such a regression next to its reducer.
just ci-domain-fact-model (also run by just ci-ownership-policy) is a Rust-native syntax check in toolkit/xtask. Over production code it requires that every DomainFact type uses the derive, has a resolvable unversioned type id and no in-payload version field, and is registered in the FactRegistry. It rejects JSON envelopes in domain fact crates. It keeps a typed inventory of reversible families; a fact carrying CausalMetadata must belong to a listed family, and each family must keep a test-scope assert_permutation_invariant call. The derive itself rejects a min_supported_schema_version key.
Home governance (docs/115 §3.4), social lifecycle (docs/115 §3.5), contacts (aura-relational::contacts), the web of trust (aura-relational::wot), recovery (aura-recovery::state), invitation outcomes (aura-invitation::lifecycle), chat revisions (aura-chat::revisions) and AMP channel membership (aura-amp::channel) follow this model.
4.3 Canonical Entity Materialization
A channel, home, invitation, or contact exists in a projection only after its domain creation fact or an equivalent authenticated creation outcome supplies the canonical identity and required metadata. A membership, relationship, status, rename, or activity fact may change an existing entity but cannot establish one. Raw identifiers identify a candidate; they are not evidence of canonical name, context, type, or relationship.
Reduction is independent of delivery order. Enrichment facts that arrive before creation remain applicable when matching creation evidence arrives. Facts for a different entity or context cannot contribute members, counts, labels, or status. Duplicate facts do not create duplicate entities or inflate counts. Replaying the same fact set after restart yields the same materialized entities and metadata as live reduction.
For homes, an accepted inviter reloads its committed HomeCreated fact before
applying membership enrichment. The app's home creation witness can be derived
only from that fact shape; acceptance or membership alone cannot create the
home projection. Nonempty home snapshots round-trip typed home and authority
identifiers through JSON without changing their identities or counts.
5. Account Journal Reduction
Account journals store attested operations for commitment tree updates. Reduction computes a TreeStateSummary (epoch, commitment, threshold, device count) from the fact set. See Authority and Identity for structure details. The summary is a lightweight public view that hides internal device structure. For the full internal representation with branches, leaves, and topology, see TreeState in aura-journal::commitment_tree.
Internally, AuthorityTreeState materializes explicit branch topology to support incremental commitment updates. It keeps ordered branch children, branch/leaf parent pointers, and branch depth metadata. The topology is deterministic: active leaves are sorted by LeafId, paired in stable order, and materialized with NodeIndex(0) as root followed by breadth-first branch assignment. This guarantees identical branch structure for identical active leaf sets across replicas.
Commitment recomputation for non-structural mutations is path-local. Aura marks affected branches dirty, collects their paths to root, then recomputes only those branches bottom-up. Structural mutations (AddLeaf, RemoveLeaf) currently use deterministic rebuild of topology and branch commitments (correctness-first baseline). Merkle proof paths are derived from the same materialized topology so proof generation and commitment caches share one source of truth.
Maintenance note: do not change topology construction or branch indexing rules without updating replay fixtures and root commitment fixtures. Determinism depends on stable leaf sort order, stable pair composition, and stable branch index assignment.
Reduction follows these steps:
- Identify all
AttestedOpfacts. - Group operations by their referenced parent state (epoch + commitment).
- For concurrent operations (same parent), select winner using max hash tie-breaking:
H(op)comparison. - Apply winners in topological order respecting parent dependencies.
- Recompute commitments bottom-up after each operation.
The max hash conflict resolution (max_by_key(hash_op)) ensures determinism by selecting a single winner from concurrent operations. The result is a single TreeStateSummary for the account derived by extracting AttestedOp facts and applying them in deterministic order.
6. RelationalContext Journal Reduction
Relational contexts store relational facts. These facts reference authority commitments. Reduction produces a RelationalState that captures the current relationship between authorities.
#![allow(unused)] fn main() { pub struct RelationalState { pub bindings: Vec<RelationalBinding>, pub flow_budgets: BTreeMap<(AuthorityId, AuthorityId, u64), u64>, pub leakage_budget: LeakageBudget, pub channel_epochs: BTreeMap<ChannelId, ChannelEpochState>, } pub struct RelationalBinding { pub binding_type: RelationalBindingType, pub context_id: ContextId, pub data: Vec<u8>, } }
This structure represents the reduced relational state. It contains relational bindings, flow budget tracking between authorities, leakage budget totals for privacy accounting, and AMP channel epoch state for message ratcheting.
Reduction processes the following protocol fact types wrapped in Protocol(...):
GuardianBindingmaps toRelationalBindingfor guardian relationshipsRecoveryGrantcreates recovery permission bindings between authoritiesConsensusstores generic bindings with consensus metadataAmpChannelCheckpointanchors channel state snapshots for AMP messagingAmpProposedChannelEpochBumpandAmpCommittedChannelEpochBumptrack channel epoch transitionsAmpChannelPolicydefines channel-specific policy overrides for skip windowsDkgTranscriptCommitstores consensus-finalized DKG transcriptsConvergenceCertrecords soft-safe convergence certificatesReversionFacttracks explicit reversion eventsRotateFactmarks lifecycle rotation or upgrade events
Domain-specific facts use Generic { context_id, binding_type, binding_data } and are reduced by registered FactReducer implementations.
Reduction verifies that relational facts reference valid authority commitments and applies them in dependency order.
Enrollment response evidence and recovery
Enrollment acceptance requires the expected verifier selected by explicit setup transfer and retained for that ceremony. A participant count, a persisted terminal outcome, or a deserialized response does not establish acceptance provenance. Recording and activation require an opaque witness minted after verification of the exact response against that retained verifier.
Durable recovery retains the original response and its subject, invitation, ceremony, device, pending epoch and setup binding. Recovery revalidates this material before issuing a new process-local witness. Missing, corrupt or legacy active records without verifier evidence fail closed. Observing a historical terminal result does not authorize a new activation.
The first durable response decision is stable under duplicate, concurrent and contradictory delivery. Required persistence failure must prevent acceptance from becoming visible to activation owners. Runtime receipts and committed journal facts have distinct provenance; a receipt alone cannot establish a consensus-finalized membership transition.
Enrollment VM control messages are authenticated against the independently selected initiator verifier retained with the signed manifest. Requests and confirmations bind the exact manifest digest and ceremony decision. Peer receipt keys or supplied digest strings cannot select that verifier. A response signer derives its physical identity and policy from locally retained setup possession and the sealed admitted manifest. Live response signing requires the current signer to match that original setup; retained evidence does not grant historical signing authority.
An established confirmation requires the authoritative committed terminal decision. Pending state is not a timeout. Recovery revalidates original retained independent pins before minting process-local admission evidence.
6.1 AMP Channel Epoch Transition Reduction
Reduced AMP epoch entries may contain staged policies, bootstrap metadata, or transition observations before creation. Canonical materialization requires the selected checkpoint for the exact context and channel. The reduced state retains checkpoint presence explicitly; an absent checkpoint cannot establish channel existence, readiness, or duplicate creation. Checkpoint evidence is observed journal content, not an authorization capability.
AMP channel epoch transition reduction is fact-only and deterministic. It refines the existing A1/A2/A3 operation model for channel epoch state without changing authority-root membership or account commitment tree rules.
Every AMP transition proposal, certificate, commit, abort, conflict, or
supersession fact binds the same canonical transition_id when it refers to
the same transition. The identity is the typed digest over:
context_idchannel_idparent_epochparent_commitmentsuccessor_epochsuccessor_commitmentmembership_commitmenttransition_policy
Reducers group transition facts by (context_id, channel_id, parent_epoch, parent_commitment) and validate all facts in the group before exposing live
state. Reducer validation covers parent binding, successor epoch validity,
membership commitment validity, witness committee validity, A2 certificate
thresholds, A3 commit evidence, and abort/conflict/supersession evidence.
For each parent group, reduction exposes one of:
| State | Live successor exposed? | Meaning |
|---|---|---|
Observed | No | One or more syntactically valid proposals exist without a live certificate. |
A2Live | Yes | Exactly one valid unsuppressed AMP-certified successor exists. |
A2Conflict | No | Multiple conflicting valid certificates or unresolved equivocation evidence exist. |
A3Finalized | Yes | Consensus-backed commit finalizes one successor. |
A3Conflict | No | Multiple conflicting durable commits or unresolved durable-commit evidence exist. |
Aborted | No | Explicit abort evidence suppresses live use. |
Superseded | Depends on successor | Authorized supersession replaces the earlier transition path. |
If exactly one valid unsuppressed A3 commit exists, that transition is both the durable and live successor. Otherwise, if exactly one valid unsuppressed A2 certificate exists, that transition is the live successor but remains non-durable. If conflicting valid A2 certificates exist and facts do not resolve the conflict, reduction exposes no live successor and marks the parent state conflict-tainted.
Reducers must not use local wall-clock time, network connectivity, operator preference, arrival order, or hash tie-breaking between conflicting valid A2 certificates to choose a live successor. Single-winner exposure must come from fact validation: a valid AMP certificate, a valid A3 commit, explicit equivocation evidence, abort evidence, or supersession evidence.
The aura-journal context reducer exposes this state as structured AMP
transition reduction data. RelationalState::amp_transitions is keyed by
AmpTransitionParentKey { context, channel, parent_epoch, parent_commitment }. Each AmpTransitionReduction records observed,
certified, finalized, suppressed, conflict, and emergency evidence ids for
that parent. ChannelEpochState::transition points at the current parent
transition, and ChannelEpochState::pending_bump is populated only when the
current parent is A2Live. Emergency reducer fields include suspect
authorities, quarantine successor epochs, and prune-before epochs derived from
emergency alarms and emergency transition facts.
The reduced channel view distinguishes:
stable_epoch: last durable committed epochlive_successor: optional A2-certified successor for the stable epochdurable_successor: optional A3-finalized successortransition_state: one of the states aboveconflict_evidence: optional witness or transition evidence when conflict-tainted- emergency policy fields such as suspect authority, quarantine epoch, and prune-before epoch when an emergency transition is active
The AMP message ratchet consumes this reducer output. It does not author membership truth, choose between transitions, or repair missing control-plane facts.
7. Flow Budgets
Flow budgets track message sending allowances between authorities. The FlowBudget structure uses semilattice semantics for distributed convergence:
#![allow(unused)] fn main() { pub struct FlowBudget { pub limit: u64, pub spent: u64, pub epoch: Epoch, } impl FlowBudget { pub fn merge(&self, other: &Self) -> Self { Self { limit: self.limit.min(other.limit), spent: self.spent.max(other.spent), epoch: if self.epoch.value() >= other.epoch.value() { self.epoch } else { other.epoch }, } } } }
The spent field uses join-semilattice (max) because charges only increase. The limit field uses meet-semilattice (min) because the most restrictive limit wins. The epoch field advances monotonically. Spent resets on epoch rotation.
Flow budget tracking operates at the runtime layer via FlowBudgetManager. The RelationalState includes a flow_budgets map for CRDT-based replication of budget state across replicas.
8. Receipts and Accountability
Receipts reference the current epoch commitment so reducers can reject stale receipts automatically. The RendezvousReceipt variant in FactContent stores accountability proofs (envelope ID, authority, timestamp, signature). Receipts are stored as relational facts scoped to the emitting context. This coupling ensures that receipt validity follows commitment tree epochs.
9. Snapshots and Garbage Collection
Snapshots summarize all prior facts. A snapshot fact contains a state hash, the list of superseded facts, and a sequence number. A snapshot establishes a high water mark. Facts older than the snapshot can be pruned.
#![allow(unused)] fn main() { pub struct SnapshotFact { pub state_hash: Hash32, pub superseded_facts: Vec<OrderTime>, pub sequence: u64, } }
Garbage collection removes pruned facts while preserving logical meaning. Pruning does not change the result of reduction. The GC algorithm uses safety margins to prevent premature pruning:
- Default skip window: 1024 generations
- Safety margin:
skip_window / 2 - Pruning boundary:
max_generation - (2 * skip_window) - safety_margin
Helper functions (compute_checkpoint_pruning_boundary, can_prune_checkpoint, can_prune_proposed_bump) determine what can be safely pruned based on generation boundaries.
10. Journal Effects Integration
The effect system provides journal operations through JournalEffects. This trait handles persistence, merging, and flow budget tracking:
#![allow(unused)] fn main() { #[async_trait] pub trait JournalEffects: Send + Sync { async fn merge_facts(&self, target: Journal, delta: Journal) -> Result<Journal, AuraError>; async fn refine_caps(&self, target: Journal, refinement: Journal) -> Result<Journal, AuraError>; async fn get_journal(&self) -> Result<Journal, AuraError>; async fn persist_journal(&self, journal: &Journal) -> Result<(), AuraError>; async fn get_flow_budget(&self, context: &ContextId, peer: &AuthorityId) -> Result<FlowBudget, AuraError>; async fn update_flow_budget(&self, context: &ContextId, peer: &AuthorityId, budget: &FlowBudget) -> Result<FlowBudget, AuraError>; async fn charge_flow_budget(&self, context: &ContextId, peer: &AuthorityId, cost: FlowCost) -> Result<FlowBudget, AuraError>; } }
The effect layer writes facts to persistent storage. Replica synchronization loads facts through effect handlers into journal memory. The effect layer guarantees durability but does not affect CRDT merge semantics.
At the choreography runtime boundary, journal coupling is always driven by guard/effect commands. Generated choreography annotations and runtime guard checks emit EffectCommand values, and JournalCoupler ensures journal commits occur before transport observables. In VM execution, AuraVmEffectHandler emits envelopes, but journal writes still flow through the same EffectInterpreter + JournalEffects path.
11. AttestedOp Structure
AttestedOp exists in two layers with different levels of detail:
Layer 1 (aura-core) - Full operation metadata:
#![allow(unused)] fn main() { pub struct AttestedOp { pub op: TreeOp, pub agg_sig: Vec<u8>, pub signer_count: u16, } pub struct TreeOp { pub parent_epoch: Epoch, pub parent_commitment: TreeHash32, pub op: TreeOpKind, pub version: u16, } }
Layer 2 (aura-journal) - Flattened for journal storage:
#![allow(unused)] fn main() { pub struct AttestedOp { pub tree_op: TreeOpKind, pub parent_commitment: Hash32, pub new_commitment: Hash32, pub witness_threshold: u16, pub signature: Vec<u8>, } }
The aura-core version includes epoch and version for full verification. The aura-journal version includes computed commitments for efficient reduction.
12. Invariants
The journal and reduction architecture satisfy several invariants:
- Convergence: All replicas reach the same state when they have the same facts
- Idempotence: Repeated merges or reductions do not change state
- Determinism: Reduction produces identical output for identical input across all replicas
- No HashMap iteration: Uses BTreeMap for deterministic ordering
- No system time: Uses OrderTime tokens for ordering
- No floating point: All arithmetic is exact
These invariants guarantee correct distributed behavior. They also support offline operation with eventual consistency. They form the foundation for Aura's account and relational context state machines.
13. Fact Validation Pipeline
Every fact inserted into a journal must be validated before merge. The following steps outline the required checks and the effect traits responsible for each fact type:
13.1 AttestedOp Facts
Checks
- Verify the threshold signature (
agg_sig) using the two-phase verification model fromaura-core::tree::verification:verify_attested_op(): Cryptographic signature check againstBranchSigningKeystored in TreeStatecheck_attested_op(): Full verification plus state consistency (epoch, parent commitment)
- Ensure the referenced parent state exists locally. Otherwise request missing facts.
- Confirm the operation is well-formed (e.g.,
AddLeafindexes a valid parent node).
See Tree Operation Verification for details on the verify/check model and binding message security.
Responsible Effects
CryptoEffectsfor FROST signature verification viaverify_attested_op().JournalEffectsfor parent lookup, state consistency viacheck_attested_op(), and conflict detection.StorageEffectsto persist the fact once validated.
13.2 Relational Facts
Checks
- Validate that each authority commitment referenced in the fact matches the current reduced state (
AuthorityState::root_commitment). - Verify Aura Consensus proofs if present (guardian bindings, recovery grants).
- Enforce application-specific invariants (e.g., no duplicate guardian bindings).
Responsible Effects
AuthorizationEffects/RelationalEffectsfor context membership checks.CryptoEffectsfor consensus proof verification.JournalEffectsfor context-specific merge.
13.3 FlowBudget Facts
Checks
- Ensure
spentdeltas are non-negative and reference the active epoch for the(ContextId, peer)pair. - Reject facts that would decrease the recorded
spent(monotone requirement). - Validate receipt signatures associated with the charge (see
111_transport_and_information_flow.md).
Responsible Effects
FlowBudgetEffects(or FlowGuard) produce the fact and enforce monotonicity before inserting.JournalEffectsgate insertion to prevent stale epochs from updating headroom.
13.4 Snapshot Facts
Checks
- Confirm the snapshot
state_hashmatches the hash of all facts below the snapshot. - Ensure no newer snapshot already exists for the namespace (check
sequencenumber). - Verify that pruning according to the snapshot does not remove facts still referenced by receipts or pending consensus operations.
Responsible Effects
JournalEffectscompute and validate snapshot digests.StorageEffectspersist the snapshot atomically with pruning metadata.
By clearly separating validation responsibilities, runtime authors know which effect handlers must participate before a fact mutation is committed. This structure keeps fact semantics consistent across authorities and contexts.
14. Consistency Metadata Schema
Facts carry consistency metadata for tracking agreement level, propagation status, and acknowledgments. See Operation Categories for the full consistency metadata type definitions.
14.1 Fact Schema Fields
The base Fact structure (section 2) is extended with consistency metadata fields (added via serde defaults for backwards compatibility):
| Field | Type | Purpose |
|---|---|---|
agreement | Agreement | Finalization level (A1 Provisional, A2 SoftSafe, A3 Finalized) |
propagation | Propagation | Anti-entropy sync status (Local, Syncing, Complete, Failed) |
ack_tracked | bool | Opt-in flag for per-peer acknowledgment tracking |
14.2 Ack Storage Table
For facts with ack_tracked = true, acknowledgments are stored in a separate table:
| fact_id | peer_id | acked_at |
|---|---|---|
| msg-001 | alice_authority_id | 2024-01-15T10:30:00Z |
| msg-001 | bob_authority_id | 2024-01-15T10:30:05Z |
14.3 Journal API for Consistency
The Journal API provides methods for acknowledgment tracking: record_ack records an acknowledgment from a peer, get_acks retrieves all acknowledgments for a fact, and gc_ack_tracking garbage collects acknowledgment data based on policy.
See Also
- Database Architecture for query system and Datalog integration
- Operation Categories for consistency metadata types
- Maintenance for snapshot and garbage collection pipeline
- Relational Contexts for context journal structure
- Authority and Identity for commitment tree operations
Required moderation evidence
Required moderation queries reject corrupt ban/mute and reversal payloads, unsupported schemas, declared-codec mismatch, oversized inventories, and wrapper/payload context mismatch before returning a denial decision. Observational compatibility decoding is separate; decoding success alone is not journal commit/authentication provenance.
Canonical codec failure provenance
Required canonical serialization retains the original concrete ciborium failure through the standard error source chain. Display diagnostics keep their existing prefixes; pure canonical-format validation failures have no invented codec source. Canonical bytes and strict decoding rules are unchanged. Native semantic classification remains SerializationFailure, including when a codec cause is carried through storage or checkpoint context. Serialized presentation diagnostics do not establish native failure provenance.
Enrollment baseline publication
An enrollment baseline is installed only after independent manifest verification. Its storage owner retains the original local history digest before replacement and publishes complete operation content before the canonical ordered index. Failed index acknowledgment is an uncertain publication outcome and requires canonical reread. Replaying an already installed baseline preserves later local operations. An original-publication record is coordination evidence, not authorization.
Immutable local enrollment decision records
Locally retained enrollment setup, pending-generation, registration, response, and issued-manifest records preserve the first canonical decision via atomic absent-only provider publication. A competing existing value must pass bounded exact binding validation; accepted-response and issued-manifest evidence must be cryptographically revalidated. Different valid signature bytes do not replace the original decision. These local records are recovery evidence, not consensus facts. Generic mutable secure-provider write access does not establish domain authorization or lifetime immutability.
Required envelope decoding failures
Required domain-fact decoding validates the declared domain, exact current schema, payload bound and canonical DAG-CBOR encoding before consuming a payload. An existing envelope and its canonical encoded form have the same validation contract. Retired and future schemas and JSON envelopes are rejected; malformed DAG-CBOR retains the original canonical serialization cause. A decode failure is not fact absence. Successful decoding establishes value shape, not journal commitment or canonical entity materialization authority.
Authorization
Overview
Aura authorizes every observable action through Biscuit capability evaluation combined with sovereign policy and flow budgets. The authorization pipeline spans AuthorizationEffects, the guard chain, and receipt accounting. This document describes the data flow and integration points.
Canonical Capability Vocabulary
Aura uses one canonical capability vocabulary based on validated
CapabilityName values.
- First-party capabilities are declared in the crate that owns the behavior,
using typed capability families generated from
#[capability_family(...)]. - Token issuance uses explicit grant profiles or explicit validated
CapabilityNamesets at the issuance boundary. There is no implicit "grant every declared capability" path. - Guard snapshots carry evaluated frontiers only. They do not carry declared families, candidate sets, or fallback broad grants.
- Raw capability strings are admitted only at explicit parsing boundaries such as Biscuit decoding and choreography DSL parsing, where invalid values fail closed.
Out-of-tree modules follow the same shape, but their capability families must be declared in admitted module manifests rather than handwritten in host runtime code.
Biscuit Capability Model
Biscuit tokens encode attenuation chains. Each attenuation step applies
additional caveats that shrink authority through meet composition. Aura stores
Biscuit material outside the replicated CRDT. Local runtimes evaluate tokens at
send time against typed candidate sets supplied by the owning domain and cache
the resulting lattice element for the active ContextId.
Cached entries expire on epoch change or when policy revokes a capability. Policy data always participates in the meet. A token can only reduce authority relative to local policy.
flowchart LR
A[frontier, token] -->|verify signature| B[parsed token]
B -->|apply caveats| C[frontier ∩ caveats]
C -->|apply policy| D[result ∩ policy]
D -->|return| E[Cap element]
This algorithm produces a meet-monotone capability frontier. Step 1 ensures provenance. Steps 2 and 3 ensure evaluation never widens authority. Step 4 feeds the guard chain with a cached outcome.
Guard Chain
Authorization evaluation feeds the transport guard chain. All documents reference this section to avoid divergence.
flowchart LR
A[Send request] --> B[CapGuard]
B --> C[FlowGuard]
C --> D[JournalCoupler]
D --> E[Transport send]
This diagram shows the guard chain sequence. CapGuard performs Biscuit evaluation. FlowGuard charges the budget. JournalCoupler commits facts before transport.
Guard evaluation is pure and synchronous over a prepared GuardSnapshot.
CapGuard reads an evaluated frontier and any inline Biscuit token already
present in the snapshot. Snapshot builders may begin with a typed candidate
set, but they must evaluate that set against the Biscuit/policy frontier before
publishing capabilities into the snapshot. FlowGuard and JournalCoupler emit
EffectCommand items rather than executing I/O directly. An async interpreter
executes those commands in production or simulation.
Only after all guards pass does transport emit a packet. Any failure returns locally and leaves no observable side effect. DKG payloads require proportional budget charges before any transport send.
Telltale Integration
Aura uses Telltale runtime admission and VM guard checkpoints. Runtime admission gates whether a runtime profile may execute. VM acquire and release guards gate per-session resource leases inside VM execution. The Aura guard chain remains the authoritative policy and accounting path for application sends.
Failure handling is layered. Admission failure rejects engine startup. VM acquire deny blocks the guarded VM action. Aura guard-chain failure denies transport and returns deterministic effect errors.
Runtime Capability Admission
Aura uses a dedicated admission surface for theorem-pack and runtime capability checks before choreography execution. RuntimeCapabilityEffects in aura-core defines capability inventory queries and admission checks. RuntimeCapabilityHandler in aura-effects stores a boot-time immutable capability snapshot. The aura-protocol::admission module declares protocol requirements and maps them to capability keys.
Current protocol capability keys include byzantine_envelope for consensus ceremony admission, termination_bounded for sync epoch-rotation admission, reconfiguration for dynamic topology transfer paths, and mixed_determinism for cross-target mixed lanes.
Execution order is runtime capability admission first, then VM profile gates, then the Aura guard chain. Admission diagnostics must respect Aura privacy constraints. Production runtime paths must not emit plaintext capability inventory events. Admission failures use redacted capability references.
Failure Handling and Caching
Runtimes cache evaluated capability frontiers per context and predicate with an epoch tag. Cache entries invalidate when journal policy facts change or when the epoch rotates.
CapGuard failures return AuthorizationError::Denied without charging flow or touching the journal. FlowGuard failures return FlowError::InsufficientBudget without emitting transport traffic. JournalCoupler failures surface as JournalError::CommitAborted and instruct the protocol to retry after reconciling journal state.
This isolation keeps the guard chain deterministic and side-channel free.
Biscuit Token Workflow
Biscuit tokens guarantee cryptographically verifiable, attenuated delegation chains. Each token carries a signature chain that prevents forgery and supports offline verification without contacting the issuer. Attenuation is monotone: each delegation step can only reduce authority, never widen it. Epoch rotation provides revocation by invalidating old tokens. Aura does not maintain a separate per-token revocation list in aura-authorization; revocation is authority-wide and anchored to the currently trusted root key for that authority.
Issuance is explicit. The runtime selects a reviewed token grant profile and
materializes a concrete Vec<CapabilityName> at the issuance boundary. That
issuance profile is separate from the evaluated frontier that later appears in
guard snapshots. The two must not be conflated: profiles declare what may be
granted, while snapshots publish what is currently admitted after Biscuit and
policy evaluation.
See Effects and Handlers Guide for Biscuit workflow implementation.
Guard Chain Integration
Biscuit authorization integrates with the guard chain through three phases: cryptographic verification, synchronous guard evaluation over a prepared GuardSnapshot, and effect command interpretation. If any phase fails, the operation returns an error without observable side effects.
Guard operation identifiers are typed guard inputs, not ambient raw strings. Empty or whitespace-only custom operations are rejected before evaluation, and missing authorization metadata is a denial rather than a bypass.
Sync peer-token validation follows the same fail-closed model. Production sync validation requires a configured Biscuit root public key and a concrete authority/operation scope; deterministic roots and dummy scopes are test fixtures only.
See Effects and Handlers Guide for guard chain integration patterns.
Authorization Scenarios
All authorization scenarios (local device operations, cross-authority delegation, API access control, guardian recovery, storage, and relaying) are handled through Biscuit token attenuation and sovereign policy integration. Token scope and restrictions vary by scenario but follow the same meet-monotone evaluation path.
See Effects and Handlers Guide for authorization scenario patterns.
Performance and Caching
Authorization results are cached per authority, token hash, and resource scope with epoch-based invalidation. Cache entries invalidate on epoch rotation or policy update. Signature verification scales with chain length. Datalog evaluation scales with facts times rules. Attenuation is constant-cost.
See Distributed Maintenance Guide for cache configuration.
Security Model
Signature-chain verification establishes token integrity under the supplied root key. Authorization additionally requires that root to be selected independently from trusted authority state. A root carried alongside serialized capability bytes is algebraic metadata and cannot establish its own issuer trust or authorize an operation.
Cryptographic signature verification prevents token forgery. Epoch scoping limits token lifetime and replay attacks. Attenuation preserves security while growing verification cost proportional to chain length. Root key compromise invalidates all derived tokens.
Authority-based ResourceScope prevents cross-authority access. Local sovereign policy integration provides an additional security layer. Guard chain isolation ensures authorization failures leak no sensitive information.
Implementation References
The Cap type in aura-core/src/domain/journal.rs wraps serialized Biscuit tokens with optional root key storage. The Cap::meet() implementation computes capability intersection. Tokens from the same issuer return the more attenuated token. Tokens from different issuers return bottom.
BiscuitAuthorizationBridge in aura-guards/src/authorization.rs handles
guard chain integration. TokenAuthority, TokenGrantProfile, and
BiscuitTokenManager in aura-authorization/src/biscuit_token.rs handle token
creation and attenuation. Capability families live in the owning feature or
domain crates, not in one central global enum. ResourceScope in
aura-core/src/types/scope.rs defines authority-centric resource patterns.
See Transport and Information Flow for flow budget details. See Journal for fact commit semantics.
Persisted startup authorization
Startup distinguishes confirmed absence of a persisted authority Biscuit from a failed required read. Absent credentials permit the explicit new-account bootstrap path; storage failure and malformed or unverifiable persisted tokens prevent runtime assembly. A restored cache is published only after bounded record validation and token verification against its retained root key. These checks preserve concrete verification and storage causes.
Authorization cache publication is runtime-private. Observed cache snapshots cannot be submitted as authority to a public cache setter. Bootstrap and verified hydration retain the production publication path; deliberately malformed cache fixtures use a test-only crate-local adapter.
Guardian invitation first binding
A Guardian acceptance is bound to the retained original issued invitation and its issuer verifier. Acceptance recording requires that invitation's owned identity evidence and its original runtime; response fields cannot substitute another issuer key, invitation type or subject. The recovery-key signature proves possession for this particular invitation. Recording that key establishes the Guardian recovery binding and does not authorize device membership. Original imported invitation continuity and local recovery-pair integrity are distinct verification roles.
Database Architecture
This document specifies the architecture for Aura's query system. The journal is the database. Datalog is the query language. Biscuit provides authorization.
1. Core Principles
1.1 Database-as-Journal Equivalence
Aura's fact-based journal functions as the database. There is no separate database layer. The equivalence maps traditional database concepts to Aura components.
Aura treats database state as a composite of the fact journal and the capability frontier. Query execution always combines the reduced fact state with the current capability lattice (the JournalState composite) to enforce authorization and isolate contexts.
| Traditional Database | Aura Component |
|---|---|
| Table | Journal reduction view |
| Row | Fact implementing JoinSemilattice |
| Transaction | Atomic fact append |
| Index | Merkle trees and Bloom filters |
| Query | Datalog program evaluation |
| Replication | CrdtCoordinator with delta sync |
1.2 Authority-First Data Model
Aura's database is partitioned by cryptographic authorities. An AuthorityId owns facts that implement JoinSemilattice. State is derived from those facts.
Data is naturally sharded by authority. Cross-authority operations require explicit choreography. Privacy is the default because no cross-authority visibility exists without permission.
2. Query System
2.1 Query Trait
The Query trait defines typed queries that compile to Datalog:
#![allow(unused)] fn main() { pub trait Query: Send + Sync + Clone + 'static { /// The result type of this query type Result: Clone + Send + Sync + Default + 'static; /// Compile this query to a Datalog program fn to_datalog(&self) -> DatalogProgram; /// Get required Biscuit capabilities for authorization fn required_capabilities(&self) -> Vec<QueryCapability>; /// Get fact predicates for invalidation tracking fn dependencies(&self) -> Vec<FactPredicate>; /// Parse Datalog bindings to typed result fn parse(bindings: DatalogBindings) -> Result<Self::Result, QueryParseError>; /// Unique identifier for caching and subscriptions fn query_id(&self) -> String; } }
This design separates query definition from execution, enabling:
- Portable query definitions across runtimes
- Authorization checking before execution
- Reactive subscriptions via dependency tracking
2.2 Datalog Types
Queries compile to DatalogProgram, the intermediate representation:
#![allow(unused)] fn main() { pub struct DatalogProgram { pub rules: Vec<DatalogRule>, pub facts: Vec<DatalogFact>, pub goal: Option<String>, } pub struct DatalogRule { pub head: DatalogFact, pub body: Vec<DatalogFact>, } pub struct DatalogFact { pub predicate: String, pub args: Vec<DatalogValue>, } pub enum DatalogValue { String(String), Integer(i64), Boolean(bool), Variable(String), Symbol(String), Null, } }
Programs convert to Datalog source via to_datalog_source():
#![allow(unused)] fn main() { let program = DatalogProgram::new(vec![ DatalogRule::new(DatalogFact::new("active_user", vec![DatalogValue::var("name")])) .when(DatalogFact::new("user", vec![DatalogValue::var("name")])) .when(DatalogFact::new("online", vec![DatalogValue::var("name")])) ]) .with_goal("active_user($name)"); let source = program.to_datalog_source(); // Output: // active_user($name) :- user($name), online($name). // ?- active_user($name). }
2.3 Fact Predicates
FactPredicate patterns determine query invalidation:
#![allow(unused)] fn main() { pub struct FactPredicate { /// The predicate name to match pub name: String, /// Optional positional argument patterns (None = wildcard) pub arg_patterns: Vec<Option<String>>, /// Named field constraints for structured facts pub named_constraints: BTreeMap<String, String>, } impl FactPredicate { /// Match any fact with the given name pub fn named(name: impl Into<String>) -> Self; /// Match facts with specific named field constraints pub fn with_args(name: impl Into<String>, args: Vec<(&str, &str)>) -> Self; /// Add a positional argument pattern pub fn with_arg(self, pattern: Option<String>) -> Self; /// Add a named field constraint pub fn with_named_constraint(self, name: impl Into<String>, value: impl Into<String>) -> Self; /// Check if this predicate matches another pub fn matches(&self, other: &FactPredicate) -> bool; /// Check if this predicate matches a fact with positional arguments pub fn matches_fact(&self, fact_name: &str, fact_args: &[String]) -> bool; /// Check if this predicate matches a fact with named fields pub fn matches_named_fact(&self, fact_name: &str, fact_fields: &BTreeMap<String, String>) -> bool; } }
When facts change, subscriptions matching the predicate re-evaluate.
2.4 Query Capabilities
Authorization integrates with Biscuit via QueryCapability:
#![allow(unused)] fn main() { pub struct QueryCapability { pub resource: String, pub action: String, pub constraints: Vec<(String, String)>, } impl QueryCapability { pub fn read(resource: impl Into<String>) -> Self; pub fn list(resource: impl Into<String>) -> Self; pub fn with_constraint(self, key: impl Into<String>, value: impl Into<String>) -> Self; pub fn to_biscuit_check(&self) -> String; } }
Capabilities convert to Biscuit checks:
#![allow(unused)] fn main() { let cap = QueryCapability::read("channels").with_constraint("owner", "alice"); assert_eq!( cap.to_biscuit_check(), "check if right(\"channels\", \"read\"), owner == \"alice\"" ); }
3. Query Effects
3.1 QueryEffects Trait
QueryEffects executes queries against the journal:
#![allow(unused)] fn main() { #[async_trait] pub trait QueryEffects: Send + Sync { /// Execute a one-shot typed query async fn query<Q: Query>(&self, query: &Q) -> Result<Q::Result, QueryError>; /// Execute a raw Datalog program async fn query_raw(&self, program: &DatalogProgram) -> Result<DatalogBindings, QueryError>; /// Subscribe to query updates when facts change fn subscribe<Q: Query>(&self, query: &Q) -> QuerySubscription<Q::Result>; /// Pre-check authorization async fn check_capabilities(&self, capabilities: &[QueryCapability]) -> Result<(), QueryError>; /// Trigger re-evaluation for matching subscriptions async fn invalidate(&self, predicate: &FactPredicate); } }
3.2 Query Execution Flow
flowchart TD
A[Query::to_datalog] --> B[QueryEffects::query];
B --> C{Check capabilities};
C -->|Pass| D[Load journal facts];
C -->|Fail| E[QueryError::AuthorizationFailed];
D --> F[Execute Datalog];
F --> G[Query::parse];
G --> H[Typed result];
3.3 Reactive Subscriptions
QuerySubscription wraps SignalStream for live updates:
#![allow(unused)] fn main() { pub struct QuerySubscription<T: Clone + Send + 'static> { stream: SignalStream<T>, query_id: String, } impl<T: Clone + Send + 'static> QuerySubscription<T> { pub fn query_id(&self) -> &str; pub fn try_recv(&mut self) -> Option<T>; pub async fn recv(&mut self) -> Result<T, QueryError>; } }
Usage pattern:
#![allow(unused)] fn main() { let mut subscription = effects.subscribe(&ChannelsQuery::default()); while let Ok(channels) = subscription.recv().await { println!("Channels updated: {} total", channels.len()); } }
3.4 Query Isolation
QueryIsolation specifies consistency requirements for queries:
#![allow(unused)] fn main() { pub enum QueryIsolation { /// See all facts including uncommitted (CRDT state) - fastest ReadUncommitted, /// Only see facts with consensus commit ReadCommitted { wait_for: Vec<ConsensusId> }, /// Snapshot at specific prestate (time-travel query) Snapshot { prestate_hash: Hash32 }, /// Wait for all pending consensus in scope ReadLatest { scope: ResourceScope }, } }
Usage:
#![allow(unused)] fn main() { // Fast query - may see uncommitted facts let result = effects.query(&ChannelsQuery::default()).await?; // Wait for specific consensus before querying let result = effects.query_with_isolation( &ChannelsQuery::default(), QueryIsolation::ReadCommitted { wait_for: vec![consensus_id] }, ).await?; }
3.5 Query Statistics
QueryStats provides execution metrics:
#![allow(unused)] fn main() { pub struct QueryStats { pub execution_time: Duration, pub facts_scanned: u32, pub facts_matched: u32, pub cache_hit: bool, pub isolation_used: QueryIsolation, pub consensus_wait_time: Option<Duration>, /// Consistency metadata for matched facts pub consistency: ConsistencyMap, } }
Usage:
#![allow(unused)] fn main() { let (channels, stats) = effects.query_with_stats(&ChannelsQuery::default()).await?; println!("Query took {:?}, scanned {} facts", stats.execution_time, stats.facts_scanned); }
3.6 Query Errors
#![allow(unused)] fn main() { pub enum QueryError { AuthorizationFailed { reason: String }, MissingCapability { capability: String }, ExecutionError { reason: String }, ParseError(QueryParseError), SubscriptionNotFound { query_id: String }, JournalError { reason: String }, HandlerUnavailable, Internal { reason: String }, ConsensusTimeout { consensus_id: ConsensusId }, SnapshotNotAvailable { prestate_hash: Hash32 }, IsolationNotSupported { reason: String }, } }
4. Concrete Query Examples
Concrete queries (such as ChannelsQuery and MessagesQuery) implement the Query trait by compiling to Datalog programs, declaring required Biscuit capabilities, specifying fact predicate dependencies for invalidation, and parsing typed results from Datalog bindings.
See Effects and Handlers Guide for query implementation examples.
5. Indexing Layer
5.1 IndexedJournalEffects
The IndexedJournalEffects trait provides efficient indexed lookups:
#![allow(unused)] fn main() { pub trait IndexedJournalEffects: Send + Sync { /// Subscribe to journal fact updates as they are added fn watch_facts(&self) -> Box<dyn FactStreamReceiver>; /// Get all facts with the given predicate/key async fn facts_by_predicate(&self, predicate: &str) -> Result<Vec<IndexedFact>, AuraError>; /// Get all facts created by the given authority async fn facts_by_authority(&self, authority: &AuthorityId) -> Result<Vec<IndexedFact>, AuraError>; /// Get all facts within the given time range (inclusive) async fn facts_in_range(&self, start: TimeStamp, end: TimeStamp) -> Result<Vec<IndexedFact>, AuraError>; /// Return all indexed facts (append-only view) async fn all_facts(&self) -> Result<Vec<IndexedFact>, AuraError>; /// Fast membership test using Bloom filter fn might_contain(&self, predicate: &str, value: &FactValue) -> bool; /// Get the Merkle root commitment for the current index state async fn merkle_root(&self) -> Result<[u8; 32], AuraError>; /// Verify a fact against the Merkle tree async fn verify_fact_inclusion(&self, fact: &IndexedFact) -> Result<bool, AuraError>; /// Get the Bloom filter for fast membership tests async fn get_bloom_filter(&self) -> Result<BloomFilter, AuraError>; /// Get statistics about the index async fn index_stats(&self) -> Result<IndexStats, AuraError>; } }
The might_contain method uses Bloom filters for fast negative answers with O(1) lookup and less than 1% false positive rate.
5.2 Index Structure
#![allow(unused)] fn main() { pub struct AuthorityIndex { merkle_tree: MerkleTree<FactHash>, predicate_filters: BTreeMap<String, BloomFilter>, by_predicate: BTreeMap<String, Vec<FactId>>, by_authority: BTreeMap<AuthorityId, Vec<FactId>>, by_time: BTreeMap<TimeStamp, Vec<FactId>>, } }
- Merkle trees: Integrity verification
- Bloom filters: Fast membership tests (<1% false positive rate)
- B-trees: Ordered lookups (O(log n))
Indexes update on fact commit. Performance target: <10ms for 10k facts.
6. Biscuit Integration
6.1 AuraQuery Wrapper
AuraQuery wraps Biscuit's authorizer for query execution:
#![allow(unused)] fn main() { pub struct AuraQuery { authorizer: biscuit_auth::Authorizer, } impl AuraQuery { pub fn add_journal_facts(&mut self, facts: &[Fact]) -> Result<()> { for fact in facts { self.authorizer.add_fact(fact.to_biscuit_fact()?)?; } Ok(()) } pub fn query(&self, rule: &str) -> Result<Vec<biscuit_auth::Fact>> { self.authorizer.query(rule) } } }
6.2 Guard Chain Integration
Database operations flow through the guard chain:
flowchart LR
A[Query Request] --> B[CapGuard];
B --> C[FlowGuard];
C --> D[JournalCoupler];
D --> E[QueryEffects];
- CapGuard: Evaluates Biscuit token authorization
- FlowGuard: Charges budget for query cost
- JournalCoupler: Logs query execution
- QueryEffects: Executes the query
Each guard must succeed before the next executes.
7. Transaction Model
7.1 Coordination Matrix
Database operations use two orthogonal dimensions:
| Single Authority | Cross-Authority | |
|---|---|---|
| Monotone | Direct fact insertion (0 RTT) | CRDT merge via anti-entropy (0 RTT + sync) |
| Consensus | Single-authority consensus (1-2 RTT) | Multi-authority consensus (2-3 RTT) |
7.2 Examples
- Monotone + Single: Append message to own channel (
journal.insert_fact()) - Monotone + Cross-Authority: Guardian adds trust fact (
journal.insert_relational_fact()) - Consensus + Single: Remove device from account (
consensus_single_shot()) - Consensus + Cross-Authority: Recovery grant with guardian approval (
federated_consensus())
Aura Consensus is not linearizable by default. Each consensus instance independently agrees on a single operation and prestate. To sequence operations, use session types (see MPST and Choreography).
Agreement modes are orthogonal to the coordination matrix: A1 (provisional) and A2 (soft-safe) may provide immediate usability, but any durable shared database state must be A3 (consensus-finalized) with prestate binding. Soft-safe windows should be bounded with convergence certificates and explicit reversion facts.
BFT-DKG integration: When key material is required (K3), the database must bind operations to a consensus-finalized DkgTranscriptCommit. This ensures the transaction prestate and the cryptographic prestate are aligned.
MutationReceipt indicates whether a mutation completed immediately (monotone/CRDT) or was submitted to consensus.
See Choreography Development Guide for mutation receipt patterns and BFT-DKG transaction integration.
8. Temporal Database Model
Aura uses a Datomic-inspired immutable database model where all changes are represented as append-only facts with temporal metadata.
8.1 Core Concepts
Facts are never deleted. They are either:
- Asserted: Added to a scope
- Retracted: Marked as no longer valid (but remain queryable in history)
- Epoch-bumped: Bulk invalidation of facts in a scope
- Checkpointed: Snapshotted for temporal queries
Facts are organized in hierarchical scopes:
#![allow(unused)] fn main() { // Scope path examples "authority:abc123" // Authority-level "authority:abc123/chat" // Named sub-scope "authority:abc123/chat/channel:xyz" // Typed sub-scope }
Facts progress through finality levels:
#![allow(unused)] fn main() { pub enum Finality { Local, // Written locally only Replicated { ack_count: u16 }, // Acknowledged by N peers Checkpointed, // In a durable checkpoint Consensus { proof: ConsensusId }, // Confirmed via consensus Anchored { anchor: AnchorProof }, // External chain anchor } }
8.2 Fact Operations
Fact operations are classified by monotonicity. Assert and Checkpoint are monotonic (no coordination required). Retract and EpochBump are non-monotonic (may require consensus). The FactEffects trait provides the write interface, supporting single operations, atomic transactions, finality waiting, and temporal queries.
The hybrid transaction model uses direct apply_op() for simple monotonic operations and explicit Transaction grouping for atomic multi-operation batches. Temporal queries support as-of, since, and history range modes. Per-scope finality configuration controls default and minimum finality levels with optional per-content overrides.
See Effects and Handlers Guide for temporal query patterns and finality configuration.
9. Consistency Metadata
Query results include consistency metadata that tracks the agreement, propagation, and acknowledgment status of each fact.
9.1 ConsistencyMap
The ConsistencyMap type provides per-item consistency status in query results:
#![allow(unused)] fn main() { pub struct ConsistencyMap { entries: HashMap<String, Consistency>, } impl ConsistencyMap { pub fn get(&self, id: &str) -> Option<&Consistency>; pub fn is_finalized(&self, id: &str) -> bool; pub fn acked_by(&self, id: &str) -> Option<&[AckRecord]>; } }
9.2 Querying with Consistency
Use query_with_consistency() to get both results and consistency metadata:
#![allow(unused)] fn main() { let (messages, consistency) = handler.query_with_consistency(&MessagesQuery::default()).await?; for msg in &messages { let status = if consistency.is_finalized(&msg.id) { "finalized" } else { "pending" }; println!("{}: {}", msg.content, status); } }
9.3 QueryStats with Consistency
QueryStats now includes a ConsistencyMap for tracking consistency of scanned facts:
#![allow(unused)] fn main() { let (result, stats) = handler.query_with_stats(&query).await?; if stats.consistency.any_finalized() { println!("Some results are finalized"); } }
9.4 Consistency Dimensions
Each Consistency entry tracks three orthogonal dimensions:
| Dimension | Type | Purpose |
|---|---|---|
| Agreement | Agreement | A1/A2/A3 finalization level |
| Propagation | Propagation | Gossip/sync status to peers |
| Acknowledgment | Acknowledgment | Per-peer delivery confirmation |
See Operation Categories for full details on these types and their usage.
10. Implementation Location
| Component | Location |
|---|---|
Query trait | aura-core/src/query.rs |
QueryEffects trait | aura-core/src/effects/query.rs |
FactEffects trait | aura-core/src/effects/fact.rs |
QueryIsolation | aura-core/src/query.rs |
QueryStats | aura-core/src/query.rs |
MutationReceipt | aura-core/src/query.rs |
ConsensusId, FactId | aura-core/src/query.rs |
ConsistencyMap | aura-core/src/domain/consistency.rs |
Agreement, Propagation | aura-core/src/domain/ |
| Temporal types | aura-core/src/domain/temporal.rs |
ScopeId, Finality | aura-core/src/domain/temporal.rs |
FactOp, Transaction | aura-core/src/domain/temporal.rs |
TemporalQuery, TemporalPoint | aura-core/src/domain/temporal.rs |
AuraQuery wrapper | aura-effects/src/database/query.rs |
QueryHandler | aura-effects/src/query/handler.rs |
| Concrete queries | aura-app/src/queries/ |
IndexedJournalEffects | aura-core/src/effects/indexed.rs |
See Also
- Journal System - Fact storage, reduction, and flow budgets
- Operation Categories - Agreement, propagation, acknowledgment, and ceremony contract
- Authorization - Biscuit token evaluation
- Effect System - Effect implementation patterns
Consensus
This document describes the architecture of Aura Consensus. It defines the problem model, protocol phases, data structures, and integration with journals. It explains how consensus provides single-shot agreement for non-monotone operations such as account updates or relational context operations.
1. Problem Model
Aura uses consensus only for operations that cannot be expressed as monotone growth. Consensus produces a commit fact. The commit fact is inserted into one or more journals and drives deterministic reduction. Aura does not maintain a global log. Consensus operates in the scope of an authority or a relational context.
Consensus is single-shot. It agrees on a single operation and a single prestate. Commit facts are immutable and merge by join in journal namespaces.
A consensus instance uses a context-scoped committee. The committee contains witnesses selected by the authority or relational context. Committee members may be offline. The protocol completes even under partitions.
Consensus finalization is the single source of durable shared state. Fast-path coordination (provisional or soft-safe) may run in parallel for liveness, but its outputs must be superseded by commit facts. For BFT-DKG, consensus finalizes a transcript and emits DkgTranscriptCommit facts.
1.2 Witness Terminology
Aura uses witness (not validator) for consensus attestation participants.
witness: attests that an operation is valid for a specific prestate and contributes consensus evidence.signer: contributes threshold signature shares in FROST.
Keeping witness and signer distinct avoids conflating consensus attestation responsibilities with cryptographic share-generation roles.
1.3 Consensus is NOT Linearizable by Default
Aura Consensus is single-shot agreement, not log-based linearization.
Each consensus instance independently agrees on:
- A single operation
- A single prestate
- Produces a single commit fact
Consensus does NOT provide global operation ordering, sequential linearization across instances, or automatic operation dependencies.
To sequence operations, use session types (docs/110_mpst_and_choreography.md) executed through Aura’s Telltale-backed choreography runtime (execute_as runners or VM backend):
#![allow(unused)] fn main() { use aura_mpst::{choreography, Role}; #[choreography] async fn sequential_device_updates<C: EffectContext>( ctx: &C, account: Role<Account>, witnesses: Vec<Role<Witness>>, ) -> Result<(), AuraError> { // Session type enforces ordering: // 1. Update policy (must complete first) let policy_commit = consensus_single_shot( ctx, account.clone(), witnesses.clone(), TreeOp::UpdatePolicy { new_policy }, prestate1.hash(), ).await?; // 2. Remove device (uses policy_commit as prestate) // Session type prevents op2 from starting until op1 completes let prestate2 = account.read_tree_state(ctx).await?; assert_eq!(prestate2.hash(), policy_commit.result_id.prestate_hash); let remove_commit = consensus_single_shot( ctx, account, witnesses, TreeOp::RemoveLeaf { target: device_id }, prestate2.hash(), ).await?; Ok(()) } }
Cross-reference: See docs/107_database.md §8 for database transaction integration.
2. Core Protocol
Aura Consensus has two paths. The fast path completes in one round trip. The fallback path uses epidemic gossip and a threshold race. Both paths produce the same commit fact once enough matching witness shares exist.
The fast path uses direct communication. The initiator broadcasts an execute message. Witnesses run the operation against the prestate. Witnesses return FROST shares. The initiator aggregates shares and produces a threshold signature. FROST primitives are in aura-core::crypto::tree_signing.
The fallback path triggers when witnesses disagree or when the initiator stalls. Witnesses exchange share proposals using bounded fanout gossip. Any witness that assembles a valid threshold signature broadcasts a complete commit fact.
3. Common Structures and Notation
Consensus uses the following core concepts and notation throughout the protocol.
Core Variables
cid : ConsensusId- consensus instance identifierOp- operation being agreed on (application-defined)prestate- local pre-state for this instance (e.g., journal snapshot)prestate_hash = H(prestate)- hash of prestaterid = H(Op, prestate)- result identifiert- threshold. Adversary controls< tkey shares.W- finite set of witnesses for this consensus instance
Per-Instance Tracking
Each consensus participant maintains per-cid state. The decided flags prevent double-voting. Proposals are keyed by (rid, prestate_hash) to group matching shares.
Equivocation Detection
Equivocation occurs when the same witness signs two different rid values under the same (cid, prestate_hash). This violates safety. The protocol detects and excludes equivocating shares.
4. Data Structures
Consensus instances use identifiers for operations and results.
#![allow(unused)] fn main() { /// Consensus instance identifier (derived from prestate and operation) pub struct ConsensusId(pub Hash32); impl ConsensusId { pub fn new(prestate_hash: Hash32, operation_hash: Hash32, nonce: u64) -> Self { // Hash of domain separator, prestate, operation, and nonce } } }
This structure identifies consensus instances. The result is identified by H(Op, prestate) computed inline.
A commit fact contains full consensus evidence including the operation, threshold signature, and participant list. Participants are recorded as AuthorityId values to preserve device privacy.
#![allow(unused)] fn main() { /// From crates/aura-consensus/src/types.rs pub struct CommitFact { pub consensus_id: ConsensusId, pub prestate_hash: Hash32, pub operation_hash: Hash32, pub operation_bytes: Vec<u8>, pub threshold_signature: ThresholdSignature, pub group_public_key: Option<PublicKeyPackage>, pub participants: Vec<AuthorityId>, pub threshold: u16, pub timestamp: ProvenancedTime, pub fast_path: bool, pub byzantine_attestation: Option<ByzantineSafetyAttestation>, } }
The commit fact is the output of consensus. Every peer merges CommitFact into its journal CRDT. A peer finalizes when it accepts a valid threshold signature and inserts the corresponding CommitFact.
The commit fact is inserted into the appropriate journal namespace. This includes account journals for account updates and relational context journals for cross-authority operations.
Ordering of committed facts relies on OrderTime (or session/consensus sequencing), not on timestamps. ProvenancedTime is semantic metadata and must not be used for cross-domain total ordering or indexing.
4.1 Byzantine Admission and Attestation
Consensus-backed ceremonies (including BFT-DKG finalization) are admitted only after runtime capability checks for the consensus profile. Aura currently enforces theorem-pack/runtime capability requirements such as byzantine_envelope before executing DKG and threshold-signing paths.
Today this admission lives in the runtime bridge and threshold-signing
services, not in the consensus choreography source. The current
consensus choreography source file (crates/aura-consensus/src/protocol/choreography.tell)
remains theorem-pack-free because it still models
the message skeleton rather than the authoritative admission/evidence profile.
Adding a theorem pack there now would be decorative.
Aura should revisit consensus theorem packs only when all of the following are true:
- the choreography owns a concrete consensus-profile admission surface rather than relying on runtime-local capability checks
- the required guarantee is better expressed as a choreography-level envelope, ordering, or synchrony contract
- Aura has a real runtime admission consumer for those choreography-level
requirements beyond the existing
byzantine_envelopecapability gate
At admission, Aura captures a CapabilitySnapshot and records a ByzantineSafetyAttestation with:
- protocol id (
aura.consensus) - required capability keys for the profile
- snapshot of admitted/not-admitted runtime capabilities
- optional runtime evidence references
The attestation is attached to CommitFact and DkgTranscriptCommit. Capability mismatches fail before ceremony execution and emit redacted capability references for operational diagnostics.
5. Prestate Model
Consensus binds operations to explicit prestates. A prestate hash commits to the current reduced state of all participants.
#![allow(unused)] fn main() { let prestate_hash = H(C_auth1, C_auth2, C_context); }
This value includes root commitments of participating authorities. It may also include the current relational context commitment. Witnesses verify that their local reduced state matches the prestate hash. This prevents forks.
The result identifier binds the operation to the prestate.
#![allow(unused)] fn main() { let rid = H(Op, prestate); }
Witnesses treat matching (rid, prestate_hash) pairs as belonging to the same bucket. The protocol groups shares by these pairs to detect agreement.
6. Fast Path Protocol
The fast path optimistically assumes agreement. It completes in one round trip when all participants share the same prestate.
Messages
Execute(cid, Op, prestate_hash, evidΔ)- initiator requests operation executionWitnessShare(cid, rid, share, prestate_hash, evidΔ)- witness returns threshold shareCommit(cid, rid, sig, attesters, evidΔ)- initiator broadcasts commit factStateMismatch(cid, expected_pre_hash, actual_pre_hash, evidΔ)- optional debugging signal
Each message carries evidence delta evidΔ for the consensus instance. Evidence propagates along with protocol messages.
Initiator Protocol
The initiator i coordinates the fast path.
State at initiator i:
cid : ConsensusId // fresh per instance
Op : Operation
shares : Map[WitnessId -> (rid, share, prestate_hash)]
decided : Map[ConsensusId -> Bool] // initially decided[cid] = false
W : Set[WitnessId]
t : Nat
The initiator maintains per-witness shares and tracks decision status.
Start Operation
Start(cid, Op):
prestate := ReadState()
prestate_hash := H(prestate)
decided[cid] := false
shares := {}
For all w in W:
Send Execute(cid, Op, prestate_hash, EvidenceDelta(cid)) to w
The initiator reads local state and broadcasts the operation to all witnesses.
Process Witness Shares
On WitnessShare(cid, rid, share, prestate_hash, evidΔ) from w:
MergeEvidence(cid, evidΔ)
If decided[cid] = false and w not in shares:
shares[w] := (rid, share, prestate_hash)
// collect all shares for this specific (rid, prestate_hash)
Hset := { (w', s') in shares | s'.rid = rid
∧ s'.prestate_hash = prestate_hash }
If |Hset| ≥ t:
sig := CombineShares( { s'.share | (_, s') in Hset } )
attesters := { w' | (w', _) in Hset }
CommitFact(cid, rid, sig, attesters)
For all v in W:
Send Commit(cid, rid, sig, attesters, EvidenceDelta(cid)) to v
decided[cid] := true
The initiator collects shares. When t shares agree on (rid, prestate_hash), it combines them into a threshold signature.
Witness Protocol
Each witness w responds to execute requests.
State at witness w:
proposals : Map[(rid, prestate_hash) -> Set[(WitnessId, Share)]]
decided : Map[ConsensusId -> Bool]
timers : Map[ConsensusId -> TimerHandle]
W : Set[WitnessId]
t : Nat
Witnesses maintain proposals and fallback timers.
Process Execute Request
On Execute(cid, Op, prestate_hash, evidΔ) from i:
MergeEvidence(cid, evidΔ)
if decided.get(cid, false) = true:
return
prestate := ReadState()
if H(prestate) != prestate_hash:
Send StateMismatch(cid, prestate_hash, H(prestate), EvidenceDelta(cid)) to i
StartTimer(cid, T_fallback)
return
rid := H(Op, prestate)
share := ProduceShare(cid, rid)
proposals[(rid, prestate_hash)] := { (w, share) }
Send WitnessShare(cid, rid, share, prestate_hash, EvidenceDelta(cid)) to i
StartTimer(cid, T_fallback)
Witnesses verify prestate agreement before computing shares. Mismatches trigger fallback timers.
Process Commit
On Commit(cid, rid, sig, attesters, evidΔ) from any v:
if decided.get(cid, false) = false
and VerifyThresholdSig(rid, sig, attesters):
MergeEvidence(cid, evidΔ)
CommitFact(cid, rid, sig, attesters)
decided[cid] := true
StopTimer(cid)
Witnesses accept valid commit facts from any source.
7. Evidence Propagation
Evidence tracks equivocation and accountability information for consensus instances. The system uses CRDT-based incremental propagation. Evidence deltas attach to all protocol messages. Witnesses merge incoming evidence automatically.
Equivocation occurs when a witness signs conflicting result IDs for the same prestate. The protocol detects this pattern and generates cryptographic proofs. Each proof records both conflicting signatures with witness identity and timestamp.
#![allow(unused)] fn main() { pub struct EquivocationProof { pub witness: AuthorityId, pub consensus_id: ConsensusId, pub prestate_hash: Hash32, pub first_result_id: Hash32, pub second_result_id: Hash32, pub timestamp_ms: u64, } }
The proof structure preserves both conflicting votes. This enables accountability and slashing logic in higher layers.
Evidence deltas propagate via incremental synchronization. Each delta contains only new proofs since the last exchange. Timestamps provide watermark-based deduplication. The delta structure is lightweight and merges idempotently.
#![allow(unused)] fn main() { pub struct EvidenceDelta { pub consensus_id: ConsensusId, pub equivocation_proofs: Vec<EquivocationProof>, pub timestamp_ms: u64, } }
Every consensus message includes an evidence delta field. Coordinators attach deltas when broadcasting execute and commit messages. Witnesses attach deltas when sending shares. Receivers merge incoming deltas into local evidence trackers. This piggybacking ensures evidence propagates without extra round trips.
8. Fallback Protocol
Fallback activates when the fast path stalls. Triggers include witness disagreement or initiator failure. Fallback uses leaderless gossip to complete consensus.
Messages
Conflict(cid, conflicts, evidΔ)- initiator seeds fallback with known conflictsAggregateShare(cid, proposals, evidΔ)- witnesses exchange proposal setsThresholdComplete(cid, rid, sig, attesters, evidΔ)- any witness broadcasts completion
Equivocation Detection
Equivocation means signing two different rid values under the same (cid, prestate_hash).
HasEquivocated(proposals, witness, cid, pre_hash, new_rid):
For each ((rid, ph), S) in proposals:
if ph = pre_hash
and rid ≠ new_rid
and witness ∈ { w' | (w', _) in S }:
return true
return false
The protocol excludes equivocating shares from threshold computation.
Fallback Gossip
Witnesses periodically exchange proposals with random peers.
OnPeriodic(cid) for fallback gossip when decided[cid] = false:
peers := SampleRandomSubset(W \ {w}, k)
For each p in peers:
Send AggregateShare(cid, proposals, EvidenceDelta(cid)) to p
Gossip fanout k controls redundancy. Typical values are 3-5.
Threshold Checking
Witnesses check for threshold completion after each update.
CheckThreshold(cid):
if decided.get(cid, false) = true:
return
For each ((rid, pre_hash), S) in proposals:
if |S| ≥ t:
sig := CombineShares({ sh | (_, sh) in S })
if VerifyThresholdSig(rid, sig):
attesters := { w' | (w', _) in S }
CommitFact(cid, rid, sig, attesters)
For all v in W:
Send ThresholdComplete(cid, rid, sig, attesters, EvidenceDelta(cid)) to v
decided[cid] := true
return
Any witness reaching threshold broadcasts the commit fact. The first valid threshold signature wins.
9. Integration with Journals
Consensus emits commit facts. Journals merge commit facts using set union. Reduction interprets commit facts as confirmed non-monotone events.
Account journals integrate commit facts that represent tree operations. Relational context journals integrate commit facts that represent guardian bindings or recovery grants.
Reduction remains deterministic. Commit facts simply appear as additional facts in the semilattice.
A commit fact is monotone even when the event it represents is non-monotone. This supports convergence.
9.1 Context Isolation and Guard Integration
Every consensus instance binds to a context identifier. The context provides isolation for capability checking and flow budget enforcement. Authority-scoped ceremonies derive context from authority identity. Relational ceremonies use explicit context identifiers from the relational binding.
The protocol integrates with the guard chain at message send boundaries. Guards evaluate before constructing messages. The guard chain sequences capability checks, flow budget charges, leakage tracking, and journal coupling. Journal facts commit at the runtime bridge layer after guard evaluation completes.
#![allow(unused)] fn main() { // Protocol evaluates guards before sending let guard = SignShareGuard::new(context_id, coordinator); let guard_result = guard.evaluate(effects).await?; if !guard_result.authorized { return Err(AuraError::permission_denied("Guard denied SignShare")); } // Construct and send message after guard approval let message = ConsensusMessage::SignShare { ... }; }
The dependency injection pattern passes effect systems as parameters. Protocol methods accept generic effect trait bounds. This enables testing with mock effects and production use with real implementations. The pattern avoids storing effects in protocol state.
10. Integration Points
Consensus is used for account tree operations that require strong agreement. Examples include membership changes and policy changes when local signing is insufficient.
Consensus is also used for relational context operations. Guardian bindings use consensus to bind authority state. Recovery grants use consensus to approve account modifications. Application specific relational contexts may also use consensus.
11. FROST Threshold Signatures
Consensus uses FROST to produce threshold signatures. Each witness holds a secret share. Witnesses compute partial signatures. The initiator or fallback proposer aggregates the shares. The final signature verifies under the group public key stored in the commitment tree. See Authority and Identity for details on the TreeState structure.
#![allow(unused)] fn main() { /// From crates/aura-consensus/src/messages.rs pub enum ConsensusMessage { SignShare { consensus_id: ConsensusId, /// The result_id (hash of execution result) this witness computed result_id: Hash32, share: PartialSignature, /// Optional commitment for the next consensus round (pipelining optimization) next_commitment: Option<NonceCommitment>, /// Epoch for commitment validation epoch: Epoch, }, // ... other message variants } }
Witness shares validate only for the current consensus instance. They cannot be replayed. Witnesses generate only one share per (consensus_id, prestate_hash).
The attester set in the commit fact contains only devices that contributed signing shares. This provides cryptographic proof of participation.
11.1 Integration with Tree Operation Verification
When consensus produces a commit fact for a tree operation, the resulting AttestedOp is verified using the two-phase model from aura-core::tree::verification:
- Verification (
verify_attested_op): Cryptographic check against theBranchSigningKeystored in TreeState - Check (
check_attested_op): Full verification plus state consistency validation
The binding message includes the group public key to prevent signature reuse attacks. This ensures an attacker cannot substitute a different signing key and replay a captured signature. See Tree Operation Verification for details.
#![allow(unused)] fn main() { // Threshold derived from policy at target node let threshold = state.get_policy(target_node)?.required_signers(child_count); // Signing key from TreeState let signing_key = state.get_signing_key(target_node)?; // Verify against stored key and policy-derived threshold verify_attested_op(&attested_op, signing_key, threshold, current_epoch)?; }
The verification step ensures signature authenticity. The check step validates state consistency. Both steps must pass before applying tree operations.
11.2 Type-Safe Share Collection
The implementation provides type-level guarantees for threshold signature aggregation. Share collection uses sealed and unsealed types to prevent combining signatures before reaching threshold. The type system enforces this invariant at compile time.
#![allow(unused)] fn main() { pub struct LinearShareSet { shares: BTreeMap<AuthorityId, PartialSignature>, sealed: bool, } pub struct ThresholdShareSet { shares: BTreeMap<AuthorityId, PartialSignature>, } }
The unsealed type accepts new shares via insertion. When threshold is reached the set seals into the threshold type. Only the threshold type provides the combine method. This prevents calling aggregation before sufficient shares exist.
The current protocol uses hash map based tracking for signature collection. The type-safe approach exists but awaits integration. Future work will replace runtime threshold checks with compile-time proofs. The sealed type pattern eliminates an entire class of bugs.
12. FROST Commitment Pipeline Optimization
The pipelined commitment optimization reduces steady-state consensus from 2 RTT (round-trip times) to 1 RTT by bundling next-round nonce commitments with current-round signature shares.
12.1 Overview
The FROST pipelining optimization improves consensus performance by bundling next-round nonce commitments with current-round signature shares. This allows the coordinator to start the next consensus round immediately without waiting for a separate nonce commitment phase.
Standard FROST Consensus (2 RTT):
- Execute → NonceCommit (1 RTT): Coordinator sends execute request, witnesses respond with nonce commitments
- SignRequest → SignShare (1 RTT): Coordinator sends aggregated nonces, witnesses respond with signature shares
Pipelined FROST Consensus (1 RTT) (after warm-up):
- Execute+SignRequest → SignShare+NextCommitment (1 RTT):
- Coordinator sends execute request with cached commitments from previous round
- Witnesses respond with signature share AND next-round nonce commitment
12.2 Core Components
WitnessState (aura-consensus/src/witness.rs) manages persistent nonce state for each witness:
#![allow(unused)] fn main() { pub struct WitnessState { /// Witness identifier witness_id: AuthorityId, /// Current epoch to detect when cached commitments become stale epoch: Epoch, /// Precomputed single-use nonces for the next consensus round next_nonce: Option<FrostNonces>, /// Active consensus instances this witness is participating in active_instances: HashMap<ConsensusId, WitnessInstance>, } }
Key methods:
get_next_commitment(): Returns cached commitment if valid for current epochtake_nonce(): Moves the cached nonces out for use in the current round
WitnessState is not Clone, because it owns FrostNonces. The orchestrator takes cached nonces through WitnessSet::take_witness_nonce, which moves them out under the state lock. Two rounds therefore cannot sign with the same nonces. Signing first retires the nonces (FrostNonces::retire) and then consumes the RetiredFrostNonces. See docs/122_ownership_model.md "Replay Protection".
set_next_nonce(): Stores new nonce for future useinvalidate(): Clears cached state on epoch change
Message schema updates: The SignShare message now includes optional next-round commitment:
#![allow(unused)] fn main() { SignShare { consensus_id: ConsensusId, share: PartialSignature, /// Optional commitment for the next consensus round (pipelining optimization) next_commitment: Option<NonceCommitment>, /// Epoch for commitment validation epoch: Epoch, } }
ConsensusProtocol (aura-consensus/src/protocol.rs) integrates the pipelining optimization via FrostConsensusOrchestrator and WitnessTracker. The pipelining logic is distributed across these components rather than isolated in a separate orchestrator.
Key methods:
run_consensus(): Determines fast path vs slow path based on cached commitmentscan_use_fast_path(): Checks if sufficient cached commitments availablehandle_epoch_change(): Invalidates all cached state on epoch rotation
12.3 Epoch Safety
All cached commitments are bound to epochs to prevent replay attacks:
- Epoch Binding: Each commitment is tied to a specific epoch
- Automatic Invalidation: Epoch changes invalidate all cached commitments
- Validation: Witnesses reject commitments from wrong epochs
#![allow(unused)] fn main() { // Epoch change invalidates all cached nonces if self.epoch != current_epoch { self.next_nonce = None; self.epoch = current_epoch; return None; } }
12.4 Fallback Handling
The system gracefully falls back to 2 RTT when:
- Insufficient Cached Commitments: Less than threshold witnesses have cached nonces
- Epoch Change: All cached commitments become invalid
- Witness Failures: Missing or invalid next_commitment in responses
- Initial Bootstrap: First round after startup (no cached state)
#![allow(unused)] fn main() { if has_quorum { // Fast path: 1 RTT using cached commitments self.run_fast_path(...) } else { // Slow path: 2 RTT standard consensus self.run_slow_path(...) } }
12.5 Performance Impact
Latency reduction:
- Before: 2 RTT per consensus
- After: 1 RTT per consensus (steady state)
- Improvement: 50% latency reduction
Message count:
- Before: 4 messages per witness (Execute, NonceCommit, SignRequest, SignShare)
- After: 2 messages per witness (Execute+SignRequest, SignShare+NextCommitment)
- Improvement: 50% message reduction
Trade-offs:
- Memory: Small overhead for caching one nonce per witness
- Complexity: Additional state management and epoch tracking
- Bootstrap: First round still requires 2 RTT
12.6 Implementation Guidelines
Adding pipelining to new consensus operations:
- Update message schema: Add
next_commitmentandepochfields to response messages - Generate next nonce: During signature generation, also generate next-round nonce
- Cache management: Store next nonce in
WitnessStatefor future use - Epoch handling: Always validate epoch before using cached commitments
Example witness flow:
#![allow(unused)] fn main() { // Move this round's nonces out of the shared state, retire them, sign once. let nonces = witness_set.take_witness_nonce(witness_id, epoch).await?; let share = orchestrator.sign_with_nonce(&transcript, share, nonces, &commitments).await?; // Cache fresh nonces for the next round; only the commitment is published. let next = witness_nonce(share, random).await?; let next_commitment = next.commitment().clone(); witness_set.update_witness_nonce(witness_id, next, epoch).await?; }
12.7 Security Considerations
- Nonce Reuse Prevention:
FrostNoncesis neitherClonenor serializable. It must be retired before it signs, and signing consumes it by value. Each nonce is tied to a specific epoch. - Epoch Isolation: Nonces from different epochs cannot be mixed
- Forward Security: Epoch rotation provides natural forward security boundary
- Availability: Fallback ensures consensus continues even without optimization
12.8 Testing Strategy
Unit tests:
- Epoch invalidation logic
- Nonce caching and retrieval
- Message serialization with new fields
Integration tests:
- Fast path vs slow path selection
- Epoch transition handling
- Performance measurement
Simulation tests:
- Network delay impact on 1 RTT vs 2 RTT
- Behavior under partial failures
- Convergence properties
12.9 Future Enhancements
- Adaptive Thresholds: Dynamically adjust quorum requirements based on cached state
- Predictive Caching: Pre-generate multiple rounds of nonces during idle time
- Compression: Batch multiple commitments in single message
- Cross-Context Optimization: Share cached state across related consensus contexts
13. Fallback Protocol Details
Fallback Trigger
The initiator can proactively trigger fallback when it detects conflicts.
Fallback_Trigger_Initiator(cid):
// Extract conflicts from shares (same prestate_hash, different rid)
conflicts := Map[(rid, prestate_hash) -> Set[(w, share)]]
For each (w, (rid, share, prestate_hash)) in shares:
conflicts[(rid, prestate_hash)] :=
conflicts.get((rid, prestate_hash), ∅) ∪ { (w, share) }
For all w in W:
Send Conflict(cid, conflicts, EvidenceDelta(cid)) to w
This optimization seeds fallback with known conflicts. Witnesses also start fallback independently on timeout.
Fallback Message Handlers
Witnesses process fallback messages to accumulate shares.
On Conflict(cid, conflicts, evidΔ) from any peer:
MergeEvidence(cid, evidΔ)
For each ((rid, pre_hash), S) in conflicts:
if not HasEquivocatedInSet(proposals, S, pre_hash):
proposals[(rid, pre_hash)] :=
proposals.get((rid, pre_hash), ∅) ∪ S
CheckThreshold(cid)
Fallback_Start(cid)
Conflict messages bootstrap the fallback phase. The witness merges non-equivocating shares.
On AggregateShare(cid, proposals', evidΔ) from any peer:
MergeEvidence(cid, evidΔ)
For each ((rid, pre_hash), S') in proposals':
For each (w', sh') in S':
if not HasEquivocated(proposals, w', cid, pre_hash, rid):
proposals[(rid, pre_hash)] :=
proposals.get((rid, pre_hash), ∅) ∪ { (w', sh') }
CheckThreshold(cid)
Aggregate shares spread proposal sets through gossip. Each witness checks for threshold after updates. Threshold-complete messages carry the final aggregated signature. Once validated, the witness commits and stops its timers.
14. Safety Guarantees
Consensus satisfies agreement. At most one commit fact forms for a given (cid, prestate_hash). The threshold signature ensures authenticity. No attacker can forge a threshold signature without the required number of shares.
Consensus satisfies validity. A commit fact references a result computed from the agreed prestate. All honest witnesses compute identical results. Malformed shares are rejected.
Consensus satisfies deterministic convergence. Evidence merges through CRDT join. All nodes accept the same commit fact.
Formal Verification Status
These properties are formally verified through complementary approaches:
-
Lean 4 Proofs (
verification/lean/Aura/Consensus/):Agreement.agreement: Unique commit per consensus instanceValidity.validity: Committed values bound to prestatesValidity.prestate_binding_unique: Hash collision resistance for prestate bindingEquivocation.detection_soundness: Conflicting signatures are detectable
-
Quint Model Checking (
verification/quint/protocol_consensus*.qnt):AllInvariants: Combined safety properties pass 1000-sample model checkingInvariantByzantineThreshold: Byzantine witnesses bounded below thresholdInvariantEquivocationDetected: Equivocation detection correctnessInvariantProgressUnderSynchrony: Liveness under partial synchrony
See verification/quint/ and verification/lean/ for verification artifacts and run notes.
Binding Message Security
The binding message for tree operations includes the group public key. This prevents key substitution attacks where an attacker captures a valid signature and replays it with a different key they control. The full binding includes:
- Domain separator for domain isolation
- Parent epoch and commitment for replay prevention
- Protocol version for upgrade safety
- Current epoch for temporal binding
- Group public key for signing group binding
- Serialized operation content
This security property is enforced by compute_binding_message() in the verification module.
15. Liveness Guarantees
The fast path completes in one round trip when the initiator and witnesses are online. The fallback path provides eventual completion under asynchrony. Gossip ensures that share proposals propagate across partitions.
The protocol does not rely on stable leaders. No global epoch boundaries exist. Witnesses can rejoin by merging the journal fact set.
Fallback State Diagram
stateDiagram-v2
[*] --> FastPath
FastPath --> FallbackPending: timeout or conflict
FallbackPending --> FallbackGossip: send Conflict/AggregateShare
FallbackGossip --> Completed: threshold signature assembled
FastPath --> Completed: Commit broadcast
Completed --> [*]
- FastPath: initiator collecting shares.
- FallbackPending: timer expired or conflicting
(rid, prestate_hash)observed. - FallbackGossip: witnesses exchange proposal sets until
CheckThresholdsucceeds. - Completed: commit fact accepted and timers stopped.
Design Trade-offs: Latency vs Availability
The two protocol paths optimize for different objectives:
| Property | Fast Path | Slow Path |
|---|---|---|
| Primary Goal | Latency (speed) | Availability (robustness) |
| Completion Time | 2δ (network speed) | Eventual (no tight bound) |
| Synchrony Assumption | Yes (GST reached) | No (works during partitions) |
| Coordination | Leader-driven (initiator) | Leaderless gossip |
| Failure Tolerance | Requires all/most online | Tolerates n-k failures |
Why leaderless gossip for fallback:
We intentionally sacrifice tight timing bounds (the theoretical 2Δ from optimal protocols) for:
-
Partition tolerance: Any connected component with k honest witnesses can complete independently. No leader election needed across partitions.
-
No single point of failure: If the initiator fails, any witness can drive completion. View-based protocols require leader handoff.
-
Simpler protocol: No view numbers, no leader election, no synchronization barriers. Witnesses simply gossip until threshold is reached.
-
Natural CRDT integration: Evidence propagates as a CRDT set. Gossip naturally merges evidence without coordination.
What we can prove:
- Fast path: Commits within 2δ when all witnesses online (verified:
TemporalFastPathBound) - Slow path: Commits when any connected component has k honest witnesses (not time-bounded)
- Safety: Always holds regardless of network conditions
What we cannot prove (by design):
- Slow path completion in fixed time (would require synchrony assumption)
- Termination under permanent partition (FLP impossibility)
Parameter Guidance
T_fallback: set to roughly 2-3 times the median witness RTT. Too aggressive causes unnecessary fallback. Too lax delays recovery when an initiator stalls.- Gossip fanout
f: see the fanout adequacy analysis below for principled selection. - Gossip interval: 250-500 ms is a good default. Ensure at least a few gossip rounds occur before timers retrigger. This gives the network time to converge.
These parameters should be tuned per deployment. The ranges above keep fallback responsive without overwhelming the network.
Fanout Adequacy for Slow Path
The slow path requires the gossip network to be connected for evidence propagation. The key question is how many gossip peers (fanout f) are needed.
Random graph connectivity theory:
For a random graph G(n, p) to be connected with high probability (w.h.p.), the classical Erdős-Rényi result states:
p ≥ (1 + ε) × ln(n) / n for any ε > 0
Translating to gossip: each node selects f random peers, giving edge probability p ≈ f/n. For connectivity:
f ≥ c × ln(n) where c ≈ 1.1-1.2 for practical certainty
Recommended fanout by witness count:
| Witnesses (n) | Minimum Fanout (f) | Recommended | Notes |
|---|---|---|---|
| 3 | 2 | 2 | All must connect (fully connected) |
| 5 | 2 | 3 | ln(5) ≈ 1.6, add margin |
| 7 | 3 | 3-4 | ln(7) ≈ 1.9 |
| 10 | 3 | 4 | ln(10) ≈ 2.3 |
| 15 | 4 | 4-5 | ln(15) ≈ 2.7 |
| 21 | 4 | 5 | ln(21) ≈ 3.0 |
| 50 | 5 | 6 | ln(50) ≈ 3.9 |
Failure tolerance:
With fanout f and n witnesses, the graph remains connected under random node failures as long as:
- At least
f + 1nodes remain (sufficient edges for spanning tree) - Failed nodes are randomly distributed (not targeted attacks)
For k-of-n threshold where k ≤ n - f:
- The
khonest witnesses form a connected subgraph w.h.p. - Each honest witness can reach at least one other honest witness via gossip
- Evidence propagates to all honest witnesses in O(log(n)) gossip rounds
Adversarial considerations:
Random graph analysis assumes non-adversarial peer selection. Against Byzantine adversaries:
- Eclipse attacks: If adversary controls gossip peer selection, connectivity guarantees fail
- Mitigation: Use deterministic peer selection based on witness IDs (e.g., consistent hashing)
- Stronger bound: For Byzantine tolerance, use
f ≥ 2t + 1where t is Byzantine threshold
Verified properties (Quint):
The following properties are model-checked in protocol_consensus_liveness.qnt:
PropertyQuorumSufficient: k honest witnesses in same connected component can progressPropertyPartitionTolerance: largest connected component with k honest succeedsAvailabilityGuarantee: combined availability invariant
With adequate fanout, these properties ensure slow path completion when quorum exists.
16. Relation to FROST
Consensus uses FROST as the final stage of agreement. FROST ensures that only one threshold signature exists per result. FROST signatures provide strong cryptographic proof.
Consensus and FROST remain separate. Consensus orchestrates communication. FROST proves final agreement. Combining the two yields a single commit fact.
17. Operation Categories
Not all operations require consensus. Aura classifies operations into three categories based on their security requirements and execution timing.
17.1 Category A: Optimistic Operations
Operations that can proceed immediately without consensus. These use CRDT facts with eventual consistency.
Characteristics:
- Immediate local effect
- Background sync via anti-entropy
- Failure shows indicator, doesn't block functionality
- Partial success is acceptable
Examples:
- Send message (within established context)
- Create channel (within established relational context)
- Update channel topic
- Block/unblock contact
- Pin message
These operations work because the cryptographic context already exists. Keys derive deterministically from shared journal state. No new agreement is needed.
17.2 Category B: Deferred Operations
Operations that apply locally but require agreement for finalization. Effect is pending until confirmed.
Characteristics:
- Immediate local effect shown as "pending"
- Background ceremony for agreement
- Failure triggers rollback with user notification
- Multi-moderator operations use this pattern
Examples:
- Change channel permissions (requires moderator consensus)
- Remove channel member (may be contested)
- Transfer channel ownership
- Rename channel
17.3 Category C: Consensus-Gated Operations
Operations where partial state is dangerous. These block until consensus completes.
Characteristics:
- Operation does NOT proceed until consensus achieved
- Partial state would be dangerous or irrecoverable
- User must wait for confirmation
Examples:
- Guardian rotation (key shares distributed atomically)
- Recovery execution (account state replacement)
- OTA hard fork activation (breaking protocol change)
- Device revocation (security-critical removal)
- Add contact / Create group (establishes cryptographic context)
- Add member to group (changes group encryption keys)
These use Aura Consensus as described in this document.
17.4 Decision Tree
Does this operation establish or modify cryptographic relationships?
│
├─ YES: Does the user need to wait for completion?
│ │
│ ├─ YES (new context, key changes) → Category C (Consensus)
│ │ Examples: add contact, create group, guardian rotation
│ │
│ └─ NO (removal from existing context) → Category B (Deferred)
│ Examples: remove from group, revoke device
│
└─ NO: Does this affect other users' access or policies?
│
├─ YES: Is this high-security or irreversible?
│ │
│ ├─ YES → Category B (Deferred)
│ │ Examples: transfer ownership, delete channel
│ │
│ └─ NO → Category A (Optimistic)
│ Examples: pin message, update topic
│
└─ NO → Category A (Optimistic)
Examples: send message, create channel, block contact
17.5 Key Insight
Ceremonies establish shared cryptographic context. Operations within that context are cheap.
Once a relational context exists (established via Category C invitation ceremony), channels and messages within that context are Category A. The expensive part is establishing WHO is in the relationship. Once established, operations WITHIN the relationship derive keys deterministically from shared state.
The optimistic-path design follows the same effect-policy integration described throughout this document: cheap operations are permitted only after the shared cryptographic context has been established by the ceremony boundary.
18. BFT‑DKG Transcript Finalization (K3)
Consensus is also used to finalize BFT-DKG transcripts. The output of the DKG is a DkgTranscriptCommit fact that is consensus-finalized and then merged into the relevant journal.
Inputs:
DkgConfig:epoch,threshold,max_signers,participants,membership_hash.DealerPackage[]: one package per dealer, containing encrypted shares for all participants and a deterministic commitment.prestate_hashandoperation_hash: bind the transcript to the authority/context state and the intended ceremony operation.
Transcript formation:
- Validate
DkgConfigand dealer packages (unique dealers, complete share sets). - Assemble the transcript deterministically.
- Hash the transcript using canonical DAG-CBOR encoding.
Finalize with consensus:
- Build
DkgTranscriptCommitwith:transcript_hashblob_ref(optional, if stored out‑of‑line)prestate_hashoperation_hashconfigandparticipants
- Run consensus over the commit fact itself.
- Insert both
CommitFactevidence and theDkgTranscriptCommitfact into the authority or context journal.
The transcript commit is the single durable artifact used to bootstrap all subsequent threshold operations. Any K3 ceremony that depends on keys must bind to this commit by reference (direct hash or blob ref).
19. Decentralized Coordinator Selection (Lottery)
Coordinator-based fast paths (A2) require a deterministic, decentralized selection mechanism so every participant can independently derive the same leader without extra coordination.
Round seed:
round_seedis a 32‑byte value shared by all participants for the round.- Sources:
- VRF output (preferred when available).
- Trusted oracle or beacon.
- Initiator‑provided seed (acceptable in trusted settings).
Selection rule:
score_i = H("AURA_COORD_LOTTERY" || round_seed || authority_id_i)
winner = argmin_i score_i
Fencing and safety:
- The coordinator must hold a monotonic fencing token (
coord_epoch). - Proposals are rejected if
coord_epochdoes not advance or ifprestate_hashmismatches local state.
Convergence:
- Coordinators emit a
ConvergenceCertonce a quorum acks the proposal. - Fast-path results remain soft-safe until a consensus
CommitFactis merged.
20. Summary
Aura Consensus produces monotone commit facts that represent non-monotone operations. It integrates with journals through set union. It uses FROST threshold signatures and CRDT evidence structures. It provides agreement, validity, and liveness. It supports authority updates and relational operations. It requires no global log and no central coordinator.
The helper HasEquivocatedInSet excludes conflict batches that contain conflicting signatures from the same witness. Fallback_Start transitions the local state machine into fallback mode and arms gossip timers. Implementations must provide these utilities alongside the timers described earlier.
See Also
- Operation Categories - When consensus is required and ceremony lifecycle
- Relational Contexts - Consensus integration for relational operations
Operation Categories
This document defines the three-tier classification system for distributed operations in Aura. It specifies the ceremony contract for Category C operations, the consistency metadata types for each category, and the decision framework for categorizing new operations. The core insight is that not all operations require consensus. Many can proceed optimistically with background reconciliation.
1. Overview
Operations in Aura fall into three categories based on their effect timing and security requirements.
| Category | Name | Effect Timing | When Used |
|---|---|---|---|
| A | Optimistic | Immediate local effect | Low-risk operations within established contexts |
| B | Deferred | Pending until confirmed | Medium-risk policy/membership changes |
| C | Consensus-Gated | Blocked until ceremony completes | Cryptographic context establishment |
Agreement modes are orthogonal to categories. Operations can use provisional or soft-safe fast paths, but any durable shared state must be consensus-finalized (A3). See Consensus for the fast-path and finalization taxonomy.
1.1 Key Generation Methods
Aura separates key generation from agreement:
| Code | Method | Description |
|---|---|---|
| K1 | Single-signer | No DKG required. Local key generation. |
| K2 | Dealer-based DKG | Trusted coordinator distributes shares. |
| K3 | Consensus-finalized DKG | BFT-DKG with transcript commit. |
| DKD | Distributed key derivation | Multi-party derivation without DKG. |
1.2 Agreement Levels
| Code | Level | Description |
|---|---|---|
| A1 | Provisional | Usable immediately but not final. |
| A2 | Coordinator Soft-Safe | Bounded divergence with convergence certificate. |
| A3 | Consensus-Finalized | Unique, durable, non-forkable. |
Fast paths (A1/A2) are provisional. Durable shared state must be finalized by A3.
1.3 The Key Architectural Insight
Ceremonies establish shared cryptographic context. Operations within that context are cheap.
Ceremony (Category C) Optimistic Operations (Category A)
───────────────────── ─────────────────────────────────
• Runs once per relationship • Within established context
• Establishes ContextId + shared roots • Derive keys from context
• Creates relational context journal • Just emit CRDT facts
• All future encryption derives here • No new agreement needed
2. Category A: Optimistic Operations
Category A operations have immediate local effect via CRDT fact emission. Background sync via anti-entropy propagates facts to peers. Failure shows a status indicator but does not block functionality. Partial success is acceptable.
2.1 Examples
| Operation | Immediate Action | Background Sync | On Failure |
|---|---|---|---|
| Create channel | Show channel, enable messaging | Fact syncs to members | Show "unsynced" badge |
| Send message | Display in chat immediately | Delivery receipts | Show "undelivered" indicator |
| Add contact (within context) | Show in list | Mutual acknowledgment | Show "pending" status |
| Block contact | Hide from view immediately | Propagate to context | Already effective locally |
| Update profile | Show changes immediately | Propagate to contacts | Show sync indicator |
| React to message | Show reaction | Fact syncs | Show "pending" |
2.2 Implementation Pattern
#![allow(unused)] fn main() { async fn create_channel_optimistic(&mut self, config: ChannelConfig) -> ChannelId { let channel_id = ChannelId::derive(&config); self.emit_fact(ChatFact::ChannelCheckpoint { channel_id, epoch: 0, base_gen: 0, window: 1024, }).await; channel_id } }
This pattern emits a fact into the existing relational context journal. The channel is immediately usable. Key derivation uses KDF(ContextRoot, ChannelId, epoch).
2.3 Why This Works
Category A operations work because encryption keys already exist (derived from established context), facts are CRDTs (eventual consistency is sufficient), no coordination is needed (shared state already agreed upon), and the worst case is delay rather than a security issue.
The CRDT property is a contract on the fact family, not on transport. Each family is reduced by a pure, order-independent function of its fact set: reversible state uses the observed-remove set, multi-value register and episode patterns, writers stamp causal metadata with a logical clock, and physical time is display-only. See the canonical domain fact model in docs/105_journal.md §4.2.1.
3. Category B: Deferred Operations
Category B operations have local effect pending until agreement is reached. The UI shows intent immediately with a "pending" indicator. Operations may require approval from capability holders. Automatic rollback occurs on rejection.
3.1 Examples
| Operation | Immediate Action | Agreement Required | On Rejection |
|---|---|---|---|
| Change channel permissions | Show "pending" | Moderator approval | Revert, notify |
| Remove channel member | Show "pending removal" | Moderator consensus | Keep member |
| Transfer ownership | Show "pending transfer" | Recipient acceptance | Cancel transfer |
| Rename channel | Show "pending rename" | Member acknowledgment | Keep old name |
| Archive channel | Show "pending archive" | Moderator approval | Stay active |
3.2 Implementation Pattern
#![allow(unused)] fn main() { async fn change_permissions_deferred( &mut self, channel_id: ChannelId, changes: PermissionChanges, ) -> ProposalId { let proposal = Proposal { operation: Operation::ChangePermissions { channel_id, changes }, requires_approval_from: vec![CapabilityRequirement::Role("moderator")], threshold: ApprovalThreshold::Any, timeout_ms: 24 * 60 * 60 * 1000, }; let proposal_id = self.emit_proposal(proposal).await; proposal_id } }
This pattern creates a proposal that does not apply the effect yet. The UI shows "pending" state. The effect applies when threshold approvals are received. Auto-revert occurs on timeout or rejection.
3.3 Approval Thresholds
#![allow(unused)] fn main() { pub enum ApprovalThreshold { Any, Unanimous, Threshold { required: u32 }, Percentage { percent: u8 }, } }
Any requires any single holder of the required capability. Unanimous requires all holders to approve. Threshold requires k-of-n approval. Percentage requires a percentage of holders.
4. Category C: Consensus-Gated Operations
Category C operations do NOT proceed until a ceremony completes. Partial state would be dangerous or irrecoverable. The user must wait for confirmation. These operations use choreographic protocols with session types, executed through Aura’s Telltale runtime.
4.1 Examples
| Operation | Why Blocking Required | Risk if Optimistic |
|---|---|---|
| Add contact (new relationship) | Creates cryptographic context | No shared keys possible |
| Create group | Multi-party key agreement | Inconsistent member views |
| Add member to group | Changes group keys | Forward secrecy violation |
| Device enrollment | Key shares distributed atomically | Partial enrollment unusable |
| Guardian rotation | Key shares distributed atomically | Partial rotation unusable |
| Recovery execution | Account state replacement | Partial recovery corruption |
| OTA hard fork | Scope-bound breaking protocol change | Explicit partition or rejected incompatible sessions outside the cutover scope |
| Device revocation | Security-critical removal | Attacker acts first |
4.2 Implementation Pattern
#![allow(unused)] fn main() { async fn add_contact(&mut self, invitation: Invitation) -> Result<ContactId> { let ceremony_id = self.ceremony_executor .initiate_invitation_ceremony(invitation) .await?; loop { match self.ceremony_executor.get_status(&ceremony_id)? { CeremonyStatus::Committed => { return Ok(ContactId::from_ceremony(&ceremony_id)); } CeremonyStatus::Aborted { reason } => { return Err(AuraError::ceremony_failed(reason)); } _ => { tokio::time::sleep(POLL_INTERVAL).await; } } } } }
This pattern blocks until the ceremony completes. The user sees progress UI during execution. Context is established only on successful commit.
5. Ceremony Contract
All Category C ceremonies follow a shared contract that ensures atomic commit/abort semantics.
5.1 Ceremony Phases
-
Compute prestate: Derive a stable prestate hash from the authority/context state being modified. Include the current epoch and effective participant set.
-
Propose operation: Define the operation being performed. Compute an operation hash bound to the proposal parameters.
-
Enter pending epoch: Generate new key material at a pending epoch without invalidating the old epoch. Store metadata for commit or rollback.
-
Collect responses: Send invitations/requests to participants. Participants respond using their full runtimes. Responses must be authenticated and recorded as facts.
-
Commit or abort: If acceptance/threshold conditions are met, commit the pending epoch and emit resulting facts. Otherwise abort, emit an abort fact with a reason, and leave the prior epoch active.
5.2 Ceremony Properties
All Category C ceremonies implement:
-
Prestate Binding:
CeremonyId = H(prestate_hash, operation_hash, nonce)prevents concurrent ceremonies on same state and ensures exactly-once semantics. -
Atomic Commit/Abort: Either fully committed or no effect. No partial state possible.
-
Epoch Isolation: Uncommitted key packages are inert. No explicit rollback needed on abort.
-
Session Types: Protocol compliance enforced at compile time via choreographic projection and enforced at runtime via Telltale adapter/VM execution.
5.3 Per-Ceremony Policy Matrix
Authority and Device Ceremonies
| Ceremony | Key Gen | Agreement | Fallback | Notes |
|---|---|---|---|---|
| Authority bootstrap | K1 | A3 | None | Local, immediate |
| Device enrollment | K2 | A1→A2→A3 | A1/A2 | Provisional → soft-safe → finalize |
| Device MFA rotation | K3 | A2→A3 | A2 | Consensus-finalized keys |
| Device removal | K3 | A2→A3 | A2 | Remove via rotation |
Guardian Ceremonies
| Ceremony | Key Gen | Agreement | Fallback | Notes |
|---|---|---|---|---|
| Guardian setup/rotation | K3 | A2→A3 | A2 | Consensus-finalized for durability |
| Recovery approval | A2→A3 | A2 | Soft-safe approvals → consensus | |
| Recovery execution | A2→A3 | A2 | Consensus-finalized commit |
Channel and Group Ceremonies
| Ceremony | Key Gen | Agreement | Fallback | Notes |
|---|---|---|---|---|
| AMP channel epoch bump | A1→A2→A3 | A1/A2 | Proposed → cert → commit | |
| AMP channel bootstrap | A1→A2→A3 | A1/A2 | Provisional → group key rotation | |
| Group/Block creation | K3 | A1→A2→A3 | A1/A2 | Provisional bootstrap → consensus |
| Rendezvous secure-channel | A1→A2→A3 | A1/A2 | Provisional → consensus |
Other Ceremonies
| Ceremony | Key Gen | Agreement | Fallback | Notes |
|---|---|---|---|---|
| Invitation (contact/channel/guardian) | A3 | None | Consensus-finalized only | |
| OTA activation | A2→A3 | A2 | Threshold-signed → consensus | |
| DKD ceremony | DKD | A2→A3 | A2 | Multi-party derivation → commit |
5.4 Bootstrap Exception
When creating a new group/channel before the group key ceremony completes, Aura allows a bootstrap epoch using a trusted-dealer key (K2/A1). The dealer distributes a bootstrap key with the channel invite, enabling immediate encrypted messaging. This is explicitly provisional and superseded by the consensus-finalized group key (K3/A3) once the ceremony completes.
5.5 AMP Channel Epoch Transition Refinement
AMP channel epoch transitions use the existing A1 -> A2 -> A3 agreement ladder with an AMP-specific live-state rule. This rule applies only to AMP channel epoch and membership state inside a relational context. It does not weaken authority-root membership, account commitment trees, guardian rotation, or recovery execution.
For a channel transition:
A1 observedmeans a syntactically valid successor proposal exists as a journal fact, but it has no live operational authority.A2Livemeans exactly one unsuppressed AMP-certified successor exists for the parent epoch and deterministic reduction exposes that successor as the live epoch for AMP send and receive policy.A3Finalizedmeans consensus-backed commit facts durably finalize a successor. The normal path finalizes the sametransition_idpreviously exposed asA2Live.
A2Live is operationally authoritative but non-durable. It may drive live AMP traffic before full A3 finalization, but durable shared state still requires the A3 consensus boundary described in Consensus.
Every AMP transition fact binds a canonical transition_id, a typed digest over:
context_idchannel_idparent_epochparent_commitmentsuccessor_epochsuccessor_commitmentmembership_commitmenttransition_policy
Proposals, A2 certificates, A3 commits, aborts, conflicts, and supersessions refer to the same transition only when this full identity matches. A different successor for the same parent is a conflicting transition.
The reducer states for a parent transition group are:
| State | Meaning |
|---|---|
Observed | Proposal facts exist, but no live certificate is valid. |
A2Live | Exactly one valid unsuppressed AMP certificate selects a successor. |
A2Conflict | Conflicting valid certificates or unresolved equivocation evidence suppress live exposure. |
A3Finalized | Consensus-backed commit finalizes one successor. |
A3Conflict | Conflicting durable commit evidence suppresses live exposure. |
Aborted | Explicit abort evidence invalidates the proposal for live use. |
Superseded | Authorized supersession replaces an earlier transition path. |
The reducer must never choose between conflicting valid A2 certificates by arrival order, local preference, wall-clock time, or deterministic tie-breaking. If facts do not prove a single winner, no live successor is exposed.
AMP transition policies distinguish additive and non-removal transitions from subtractive, removal, revocation, and emergency transitions. Additive transitions may permit bounded dual-epoch receive overlap. Subtractive and emergency transitions require stricter old-epoch acceptance so removed or suspected participants do not retain indefinite send authority.
Emergency AMP transitions are channel-scoped control-plane transitions:
EmergencyQuarantineTransitionexcludes a suspect from the successor epoch, cuts new sends over immediately, minimizes old-epoch receive grace, and rotates or erases old secret material aggressively.EmergencyCryptoshredTransitionuses the strongest channel-scoped bar and destroys ordinary pre-emergency readable state at theA2Livecutover boundary.
Emergency channel facts do not automatically remove authority-root membership or suspend recovery/governance rights. Those require separate authority-scoped governance facts and their own thresholds.
6. Consistency Metadata
Each operation category has a purpose-built status type for tracking consistency.
6.1 Core Types
#![allow(unused)] fn main() { pub enum Agreement { Provisional, SoftSafe { cert: Option<ConvergenceCert> }, Finalized { consensus_id: ConsensusId }, } pub enum Propagation { Local, Syncing { peers_reached: u16, peers_known: u16 }, Complete, Failed { retry_at: PhysicalTime, retry_count: u32, error: String }, } pub struct Acknowledgment { pub acked_by: Vec<AckRecord>, } }
Agreement indicates the finalization level (A1/A2/A3). Propagation tracks anti-entropy sync status. Acknowledgment tracks explicit per-peer delivery confirmation.
6.2 Category A: OptimisticStatus
#![allow(unused)] fn main() { pub struct OptimisticStatus { pub agreement: Agreement, pub propagation: Propagation, pub acknowledgment: Option<Acknowledgment>, } }
Use cases include send message, create channel, update profile, and react to message.
UI patterns:
◐Sending: propagation == Local✓Sent: propagation == Complete✓✓Delivered: acknowledgment.count() >= expected.len()◆Finalized: agreement == Finalized
6.3 Category B: DeferredStatus
#![allow(unused)] fn main() { pub struct DeferredStatus { pub proposal_id: ProposalId, pub state: ProposalState, pub approvals: ApprovalProgress, pub applied_agreement: Option<Agreement>, pub expires_at: PhysicalTime, } pub enum ProposalState { Pending, Approved, Rejected { reason: String, by: AuthorityId }, Expired, Superseded { by: ProposalId }, } }
Use cases include change permissions, remove member, transfer ownership, and archive channel.
6.4 Category C: CeremonyStatus
#![allow(unused)] fn main() { pub struct CeremonyStatus { pub ceremony_id: CeremonyId, pub state: CeremonyState, pub responses: Vec<ParticipantResponse>, pub prestate_hash: Hash32, pub committed_agreement: Option<Agreement>, } pub enum CeremonyState { Preparing, PendingEpoch { pending_epoch: Epoch, required_responses: u16, received_responses: u16 }, Committing, Committed { consensus_id: ConsensusId, committed_at: PhysicalTime }, Aborted { reason: CeremonyFailureReason, aborted_at: PhysicalTime }, Superseded { by: CeremonyId, reason: SupersessionReason }, } pub enum CeremonyFailureReason { Rejected, Cancelled, TimedOut, ChoreographyFailed, RuntimeFailed, Superseded, } }
Use cases include add contact, create group, guardian rotation, device enrollment, and recovery.
When a ceremony commits successfully, committed_agreement is set to Agreement::Finalized with the consensus ID, indicating A3 durability.
An issued invitation or enrollment code is the terminal result of code issuance, not the terminal result of the ceremony it starts. Enrollment completion has a separate operation instance linked to the ceremony ID. The initiator and invitee derive completion from the same authoritative ceremony outcome. A completion instance has exactly one terminal result: committed, cancelled, rejected, or timed out. The first terminal result is stable under duplicate, late, and replayed messages; a conflicting later result cannot replace it. Failure and cancellation carry stable, typed reasons independently of display text. An unauthenticated response cannot terminate a valid ceremony.
An enrollment request must match the issued invitation's subject authority, invitation, ceremony, target device and pending epoch. Successful confirmation must identify that same invitation and ceremony, explicitly establish enrollment, and carry the expected resulting epoch. A mismatch is a typed failure rather than an observation of completion. Matching message contents alone does not establish authentication or commit provenance.
Enrollment setup statements bind the exporting authority, physical device, request nonce, bounded validity interval, signing epoch, signing mode, threshold policy and public key package in a dedicated canonical signing transcript. Possession verification requires the proof's epoch and package to match that statement and produces sealed, non-deserializable evidence. This evidence certifies possession of the embedded key only. Association with the intended physical device requires explicit user transfer or an independently authenticated binding; decoding or self-certification cannot establish that association.
The initiator retains the selected setup statement and digest with its subject, ceremony, pending epoch and physical initiator before admitting response owners. Enrollment acceptance requires proof under that retained provisional package, epoch, mode and signer policy. A missing verifier record, unknown record version, corrupt binding or response-supplied substitute key cannot count a participant. The setup expiry gates issuance; an admitted response remains subject to the invitation and ceremony deadline. Persisted verifier selection alone does not prove baseline authentication, authenticated refusal, nonce consumption, first-decision persistence or atomic activation.
Issuance reserves its invitation identity before fact preparation or delivery. The reservation has one physical issuer and is consumed by the preparation owner. The complete signed payload binds that identity before publication; later payload repair cannot change an already committed invitation. Invalid or overflowing expiration fails before preparation mutates authoritative state.
A signed setup admission includes the setup nonce/digest, both device identities, subject and provisional authority, invitation/ceremony, pending epoch, manifest digest and exact-parent verifier inventory digest. Its expected verification key comes from the independently pinned manifest inventory at the exact prestate; the pending enrollment package and the receipt's embedded key are insufficient. Signature-only evidence remains separate from authenticated admission provenance. An invitee response owner requires that provenance and locally owned admission and revocation state before selecting a retained historical signing share.
6.5 Unified Consistency Type
For cross-category queries and generic handling:
#![allow(unused)] fn main() { pub struct Consistency { pub category: OperationCategory, pub agreement: Agreement, pub propagation: Propagation, pub acknowledgment: Option<Acknowledgment>, } pub enum OperationCategory { Optimistic, Deferred { proposal_id: ProposalId }, Ceremony { ceremony_id: CeremonyId }, } }
7. Ceremony Supersession
When a new ceremony replaces an old one, Aura emits explicit supersession facts that propagate via anti-entropy.
7.1 Supersession Reasons
#![allow(unused)] fn main() { pub enum SupersessionReason { PrestateStale, NewerRequest, ExplicitCancel, Timeout, Precedence, } }
PrestateStale indicates the prestate changed while the ceremony was pending. NewerRequest indicates an explicit newer request from the same initiator. ExplicitCancel indicates manual cancellation by an authorized participant. Timeout indicates the ceremony exceeded its validity window. Precedence indicates a concurrent ceremony won via conflict resolution.
7.2 Supersession Facts
Each ceremony fact enum includes a CeremonySuperseded variant:
#![allow(unused)] fn main() { CeremonySuperseded { superseded_ceremony_id: String, superseding_ceremony_id: String, reason: String, trace_id: Option<String>, timestamp_ms: u64, } }
7.3 CeremonyTracker API
The CeremonyTracker in aura-agent maintains supersession records for auditability:
| Method | Purpose |
|---|---|
supersede(old_id, new_id, reason) | Record a supersession event |
check_supersession_candidates(prestate_hash, op_type) | Find stale ceremonies |
get_supersession_chain(ceremony_id) | Get full supersession history |
is_superseded(ceremony_id) | Check if ceremony was replaced |
Supersession facts propagate via the existing anti-entropy mechanism. Peers receiving a CeremonySuperseded fact update their local ceremony state accordingly.
8. Decision Tree
Use this tree to categorize new operations:
Does this operation establish or modify cryptographic relationships?
│
├─ YES: Does the user need to wait for completion?
│ │
│ ├─ YES (new context, key changes) → Category C (Blocking Ceremony)
│ │ Examples: add contact, create group, guardian rotation
│ │
│ └─ NO (removal from existing context) → Category B (Deferred)
│ Examples: remove from group (epoch rotation in background)
│
└─ NO: Does this affect other users' access or policies?
│
├─ YES: Is this high-security or irreversible?
│ │
│ ├─ YES → Category B (Deferred)
│ │ Examples: transfer ownership, delete channel, kick member
│ │
│ └─ NO → Category A (Optimistic)
│ Examples: pin message, update topic
│
└─ NO → Category A (Optimistic)
Examples: send message, create channel, block contact
9. UI Feedback Patterns
9.1 Category A: Instant Result with Sync Indicator
┌───────────────────────────────────┐
│ You: Hello everyone! ◆ ✓✓ │ ← Finalized + Delivered
│ You: Check this out ✓✓ │ ← Delivered (not yet finalized)
│ You: Another thought ✓ │ ← Sent
│ You: New idea ◐ │ ← Sending
└───────────────────────────────────┘
Effect already applied. Indicators show delivery status (◐ → ✓ → ✓✓ → ✓✓ blue) and finalization (◆ appears when A3 consensus achieved).
9.2 Category B: Pending Indicator
┌─────────────────────────────────────────────────────────────────────┐
│ Channel: #project │
├─────────────────────────────────────────────────────────────────────┤
│ Pending: Remove Carol (waiting for Bob to confirm) │
├─────────────────────────────────────────────────────────────────────┤
│ Members: │
│ Alice (moderator) ✓ │
│ Bob (moderator) ✓ │
│ Carol ✓ ← Still has access until confirmed │
└─────────────────────────────────────────────────────────────────────┘
Proposal shown. Effect NOT applied yet.
9.3 Category C: Blocking Wait
┌─────────────────────────────────────────────────────────────────────┐
│ Adding Bob to group... │
│ │
│ ✓ Invitation sent │
│ ✓ Bob accepted │
│ ◐ Deriving group keys... │
│ ○ Ready │
│ │
│ [Cancel] │
└─────────────────────────────────────────────────────────────────────┘
User waits. Cannot proceed until ceremony completes.
10. Effect Policy Configuration
Operations use configurable policies that reference the capability system:
#![allow(unused)] fn main() { pub struct EffectPolicy { pub operation: OperationType, pub timing: EffectTiming, pub security_level: SecurityLevel, } pub enum EffectTiming { Immediate, Deferred { requires_approval_from: Vec<CapabilityRequirement>, timeout_ms: u64, threshold: ApprovalThreshold, }, Blocking { ceremony: CeremonyType, }, } }
10.1 Context-Specific Overrides
Contexts can override default policies:
#![allow(unused)] fn main() { // Strict security channel: unanimous moderator approval for kicks channel.set_effect_policy(RemoveFromChannel, EffectTiming::Deferred { requires_approval_from: vec![CapabilityRequirement::Role("moderator")], timeout_ms: 48 * 60 * 60 * 1000, threshold: ApprovalThreshold::Unanimous, }); // Casual channel: any moderator can kick immediately channel.set_effect_policy(RemoveFromChannel, EffectTiming::Immediate); }
11. Full Operation Matrix
| Operation | Category | Effect Timing | Security | Notes |
|---|---|---|---|---|
| Within Established Context | ||||
| Send message | A | Immediate | Low | Keys already derived |
| Create channel | A | Immediate | Low | Just facts into context |
| Update topic | A | Immediate | Low | CRDT, last-write-wins |
| React to message | A | Immediate | Low | Local expression |
| Local Authority | ||||
| Block contact | A | Immediate | Low | Your decision |
| Mute channel | A | Immediate | Low | Local preference |
| Policy Changes | ||||
| Change permissions | B | Deferred | Medium | Others affected |
| Kick from channel | B | Deferred | Medium | Affects access |
| Archive channel | B | Deferred | Low-Med | Reversible |
| High Risk | ||||
| Transfer ownership | B | Deferred | High | Irreversible |
| Delete channel | B | Deferred | High | Data loss |
| Remove from context | B | Deferred | High | Affects encryption |
| Cryptographic | ||||
| Add contact | C | Blocking | Critical | Creates context |
| Create group | C | Blocking | Critical | Multi-party keys |
| Add group member | C | Blocking | Critical | Changes group keys |
| Device enrollment | C | Blocking | Critical | DeviceEnrollment choreography |
| Guardian rotation | C | Blocking | Critical | Key shares |
| Recovery execution | C | Blocking | Critical | Account state |
| Device revocation | C | Blocking | Critical | Security response |
12. Common Mistakes to Avoid
Mistake 1: Making Everything Category C
Wrong: "Adding a channel member requires ceremony"
Right: If the member is already in the relational context, it is Category A. Just emit a fact. Only if they need to join the context first is it Category C.
Mistake 2: Forgetting Context Existence
Wrong: Trying to create a channel before establishing relationship
Right: Contact invitation (Category C) must complete before any channel operations (Category A) are possible.
Mistake 3: Optimistic Key Operations
Wrong: "User can start using new guardians while ceremony runs"
Right: Guardian changes affect key shares. Partial state means unusable keys. Must be Category C.
Mistake 4: Blocking on Low-Risk Operations
Wrong: "Wait for all members to confirm before showing channel"
Right: Channel creation is optimistic. Show immediately, sync status later.
See Also
- Consensus for fast path and fallback consensus
- Journal for fact semantics and reduction flows
- Aura Messaging Protocol (AMP) for channel encryption and key derivation
- Relational Contexts for context vs channel distinction
- MPST and Choreography for session types in Category C
- Transport and Information Flow for sync status tracking
- Effect System for effect policies
Enrollment manifest ownership
Exporting setup or manifest transfer material is read-only with respect to enrollment business state. Invitation reservation and pending generation ownership precede key writes; signed manifest retention precedes invitation publication. Import admission requires the app-issued explicit transfer selection and produces a runtime-private, non-deserializable witness. The bootstrap session consumes that witness without changing global transport identity or durable membership. Enrollment acceptance and activation require their separate verified response and registered generation permissions.
The app owns the complete manifest-pin, import, acceptance, and convergence lifecycle under one ImportDeviceEnrollmentCode operation. Frontends transfer submission ownership before the first awaited workflow step. Missing transfer input is a typed terminal failure before import mutation. Browser persistence consumes only the app-issued completed enrollment result after acceptance and adoption; received authority/device identifiers cannot stage that result.
Enrollment invitee adoption is the application of an authenticated committed ceremony result. Its local persistence and signing-context activation consume runtime-owned durable confirmation evidence for the exact imported generation. They are not independent agreement operations, and local accepted status or receipt locator fields do not authorize adoption. Generic key-rotation commit is not an alternate enrollment activation path.
Enrollment initiation under an active quorum
Preparing an enrollment signing intent retains the original issuer allocation and establishes neither enrollment success nor local signing consent. Each active physical participant independently approves the exact manifest, public transport commitment, initial Request, issuer return mailbox statement and finite negative terminal policy under its current authenticated policy. Resuming that allocation may produce a pending enrollment code only after the four initiation signatures verify. The policy is conditional consent, not a fifth initiation signature. A later Failed control also requires the original protected first negative decision and retained participant custody. Committed control, durable membership and invitee activation retain their separate agreement and evidence requirements.
MPST and Choreography
This document describes the architecture of choreographic protocols in Aura. It explains how global protocols are defined, projected, and executed. It defines the structure of local session types, the integration with the Effect System, and the use of guard chains and journal coupling.
1. DSL and Projection
Aura defines global protocols using the tell! macro. The macro parses a global specification into an abstract syntax tree. The macro produces code that represents the protocol as a choreographic structure. The source of truth for protocols is a .tell file stored next to the Rust module that loads it.
Projection converts the global protocol into per-role local session types. Each local session type defines the exact sequence of sends and receives for a single role. Projection eliminates deadlocks and ensures that communication structure is correct.
#![allow(unused)] fn main() { tell!(include_str!("example.tell")); }
Example file: example.tell
module example exposing (Example)
protocol Example =
roles A, B
A -> B : Msg(data: Vec<u8>)
B -> A : Ack(code: u32)
This snippet defines a global protocol with two roles. Projection produces a local type for A and a local type for B. Each local type enforces the required ordering at compile time.
2. Local Session Types
Local session types describe the allowed actions for a role. Each send and receive is represented as a typed operation. Local types prevent protocol misuse by ensuring that nodes follow the projected sequence.
Local session types embed type-level guarantees. These guarantees prevent message ordering errors. They prevent unmatched sends or receives. Each protocol execution must satisfy the session type.
#![allow(unused)] fn main() { type A_Local = Send<B, Msg, Receive<B, Ack, End>>; }
This example shows the projected type for role A. The type describes that A must send Msg to B and then receive Ack.
3. Runtime Integration
Aura executes production choreographies through the Telltale protocol machine. The tell! macro emits the global type, projected local types, role metadata, and composition metadata that the runtime uses to build protocol-machine code images. AuraChoreoEngine in crates/aura-agent/src/runtime/choreo_engine.rs is the production runtime surface.
Aura targets the current public Telltale language/runtime surface directly. Generated code is sourced from .tell files, projected through the public session-type model, and admitted into the protocol machine without an Aura-local runner compatibility layer. For the upstream capability, finalization, semantic-handoff, and runtime-upgrade contract that this runtime model assumes, see Telltale docs/38_capability_model.md.
Generated runners still expose role-specific execution helpers. Aura keeps those helpers for tests, focused migration utilities, and narrow tooling paths. They are not the production execution boundary.
Generated runtime artifacts also carry the data that production startup needs:
provide_messagefor outbound payloadsselect_branchfor choice decisions- protocol id and determinism policy reference
- required capability keys
- link and delegation constraints
- operational-envelope selection inputs
These values are sourced from runtime state such as params, journal facts, UI inputs, and manifest-driven admission state.
Aura has one production choreography backend:
- protocol-machine backend (
AuraChoreoEngine) for admitted Telltale runtime execution, replay, and parity checks.
Sessions run in Telltale nullifier replay mode, and frames are admitted by consumed owner-minted admissions; see Ownership Model.
The authoritative async ownership contract for how aura-agent hosts these sessions lives in crates/aura-agent/ARCHITECTURE.md.
That contract is intentionally split:
- actor services structure the long-lived host runtime
- move semantics define fragment, session, and endpoint ownership transfer
This distinction matters because delegate is not merely another actor message.
Direct generated-runner execution is test and migration support only.
Production runtime ownership is fragment-scoped. The admitted unit is one protocol fragment derived from the generated CompositionManifest. A manifest without link metadata yields one protocol fragment. A manifest with link metadata yields one fragment per linked bundle.
delegate and link define how ownership moves. Local runtime services claim fragment ownership through AuraEffectSystem. Runtime transfer goes through ReconfigurationManager. The runtime rejects ambiguous local ownership before a transfer reaches the protocol machine.
That rejection is fail-closed. Aura rejects stale or forged owner capabilities, rejects mismatched transfer evidence, and binds timeout expiry to issued timeout witnesses rather than reconstructing expiry from a later host-side elapsed-time guess.
The host runtime may use actor services to supervise the surrounding work, but fragment ownership itself remains a singular move boundary with stale-owner rejection.
Supervised local session bindings use the opaque execution identity issued by actual bounded runtime task registration. That identity remains stable across suspension and executor migration, and distinguishes sibling groups even when their local task counters coincide. Poll and destruction scopes restore their caller before returning to the executor. Observing the identity grants neither task admission nor fragment, peer, or signing authority. Browser siblings must not derive session ownership from their shared executor thread.
Owner record and capability are also distinct here:
- ownership answers which local runtime currently owns the fragment
- capability answers which fragment-scoped effects that owner may drive
Delegation must define both the ownership handoff and the capability scope that moves with it.
Host-side async code must preserve that ownership model. External network, timer, and callback work enters through canonical ingress and is routed to the current local owner before any session mutation occurs.
VmBridgeEffects is the synchronous host boundary for one fragment. Protocol-machine callbacks use it for session-local payload queues, blocked receive snapshots, and scheduler signals. Async transport, journal, and storage work stay outside the callback path in the host bridge loop.
4. Choreography Annotations and Effect Commands
Choreographies support annotations that modify runtime behavior. The tell! macro extracts these annotations and generates EffectCommand sequences. This follows the choreography-first architecture where choreographic annotations are the canonical source of truth for guard requirements.
Supported Annotations
| Annotation | Description | Generated Effect |
|---|---|---|
guard_capability = "namespace:capability" | Canonical capability requirement | StoreMetadata (audit trail) |
flow_cost = N | Flow budget charge | ChargeBudget |
journal_facts = "fact" | Journal fact recording | StoreMetadata (fact key) |
journal_merge = true | Request journal merge | StoreMetadata (merge flag) |
audit_log = "event" | Audit trail entry | StoreMetadata (audit key) |
leak = "External" | Leakage tracking | RecordLeakage |
guard_capability is the string boundary for choreography DSL input. The macro
parses it into a validated CapabilityName and rejects legacy, unnamespaced,
or invalid values at compile time. Outside the DSL boundary, first-party Rust
code should use typed capability families rather than hand-written strings.
See Choreography Development Guide for annotation syntax and usage, including protocol artifact requirements, dynamic reconfiguration, protocol evolution compatibility policy, termination budgets, effect command generation, macro output contracts, and effect interpreter integration.
5. Guard Chain Integration
Choreography annotations compile to EffectCommand sequences that feed the same guard chain used at runtime send sites (CapGuard, FlowGuard, JournalCoupler, LeakageTracker). Annotation-derived effects execute first, then runtime guards validate and charge budgets before transport. Guard evaluation is synchronous over a prepared GuardSnapshot and yields EffectCommand items interpreted asynchronously.
See Choreography Development Guide for guard chain integration patterns.
6. Execution Modes
Aura supports multiple execution environments for the same choreography definitions. Production execution uses admitted VM sessions with real effect handlers. Simulation execution uses deterministic time and fault injection. Test utilities may use narrower runner surfaces when that improves isolation.
Each environment preserves the same protocol structure and admission semantics where applicable. Choreography execution also captures conformance artifacts for native/WASM parity testing. See Test Infrastructure Reference for artifact surfaces and effect classification.
7. Example Protocols
Anti-entropy protocols synchronize CRDT state. They run as choreographies that exchange state deltas. Session types ensure that the exchange pattern follows causal and structural rules.
FROST ceremonies use choreographies to coordinate threshold signing. These ceremonies use the guard chain to enforce authorization rules.
Aura Consensus uses choreographic notation for fast path and fallback flows. Consensus choreographies define execute, witness, and commit messages. Session types ensure evidence propagation and correctness.
#![allow(unused)] fn main() { tell! { #[namespace = "sync"] protocol AntiEntropy { roles: A, B; A -> B: Delta(data: Vec<u8>); B -> A: Ack(data: Vec<u8>); } } }
This anti-entropy example illustrates a minimal synchronization protocol.
8. Operation Categories and Choreography Use
Not all multi-party operations require full choreographic specification. Aura classifies operations into categories that determine when choreography is necessary.
8.1 When to Use Choreography
Full choreography (Category C) is required for operations where partial execution is dangerous and all parties must agree before effects apply -- such as establishing or modifying cryptographic relationships. Operations within established cryptographic contexts (Category A) use CRDT fact emission without choreography. Operations affecting other users' policies (Category B) may use lightweight proposal/approval patterns.
See Choreography Development Guide for the decision framework. See Consensus - Operation Categories for detailed categorization.
9. Choreography Inventory
The codebase contains choreographic protocols spanning core consensus, rendezvous, authentication, recovery, invitation, sync, and runtime coordination -- approximately 15 protocols across 7 domains.
See Project Structure for the protocol inventory with locations and purposes.
10. Runtime Infrastructure
The runtime provides production choreographic execution through manifest-driven Telltale protocol-machine sessions.
10.1 ChoreographicEffects Trait
| Method | Purpose |
|---|---|
send_to_role_bytes | Send message to specific role |
receive_from_role_bytes | Receive message from specific role |
broadcast_bytes | Broadcast to all roles |
start_session | Initialize choreography session |
end_session | Terminate choreography session |
AuraVmEffectHandler is the synchronous host boundary between the protocol machine and Aura runtime services. AuraQueuedVmBridgeHandler provides queued outbound payloads and branch decisions for role-scoped protocol-machine sessions.
10.2 Wiring a Choreography
Wiring a choreography involves storing the protocol in a .tell file, generating artifacts via tell!, opening an admitted protocol-machine session, and providing decision sources through the host bridge.
See Choreography Development Guide for the wiring procedure.
10.5 Output and Flow Policy Integration Points
Aura binds choreography execution to protocol-machine output/flow gates at the runtime boundary.
AuraVmEffectHandler tags protocol-machine-observable operations with output-condition predicate hints so OutputConditionPolicy can enforce commit visibility rules. The hardening profile allow-list admits only known predicates (transport send/recv, protocol choice/step, guard acquire/release). Unknown predicates are rejected in CI profiles.
Flow constraints are enforced with FlowPolicy::PredicateExpr(...) derived from Aura role/category constraints. This keeps pre-send flow checks aligned with Aura's information-flow contract while preserving deterministic replay behavior.
Practical integration points:
- Choreography annotations declare intent (
guard_capability,flow_cost,journal_facts,leak). - Macro output emits
EffectCommandsequences. - Snapshot builders evaluate typed capability candidates into an admitted frontier, and the guard chain evaluates commands and budgets at send sites.
- Protocol-machine output/flow policies gate observable commits and cross-role message flow before transport effects execute.
Choreography-level guard semantics and protocol-machine-level hardening are additive, not competing. Annotations define required effects. Policies constrain which effects are allowed to become observable.
11. Summary
Aura uses choreographic programming to define global protocols. Projection produces local session types. Session types enforce structured communication. Handlers execute protocol steps using effect traits. Extension effects provide authorization, budgeting, and journal updates. Execution modes support testing, simulation, and production. Choreographies define distributed coordination for CRDT sync, FROST signing, and consensus.
Not all multi-party operations need choreography. Operations within established cryptographic contexts use optimistic CRDT facts. Choreography is reserved for Category C operations where partial state would be dangerous.
Authenticated enrollment refusal
The device-enrollment response carries either acceptance or refusal. Both are bound to the independently transferred setup signer, the exact invitation, manifest digest, ceremony, subject authority, and physical invitee device. Acceptance and refusal use distinct signature domains and decision values. A wire disposition is untrusted data; only the runtime verifier issues the opaque capability used to settle a response. Invalid or malformed responses neither advance the receive coroutine nor settle the ceremony.
The issuer signs the terminal control only from its persisted terminal decision.
A signed Failed control carries the exact invitation, ceremony, and failure
reason. It is distinct from Committed: neither a verified failure nor its
receipt authorizes key activation, profile adoption, or current membership.
Required verification, clock, storage, and VM-close failures retain their native
causes. A missing invitee during the initial request may be retried only from the
actual transport cause, within the original enrollment window.
Enrollment negative terminal notification
Authenticated enrollment cancellation uses the separately admitted finite
aura.invitation.device_enrollment_terminal_notice protocol. Its session identity
is domain separated from the request/response session and binds the original
invitation and admitted manifest digest. A notification never advances the
request/response VM's program counter. The wire envelope is untrusted: only the
independently pinned issuer signature and exact original manifest, invitation,
ceremony and physical-device bindings issue negative terminal evidence.
The issuer sends only after the durable cancelled terminal decision. The receiver's listener belongs to the existing invitation service task tree and shares the original admitted window's lease, checkpoint and observations. It retains a distinct immutable signed failure receipt before reporting failure. Negative evidence cannot authorize device adoption or committed recovery. Cancellation and ordinary response races close their actual owned session slots; forced drop retires exact session custody without claiming asynchronous close or terminal evidence. Required failure causes remain in native observation and service task health. Notification retries retain the original deadline and only reconcile definitely unsent, exactly scoped transport failures.
Required close error provenance
A required session close preserves the native engine or choreography error as its cause. Session ownership retirement and VM close are distinct outcomes: retiring an owner cannot erase a failed close, and a combined failure retains both causes. Forced cleanup provides resource retirement evidence only; it cannot substitute for an acknowledged protocol terminal decision.
Required local session disposal
Required VM retirement disposes only the owned target session, including live or blocked coroutines, scheduling eligibility, handoffs and scoped communication and resource state. Unrelated sessions remain usable. Host metadata removal follows the actual backend acknowledgment. The cooperative backend retains stable coroutine IDs through its existing index rebuild; the threaded backend validates and rebuilds its explicit ID index after removal.
Threaded worker execution is joined by the engine's synchronous worker scope before exclusive disposal begins. Acknowledgment means no target job remains; it does not require destroying the shared pool or other sessions. Naturally terminal session status and epoch are preserved, and repeated disposal returns its original compact acknowledgment. New close epoch advancement is checked only for a genuinely active target.
Concrete backend failure remains in the standard native source chain. Required closure cannot succeed by parsing or suppressing an unsupported error, merely removing host metadata, or disposing an entire engine containing other sessions. Historical compact summaries and diagnostic traces follow the dependency's explicit archive policy. Shared global guard state is not claimed as exclusively owned by the target session. VM disposal is local cleanup and does not establish remote delivery, a signed terminal decision or protocol completion.
Cancelled enrollment notification recovery
Post-bootstrap recovery distinguishes a retained Cancelled first decision from an active enrollment registration. Pending generation secrets remain retired. A separate move-owned notice capability binds the independently retained issued manifest, actual runtime, immutable first decision, original clock checkpoint and original execution semaphore. It authorizes only the finite signed terminal-notice protocol; it grants no Request, Accept, Confirm, activation or membership authority.
Notification eligibility ends at the earlier of the original registered deadline and the signed manifest expiry. Restoring a terminal decision does not renew either bound. Required observation and checkpoint acknowledgment precede signing and continuation. Signing uses the currently owned issuer identity only while its key still matches the independently retained issuer verifier. Known original or signed expiry completes the finite recovery owner with a typed eligibility-ended disposition and prevents further sends. Required clock, checkpoint, signer, transport and teardown faults retain their original typed cause through task failure and drain. Both preserve the Cancelled decision.
Transport and Information Flow
This document describes the architecture of transport, guard chains, flow budgets, receipts, and information flow in Aura. It defines the secure channel abstraction and the enforcement mechanisms that regulate message transmission. It explains how context boundaries scope capabilities and budgets.
1. Transport Abstraction
Aura provides a transport layer that delivers payload-encrypted messages between authorities. Each transport connection is represented as a SecureChannel. A secure channel binds a pair of authorities and a context identifier. A secure channel maintains isolation across contexts.
The direct TCP/WebSocket emitters are byte-delivery mechanisms, not a substitute for payload encryption. Production direct transport rejects outbound envelopes unless the envelope either carries explicit aura-payload-encryption metadata with a non-plaintext value or uses an Aura content type that is already defined as encrypted. Test, simulation, and harness transports may bypass this send-time policy so deterministic fixtures can exercise routing without provisioning channel keys.
A secure channel exposes a send operation and a receive operation. The channel manages replay protection and handles connection teardown on epoch changes. Receipt generations, AMP generations, and AEAD nonces are owner-minted and consumed once; see Ownership Model.
#![allow(unused)] fn main() { pub struct SecureChannel { pub context: ContextId, pub peer: AuthorityId, pub channel_id: Uuid, } }
This structure identifies a single secure channel. One channel exists per (ContextId, peer) pair. Channel metadata binds the channel to a specific context epoch.
2. Guard Chain
All transport sends pass through the guard chain defined in Authorization. CapGuard evaluates Biscuit capabilities and sovereign policy. FlowGuard charges the per-context flow budget and produces a receipt. JournalCoupler records the accompanying facts atomically. Each stage must succeed before the next stage executes. Guard evaluation runs synchronously over a prepared GuardSnapshot and returns EffectCommand data. An async interpreter executes those commands so guards never perform I/O directly.
3. Flow Budget and Receipts
Flow budgets limit the amount of data that an authority may send within a context. The flow budget model defines a quota for each (ContextId, peer) pair. A reservation system protects against race conditions.
Missing budget state or budget retrieval errors do not create implicit headroom. Zero limits mean no spend is available unless a future explicit typed unlimited-budget policy says otherwise, and guard-time checks must match charge-time semantics.
An authority must reserve budget before sending. A reservation locks a portion of the available budget. The actual charge occurs during the guard chain. If the guard chain succeeds, a receipt is created.
#![allow(unused)] fn main() { /// From aura-core/src/types/flow.rs pub struct Receipt { pub ctx: ContextId, pub src: AuthorityId, pub dst: AuthorityId, pub epoch: Epoch, pub cost: FlowCost, pub nonce: FlowNonce, pub prev: Hash32, pub sig: ReceiptSig, } }
This structure defines a receipt. A receipt binds a cost to a specific context and epoch. The sender signs the receipt. The nonce provides a replay identifier when checked against retained state, and the prev field chains receipts for auditing. The recipient verifies the signature. Receipts support accountability in multi-hop routing.
Receipt transcript verification and sender authentication are separate checks. A signature verified with the public key embedded in its own receipt establishes integrity under that key; it does not bind the claimed source authority or device. An ingress owner may publish verified peer identity only after resolving an expected active key from trusted local authority/device state, checking the key and epoch against that binding, and applying replay state. LAN bootstrap frames that have only a self-certified receipt remain untrusted routing input even when their bytes are intact.
3.1 Budget Epochs, Generations and Windows
Flow budget accounting reuses the AMP ratchet model (AMP §5–§8) without its key derivation. Every quantity is derived from replicated facts in the shared relational context, so no wall clock decides which budget is in force and every device of an authority converges on the same position.
- Epoch: for each context and direction (sender → receiver), the budget epoch advances only through a committed transition fact, reduced deterministically to one canonical epoch, as AMP channel epochs are.
- Generation: the receipt
nonceis the sender's budget generation within the epoch. It is derived from reduced journal state rather than a local counter, sospentfor the epoch is the generation span consumed. - Window: a checkpoint fact anchors the epoch's
base_gen. The receiver accepts a receipt only if its generation lies inside the granted window abovebase_gen. Generations below the window (replays) or above it (sends beyond the allowance) are rejected structurally. - Dual window: at an epoch boundary the receiver keeps the previous window open alongside the successor window, as AMP's alternating windows do, so receipts the sender stamped before observing the new epoch are still accepted and nothing in flight is dropped.
- Replenishment: the receiver opens the successor epoch once it has accepted half a window of receipts in the current epoch, AMP's routine spacing rule, with
base_genset to the highest accepted generation. Counting accepted receipts rather than trusting stamped generations means a sender cannot skip generations or name an unopened epoch to send more than its allowance; it tolerates losing up to half a window per epoch. A peer that stays within its window therefore keeps sending; a receiver withholds or delays the bump to throttle a peer. - Allowance: the window size resolves in priority order from a per-peer override fact, then a context policy fact, then the default (1024), as AMP's skip window does. Adjusting a peer's allowance is committing an override; an adaptive anti-spam policy writes overrides or delays bumps without changing the protocol. The sender's effective limit is the minimum of this window and the limit it derives from its Biscuit tokens and local policy.
Before any checkpoint exists for a direction, both sides use the default window at the initial epoch with base_gen = 0.
The current runtime realizes this contract with runtime-owned state rather than replicated facts. The receiver delivers each successor checkpoint to the sender as a receipted application/aura-flow-checkpoint transport message, offers it again while the sender still stamps the previous epoch, and keeps its windows in memory; after a restart it adopts the first receipt it sees from a sender as that direction's checkpoint, which resets accounting by at most one window. Receipts outside the window are dropped without a response. The sender keeps its generation and adopted limit in its local journal budget; a sender that reaches its limit fails the send locally until the checkpoint arrives.
4. Information Flow Budgets
Information flow budgets define limits on metadata leakage. Budgets exist for external leakage, neighbor leakage, and group leakage. Each protocol message carries leakage annotations. These annotations specify the cost for each leakage dimension.
Leakage budgets determine if a message can be sent. If the leakage cost exceeds the remaining budget, the message is denied. Enforcement uses padding and batching strategies. Padding hides message size. Batching hides message frequency.
#![allow(unused)] fn main() { pub struct LeakageBudget { pub external: u32, pub neighbor: u32, pub in_group: u32, } }
This structure defines the leakage budget for a message. Leakage costs reduce the corresponding budget on successful send.
5. Context Integration
Capabilities and flow budgets are scoped to a ContextId. Each secure channel associates all guard decisions with its context. A capability is valid only for the context in which it was issued. A flow budget applies only within the same context.
Derived context keys bind communication identities to the current epoch. When the account epoch changes, all context identities must refresh. All secure channels for the context must be renegotiated.
#![allow(unused)] fn main() { pub struct ChannelContext { pub context: ContextId, pub epoch: u64, pub caps: Vec<Capability>, } }
This structure defines the active context state for a channel. All guard chain checks use these values.
Bootstrap and stale-node re-entry surfaces fit this model as discovery inputs, not as transport
exceptions. Shared bootstrap contact hints, neighborhood re-entry hints, and bounded bootstrap
introductions may advertise scoped link endpoints plus expiry and replay bounds. Runtime code can
merge those records into local bootstrap selection state, but the transport layer still uses the
same guarded Establish, Move, and Hold path objects after a candidate is chosen.
6. Failure Modes and Observability
The guard chain defines three categories of failure. A denial failure occurs when capability requirements are not met. A block failure occurs when a flow budget check fails. A commit failure occurs when journal coupling fails.
Denial failures produce no observable behavior. Block failures also produce no observable behavior. Commit failures prevent sending and produce local error logs. None of these failures result in network traffic.
This design ensures that unauthorized or over-budget sends do not produce side channels.
7. Security Properties
Aura enforces no observable behavior without charge. A message cannot be sent unless flow budget is charged first. Capability gated sends ensure that each message satisfies authorization rules. Receipts provide accountability for multi-hop forwarding.
The network layer does not reveal authority structure. Context identifiers do not reveal membership. All metadata is scoped to individual relationships.
8. Secure Channel Lifecycle
Secure channels follow a lifecycle aligned with rendezvous and epoch semantics.
Establishment begins with rendezvous per Rendezvous Architecture to exchange descriptors inside the Relational Contexts journal. Each descriptor contains transport hints, a handshake PSK derived from the context key, and a punch_nonce. Once both parties receive offer/answer envelopes, they perform Noise IKpsk2 using context-derived keys and establish a QUIC or relay-backed channel bound to (ContextId, peer).
During steady state, the guard chain enforces CapGuard, FlowGuard, and JournalCoupler for every send. FlowBudget receipts created on each hop are inserted into the Relational Contexts journal so downstream peers can audit path compliance.
Bootstrap discovery does not bypass this lifecycle. Broker-backed or board-backed discovery can surface candidates, but once a candidate is selected the resulting channel or movement setup uses the same guarded transport machinery, receipt flow, and context scoping as any other path.
When the account or context epoch changes, the channel detects the mismatch, tears down the existing Noise session, and triggers rendezvous to derive fresh keys. Existing receipts are marked invalid for the new epoch, preventing replay. Channels close explicitly when contexts end or when FlowGuard hits the configured budget limit. Receipts emitted during teardown propagate through the relational context journal so guardians or auditors can verify all hops charged their budgets. Tying establishment and teardown to relational context journals ensures receipts become part of the same fact set tracked in Distributed Maintenance Architecture.
9. Privacy-by-Design Patterns
Privacy-by-design is enforced through context isolation, fixed-size envelopes, and flow budgets as defined in sections 1-7. All messages are scoped to a ContextId or RelationshipId with no cross-context routing. Capability hints are blinded before network transmission. The guard chain ensures unauthorized and over-budget sends produce no network traffic or timing side channels.
See Effects and Handlers Guide for privacy-aware implementation patterns.
10. Sync Status and Delivery Tracking
The system exposes sync status for Category A (optimistic) operations through Propagation state (Local, Syncing, Complete, Failed) and Acknowledgment records per peer. Delivery status is derived from consistency metadata, not stored directly. Read receipts are semantic (user viewed the message) and distinct from transport-level delivery acknowledgments.
Category B operations use proposal/approval state. Category C operations use ceremony completion status. Lifecycle modes (A1/A2/A3) apply within these categories: A1/A2 updates are usable immediately but provisional until A3 consensus finalization.
See Operation Categories for the full consistency metadata type definitions. See Effects and Handlers Guide for delivery tracking patterns.
10.1 Adaptive Privacy Movement
MoveEnvelope is the shared accountable movement boundary for relay traffic, retrieval traffic, held-object deposit and retrieval, accountability replies, and cover traffic where those flows use the adaptive privacy substrate. These flows do not regain separate mailbox, retrieval, relay, or cache-specific transport families.
Movement runs over an explicit path. The path may be a direct established path in passthrough mode, or an anonymous EstablishedPath in privacy mode. Move does not smuggle route setup back into the envelope.
The runtime schedules movement through three classes. Sync-blended traffic rides anti-entropy windows when deadlines allow it. Bounded-deadline replies carry accountability and control traffic that needs shorter latency. Synthetic cover fills the remaining cover floor after application traffic and sync-blended retrieval are counted.
Accountability replies share the same movement substrate, but the first deployment measures them separately. They do not reduce the synthetic cover floor. This prevents mandatory witness traffic from being mistaken for discretionary cover.
10.2 AMP Channel Epoch Data Plane
AMP message acceptance is subordinate to reducer-derived channel epoch state. The ratchet consumes the reduced control-plane view from the relational context journal; it does not decide membership truth or choose among competing successor epochs.
A received AMP message is accepted only when all of the following hold:
- the message epoch is the stable epoch or the single reducer-exposed
A2Livesuccessor epoch - the sender is a member of that exact epoch's membership commitment
- the generation is within the configured skip window or acceptance horizon
- cryptographic validation succeeds
Dual-epoch acceptance is policy-limited. Additive and non-removal transitions may permit bounded old-epoch receive overlap. Subtractive, removal, revocation, and emergency transitions require stricter old-epoch handling so removed or suspected participants cannot keep sending indefinitely while the network is slow.
Runtime ratchet derivation follows the same rule. Sends use the stable epoch
unless the reducer exposes exactly one A2Live successor, in which case sends
cut over to that successor. Receives allow stable-plus-successor overlap for
additive and ordinary non-removal transitions, reject old-epoch traffic for
subtractive and cryptoshred transitions, and allow only minimal old-epoch grace
for quarantine transitions. Emergency suspect exclusions are enforced at AMP
send boundaries and do not imply authority-root membership changes.
10.3 Emergency AMP Policies
AMP emergency transitions are control-plane epoch transitions, not informal warning messages.
EmergencyQuarantineTransition excludes the suspect from the successor epoch
once the A2 certificate makes the successor live. New application sends cut
over to the successor epoch immediately. Old-epoch receive grace is minimal and
must be explicitly authorized by the transition policy. Implementations erase
old sender keys, receiver chain keys, skipped-message key caches, staged epoch
material, and channel-adjacent access material aggressively, subject to local
retention policy.
EmergencyCryptoshredTransition is the strongest channel-scoped emergency
mode. When its successor becomes A2Live, ordinary pre-emergency readable
state is destroyed immediately according to local cryptoshredding policy. A3
finalization later durably commits the already-live successor; it does not
delay cryptoshredding.
Emergency transitions protect future traffic and reduce future at-rest exposure on honest devices. They do not retroactively protect data already seen, decrypted, or exfiltrated before cutover.
Operator diagnostics must present emergency AMP actions with that limitation: quarantine and cryptoshred reduce future exposure and local readable remnants after the reducer exposes the emergency successor, but they are not an incident response guarantee for content already copied outside honest devices. Cooldown and accusation diagnostics are generation/evidence based; wall-clock timers are operator display metadata only and are not reducer inputs.
Channel emergency facts do not automatically remove authority-root membership or recovery/governance rights. Recovery suspension, governance suspension, and durable structural removal are separate authority-scoped governance actions with their own thresholds.
11. Anti-Entropy Sync Protocol
Anti-entropy implements journal synchronization between peers. The protocol exchanges digests, plans reconciliation, and transfers operations.
11.1 Sync Phases
A sync round begins by loading the local Journal and operation log, then computing a JournalDigest for the local state. The digest is exchanged with the peer. The two digests are compared to determine whether the states are equal, whether one side is behind, or whether they have diverged. Missing operations are then pulled or pushed in batches. Applied operations are converted to a journal delta, merged with the local journal, and persisted once per round.
11.2 Digest Format
#![allow(unused)] fn main() { pub struct JournalDigest { pub operation_count: u64, pub last_epoch: Option<u64>, pub operation_hash: Hash32, pub fact_hash: Hash32, pub caps_hash: Hash32, } }
The operation_count is the number of operations in the local op log. The last_epoch is the max parent_epoch observed, or None if the log is empty. The operation_hash is computed by streaming op fingerprints in deterministic order. The fact_hash and caps_hash use canonical serialization (DAG-CBOR) then hash.
11.3 Reconciliation Actions
| Digest Comparison | Action |
|---|---|
| Equal | No-op |
| LocalBehind | Request missing ops |
| RemoteBehind | Push ops |
| Diverged | Push + pull |
Retry behavior follows AntiEntropyConfig.retry_policy with exponential backoff. Failures are reported with structured phase context attributable to a specific phase and peer.
See Choreography Development Guide for anti-entropy implementation.
11.4 Relational-Context Sync
Anti-entropy carries only AttestedOps. Committed relational facts of home, channel and DM contexts converge through relational-context sync, a membership-checked pull between the members of one context.
A member sends each peer it counts as a member of the context a context-sync summary (content type application/aura-context-sync) holding the context id and the hashes of its committed fact digests in 16 buckets. The peer identifies differing buckets, and the requester sends those buckets as pages of at most 256 digests. Each page bounds the range of facts the peer may return. Context-sync facts are home governance facts, moderation actions, chat facts (channels, messages, delivery and read state) and AMP channel membership facts. The peer serves only a requester it counts as a member: the home roster (members and moderation targets) of a home with that context, or an authoritative participant of a channel in it (AMP membership plus accepted channel invitations). It answers with the facts the requester lacks that it may serve. A moderation or membership fact is served only by its author, because a receiver requires its actor or author to be its sender. A membership event written for another participant also needs an author with standing: a join from an admitted member (the inviter of an accepted invitation), a departure (a kick) from a moderator of the context's home with the kick capability. The receiver drops one without standing and a later sync round offers it again; AMP membership reduction counts such an event only once its author is admitted, in any order. The receiver commits a delivered fact once; a synced membership fact also enters the AMP context journal.
The runtime-owned periodic sync runs the pull on PhysicalTimeEffects, coalesced per (context, peer) by the sync manager. Commit-time sends to peers are single best-effort sends that only cut latency; they are never retried, and a failed send never turns a committed action into a reported failure. Message delivery status comes from the recipient's delivery receipt, which a recipient sends when it first commits the message whether the message arrived by send or by sync. A failed commit-time send marks the message Failed; a later receipt advances it to Delivered, and a failed send never overrides a receipt.
Relational-context sync does not establish membership. A peer that does not yet count the requester as a member ignores the request, and the requester converges through another member. Held-digest sets grow with the context's history.
12. Protocol Version Negotiation
All choreographic protocols participate in version negotiation during connection establishment.
12.1 Version Handshake Flow
sequenceDiagram
participant I as Initiator
participant R as Responder
I->>R: VersionHandshakeRequest(version, min_version, capabilities, nonce)
R->>I: VersionHandshakeResponse(Accepted/Rejected)
alt Compatible
Note over I,R: Use negotiated version
else Incompatible
Note over I,R: Disconnect
end
See Choreography Development Guide for version handshake implementation.
12.2 Handshake Outcomes
| Outcome | Response Contents |
|---|---|
| Compatible | negotiated_version (min of both peers), shared capabilities |
| Incompatible | reason, peer version, optional upgrade_url |
12.3 Protocol Capabilities
| Capability | Min Version | Description |
|---|---|---|
ceremony_supersession | 1.0.0 | Ceremony replacement tracking |
version_handshake | 1.0.0 | Protocol version negotiation |
fact_journal | 1.0.0 | Fact-based journal sync |
13. Summary
The transport, guard chain, and information flow architecture enforces strict control over message transmission. Secure channels bind communication to contexts. Guard chains enforce authorization, budget, and journal updates. Flow budgets and receipts regulate data usage. Leakage budgets reduce metadata exposure. Privacy-by-design patterns ensure minimal metadata exposure and context isolation. All operations remain private to the context and reveal no structural information.
Sync status and delivery tracking provide user visibility into Category A operation propagation. Anti-entropy provides the underlying sync mechanism with digest-based reconciliation. Version negotiation ensures protocol compatibility across peers. Delivery receipts enable message read status for enhanced UX.
Generation interval arithmetic
Receipt-generation allowance coordinates and physical-time coordinates are distinct domains. Receipt windows contain no physical timestamps and do not renew according to elapsed time. Their checked half-open intervals require a representable exclusive endpoint: base u64::MAX with extent one is invalid, and endpoint overflow is rejected rather than wrapped or truncated. Exhaustion requires an explicit domain outcome; it does not authorize implicit renewal. Empty generation allowances admit no receipts. Current/previous epoch acceptance, authenticated checkpoint admission, nonce replay protection and authorized checked epoch progression remain flow-domain contracts. Serialized arithmetic intervals do not provide admission authority. Fixed physical execution windows retain their original deadline and do not acquire generation rollover semantics.
Receive readiness
Transport receive readiness is a local observation of the original provider or canonical runtime inbox. It consumes no envelope and supplies no authentication, protocol completion or durable acknowledgment. Each provider registers its arrival event before checking its own queue; a stateless provider explicitly refuses unsupported readiness. A required receive retains its original provider inventory and fixed operation endpoint, including readiness and provider errors. An unrelated session's retained frame cannot authorize another session or cause that session to spin. Arrival notifications replace timed polling; they do not advance physical time or allocate a new execution window.
Aura Messaging Protocol (AMP)
AMP is a secure asynchronous messaging protocol for Aura. It operates within relational contexts and channels. The protocol provides strong post-compromise security and bounded forward secrecy without head-of-line blocking.
1. Scope and Goals
A membership-change epoch requires a key ceremony among the successor members and their authenticated consensus on the exact epoch proposal. Agreement evidence is verified against each receiving member's locally retained ceremony group key before the committed bump is retained. A consensus identifier alone does not establish finalization or the availability of a successor base key.
AMP assumes shared state in joint semilattice journals is canonical. Secrets derive locally from shared state combined with authority keys. Ratchet operations remain deterministic and recoverable.
The protocol targets four properties. No head-of-line blocking occurs during message delivery. Strong post-compromise security restores confidentiality after key exposure. Bounded forward secrecy limits exposure within skip windows. Deterministic recovery enables key rederivation from journal state.
1.1 Design Requirements
AMP addresses constraints that existing messaging protocols cannot satisfy.
Deterministic recovery requires all ratchet state to be derivable from replicated facts. The journal is the only durable state. Secrets derive from reduced journal state combined with authority keys. No device may maintain ratchet state that cannot be recovered by other devices in the authority.
Multi-device authorities require support for concurrent message sends from different devices within the same authority. External parties cannot observe which device sent a message. All devices must converge to the same ratchet position after merging facts.
Selective consistency requires both eventual consistency for message sends and strong agreement for durable epoch transitions. The protocol cannot assume a central ordering service.
Authorization integration requires every message send to pass through a guard chain before reaching the network. Authorization failure must prevent key derivation. Budget charges must be atomic with the send.
1.2 Optimistic Operations Within Contexts
Channels are encrypted substreams within an existing relational context. The relational context, established via invitation ceremony, already provides the shared secret foundation. No new key agreement is needed. Channel creation is local: a device emits a ChannelCheckpoint fact into the existing context journal. Members must already share the context.
Canonical channel existence requires a reducer-selected checkpoint for the exact context and channel. Policy, bootstrap, membership, or transition observations alone do not establish creation. A duplicate creation outcome identifies that same context and channel and requires canonical reconciliation before readiness or successful completion. A failed join remains a failure even when an earlier checkpoint exists.
Required AMP reads and mutations distinguish canonical absence, duplicate creation, authorization, storage, transport, codec, and cryptographic failures. Native error boundaries retain the underlying typed cause. Diagnostic text cannot select idempotent success, bypass mutation, or establish channel state.
Channel creation and messaging are Category A operations. Channel facts sync via normal journal anti-entropy. The bootstrap epoch uses the dealer key (§1.2.1); later epochs take their ChannelBaseKey from the context threshold PRF (§4), so every member derives the same key and no non-member can. See Operation Categories for the full classification.
1.2.1 Bootstrap Messaging (Dealer Key, Provisional)
For newly-created channels where the group key ceremony has not completed yet, AMP supports a bootstrap epoch using a trusted-dealer key (K2/A1). This enables participants to exchange encrypted messages immediately without waiting for consensus-finalized group keys.
The dealer generates a bootstrap key (K_boot) during channel creation and emits an AmpChannelBootstrap fact recording the bootstrap metadata but not the key itself. The dealer distributes K_boot per invitee over a Noise IKpsk2 channel established through rendezvous, authenticated by identity keys and a PSK derived from the relational context. Participants store K_boot locally in secure storage keyed by (context, channel, bootstrap_id). Messages in epoch 0 use K_boot for encryption and decryption.
Messages are encrypted but confidentiality is provisional and dealer-trusted. K_boot never appears in the journal. Only the bootstrap_id hash is recorded. Late joiners do not receive K_boot and therefore cannot read bootstrap-epoch messages. The AmpChannelBootstrap fact lists the dealer's initial recipients, which form the roster of epoch 0.
A participant is an authority, not a device. A device that holds K_boot delivers it to the other devices of its authority so that bootstrap-epoch state stays recoverable by every device (§1.1). Delivery seals K_boot to the recipient device's commitment-tree leaf key with an ephemeral X25519 agreement and AES-GCM bound to the authority, recipient device and purpose. A device that is not yet a leaf of the authority's tree receives nothing.
Every membership change moves the channel to a new epoch. A join applies at once as a membership fact (A1); the key follows by consensus (A3). When a channel's members differ from the roster of its current key epoch, the lowest member authority coordinates a key ceremony among the members (a DKG whose round-two packages are sealed to each member's verified device key) and then Aura Consensus among the new roster on the epoch bump. The commit is signed with the new epoch's group key, so it also finalizes the ceremony; members sync it as a channel epoch commit fact and admit it only when it verifies against the group key they hold. Messages in epoch 1 and later use the base key the members derive from their shares (§4). A member that joins later holds no key for earlier epochs and reads only what is sent after it joins; a departed or kicked member holds no key for later epochs. Existing members keep reading earlier epochs whose keys they hold.
1.3 AMP Lifecycle (A1/A2/A3)
AMP channel epoch transitions use the A1 -> A2 -> A3 agreement ladder with an AMP-specific live-state rule. This rule applies only to AMP channel epoch and membership state inside a relational context. It does not modify authority-root membership, account commitment trees, device enrollment, guardian rotation, or recovery execution.
| Level | AMP meaning | Send authority |
|---|---|---|
| A1 | A syntactically valid AmpProposedChannelEpochBump fact exists. | No successor-epoch sends. |
| A2 | Exactly one valid unsuppressed AmpCertifiedChannelEpochBump exists for the parent epoch. | Successor is live for AMP send and receive policy. |
| A3 | Consensus-backed finalization selected one transition as durable. | Successor is durable and live. |
The normal path finalizes the same transition_id that was previously exposed as A2 live. See Operation Categories for the agreement taxonomy and Consensus for consensus evidence binding.
2. Channel Lifecycle Surface
The AmpChannelEffects trait defines the canonical API for AMP channel lifecycle and messaging. This trait lives in aura-core::effects::amp.
#![allow(unused)] fn main() { #[async_trait] pub trait AmpChannelEffects: Send + Sync { async fn create_channel(&self, params: ChannelCreateParams) -> Result<ChannelId, AmpChannelError>; async fn close_channel(&self, params: ChannelCloseParams) -> Result<(), AmpChannelError>; async fn join_channel(&self, params: ChannelJoinParams) -> Result<(), AmpChannelError>; async fn leave_channel(&self, params: ChannelLeaveParams) -> Result<(), AmpChannelError>; async fn send_message(&self, params: ChannelSendParams) -> Result<AmpCiphertext, AmpChannelError>; } }
The create_channel method writes an AMP checkpoint and policy for a context-scoped channel. The close_channel method records a terminal epoch bump and policy closure. The join_channel and leave_channel methods record membership facts. The send_message method derives current channel state and returns AmpCiphertext containing the header and encrypted payload.
Schema-one membership observations are scoped to an exact context and channel
and reduce as observed joins minus observed departures. Departure wins regardless
of arrival, insertion, merge or opaque order-token ordering. OrderClock supplies
no causal proof, and this schema contains no successor generation evidence; an
unversioned join cannot supersede a retained departure. Such a rejoin is refused
with RejoinRequiresMembershipEvidence. Certified transitions retain ownership of
successor-epoch membership and are not authorized by this observation reducer.
The current transition reduction retains selected transition identities,
membership commitments and emergency exclusions, but no independently verified
successor roster or participant inclusion witness. Those fields alone cannot
admit a departed participant; that admission remains unavailable until the
missing membership evidence contract is implemented.
An empty membership set resulting from departures cannot authorize a sender.
Required membership time failures preserve their cause and do not append a
fabricated zero-time event.
2.1 Implementations
The runtime implementation uses AmpChannelCoordinator in aura-protocol::amp::channel_lifecycle. The simulator implementation uses SimAmpChannels in aura-simulator::amp. The testkit provides MockEffects implementing AmpChannelEffects for deterministic unit tests.
3. Terminology
3.1 Aura Terms
An authority is an account authority with a commitment tree and FROST keys. A relational context is shared state between authorities identified by ContextId. A journal is a CRDT OR-set of facts with monotone growth and deterministic reduction.
3.2 AMP Terms
A channel is a messaging substream scoped to a relational context. The channel epoch bounds post-compromise security and serves as the KDF base. The ratchet generation is a monotone position derived from reduced journal state. The skip window defines out-of-order tolerance with a default of 1024 generations.
A checkpoint is a journal fact anchoring ratchet windows. The alternating ratchet maintains two overlapping windows at boundaries. A transition proposal is an observed request to move from a parent epoch to a successor epoch.
An AMP transition identity binds context_id, channel_id, parent_epoch, parent_commitment, successor_epoch, successor_commitment, membership_commitment, and transition_policy. The typed digest over this tuple is the transition_id. All proposal, certificate, commit, abort, conflict, and supersession facts for the same transition must bind the same transition_id.
An A2 certificate is a witness-backed AmpCertifiedChannelEpochBump fact. An A3 finalization is an AmpFinalizedChannelEpochBump fact backed by consensus evidence. A live successor is the single successor exposed by deterministic reduction for current AMP traffic. A durable successor is the successor finalized by A3 evidence.
4. Commitment Tree Integration
The commitment tree defines authority structure and provides the foundation for key derivation. Each authority maintains an internal tree with branch nodes and leaf nodes. Leaf nodes represent devices holding threshold signing shares. Branch nodes represent subpolicies expressed as m-of-n thresholds.
#![allow(unused)] fn main() { pub struct TreeState { pub epoch: Epoch, pub root_commitment: TreeHash32, pub branches: BTreeMap<NodeIndex, BranchNode>, pub leaves: BTreeMap<LeafId, LeafNode>, } }
The TreeState represents the result of reducing all operations in the OpLog. The epoch field scopes all derived keys. The root_commitment field is a Merkle hash over the ordered tree structure. External parties see only the epoch and root commitment.
Tree operations modify device membership and policies. The AddLeaf operation inserts a new device. The RemoveLeaf operation removes an existing device. The ChangePolicy operation updates threshold requirements. The RotateEpoch operation increments the epoch and invalidates all derived keys.
Each operation appears in the journal as an attested operation signed by the required threshold of devices. The tree supports concurrent updates through deterministic conflict resolution.
Multiple Concurrent Ops → Group by Parent Commitment → Select Winner by Hash Order → Apply in Epoch Order → Single TreeState
The channel base key for a given ChannelId and epoch is derived from the relational context's FROST DKG shares, never from public values: ChannelBaseKey = KDF(s · H(context, ChannelId, epoch)), where s is the context DKG group secret, which no participant holds (see Cryptography §7.5). Each member device computes a partial evaluation from its share with a proof against its public verifying share, and any threshold of verified partials combine to the same key. The tree root and epoch remain public binding context only; anyone who sees them cannot derive a channel key. The context DKG is re-run on authority epoch rotation (§7.1).
5. Fact Structures
AMP uses facts inserted into the relational context journal. All facts are monotone. Reduction determines canonical state.
5.1 Channel Checkpoint
#![allow(unused)] fn main() { pub struct ChannelCheckpoint { pub context: ContextId, pub channel: ChannelId, pub chan_epoch: u64, pub base_gen: u64, pub window: u32, pub ck_commitment: Hash32, pub skip_window_override: Option<u32>, } }
Reduction chooses one canonical checkpoint per context, channel, and epoch tuple. The valid ratchet generation set is the union of two windows. Window A spans from base_gen to base_gen + window. Window B spans from base_gen + window + 1 to base_gen + 2 * window. Checkpoints enable deterministic recovery and serve as garbage collection anchors.
5.2 Channel Epoch Transition Facts
#![allow(unused)] fn main() { pub struct ProposedChannelEpochBump { pub context: ContextId, pub channel: ChannelId, pub parent_epoch: u64, pub new_epoch: u64, pub bump_id: Hash32, pub reason: ChannelBumpReason, pub parent_commitment: Hash32, pub successor_commitment: Hash32, pub membership_commitment: Hash32, pub transition_policy: AmpTransitionPolicy, pub transition_id: Hash32, } }
AmpProposedChannelEpochBump records A1 observed state. It is useful evidence for operators and reducers. It does not authorize successor-epoch sends by itself.
#![allow(unused)] fn main() { pub struct CertifiedChannelEpochBump { pub identity: AmpTransitionIdentity, pub transition_id: Hash32, pub witness_payload_digest: Hash32, pub committee_digest: Hash32, pub threshold: u16, pub fault_bound: u16, pub witness_signatures: Vec<AmpTransitionWitnessSignature>, pub equivocation_refs: BTreeSet<Hash32>, pub excluded_authorities: BTreeSet<AuthorityId>, pub readable_state_destroyed: bool, } }
AmpCertifiedChannelEpochBump records A2 soft-safe evidence. The certificate binds the exact parent prestate, successor epoch, successor membership, transition policy, witness committee, threshold, and witness signatures. If it is the only valid unsuppressed certificate for the parent epoch, reduction exposes the successor as live.
#![allow(unused)] fn main() { pub struct CommittedChannelEpochBump { pub context: ContextId, pub channel: ChannelId, pub parent_epoch: u64, pub new_epoch: u64, pub chosen_bump_id: Hash32, pub consensus_id: Hash32, pub transcript_ref: Option<Hash32>, } }
AmpCommittedChannelEpochBump is the legacy committed-bump shape. It remains part of the protocol fact set for compatibility and recovery fixtures. New transition-aware reducers use the canonical transition fields when they are present.
#![allow(unused)] fn main() { pub struct FinalizedChannelEpochBump { pub identity: AmpTransitionIdentity, pub transition_id: Hash32, pub consensus_id: Hash32, pub transcript_ref: Option<Hash32>, pub excluded_authorities: BTreeSet<AuthorityId>, pub readable_state_destroyed: bool, } }
AmpFinalizedChannelEpochBump records A3 durability for one transition. The transcript_ref optionally links the transition to a DKG transcript for key ceremony coordination.
5.3 Transition Evidence Facts
AMP transition reduction also consumes AmpTransitionAbort, AmpTransitionConflict, AmpTransitionSupersession, and AmpEmergencyAlarm facts. These facts suppress unsafe live exposure, record equivocation evidence, authorize replacement paths, and surface emergency suspicion without changing authority-root membership.
Abort and supersession facts include an AmpTransitionSuppressionScope. The A2LiveOnly scope suppresses live use but does not by itself reject later A3 evidence. The A2AndA3 scope suppresses both live use and durable finalization for the affected transition.
5.4 Channel Bump Reason and Transition Policy
#![allow(unused)] fn main() { pub enum ChannelBumpReason { Routine, SuspiciousActivity, ConfirmedCompromise, } }
The Routine variant indicates cadence-based maintenance. The SuspiciousActivity variant indicates detected anomalies such as AEAD failures or ratchet conflicts. The ConfirmedCompromise variant requires immediate post-compromise security restoration. Both suspicious activity and confirmed compromise bypass routine spacing rules.
AmpTransitionPolicy refines these reasons into NormalTransition, AdditiveTransition, SubtractiveTransition, EmergencyQuarantineTransition, and EmergencyCryptoshredTransition. The policy determines old-epoch receive overlap, suspect exclusion, and cryptoshred behavior after an A2 live successor is exposed.
6. Derived Channel State
Reduction yields a ChannelEpochState struct containing the stable epoch, optional live transition, bootstrap metadata, and ratchet position.
#![allow(unused)] fn main() { pub struct ChannelEpochState { pub chan_epoch: u64, pub pending_bump: Option<PendingBump>, pub bootstrap: Option<ChannelBootstrap>, pub last_checkpoint_gen: u64, pub current_gen: u64, pub skip_window: u32, pub transition: Option<AmpTransitionReduction>, } }
chan_epoch is the stable reduced epoch. pending_bump is derived only when exactly one unsuppressed A2 certificate exposes a live successor. It is not derived from proposal order or local preference.
#![allow(unused)] fn main() { pub enum AmpTransitionReductionStatus { Observed, A2Live, A2Conflict, A3Finalized, A3Conflict, Aborted, Superseded, } }
The status describes the reducer result for one parent prestate. Observed has no live successor. A2Live exposes one live successor. A3Finalized exposes one durable successor. Conflict, abort, and supersession states suppress live use unless explicit replacement evidence selects a valid successor.
#![allow(unused)] fn main() { pub struct PendingBump { pub parent_epoch: u64, pub new_epoch: u64, pub bump_id: Hash32, pub reason: ChannelBumpReason, pub transition_id: Hash32, pub transition_policy: AmpTransitionPolicy, } }
PendingBump is the compatibility projection for the live A2 successor. The richer transition reduction remains available through RelationalState::amp_transitions and ChannelEpochState::transition. See Journal for the reducer contract.
6.1 Skip Window Computation
The skip window derives from three sources in priority order. The checkpoint skip_window_override takes precedence. The channel policy fact applies if no override exists. The default of 1024 applies otherwise. The skip window size and bump cadence are governable via context policy facts.
6.2 Critical Invariants
Before sending, a device must merge latest facts, reduce channel state, and use updated epoch and generation values. No device may send under stale epochs. A proposal alone never authorizes successor-epoch sends.
For each parent epoch and parent commitment, reduction must expose at most one live successor. If two valid A2 certificates conflict and no fact resolves the conflict, the reducer exposes no live successor. Reducers must not choose a winner by arrival order, local preference, wall-clock time, network connectivity, or hash tie-breaking.
A3 finalization may make the same transition durable. If A3 evidence conflicts with already-live A2 evidence, the reducer must surface conflict state rather than silently selecting one path. Emergency transition facts remain channel-scoped and do not alter authority-root membership.
6.3 Ratchet Generation Semantics
The ratchet_gen value is not a local counter. It derives from reduced journal state. All devices converge to the same ratchet position after merging facts. Generation advances only when send or receive events occur consistent with checkpoint and dual-window rules. This guarantees deterministic recovery and prevents drift across devices.
7. Three-Level Key Architecture
AMP separates key evolution across three levels. Authority epochs provide identity-level post-compromise security. Channel epochs provide channel-level post-compromise security. Ratchet generations provide bounded forward secrecy within each epoch.
7.1 Authority Epochs
Authority epochs rotate the threshold key shares via DKG ceremony. Rotation invalidates all derived context keys. This is the strongest form of post-compromise security.
Authority epoch rotation occurs approximately daily or upon confirmed compromise. The rotation is independent of messaging activity. All relational contexts must re-derive their shared secrets after rotation.
7.2 Channel Epochs
Channel epochs provide post-compromise security at the channel level. Each epoch uses an independent base key from the context threshold PRF (§4). Epoch rotation invalidates all keys from the previous epoch. The rotation is atomic. All devices observe the same epoch after merging journal facts.
The epoch transition lifecycle has observed, live, durable, conflict, abort, and supersession states. The stable epoch remains the durable baseline until reduction exposes a single live successor or a single durable successor. This single-live-successor invariant ensures linear AMP traffic for each parent epoch.
7.3 Ratchet Generations
Ratchet generations provide forward secrecy within each epoch. Message keys derive from the channel base key, generation, and direction.
#![allow(unused)] fn main() { pub struct AmpHeader { pub context: ContextId, pub channel: ChannelId, pub chan_epoch: u64, pub ratchet_gen: u64, } }
The AmpHeader contains the routing and ratchet information. The chan_epoch field identifies which base key to use. The ratchet_gen field identifies which generation key to derive. This header becomes the AEAD additional data.
Ratchet generation is not a local counter. It derives from reduced journal state. Devices compute the current generation by examining send and receive events in the reduced context state. All devices converge to the same ratchet position after merging facts.
8. Channel Epoch Bump Lifecycle
8.1 Reducer States
A channel has a stable epoch plus reducer-derived transition state. Observed means proposals exist but do not affect send authority. A2Live means one certified successor is live for AMP traffic. A3Finalized means one successor is durable.
A2Conflict and A3Conflict expose no live successor. Aborted suppresses the affected transition. Superseded records an authorized replacement path and derives live state from the replacement only when the replacement has valid evidence.
8.2 Spacing Rule for Routine Bumps
AMP enforces a spacing rule for routine bumps. Let base_gen be the anchor generation from the canonical checkpoint. Let current_gen be the current ratchet generation. Let W be the skip window.
A routine bump from epoch e to e+1 requires current_gen - base_gen >= W / 2. With default W of 1024, this threshold equals 512 generations. This spacing ensures structural transitions do not occur too frequently.
Emergency transitions bypass this rule. Examples include multiple AEAD failures, conflicting ratchet commitments, unexpected epoch values, and explicit compromise signals.
8.3 State Transitions
In stable state, if the spacing rule is satisfied and no transition is live, a device may insert AmpProposedChannelEpochBump. The channel remains on the stable epoch until an A2 certificate or A3 finalization becomes reducer-visible.
When the reducer observes exactly one valid unsuppressed AmpCertifiedChannelEpochBump, the successor becomes A2Live. New sends cut over to the successor epoch. Receives follow the transition policy for stable-plus-successor overlap.
When the reducer observes valid AmpFinalizedChannelEpochBump evidence for one successor, the successor becomes durable. The device may emit a new checkpoint for the successor epoch. Conflict, abort, and supersession evidence can suppress live use or durable use according to its scope.
8.4 Complete Lifecycle Sequence
The lifecycle has four common phases: channel creation, normal messaging, routine transition, and emergency transition.
Channel creation establishes the initial checkpoint at epoch 0.
sequenceDiagram
participant A as Device A
participant J as Journal
participant B as Device B
A->>J: ChannelCheckpoint(epoch=0, base_gen=0, W=1024)
J-->>B: Sync checkpoint fact
B->>B: Reduce state to epoch 0, gen 0
This sequence records the initial checkpoint. The checkpoint anchors recovery and the first dual ratchet window.
sequenceDiagram
participant A as Device A
participant B as Device B
loop Messages within Window A [0..1024]
A->>A: Merge facts, reduce state
A->>A: Derive key(epoch=0, gen=N)
A->>B: AmpHeader(epoch=0, gen=N) + ciphertext
B->>B: Validate gen in [0..2048]
B->>B: Derive key, decrypt
B->>B: Advance receive ratchet
end
Normal messaging advances the ratchet generation within dual windows.
sequenceDiagram
participant A as Device A
participant J as Journal
participant B as Device B
A->>A: Check: current_gen - base_gen >= W/2
A->>J: AmpProposedChannelEpochBump(0 to 1, policy=NormalTransition)
J-->>B: Sync proposal fact
B->>B: Reduce state to Observed
A->>J: AmpCertifiedChannelEpochBump(transition_id=T)
J-->>B: Sync certificate fact
A->>A: Reduce state to A2Live(T)
B->>B: Reduce state to A2Live(T)
rect rgb(240, 240, 255)
Note over A,B: Transition policy controls old-epoch receive overlap
A->>B: Messages use epoch 1
B->>B: Accept stable or live successor epoch by policy
end
A->>J: AmpFinalizedChannelEpochBump(transition_id=T)
J-->>B: Sync finalization fact
A->>A: Reduce state to A3Finalized(T)
B->>B: Reduce state to A3Finalized(T)
A->>J: ChannelCheckpoint(epoch=1, base_gen=1024)
This sequence shows the key distinction between live and durable state. The A2 certificate can drive traffic before A3 finalization. A3 finalization later commits the same transition as durable.
Conflicting certificates suppress live use until facts prove a single winner.
sequenceDiagram
participant A as Device A
participant J as Journal
participant B as Device B
A->>J: AmpCertifiedChannelEpochBump(transition_id=T1)
B->>J: AmpCertifiedChannelEpochBump(transition_id=T2)
J-->>A: Sync conflicting certificates
J-->>B: Sync conflicting certificates
A->>A: Reduce state to A2Conflict
B->>B: Reduce state to A2Conflict
A->>A: Keep sends on stable epoch
B->>B: Keep sends on stable epoch
This sequence prevents silent fork selection. The reducer must not choose between conflicting valid certificates without explicit abort, conflict, supersession, or finalization evidence.
Emergency transitions bypass spacing for post-compromise containment.
sequenceDiagram
participant B as Device B
participant J as Journal
participant A as Device A
B->>B: Detect AEAD failures > threshold
B->>J: AmpEmergencyAlarm(suspect=S)
B->>J: AmpProposedChannelEpochBump(1 to 2, policy=EmergencyQuarantineTransition)
Note right of B: Bypasses spacing rule
B->>J: AmpCertifiedChannelEpochBump(transition_id=E)
J-->>A: Sync emergency certificate
A->>A: Reduce state to A2Live(E)
B->>B: Reduce state to A2Live(E)
A->>A: Exclude suspect from successor send policy
B->>B: Erase old material by emergency policy
Emergency quarantine excludes the suspect from the successor epoch once A2 evidence is live. Emergency cryptoshred also destroys ordinary pre-emergency readable state at the A2 live boundary. A3 finalization confirms durability but does not delay the emergency cutover.
9. Ratchet Windows
AMP uses an always-dual window model. Every checkpoint defines two consecutive skip windows providing a continuous valid range of 2W generations.
9.1 Window Layout
Given base generation G and skip window W, two windows are defined. Window A spans G to G+W. Window B spans G+W+1 to G+2W. The valid generation set is the union of both windows.
#![allow(unused)] fn main() { // Window layout for checkpoint at generation G with window W let window_a = G..(G + W); let window_b = (G + W + 1)..(G + 2*W); let valid_gen_set = window_a.union(window_b); }
Window A [G .. G+W] → Window B [G+W+1 .. G+2W]
This design eliminates boundary issues. No mode switches are required. The implementation remains simple with robust asynchronous tolerance.
9.2 Window Shifting
When a new checkpoint is issued, the new base generation is chosen far enough ahead per the spacing rule. The dual-window layout guarantees overlap with prior windows. Garbage collection can safely prune older checkpoints when they no longer affect valid generation ranges.
9.3 Asynchronous Delivery
The dual window design solves the asynchronous delivery problem. Messages may arrive out of order by up to W generations. During additive and ordinary non-removal transitions, messages may be accepted under either the stable epoch or the single reducer-exposed live successor epoch.
Message derivation uses a KDF chain similar to Signal's construction but with key differences. AMP derives all ratchet state deterministically from replicated journal facts rather than device-local databases. This enables complete recovery across multiple devices without coordination.
Subtractive, revocation, quarantine, and cryptoshred transitions use stricter old-epoch handling. Removed or suspected authorities must not retain indefinite send authority while the network is slow. See Transport and Information Flow for the data-plane acceptance contract.
10. Sending Messages
10.1 Message Header
#![allow(unused)] fn main() { pub struct AmpHeader { pub context: ContextId, pub channel: ChannelId, pub chan_epoch: u64, pub ratchet_gen: u64, } }
The header contains the context identifier, channel identifier, current epoch, and current generation. These fields form the additional authenticated data for AEAD encryption.
10.2 Reduce-Before-Send Rule
Before sending a message, a device must merge the latest journal facts. It must reduce the channel state to get the stable epoch, live successor, and generation. It must verify that the generation is within the valid window. Only then can it derive the message key and encrypt.
10.3 Send Procedure
Before sending, a device merges new facts and reduces channel state. It asserts that the current generation is within the valid generation set. It chooses the stable epoch unless reduction exposes exactly one A2Live or A3Finalized successor.
If the spacing rule is satisfied and no transition is live, the device may propose a new transition. The proposal is not send authority. The device derives the message key using a KDF with the channel base key, generation, and direction.
The device creates an AmpHeader, encrypts the payload with AEAD using the message key and header as additional data, and performs the guard chain. Guard evaluation runs over a prepared GuardSnapshot and emits EffectCommand items for async interpretation. The device then advances the local ratchet generation.
Emergency policies add sender membership checks at the send boundary. A suspect excluded by a live emergency successor cannot keep sending under the old epoch through local ratchet state.
11. Receiving Messages
When receiving, a device merges new facts and reduces channel state. It checks that the message epoch is the stable epoch or the single reducer-exposed successor epoch. It checks that the sender belongs to the membership commitment for that exact epoch. It checks that the generation is within the valid generation set.
The device rederives the message key using the same KDF parameters. It decrypts the payload using AEAD with the message key and header. It advances the local receive ratchet.
Messages outside valid windows or with unsupported epochs are rejected. Subtractive and cryptoshred transitions reject old-epoch traffic more aggressively than additive transitions. Quarantine transitions allow only minimal old-epoch grace when the transition policy explicitly permits it.
12. Guard Chain Integration
AMP integrates with Aura's guard chain for authorization and flow control. Every message send passes through CapabilityGuard, FlowBudgetGuard, JournalCouplingGuard, and LeakageTrackingGuard before reaching the transport.
Guard evaluation runs over a prepared GuardSnapshot and produces EffectCommand items. An async interpreter executes those commands only after the entire guard chain succeeds. Unauthorized or over-budget sends never touch the network.
#![allow(unused)] fn main() { let outcome = guard_chain.evaluate(&snapshot, &request); if !outcome.is_authorized() { return Err(AuraError::authorization_failed("Guard denied")); } for cmd in outcome.effects { interpreter.execute(cmd).await?; } }
The snapshot captures the current capability frontier and flow budget state. Each guard emits EffectCommand items instead of performing I/O. The interpreter executes the resulting commands in production or simulation. Any failure returns locally without observable effects.
12.1 Flow Budgets
Flow budgets are replicated as spent counters in the journal. The spent counter for a context and peer pair is a monotone fact. The limit computes at runtime from Biscuit capabilities and sovereign policy. Before sending, the flow budget guard checks that spent + cost <= limit.
12.2 Receipts
Receipts provide accountability for multi-hop forwarding. Each relay hop produces a receipt containing the context, source, destination, epoch, cost, and signature. The receipt proves that the relay charged its budget before forwarding.
13. Recovery and Garbage Collection
13.1 Recovery
To recover, a device loads the relational context journal. It reduces to the latest stable epoch, any reducer-exposed live successor, the latest checkpoint, and the skip window. It rederives the channel base key from context root key, channel identifier, and selected epoch. It rederives ratchet state from the checkpoint and window generations.
Load journal facts -> reduce to TreeState -> reduce to ChannelEpochState -> compute checkpoint -> derive base key -> ready to message
The recovery process requires no coordination. The device does not need to contact other participants. It does not need to request missing state. It only needs access to the journal facts. Once reduction completes, the device has the same view as all other participants.
13.2 Garbage Collection
AMP garbage collection maintains protocol safety while reclaiming storage. GC operates on checkpoints, transition proposals, certificates, finalizations, aborts, conflicts, supersessions, and emergency alarms.
A checkpoint at generation G with window W can be pruned when a newer checkpoint exists at G' where G' exceeds G+2W. The newer checkpoint coverage must not overlap with the old checkpoint coverage. All messages within the old window must be processed or beyond the recovery horizon.
A transition proposal can be pruned when finalization, abort, or supersession evidence makes it stale. A2 certificates and A3 finalizations are retained as evidence until full snapshot compaction. Conflict evidence must remain available while it can affect live successor exposure.
13.3 Pruning Boundary
The safe pruning boundary for checkpoints is computed as the maximum checkpoint generation minus 2W minus a safety margin. The recommended safety margin is W/2 or 512 generations with default settings.
GC triggers when journal size exceeds threshold, checkpoint count exceeds maximum, manual compaction is requested, or snapshot creation initiates. See Distributed Maintenance Architecture for integration with the Aura snapshot system.
14. Security Properties
14.1 Forward Secrecy
Forward secrecy is bounded by the skip window size of 1024 within each epoch. Within a single epoch, an attacker who compromises a device learns at most W future message keys. Older epochs use independent base keys. Compromise of epoch e reveals nothing about epoch e-1.
14.2 Post-Compromise Security
Post-compromise security operates at two levels. Channel epoch bumps heal compromise of channel secret state. Context epoch bumps provide stronger PCS by healing compromise of context state. Channel bumps are frequent and cheap. Context bumps are rare and expensive.
The dual window mechanism provides continuous post-compromise healing. When an emergency transition becomes A2 live, the new epoch uses a fresh base key. Messages sent under the new epoch cannot be decrypted with the old base key. Emergency cryptoshred destroys ordinary pre-emergency readable state according to local retention policy.
Emergency transitions protect future traffic and reduce future readable remnants on honest devices. They do not retroactively protect data already seen, decrypted, or exfiltrated before cutover.
14.3 No Head-of-Line Blocking
The protocol accepts out-of-order messages up to W generations. Dual windows absorb boundary drift.
14.4 No Ratchet Forks
Deterministic reduction exposes at most one live successor for each parent epoch. A3 consensus finalizes durability. Conflicting valid A2 certificates suppress live exposure rather than creating two ratchet branches.
14.5 Deterministic Recovery
Checkpoints anchor the ratchet. Facts represent all shared state. Keys are always rederived deterministically. This property enables true multi-device messaging. All devices in an authority see the same messages. All devices can send and receive without coordinating who is currently active. The authority appears as a single messaging entity to external parties.
15. Failure Modes
AMP drops messages only when they fall outside the cryptographically safe envelope. These failures are intentional safeguards.
15.1 Generation Out of Window
A message is dropped if its generation lies outside the valid generation set. Causes include stale sender state, aged messages post-GC, or invalid generations from attackers.
15.2 Epoch Mismatch
Messages are rejected when the header epoch is inconsistent with reduced epoch state. This includes epochs that are too old, non-linear epochs, or replays from retired epochs.
15.3 AEAD Failure
If AEAD decryption fails, messages are dropped. Repeated failures contribute to suspicious-event classification and may trigger AmpEmergencyAlarm and emergency transition proposal facts.
15.4 Beyond Recovery Horizon
Messages older than the current checkpoint window cannot be decrypted because older checkpoints have been garbage collected. This is an intentional forward secrecy tradeoff.
15.5 Policy-Enforced Invalidity
After context epoch bumps or high-severity PCS events, messages from previous context epochs are intentionally dropped. After subtractive, quarantine, or cryptoshred transitions, messages from old channel epochs may also be rejected by transition policy.
16. Message Delivery Tracking
AMP integrates with Aura's consistency metadata system for delivery tracking. The transport layer supports opt-in acknowledgment tracking through FactOptions. Peers send FactAck responses upon successful processing. Acks are stored in the journal's ack table and garbage-collected when the delivery policy determines they are no longer needed.
Read receipts are distinct from delivery acknowledgments. Delivery indicates the message was received and decrypted. Read indicates the user viewed the message. Read receipts are opt-in per contact and emit a ChatFact::MessageRead fact.
Delivery acknowledgments leak timing metadata. Applications should batch acknowledgments to reduce timing precision. Read receipts should default to disabled. High-sensitivity contexts can disable acks entirely. See Operation Categories for consistency type definitions and User Interface for status indicators.
See Also
- Transport and Information Flow for guard chain enforcement and AMP data-plane acceptance
- Consensus for epoch transition finalization
- Journal for fact semantics and AMP transition reduction
- Distributed Maintenance Architecture for snapshot and GC integration
- Authority and Identity for tree operation details
- User Interface for UI delivery status display
Rendezvous Architecture
This document describes the rendezvous architecture in Aura. It explains peer discovery, descriptor propagation, service-surface advertisement, connectivity selection, channel establishment, and relay-to-direct holepunch upgrades. It aligns with the authority and context model. It scopes all rendezvous behavior to relational contexts.
1. Overview
Rendezvous establishes secure channels between authorities. The RendezvousService exposes prepare_publish_descriptor() and prepare_establish_channel() methods. The service returns guard outcomes that the caller executes through an effect interpreter. Rendezvous operates inside a relational context and uses the context key for encryption. Descriptors appear as facts in the context journal. Propagation uses journal synchronization (aura-sync), not custom flooding.
Rendezvous owns descriptor semantics, publication, validation, and establish bootstrap. It does not own the long-lived mutable descriptor cache. The runtime in aura-agent owns that cache and passes descriptor snapshots into peer-discovery views.
Rendezvous does not establish global identity. All operations are scoped to a ContextId. A context defines which authorities may see descriptors. Only participating authorities have the keys required to decrypt descriptor payloads.
Rendezvous descriptor exchange can run in provisional (A1) or soft-safe (A2) modes to enable rapid connectivity under poor network conditions, but durable channel epochs and membership changes must be finalized via consensus (A3). Soft-safe flows should emit convergence and reversion facts so participants can reason about reversion risk while channels are warming.
Bootstrap discovery is a separate concern. First-run startup may surface same-machine or same-LAN bootstrap candidates before any enrollment or acceptance has completed. Those candidates are not ordinary rendezvous peers. They must not inflate ordinary peer counts or become context-scoped descriptor participants before enrollment or acceptance completes.
Browser runtimes cannot join the native UDP LAN path. Browser-involved startup uses a bootstrap broker path that publishes ephemeral bootstrap descriptors and then hands control back to the existing invitation or device-enrollment flow.
1.1 Secure‑Channel Lifecycle (A1/A2/A3)
- A1: Provisional
Descriptor/ handshake facts allow immediate connectivity. - A2: Coordinator soft‑safe convergence certs indicate bounded divergence.
- A3:
ChannelEstablishedis finalized by consensus and accompanied by aCommitFact.
Rendezvous must treat A1/A2 outputs as provisional until A3 evidence is merged. See Consensus for commit evidence binding.
2. Architecture
The rendezvous crate follows Aura's fact-based architecture:
- Guard Chain First: All network sends flow through guard evaluation before execution
- Facts Not Flooding: Descriptors are journal facts propagated via
aura-sync, not custom flooding - Standard Receipts: Uses the system
Receipttype with epoch binding and cost tracking - Session-Typed Protocol: Protocols expressed as MPST choreographies with guard annotations
- Unified Transport: Channels established via
SecureChannelwith Noise IKpsk2
2.1 Module Structure
aura-rendezvous/
├── src/
│ ├── lib.rs # Public exports
│ ├── facts.rs # RendezvousFact domain fact type
│ ├── protocol.rs # MPST choreography definition
│ ├── service.rs # RendezvousService (main coordinator)
│ ├── descriptor.rs # Transport selector and builder
│ └── new_channel.rs # SecureChannel, ChannelManager, Handshaker
3. Connectivity and Service Advertisement
Rendezvous descriptors carry two kinds of information. One surface describes concrete connectivity endpoints. The other surface describes abstract service families such as Establish, Move, and Hold. These surfaces must remain separate.
Connectivity endpoints describe how a peer may be reached. Service advertisements describe what the peer is willing to provide. Runtime policy combines both surfaces with local permit state, health, and trust evidence. Descriptor publication itself does not commit the final route choice.
The implementation still derives split connectivity and service-surface views from legacy TransportHint compatibility data in some descriptor and invitation paths. That compatibility bridge is quarantined. Owner: adaptive_privacy_runtime. Removal condition: descriptor publication and invitation bootstrap no longer need the legacy hint bridge. New code should consume LinkEndpoint, ServiceDescriptor, EstablishPath, MovePath, and HoldDescriptor views rather than treating transport hints as final routing policy.
3.1 Bootstrap Discovery Plane
Aura uses two distinct discovery planes during startup:
- Native rendezvous/LAN discovery for native-to-native startup on the same LAN.
- Broker-backed bootstrap discovery for any startup shape that involves the browser, including same-machine TUI to Web and same-LAN TUI to Web or Web to Web.
The bootstrap broker publishes ephemeral bootstrap descriptors only. It exists to help first-run instances discover one another and exchange invitation or device-enrollment material through the existing enrollment path. It does not create an ordinary rendezvous relationship on its own.
Bootstrap broker URLs carry only non-secret endpoint identifiers. Bearer credentials and invitation retrieval tokens travel in headers or another explicit credential channel, never in URL query strings, so logs, histories, referrers, and diagnostics do not capture secret material.
Bootstrap delivery identifies the recipient by both authority and device. Two devices belonging to one authority have independent retrieval credentials and pending deliveries; registering either device cannot replace the other's credential or drain its queue. Discovery metadata identifies a destination but does not authorize an enrollment, contact, or device operation.
The broker wire contract is version 2. Registration and candidate records carry the device identifier, delivery records carry the recipient device identifier, and retrieval addresses name both authority and device. Version 1 records and authority-only retrieval paths are not accepted.
Each delivery carries an explicit invitation purpose. The receiving bootstrap owner retains every retrieved delivery until the matching existing workflow accepts custody or returns a typed refusal. Queue order does not determine purpose, and retrieving a batch cannot silently discard its other members. An enrollment prefill is observed input requiring the existing explicit approval and verifier contract. Contact delivery likewise requires canonical signed invitation verification and the contact workflow; neither purpose can substitute for the other.
Broker retrieval acknowledges transport custody only. One-use retrieval credentials do not acknowledge workflow completion, enrolled-device authority, or cancellation cleanup. Any subsequent shortcut delivery retains the original approved enrollment owner and its purpose-bound acknowledgment under the original selected provider and deadline; broker records cannot reconstruct that authority. The issuer selects an external recipient authority and device and a Contact or Guardian purpose before starting an enrollment-with-shortcut workflow. After original enrollment disposal and positive acknowledgment, the issuer creates a fresh signed invitation for that exact destination and purpose under the separate fixed shortcut endpoint, then delivers it through the broker. The enrollment code is not replayed as the shortcut, and broker delivery does not turn enrollment-start success into invitation acceptance.
Pending device-enrollment VM transport
Before adoption, an invitee still runs under its provisional authority while the enrollment VM addresses both roles under the issuer's subject authority. The broker may carry these VM envelopes without promoting a bootstrap candidate to an ordinary rendezvous peer. Each direction needs its own authenticated mailbox scope; possession of a broker bearer credential alone does not authorize an enrollment route.
The invitee's first-frame mailbox registration is authorized by the verified original setup key and exact admitted manifest. The reverse mailbox is registered by the issuer under the retained original enrollment control and approved native threshold policy. Its signing transcript belongs to the original user-approved initiation batch; later generic signing cannot create the route. Its signed registration binds the original invitation, manifest and original setup digests, session, subject, issuer and invitee devices, direction, and expiry. The invitee may send a response only after checking that registration against its independently retained enrollment baseline and proving possession of its admitted setup key. Neither a self-certified descriptor nor a signature copied from the manifest can establish the reverse route. The return registration uses the v2 signed transcript; old v1 records cannot authorize a route after the setup-digest binding was added.
For quorum issuance the verifier uses the authenticated native root signing
node (NodeIndex(0)), requires its original threshold of at least two, and
matches its group verifier to the separately pinned initiator confirmation
verifier in the transferred manifest. Another active inventory key, even one
listing the issuer device, cannot register the return route.
For an original K1 issuance, the same retained physical SingleSigner root
selected for the signed manifest signs a distinct return transcript before
the enrollment code is exported. Its package and epoch must match the
independently pinned root and initiator confirmation verifier. The registration
records the signing mode; K1 and quorum proofs cannot substitute for one
another. Both modes check expiry through the selected physical-time provider.
Each Bob-to-Alice VM envelope has a separate setup-key authorization over its
exact message ID and serialized envelope digest, bound to the verified issuer
return registration and original session. The broker cannot promote this
authorization to membership or treat a first-frame proof as a reverse route.
Broker enqueue, take, and acknowledgment use separate scoped credentials. The broker enforces the signed scope, bounded capacity, and expiry using its selected physical-time provider. A recipient durably retains an exact message-ID/envelope record under the protected enrollment admission before acknowledging delivery, deduplicates redelivery, and replays that record on same-profile reopen. VM ingress remains responsible for final session, role, message, and cryptographic verification. Terminal acknowledgment or verified failure retires the scoped mailbox and replay record; an ambiguous send or take cannot issue a new enrollment operation or discard the original frame.
Bootstrap and stale-node re-entry remain distributed surfaces. Aura does not define a singleton bootstrap registry. Runtime code may combine remembered direct contacts, neighborhood discovery-board publications, bounded bootstrap introductions, and broker-backed ephemeral startup descriptors. aura-rendezvous owns schema validation for bootstrap contact hints and neighborhood re-entry hints, but it does not own final route choice or a global bootstrap cache.
Operationally, browser and native first-run startup may become bootstrap-visible only after the first native account runtime exists and begins hosting the broker automatically. For example, in a TUI plus Web startup, the user may create the web account first and the TUI account second. Once the TUI runtime is live, both instances should surface one another as bootstrap candidates without extra user setup steps.
3.2 Holepunching and Upgrade Policy
Aura uses a relay-first, direct-upgrade model for NAT traversal:
- Start on relay as soon as both peers have a valid descriptor path.
- Exchange direct/reflexive candidates from descriptor facts.
- Launch bounded direct upgrade attempts (holepunch) in the background.
- Promote to direct when a recoverable direct path succeeds. Otherwise remain on relay.
Retry state is tracked with typed generations (CandidateGeneration, NetworkGeneration) and bounded backoff (AttemptBudget, BackoffWindow) in PeerConnectionActor. Generation changes reset retry budgets, which avoids stale retry loops after interface/NAT changes.
The runtime drives one such actor per (context, peer) in its service registry (PeerPathState). Every transport send toward the peer, and every channel preparation, asks that state which establish path to use: the relay when the peer advertises one, otherwise its first dialable direct endpoint. While on the relay, a send may also carry a bounded direct probe (a TCP connect to a direct candidate, nothing sent); a reachable listener promotes the state to direct, and a failed direct send degrades it back to the relay and carries the send over the relay. The candidate generation advances when the peer's usable path set changes; the network generation advances when the peer's own relay session is re-established. The current selection, with both generations and the attempts used, is the SelectedPeerPath observation exposed through the runtime bridge and surfaced as the peer_path_selected runtime event.
Recoverability is evaluated from local binding/interface provenance, not from reflexive addresses alone. This prevents treating stale external mappings as viable direct paths.
Operationally:
- Relay path is the safety baseline.
- Direct holepunch is an optimization path.
- Network changes can trigger a fresh upgrade cycle without dropping relay connectivity.
3.3 Relay Transport
A relay-capable node (serve_relay in the agent network configuration) accepts relay registrations on its ordinary transport listener. A peer configured with a relay_address keeps one outbound TCP connection to that node (RelaySessionService): it sends a register control frame naming its authority and device, receives a registered acknowledgment that names the relay's authority, then keeps the session alive with periodic keepalive frames that the relay acknowledges. A missing acknowledgment or a broken socket ends the session; the peer reconnects with bounded backoff and advances its network generation.
The acknowledgment carries the relay's own descriptor, which the peer caches like any other descriptor. While registered, the peer's published descriptor carries a WebSocketRelay transport hint naming only the relay authority; addresses never enter a relay hint. A sender whose path state selects that hint resolves the relay authority to a dialable address from the relay's descriptor (cached from its own registration acknowledgment, or propagated like any descriptor), dials the relay and writes the frame unchanged; the relay (RelayForwarderActor) reads only the frame's routing header and writes it down the destination's session connection (the matching device when the frame is device-addressed, every registered device otherwise). The frame keeps the sender's guard-chain receipt, so the receiver's LAN integrity check is the same as for a direct frame. Control frames never enter the runtime inbox, and a node that does not serve as a relay drops frames addressed to other authorities.
Registration binds an authority id to a connection without proving the registrant holds that authority's keys. Payloads are end-to-end protected, so a false registration can only divert or drop frames; the relay forwards only to registered destinations and only from accepted connections, and later registrations for the same authority and device replace earlier ones. Authenticated registration against the registrant's descriptor key is a follow-up.
4. Data Structures
4.1 Domain Facts
Rendezvous uses domain facts in the relational context journal. Facts are propagated via journal synchronization.
#![allow(unused)] fn main() { /// Rendezvous domain facts stored in context journals pub enum RendezvousFact { /// Transport descriptor advertisement Descriptor(RendezvousDescriptor), /// Channel established acknowledgment ChannelEstablished { initiator: AuthorityId, responder: AuthorityId, channel_id: [u8; 32], epoch: u64, }, /// Descriptor revocation DescriptorRevoked { authority_id: AuthorityId, nonce: [u8; 32], }, } }
4.2 Rendezvous Descriptors
#![allow(unused)] fn main() { /// Rendezvous descriptor for peer discovery pub struct RendezvousDescriptor { /// Authority publishing this descriptor pub authority_id: AuthorityId, /// Context this descriptor is for pub context_id: ContextId, /// Legacy connectivity hints used to derive split views pub transport_hints: Vec<TransportHint>, /// Handshake PSK commitment (hash of PSK derived from context) pub handshake_psk_commitment: [u8; 32], /// Public key for Noise IK handshake (Ed25519 public key) pub public_key: [u8; 32], /// Validity window start (ms since epoch) pub valid_from: u64, /// Validity window end (ms since epoch) pub valid_until: u64, /// Nonce for uniqueness pub nonce: [u8; 32], /// What the peer wants to be called (optional, for UI purposes) pub nickname_suggestion: Option<String>, } }
A WebSocketRelay hint names only the relay authority. The relay's own descriptor, not the hint, says where the relay is reached, so a relay can move without every peer republishing.
RendezvousDescriptor is the authoritative shared object in the journal. Callers derive LinkEndpoint and ServiceDescriptor views from it. This keeps the fact schema stable during migration while preventing route policy from hardening into the fact format.
Bootstrap records follow the same rule. Shared bootstrap contact hints and neighborhood re-entry hints are typed, expiring, replay-bounded records. They are valid only inside their scoped contexts. They do not encode final route policy, trust tier, or canonical provider ranking.
4.3 Split Connectivity and Service Surfaces
#![allow(unused)] fn main() { pub struct LinkEndpoint { pub protocol: LinkProtocol, pub address: Option<String>, pub relay_authority: Option<AuthorityId>, } pub struct ServiceDescriptor { pub header: ServiceDescriptorHeader, pub kind: ServiceDescriptorKind, } pub struct EstablishPath { pub route: Route, } pub struct MovePath { pub route: Route, } }
LinkEndpoint answers how a peer may be reached. ServiceDescriptor answers what service family is being advertised. Runtime-owned selection state combines these views with local policy and social inputs. The selected provider should observe only the generic service action, not the social reason it was chosen.
EstablishPath and MovePath are the explicit path objects consumed by current bootstrap and movement flows. They are derived from descriptor views plus runtime-local policy, but they remain socially neutral: home, neighborhood, guardian, friend, and similar provider roles must not appear in the path schema itself.
Anonymous path establishment uses the same Establish family boundary. aura-rendezvous validates path objects and descriptor inputs. aura-agent owns reusable anonymous path lifecycle, route choice, and path reuse policy.
5. MPST Choreographies
Rendezvous protocols are defined as MPST choreographies with guard annotations.
5.1 Direct Exchange Protocol
#![allow(unused)] fn main() { tell! { #[namespace = "rendezvous_exchange"] protocol RendezvousExchange { roles: Initiator, Responder; // Initiator publishes descriptor (fact insertion, propagates via sync) Initiator[guard_capability = "rendezvous:publish", journal_facts = "descriptor_offered"] -> Responder: DescriptorOffer(RendezvousDescriptor); // Responder publishes response descriptor Responder[guard_capability = "rendezvous:publish", journal_facts = "descriptor_answered"] -> Initiator: DescriptorAnswer(RendezvousDescriptor); // Direct channel establishment Initiator[guard_capability = "rendezvous:connect", -> Responder: HandshakeInit(NoiseHandshake); Responder[guard_capability = "rendezvous:connect", journal_facts = "channel_established"] -> Initiator: HandshakeComplete(NoiseHandshake); } } }
5.2 Relayed Protocol
#![allow(unused)] fn main() { tell! { #[namespace = "relayed_rendezvous"] protocol RelayedRendezvous { roles: Initiator, Relay, Responder; Initiator[guard_capability = "rendezvous:relay",] -> Relay: RelayRequest(RelayEnvelope); Relay[guard_capability = "relay:forward", leak = "neighbor:1"] -> Responder: RelayForward(RelayEnvelope); Responder[guard_capability = "rendezvous:relay"] -> Relay: RelayResponse(RelayEnvelope); Relay[guard_capability = "relay:forward", leak = "neighbor:1"] -> Initiator: RelayComplete(RelayEnvelope); } } }
6. Descriptor Propagation
Descriptors propagate via journal synchronization. This replaces custom flooding.
- Authority creates a
RendezvousFact::Descriptorfact - Guard chain evaluates the publication request
- On success, fact is inserted into the context journal
- Journal sync (
aura-sync) propagates facts to context participants - Peers query journal for peer descriptors
This model provides:
- Deduplication: Journal sync handles duplicate facts naturally
- Ordering: Facts have causal ordering via journal timestamps
- Authorization: Guard chain validates before insertion
- Consistency: Same propagation mechanism as other domain facts
6.1 aura-sync Integration
The aura-sync crate provides a RendezvousAdapter that bridges peer discovery with runtime-owned descriptor snapshots:
#![allow(unused)] fn main() { use aura_sync::infrastructure::RendezvousAdapter; // Create adapter using the local authority identity. let adapter = RendezvousAdapter::new(local_authority); // Query peer info from a runtime-owned descriptor snapshot. if let Some(peer_info) = adapter.get_peer_info(&descriptors, context_id, peer, now_ms) { if peer_info.has_direct_transport() { // Use direct connection } } // Check which peers need descriptor refresh let stale_peers = adapter.peers_needing_refresh(&descriptors, context_id, now_ms); }
The adapter is a pure view helper. It does not own or mutate the cache. The runtime cache stays in aura-agent.
6.2 Social Inputs and Route Selection
Rendezvous may consume socially rooted provider inputs, but it does not own social topology or trust evaluation. The Neighborhood Plane and Web of Trust Plane produce permit and candidate inputs. The runtime combines those inputs with descriptor views and local policy.
This separation is required for privacy. Shared descriptor facts must not expose route classes such as "friend relay" or "neighborhood hold". The selected provider should observe only the generic service action. The current descriptor view therefore advertises generic Hold surfaces for deferred-delivery and cache-replica retention, while selector issuance, holder rotation, and retrieval policy remain runtime-local. See Social Architecture for the plane split.
7. Protocol Flow
The rendezvous sequence uses the context between two authorities.
sequenceDiagram
participant A as Authority A
participant J as Context Journal
participant B as Authority B
A->>A: Build descriptor
A->>A: Evaluate guards
A->>J: Insert descriptor fact
J-->>B: Sync descriptor fact
B->>B: Query descriptor
B->>A: Select transport
A->>B: Noise IKpsk2 handshake
B->>J: Record ChannelEstablished fact
8. Guard Chain Integration
All rendezvous operations flow through the guard chain.
8.1 Guard Capabilities
#![allow(unused)] fn main() { pub mod guards { pub const CAP_RENDEZVOUS_PUBLISH: &str = "rendezvous:publish"; pub const CAP_RENDEZVOUS_CONNECT: &str = "rendezvous:connect"; pub const CAP_RENDEZVOUS_RELAY: &str = "rendezvous:relay"; } }
8.2 Flow Costs
#![allow(unused)] fn main() { pub const DESCRIPTOR_PUBLISH_COST: u32 = 1; pub const CONNECT_DIRECT_COST: u32 = 2; pub const CONNECT_RELAY_COST: u32 = 3; pub const RELAY_FORWARD_COST: u32 = 1; }
8.3 Guard Evaluation
The service prepares operations and returns GuardOutcome containing effect commands. The caller executes these commands.
#![allow(unused)] fn main() { // 1. Prepare snapshot of current state let snapshot = GuardSnapshot { authority_id: alice, context_id: context, flow_budget_remaining: 100, capabilities: vec!["rendezvous:publish".into()], epoch: 1, }; // 2. Prepare publication (pure, sync) let outcome = service.prepare_publish_descriptor( &snapshot, context, transport_hints, now_ms ); // 3. Check decision and execute effects if outcome.decision.is_allowed() { for cmd in outcome.effects { execute_effect_command(cmd).await?; } } }
9. Secure Channel Establishment
After receiving a valid descriptor, the initiator selects a transport. Both sides run Noise IKpsk2 using a context-derived PSK. Successful handshake yields a SecureChannel.
9.1 Channel Structure
#![allow(unused)] fn main() { pub struct SecureChannel { /// Unique channel identifier channel_id: [u8; 32], /// Context this channel belongs to context_id: ContextId, /// Local authority local: AuthorityId, /// Remote peer remote: AuthorityId, /// Current epoch (for key rotation) epoch: u64, /// Channel state state: ChannelState, /// Agreement mode (A1/A2/A3) for the channel lifecycle agreement_mode: AgreementMode, /// Whether reversion is still possible reversion_risk: bool, /// Whether the channel needs key rotation needs_rotation: bool, /// Bytes sent on this channel (for flow budget tracking) bytes_sent: u64, /// Bytes received on this channel bytes_received: u64, } pub enum ChannelState { Establishing, Active, Rotating, Closed, Error(String), } }
9.2 Channel Manager
The ChannelManager tracks active channels:
#![allow(unused)] fn main() { let mut manager = ChannelManager::new(); // Register a new channel manager.register(channel); // Find channel by context and peer if let Some(ch) = manager.find_by_context_peer(context, peer) { if ch.is_active() { // Use channel } } // Advance epoch and mark channels for rotation manager.advance_epoch(new_epoch); }
9.3 Handshake Flow
The Handshaker state machine handles Noise IKpsk2:
#![allow(unused)] fn main() { // Initiator side let mut initiator = Handshaker::new(HandshakeConfig { local: alice, remote: bob, context_id: context, psk: derived_psk, timeout_ms: 5000, }); let init_msg = initiator.create_init_message(epoch)?; // ... send init_msg to responder ... initiator.process_response(&response_msg)?; let result = initiator.complete(epoch, true)?; let channel = initiator.build_channel(&result)?; }
9.4 Key Rotation
Channels support epoch-based key rotation. When the epoch advances, channels rekey using the new context-derived PSK.
#![allow(unused)] fn main() { impl SecureChannel { pub fn needs_epoch_rotation(&self, current_epoch: u64) -> bool { self.epoch < current_epoch } pub fn rotate(&mut self, new_epoch: u64) -> AuraResult<()> { // Rekey the channel self.state = ChannelState::Rotating; self.epoch = new_epoch; self.needs_rotation = false; self.state = ChannelState::Active; Ok(()) } } }
10. Service Interface
The rendezvous service coordinates descriptor publication and channel establishment.
#![allow(unused)] fn main() { impl RendezvousService { /// Create a new rendezvous service pub fn new(authority_id: AuthorityId, config: RendezvousConfig) -> Self; /// Prepare to publish descriptor to context journal pub fn prepare_publish_descriptor( &self, snapshot: &GuardSnapshot, context_id: ContextId, transport_hints: Vec<TransportHint>, now_ms: u64, ) -> GuardOutcome; /// Prepare to establish channel with peer pub fn prepare_establish_channel( &self, snapshot: &GuardSnapshot, context_id: ContextId, peer: AuthorityId, psk: &[u8; 32], ) -> AuraResult<GuardOutcome>; /// Prepare to handle incoming handshake pub fn prepare_handle_handshake( &self, snapshot: &GuardSnapshot, context_id: ContextId, initiator: AuthorityId, handshake: NoiseHandshake, psk: &[u8; 32], ) -> GuardOutcome; /// Cache a peer's descriptor (from journal sync) pub fn cache_descriptor(&mut self, descriptor: RendezvousDescriptor); /// Get a cached descriptor pub fn get_cached_descriptor( &self, context_id: ContextId, peer: AuthorityId, ) -> Option<&RendezvousDescriptor>; /// Check if our descriptor needs refresh pub fn needs_refresh( &self, context_id: ContextId, now_ms: u64, refresh_window_ms: u64, ) -> bool; } }
11. Effect Commands
The service returns GuardOutcome with effect commands to execute:
#![allow(unused)] fn main() { pub enum EffectCommand { /// Append fact to journal JournalAppend { fact: RendezvousFact }, /// Charge flow budget ChargeFlowBudget { cost: FlowCost }, /// Send handshake init message SendHandshake { peer: AuthorityId, message: HandshakeInit }, /// Send handshake response SendHandshakeResponse { peer: AuthorityId, message: HandshakeComplete }, /// Record operation receipt RecordReceipt { operation: String, peer: AuthorityId }, } }
12. Failure Modes and Privacy
Failures occur during guard evaluation, descriptor validation, or transport establishment. These failures are local. No network packets reveal capability or budget failures.
Context isolation prevents unauthorized authorities from reading descriptors. Transport hints do not reveal authority structure. Relay identifiers reveal only the relay authority. Descriptor contents remain encrypted for transit.
13. Summary
Rendezvous provides encrypted peer discovery and channel establishment scoped to relational contexts. Descriptors propagate through journal synchronization with guard chain enforcement. Secure channels use Noise IKpsk2 and QUIC. All behavior remains private to the context and reveals no structural information. The architecture uses standard Aura primitives: domain facts, guard chains, MPST choreographies, and effect interpretation.
Required Contact response state
A verified Contact response is bound to the retained imported invitation, its issuer point and the exact acknowledged acceptance digest. The response owner carries that complete state through materialization. Missing, malformed, oversized or mismatched required backing metadata cannot be replaced by a cached Pending state. Invalid signatures remain distinct from failures of the cryptographic provider.
Relational Contexts
This document describes the architecture of relational contexts in Aura. It explains how cross-authority relationships are represented using dedicated context namespaces. It defines the structure of relational facts and the role of Consensus in producing agreed relational state. It also describes privacy boundaries and the interpretation of relational data by participating authorities.
Relational contexts are distinct from authority types. In particular, Neighborhood is modeled as an authority type in the Neighborhood Plane as described in Social Architecture. Bilateral trust in the Web of Trust Plane is modeled as relational-context state, not as a new authority type.
1. RelationalContext Abstraction
A relational context is shared state linking two or more authorities. A relational context has its own Journal namespace. A relational context does not expose internal authority structure. A relational context contains only the facts that the participating authorities choose to share.
A relational context is identified by a ContextId. Authorities publish relational facts inside the context journal. The context journal is a join semilattice under set union. Reduction produces a deterministic relational state.
#![allow(unused)] fn main() { pub struct ContextId(Uuid); }
This identifier selects the journal namespace for a relational context. It does not encode participant information. It does not reveal the type of relationship. Only the participants know how the context is used.
2. Participants and Fact Store
A relational context has a defined set of participating authorities. This set is not encoded in the ContextId. Participation is expressed by writing relational facts to the context journal. Each fact references the commitments of the participating authorities.
#![allow(unused)] fn main() { /// Relational facts in `aura-journal/src/fact.rs` pub enum RelationalFact { /// Protocol-level facts with core reduction semantics Protocol(ProtocolRelationalFact), /// Domain-level extensibility facts Generic { context_id: ContextId, envelope: FactEnvelope }, } /// Typed fact envelope (from aura-core/src/types/facts.rs) pub struct FactEnvelope { pub type_id: FactTypeId, pub schema_version: u16, pub encoding: FactEncoding, pub payload: Vec<u8>, } }
The Protocol variant wraps core protocol facts that have specialized reduction logic in reduce_context(). These include GuardianBinding, RecoveryGrant, Consensus, AMP channel facts, DKG transcript commits, and lifecycle markers. The Generic variant provides extensibility for domain-specific facts using FactEnvelope which contains a typed payload with schema versioning.
AMP channel facts include checkpoints, transition proposals, A2 certificates, A3 finalizations, abort evidence, conflict evidence, supersession evidence, and emergency alarms. These facts remain scoped to the relational context. They do not change authority-root membership, recovery rights, guardian bindings, or account commitment trees.
Domain crates implement the DomainFact trait from aura-journal/src/extensibility.rs. They store facts via DomainFact::to_generic() which produces a FactEnvelope. The runtime registers reducers in crates/aura-agent/src/fact_registry.rs so reduce_context() can process Generic facts into RelationalBinding values.
3. Prestate Model
Relational context operations use a prestate model. Aura Consensus verifies that all witnesses see the same authority states. The prestate hash binds the relational fact to current authority states.
#![allow(unused)] fn main() { let prestate_hash = H(C_auth1, C_auth2, C_context); }
This hash represents the commitments of the authorities and the current context. Aura Consensus witnesses check this hash before producing shares. The final commit fact includes a threshold signature over the relational operation.
4. Types of Relational Contexts
Several categories of relational contexts appear in Aura. Each fact type carries a well-defined schema to ensure deterministic reduction.
Neighborhood governance and home-membership state are recorded in neighborhood authority journals, not in relational context journals. Relational contexts are still used for pairwise and small-group cross-authority relationships such as guardian bindings, recovery grants, and application-specific collaboration contexts.
WebOfTrustContext
Direct friendship is modeled as a bilateral relational context between authorities. Contact remains unilateral reachability or identification state. Friendship requires explicit bilateral acceptance. Friendship is not represented as a new authority object.
A known contact relationship and a verified device-key binding are separate facts. A fresh invitation from a known contact may establish continuity with a previously confirmed invitation key, but that continuity does not by itself authenticate a newly claimed device ID or a rotated key. If the device binding is unresolved, the import outcome remains unresolved or already linked rather than treating a valid code as malformed.
The context stores lifecycle facts such as proposal, acceptance, and revocation. It may also store bounded trust-introduction artifacts. Those artifacts carry expiry, remaining depth, and fan-out limits. Runtime policy may use the resulting evidence as permit input, but the shared facts do not hard-code runtime policy tiers.
Bounded bootstrap introductions follow the same model. A direct friend may publish an introduction artifact that helps stale-node re-entry or first-contact bootstrap, but the artifact remains scoped to the relational context, carries explicit expiry and replay bounds, and does not materialize a shared friend-of-friend graph. Runtime code may amplify re-entry attempts from that evidence only within the stated depth and fan-out limits.
GuardianConfigContext
Stores GuardianBinding facts:
{
"type": "GuardianBinding",
"account_commitment": "Hash32",
"guardian_commitment": "Hash32",
"parameters": {
"recovery_delay_secs": 86400,
"notification_required": true
},
"consensus_commitment": "Hash32",
"consensus_proof": "ThresholdSignature"
}
account_commitment: reduced commitment of the protected authority.guardian_commitment: reduced commitment of the guardian authority.parameters: serialized GuardianParameters (delay, notification policy, etc.).consensus_commitment: commitment hash of the Aura Consensus instance that approved the binding.consensus_proof: aggregated signature from the witness set.
GuardianRecoveryContext
Stores RecoveryGrant facts:
{
"type": "RecoveryGrant",
"account_commitment_old": "Hash32",
"account_commitment_new": "Hash32",
"guardian_commitment": "Hash32",
"operation": {
"kind": "ReplaceTree",
"payload": "Base64(TreeOp)"
},
"consensus_commitment": "Hash32",
"consensus_proof": "ThresholdSignature"
}
account_commitment_old/new: before/after commitments for the account authority.guardian_commitment: guardian authority that approved the grant.operation: serialized recovery operation (matches TreeOp schema).consensus_*: Aura Consensus identifiers tying the grant to witness approvals.
Generic / Application Contexts
Shared group or project contexts can store application-defined facts:
{
"type": "Generic",
"payload": "Base64(opaque application data)",
"bindings": ["Hash32 commitment of participant A", "Hash32 commitment of participant B"],
"labels": ["project:alpha", "role:reviewer"]
}
Generic facts should include enough metadata (bindings, optional labels) for interpreters to apply context-specific rules.
5. Relational Facts
Relational facts express specific cross-authority operations. A GuardianBinding fact defines the guardian authority for an account while a RecoveryGrant fact defines an allowed update to the account state. A Generic fact covers application defined interactions. Consensus-backed facts include the consensus_commitment and aggregated signature so reducers can verify provenance even after witnesses rotate.
Guardian invitation confirmation is bound to the invitation, both authorities, and the inviter proof key carried by the issued code. The guardian accepts with a signed recovery key and names that inviter proof key. After verifying and recording the acceptance, the principal confirms with its retained matching signing key. Rotation of the principal's current identity key does not change the key expected by an already issued invitation; if the matching key is unavailable, confirmation fails.
SessionDelegation protocol facts record runtime endpoint transfer events. Aura emits these facts when session ownership moves across authorities (for example, guardian handoff or device migration). Each delegation fact includes source authority, destination authority, session id, optional bundle id, and timestamp so reconfiguration decisions remain auditable.
Reduction applies all relational facts to produce relational state. Reduction verifies that authority commitments in each fact match the current reduced state of each authority.
#![allow(unused)] fn main() { /// Reduced relational state from aura-journal/src/reduction.rs pub struct RelationalState { /// Active relational bindings pub bindings: Vec<RelationalBinding>, /// Flow budget state by context pub flow_budgets: BTreeMap<(AuthorityId, AuthorityId, u64), u64>, /// Leakage budget totals for privacy accounting pub leakage_budget: LeakageBudget, /// AMP channel epoch state keyed by channel id pub channel_epochs: BTreeMap<ChannelId, ChannelEpochState>, } pub struct RelationalBinding { pub binding_type: RelationalBindingType, pub context_id: ContextId, pub data: Vec<u8>, } }
This structure represents the reduced relational state. It contains relational bindings, flow budget tracking between authorities, leakage budget totals for privacy accounting, and AMP channel epoch state for message ratcheting. Reduction processes all facts in the context journal to derive this state deterministically.
6. Aura Consensus in Relational Contexts
Some relational operations require strong agreement. Consensus produces these operations. Aura Consensus uses a witness set drawn from participating authorities. Witnesses compute shares after verifying the prestate hash.
Commit facts contain threshold signatures. Each commit fact is inserted into the relational context journal. Reduction interprets the commit fact as a confirmed relational operation.
Aura Consensus binds relational operations to authority state. After consensus completes, the initiator inserts a CommitFact into the relational context journal that includes:
#![allow(unused)] fn main() { pub struct RelationalCommitFact { pub context_id: ContextId, pub consensus_commitment: Hash32, // H(Op, prestate) pub fact: RelationalFact, // GuardianBinding, RecoveryGrant, etc. pub aggregated_signature: ThresholdSignature, pub attesters: BTreeSet<AuthorityId>, } }
Reducers validate aggregated_signature before accepting the embedded RelationalFact. This mirrors the account-level process but scoped to the context namespace.
7. Interpretation of Relational State
Authorities interpret relational state by reading the relational context journal. An account reads GuardianBinding facts to determine its guardian authority. A guardian authority reads the same facts to determine which accounts it protects.
Other relational contexts follow similar patterns. Each context defines its own interpretation rules. No context affects authority internal structure. Context rules remain confined to the specific relationship.
For web-of-trust contexts, direct-friend state is authoritative shared state. Friend-of-friend state is not. Runtime components derive introduced or transitive trust locally from direct-friend edges plus bounded introduction artifacts. This avoids turning the transitive social graph into canonical shared state.
8. Privacy and Isolation
A relational context does not reveal its participants. The ContextId is opaque. Only participating authorities know the relationship. No external party can infer connections between authorities based on context identifiers.
Profile information shared inside a context stays local to that context. Nickname suggestions and contact attributes do not leave the context journal. Each context forms a separate identity boundary. Authorities can maintain many unrelated relationships without cross linking.
Trust evidence must follow the same boundary rule. Shared facts may record bilateral friend lifecycle state and bounded introductions. They must not expose wire-visible service classes such as direct_friend_relay or introduced_hold. Any coarse policy tier is derived locally in the runtime from evidence provenance.
Bootstrap use does not change that rule. A bounded bootstrap introduction is evidence, not a route commitment. It can seed local runtime discovery or stale-node re-entry, but it must not become a canonical shared topology edge or a shared provider-class label.
9. Implementation Patterns
The implementation in aura-relational provides concrete patterns for working with relational contexts.
Creating and Managing Contexts
#![allow(unused)] fn main() { use aura_core::{AuthorityId, ContextId}; use aura_relational::RelationalContext; // Create a new guardian-account relational context let account_authority = AuthorityId::from_entropy([1u8; 32]); let guardian_authority = AuthorityId::from_entropy([2u8; 32]); let context = RelationalContext::new(vec![account_authority, guardian_authority]); // Or use a specific context ID let context_id = ContextId::from_entropy([3u8; 32]); let context = RelationalContext::with_id( context_id, vec![account_authority, guardian_authority], ); // Check participation assert!(context.is_participant(&account_authority)); assert!(context.is_participant(&guardian_authority)); }
Guardian Binding Pattern
#![allow(unused)] fn main() { use aura_core::relational::{GuardianBinding, GuardianParameters}; use std::time::Duration; let params = GuardianParameters { recovery_delay: Duration::from_secs(86400), notification_required: true, // Use Aura's unified time system (PhysicalTimeEffects/TimeStamp) for expiration. expiration: None, }; let binding = GuardianBinding::new( Hash32::from_bytes(&account_authority.to_bytes()), Hash32::from_bytes(&guardian_authority.to_bytes()), params, ); // Store a binding receipt + full payload via the context's journal-backed API context.add_guardian_binding(account_authority, guardian_authority, binding)?; }
Recovery Grant Pattern
#![allow(unused)] fn main() { use aura_core::relational::{RecoveryGrant, RecoveryOp, ConsensusProof}; // Construct a recovery operation let recovery_op = RecoveryOp::AddDevice { device_public_key: new_device_pubkey.to_bytes(), }; // Create recovery grant (requires consensus proof) let grant = RecoveryGrant { account_old: old_tree_commitment, account_new: new_tree_commitment, guardian: guardian_commitment, operation: recovery_op, consensus_proof: consensus_result.proof, // From Aura Consensus }; // Add to recovery context recovery_context.add_fact(RelationalFact::RecoveryGrant(grant))?; // Check operation type if grant.operation.is_emergency() { // Handle emergency operations immediately execute_emergency_recovery(&grant)?; } }
Query Patterns
#![allow(unused)] fn main() { // Query guardian bindings let bindings = context.guardian_bindings(); for binding in bindings { println!("Guardian: {:?}", binding.guardian_commitment); println!("Recovery delay: {:?}", binding.parameters.recovery_delay); if let Some(expiration) = binding.parameters.expiration { if expiration < Utc::now() { // Binding has expired } } } // Find specific guardian binding if let Some(binding) = context.get_guardian_binding(account_authority) { // Found guardian for this account let guardian_id = binding.guardian_commitment; } // Query recovery grants let grants = context.recovery_grants(); for grant in grants { println!("Operation: {}", grant.operation.description()); println!("From: {:?} -> To: {:?}", grant.account_old, grant.account_new); } }
Generic Binding Pattern
#![allow(unused)] fn main() { use aura_core::relational::{GenericBinding, RelationalFact}; use aura_core::types::facts::{FactEnvelope, FactTypeId, FactEncoding}; // Application-specific binding (e.g., project collaboration) let payload = serde_json::to_vec(&ProjectMetadata { name: "Alpha Project", role: "Reviewer", permissions: vec!["read", "comment"], })?; let envelope = FactEnvelope { type_id: FactTypeId::new("project_collaboration"), schema_version: 1, encoding: FactEncoding::Json, payload, }; let generic = GenericBinding::new(envelope, None); // No consensus proof context.add_fact(RelationalFact::Generic(generic))?; }
Prestate Computation Pattern
#![allow(unused)] fn main() { use aura_core::Prestate; // Collect current authority commitments let authority_commitments = vec![ (account_authority, account_tree_commitment), (guardian_authority, guardian_tree_commitment), ]; // Compute prestate for consensus let prestate = context.compute_prestate(authority_commitments); // Use prestate in consensus protocol let consensus_result = run_consensus( prestate, operation_data, witness_set, ).await?; }
Journal Commitment Pattern
#![allow(unused)] fn main() { // Get deterministic commitment of current relational state let commitment = context.journal.compute_commitment(); // Commitment is deterministic - all replicas compute same value // Used for: // - Prestate computation in consensus // - Context verification // - Anti-entropy sync checkpoints }
Integration with Aura Consensus
#![allow(unused)] fn main() { use aura_consensus::relational::run_consensus; use aura_core::relational::ConsensusProof; use aura_effects::random::RealRandomHandler; use aura_effects::time::PhysicalTimeHandler; // 1. Prepare operation requiring consensus let binding = GuardianBindingBuilder::new() .account(account_commitment) .guardian(guardian_commitment) .build()?; // 2. Compute prestate let prestate = context.compute_prestate(authority_commitments); // 3. Run consensus let random = RealRandomHandler; let time = PhysicalTimeHandler; let consensus_proof = run_consensus( context.context_id, &prestate, &binding, key_packages, group_public_key, epoch, &random, &time, ).await?; // 4. Attach proof to fact let binding_with_proof = GuardianBinding { consensus_proof: Some(consensus_proof), ..binding }; // 5. Add to context context.add_fact(RelationalFact::GuardianBinding(binding_with_proof))?; }
Recovery Operation Selection
#![allow(unused)] fn main() { use aura_core::relational::RecoveryOp; // Select appropriate recovery operation let recovery_op = match recovery_scenario { RecoveryScenario::LostAllDevices => RecoveryOp::ReplaceTree { new_tree_root: new_tree_commitment, }, RecoveryScenario::AddNewDevice => RecoveryOp::AddDevice { device_public_key: device_key.to_bytes(), }, RecoveryScenario::RemoveCompromised => RecoveryOp::RemoveDevice { leaf_index: compromised_device_index, }, RecoveryScenario::ChangeThreshold => RecoveryOp::UpdatePolicy { new_threshold: new_m_of_n.0, }, RecoveryScenario::EmergencyCompromise => RecoveryOp::EmergencyRotation { new_epoch: current_epoch + 1, }, }; // Emergency operations bypass delay if recovery_op.is_emergency() { // No recovery_delay applied } else { // Wait for binding.parameters.recovery_delay } }
Best Practices
Guardian configuration:
- Use 24-hour minimum recovery delay for security
- Always require notification unless emergency scenario
- Set expiration for temporary guardian relationships
- Rotate guardian bindings periodically
Recovery grants:
- Always require consensus proof for recovery operations
- Validate prestate commitments before accepting grants
- Log all recovery operations for audit trail
- Emergency operations should be rare and logged prominently
Generic bindings:
- Document your FactTypeId schemas externally
- Use schema_version field to version your payload format
- Include consensus_proof for critical application bindings
- Keep payload size reasonable for sync performance
Context management:
- Use opaque ContextId - never encode participant info
- Limit participants to 2-10 authorities for efficiency
- Separate contexts for different relationship types
- Garbage collect expired bindings periodically
Lifecycle notes:
- A1/A2 facts are usable immediately but are provisional. Any durable relational state must be A3 (consensus-finalized).
- Soft-safe operations should emit
ConvergenceCertandReversionFactprotocol facts to make convergence and reversion risk explicit.
10. Contexts vs Channels: Operation Categories
Understanding the distinction between relational contexts and channels is essential for operation categorization.
10.1 Relational Contexts (Category C - Consensus Required)
Creating a relational context establishes a cryptographic relationship between authorities. This is a Category C (consensus-gated) operation because:
- It creates the shared secret foundation for all future communication
- Both parties must agree to establish the relationship
- Partial state (one party thinks relationship exists, other doesn't) is dangerous
Examples:
- Adding a contact (bilateral context between two authorities)
- Creating a group (multi-party context with all members)
- Adding a member to an existing group (extends the cryptographic context)
10.2 Channels Within Contexts (Category A - Optimistic)
Once a relational context exists, channels are Category A (optimistic) operations:
- Channels are just organizational substreams within the context
- No new cryptographic agreement needed - keys derive from context
- Channel facts sync via anti-entropy, eventual consistency is sufficient
Examples within existing context:
- Create channel → emit
ChannelCheckpointfact - Send message → derive key from context, encrypt, send
- Update topic → emit fact to context journal
10.3 The Cost Structure
BILATERAL MULTI-PARTY
(2 members) (3+ members)
─────────── ────────────
Context Creation Invitation ceremony Group ceremony
(Category C - expensive) (Category C - expensive)
Member Addition N/A (already 2) Per-member ceremony
(Category C - expensive)
Channel Creation Optimistic Optimistic
(Category A - cheap) (Category A - cheap)
Messages Optimistic Optimistic
(Category A - cheap) (Category A - cheap)
The expensive part is establishing WHO is in the group. Once that's established, operations WITHIN the group are cheap.
10.4 Multi-Party Context Keys
Groups with >2 members derive keys from all member tree roots:
GroupContext {
context_id: ContextId,
members: [Alice, Bob, Carol],
group_secret: DerivedFromMemberTreeRoots,
epoch: u64,
}
Key Derivation:
1. Each member contributes their tree root commitment
2. Group secret = KDF(sorted_member_roots, context_id)
3. Channel key = KDF(group_secret, channel_id, epoch)
All members derive the SAME group secret from the SAME inputs
10.5 Why Membership Changes Require Ceremony
Group membership changes are Category C because they affect encryption:
-
Forward Secrecy: New members shouldn't read old messages
- Solution: Epoch rotation, new keys for new messages
-
Post-Compromise Security: Removed members shouldn't read new messages
- Solution: Epoch rotation, re-derive group secret without removed member
-
Consistency: All members must agree on who's in the group
- Solution: Ceremony ensures atomic membership view
See Operation Categories for the full decision tree.
11. Summary
Relational contexts represent cross-authority relationships in Aura. They provide shared state without revealing authority structure and support guardian configuration, recovery, and application specific collaboration. Aura Consensus ensures strong agreement where needed while deterministic reduction ensures consistent relational state. Privacy boundaries isolate each relationship from all others.
The implementation provides concrete types (RelationalContext, GuardianBinding, RecoveryGrant) with builder patterns, query methods, and consensus integration. All relational facts are stored in a CRDT journal with deterministic commitment computation.
12. Implementation References
- Core Types:
aura-core/src/relational/- RelationalFact, GuardianBinding, RecoveryGrant, ConsensusProof domain types - Journal Facts:
aura-journal/src/fact.rs- Protocol-level RelationalFact with AMP variants - Reduction:
aura-journal/src/reduction.rs- RelationalState, reduce_context() - Context Management:
aura-relational/src/lib.rs- RelationalContext (context-scoped fact journal mirror + helpers) - Consensus Integration:
crates/aura-consensus/src/consensus/relational.rs- consensus implementation - Consensus Integration:
aura-consensus/src/relational.rs- direct relational consensus with explicit time/random effect ownership - Prestate Computation:
aura-core/src/domain/consensus.rs- Prestate struct and methods - Protocol Usage:
aura-authentication/src/guardian_auth_relational.rs- Guardian authentication - Recovery Flows:
aura-recovery/src/- Guardian recovery choreographies
See Also
- Operation Categories - Ceremony contract, guardian rotation, device enrollment, and Category B/C operations
- Consensus - Aura Consensus protocol for strong agreement
Social Architecture
This document defines Aura's social organization model using two social planes plus the message contexts that run on top of them. The system layers privacy, consent, and governance into a Neighborhood Plane, a Web of Trust Plane, and the message contexts that consume their outputs.
1. Overview
1.1 Design Goals
The model produces human-scaled social structures with natural scarcity based on physical analogs. Organic community dynamics emerge from bottom-up governance. The design aligns with Aura's consent-based privacy guarantees and capability-based authorization.
1.2 Social Planes
The Neighborhood Plane models homes, neighborhoods, membership, moderation, and locality-scoped infrastructure. It answers who shares a local social space and which neighborhood-scoped providers are admissible.
The Web of Trust Plane models bilateral friend relationships and bounded introductions. It answers which providers have direct or introduced trust evidence. It does not own final route selection. It does not materialize the transitive trust graph as shared state.
Messages are communication contexts built on top of those planes. Direct messages are private relational contexts. Home messages are semi-public messaging for home members and participants.
1.3 Terminology
An authority (AuthorityId) is the cryptographic identity that holds capabilities and participates in consensus. A nickname is a local mapping from an authority to a human-understandable name. Each device maintains its own nickname mappings. There is no global username registry.
A nickname suggestion (nickname_suggestion) is metadata an authority optionally shares when connecting with someone. Users configure a default suggestion sent to all new connections. Users can share different suggestions with different people or opt out entirely.
Contact is unilateral reachability or identification state. It means the local user knows how to recognize or reach an authority. It does not imply bilateral trust. Removing a contact is therefore local: it deletes this authority's own record and does not notify the peer, whose contact record for this authority is unaffected. Ending bilateral trust is a Friend revocation, which both sides observe.
Friend is bilateral accepted trust in the Web of Trust Plane. Friend lifecycle facts live in relational contexts. Friends of friends are local derivations or bounded introduction evidence, not canonical shared graph state.
1.4 Unified Naming Pattern
The codebase uses a consistent naming pattern across entities (contacts, devices, discovered peers). The EffectiveName trait in aura-app/src/views/naming.rs defines the resolution order:
- Local nickname (user-assigned override) if non-empty
- Shared nickname_suggestion (what entity wants to be called) if non-empty
- Fallback identifier (truncated authority/device ID)
This pattern ensures consistent display names across all UI surfaces while respecting both local preferences and shared suggestions.
2. Message Types
2.1 Direct Messages
Direct messages are small private relational contexts built on AMP. There is no hop-based expansion across homes. All participants must be explicitly added. New members do not receive historical message sync.
2.2 Home Messages
Home messages are semi-public messaging for home members and participants. They use the same AMP infrastructure as direct messages. When a new participant joins, current members send a window of recent messages.
Membership and participation are tied to home policy. Leaving the home revokes access. Multiple channels may exist per home for different purposes.
#![allow(unused)] fn main() { pub struct HomeMessage { home_id: HomeId, channel: String, content: Vec<u8>, author: AuthorityId, timestamp: TimeStamp, } }
The message structure identifies the home, channel, content, author, and timestamp. Historical sync is configurable, typically the last 500 messages.
3. Home Architecture
3.1 Home Structure
A home is an authority-scoped context with its own journal. The total storage allocation is 10 MB. Capability templates define limited, partial, full, participant, and moderator patterns. Local governance is encoded via policy facts.
#![allow(unused)] fn main() { pub struct Home { /// Unique identifier for this home pub home_id: HomeId, /// Total storage limit in bytes pub storage_limit: u64, /// Maximum number of participants pub max_participants: u8, /// Maximum number of neighborhoods this home can join pub neighborhood_limit: u8, /// Current participants (authority IDs) pub participants: Vec<AuthorityId>, /// Current moderators with their capabilities pub moderators: Vec<(AuthorityId, ModeratorCapabilities)>, /// Current storage budget tracking pub storage_budget: HomeStorageBudget, } }
The home structure contains the identifier, storage limit, configuration limits, participant list, moderator designation list with capabilities, and storage budget tracking.
3.2 Membership and Participation
Home participation derives from possessing capability bundles, meeting entry requirements defined by policy, and allocating participant-specific storage. In v1, each user belongs to exactly one home. Home creation is user-initiated: accounts do not receive a home automatically at account creation. Instead, a user creates their home from the Neighborhood screen when they are ready to start connecting with others and participating in social features.
Joining a home follows a defined sequence. The authority requests capability. Home governance approves using local policy via Biscuit evaluation and consensus. The authority accepts the capability bundle and allocates storage. Historical home messages sync from current members.
3.3 Moderator Designation
Moderators are designated via governance decisions in the home. A moderator must also be a member. A home invitation grants participant access; a moderator holding grant_moderator admits a participant to the member set with HomeAdmitMemberFact (the /admit <user> command), after which the member can be designated moderator. Moderator capability bundles include moderation, pin and unpin operations, and governance facilitation. Moderator designation is auditable because capability issuance is visible via relational facts.
3.4 Order-Independent Governance Reduction
Home governance facts are bans, unbans, mutes, unmutes, kicks, moderator grants and revocations, access overrides, channel mode, the capability configuration, and member joins and leaves. They follow the canonical domain fact model of docs/105 §4.2.1 (schema 3; kicks schema 4; social facts schema 6). The writer obtains the fact's CausalMetadata from the runtime (RuntimeBridge::causal_stamp with CausalStampKey::HomeGovernance), which advances its logical clock past every governance fact it holds for the home.
- Bans and mutes are tagged observed-remove sets keyed by target and channel scope. An unban or unmute revokes the bans or mutes of that key its writer observed. A concurrent ban the writer did not observe stays in force.
- Member admissions are a tagged observed-remove set keyed by target: an admission by a moderator holding
grant_moderatormakes a joined participant a member until a kick or leave of that target that observed it. An admission that arrives before the join takes effect when the member joins. - Moderator designations are a tagged observed-remove set keyed by target. The creator is a permanent moderator. Roles are derived from the whole set, so a grant that arrives before the member joins takes effect when the member joins.
- Access overrides are a multi-value register per target. Concurrent surviving overrides resolve to the most restrictive level, then the later in causal order. The capability configuration is a multi-value register per home; concurrent survivors combine by per-level intersection.
- Channel mode is a multi-value register per home. A write supersedes only observed mode tags; concurrent surviving writes resolve to the lexicographically greatest flags. Only actors holding
manage_channelcontribute authorized writes. The committed register supplies the mode after synchronization and restart; frontends keep no independent mode cache. - Membership is a tagged observed-remove set of episodes. Each
MemberJoinedstarts the episode named by its member, context andepisode(the accepted invitation id, or a fixed label for the creator); the inviter and the invitee commit the same join under that id, so their copies are one episode. A kick, and aMemberLeft(schema 4), revoke the episodes of that member the writer observed. A member stays in the roster while any episode is live, so a later rejoin, or one concurrent with the kick, survives in every delivery order, including a reinstalled member that rejoins and then pulls the old kick through relational-context sync (Transport §11.4). A kick the writer issued without observing any join of the target removes nothing. - Kicks are also history entries shown in causal order.
- Authorization is evaluated against the moderator set and access state reduced from the whole fact set, not the state at arrival. A ban by a newly designated moderator holds in every delivery order. Override and capability-configuration writes name their actor, which must be a moderator holding
grant_moderator; because access state and moderator designations depend on each other, reduction is stratified: moderators under default access, then the authorized access registers, then moderators under that access state. - Without the
HomeCreatedfact the creator is unknown, so only targets of authorized designations have derived roles; other materialized roles are kept until creation is reduced. Relational-context sync servesHomeCreatedwith the governance facts. - The home view lists home-wide bans and mutes only. Channel-scoped bans and mutes are enforced per channel by the runtime moderation query.
- Banned members leave the visible roster and return when the ban is lifted.
The pure reducer is aura_app::views::home::reduce_home_governance. The home signal view keeps each home's governance fact set and reduces it after every batch.
3.5 Order-Independent Lifecycle Reduction
The remaining SocialFact pairs (schema 6) reduce in aura_social::lifecycle over the whole fact set; physical timestamps never order them.
- Home existence is a tagged observed-remove set. Each
HomeCreatedis an add tagged by its content. AHomeDeletedby the home's creator revokes the creations it observed; a deletion by anyone else, or one that observed no creation, removes nothing. Deletion is terminal: aHomeIdis minted once, so a recreated home is a newHomeId. A deleted home is never materialized, even when its creation arrives after the deletion. - Neighborhood membership is a tagged observed-remove set of episodes per home and neighborhood. A
HomeLeftNeighborhoodrevokes the joins its writer observed; a later join is a new episode and survives. The home view sets each home's fact-backed neighborhoods to the live set, rejoining in neighborhood-id order within the neighborhood budget. - Storage readings (
StorageUpdated) are a multi-value register per home. A write supersedes the writes its writer observed; concurrent survivors resolve to the largest usage, then the largest capacity, then the later write in causal order. - Neighborhood names come from
NeighborhoodCreated; duplicate creations of one id resolve to the smallest name.
SocialFact is registered in the agent FactRegistry with SocialFactReducer, which decodes through SocialFact::try_from_envelope. Moderator designations are HomeGrantModeratorFact and HomeRevokeModeratorFact only; member admissions are HomeAdmitMemberFact.
4. Neighborhood Architecture
4.1 Neighborhood Structure
A neighborhood is an authority type linking multiple homes. It contains a combined pinned infrastructure pool equal to the number of homes times 1 MB. A 1-hop link graph connects homes. Access-level and inter-home policy logic define movement rules.
#![allow(unused)] fn main() { pub struct Neighborhood { /// Unique identifier for this neighborhood pub neighborhood_id: NeighborhoodId, /// Member homes pub member_homes: Vec<HomeId>, /// 1-hop links between homes pub one_hop_links: Vec<(HomeId, HomeId)>, } }
The neighborhood structure contains the identifier, member homes, and 1-hop link edges.
4.2 Home Membership
Homes allocate 1 MB of their budget per neighborhood joined. In v1, each home may join a maximum of 4 neighborhoods. This limits 1-hop graph complexity and effect delegation routing.
5. Position and Traversal
5.1 Neighborhood Discovery Layers
Neighborhood-scoped discovery is represented through the DiscoveryLayer enum. It indicates the best neighborhood strategy to reach a target based on locality relationships:
#![allow(unused)] fn main() { pub enum DiscoveryLayer { /// No relationship with target - must use rendezvous/flooding discovery Rendezvous, /// We have neighborhood presence and can use traversal Neighborhood, /// Target is reachable via home-level relay Home, /// Target is personally known - we have a direct relationship Direct, } }
The discovery layer determines locality-aware discovery strategy and flow costs. aura-social may classify neighborhood candidates using these layers, but it does not own the final route choice. Runtime policy in aura-agent fuses neighborhood candidates with web-of-trust evidence and descriptor views.
Neighborhood discovery boards are bounded hint surfaces inside this plane. A board publication may advertise a signed, expiring, replay-bounded re-entry hint for stale-node bootstrap, but it is not a topology map. The publication does not enumerate the neighborhood graph and does not commit a runtime route. It only exposes enough scoped hint material for local runtime discovery to try a candidate.
5.2 Movement Rules
Movement is possible when a Biscuit capability authorizes entry, neighborhood policy allows movement along a 1-hop link, and home policy or invitations allow deeper access levels. Movement does not replicate pinned data. Visitors operate on ephemeral local state.
Traversal does not reveal global identity. Only contextual identities within encountered homes are visible.
6. Storage Constraints
6.1 Block-Level Allocation
Homes have a fixed size of 10 MB total. Allocation depends on neighborhood participation.
| Neighborhoods | Allocation | Participant Storage | Shared Storage |
|---|---|---|---|
| 1 | 1.0 MB | 1.6 MB | 7.4 MB |
| 2 | 2.0 MB | 1.6 MB | 6.4 MB |
| 3 | 3.0 MB | 1.6 MB | 5.4 MB |
| 4 | 4.0 MB | 1.6 MB | 4.4 MB |
More neighborhood connections mean less local storage for home culture. This creates meaningful trade-offs.
6.2 Flow Budget Integration
Storage constraints are enforced via the flow budget system.
#![allow(unused)] fn main() { pub struct HomeFlowBudget { /// Home ID (typed identifier) pub home_id: HomeId, /// Current number of participants pub participant_count: u8, /// Storage used by participants (spent counter as fact) pub participant_storage_spent: u64, /// Number of neighborhoods joined pub neighborhood_count: u8, /// Total neighborhood allocations pub neighborhood_allocations: u64, /// Storage used by pinned content (spent counter as fact) pub pinned_storage_spent: u64, } }
The spent counters are persisted as journal facts. The count fields track current membership. Limits are derived at runtime from home policy and Biscuit capabilities. Participant storage limit is 1.6 MB for 8 participants at 200 KB each.
7. Fact Schema
7.1 Home Facts
Home facts enable Datalog queries.
home(home_id, created_at, storage_limit).
home_config(home_id, max_participants, neighborhood_limit).
participant(authority_id, home_id, joined_at, storage_allocated).
moderator(authority_id, home_id, designated_by, designated_at, capabilities).
pinned(content_hash, home_id, pinned_by, pinned_at, size_bytes).
These facts express home existence, configuration, participation, moderator designation, and pin state.
7.2 Neighborhood Facts
Neighborhood facts express neighborhood existence, home membership, 1-hop links, and access permissions.
neighborhood(neighborhood_id, created_at).
home_member(home_id, neighborhood_id, joined_at, allocated_storage).
one_hop_link(home_a, home_b, neighborhood_id).
access_allowed(from_home, to_home, capability_requirement).
7.3 Query Examples
Queries use Biscuit Datalog.
participants_of(Home) <- participant(Auth, Home, _, _).
visitable(Target) <-
participant(Me, Current, _, _),
one_hop_link(Current, Target, _),
access_allowed(Current, Target, Cap),
has_capability(Me, Cap).
The first query finds all participants of a home. The second finds homes a user can visit from their current position via 1-hop links.
Neighborhood discovery-board records are intentionally separate from these canonical topology facts.
They are advisory publications consumed by runtime-local bootstrap selection. They must not change
Neighborhood, SocialTopology, or other canonical neighborhood views into route-truth owners.
8. IRC-Style Commands
8.1 User Commands
User commands are available to all participants.
| Command | Description | Capability |
|---|---|---|
/msg <user> <text> | Send private message | send_dm |
/me <action> | Send action | send_message |
/nick <name> | Update contact suggestion | update_contact |
/who | List participants | view_members |
/leave | Leave current context | leave_context |
8.2 Moderator Commands
Moderator commands require moderator capabilities, and moderators must be members.
| Command | Description | Capability |
|---|---|---|
/kick <user> | Remove from home | moderate:kick |
/ban <user> | Ban from home | moderate:ban |
/mute <user> | Silence user | moderate:mute |
/pin <msg> | Pin message | pin_content |
8.3 Command Execution
Commands execute through the guard chain.
flowchart LR
A[Parse Command] --> B[CapGuard];
B --> C[FlowGuard];
C --> D[JournalCoupler];
D --> E[TransportEffects];
The command is parsed into a structured type. CapGuard checks capability requirements. FlowGuard charges the moderation action budget. JournalCoupler commits the action fact. TransportEffects notifies affected parties.
9. Governance
9.1 Home Governance
Homes govern themselves through capability issuance, consensus-based decisions, member moderation designations, and moderation. Home governance uses Aura Consensus for irreversible or collective decisions.
9.2 Neighborhood Governance
Neighborhoods govern home admission, 1-hop graph maintenance, access rules, and shared civic norms. High-stakes actions use Aura Consensus.
10. Privacy Model
10.1 Contextual Identity
Identity in Aura is contextual and relational. Joining a home reveals a home-scoped identity. Leaving a home causes that contextual identity to disappear. Profile data shared inside a context stays local to that context.
10.2 Consent Model
Disclosure is consensual. The device issues a join request. Home governance approves using local policy. The authority accepts the capability bundle. This sequence ensures all participation is explicit.
11. V1 Constraints
For the initial release, the model is simplified with three constraints.
Each user is a member of exactly one home. This eliminates multi-membership complexity and allows core infrastructure to stabilize.
Each home has a maximum of 8 participants. This human-scale limit enables strong community bonds and manageable governance.
Each home may join a maximum of 4 neighborhoods. This limits 1-hop graph complexity and effect delegation routing overhead.
12. Infrastructure Roles
Homes and neighborhoods provide infrastructure services beyond social organization. The aura-social crate implements neighborhood facts, materialized views, and neighborhood-derived candidate production. Final route or retrieval choice belongs to the runtime.
12.1 Neighborhood Plane Responsibilities
The Neighborhood Plane provides broad locality-scoped candidate pools:
- neighborhood-derived
EstablishandMovecandidates - neighborhood-only
Holdcandidates for availability and deferred delivery - locality-scoped storage and relay budgeting
- governance and moderation state for homes and neighborhoods
These outputs are permit and candidate inputs. They are not route commitments. For Hold, the neighborhood scope is the whole admissible interface while the runtime chooses a bounded rotating subset of holders inside that scope and keeps retention treatment uniform across deposits.
12.2 Web of Trust Plane Responsibilities
The Web of Trust Plane provides trust evidence:
- bilateral friendship state as relational-context facts
- bounded introduction evidence for introduced candidates
- permit input for
EstablishandMove - bootstrap and accountability weight for trusted providers
Direct friendship is authoritative shared state. Friend-of-friend is local derivation or bounded introduction evidence. It is not canonical shared graph state.
Trust evidence may affect provider admission, weighting, and accountability preference. It must not create friend-shaped, FoF-shaped, guardian-shaped, or neighborhood-shaped route schemas. The provider should observe only the generic Establish, Move, or Hold service action.
12.3 Plane Fusion
The runtime fuses neighborhood candidates, web-of-trust evidence, descriptor views, and health data into provider selection:
| Input | Owned by | Purpose |
|---|---|---|
| Neighborhood facts and locality classification | aura-social | neighborhood-scoped permit and candidate production |
| Friend lifecycle and introduction evidence | aura-relational | trust evidence provenance |
| Descriptor snapshots | aura-agent runtime cache | connectivity and service advertisements |
| Final provider selection | aura-agent | runtime-local permit view and route choice |
This split prevents social-role labels from becoming wire-visible service classes.
Neighborhood-only and WoT-assisted candidate production must therefore emit the same Establish and Move descriptor, path, and envelope shapes. The only allowed differences are trust-evidence provenance and runtime-local weighting or selection state. Shared schemas must not grow neighborhood-, friend-, or FoF-specific variants.
12.4 Relay Selection
The SocialTopology provides neighborhood-derived relay candidate generation:
#![allow(unused)] fn main() { let topology = SocialTopology::new(local_authority, home, neighborhoods); let candidates = topology.build_relay_candidates(&destination, |peer| is_reachable(peer)); }
Reachability checks filter unreachable peers. Candidate provenance may record same-home, neighborhood-hop, or guardian evidence. The runtime may use that provenance during local permit evaluation, but aura-social does not own the final route decision.
See Also
Database Architecture describes fact storage and queries. Transport and Information Flow covers AMP messaging. Authorization describes capability evaluation. Rendezvous Architecture describes rendezvous advertisement and selection boundaries.
Distributed Maintenance Architecture
This document describes distributed maintenance in Aura. It explains snapshots, garbage collection, cache invalidation, OTA upgrades, admin replacement, epoch handling, and backup procedures. All maintenance operations align with the authority and relational context model. All maintenance operations insert facts into appropriate journals. All replicas converge through join-semilattice rules.
1. Maintenance Facts
Maintenance uses facts stored in an authority journal. Facts represent monotone knowledge. Maintenance logic evaluates local predicates over accumulated facts. These predicates implement constraints such as GC eligibility or upgrade readiness. The authoritative schema lives in crates/aura-maintenance/src/facts.rs.
#![allow(unused)] fn main() { pub enum MaintenanceFact { SnapshotProposed(SnapshotProposed), SnapshotCompleted(SnapshotCompleted), CacheInvalidated(CacheInvalidated), AdminReplacement(AdminReplacement), ReleaseDistribution(ReleaseDistributionFact), ReleasePolicy(ReleasePolicyFact), UpgradeExecution(UpgradeExecutionFact), } }
This fact model defines snapshot, cache, release-distribution, policy-publication, and scoped upgrade-execution events. Each fact is immutable and merges by set union. Devices reduce maintenance facts with deterministic rules.
2. Snapshots and Garbage Collection
Snapshots bound storage size. A snapshot proposal announces a target epoch and a digest of the journal prefix. Devices verify the digest. If valid, they contribute signatures. A threshold signature completes the snapshot.
Snapshot completion inserts a SnapshotCompleted fact. Devices prune facts whose epochs fall below the snapshot epoch. Devices prune blobs whose retractions precede the snapshot. This pruning does not affect correctness because the snapshot represents a complete prefix.
DKG transcript blobs follow the same garbage collection fence: once a snapshot is finalized, transcripts with epochs older than the snapshot retention window may be deleted. This keeps long-lived key ceremonies from accumulating unbounded storage while preserving the ability to replay from the latest snapshot.
#![allow(unused)] fn main() { pub struct Snapshot { pub epoch: Epoch, pub commitment: TreeHash32, pub roster: Vec<LeafId>, pub policies: BTreeMap<NodeIndex, Policy>, pub state_cid: Option<TreeHash32>, pub timestamp: u64, pub version: u8, } }
This structure defines the snapshot type from aura_core::tree. Devices fetch the blob when restoring state. Devices hydrate journal state and replay the tail of post-snapshot facts.
3. Cache Invalidation
State mutations publish CacheInvalidated facts. A cache invalidation fact contains cache keys and an epoch floor. Devices maintain local actor-owned maps from keys to epoch floors. A cache entry is valid only when the current epoch exceeds its floor.
Cache invalidation is local. No CRDT cache is replicated. Devices compute validity using meet predicates on epoch constraints. Service caches such as rendezvous descriptor registries remain runtime-local mutable state in aura-agent. Facts invalidate them, but facts do not materialize them.
#![allow(unused)] fn main() { pub struct CacheKey(pub String); }
This structure identifies a cached entry. Devices invalidate cached data when they observe newer invalidation facts.
3.1 Hold Garbage Collection
Hold GC uses the same epoch, invalidation, and storage-pressure vocabulary as journal GC. It does not use the same authority model. Journal GC prunes authoritative shared state after threshold-backed snapshot evidence, while Hold GC prunes opaque custody objects through local provider policy.
Held objects are scoped to the epoch in which they were deposited. Epoch rotation makes prior-epoch objects GC-eligible unless a retrieval capability explicitly spans the new epoch. Retrieval-capability expiration and storage pressure can also make a held object eligible for local eviction.
Eviction priority is epoch and then age. It must not vary by social distance, friendship, home membership, or introduction provenance. Uniform treatment prevents retention behavior from becoming a side channel under onion routing.
4. OTA Upgrades
OTA in Aura separates two concerns:
- global and eventual release distribution
- local or scope-bound staging, activation, cutover, and rollback
Aura does not model "the whole network is now in cutover" as a valid primitive. Release propagation is multi-directional and eventual. Hard cutover is meaningful only inside a scope that actually has agreement or a legitimate fence.
4.1 Release Identity and Provenance
#![allow(unused)] fn main() { pub struct AuraReleaseProvenance { pub source_repo_url: String, pub source_bundle_hash: Hash32, pub build_recipe_hash: Hash32, pub output_hash: Hash32, pub nix_flake_hash: Hash32, pub nix_flake_lock_hash: Hash32, } pub struct AuraReleaseManifest { pub series_id: AuraReleaseSeriesId, pub release_id: AuraReleaseId, pub version: SemanticVersion, pub provenance: AuraReleaseProvenance, pub artifacts: Vec<AuraArtifactDescriptor>, pub compatibility: AuraCompatibilityManifest, pub suggested_activation_time_unix_ms: Option<u64>, } }
AuraReleaseId is derived from the release series and the full provenance. source_repo_url participates in that derivation, so the declared upstream repository location is part of canonical release identity. Builder authorities may publish deterministic build certificates over the same provenance. TEE attestation is optional hardening, not the source of release identity.
4.2 Policy Surfaces
OTA policy is not one switch. Aura distinguishes:
- discovery policy: what release authorities, builders, and contexts a device is willing to learn from
- sharing policy: what manifests, artifacts, certificates, or recommendations it is willing to forward or pin
- activation policy: what trust, compatibility, health, approval, and fence conditions must hold before local activation
Discovering a release does not imply forwarding it. Forwarding it does not imply activating it.
4.3 Activation Scopes and State
Activation is modeled per scope, not globally.
#![allow(unused)] fn main() { pub enum AuraActivationScope { DeviceLocal { device_id: DeviceId }, AuthorityLocal { authority_id: AuthorityId }, RelationalContext { context_id: ContextId }, ManagedQuorum { context_id: ContextId, participants: BTreeSet<AuthorityId>, }, } pub enum ReleaseResidency { LegacyOnly, Coexisting, TargetOnly, } pub enum TransitionState { Idle, AwaitingCutover, CuttingOver, RollingBack, } }
ReleaseResidency describes which release set may currently run in the scope. TransitionState describes whether the scope is stable, waiting on evidence, actively switching, or rolling back.
4.4 Cutover and Rollback
Scoped activation uses journal facts plus local policy evaluation. A scope may move toward cutover only when the relevant evidence is present:
- manifest and certificate verification
- compatibility classification
- staged artifacts
- local trust policy satisfaction
- optional local-policy respect for
suggested_activation_time_unix_ms - threshold approval, if that scope actually supports threshold approval
- epoch fence, if that scope actually owns the relevant fence
- health gate checks
Hard-fork behavior is explicit. After local cutover, incompatible new sessions are rejected. In-flight incompatible sessions must drain, abort, or delegate according to policy. If post-cutover validation fails, rollback is deterministic and recorded in UpgradeExecutionFact.
Managed quorum cutover requires explicit approval from the participant set bound into AuraActivationScope::ManagedQuorum. Staged revoked releases are canceled before cutover. Active revoked releases follow the local rollback preference. Automatic rollback queues the revert path immediately. Manual rollback leaves the scope failed until an operator approves rollback.
4.5 Updater / Launcher Boundary
Aura does not rely on in-place self-replacement of the running runtime. Layer 6 owns an updater/launcher control plane that:
- stages manifests, artifacts, and certificates
- emits explicit activate/rollback commands
- records scoped upgrade state
- restores the previous release deterministically when rollback is required
5. Admin Replacement
Admin replacement uses a maintenance fact. The fact records the old admin, new admin, and activation epoch. Devices use this fact to ignore operations from retired administrators.
#![allow(unused)] fn main() { pub struct AdminReplacement { pub authority_id: AuthorityId, pub old_admin: AuthorityId, pub new_admin: AuthorityId, pub activation_epoch: Epoch, } }
This structure defines an admin replacement. Devices enforce this rule locally. The replacement fact is monotone and resolves disputes using journal evidence.
6. Epoch Handling
Maintenance logic uses identity epochs for consistency. A maintenance session uses a tuple containing the identity epoch and snapshot epoch. A session aborts if the identity epoch advances. Devices retry under the new epoch.
Snapshot completion sets the snapshot epoch equal to the identity epoch. Garbage collection rules use the snapshot epoch to prune data safely. Upgrade fences use the same epoch model to enforce activation.
#![allow(unused)] fn main() { use aura_maintenance::MaintenanceEpoch; pub struct MaintenanceEpoch { pub identity_epoch: Epoch, pub snapshot_epoch: Epoch, } }
This structure captures epoch state for maintenance workflows. Devices use this structure for guard checks.
7. Backup and Restore
Backup uses the latest snapshot and recent journal facts. Devices export an encrypted archive containing the snapshot blob and journal tail. Restore verifies the snapshot signature, hydrates state, and replays the journal tail.
Backups use existing storage and verification effects. No separate protocol exists. Backup correctness follows from snapshot correctness.
8. Automatic Synchronization
Automatic synchronization implements periodic journal replication between devices. The synchronization service coordinates peer discovery, session management, and fact exchange. All synchronization uses the journal primitives described in Journal.
8.1 Peer Discovery and Selection
Devices discover sync peers through the rendezvous system described in Rendezvous Architecture. The peer manager consumes runtime-owned rendezvous descriptor snapshots. The peer manager maintains metadata for each discovered peer. This metadata includes connection state, trust level, sync success rate, and active session count.
#![allow(unused)] fn main() { pub struct PeerMetadata { pub device_id: DeviceId, pub status: PeerStatus, pub discovered_at: PhysicalTime, pub last_status_change: PhysicalTime, pub successful_syncs: u64, pub failed_syncs: u64, pub average_latency_ms: u64, pub last_seen: PhysicalTime, pub last_successful_sync: PhysicalTime, pub trust_level: u8, pub has_sync_capability: bool, pub active_sessions: usize, } }
This structure tracks peer state for selection decisions. All timestamp fields use PhysicalTime from the unified time system. The peer manager calculates a score for each peer using weighted factors. Trust level contributes 50 percent. Success rate contributes 30 percent. Load factor contributes 20 percent. Higher scores indicate better candidates for synchronization.
Devices select peers when their score exceeds a threshold. Devices limit concurrent sessions per peer. This prevents resource exhaustion. Devices skip peers that have reached their session limit.
8.2 Session Management
The session manager tracks active synchronization sessions. Each session has a unique identifier and references a peer device. Sessions enforce rate limits and concurrency bounds.
#![allow(unused)] fn main() { pub struct SessionManager<T> { sessions: HashMap<SessionId, SessionState<T>>, config: SessionConfig, metrics: Option<MetricsCollector>, last_cleanup: PhysicalTime, session_counter: u64, } }
This structure maintains session state. Sessions are indexed by SessionId rather than DeviceId. Configuration is provided via SessionConfig. All timestamp fields use PhysicalTime from the unified time system. Devices close sessions after fact exchange completes. Devices abort sessions when the identity epoch advances. Session cleanup releases resources for new synchronization rounds.
8.3 Rate Limiting and Metrics
The synchronization service enforces rate limits per peer and globally. Rate limiting prevents network saturation. Metrics track sync latency, throughput, and error rates.
Devices record metrics for each sync operation. These metrics include fact count, byte count, and duration. Devices aggregate metrics to monitor service health. Degraded peers receive lower priority in future rounds.
8.4 Integration with Journal Effects
Automatic synchronization uses JournalEffects to read and write facts. The service queries local journals for recent facts. The service sends these facts to peers. Peers merge incoming facts using join-semilattice rules.
All fact validation rules apply during automatic sync. Devices reject invalid facts. Devices do not rollback valid facts already merged. This maintains journal monotonicity.
9. Migration Infrastructure
The migration runtime in aura-agent/src/runtime/migration.rs orchestrates data migrations between protocol versions.
9.1 Migration Trait
#![allow(unused)] fn main() { #[async_trait] pub trait Migration: Send + Sync { fn source_version(&self) -> SemanticVersion; fn target_version(&self) -> SemanticVersion; fn name(&self) -> &str; async fn validate(&self, ctx: &MigrationContext) -> Result<(), MigrationError>; async fn execute(&self, ctx: &MigrationContext) -> Result<(), MigrationError>; async fn rollback(&self, ctx: &MigrationContext) -> Result<bool, MigrationError> { Ok(false) // Default: rollback not supported } } }
Each migration specifies source and target versions, a name for logging, validate/execute methods, and an optional rollback method. The default rollback implementation returns Ok(false) to indicate rollback is not supported.
9.2 Coordinator API
| Method | Purpose |
|---|---|
needs_migration(from) | Check if upgrade is needed |
get_migration_path(from, to) | Find ordered migration sequence |
migrate(from, to) | Execute migrations with validation |
validate_migration(from, to) | Dry-run validation only |
9.3 Migration Guarantees
Migrations are ordered by target version. Each migration runs at most once (idempotent via version tracking). Failed migrations leave the system in a consistent state. Progress is recorded in the journal for auditability.
10. Evolution
Maintenance evolves in phases. Current OTA work focuses on release identity/provenance, scoped activation, deterministic rollback, and Aura-native distribution. Future phases may add richer replicated cache CRDTs, stronger builder attestation, staged rollout tooling, and automatic snapshot triggers.
Future phases build on the same journal schema. Maintenance semantics remain compatible with older releases.
11. Summary
Distributed maintenance uses journal facts to coordinate snapshots, cache invalidation, release distribution, scoped upgrades, and admin replacement. All operations use join-semilattice semantics. All reductions are deterministic. Devices prune storage only after observing snapshot completion. OTA release propagation is eventual, while activation is always local or scope-bound. The system remains consistent across offline and online operation.
User Interface
This document describes the aura-terminal user interface layer. It covers the non-interactive CLI commands and the iocraft-based TUI. It also describes how both frontends share aura-app through AppCore and the reactive signal system.
Demo mode is compiled only with --features development.
Goals and constraints
The CLI and the TUI are thin frontends over AppCore. They should not become alternate application runtimes. They should also avoid owning long-lived domain state.
Both frontends must respect the guard chain, journaling, and effect system boundaries described in Aura System Architecture. The CLI optimizes for scriptability and stable output. The TUI optimizes for deterministic navigation with reactive domain data.
Concepts
- Command. A user-invoked operation such as
aura statusoraura chat send. - Handler. A CLI implementation function that uses
HandlerContextand returnsCliOutput. - Screen. A routed view that renders domain data and local UI state.
- Modal. A blocking overlay that captures focus. Modals are queued and only one can be visible at a time.
- Toast. A transient notification. Toasts are queued and only one can be visible at a time.
- Signal. A reactive stream of domain values from
aura-app. - Intent. A journaled application command dispatched through
AppCore.dispatch(legacy in the TUI). Most TUI actions are runtime-backed workflows viaIoContext. - Role/access labels. UI copy should use canonical terms from Theoretical Model:
Member,Participant,Moderator, and access levelsFull/Partial/Limited.
Running
Aura provides CLI, TUI, and demo execution modes. See Getting Started Guide for running instructions and configuration options.
Architecture overview
The CLI and the TUI share the same backend boundary. Both construct an AppCore value and use it as the primary interface to domain workflows and views. Both also rely on aura-agent for effect handlers and runtime services.
The user interface split is:
crates/aura-appprovides portable domain logic, reactive state, and signals throughAppCore.crates/aura-terminal/src/cli/defines bpaf parsers and CLI argument types.crates/aura-terminal/src/handlers/implements CLI commands and shared terminal glue.crates/aura-terminal/src/tui/implements iocraft UI code and deterministic navigation.
Relationship to aura-app
AppCore is the shared boundary for both frontends. It owns reactive state and provides stable APIs for dispatching intents and reading derived views. Frontends should use the aura_app::ui facade (especially aura_app::ui::signals and aura_app::ui::workflows) as the public API surface.
The frontends use AppCore in two ways:
- Trigger work by calling
AppCore.dispatch(intent)or by calling effect-backed handlers that ultimately produce journaled facts. - Read state by reading views or by subscribing to signals for push-based updates.
This split keeps domain semantics centralized. It also makes it possible to reuse the same workflows in multiple user interfaces.
Time system in UI
UI code must never read OS clocks (for example, SystemTime::now() or Instant::now()). All wall-clock needs must flow through algebraic effects (PhysicalTimeEffects via the handler/effect system). Demo mode and relative-time UI (e.g., “Synced Xm ago”) must be driven by runtime time so simulations remain deterministic.
Aura time domains are: PhysicalClock (wall time), LogicalClock (causality), OrderClock (privacy-preserving ordering), and Range (validity windows). When attested time is required, use ProvenancedTime/TimeComparison rather than embedding OS timestamps in UI state.
Ordering across domains must be explicit: use TimeStamp::compare(policy) (never compare raw ms) when you need deterministic ordering across mixed time domains.
Shared infrastructure in aura-terminal
CLI commands are parsed in crates/aura-terminal/src/cli/commands.rs and routed through crates/aura-terminal/src/main.rs. Implementations live under crates/aura-terminal/src/handlers/ and use HandlerContext from crates/aura-terminal/src/handlers/handler_context.rs. Handler functions typically return CliOutput for testable rendering.
The TUI launcher lives in crates/aura-terminal/src/handlers/tui.rs. It sets up tracing and constructs the IoContext and callback registry. The fullscreen stdio policy is defined in crates/aura-terminal/src/handlers/tui_stdio.rs.
CLI execution model
The CLI is request and response. Each command parses arguments, runs one handler, and exits. Long-running commands such as daemon modes should still use the same effect boundaries.
flowchart TD A[CLI args] --> P[bpaf parser] P --> H[CliHandler] H --> HC[HandlerContext] HC --> E[Effects and services] E --> AC[AppCore state] AC --> O[CliOutput render]
This diagram shows the main CLI path from parsing to rendering. Some handlers also read derived state from AppCore after effects complete.
Reactive data model
The reactive system follows a fact-based architecture where typed facts are the source of truth for UI state.
Signals as single source of truth
ReactiveEffects signals (CHAT_SIGNAL, CONTACTS_SIGNAL, RECOVERY_SIGNAL, etc.) are the canonical source for all UI state. They are updated by the ReactiveScheduler processing typed facts from the journal.
flowchart LR F[Typed Facts] -->|commit| J[Journal] J -->|publish| S[ReactiveScheduler] S -->|emit| Sig[Signals] Sig --> TUI[TUI Screens] Sig --> CLI[CLI Commands]
The data flow is:
- Typed facts (
aura_journal::fact::Fact) are committed to the journal - ReactiveScheduler processes committed facts via registered
ReactiveViewimplementations - SignalViews (e.g.,
ContactsSignalView,ChatSignalView) update their internal state and emit snapshots to signals - UI components subscribe to signals and render the current state
This architecture ensures a single source of truth and eliminates dual-write bugs. Code that needs to update UI state must commit facts (production) or emit directly to signals (demo/test).
ViewState is internal
AppCore contains an internal ViewState used for legacy compatibility and non-signal use cases. ViewState changes do not propagate to signals. The signal forwarding infrastructure was removed in favor of scheduler-driven updates.
For compile-time safety, there are no public methods on AppCore to mutate ViewState for UI-affecting state. Code that needs to update what the UI displays must:
- Production: Commit facts via
RuntimeBridge.commit_relational_facts(). Facts flow through the scheduler to signals. - Demo/Test: Emit directly to signals via
ReactiveEffects::emit(). This is explicit and type-safe.
This design prevents the "dual-write" bug class where code updates ViewState expecting UI changes, but signals remain unchanged.
The CLI usually reads state at a point in time. It can still use signals for watch-like commands or daemon commands. When a command needs continuous updates, it should subscribe to the relevant signals and render incremental output.
Reading and subscribing to signals
Signals are accessed through AppCore's ReactiveEffects implementation. A continuously observed view must establish its receiver before reading the current value so an update between those operations cannot be lost. An unregistered signal, failed read, or closed receiver is a typed observation failure, not an empty or default domain state. After recovery, the view must read a fresh current snapshot; the reactive stream does not promise replay of intermediate values.
Subscriptions and ownership
Long-lived subscriptions that drive global TUI elements live in crates/aura-terminal/src/tui/screens/app/subscriptions.rs. Screen-local subscriptions should live with the screen module.
Subscriptions should be owned by the component that renders the data. A mounted shared UI shell owns one supervised subscription group per runtime generation, with one receiver per distinct required signal. The shared UiSnapshot.subscription_health field reports typed attachment, healthy, degraded, and recovering states, with a typed cause for registration, stream closure, or snapshot-read failure. Unmount or generation replacement cancels its old group before the next group becomes ready. A listener must not retain its own lifetime owner. A subscription should not mutate TuiState unless it is updating navigation, focus, or overlay state.
Connection status (peer count)
The footer "connected peers" count is a UI convenience signal. It must represent how many of your contacts are online, not a seeded or configured peer list.
- Source:
CONNECTION_STATUS_SIGNAL(emitted byaura_app::ui::workflows::system::refresh_account()). - Contact set: read from
CONTACTS_SIGNAL(signal truth), not fromViewStatesnapshots. - Online check:
RuntimeBridge::is_peer_online(contact_id)(best-effort). Demo uses a shared in-memory transport. Production can use real transport channel health.
Deterministic UI model
The TUI separates domain state from UI state. Domain state is push-based and comes from aura-app signals. UI state is deterministic and lives in TuiState.
Navigation, focus, input buffers, modal queues, and toast queues are updated by a pure transition function. The entry point is crates/aura-terminal/src/tui/state/mod.rs. The runtime executes TuiCommand values in crates/aura-terminal/src/tui/runtime.rs.
Dispatch bridge
The TUI dispatch path uses IoContext in crates/aura-terminal/src/tui/context/io_context.rs.
Today the TUI uses a runtime-backed dispatch model: IoContext routes EffectCommand to DispatchHelper and OperationalHandler. Most domain-affecting behavior occurs through aura-app workflows that call RuntimeBridge (which commits facts and drives signals).
flowchart TD UI[User input] --> SM[TuiState transition] SM -->|TuiCommand::Dispatch| IO[IoContext dispatch] IO --> DH[DispatchHelper] DH --> OP[OperationalHandler] OP --> W[Workflows / RuntimeBridge] W --> J[Commit facts] J --> S[Emit signals] S --> UI2[Screens subscribe]
This diagram shows the primary TUI dispatch path. Operational commands may also emit operational signals such as SYNC_STATUS_SIGNAL, CONNECTION_STATUS_SIGNAL, and ERROR_SIGNAL.
Screens, modals, and callbacks
The root iocraft component is in crates/aura-terminal/src/tui/screens/app/shell.rs. Global modals live in crates/aura-terminal/src/tui/screens/app/modal_overlays.rs. Long-lived signal subscriptions for the shell live in crates/aura-terminal/src/tui/screens/app/subscriptions.rs.
Modals and toasts are routed through explicit queues in TuiState. The modal enum is QueuedModal in crates/aura-terminal/src/tui/state/modal_queue.rs. Avoid per-modal visible flags.
Invitation codes are managed from the Contacts workflow (modals), not via a dedicated routed Invitations screen.
Callbacks are registered in crates/aura-terminal/src/tui/callbacks/. Asynchronous results are surfaced through UiUpdate in crates/aura-terminal/src/tui/updates.rs. Prefer subscribing to domain signals when a signal already exists.
Fullscreen I/O policy
Writing to stderr while iocraft is in fullscreen can corrupt the terminal buffer. The TUI redirects stderr away from the terminal while fullscreen is active. Tracing is written to a log file.
The policy is enforced with type-level stdio tokens in crates/aura-terminal/src/handlers/tui_stdio.rs. The token used before fullscreen is consumed while iocraft is running. This prevents accidental println! and eprintln! calls in the fullscreen scope.
This policy aligns with Privacy and Information Flow and Effect System.
Errors and user feedback
Domain and dispatch failures are emitted through aura_app::ui::signals::ERROR_SIGNAL. The app shell subscribes to this signal and renders errors as queued toasts. When the account setup modal is active, errors are routed into the modal instead of creating a toast.
UI-only failures use UiUpdate::OperationFailed. This is used primarily for account file operations that occur before AppCore dispatch.
CLI commands should return errors through TerminalResult and render them through CliOutput. Avoid printing error text directly from deep helper functions. Prefer returning structured error types.
Invariants and common pitfalls
The state machine owns navigation, focus, and overlay visibility. Screen components should render TuiState and should not mutate it directly. They should send events and let the state machine decide transitions.
The domain owns the reactive state. Avoid caching domain data in TuiState. Prefer subscribing to aura-app signals and deriving view props inside the screen component.
Single source of truth invariants
- Signals are the source of truth for UI state, not ViewState.
- Facts drive signals in production. Commit facts via RuntimeBridge.
- Direct emission is only for demo/test scenarios via
ReactiveEffects::emit(). - No ViewState mutation for UI state. AppCore has no public methods to mutate ViewState for UI-affecting state.
Common pitfalls
- Calling
println!andeprintln!while fullscreen is active - Storing domain state in
TuiStateinstead of subscribing to signals - Adding per-modal
visibleflags instead of usingQueuedModaland the modal queue - Using
UiUpdateas a general event bus instead of subscribing to signals - Expecting ViewState changes to appear in the UI. ViewState does not propagate to signals.
- Emitting directly to domain signals in production code. Use fact commits instead.
Testing strategy
The CLI should be tested with handler unit tests and structured output assertions. Prefer pure formatting helpers and CliOutput snapshots over stdout capture.
The deterministic boundary for the TUI is the state machine. Prefer unit tests that call transition() directly for navigation and modal behavior. For headless terminal event tests, use TuiRuntime<T> from crates/aura-terminal/src/tui/runtime.rs with a mock TerminalEffects handler.
Code map
crates/aura-terminal/src/
main.rs
cli/
commands.rs
handlers/
mod.rs
handler_context.rs
tui.rs
tui_stdio.rs
tui/
context/
screens/
app/
shell.rs
modal_overlays.rs
subscriptions.rs
state/
runtime.rs
hooks.rs
effects/
components/
This map shows the primary module boundaries for the CLI and the TUI. CLI logic should live under handlers/ and cli/. TUI view logic should live under tui/.
Demo mode
Demo mode is under crates/aura-terminal/src/demo/. It compiles only with --features development. Production builds should not require demo-only types or props.
Demo architecture
Demo mode uses the same fact-based pipeline as production where possible:
- Guardian bindings: Committed as
RelationalFact::GuardianBindingfacts throughRuntimeBridge.commit_relational_facts(). These flow through the scheduler to updateCONTACTS_SIGNAL. - Chat messages: Emitted directly to
CHAT_SIGNALviaReactiveEffects::emit(). Sealed message facts would require cryptographic infrastructure not available in demo. - Recovery approvals: Emitted directly to
RECOVERY_SIGNAL. Production would use consensus-basedRecoveryGrantfacts.
SimulatedBridge owns the simulated agents' response receiver and processes
their responses through its existing demo execution loop. DemoSimulator
owns the runtime-backed demo automation; there is no separate signal-watching
coordinator that infers user actions from rendered projections.
Demo shortcuts
Demo mode supports convenience shortcuts. Invite code entry supports Ctrl+a and Ctrl+l when demo codes are present.
Recovery scenario walkthrough
The CLI can run a complete guardian recovery demo through the simulator. This scenario shows Bob onboarding with guardians, losing his device, and recovering with help from Alice and Carol.
Run the recovery demo from the repository root:
cargo run -p aura-terminal -- scenarios run --directory scenarios/integration --pattern cli_recovery_demo
This command uses the CLI scenario runner plus the simulator to execute the guardian setup and recovery choreography. Logs are written to the scenario runner's output log bundle.
The scenario executes in eight phases:
alice_carol_setupcreates Alice and Carol authorities using Ed25519 single-signer mode for initial key generation.bob_onboardingcreates Bob authority (Ed25519 initially), sends guardian requests, and configures threshold 2 (switching to FROST).group_chat_setuphas Alice create a group chat and invite Bob and Carol. Context keys are derived for the chat.group_messagingsends normal chat messages among all three participants. History is persisted.bob_account_losssimulates total device loss for Bob. He cannot access his authority.recovery_initiationhas Bob initiate recovery. Alice and Carol validate and approve the request. Guardian approval threshold (2) is met.account_restorationruns threshold key recovery. Bob's chat history is synchronized back.post_recovery_messaginghas Bob send messages again and see full history. The group remains functional.
New accounts use standard Ed25519 signatures because FROST requires at least 2 signers. Once Bob adds guardians and configures threshold 2, subsequent signing operations use the full FROST threshold protocol. See Cryptographic Architecture for details on signing modes.
Testing
Run tests inside the development shell.
Standard
just test-crate aura-terminal
This runs the aura-terminal test suite in the standard project workflow.
Offline
For offline testing, use the workspace offline mode.
CARGO_NET_OFFLINE=true cargo test -p aura-terminal --tests --offline
This runs the full aura-terminal test suite without network access.
Message status indicators
Chat messages display delivery status and finalization indicators in the message bubble header. Status is derived from the unified consistency metadata types in aura_core::domain.
Status indicator legend
Symbol Meaning Color Animation Source
────────────────────────────────────────────────────────────────
◐ Syncing/Sending Blue Pulsing Propagation::Local
◌ Pending Gray None Agreement::Provisional
✓ Sent Green None Propagation::Complete
✓✓ Delivered Green None Acknowledgment.acked_by includes recipient
✓✓ Read Blue None ChatFact::MessageRead
⚠ Unconfirmed Yellow None Agreement::SoftSafe (pending A3)
✗ Failed Red None Propagation::Failed
◆ Finalized Muted None Agreement::Finalized
Delivery status lifecycle
Messages progress through the following states:
| Status | Icon | Meaning |
|---|---|---|
| Sending | ◐ | Message being transmitted (Propagation::Local) |
| Sent | ✓ | Synced to all known peers (Propagation::Complete) |
| Delivered | ✓✓ | Recipient acked via transport protocol |
| Read | ✓✓ (blue) | Recipient viewed message (ChatFact::MessageRead) |
| Failed | ✗ | Sync failed (Propagation::Failed with retry) |
Delivery status is derived from OptimisticStatus consistency metadata:
#![allow(unused)] fn main() { use aura_core::domain::{Propagation, Acknowledgment, OptimisticStatus}; fn delivery_icon(status: &OptimisticStatus, expected_peers: &[AuthorityId]) -> &'static str { match &status.propagation { Propagation::Local => "◐", Propagation::Syncing { .. } => "◐", Propagation::Failed { .. } => "✗", Propagation::Complete => { // Check if all expected peers have acked let delivered = status.acknowledgment .as_ref() .map(|ack| expected_peers.iter().all(|p| ack.contains(p))) .unwrap_or(false); if delivered { "✓✓" } else { "✓" } } } } }
The transport layer implements ack tracking via ack_tracked on facts. When ack_tracked = true, recipients send FactAck responses that are recorded in the journal's ack table. Read receipts are semantic (user viewed) and use ChatFact::MessageRead.
Agreement and finalization
Agreement level affects display:
| Agreement | Display | Meaning |
|---|---|---|
| Provisional (A1) | Normal | Usable but may change |
| SoftSafe (A2) | ⚠ badge | Coordinator-safe with convergence cert |
| Finalized (A3) | ◆ badge | Consensus-finalized, durable |
The finalization indicator (◆) appears when a message achieves A3 consensus (2f+1 witnesses). This indicates the message is durably committed and cannot be rolled back.
Implementation notes
Status indicators are rendered in MessageBubble (crates/aura-terminal/src/tui/components/message_bubble.rs). The consistency metadata flows from ChatState through the CHAT_SIGNAL to the TUI. The ChatState includes OptimisticStatus for each message, which contains:
agreement: Current A1/A2/A3 levelpropagation: Sync status (Local, Syncing, Complete, Failed)acknowledgment: Which peers have acked (for delivery tracking)
See Operation Categories for the full consistency metadata type definitions and AMP Protocol for the acknowledgment flow.
See also
- Aura System Architecture
- Privacy and Information Flow
- Effect System
- Runtime
- AMP Protocol for message delivery acknowledgments
- Operation Categories for status tracking patterns
Committed control visibility
A rendered-control visibility observation refers to an actually committed typed control with nonempty rendered layout after clipping, with no hidden or disposed state. Eligibility, focus, screen identity, and component mounting alone do not establish visibility. The observation binds both its semantic source revisions and its renderer capture. Superseding renders and unmounts revoke the previous capture; a previous mount cannot publish into a later mount with the same semantic source. Browser observations use renderer-registered node references and a commit acknowledgment after the edit batch; native observations use the completed canvas traversal and actual clipping ancestors. Observations retain all matching control instances rather than collapsing duplicates into a boolean. Unsupported controls provide no positive visibility evidence. This observation proves the captured layout, not pixel occlusion or future layout stability.
Modal focus observation retains the exact canonical ControlId::Field(FieldId)
from the active modal field. A generic modal-input identity cannot replace that
field and focus does not prove rendered visibility. The unused invitation-type
list/field and generic modal-input wire variants are removed with their raw-key
selector/fallback paths; no compatibility decoder remains. Actual native and
shared UI snapshot regressions cover all four contact-invitation fields. These
are local observation checks, not paired-client business completion evidence.
Test Infrastructure Reference
This document describes the architecture of aura-testkit, the test infrastructure crate that provides fixtures, mock handlers, and verification utilities for testing Aura protocols.
Overview
The aura-testkit crate occupies Layer 8 in the Aura architecture. It provides reusable test infrastructure without containing production code. All test utilities follow effect system guidelines to ensure deterministic execution.
The crate serves three purposes. It provides stateful effect handlers for controllable test environments. It offers fixture builders for consistent test setup. It includes verification utilities for property testing and differential testing.
Complete-flow fixture contract
Reusable fixtures support deterministic execution of the actual runtime and app workflow. Generic providers, fault controls and evidence utilities belong in aura-testkit; runtime-specific assembly belongs in sanctioned runtime test support or simulation factories. Testkit utilities do not introduce upward production dependencies or a second implementation of a protocol.
Positive evidence comes from canonical producers: real signing and verification, explicit transferred trust, committed journal state, acknowledged storage and actual owned task disposal. MockRuntimeBridge projections and mock crypto remain useful for component tests, but cannot establish authenticated distributed success or profile restart continuity.
A complete lifecycle fixture retains participant identity, selected clock/provider, original operation and window ownership, storage profile and typed failure sources across its stages. Restart requires acknowledged old-owner shutdown and reacquisition of the same original profile, with durable evidence revalidated. Scenario checkpoints and copied metadata cannot substitute for that custody. Fault and replay evidence distinguishes actual runtime execution from observational model steps.
Failure after partial assembly or issuance still requires acknowledged cleanup of every acquired runtime owner. Dropping a fixture is not shutdown evidence. Cleanup preserves the original concrete failure and reports any required cleanup failure separately; it cannot manufacture a cancellation or successful terminal receipt.
Enrollment is the first complete-flow fixture target; its implementation and migration remain explicit work until actual execution covers setup, issuance, acceptance/rejection, host persistence, terminal publication, cleanup and reopen. Simulation Guide defines the development workflow and coverage sequence.
Reusable lifecycle support
A reusable fixture exposes deterministic fault boundaries and retains the original owners through failure and cleanup. Its observations distinguish domain outcome, persistence acknowledgment, semantic terminal publication and required resource disposal. Failure in one stage cannot manufacture evidence for another. Participant setup and restart custody are shared infrastructure, rather than independently reconstructed state in each regression. Platform-specific storage and network behavior remain separately identified coverage requirements.
Fixture coverage identity
Fixture evidence identifies the original participants, operation, selected providers and durable profile, together with the supported lifecycle stages. Required host persistence names the actual storage producer: a generic callback write does not establish native or browser identity persistence. Unsupported stages remain explicit dependencies rather than implied fixture capabilities.
Stateful Effect Handlers
Stateful effect handlers maintain internal state across calls. They enable deterministic testing by controlling time, randomness, and storage. These handlers implement the same traits as production handlers but store state for inspection and manipulation.
Handler Categories
The stateful_effects module provides handlers for each effect category.
| Handler | Effect Trait | Purpose |
|---|---|---|
SimulatedTimeHandler | PhysicalTimeEffects | Controllable simulated time |
MockRandomHandler | RandomCoreEffects | Seeded deterministic randomness |
MemoryStorageHandler | StorageEffects | In-memory storage with inspection |
MockJournalHandler | JournalEffects | Journal with fact tracking |
MockCryptoHandler | CryptoCoreEffects | Crypto with key inspection |
MockConsoleHandler | ConsoleEffects | Captured console output |
Time Handler
The SimulatedTimeHandler provides controllable time for tests.
#![allow(unused)] fn main() { use aura_testkit::stateful_effects::SimulatedTimeHandler; use aura_core::effects::PhysicalTimeEffects; let time = SimulatedTimeHandler::new_with_time(5_000); let now = time.physical_time().await?; time.advance_time(5000); let later = time.physical_time().await?; }
The existing new() constructor starts at current system time; deterministic fixtures select new_at_epoch() or new_with_time(start_ms) explicitly. Concurrent runtime fixtures instead retain ManualPhysicalClock for exact fault boundaries or a shared QuiescentClock with paused Tokio time. Clock reads never provide distributed ordering authority, and provider sleep semantics must not silently advance another owner's deadline. See Testing Guide for runtime assembly and restart contracts.
Random Handler
The MockRandomHandler provides seeded randomness for reproducible tests.
#![allow(unused)] fn main() { use aura_testkit::stateful_effects::MockRandomHandler; let random = MockRandomHandler::with_seed(42); let bytes = random.random_bytes(32).await; }
Given the same seed, this handler produces identical sequences across runs. This enables deterministic property testing and failure reproduction.
Fixture System
The fixture system provides consistent test environment setup. Fixtures encapsulate common configuration patterns and reduce boilerplate.
TestFixture
The TestFixture type provides a complete test environment.
#![allow(unused)] fn main() { use aura_testkit::infrastructure::harness::{TestFixture, TestConfig}; let fixture = TestFixture::new().await?; let device_id = fixture.device_id(); let context = fixture.context(); }
A fixture creates deterministic identifiers, initializes effect handlers, and provides access to test context. The default configuration suits most unit tests.
TestConfig
Custom configurations enable specialized test scenarios.
#![allow(unused)] fn main() { let config = TestConfig { name: "threshold_test".to_string(), deterministic_time: true, capture_effects: true, timeout: Some(Duration::from_secs(60)), }; let fixture = TestFixture::with_config(config).await?; }
The deterministic_time flag enables StatefulTimeHandler. The capture_effects flag records effect calls for later inspection.
Builder Utilities
Builder functions create test data with deterministic inputs. They live in the builders module.
Account Builders
#![allow(unused)] fn main() { use aura_testkit::builders::test_account_with_seed; let account = test_account_with_seed(42).await; }
This creates an account with deterministic keys derived from the seed. Multiple calls with the same seed produce identical accounts.
Key Builders
#![allow(unused)] fn main() { use aura_testkit::builders::test_key_pair; let (signing_key, verifying_key) = test_key_pair(1337); }
Key pairs derive from the provided seed. This enables testing signature verification with known keys.
Identifier Generation
Tests must use deterministic identifiers to ensure reproducibility.
#![allow(unused)] fn main() { use aura_core::types::identifiers::AuthorityId; let auth1 = AuthorityId::from_entropy([1u8; 32]); let auth2 = AuthorityId::from_entropy([2u8; 32]); }
Never use Uuid::new_v4() or similar entropy-consuming methods in tests. Incrementing byte patterns create distinct but reproducible identifiers.
Verification Utilities
The verification module provides utilities for property testing and differential testing.
Proptest Strategies
The strategies module defines proptest strategies for Aura types.
#![allow(unused)] fn main() { use aura_testkit::verification::strategies::{arb_device_id, arb_account_id, arb_key_pair}; use proptest::prelude::*; proptest! { #[test] fn device_id_deterministic(id in arb_device_id()) { assert_ne!(id.to_string(), ""); } #[test] fn key_pair_valid((sk, vk) in arb_key_pair()) { assert_eq!(sk.verifying_key(), vk); } } }
Available strategies include arb_device_id, arb_account_id, arb_session_id, and arb_key_pair. These generate valid, deterministic instances for property testing.
Lean Oracle
The lean_oracle module provides integration with Lean theorem proofs.
#![allow(unused)] fn main() { use aura_testkit::verification::lean_oracle::LeanOracle; let oracle = LeanOracle::new()?; let result = oracle.verify_journal_merge(&state1, &state2)?; }
The oracle invokes compiled Lean code to verify properties. This enables differential testing against proven implementations.
Capability Soundness
The capability_soundness module provides formal verification for capability system properties.
#![allow(unused)] fn main() { use aura_testkit::verification::capability_soundness::{ CapabilitySoundnessVerifier, SoundnessProperty, CapabilityState }; let mut verifier = CapabilitySoundnessVerifier::with_defaults(); let result = verifier.verify_property( SoundnessProperty::NonInterference, initial_state ).await?; assert!(result.holds); }
The verifier checks five soundness properties: NonInterference, Monotonicity, TemporalConsistency, ContextIsolation, and AuthorizationSoundness. Use verify_all_properties to check all properties at once.
Consensus Testing
The consensus module provides infrastructure for consensus protocol testing.
ITF Loader
The itf_loader module loads ITF traces for replay testing.
#![allow(unused)] fn main() { use aura_testkit::consensus::itf_loader::ITFLoader; let trace = ITFLoader::load("artifacts/traces/consensus_happy_path.itf.json")?; for state in trace.states { // Verify state against implementation } }
ITF traces come from Quint model checking. The loader parses them into Rust types for conformance testing.
Reference Implementation
The reference module provides a minimal consensus implementation for differential testing.
#![allow(unused)] fn main() { use aura_testkit::consensus::reference::ReferenceConsensus; let reference = ReferenceConsensus::new(config); let expected = reference.process_vote(vote)?; let actual = production_consensus.process_vote(vote)?; assert_eq!(expected.outcome, actual.outcome); }
The reference implementation prioritizes clarity over performance. It serves as a specification against which production code is tested.
Mock Runtime Bridge
The MockRuntimeBridge simulates the runtime environment for TUI testing.
#![allow(unused)] fn main() { use aura_testkit::mock_runtime_bridge::MockRuntimeBridge; let bridge = MockRuntimeBridge::new(); bridge.inject_chat_update(chat_state); bridge.inject_contact_update(contacts); }
This bridge injects signals that would normally come from the reactive pipeline. It enables testing TUI state machines without a full runtime.
Conformance Framework
The conformance module provides artifact validation for native/WASM parity testing.
Artifact Format
The AuraConformanceArtifactV1 captures execution state for comparison. The type is defined in aura_core::conformance:
#![allow(unused)] fn main() { use aura_core::{AuraConformanceArtifactV1, AuraConformanceRunMetadataV1, ConformanceSurfaceName}; let mut artifact = AuraConformanceArtifactV1::new(AuraConformanceRunMetadataV1 { target: "native".to_string(), profile: "native_coop".to_string(), scenario: "test_scenario".to_string(), seed: Some(42), commit: None, async_host_transcript_entries: None, async_host_transcript_digest_hex: None, }); // Insert required surfaces artifact.insert_surface(ConformanceSurfaceName::Observable, observable_surface); artifact.insert_surface(ConformanceSurfaceName::SchedulerStep, scheduler_surface); artifact.insert_surface(ConformanceSurfaceName::Effect, effect_surface); artifact.validate_required_surfaces()?; }
Every conformance artifact must capture three surfaces:
| Surface | Purpose | Content |
|---|---|---|
Observable | Protocol-visible outputs | Normalized message contents |
SchedulerStep | Logical progression | Step index, session state, role progression |
Effect | Effect envelope trace | Sequence of effect calls with arguments |
Missing surfaces cause validation failure.
Metadata aids debugging but does not affect comparison:
#![allow(unused)] fn main() { pub struct AuraConformanceRunMetadataV1 { pub target: String, pub profile: String, pub scenario: String, pub seed: Option<u64>, pub commit: Option<String>, pub async_host_transcript_entries: Option<u64>, pub async_host_transcript_digest_hex: Option<String>, } }
Effect Envelope Classification
Each effect kind has a comparison class that determines how differences are evaluated:
| Effect Kind | Class | Comparison Rule |
|---|---|---|
send_decision | commutative | Order-insensitive under normalization |
invoke_step | commutative | Scheduler interleavings normalized |
handle_recv | strict | Byte-exact match required |
handle_choose | strict | Branch choice must match |
handle_acquire | strict | Guard semantics must match |
handle_release | strict | Guard semantics must match |
topology_event | algebraic | Reduced via topology-normal form |
The strict class requires exact matches. The commutative class normalizes order before comparison. The algebraic class applies domain-specific reduction before comparison.
New effect kinds must be classified before use:
#![allow(unused)] fn main() { use aura_core::conformance::AURA_EFFECT_ENVELOPE_CLASSIFICATIONS; AURA_EFFECT_ENVELOPE_CLASSIFICATIONS.insert( "new_effect_kind", ComparisonClass::Strict, ); aura_core::assert_effect_kinds_classified(&effect_trace)?; }
Unclassified effect kinds cause conformance checks to fail.
Module Structure
aura-testkit/
├── src/
│ ├── builders/ # Test data builders
│ ├── configuration/ # Test configuration
│ ├── consensus/ # Consensus testing utilities
│ ├── conformance.rs # Conformance artifact support
│ ├── differential.rs # Differential testing
│ ├── fixtures/ # Reusable test fixtures
│ ├── foundation.rs # Core test utilities
│ ├── handlers/ # Mock effect handlers
│ ├── infrastructure/ # Test harness infrastructure
│ ├── mock_effects.rs # Simple mock implementations
│ ├── stateful_effects/ # Stateful effect handlers
│ └── verification/ # Property testing utilities
├── tests/ # Integration tests
└── benches/ # Performance benchmarks
Related Documentation
See Testing Guide for how to write tests using this infrastructure. See Effect System for effect trait definitions.
Simulation Infrastructure Reference
This document describes the architecture of aura-simulator, the simulation crate that provides deterministic protocol testing through effect handler composition, fault injection, and scenario execution.
Overview
The aura-simulator crate occupies Layer 6 in the Aura architecture. It enables testing distributed protocols under controlled conditions. The simulator uses a handler-based architecture rather than a monolithic simulation engine.
The crate provides four capabilities. It offers specialized effect handlers for simulation control. It includes a middleware system for fault injection. It supports TOML-based scenario definitions. It integrates with Quint for model-based testing.
Simulation Modes
The simulator provides two execution modes. TOML scenarios are human-written declarative test scripts that specify operations, assertions, and fault injection. Quint actions are model-generated traces from formal specifications that exercise state-space coverage.
Simulation is the deterministic execution substrate for runtime and app workflow validation. Complete-flow evidence requires the actual protocol, cryptographic, journal, ownership and app lifecycle implementations under controlled effects. Shared semantic contracts live in aura-app and are consumed by simulation and harness execution. The harness owns real frontend execution; local frontend evidence and final cross-machine integration evidence remain distinct from in-process correctness.
Complete-flow evidence boundary
A complete-flow result binds each action and terminal outcome to the original participant, operation and capability owner. Persistence acknowledgment, required task/session disposal and same-profile restart continuity are part of the lifecycle when the flow requires them. Seeds, selected providers, original endpoints and injected fault boundaries identify replay inputs. A restored scenario snapshot is not itself a restored runtime profile or a reissued capability.
Model-only transition adapters, mock runtime projections and artifact comparisons establish only their declared scope. They cannot manufacture signed acceptance, durable writes, quorum agreement or successful cleanup. Missing production integration remains an explicit coverage gap. Simulator growth extends existing production seams and shared semantic contracts rather than maintaining an independent protocol implementation. Execution and promotion workflows are defined in Simulation Guide.
Coverage boundaries
Runtime protocol execution, app semantic terminal publication, platform storage and real-network integration are separate evidence scopes. A complete-flow fixture exposes the real owners and acknowledgments needed to observe each supported scope. Unsupported stages remain explicit gaps; simulator availability alone does not establish coverage. Simulation and frontend execution share the app semantic contract while retaining their respective execution boundaries.
Declared execution scope
A flow's evidence identifies which stages execute canonical production owners and which remain unsupported. Runtime protocol, app terminal publication, host persistence and restart have independent acknowledgments. Coverage of one stage does not imply coverage of the next. Cross-machine confirmation binds the exact source revision and locally established flows to real network/process behavior.
Handler-Based Architecture
The simulator composes effect handlers rather than wrapping them in a central engine. Each simulated participant uses its own handler instances. This approach aligns with Aura's stateless effect architecture.
graph TD
A[Protocol Code] --> B[Effect Traits]
B --> C[SimulationTimeHandler]
B --> D[SimulationFaultHandler]
B --> E[Other Handlers]
C --> F[Simulated State]
D --> F
E --> F
Handlers implement effect traits from aura-core. Protocol code calls effect methods without knowing whether handlers are production or simulation instances.
Simulation Handlers
SimulationTimeHandler
This handler provides deterministic time control.
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationTimeHandler; use aura_core::effects::PhysicalTimeEffects; use std::time::Duration; let mut time = SimulationTimeHandler::new(); time.jump_to_time(Duration::from_secs(10)); let now = time.physical_time().await?; }
Time starts at zero and advances through explicit jump_to_time calls or sleep_ms invocations. This handler's sleep returns after advancing its local simulated time by the scaled duration. That behavior is distinct from concurrent runtime clocks: ManualPhysicalClock waits for explicit advancement, and QuiescentClock progresses at scheduler quiescence. Complete multi-participant runtime evidence retains the selected shared provider and original endpoints; background sleeps cannot independently spend the entire flow's lifetime. The testing and simulation guides specify provider selection.
SimulationFaultHandler
This handler injects faults into protocol execution.
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationFaultHandler; use aura_core::{AuraFault, AuraFaultKind, FaultEdge}; use std::time::Duration; let faults = SimulationFaultHandler::new(42); // seed for determinism // Inject a message delay fault let delay_fault = AuraFault { fault: AuraFaultKind::MessageDelay { delay_ms: 200 }, edge: FaultEdge::new("*", "*"), }; faults.inject_fault(delay_fault, Some(Duration::from_secs(60)))?; // Inject a message drop fault let drop_fault = AuraFault { fault: AuraFaultKind::MessageDrop { probability: 0.1 }, edge: FaultEdge::new("*", "*"), }; faults.inject_fault(drop_fault, None)?; // permanent }
Fault types include MessageDelay, MessageDrop, MessageCorruption, NodeCrash, NetworkPartition, FlowBudgetExhaustion, and JournalCorruption. Faults can be temporary (with duration) or permanent. The handler implements ChaosEffects for async fault injection.
SimulationScenarioHandler
This handler manages scenario-driven testing.
#![allow(unused)] fn main() { use aura_simulator::handlers::{ SimulationScenarioHandler, ScenarioDefinition, TriggerCondition, InjectionAction, }; let mut scenarios = SimulationScenarioHandler::new(); scenarios.add_scenario(ScenarioDefinition { name: "partition".to_string(), trigger: TriggerCondition::AfterTime(Duration::from_secs(5)), action: InjectionAction::PartitionNetwork { group_a: vec![device1, device2], group_b: vec![device3], }, }); }
Scenarios define triggered actions based on time or protocol state. They enable testing recovery from transient failures.
SimulationEffectComposer
This type composes handlers into complete simulation environments.
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationEffectComposer; use aura_core::DeviceId; let device_id = DeviceId::new_from_entropy([1u8; 32]); let composer = SimulationEffectComposer::for_testing(device_id).await?; let env = composer .with_time_control() .with_fault_injection() .build()?; }
The composer provides a builder pattern for handler configuration. It produces an effect system instance suitable for simulation.
TOML Scenario System
TOML scenarios provide human-readable integration tests with fault injection.
File Format
Scenario files live in the scenarios/ directory.
[metadata]
name = "dkd_basic_derivation"
description = "Basic P2P deterministic key derivation"
version = "1.0"
[[phases]]
name = "setup"
actions = [
{ type = "create_participant", id = "alice" },
{ type = "create_participant", id = "bob" },
]
[[phases]]
name = "derivation"
actions = [
{ type = "run_choreography", choreography = "p2p_dkd", participants = ["alice", "bob"] },
]
[[phases]]
name = "verification"
actions = [
{ type = "verify_property", property = "derived_keys_match" },
]
[[properties]]
name = "derived_keys_match"
property_type = "safety"
expression = "alice.derived_key == bob.derived_key"
Each scenario has metadata, ordered phases, and property definitions. Phases contain action sequences that execute in order.
Action Types
| Action | Parameters | Description |
|---|---|---|
create_participant | id | Create a simulated participant |
run_choreography | choreography, participants | Execute a choreographic protocol |
verify_property | property | Check a named property |
simulate_data_loss | participant, percentage | Delete random stored data |
apply_network_condition | condition, duration | Apply network fault |
advance_time | duration | Advance simulated time |
Execution
The SimulationScenarioHandler executes TOML scenarios.
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationScenarioHandler; let handler = SimulationScenarioHandler::new(); let result = handler.execute_file("scenarios/core_protocols/dkd_basic.toml").await?; assert!(result.all_properties_passed()); }
Execution proceeds phase by phase. Failures stop execution and report the failing action.
Configuration System
The simulator uses configuration types from aura_simulator::types.
SimulatorConfig
#![allow(unused)] fn main() { use aura_simulator::types::{SimulatorConfig, NetworkConfig}; use aura_core::DeviceId; let config = SimulatorConfig { seed: 42, deterministic: true, time_scale: 1.0, network: Some(NetworkConfig { latency: std::time::Duration::from_millis(50), packet_loss_rate: 0.02, bandwidth_bps: Some(1_000_000), }), ..Default::default() }; }
NetworkConfig
Network configuration controls simulated network conditions.
| Field | Type | Description |
|---|---|---|
latency | Duration | Base network latency |
packet_loss_rate | f64 | Probability of dropping messages |
bandwidth_bps | Option<u64> | Bytes per second limit |
SimulatorContext
The SimulatorContext tracks execution state during simulation runs.
#![allow(unused)] fn main() { use aura_simulator::types::SimulatorContext; let context = SimulatorContext::new("scenario_id".into(), "run_123".into()) .with_seed(42) .with_participants(3, 2) .with_debug(true); println!("Tick: {}", context.tick); println!("Timestamp: {:?}", context.timestamp); }
The context advances through advance_tick and advance_time methods.
Async Host Boundary
The AsyncSimulatorHostBridge provides an async request/resume interface for Telltale integration.
Design
#![allow(unused)] fn main() { use aura_simulator::{AsyncHostRequest, AsyncSimulatorHostBridge}; let mut host = AsyncSimulatorHostBridge::new(42); host.submit(AsyncHostRequest::VerifyAllProperties); let entry = host.resume_next().await?; }
The bridge maintains deterministic ordering through FIFO processing and monotone sequence IDs.
Determinism Constraints
The async host boundary enforces several constraints. Requests process in submission order. Each request receives a unique monotone sequence ID. No wall-clock time affects host decisions. Transcript entries enable replay comparison.
Transcript Artifacts
Adaptive Privacy Phase 6 Evidence
Phase 6 adaptive-privacy validation uses one deterministic artifact lane instead of ad hoc local sweeps. Run:
just ci-adaptive-privacy-tuning
That lane writes the canonical archive under
artifacts/adaptive-privacy/phase6/ with:
tuning_report.jsonfor the provisional-vs-fixed policy comparisonmatrix_results.jsonfor the canonical Phase 6 validation matrixcontrol-plane/telltale-backed parity reports for anonymous path establishment and reply-block accountabilityparity/report.jsonfor the generic telltale parity lane used by the same archive contract
These artifacts are the evidence source for tuned adaptive-privacy constants. They are observational outputs, not new semantic truth.
#![allow(unused)] fn main() { use aura_simulator::AsyncHostTranscriptEntry; let entry = host.resume_next().await?; assert_eq!(entry.sequence, 0); assert!(entry.request.is_verify_properties()); }
Transcript entries record request/response pairs. They enable sync-versus-async host parity testing.
Factory Abstraction
The SimulationEnvironmentFactory trait decouples simulation from effect system internals.
#![allow(unused)] fn main() { use aura_core::effects::{SimulationEnvironmentFactory, SimulationEnvironmentConfig}; let config = SimulationEnvironmentConfig { seed: 42, authority_id, device_id: Some(device_id), test_mode: true, }; let effects = factory.create_simulation_environment(config).await?; }
This abstraction enables stable simulation code across effect system changes. Only the factory implementation requires updates when internals change.
Quint Integration
The quint module provides integration with Quint formal specifications. See Formal Verification Reference for complete details.
Telltale Parity Integration
The simulator exposes telltale parity as an artifact-level boundary. The boundary lives in aura_simulator::telltale_parity. Default simulator execution does not run the protocol machine directly.
Entry Points
Use TelltaleParityInput and TelltaleParityRunner when both baseline and candidate artifacts are already in memory. Use run_telltale_parity_file_lane with TelltaleParityFileRun for file-driven CI workflows.
The supported file lanes accept baseline and candidate artifact paths, a comparison profile, an output report path, and upstream Telltale run sidecars. They emit one stable JSON report artifact whose semantic surface is rooted in the upstream run context rather than Aura-local fallback summaries.
Protocol-critical control-plane lifecycles should use the dedicated telltale
control-plane lanes instead of reimplementing the same ownership/timeout/replay
lifecycle in Aura-local simulator scenario state. Use
run_telltale_control_plane_file_lane with TelltaleControlPlaneFileRun for:
anonymous_path_establishreply_block_accountability
Those simulator lanes correspond to the current adaptive-privacy control-plane
protocol inventory in aura-agent:
- "AnonymousPathEstablishProtocol"
- "MoveReceiptReplyBlockProtocol"
- "HoldDepositReplyBlockProtocol"
- "HoldRetrievalReplyBlockProtocol"
- "HoldAuditReplyBlockProtocol"
Bootstrap and stale-node re-entry are not part of these lanes because they remain runtime-local bootstrap/hint logic rather than canonical multi-party control protocols.
Canonical Surface Mapping
Telltale parity lanes use one canonical mapping:
| Telltale Event Family | Aura Surface | Normalization |
|---|---|---|
observable | observable | identity |
scheduler_step | scheduler_step | tick normalization |
effect | effect | envelope classification |
Reports use schema aura.telltale-parity.report.v1.
For Telltale 11-backed lanes, Aura can also invoke an upstream simulator runner
first and attach the candidate run sidecar automatically. Use
run_telltale_parity_with_runner(...) or
run_telltale_control_plane_with_runner(...) and configure the runner command
with AURA_TELLTALE_SIMULATOR_RUNNER when the executable is not on the shell
search path. The supported report lanes still expect a baseline upstream run
sidecar so the report can compare theorem, scheduler, environment, and
reconfiguration context across both sides.
Expected Outputs
The simulator telltale parity lane writes:
artifacts/telltale-parity/report.json
The report includes:
- comparison classification (
strictorenvelope_bounded) - first mismatch surface
- first mismatch step index
- full differential comparison payload
- semantic summary derived from authoritative upstream Telltale 11 run context
- upstream Telltale 11 run context for both sides, with optional decision and sweep attachments when those sidecars are provided
Environment Bridge
Aura now exposes a small environment bridge for simulator-local state that is being migrated toward Telltale 11 terminology. The current migrated slice is:
- adaptive-privacy movement profiles -> mobility profiles
- sync opportunities -> link-admission observations
- provider saturation -> node-capability observations
Scenario runs now persist that bridge surface as first-class artifacts under the simulator artifact root:
<artifacts_dir>/scenario-runs/<scenario_slug>-seed-<seed>/environment_snapshot.json
<artifacts_dir>/scenario-runs/<scenario_slug>-seed-<seed>/environment_trace.json
<artifacts_dir>/scenario-runs/<scenario_slug>-seed-<seed>/environment_overlay.json
Read the written paths from SimulationResults::environment_artifacts. The
bridge remains the single Aura-owned place where migrated mobility,
link-admission, and node-capability decisions are materialized before handler
state keeps its richer Aura-local bookkeeping. The optional
environment_overlay.json supplement carries Aura-only dimensions such as
provider heterogeneity, admission pressure, topology churn, and interference
patterns without expanding the core bridge vocabulary.
Experiment Surfaces
Aura now layers its comparative experiment lanes on top of the published Telltale simulator harness and sweep machinery instead of adding a second local manifest format.
Use aura_simulator::run_adaptive_privacy_policy_sweep(...) together with
aura_simulator::archive_from_sweep(...) to produce AuraSweepArchiveV1
artifacts for adaptive-privacy comparisons while preserving the shared
Telltale sweep manifest shape internally. Use
aura_simulator::compare_policy_sweeps(...) to emit AuraPolicyDiffReportV1,
which compares two sweep runs with the shared Telltale diff logic.
For theorem-aware failure evidence, use
aura_simulator::counterexample_from_parity_report(...) or
aura_simulator::counterexample_from_control_plane_report(...). These wrappers
emit AuraCounterexampleReportV1, preserving the shared Telltale counterexample
witness internally and annotating whether the mismatch is schedule noise or
safety-visible divergence.
For reusable study bundles, use aura_simulator::run_suite_catalog(...) and
aura_simulator::compare_suite_catalogs(...). Aura owns the suite catalog
choices, while the shared Telltale harness remains the execution engine and
AuraSuiteTournamentReportV1 preserves the shared sweep-derived comparison
shape internally.
ITF Trace Format
ITF (Informal Trace Format) traces come from Quint model checking. Each trace captures a sequence of states and transitions.
{
"#meta": {
"format": "ITF",
"source": "quint",
"version": "1.0"
},
"vars": ["phase", "participants", "messages"],
"states": [
{
"#meta": { "index": 0 },
"phase": "Setup",
"participants": [],
"messages": []
},
{
"#meta": { "index": 1, "action": "addParticipant" },
"phase": "Setup",
"participants": ["alice"],
"messages": []
}
]
}
Each state represents a model state. Transitions between states correspond to actions.
ITF traces capture non-deterministic choices for replay:
{
"#meta": {
"index": 3,
"action": "selectLeader",
"nondet_picks": { "leader": "bob" }
}
}
The nondet_picks field records choices made by Quint. Replay uses these values to seed RandomEffects.
ITFLoader
#![allow(unused)] fn main() { use aura_simulator::quint::itf_loader::ITFLoader; let trace = ITFLoader::load("trace.itf.json")?; for (i, state) in trace.states.iter().enumerate() { let action = state.meta.action.as_deref(); let picks = &state.meta.nondet_picks; } }
The loader validates trace format and extracts typed state.
GenerativeSimulator
#![allow(unused)] fn main() { use aura_simulator::quint::generative_simulator::GenerativeSimulator; let simulator = GenerativeSimulator::new(config)?; let result = simulator.replay_trace(&trace).await?; }
The generative simulator replays ITF traces through real effect handlers.
Module Structure
aura-simulator/
├── src/
│ ├── handlers/ # Simulation effect handlers
│ │ ├── time_control.rs
│ │ ├── fault_simulation.rs
│ │ ├── scenario.rs
│ │ └── effect_composer.rs
│ ├── middleware/ # Effect interception
│ ├── quint/ # Quint integration
│ │ ├── itf_loader.rs
│ │ ├── action_registry.rs
│ │ ├── state_mapper.rs
│ │ └── generative_simulator.rs
│ ├── scenarios/ # Scenario execution
│ ├── async_host.rs # Async host boundary
│ └── testkit_bridge.rs # Testkit integration
├── tests/ # Integration tests
└── examples/ # Usage examples
Related Documentation
See Simulation Guide for how to write simulations. See Testing Guide for conformance testing. See Formal Verification Reference for Quint integration details.
Formal Verification Reference
This document describes the formal verification infrastructure that provides mathematical guarantees for Aura protocols through Quint model checking, Lean theorem proving, and Telltale session type verification.
Overview
Aura uses three complementary verification systems. Quint provides executable state machine specifications with model checking. Lean provides mathematical theorem proofs. Telltale provides session type guarantees for choreographic protocols.
The systems form a trust chain. Quint specifications define correct behavior. Lean proofs verify mathematical properties. Telltale ensures protocol implementations match session type specifications.
Verification Boundary
Aura separates domain proof ownership from runtime parity checks.
| Verification Surface | Primary Tools | Guarantee Class | Ownership |
|---|---|---|---|
| Consensus and CRDT domain properties | Quint + Lean | model and theorem correctness | verification/quint/ and verification/lean/ |
| Runtime execution conformance | Telltale parity + conformance artifacts | implementation parity under declared envelopes | aura-agent, aura-simulator, aura-testkit |
| Bridge consistency | aura-quint bridge pipeline | cross-validation between model checks and certificates | aura-quint |
Telltale runtime parity does not replace domain theorem work. It validates runtime behavior against admitted profiles and artifact envelopes.
Assurance Summary
This architecture provides five assurance classes.
-
Boundary assurance. Domain theorem claims and runtime parity claims are separated. This reduces proof-surface ambiguity.
-
Runtime parity assurance. Telltale parity lanes compare runtime artifacts with deterministic profiles. This provides replayable evidence for conformance under declared envelopes.
-
Bridge consistency assurance. Bridge pipelines check model-check outcomes against certificate outcomes. This detects drift between proof artifacts and executable checks.
-
CI gate assurance. Parity and bridge lanes run as CI gates. This prevents silent regression of conformance checks.
-
Coverage drift assurance. Coverage documentation is validated against repository state by script checks. This prevents long-term drift between claims and implementation.
Limits remain explicit. Parity success is not a replacement for new Quint or Lean domain proofs. Parity checks are coverage-bounded by scenarios, seeds, and artifact surfaces.
Quint Architecture
Quint specifications live in verification/quint/. They define protocol state machines and verify properties through model checking with Apalache.
Directory Structure
verification/quint/
├── core.qnt # Shared runtime utilities
├── authorization.qnt # Guard chain security
├── recovery.qnt # Guardian recovery
├── consensus/ # Consensus protocol specs
│ ├── core.qnt
│ ├── liveness.qnt
│ └── adversary.qnt
├── journal/ # Journal CRDT specs
│ ├── core.qnt
│ ├── counter.qnt
│ └── anti_entropy.qnt
├── keys/ # Key management specs
│ └── dkg.qnt
├── sessions/ # Session management specs
│ ├── core.qnt
│ └── groups.qnt
├── harness/ # Simulator harnesses
├── tui/ # TUI state machine
└── traces/ # Generated ITF traces
Each specification focuses on a single protocol or subsystem.
Specification Pattern
Specifications follow a consistent structure.
module protocol_example {
// Type definitions
type Phase = Setup | Active | Completed | Failed
type State = { phase: Phase, data: Data }
// State variables
var state: State
// Initial state
action init = {
state' = { phase: Setup, data: emptyData }
}
// State transitions
action transition(input: Input): bool = all {
state.phase != Completed,
state.phase != Failed,
state' = computeNextState(state, input)
}
// Invariants
val safetyInvariant = state.phase != Failed or hasRecoveryPath(state)
}
Actions define state transitions. Invariants define properties that must hold in all reachable states.
Harness Modules
Harness modules provide standardized entry points for simulation.
module harness_example {
import protocol_example.*
action register(id: Id): bool = init
action step(input: Input): bool = transition(input)
action complete(): bool = state.phase == Completed
}
Harnesses enable Quint simulation and ITF trace generation.
Available Specifications
| Specification | Purpose | Key Invariants |
|---|---|---|
consensus/core.qnt | Fast-path consensus | UniqueCommitPerInstance, CommitRequiresThreshold |
consensus/liveness.qnt | Liveness properties | ProgressUnderSynchrony, RetryBound |
consensus/adversary.qnt | Byzantine tolerance | ByzantineThreshold, EquivocationDetected |
journal/core.qnt | Journal CRDT | NonceUnique, FactsOrdered |
journal/anti_entropy.qnt | Sync protocol | FactsMonotonic, EventualConvergence |
authorization.qnt | Guard chain | NoCapabilityWidening, ChargeBeforeSend |
Lean Architecture
Lean proofs live in verification/lean/. They provide mathematical verification of safety properties.
Directory Structure
verification/lean/
├── lakefile.lean # Build configuration
├── Aura/
│ ├── Assumptions.lean # Cryptographic axioms
│ ├── Types.lean # Core type definitions
│ ├── Types/
│ │ ├── ByteArray32.lean
│ │ └── OrderTime.lean
│ ├── Proofs/
│ │ ├── Consensus/
│ │ │ ├── Agreement.lean
│ │ │ ├── Validity.lean
│ │ │ ├── Equivocation.lean
│ │ │ ├── Liveness.lean
│ │ │ ├── Evidence.lean
│ │ │ ├── Adversary.lean
│ │ │ └── Frost.lean
│ │ ├── Journal.lean
│ │ ├── FlowBudget.lean
│ │ ├── GuardChain.lean
│ │ ├── KeyDerivation.lean
│ │ ├── TimeSystem.lean
│ │ └── ContextIsolation.lean
│ └── Runner.lean # CLI for differential testing
Axioms
Cryptographic assumptions appear as axioms in Assumptions.lean.
axiom frost_threshold_unforgeability :
∀ (k n : Nat) (shares : List Share),
k ≤ shares.length →
shares.length ≤ n →
validShares shares →
unforgeable (aggregate shares)
axiom hash_collision_resistance :
∀ (a b : ByteArray), hash a = hash b → a = b
Proofs that depend on these assumptions are sound under standard cryptographic hardness assumptions.
The consensus proofs also depend on domain-level axioms for signature binding. These axioms establish that valid signatures bind to unique results. See verification/lean/Aura/Assumptions.lean for the full axiom reduction analysis.
Claims Bundles
Related theorems group into claims bundles.
structure ValidityClaims where
commit_has_threshold : ∀ c, isCommit c → hasThreshold c
validity : ∀ c, isCommit c → validPrestate c
distinct_signers : ∀ c, isCommit c → distinctSigners c.shares
def validityClaims : ValidityClaims := {
commit_has_threshold := Validity.commit_has_threshold
validity := Validity.validity
distinct_signers := Validity.distinct_signers
}
Bundles provide easy access to related proofs.
Proof Status
| Module | Status | Notes |
|---|---|---|
Validity | Complete | All theorems proven |
Equivocation | Complete | Detection soundness/completeness |
Evidence | Complete | CRDT properties |
Frost | Complete | Aggregation properties |
Agreement | Uses axiom | Depends on FROST uniqueness |
Liveness | Axioms | Timing assumptions |
Journal | Complete | CRDT semilattice properties |
Canonical Lean API Types
Legacy Lean verification compatibility types have been removed from aura_testkit::verification and aura_testkit::verification::lean_oracle. Use the canonical full-fidelity types and methods.
Type Mapping
| Legacy Type | Canonical Type |
|---|---|
Fact | LeanFact |
ComparePolicy | LeanComparePolicy |
TimeStamp | LeanCompareTimeStamp (compare payloads) or LeanTimeStamp (journal facts) |
Ordering | LeanTimestampOrdering |
FlowChargeInput/FlowChargeResult | LeanFlowChargeInput/LeanFlowChargeResult |
TimestampCompareInput/TimestampCompareResult | LeanTimestampCompareInput/LeanTimestampCompareResult |
Method Mapping
| Legacy Method | Canonical Method |
|---|---|
verify_merge | verify_journal_merge |
verify_reduce | verify_journal_reduce |
verify_charge | verify_flow_charge |
verify_compare | verify_timestamp_compare |
aura-quint Crate
The aura-quint crate provides Rust integration with Quint specifications.
QuintRunner
The runner executes Quint verification and parses results.
#![allow(unused)] fn main() { use aura_quint::runner::{QuintRunner, RunnerConfig}; use aura_quint::PropertySpec; let config = RunnerConfig { default_timeout: Duration::from_secs(60), max_steps: 1000, generate_counterexamples: true, ..Default::default() }; let mut runner = QuintRunner::with_config(config)?; let spec = PropertySpec::invariant("UniqueCommitPerInstance"); let result = runner.verify_property(&spec).await?; }
The runner provides verify_property for invariant checking and simulate for trace-based testing. It caches results and can generate counterexamples.
Property Evaluator
The evaluator checks properties against Rust state.
#![allow(unused)] fn main() { use aura_quint::evaluator::PropertyEvaluator; let evaluator = PropertyEvaluator::new(); let result = evaluator.evaluate("chargeBeforeSend", &state)?; }
Properties translate from Quint syntax to Rust predicates.
Property Categories
The evaluator classifies properties by keyword patterns.
| Category | Keywords | Examples |
|---|---|---|
| Authorization | grant, permit, guard | guardChainOrder |
| Budget | budget, charge, spent | chargeBeforeSend |
| Integrity | attenuation, signature | attenuationOnlyNarrows |
| Liveness | eventually, progress | eventualConvergence |
| Safety | never, always, invariant | uniqueCommit |
Categories help organize verification coverage reports.
Telltale Bridge Data Contract
aura-quint defines a versioned interchange schema for bridge workflows.
| Type | Purpose |
|---|---|
BridgeBundleV1 | Top-level bundle with schema_version = "aura.telltale-bridge.v1" |
SessionTypeInterchangeV1 | Session graph exchange |
PropertyInterchangeV1 | Quint, Telltale, and Lean property exchange |
ProofCertificateV1 | Proof or model-check evidence |
Use this schema as the canonical data contract when exporting Quint sessions to Telltale formats or importing Telltale and Lean properties into Quint harnesses.
Quint-Lean Correspondence
This section maps Quint model invariants to Lean theorem proofs, providing traceability between model checking and formal proofs.
Types Correspondence
| Quint Type | Lean Type | Rust Type |
|---|---|---|
ConsensusId | Aura.Domain.Consensus.Types.ConsensusId | consensus::types::ConsensusId |
ResultId | Aura.Domain.Consensus.Types.ResultId | consensus::types::ResultId |
PrestateHash | Aura.Domain.Consensus.Types.PrestateHash | consensus::types::PrestateHash |
AuthorityId | Aura.Domain.Consensus.Types.AuthorityId | core::AuthorityId |
ShareData | Aura.Domain.Consensus.Types.ShareData | consensus::types::SignatureShare |
ThresholdSignature | Aura.Domain.Consensus.Types.ThresholdSignature | consensus::types::ThresholdSignature |
CommitFact | Aura.Domain.Consensus.Types.CommitFact | consensus::types::CommitFact |
WitnessVote | Aura.Domain.Consensus.Types.WitnessVote | consensus::types::WitnessVote |
Evidence | Aura.Domain.Consensus.Types.Evidence | consensus::types::Evidence |
Invariant-Theorem Correspondence
Agreement Properties
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
InvariantUniqueCommitPerInstance | Aura.Proofs.Consensus.Agreement.agreement | proven |
InvariantUniqueCommitPerInstance | Aura.Proofs.Consensus.Agreement.unique_commit | proven |
| - | Aura.Proofs.Consensus.Agreement.commit_determinism | proven |
Validity Properties
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
InvariantCommitRequiresThreshold | Aura.Proofs.Consensus.Validity.commit_has_threshold | proven |
InvariantSignatureBindsToCommitFact | Aura.Proofs.Consensus.Validity.validity | proven |
| - | Aura.Proofs.Consensus.Validity.distinct_signers | proven |
| - | Aura.Proofs.Consensus.Validity.prestate_binding_unique | proven |
| - | Aura.Proofs.Consensus.Validity.honest_participation | proven |
| - | Aura.Proofs.Consensus.Validity.threshold_unforgeability | axiom |
FROST Integration Properties
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
InvariantSignatureThreshold | Aura.Proofs.Consensus.Frost.aggregation_threshold | proven |
| - | Aura.Proofs.Consensus.Frost.share_session_consistency | proven |
| - | Aura.Proofs.Consensus.Frost.share_result_consistency | proven |
| - | Aura.Proofs.Consensus.Frost.distinct_signers | proven |
| - | Aura.Proofs.Consensus.Frost.share_binding | proven |
Evidence CRDT Properties
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
| - | Aura.Proofs.Consensus.Evidence.merge_comm_votes | proven |
| - | Aura.Proofs.Consensus.Evidence.merge_assoc_votes | proven |
| - | Aura.Proofs.Consensus.Evidence.merge_idem | proven |
| - | Aura.Proofs.Consensus.Evidence.merge_preserves_commit | proven |
| - | Aura.Proofs.Consensus.Evidence.commit_monotonic | proven |
Equivocation Detection Properties
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
InvariantEquivocationDetected | Aura.Proofs.Consensus.Equivocation.detection_soundness | proven |
InvariantEquivocationDetected | Aura.Proofs.Consensus.Equivocation.detection_completeness | proven |
InvariantEquivocatorsExcluded | Aura.Proofs.Consensus.Equivocation.exclusion_correctness | proven |
InvariantHonestMajorityCanCommit | Aura.Proofs.Consensus.Equivocation.honest_never_detected | proven |
| - | Aura.Proofs.Consensus.Equivocation.verified_proof_sound | proven |
Byzantine Tolerance (Adversary Module)
| Quint Invariant | Lean Theorem | Status |
|---|---|---|
InvariantByzantineThreshold | Aura.Proofs.Consensus.Adversary.adversaryClaims.byzantine_cannot_forge | claim |
InvariantEquivocationDetected | Aura.Proofs.Consensus.Adversary.adversaryClaims.equivocation_detectable | claim |
InvariantHonestMajorityCanCommit | Aura.Proofs.Consensus.Adversary.adversaryClaims.honest_majority_sufficient | claim |
InvariantEquivocatorsExcluded | Aura.Proofs.Consensus.Adversary.adversaryClaims.equivocators_excluded | claim |
InvariantCompromisedNoncesExcluded | - | Quint only |
Liveness Properties
| Quint Property | Lean Support | Notes |
|---|---|---|
InvariantProgressUnderSynchrony | Aura.Proofs.Consensus.Liveness.livenessClaims.terminationUnderSynchrony | axiom |
InvariantByzantineTolerance | byzantine_threshold | axiom |
FastPathProgressCheck | Aura.Proofs.Consensus.Liveness.livenessClaims.fastPathBound | axiom |
SlowPathProgressCheck | Aura.Proofs.Consensus.Liveness.livenessClaims.fallbackBound | axiom |
NoDeadlock | Aura.Proofs.Consensus.Liveness.livenessClaims.noDeadlock | axiom |
InvariantRetryBound | - | Quint model checking only |
Module Correspondence
| Lean Module | Quint File | What It Proves |
|---|---|---|
Proofs.ContextIsolation | authorization.qnt, leakage.qnt | Context separation and bridge authorization |
Proofs.Consensus.Agreement | consensus/core.qnt | Agreement safety (unique commits) |
Proofs.Consensus.Evidence | consensus/core.qnt | CRDT semilattice properties |
Proofs.Consensus.Frost | consensus/frost.qnt | Threshold signature correctness |
Proofs.Consensus.Liveness | consensus/liveness.qnt | Synchrony model axioms |
Proofs.Consensus.Adversary | consensus/adversary.qnt | Byzantine tolerance bounds |
Proofs.Consensus.Equivocation | consensus/adversary.qnt | Detection soundness/completeness |
Quint Integration in aura-simulator
The simulator provides deeper Quint integration for model-based testing.
ITFLoader
#![allow(unused)] fn main() { use aura_simulator::quint::itf_loader::ITFLoader; let trace = ITFLoader::load("trace.itf.json")?; }
The loader parses ITF traces into typed Rust structures.
QuintMappable Trait
Types that map between Quint and Rust implement QuintMappable.
#![allow(unused)] fn main() { use aura_core::effects::quint::QuintMappable; impl QuintMappable for ConsensusState { fn from_quint(value: &QuintValue) -> Result<Self> { // Parse Quint JSON into Rust type } fn to_quint(&self) -> QuintValue { // Convert Rust type to Quint JSON } } }
This trait enables bidirectional state mapping.
ActionRegistry
The registry maps Quint action names to Rust handlers.
#![allow(unused)] fn main() { use aura_simulator::quint::action_registry::{ActionRegistry, ActionHandler}; let mut registry = ActionRegistry::new(); registry.register("initContext", Box::new(InitContextHandler)); registry.register("submitVote", Box::new(SubmitVoteHandler)); let result = registry.execute("initContext", ¶ms, &effects).await?; }
Handlers implement Quint actions using real effect handlers.
StateMapper
The mapper converts between Aura and Quint state representations.
#![allow(unused)] fn main() { use aura_simulator::quint::state_mapper::StateMapper; let mapper = StateMapper::default(); let quint_state = mapper.aura_to_quint(&aura_state)?; let updated_aura = mapper.quint_to_aura(&quint_state)?; }
Bidirectional mapping enables state synchronization during trace replay.
GenerativeSimulator
The simulator replays ITF traces through real effect handlers.
#![allow(unused)] fn main() { use aura_simulator::quint::generative_simulator::{ GenerativeSimulator, GenerativeSimConfig, }; let config = GenerativeSimConfig { max_steps: 1000, check_invariants_every: 10, seed: Some(42), }; let simulator = GenerativeSimulator::new(config)?; let result = simulator.replay_trace(&trace).await?; }
Replay validates that implementations match Quint specifications.
Telltale Formal Guarantees
Telltale provides session type verification for choreographic protocols.
Session Type Projections
Choreographies project to local session types for each participant.
#![allow(unused)] fn main() { #[choreography] async fn two_party_exchange<A, B>( #[role] alice: A, #[role] bob: B, ) { alice.send(bob, message)?; let response = bob.recv(alice)?; } }
The macro generates session types that ensure protocol compliance.
Leakage Tracking
The LeakageTracker monitors information flow during protocol execution.
#![allow(unused)] fn main() { use aura_mpst::LeakageTracker; let tracker = LeakageTracker::new(budget); tracker.record_send(recipient, message_size)?; let remaining = tracker.remaining_budget(); }
Choreography annotations specify leakage costs. The tracker enforces budgets at runtime.
Guard Annotations
Guards integrate with session types through annotations.
#![allow(unused)] fn main() { #[guard_capability("send_message")] #[flow_cost(100)] #[journal_facts("MessageSent")] async fn send_step() { // Implementation } }
Annotations generate guard chain invocations. The Telltale compiler verifies annotation consistency.
Related Documentation
- Verification Guide: practical workflows, commands, and Quint-Lean correspondence tables
- Verification Coverage: current metrics, file inventories, and CI gates
- Simulation Infrastructure Reference: ITF trace format and generative simulation
User Flow Harness
This document defines the harness contract for parity-critical user flows. It supplements Testing Guide. Crate placement follows Project Structure.
1. Purpose
aura-harness is the multi-instance orchestration crate for end-to-end Aura validation. It starts local, browser, and SSH-backed instances. It runs shared scenarios against real frontends instead of renderer-specific scripts.
Complete runtime and app workflow correctness is established first by deterministic in-process execution of the real implementation. The harness owns real frontend integration evidence, including renderer and platform boundaries. Cross-machine P2P evidence is a final batched integration scope. Models and mock projections cannot replace actual protocol execution; simulator results cannot replace real frontend evidence. Validation scheduling is defined in Testing Guide.
2. Execution Lanes
The harness defines two execution lanes:
- Shared semantic lane: submits typed intent commands and waits on typed semantic contracts.
- Frontend-conformance lane: validates renderer-specific wiring such as PTY keys, DOM selectors, focus movement, and control bindings.
See Testing Guide for lane selection and execution details.
3. Scenario Sources
The scenario source of truth is aura-app::scenario_contract. Scenario taxonomy:
- Shared semantic scenarios: typed semantic steps, no
execution_modedeclaration, no renderer-specific mechanics. - Frontend-conformance scenarios: typed
UiActionmechanics (key presses, text input, modal dismissal), must declareexecution_modeexplicitly. - Compatibility fixtures: quarantined renderer-mechanic coverage only, must declare
execution_mode = "compatibility"orexecution_mode = "agent".
Inventoried scenarios are classified in scenarios/harness_inventory.toml as shared, TUI conformance, or web conformance.
See Testing Guide for scenario authoring and governance.
4. Backend Model
The harness defines the following backend interfaces:
InstanceBackend: lifecycle, health checks, snapshots, log tails, and basic input.RawUiBackend: renderer-driven actions for conformance coverage.SharedSemanticBackend:shared_projection(),submit_semantic_command(), and projection-event waits. Implemented byLocalPtyBackendandPlaywrightBrowserBackend.SshTunnelBackend: orchestration-only (SSH security defaults and tunnel setup).
See Testing Guide for backend implementation.
5. Observation Model
UiSnapshot is the authoritative observation surface for parity-critical flows. Observation contracts:
- Snapshots carry
ProjectionRevision, separateprojection_source_revisionsfor observed entity signals, quiescence state, selections, lists, operations, toasts, and runtime events. The source revisions identify graph values copied into the app view;ProjectionRevisiontracks frontend semantic and render publication. - Parity-critical waits bind to typed contracts (readiness, visibility, events, quiescence, operation handles, strictly newer projections). Raw text matching and DOM scraping are diagnostics only.
- Reactive refresh may combine a burst of signal updates into a later current-state projection. A wait for convergence checks the authoritative state and a strictly newer projection or declared barrier; it does not require every intermediate signal value or projection revision to be observed.
- Frontend subscription health distinguishes attaching, ready, recovering, and failed observation for the active runtime generation. A missing signal or closed stream cannot be reported as ready; recovery attaches a new receiver and resnapshots current state before the frontend reports convergence.
- Browser generation replacement and TUI remount cancel old observers before the new generation is ready. Harness waits bind to the active generation and treat stale-generation projections as stale even when their contents look plausible.
- Observation paths are side-effect free. Reads do not repair state or retry hidden actions.
See Testing Guide for observation patterns.
6. Semantic Command Plane
Shared commands are typed IntentAction requests (account creation, device enrollment, contact invitations, channel membership, chat sends). Contracts:
- Each command returns a typed response with submission metadata and an optional operation handle.
- Post-action waits require a strictly newer authoritative projection or another declared barrier.
- Unsupported semantic commands fail closed. No silent fallback to renderer-specific behavior.
ExportDeviceEnrollmentSetupreturns an immediate typedDeviceEnrollmentSetup { setup_code }value from the runtime's bounded signing export. It has no ceremony operation handle. Native and browser adapters transfer the exact code; missing runtime or signing readiness rejects export rather than manufacturing identity evidence.- Enrollment code issuance and enrollment completion are separate operation instances. A code-ready response confirms only issuance. Wait for the ceremony-linked completion instance and its authoritative terminal state before asserting that another device joined.
OperationSnapshotexports the instance ID, state, and stable failure domain/code on both frontends. A cancelled operation remains distinguishable from a failure. Shared waits use those fields and the active observation generation; local wizard state, a toast, a click, or a changed count cannot substitute for a terminal result.- A staged browser import or bootstrap handoff reports staging. The follow-up operation settles only after the runtime ceremony outcome is observed.
- Guardian acceptance uses a distinct follow-up operation. It succeeds only after the principal's verified binding acknowledgment; local acceptance or a click is not a terminal result.
See Testing Guide for semantic command usage.
7. Scenario Execution
ScenarioExecutor enforces per-step budgets and an optional global budget. Contracts:
- Shared scenarios must declare convergence barriers before the next typed intent when the flow requires one.
- The executor records canonical trace events, state transitions, and step metrics.
- Frontend-conformance scenarios produce traces and diagnostics but are not the primary parity oracle for shared business flows.
See Testing Guide for scenario execution details.
8. Determinism And Replay
Determinism contracts:
- Configuration validation is config-first: invalid inputs fail before execution starts.
- Determinism derives from
build_seed_bundle()(run seed, scenario seed, fault seed, per-instance seeds). Event streams use monotonically increasing identifiers. - Replay bundles store run config, tool API version, action log, routing metadata, and seed bundle. Deterministic shared flows preserve semantic trace shape under identical inputs.
See Testing Guide for determinism and replay details.
9. Runtime Substrate
The harness supports real and simulator runtime substrates. The existing harness command default is real; that command default does not determine development validation order. The simulator substrate is a deterministic runtime controller for fault injection and transcript capture.
Simulator substrate runs currently support local instances only. Browser instances are not allowed in simulator mode. Runtime/app flow evidence, local frontend-conformance evidence and cross-machine integration evidence retain distinct scopes. Shared actions and expected outcomes come from the app contract; missing complete-flow simulator coverage remains explicit until implemented. No browser simulator support is implied by this contract.
10. Governance And Policy
Harness governance is typed first. aura-harness exposes governance checks for shared scenario contracts, scenario-shape enforcement, barrier legality, user-flow coverage, UI parity metadata, and wrapper integrity.
The main repository policy entry points are Aura's toolkit/xtask checks exposed through just ci-shared-flow-policy, just ci-user-flow-policy, and just ci-harness-matrix-inventory.
Harness mode may add instrumentation and render-stability hooks. It must not change parity-critical business semantics. Allowlisted exceptions must carry owner, justification, and design-note metadata.
11. Boundaries
aura-harness is tooling. It is not the authority for domain semantics, effect traits, or protocol safety rules. Those contracts remain owned by aura-core, aura-app, and the other runtime and specification crates.
The harness drives instances through process boundaries and typed tool surfaces. It must not mutate protocol state out of band. Shared UX identifiers, parity metadata, and observation shapes remain owned by aura-app::ui_contract.
Enrollment manifest transfer surface
ImportDeviceEnrollmentCode takes an enrollment code plus explicit signed manifest and independently transferred initiator verifier inputs. Its submission is a device_enrollment operation handle. The shared fields are DeviceImportCode, DeviceImportManifest, and DeviceImportInitiatorVerifier; browser DOM identifiers are aura-account-import-code-input, aura-device-import-manifest-input, and aura-device-import-initiator-verifier-input. Import requires a real provisional runtime with its actual exported setup signing context. Received invitation identities cannot create or replace this runtime before verification.
DeviceEnrollmentCodeReady carries the actual issuer's manifest/verifier transfer alongside the enrollment code. Capturing event variable name also captures name_manifest and name_initiator_verifier. Shared scenarios pass all three explicitly. Missing event payload fails rather than consulting the clipboard or reconstructing trust from the enrollment code. Legacy pending-code records cannot replay an enrollment without owned authenticated transfer evidence.
Native semantic failure codes
Shared semantic operation errors preserve the operation failure domain and native failure code across frontend and harness snapshots. Required native categories map to crypto_failure, serialization_failure, storage_failure, journal_failure, or reactive_failure. Generic crypto failure does not assert unauthorized access or signature denial. All frontends and harness observers consume this canonical shared error contract; display text is not category evidence.
Typed command failure classification
Strong-command terminal outcomes classify typed resolver/precondition/plan failures and native runtime error categories. The display text of generic Invalid or PermissionDenied failures cannot manufacture a more specific semantic subreason. A membership/mute/ban result requires an originating typed domain reason; generic denial remains permission_denied.
Typed moderation decisions
A command's not_member, muted, or banned code requires the corresponding typed moderation decision retained from the authoritative status query. Send/join operations retain the exact queried context/channel/authority. Generic permission text cannot supply those codes. The existing owned send failure boundary publishes moderation denial before returning its original source chain.
Enrollment import success requires the actual independently pinned issuer committed confirmation, durable original-window acknowledgement and sanctioned exact-generation adoption. Frontends receive an opaque completion with receipt locator fields; they cannot reconstruct completion from persisted JSON or subject/device IDs. A profile handoff or restart must revalidate the runtime's original durable receipt before publishing the selected identity. Persisting selection, account configuration and pending-state cleanup separately does not satisfy this profile transaction contract.
Required flow-budget guard denial has the stable budget_exceeded native and
semantic category. It remains distinct from authorization denial and retains the
structural required/remaining policy reason. Frontends and harness observers do
not infer either category from operation text or automatically retry it.
Bootstrap account operation continuity
Runtime-free account creation transfers its original operation instance to the application owner before storage production. A successful terminal outcome requires acknowledgment of both pending bootstrap and account configuration. The first runtime attachment preserves that original authoritative operation history. Frontend-local observations and pending-file reconciliation cannot mint account creation success. Shared parity compares that retained terminal outcome across terminal and browser surfaces.
Explicit quorum initiation consent
An enrollment signing intent is identification data. Receiving, displaying, or parsing it does not approve signing. Local consent binds the original runtime and exact v4 five-domain intent, including its original issuer return mailbox statement and finite conditional negative terminal policy. Historical consent cannot be upgraded to new control authority; the policy alone cannot establish a negative decision or terminal success. A pending code-issuance outcome is distinct from committed enrollment and activation, and shared scenarios cannot infer the latter from code export. When a shared scenario performs setup and then imports enrollment under the same operation ID for one actor, it captures the setup operation instance before import and requires a different instance for terminal completion. For an actor with no prior enrollment operation, the scenario establishes that absence before import and then observes that actor's own successful operation. Neither a prior setup success nor another actor's result establishes import success. An operation wait first requires the selected actor's semantic snapshot to contain the requested operation ID and state, with a fresh instance when one was specified. If that actor also has a matching submitted handle, the wait additionally requires the handle's exact instance and state; a handle alone cannot supply missing snapshot evidence.
Ownership Model
This document defines Aura's ownership model for authority, mutation, async lifecycle, and terminal failure behavior across the workspace.
It complements System Architecture for the high-level system view. See Effect System for effect boundaries. See Runtime for lifecycle and supervision. See Project Structure for layer placement.
Overview
Aura uses four ownership categories: Pure, MoveOwned, ActorOwned, and Observed. Every parity-critical subsystem, operation, and mutation surface must fit one of these categories. Bugs of the form "multiple layers own the same truth" are architectural violations.
Categories
Pure
Pure code is deterministic and effect-free. Use it for reducers, validators, state machines, fact interpretation, and typed contracts. Pure code may not own long-lived mutable async state, publish semantic lifecycle, or rely on ambient authority.
MoveOwned
MoveOwned code represents exclusive authority through consumed values. Use it for operation handles, owner tokens, delegation records, session handoff objects, and stale-owner invalidation boundaries.
Ownership transfer must consume a handoff object or owner token. Stale holders must become invalid by construction. Direct owner-field rewrites are forbidden where a transfer object is required.
ActorOwned
ActorOwned code owns long-lived mutable async state under one live task. Use it for runtime services, supervisors, maintenance loops, readiness coordinators, lifecycle coordinators, and command ingress loops.
There must be exactly one live owner for the mutable state domain. Mutation happens through typed ingress, not shared mutable access. Long-lived background work must be supervised. Owner death must lead to explicit terminal state, failure, or shutdown.
In practice, Aura's production ActorOwned runtime path is aura-agent:
- bounded ingress is declared with
aura-core::BoundedActorIngress - long-lived service ownership is internal to runtime service modules
- shared actor handles/mailboxes are crate-private runtime internals, not a public API for higher layers
- raw spawn lives only inside the sanctioned supervision implementation
- public runtime facades must consume shared runtime-owned supervisors and ceremony runners. They may not allocate private ownership roots as a convenience constructor.
- service health must reflect degraded obligation progress explicitly. "Task exists" is not a sufficient health contract when required maintenance work is failing.
Observed
Observed code reads and presents authoritative state but does not own it. Use it for projections, UI rendering, harness reads, diagnostics, and reporting.
Observed code may submit typed commands to owner surfaces. It may not author semantic lifecycle or readiness truth. It may not repair ownership mistakes by mutating product state.
Observed/reactive code also may not synthesize canonical entity metadata from weaker signals. If a channel, invitation, or similar parity-critical entity requires canonical name/context materialization, one explicit owned path must materialize it end to end. Membership events, UI projections, or view-local fallbacks may enrich an already-materialized entity, but they may not create or repair the canonical entity shape.
Capability-Gated Authority
The ownership model builds on Aura's existing capability system. Parity-critical mutation and publication should be capability-gated.
Semantic lifecycle publication requires an appropriate capability. Readiness publication requires a coordinator-owned capability. Ownership transfer requires a transfer capability or sanctioned handoff token. Actor ingress that mutates owned state requires the actor's command boundary.
The goal is to make incorrect authority structurally hard to express. Code should not be able to publish semantic truth merely because it can call a helper.
The same fail-closed rule applies to authoritative signal reads in semantic
owner code. Missing or unavailable authoritative state must surface as explicit
failure or degraded state, not Default::default() business truth.
Usage Examples
When To Use Pure
Use Pure when the code interprets values rather than owning authority or async lifecycle.
#![allow(unused)] fn main() { pub fn reduce_membership( current: MembershipState, fact: MembershipFact, ) -> MembershipState { match fact { MembershipFact::Joined { member } => current.with_member(member), MembershipFact::Left { member } => current.without_member(member), } } }
This stays Pure because it consumes and returns values, owns no long-lived state, and does not publish lifecycle directly.
When To Use MoveOwned
Use MoveOwned when stale access must become invalid after handoff.
#![allow(unused)] fn main() { use aura_core::{ issue_owner_token, OwnershipTransferCapability, }; let capability = OwnershipTransferCapability::new("ownership:transfer"); let token = issue_owner_token(&capability, "invite-op-7", "channel:alpha"); let transfer = token.handoff("invite-coordinator"); }
The original token is consumed by handoff. Trying to act through the old owner is a compile-time error.
Typed ownership capabilities from the same wrapper family can also be issued onto Aura's existing Biscuit path without first down-converting them to raw CapabilityKey values via ownership_capability_token_request_for(...). Lower layers should not expose parallel raw ownership-capability request helpers once a typed wrapper family exists.
When To Use Capability Tokens
Use capability wrappers whenever parity-critical code needs authority to author semantic truth.
#![allow(unused)] fn main() { use aura_core::{ issue_operation_context, AuthorizedProgressPublication, AuthorizedReadinessPublication, LifecyclePublicationCapability, OperationContextCapability, OperationTimeoutBudget, OwnedShutdownToken, OwnerEpoch, PublicationSequence, ReadinessPublicationCapability, TraceContext, }; let context_capability = OperationContextCapability::new("semantic:context"); let lifecycle_capability = LifecyclePublicationCapability::new("semantic:lifecycle"); let mut ctx = issue_operation_context( &context_capability, "send_message", "send_message-7", OwnerEpoch::new(0), PublicationSequence::new(0), OperationTimeoutBudget::deferred_local_policy(), OwnedShutdownToken::detached(), TraceContext::detached(), ); let update: AuthorizedProgressPublication<_, _, _, _> = ctx.publish_progress(&lifecycle_capability, "waiting"); let terminal = ctx .begin_terminal::<(), &'static str>(&lifecycle_capability) .fail("timeout"); }
Context minting and publication both require capability-shaped inputs. Random helper code cannot fabricate owner context or publish lifecycle by accident.
The same rule applies to readiness and actor-ingress mutation. Higher layers should prefer AuthorizedReadinessPublication<T> and AuthorizedActorIngressMutation<T> over raw capability arguments when they need to move parity-critical authority across API boundaries.
When To Use ActorOwned
Use ActorOwned when one live task must own mutable async state and terminal responsibility.
#![allow(unused)] fn main() { struct ChannelInviteCoordinator { pending: HashMap<InviteId, InviteState>, rx: mpsc::Receiver<InviteCommand>, } impl ChannelInviteCoordinator { async fn run(mut self) { while let Some(command) = self.rx.recv().await { self.apply(command).await; } } } }
There is one live owner of pending. Mutation happens through typed ingress. Owner drop is a lifecycle event that must be surfaced explicitly.
Selection Heuristics
Choose Pure first if the logic can be expressed as value-in/value-out. Choose MoveOwned when the hard problem is exclusive authority or stale-holder invalidation. Choose ActorOwned when the hard problem is long-lived mutable async state under one live owner. Choose Observed only for read-only presentation or diagnostics.
Anti-patterns to avoid:
- a shell callback publishing semantic success (should be
Observed) - shared mutable
Arc<Mutex<_>>state spread across tasks (should beActorOwned) - rewriting an owner field in place after delegation (should be
MoveOwned) - reducers that call time/network/storage directly (no longer
Pure) - reactive/view code inventing channel names from raw ids or membership events instead of consuming an owned canonical materialization path
- runtime or workflow code mining pending invitations, optimistic sketches, or cross-context routing cache entries to repair a missing authoritative binding/context after handoff
Contributor Requirement
New or materially changed parity-critical modules must declare their ownership
category in the crate ARCHITECTURE.md.
That declaration must name:
- the ownership category (
Pure,MoveOwned,ActorOwned, orObserved) - the authoritative owner for terminal lifecycle if the surface is async
- the capability-gated mutation/publication points
- the local timeout/backoff owner if deadlines or retries are involved
The ownership declaration is part of the change, not optional follow-up documentation.
Terminality
Every parity-critical operation must have typed terminal behavior. Direct boundaries use Result<T, E>. Long-running operations use typed lifecycle phases: Submitted, zero or more intermediate phases, then Succeeded, Failed(E), or Cancelled.
Runtime-owned bridge APIs must follow the same rule. If a public runtime call can
distinguish no progress, started, already running, processed,
degraded, or mutated, it must return a typed outcome instead of collapsing
those states into Result<(), E>.
Every submitted operation must reach a terminal state. Terminal states may not regress. Owner drop must publish failure or cancellation explicitly.
Device enrollment setup verification and code issuance belong to one submission
owner. Issuance success requires the runtime's actual ceremony result; common
preparation must not publish a second success. This start proof does not prove
enrollment completion, which has its own operation instance and authoritative
ceremony outcome. Invalid possession signatures or bindings yield
PermissionDenied; malformed or out-of-validity setup statements yield
InvalidArgument. Bounded deadlines yield OperationTimedOut with the original
typed cause retained through the standard error source chain.
Enrollment completion is owned by the app workflow layer, not by a frontend. Its operation instance is keyed by ceremony ID, so a replayed older ceremony cannot overwrite a newer ceremony's snapshot. The runtime ceremony tracker retains the first terminal result (committed, cancelled, rejected or timed out) and rejects a conflicting later result. The app-owned completion hook survives UI remount, browser rebootstrap and runtime restart; frontends only observe it. The invitee acceptance path keeps its supplied handoff instance and typed cause instead of minting a fresh error owner.
Guardian acceptance has its own follow-up owner with a distinct operation kind. Local acceptance only starts the guardian choreography. Success requires the principal's verified binding acknowledgment, and a runtime failure settles the same instance with a typed ceremony failure. Moderation commands settle with exhaustive, stable failure codes; list or count changes are diagnostics only.
Terminality alone is not strong enough. Aura also requires owner-internal liveness: a legal owner may not contain unbounded internal work that can keep an operation in OperationState::Submitting forever. If the owner can hang indefinitely while still technically being the "right" owner, the architecture is incomplete.
Timeout-triggered returns do not relax this rule. A timeout may fail an
operation, but it may not silently convert an ambiguous owner-internal state
into nominal success. Typed NoProgress or Degraded outcomes are preferable
to unit success when runtime-owned work can observe those distinctions.
Semantic Owner Protocol
Parity-critical semantic operations must follow one protocol from submission to terminal publication.
- A frontend or harness may create a local submission record.
- If app/runtime workflow ownership is required, the frontend/harness must hand ownership off immediately before the first awaited workflow step.
- After handoff, only the canonical owner may publish non-local lifecycle.
- The canonical owner must publish a terminal state before any best-effort repair, warm-up, or post-success reconciliation that is allowed to fail.
- Best-effort follow-up work must never be required for the operation to stop
being
OperationState::Submitting.
This forbids the bug shape where:
- the callback is the "temporary" owner
- the app workflow is the "real" owner
- both are structurally legal
- but the callback keeps local
OperationState::Submittingstate alive while the workflow has already reached terminal publication or is blocked in best-effort work
The handoff boundary must therefore be before awaited workflow execution, not after it.
Macro declaration rule:
#[aura_macros::semantic_owner(owner = "...", terminal = "...", category = "move_owned")]is the sanctioned declaration surface for move-owned semantic workflow boundaries- semantic owners must also declare:
postcondition = "..."for the authoritative state guaranteed by successdepends_on = "a,b,..."for prerequisite readiness edgeschild_ops = "a,b,..."for sanctioned semantically required child workproof = Typewhenever success is only valid if a typed postcondition witness has been established
#[aura_macros::capability_boundary(category = "capability_gated", capability = "...")]is the sanctioned declaration surface for capability-bearing mint/publication helpers#[aura_macros::actor_owned(owner = "...", domain = "...", gate = "...", command = Type, capacity = N, category = "actor_owned")]is the sanctioned declaration surface for long-lived actor-owned async domains#[aura_macros::ownership_lifecycle(initial = "...", ordered = "...", terminals = "...")]is the sanctioned declaration surface for small parity-critical lifecycle enums#[aura_macros::authoritative_source(kind = "...")]is the sanctioned declaration surface for helpers that mint or read authoritative semantic truth. Valid kinds areruntime,signal,app_core, andproof_issuer.#[aura_macros::strong_reference(domain = "...")]is the sanctioned declaration surface for canonical strong-reference carriers. Valid domains arechannel,invitation,ceremony,home, andhome_scope.#[aura_macros::weak_identifier(domain = "...")]is the sanctioned declaration surface for weak identifier carriers that must not be upgraded into strong bindings without an explicit owner path
Reactive Contract
Parity-critical reactive consumers must rely on one explicit subscription contract.
- subscription to an unregistered signal is a typed failure, not an empty or inert stream
- there is no implicit registration wait for parity-critical consumers
- if a subscriber lags behind the broadcast buffer, the handler logs the lag and resumes from a newer snapshot
- parity-critical owners may not infer replay or lossless history from the reactive layer unless an explicit replay contract exists
- hook ownership is explicit across installation: an
Installinggroup cannot be reported ready, aReadygroup owns one attached stream and acknowledged listener per required signal, andStoppedcancels those streams on detach or failed installation - a mounted frontend owns one supervised observer group per runtime generation and one receiver per distinct required signal; its health records attachment, closure, and recovery failures as typed states
- listener tasks may retain an owned task spawner but must not retain the group lifetime owner; unmount or generation replacement cancels all listeners before another group becomes ready
- receiver attachment precedes the current-state read; after reattachment or lag, the observer derives state from a fresh current snapshot rather than assuming intermediate updates were replayed
This means reactive delivery is a transport for authoritative snapshots, not an alternate owner of semantic truth. Owner code must tolerate "newer snapshot after lag" semantics without silently treating a missed update as "no change."
Enforcement rule:
- ownership declarations, strong-reference markers, and authoritative-source markers should be enforced first by proc-macro validation, Rust-native lints, and compile-fail tests
- shell scripts should remain only for integration checks or governance rules that are not realistically provable in types or Rust-native syntax analysis
Reactive/view consumers also may not fabricate canonical entities from partial
facts. For example, a membership fact may update membership for a known channel,
but it may not create a channel with channel_id.to_string() as a fallback
name. Canonical entity materialization must come from one owned path that
already carries the authoritative metadata.
The materialization owner exposes a distinct opaque creation witness for each
entity family. It mints that witness only from a validated creation fact or an
authenticated completion outcome with the same required metadata. A
projection's insertion boundary requires the corresponding witness;
enrichment boundaries require an already-materialized entity and cannot mint
one. Witness constructors remain private to the materialization owner.
Out-of-order enrichment is retained for later application only when its entity
identity and context match the eventual creation evidence. Compile-fail/API
tests guard the constructor boundary, and permutation/replay tests guard the
order-independent behavior.
The app-private HomeCreationWitness constructor accepts only HomeCreated
shape through ProjectionOwner::home_created_witness. The projection owner
controls that conversion, while journal commitment remains the responsibility
of the runtime ingestion path. A plain public fact value does not itself prove
commitment.
Owner Body Rules
Once a function is designated as a semantic owner, its body is constrained more strictly than ordinary async code.
Allowed:
- bounded awaits through approved timeout-budget helpers
- retries through approved retry-policy helpers
- publication through capability-gated lifecycle/readiness helpers
- explicit handoff to another sanctioned owner
Forbidden:
- raw open-ended
.awaiton runtime/effect calls - awaiting best-effort network or transport side effects before terminal publication
- retaining a frontend-local owner while awaiting an app-owned workflow
- detached work that still owns terminal responsibility
- direct spawn from a semantic owner except through an explicitly declared child-operation surface
- silently discarding parity-critical results or errors
- ad hoc local retries, sleeps, or polling loops
If a semantic owner needs long-lived convergence, that convergence must be owned by a dedicated ActorOwned coordinator and expressed as typed readiness or typed terminal lifecycle, not as an unbounded await hidden inside a helper.
Typed Success Proofs
Declared postconditions are not documentation-only. For parity-critical operation families, Succeeded should be tied to an opaque typed proof surface whenever the authoritative postcondition is stronger than "the function returned successfully".
The required pattern is:
- capability-gated code performs the authoritative mutation, readiness check, or materialization step
- that sanctioned helper mints an opaque proof witness for the declared postcondition, such as a channel-membership-ready proof
- the semantic owner publishes terminal success by consuming that proof through the canonical success path
This is intentionally different from a capability token:
- a capability answers who is allowed to act
- a proof answers what has become true
Proofs must therefore be minted by capability-gated code, but the proof itself must not be the authority token.
The canonical direction is:
#[aura_macros::semantic_owner(..., postcondition = "...", proof = Type)]- owner success goes through
publish_success_with(proof)or the equivalent canonical proof-bearing success helper - plain
publish_phase(Succeeded)is forbidden for proof-bound owners
Proof constructors stay private. External code must not be able to forge a proof witness, and the compile-fail suites should prove that boundary.
Best-Effort Separation
Aura distinguishes terminally required work from best-effort work.
Terminally required work:
- determines whether the operation is
Succeeded,Failed, orCancelled - may block terminal publication only through bounded waits owned by the canonical semantic owner
Best-effort work:
- may improve projection quality, connectivity, warming, discovery, or local convenience
- must run only after terminal publication, or under a different owner with its own explicit lifecycle
- must not prevent the submitted operation from leaving
OperationState::Submitting - must not directly publish parity-critical lifecycle or readiness
- must not directly perform parity-critical mutation such as committing facts, materializing authoritative state, registering required ownership, or other work that a later parity-critical operation depends on
- must not use the
best_effort_*naming surface unless they actually obey the best-effort contract above. Aura treats that prefix as a reserved ownership boundary and lints it accordingly even when the helper forgot to add an explicit#[best_effort_boundary].
If a step mutates authoritative state required by a later semantic operation, it is not best-effort. It belongs either:
- inside the canonical semantic owner before
Succeeded, or - inside a distinct owned child operation with its own explicit lifecycle and dependency edge
This rule is stronger than "use timeouts". A bounded best-effort step is still architecturally wrong if it owns the primary operation's terminal state.
Correct-By-Construction Requirements
For parity-critical operation families, "correct by construction" means:
- submission uses one canonical typed owner wrapper
- owner handoff uses one canonical consumed transfer API
- terminal publication uses one capability-gated API family
- success implies one declared authoritative postcondition
- proof-bound success consumes one opaque typed proof minted by sanctioned capability-gated code
- bounded awaits use one approved timeout-budget helper family
- retries use one approved retry-policy helper family
- best-effort work uses one explicit helper family that cannot publish or delay primary terminal state
- semantic owners do not spawn except through declared child-operation APIs
- parity-critical results are not ignored or downgraded to logging-only paths
- an issued code and the ceremony it starts have distinct terminal owners and operation instances linked by ceremony ID; code issuance cannot publish completion success
- a ceremony owner accepts one typed terminal outcome and preserves the first result under duplicate, late, or replayed responses
- frontend operation snapshots retain the authoritative failure domain/code and cancellation state; local wizard progress does not publish ceremony success
- a frontend may return an import submission handle before it knows an invitation's type, but it hands the generic import owner to the app before the first awaited verification/cache step. Only a verified import result allocates the separate typed contact, guardian, or channel accept owner
Replay Protection
Sequences, nonces, generations, and message identities are minted by their owner and consumed once. Replay and reuse are rejected by type or by a verified nullifier, never only by a caller convention. Two layers apply.
Type layer (within one process). These primitives live in
aura-core::ownership::sequence:
SequenceOwner<D>isActorOwnedand notClone. It is the only source ofAdmission<D>for its domainD.Admission<D>isMoveOwned: notCloneorCopy, private fields,#[must_use]. It names exactly the next sequence, and admitting a frame consumes it. Delivered frames are notClone, so delivery consumes them too. Re-injecting or forging an admission does not compile.DurableSequenceOwner<D>reserves and persists itsSequenceStorecounter under its own lock before handing out an admission. Concurrent callers never share a value, and a restart never reissues one. The owner serves one store identity; AMP send generations use one owner per sender cursor.NonceOwner<K>builds every AEAD nonce for keyKitself. Raw-nonce AEAD entry points are private to the effect implementation.FrostNoncesis notCloneor serializable, and it is zeroized on drop. OnlyFrostNonces::retireproduces theRetiredFrostNoncesthat signing accepts, and it does so after writing a retirement record to aFrostNonceRetirementlog that refuses duplicates. Signing consumes that value. The log must be at least as durable as the secret: nonces that never leave process memory use the in-process log, because a restart destroys them. A signing nonce cannot be cloned, cached in a copy, or used twice.CommitKeyis the owner-minted idempotency key for a journal fact commit.
Public APIs do not accept raw u64, [u8; 12], or byte-slice sequence,
nonce, generation, or message-id parameters outside this module. Non-test
code has no process-global id counters.
Protocol layer (across peers, sessions, and restarts). Choreography
sessions run Telltale in CommunicationReplayMode::Nullifier, so a duplicate
message terminates with a typed DuplicateIdentity. Cross-session protocol
messages, ceremony and consensus shares, DKG packages, terminal notices, and
commits are Telltale heap resources accepted through nullifier consumption.
The nullifier set's root is part of the verified HeapCommitment.
- A nullifier is derived from the authenticated message identity: sender, session, label, and content hash. It excludes allocation counters, so a re-sent message maps to the same nullifier.
- Nullifier hashing uses a cryptographic
VerificationModel. - Nullifier history is never removed by resource removal. It is pruned only by folding a retired epoch into the committed root.
- A consumed nullifier is persisted atomically with the effect it protects.
The
HeapCommitmentroot is published as a fact at ceremony and epoch boundaries, so peers and restarted devices verify against the root rather than sync the whole set.
Replay tolerance that a protocol requires, such as idempotent re-delivery or first-result-wins terminal outcomes, is expressed through these mechanisms, not by minting fresh identities to avoid duplicate detection.
Enforcement Ratchet
Aura treats ownership enforcement as a ratchet, not a static checklist.
The desired order of strength is:
- private constructors and opaque types
- capability-gated APIs
- canonical owner wrappers/macros
- AST-backed lints
- compile-fail tests
- invariant and concurrency tests
- thin CI shell wrappers that call those stronger checks
Shell scripts remain useful as workflow glue, but they are the weakest layer. If a policy matters for parity-critical correctness, the long-term goal is to encode it in types, macros, or AST-backed analysis rather than rely on grep.
Required Invariants For Parity-Critical Operations
Every parity-critical operation family should have invariant tests for all of the following:
- owner drop forces
FailedorCancelled - terminal state cannot regress
- stale owner or stale handle cannot advance state
- canonical owner publishes terminal state within a bounded budget
Succeededimplies the semantic owner's declared postcondition holds- proof-bound
Succeededconsumes the correct typed witness for that declared postcondition - best-effort failure cannot block terminal publication
- no later parity-critical operation can depend on hidden best-effort work to make a successful operation "actually true"
- frontend-local submission state cannot mask authoritative terminal state after handoff
- older authoritative instances cannot overwrite newer local submissions
Frontend Handoff Rule
Layer 7 frontends are primarily Observed, but they are allowed to own a very small local submission window. That window is subject to a strict rule:
- if the frontend owns terminal publication, it must settle locally
- if the app/runtime owns terminal publication, the frontend must relinquish local ownership before awaiting the app/runtime workflow
There is no supported middle state where the frontend keeps a local submitting record "just in case" while the canonical workflow runs elsewhere.
Time And Ownership
Timeouts and backoffs are part of ownership, not incidental implementation detail.
For every parity-critical async path, the architecture must identify:
- who owns the deadline
- who owns retry policy
- whether the wait is terminally required or best-effort
- what happens when the budget is exhausted
Wall-clock time remains a local choice in Aura's time model, but timeout policy ownership is not a local choice. A path that can wait forever without a declared owner and terminal consequence is an ownership violation.
Layer Guidance
Layer 1 (aura-core) defines the shared ownership vocabulary: primitives, typed lifecycle helpers, and capability boundaries.
Layer 2 (domain crates) defaults to Pure. Use MoveOwned only when transfer semantics are part of the domain itself. Domain crates should not silently grow runtime-style async ownership.
Layer 3 (implementation crates) defaults to stateless handlers. Avoid long-lived mutable ownership except for narrow adapter internals.
Layer 4 (orchestration) uses MoveOwned for delegation, session ownership, and handoff. Use ActorOwned for long-lived orchestration coordinators only.
Layer 5 (feature crates) should have single-owner semantic lifecycle. Wrappers, views, and shells must not co-author stronger semantics than canonical workflows.
Layer 6 (runtime) is the primary ActorOwned layer. Runtime services, caches, maintenance loops, and supervisors should be actor-owned. Ownership transfer still uses MoveOwned surfaces.
Layer 7 (interface) is primarily Observed. Frontends may provide command ingress mechanics but do not own parity-critical semantic truth.
Layer 8 (testing) may simulate actors and capabilities. Parity-critical lanes must observe and submit through the same ownership boundaries as production code.
Workspace Ownership Inventory
This inventory covers every Rust crate under crates/. It is the workspace-level baseline. Detailed per-module inventories belong in crate ARCHITECTURE.md files.
Layer Summary
- Layer 1 (
aura-core) is primarilyPureand defines the canonicalActorOwned,MoveOwned, and capability-gated vocabulary. It does not own long-lived mutable runtime state. - Layer 2 crates stay primarily
Pure. They may exposeMoveOwnedrecords when transfer semantics are part of the domain model, but they do not grow runtime-style actor ownership. - Layer 3 crates stay
Pureand infrastructural. They implement handlers and composition without becoming semantic owners of parity-critical lifecycle. - Layer 4 crates commonly mix
ActorOwnedcoordinators andMoveOwnedtransport/protocol surfaces. Coordination publication and ingress remain capability-gated. - Layer 5 crates mix
Pure,MoveOwned, and narrowActorOwnedprotocol coordinators. Ceremony, invitation, recovery, sync, and rendezvous flows use typed handles, typed terminal states, and coordinator-owned publication. - Layer 6 splits strictly:
aura-agentis the productionActorOwnedruntime and the only sanctioned production structured-concurrency pathaura-appis primarilyPureplusMoveOwnedand owns authoritative semantic lifecycle/readiness publication for shared semantic flowsaura-simulatorisActorOwnedfor simulation coordination andObservedfor test-facing exports
- Layer 7 crates are strict consumers:
aura-terminalandaura-webareObservedwith narrow ingress/bridge ownership onlyaura-uiisObserved- frontend-local parity-critical lifecycle ownership is not allowed outside the sanctioned local-terminal/handoff boundary
- Layer 8 crates are primarily
Observed. Test-only actor helpers are allowed where they mirror production owner boundaries rather than inventing a separate semantic model.
Each crate ARCHITECTURE.md must classify its parity-critical modules, identify actor-owned domains, name consumed move-owned surfaces, and list the capability-gated mutation/publication points it exposes.
Enforcement
The ownership model is enforced in layers.
Types and private constructors provide the first line of defense. Capability-gated mutation and publication APIs form the second layer. Canonical owner wrappers and macros provide the third layer. AST-backed checks, compile-fail tests, invariant tests, and then thin scripts/check/*.sh / just ci-* wrappers complete CI enforcement.
Enforcement split:
- Types, private constructors, sealed traits, and consumed ownership wrappers are the primary defense.
- Ownership and lifecycle declaration macros in
aura-macrosforce explicit boundary classification. trybuildcompile-fail suites inaura-coreandaura-appprove that forbidden ownership/publication patterns do not compile.- Parity-critical APIs must require the strongest available typed input.
Once authoritative context exists, raw-id helper calls,
resolve_*re-resolution, and*_or_fallbackrepair paths are ownership violations. - Rust-native lint binaries in
aura-macrosprovide syntax-level fences for:- proof-bound semantic owners using plain
Succeededpublication instead of proof-bearing success - semantic owners publishing success and then launching detached continuation
- semantic owners spawning outside explicit child-operation ownership
- silent discard of parity-critical results and errors
- best-effort boundaries performing direct parity-critical mutation or publication
- helpers named
best_effort_*being treated as real best-effort boundaries rather than advisory comments - raw spawn / raw task-handle escape hatches
- frontend semantic handoff bypasses
- authoritative-ref downgrade via raw-id re-resolution inside authoritative-only workflow slices
- raw timeout/time-domain usage in protected modules
- proof-bound semantic owners using plain
- Thin shell wrappers under
scripts/check/remain only as CI glue or where the invariant is inherently integration-level rather than compile-time. - Governance-only checks stay clearly separate from code-correctness
enforcement:
just ci-ownership-categoriesjust ci-harness-actor-vs-move-ownership- Aura
toolkit/xtaskuser-flow guidance sync check
- Runtime/integration checks remain appropriate for properties such as runtime shutdown ordering and instrumentation schema discipline because those are orchestration-level invariants, not just API-shape rules.
Primary enforcement belongs in typed ownership primitives and proc-macro declarations. For the frontend/harness stack this means:
HarnessUiOperationHandleandUiOperationHandleare constructor/accessor surfaces, not public-field records- readiness refresh helpers stay private to
aura-app::workflows - the local-terminal and workflow-handoff owner wrappers are the sanctioned frontend submission windows
UiTaskOwnerandWebTaskOwnerare the only sanctioned frontend task-ownership surfaces
Shell checks such as semantic-owner bounded-await and frontend/harness boundary wrappers are secondary fences for narrow escape hatches, not the source of truth for semantic correctness.
Phase-6 rollup rule:
- extend typed ownership primitives or proc-macro declarations first
- add or update compile-fail coverage for the newly-closed misuse shape
- place syntax-owned enforcement in
aura-macroslint binaries and run it throughjust lint-arch-syntaxorjust ci-ownership-policy - keep shell backstops only for integration-governance checks that cannot be proved in types or Rust-native syntax analysis
- delete the legacy helper, compatibility wrapper, migration shim, or stale test that the stronger contract replaced in the same milestone
Do not keep dormant fallback modules, compatibility constructors, or "temporary" legacy upgrade paths after the strong contract exists. If a rule can be enforced by types, macros, compile-fail suites, or Rust-native lints, that enforcement is primary and the shell layer stays thin.
For proof-bearing postconditions specifically, the desired enforcement order is:
- private proof constructors
- capability-gated proof minting helpers
#[semantic_owner(..., proof = Type)]- compile-fail tests proving proofs cannot be forged or minted from the wrong module
- AST-backed linting that rejects plain
Succeededpublication in proof-bound owners - invariant tests proving the proof-minting helper is semantically honest
Scripts alone are not sufficient. The API must make the wrong pattern hard or impossible first.
Service-Family Enforcement Map
For new Establish, Move, or Hold surfaces, keep the enforcement split
explicit:
- type-enforced:
- runtime-local policy stays inside runtime-owned services
- strongest typed reference continues after authoritative context exists
- capability-gated mutation/publication boundaries
- proc-macro declaration-enforced:
#[service_surface(...)]#[actor_owned(...)],#[semantic_owner(...)], or the narrower ownership declaration that matches the boundary
- compile-fail-enforced:
- service-surface misuse and private-constructor misuse in
trybuildsuites - stale-owner / wrong-capability / wrong-layer misuse when the API shape can reject it
- service-surface misuse and private-constructor misuse in
- lint-enforced:
aura-macrosownership and architecture lint binaries run throughjust ci-ownership-policyandjust lint-arch-syntax
- script-enforced:
- thin repo-wide integration/governance gates such as
just ci-service-surface-policy,just ci-service-registry-ownership,just ci-harness-ownership-policy, andjust ci-adaptive-privacy-tuning
- thin repo-wide integration/governance gates such as
The default contributor path for service-family boundary work is:
just lint-arch-syntaxjust ci-ownership-policyjust check-archjust ci-adaptive-privacy-tuningwhen the change affects adaptive privacy policy, simulator evidence, or control-plane parity artifacts
Same-Change Checklist
Any new service-family composition or service-surface type must include, in the same change:
- the declaration macros for the boundary and owner category
- typed/runtime-local state placement that keeps shared truth separate from local policy
- compile-fail or invariant coverage for the strongest misuse shape the API can reject
- lint or script wiring for the remaining syntax/integration boundary
- doc updates in the affected crate
ARCHITECTURE.mdand any authoritative guide that owns the contract - removal of the superseded helper, adapter, allowlist, compatibility branch, or migration note
If item 6 cannot be completed immediately, record the owner and explicit removal condition in the active migration inventory rather than leaving a silent compatibility path behind.
Review Checklist
When adding or modifying a parity-critical path, ask these questions:
- What category is this module or subsystem?
- Who is the single live owner of mutable async state?
- How is authority transferred?
- What capability authorizes mutation or publication?
- What is the typed terminal success/failure contract?
- What authoritative postcondition does
Succeededactually guarantee? - Does success require a typed proof witness, and where is that proof minted?
- Where does local submission ownership end and canonical workflow ownership begin?
- Once authoritative context exists, which strong typed reference carries it through the rest of the flow?
- Could any later helper silently downgrade from that strong reference back to raw-id lookup, fallback, or re-resolution?
- Which awaits are terminally required, and which are best-effort only?
- Is any later parity-critical step relying on hidden best-effort follow-up?
- What bounded budget owns each required wait and retry? If these answers are unclear, the design is not complete enough.
Window ownership
The common window primitive is Pure: sealed physical-millisecond and receipt-generation domains provide checked bounds and half-open membership. Admission, progression, cryptographic provenance and durable acknowledgment belong to their domain owners. Arithmetic serialization cannot mint an admission capability.
A fixed physical execution window is MoveOwned at admission and shares one observation/exhaustion owner across clones and children. Its enclosing runtime is ActorOwned. An observed ceremony snapshot cannot mint that execution capability or replace its interval. The registered owner admits execution directly from its authoritative registry and retains the sealed allocation capability through subsequent checkpoints.
Initial allocation and live admission are distinct lifecycle phases. Only an internally minted pre-live capability can retain a missing initial checkpoint from the exact original secure allocation, before canonical registration or immutable live-boundary evidence exists. The live boundary is retained before execution can observe the registry entry. After that boundary, missing observation history fails closed. A required checkpoint holds allocation continuity through its write, retains monotone durable history and preserves sticky failures; cancellation or storage failure prevents the required continuation/publication. A terminal outcome for the same allocation does not invalidate historical acknowledgment or renew execution.
Supervised execution identity comes from successful bounded registry admission, not from a caller identifier or an executor thread. Each registered future poll and destructor has its original owned identity; nested scopes restore their caller and cancellation cannot leave an ambient owner installed. Identity is stable across suspension and executor migration and distinguishes sibling groups with identical local task counters. Native and browser choreography session bindings use that identity for supervised tasks. Identity observation grants no ability to admit a task or enter an execution scope, and identity carries no cryptographic peer, membership or signing authority.
Enrollment notification ownership
An enrollment terminal-notice listener is a registered sibling in the existing invitation service task tree. The original admitted window and physical-device witness bind its admission; a cloned window shares observations, lease and checkpoint and grants no new duration. The listener owns its actual VM session slot across bounded selection. Explicit shutdown closes that slot before normal completion; forced drop retires exact owner generation and scope without claiming asynchronous close or signed terminal evidence. Required native causes remain in the owning task tree's health and terminal failure observation.
Cancellation observation custody
The authoritative tracker mints cancellation preparation custody from its actual registered allocation and independently retained issuer control. Observed state, raw IDs and caller-selected timestamps cannot construct it. Preparation shares the original high-water and expiration owners and requires the original durable checkpoint to acknowledge observations. This custody authorizes bounded cancellation preparation, not VM admission, and does not acquire the execution semaphore a second time.
A separately bounded ingress owner has no enrollment admission authority. Historical negative publication retains its genuine prior terminal capability; it cannot exchange that proof for a new active execution window. Required preparation, checkpoint or publication failure preserves native causes and does not report a successful completed handoff.
Targeted VM disposal custody
Runtime session owner capabilities have private construction and read-only metadata. Authorization requires the actual issued claim identity in addition to matching session, generation, label and scope. Matching observations from a different runtime grant no ingress, transfer or retirement authority. A handoff invalidates every retained copy of the previous claim.
Required VM retirement disposes only the owned target session, including live or blocked coroutines, scheduling eligibility, handoffs and scoped communication and resource state. Unrelated sessions remain usable. Host metadata removal follows the actual backend acknowledgment. The cooperative backend retains stable coroutine IDs through its existing index rebuild; the threaded backend validates and rebuilds its explicit ID index after removal.
Threaded worker execution is joined by the engine's synchronous worker scope before exclusive disposal begins. Acknowledgment means no target job remains; it does not require destroying the shared pool or other sessions. Naturally terminal session status and epoch are preserved, and repeated disposal returns its original compact acknowledgment. New close epoch advancement is checked only for a genuinely active target.
Concrete backend failure remains in the standard native source chain. Required closure cannot succeed by parsing or suppressing an unsupported error, merely removing host metadata, or disposing an entire engine containing other sessions. Historical compact summaries and diagnostic traces follow the dependency's explicit archive policy. Shared global guard state is not claimed as exclusively owned by the target session. VM disposal is local cleanup and does not establish remote delivery, a signed terminal decision or protocol completion.
Exact capability declaration evidence
A capability boundary declares its exact capability type in a parsed input or output. Semantic labels may specify capability_type = Type; labels and body text do not establish custody. Accessors return that exact type, authorizers retain that typed input or output, and proof issuers also declare their authoritative proof source. Runtime helpers with an actual held receiver may specify receiver_type = OwnerType; expansion checks the concrete receiver against that type. This receiver contract does not apply to free functions or replace authorization inputs in authorizers.
Constants, capability-like substrings, incidental body calls, phantom markers and associated projections do not satisfy the declaration. The declaration verifies API shape; private constructors and actual runtime ownership validation establish authority. Pure validators, pure execution-plan builders and observed projections are not capability issuers and carry no decorative capability-boundary declarations. Their domain tests and effect-placement rules remain required.
Configured capability types preserve their complete parsed path and generic
arguments. A boundary for Owner<Capability> cannot be satisfied by
Owner<Other> or an unparameterized owner with the same name.
A nominal capability declaration may omit borrow lifetime arguments from its
label. This permits an actual Reservation<'a> without erasing type or const
parameters; configured type and const arguments still require exact matches.
Canonical AgentResult<T> carries capability evidence only through its success
value T, using the same rule as Result<T, E>. An error type does not provide
custody. Actual production compilation and negative validator coverage enforce
this supported result-alias contract.
Qualified container names do not confer capability evidence by their final identifier alone. A foreign wrapper named Result, Arc or AgentResult cannot authorize a boundary by carrying an unrelated declaration parameter. Canonical container paths preserve declared value evidence; actual capability custody still requires opaque owner APIs and compiler-enforced ownership.
Contact confirmation continuation
Required imported Contact metadata is read under a lease belonging to the actual runtime. The retained acceptance capability transfers into a move-only signed continuation only after the acceptance digest is acknowledged. Its confirmation child shares the original operation's fixed deadline and physical observation owner; retries cannot create a replacement interval.
A verified response retains the complete required import and runtime decision lease through canonical contact publication and imported-status persistence. Materialization consumes this evidence directly. Observed caches and descriptor enrichment cannot select authoritative invitation state or delay the required terminal publication on an unrelated reactive batch. App readiness remains an independent authoritative observation contract.
In-process continuation does not establish restart authority. Durable restoration requires the original parent and child checkpoints, signed payload and selected profile binding; a retained digest alone cannot authorize a new wait.
Original local deadline observation
A fixed physical endpoint bounds resource waiting under one original owner; it is not shared temporal provenance or distributed completion evidence. The owner retains its selected clock, observation lease and required checkpoint through terminal acknowledgment. The endpoint has priority over late checkpoint completion, and losing read/checkpoint/timer futures release their custody. Successful publication is synchronous under the original observation guard and requires independently established domain completion. Unsupported or failed clock providers cannot substitute a second clock or renew the original window.
Checkpoint evidence and native participant completion
A domain operation result, persistence receipt, first failure and final selected-provider validation are independent evidence. Final checkpoint success cannot erase a native domain failure, and a preoperation receipt cannot establish postoperation durability. Any completed result and actual checkpoint disposition remain with the original consuming domain root after negative or unresolved execution; such outcomes create no cleanup capability.
The approved-signing root consumes actual original participant completion and sealed descendant disposal before acknowledging Closed. The move-owned lease of the original tree handler provides exclusion but no authenticated provenance. Required-task disposal observers retain one accepted custody slot and remain Observed, even when repeated. Actual settled disposition, including resolved negative domain failure, is retained in that same slot before its resource acknowledgment becomes visible. Failed or interrupted cleanup cannot publish a settled disposition. Their outcome cannot authorize another execution or substitute for domain completion. Reconciliation custody remains with the original accepted control when an attempt is cancelled or fails. A retry may settle that original resource obligation under its existing authorized window; it cannot allocate a replacement task, provider or deadline. Resource disposal and domain terminal evidence remain distinct. Finite conditional negative consent remains bound to the original reviewed intent and actual protected first decision; it cannot authorize unrelated signatures or reconstruct participant material.
Network Anonymity
This document defines Aura's network privacy and network anonymity model. It specifies the route-layer cryptographic objects, bootstrap re-entry records, hop processing rules, and reply-block semantics used by adaptive privacy routing.
This document complements Transport and Information Flow, Rendezvous Architecture, Relational Contexts, and Social Architecture. Those documents define adjacent-peer transport, context-scoped discovery, relational trust facts, and social provisioning. This document defines the anonymous path layer that sits above those surfaces.
1. Scope
Aura provides two distinct network protection layers:
Link encryptionprotects one adjacent transport hop.Path encryptionprotects the anonymous multi-hop route object carried across several adjacent hops.
Link encryption and path encryption solve different problems. Link encryption hides packet contents from the local network and from passive observers on one transport edge. Path encryption hides deeper route structure and reply-path structure from intermediate forwarding hops.
This document does not define application payload encryption. Application and context semantics remain protected by the existing Aura context and channel model.
2. Direct-Channel Baseline
Aura already uses adjacent-peer secure channels for direct transport. The current baseline is the Noise IKpsk2 25519 ChaChaPoly BLAKE2s pattern through NoiseEffects with the snow implementation.
The direct-channel baseline remains authoritative for adjacent-peer secure channels. Anonymous path routing does not replace that layer. Each adjacent hop on an anonymous route still runs over the existing link-protected channel model from Transport and Information Flow.
3. Network Privacy Goals
Aura's route layer has the following goals:
- prevent an intermediate hop from reading deeper route state
- prevent an intermediate hop from deriving the final destination from its local peel result alone
- allow bounded stale-node re-entry without a singleton bootstrap service
- keep bootstrap hints signed, expiring, replay-bounded, and scope-limited
- keep reply paths typed and accountability-aware
Aura's route layer has the following non-goals:
- defeat a global passive observer
- create a globally enumerable neighborhood graph
- create a canonical shared Web-of-Trust topology map
4. Route-Layer Construction
Aura adopts a route-layer construction based on Curve25519, Aura's centralized KDF, and ChaCha20-Poly1305.
The route-layer construction uses the following rules:
- Each anonymous path setup flow creates a fresh route identifier and fresh ephemeral route secret material.
- Each hop derives a forward hop key stream and a backward hop key stream from the route secret material through Aura's centralized KDF.
- Each hop encrypts or decrypts only its own layer with
ChaCha20-Poly1305. - Each hop receives enough authenticated metadata to identify the next processing action, but not enough to reconstruct deeper route state.
Aura uses SURB-like reply blocks as Aura-native typed objects with explicit expiry, scope, and accountability semantics.
4.1 Deployment Model
The service family model is always active. Establish, Move, and Hold are the normal service vocabulary for path creation, opaque movement, and custody.
LocalRoutingProfile::passthrough() is the pre-privacy routing baseline. It uses mixing depth 0, delay 0, cover rate 0, and path diversity 1. Hold remains active under passthrough because it is an availability service, not a routing-profile knob.
Production privacy uses encrypted path setup and encrypted MoveEnvelope processing with one fixed adaptive policy. Users do not tune this policy. Development and simulation may sweep policy constants, but production nodes use the evidence-backed constants shipped with the build.
The current fixed policy uses path-diversity floor 2, cover floor 2 packets per second, delay gain denominator 3, neighborhood hold retention window 120s, and retrieval-capability rotation beginning 10s before expiry.
5. Link Encryption Versus Path Encryption
Link encryption uses the adjacent-peer secure channel. It protects one hop and one transport edge.
Path encryption uses the route-layer construction from section 4. It protects the route object carried inside the link-protected channel. Intermediate hops remove one route layer and learn only the immediate forwarding decision and the local accountability material for that hop.
The two layers must remain distinct:
- path-layer keys must not be reused as adjacent-peer channel keys
- adjacent-peer channel state must not be treated as route-hop state
- application or context semantic keys must not be treated as route-layer keys
6. Route-Layer Objects
The route layer uses the following typed objects:
BootstrapContactHintNeighborhoodReentryHint- bounded bootstrap introduction records
EstablishedPathMoveEnvelope- typed reply blocks
BootstrapContactHint records a remembered direct contact or prior provider that may help stale-node re-entry. It carries a scope, expiry, freshness data, and signed contact material. It does not represent canonical route truth.
NeighborhoodReentryHint records a board-published re-entry surface. It carries a neighborhood-scoped publication, expiry, replay bound, and signed route-surface material. It does not expose a globally enumerable topology map.
Bounded bootstrap introductions carry explicit introducer identity, introduced authority, scope, expiry, maximum remaining depth, and fan-out limits. They are trust and bootstrap evidence. They are not canonical shared route tiers.
EstablishedPath is the reusable route object consumed by Move. MoveEnvelope is the shared movement envelope family. Encrypted peel processing is the production route-layer behavior and preserves the accountable movement boundary.
7. Bootstrap and Re-Entry Surfaces
Aura supports stale-node re-entry through several overlapping bootstrap surfaces:
- remembered direct contacts and prior providers
- neighborhood discovery boards
- bounded Web-of-Trust bootstrap introductions
- rotating bootstrap relays or bridge providers
These surfaces are ordered inputs, not canonical shared route truth. Runtime selection may widen from one surface to the next when prior attempts fail or when freshness decays.
Aura explicitly rejects the following bootstrap designs:
- a singleton bootstrap authority
- a globally enumerable neighborhood adjacency map
- a canonical shared friends-of-friends graph
8. Neighborhood Discovery Boards
Neighborhood discovery boards publish signed, expiring, scope-limited re-entry hints. A board publication must include:
- the publishing authority
- the scoped neighborhood or re-entry domain
- an expiry time
- a replay-bounded publication identifier
- the advertised route-layer or move-surface public material
Board contents are advisory. Runtime caches may merge them. Runtime caches must not elevate them into canonical route truth. Runtime caches must not expose a stable global graph projection derived from board contents.
9. Bounded Bootstrap Introductions
Bootstrap introductions are Web-of-Trust evidence used for stale-node re-entry. Each introduction must include:
- introducer authority
- introduced authority
- scope
- expiry
- maximum remaining depth
- maximum fan-out
Introductions are valid only within their declared bounds. Runtime policy may consume them as discovery and permit input. Runtime policy must not publish a canonical shared introduction tier or transitive trust graph.
10. Hop Processing Rules
Every forwarding hop performs the following route-layer steps:
- authenticate and decrypt the local hop layer
- verify route identifier, hop position, expiry, and replay bound
- derive the local forward or backward hop key stream
- recover the next forwarding instruction or reply instruction
- emit local accountability state and continue on the adjacent secure channel
A hop may learn:
- that it is on the route
- the previous hop on the adjacent edge
- the next hop on the adjacent edge
- local replay and expiry state
A hop may not learn:
- the full route
- deeper hop keys
- the final destination unless it is the exit hop
- the full reply path unless it is processing its own reply layer
11. Typed Reply Blocks
Aura uses typed reply blocks for backward anonymous delivery. A reply block is an Aura-native object with:
- scope
- route binding
- expiry
- replay bound
- backward hop material
- accountability linkage
Reply blocks are not borrowed Tor SURB packets. They are typed Aura objects that integrate with Aura movement, accountability, and retrieval-capability rotation rules.
Reply blocks must remain distinct from:
- application message payloads
- adjacent-peer secure channel state
- bootstrap trust records
11.1 Movement Scheduling
The runtime schedules protected movement through shared classes rather than separate transport families. Sync-blended traffic may wait for anti-entropy windows. Bounded-deadline replies carry accountability or control traffic with shorter deadlines. Synthetic cover fills the remaining cover floor.
Application traffic and sync-blended retrieval reduce the synthetic-cover gap. Accountability replies are measured separately in the current deployment model. They do not reduce the first-deployment synthetic cover floor.
12. Per-Boundary Leakage
Aura tracks privacy leakage by boundary. The route-layer design assumes leakage cannot be eliminated completely. The design instead constrains what each boundary can learn.
The main boundaries are:
- external observer of adjacent link traffic
- intermediate forwarding hop
- compromised subset of route hops
- stale-node bootstrap observer
An external observer may see timing, packet count, and adjacent link endpoints. An intermediate hop may see its adjacent predecessor and successor and its local peel result. A stale-node bootstrap observer may see limited board, introduction, or bridge use, but it must not recover a canonical shared topology map from that data alone.
13. Adversary Assumptions
Aura assumes the following adversary model:
- local passive observers exist
- some forwarding hops may be compromised
- bootstrap boards and bridge providers may be observed
- stale-node re-entry may happen after long offline gaps and physical movement
Aura does not assume a global passive adversary can be defeated. Aura does not assume that service relationships reveal nothing. Aura aims to reduce graph leakage and route leakage under partitioned socially rooted operation.
14. Construction Rationale
Aura keeps adjacent-peer Noise channels because they already fit the transport boundary and context model. Aura adds a route-layer construction because adjacent-peer channels alone do not hide deeper route structure from intermediate forwarding hops.
Aura chooses Curve25519, a centralized KDF surface, and ChaCha20-Poly1305 because the construction is simple, auditable, and fits Aura's typed route-layer needs. The route layer needs explicit forward and backward hop streams, typed replay bounds, and typed reply blocks. A compact Aura-native construction is easier to align with these requirements than importing a foreign packet format.
15. Required Implementation Boundaries
The implementation must satisfy the following boundaries:
aura-effectsowns hop crypto primitives- shared record types for bootstrap hints and re-entry hints remain authoritative typed objects
- runtime-owned caches merge bootstrap records locally and expire them locally
MoveEnveloperemains the shared accountable movement boundarytransparent_onionremains a debug and simulation tool only
Production paths use encrypted peel processing. Transparent setup and header inspection objects remain quarantined behind the explicit transparent_onion feature surface and must fail closed in release production builds.
16. Summary
Aura uses existing Noise-based adjacent-peer channels for link encryption and a separate Aura-native route-layer construction for anonymous path encryption. Bootstrap and re-entry use overlapping signed and expiring surfaces instead of a singleton service. Reply blocks remain typed Aura objects. Runtime selection stays local and does not promote bootstrap provenance into canonical shared route truth.
Hello World Guide
This guide gets you running with Aura in 15 minutes. You will build a simple ping-pong protocol, deploy it locally, and interact with it using the CLI.
Setup
Aura uses Nix for reproducible builds. Install Nix with flakes support.
Enter the development environment:
nix develop
This command activates all required tools and dependencies. The environment includes Rust, development tools, and build scripts.
Cargo and cargo clippy both use the shell's pinned Rust toolchain. The shell
dispatches Clippy explicitly because Cargo can otherwise select an older
plugin installed in Cargo home before searching PATH. This requires no global
toolchain changes. just ci-build-cache-policy tests the dispatch, argument
boundaries, and forwarded exit status.
The repository supports the pinned Rust 1.93 toolchain. Workspace packages
declare 1.93 as their supported compiler floor, including published packages;
the earlier 1.75 metadata did not establish a tested minimum for the current
resolved dependency graph. Lower package-specific minimum supported Rust
versions require a separate dependency audit and actual checks with that
compiler. Dependency metadata alone does not establish lower-toolchain support.
The separate host-tool workspaces (toolkit/test-support and toolkit/xtask)
declare this floor explicitly; they do not inherit the runtime workspace's
metadata. Dylint libraries use the separately pinned nightly compiler because
they integrate with compiler-private APIs. Vendored upstream package metadata
remains upstream-owned.
Build the project:
just build
The build compiles all Aura components and generates the CLI binary. This takes a few minutes on the first run.
For a deployable terminal binary, run just build-release. This builds the
production terminal feature set and installs bin/aura atomically. Use
just build-dev for the development feature set, and
just build-workspace-release when validating every workspace crate in the
release profile. The browser bundle has its own Dioxus build path.
On a clean fixed-commit comparison (a9fabe9a, macOS ARM), the terminal
release retained 1,825,040 KiB versus 3,068,204 KiB for the full workspace:
1,243,164 KiB (40.5%) less release output. The terminal compiled 330
packages versus 498 for the workspace. Shared warm caches vary with later
web, development and test builds; use the disk report to measure the current
checkout.
Repeated LAN test builds should use just e2e-build-terminal,
just e2e-build-web, and just e2e-build-harness in the Nix environment on
each host. These commands report free space, preview and collect idle Cargo
artifacts when needed, and stop their own build if free space reaches the
emergency floor. just disk-report, just cache-inventory, and
just build-budget-dry-run are read-only. Run the LAN recipes from the same
pushed commit on both hosts, in the background and one host at a time. Set
CARGO_BUILD_JOBS to half the available cores on the Air. The recipes use
nice -n 10. Use AURA_BUILD_TARGET_CAP_GIB, AURA_BUILD_MIN_FREE_GIB, and
AURA_BUILD_EMERGENCY_FREE_GIB to adjust Host B thresholds after its own
read-only baseline. The 10 GiB per-checkout Cargo target cap is a between-build soft target;
it is not a quota during compilation. The scripts preserve .tmp/e2e and failure
evidence. Use scripts/dev/retain-e2e-runs.sh prune --dry-run to inspect
completed successful run bundles, then --apply when no harness run is
active. Failed, pinned, active and unclassified bundles are preserved.
The disk report lists the current checkout and linked Git worktrees separately, including debug incremental and trybuild caches; it never collects another worktree's target. Work 8 debug, test, and Clippy rebuilds also produce Cargo artifacts. Route each of those commands through the same guard, keeping any chosen Cargo profile or explicit incremental override on the command. During an approved live LAN run, use:
AURA_BUILD_PROFILE=debug nice -n 10 bash scripts/dev/build-budget.sh \
--lane work8-debug --allow-live-harness -- cargo test -p hxrts-aura-agent --lib
Replace the Cargo command after -- for cargo check, cargo clippy, or
another package test. Omit --allow-live-harness outside a live run. The
guard refuses admission when another builder of the same checkout is active,
or when free space minus other admitted builds' reservations is below
the configured floor; wait for the current owner to finish and release an
idle cache window before retrying. The Cargo development profile disables
incremental compilation by default for ordinary Cargo and editor checks;
guarded builds also default to CARGO_INCREMENTAL=0. Opt in with
CARGO_INCREMENTAL=1 when the saved rebuild
time justifies its retained cache. The fixed-source foundation measurement
retained 289,240 KiB without incremental compilation versus 552,508 KiB after
an incremental source rebuild (47.6% less). The wrapper's measured rebuild
times were 16s versus 12s; this is a foundation check, not a whole-workspace
performance guarantee. The wrapper and saved disk report log the effective
setting. Required cache-policy fixtures verify the wrapper behavior and compile
a tiny isolated package using the actual development profile to verify the
compiler default and explicit override.
Run just ci-dry-run only after Cargo, Dioxus and LAN harness consumers
have stopped. Its startup and per-step preflight refuses active consumers,
checks free space, and can collect only idle compiler caches. It preserves
.tmp/e2e and current CI logs.
A complete run needs about 40 GiB free at start. To exclude a step
explicitly, set AURA_CI_DRY_RUN_SKIP to comma-separated step names (for
example "Tests + Protocol Compat"); excluded steps are announced at the
start of the run.
If stale native release variants dominate after the LAN run ends, preview
bash scripts/dev/prune-inactive-lane.sh --lane release --dry-run and then
use --apply to reset that whole idle cache. The command refuses active
builders, harness processes and open release files. It leaves the installed
bin/aura alone; the next release build recompiles its dependencies.
The normal guarded build sequence on each host is:
just disk-report
just build-budget-dry-run
just e2e-build-terminal
just e2e-build-web
just e2e-build-harness
just disk-report
To compare the clean disk cost of the deployable terminal build with the
full workspace release gate, run
scripts/dev/compare-release-scopes.sh --dry-run first. On an idle host
with at least 40 GiB free, use --apply. The Bash script builds both scopes
from one commit in separate temporary worktrees, copies the disk reports to
artifacts/disk-budget/comparisons/, and removes each temporary target before
starting the next build. By default it refuses to run while a build or LAN
harness consumer is active.
For a reserved window with a live LAN harness but no Cargo/Dioxus builders,
use --check --allow-live-harness and then --apply --allow-live-harness.
This mode still refuses another builder, uses four low-priority Cargo jobs by
default, and touches only the temporary worktree target. Override the job
count with AURA_COMPARE_CARGO_JOBS when the host needs a lower limit.
The comparison uses the budget wrapper's --no-prune mode because each
temporary target is removed after measurement; its free-space admission and
emergency stop remain active.
If a separate builder starts before the second scope, the script preserves
the completed first-scope measurements and stops. Rerun with
--resume artifacts/disk-budget/comparisons/<run-directory> from a later
no-builder window; it verifies the fixed commit and skips successful scopes.
The tracked LAN entry point is scripts/harness/lan/build.sh; its lane is
terminal, terminal-live, terminal-dev, web, web-live, harness,
or harness-live. Use the live variants during an approved active LAN run;
they preserve release and web caches and only collect an idle WASM debug
lane when the budget requires cleanup.
It prints the host and commit before building, enters nix develop when
needed, and accepts AURA_EXPECT_COMMIT=<full-hash> to reject a host on a
different revision or a checkout with uncommitted changes. Use its
--dry-run flag to preview the selected recipe.
Use scripts/harness/lan/build.sh all for the complete terminal, web and
harness build sequence. It requires a clean checkout, pins the initial commit
through every step, and stops at the first failure. Run this sequence on one
host at a time; it does not start an E2E run or modify the other host.
LAN browser startup requires the prebuilt harness-enabled bundle and fails if
it is missing or stale. It cannot quietly start an unguarded Dioxus build or
clear the serving cache; stop the run and repeat the guarded web build first.
On Host B, the macOS application firewall may need the newly signed
bin/aura authorized again after a rebuild, as described in work/8.md.
The build helper does not change firewall settings.
Run just e2e-build-terminal-dev separately when a test explicitly needs
the development feature set. Each successful guarded build also saves its
own disk report under artifacts/disk-budget/.
For one-off Work 8 Cargo test, check, or Clippy rebuilds, wrap the Cargo
command too. For example, inside nix develop:
AURA_BUILD_PROFILE=debug AURA_BUILD_FEATURES=work8-test \
nice -n 10 bash scripts/dev/build-budget.sh \
--lane work8-debug --allow-live-harness -- \
cargo test -p hxrts-aura-app
Substitute the required Cargo subcommand and package selector. Start only
when no other Cargo or Dioxus build is active. The live option preserves
release/web/Dylint caches while a LAN run is active; the disk monitor still
stops only its own command at the emergency floor.
When the LAN owner permits a terminal build during a live run, use
just e2e-build-terminal-live. That recipe skips global Cargo sweeping and
may collect only an idle WASM debug lane. The ordinary
just e2e-build-terminal recipe enforces the full idle-lane cache policy;
run it after the harness stops. Web and harness-tool rebuilds also require
the harness to stop before cache collection.
On Host B, pass its own --root ending in /artifacts/runs to the retention
script; it never prunes the other host remotely.
When only an unused debug lane can be released, inspect it with
just prune-inactive-lane wasm-debug --dry-run and then use --apply.
The cleanup checks for active compilers and open files in that lane.
Global Cargo sweeping also skips a target with open files, such as proc-macro
libraries loaded by rust-analyzer; it then considers only fully inactive
whole lanes. The 10 GiB per-checkout target is a soft between-build goal, so a lane held
open by another process may remain above it until that process exits.
just prune-inactive-lane debug-incremental --dry-run previews the complete
incremental cache independently of sibling debug dependencies. With --apply,
it refuses active compilers, open incremental files and symlinked parents,
and preserves release outputs and loaded debug libraries. The build and CI
guards consider this lane before the complete debug lane.
just prune-inactive-lane trybuild --dry-run separately previews the complete
target/tests/trybuild compile-fail cache. Its apply mode requires idle compilers,
no open files in that cache, and ordinary parent directories. Build and CI guards
can reclaim it while preserving editor-loaded sibling debug libraries. The next
compile-fail gate rebuilds this cache; its test sources and expected diagnostics
remain in the repository.
For an explicit browser release cache reset, wasm-release selects
target/wasm32-unknown-unknown/wasm-release and wasm-host-release selects
its host-side build cache at target/wasm-release. Preview each with
just prune-inactive-lane <lane> --dry-run. Apply refuses active compilers,
harness consumers, open files, and symlinked paths. These release lanes are
manual cleanup choices; automatic guards preserve them. Installed browser
bundles and run evidence stay outside these compiler cache paths.
To reproduce the debug cache measurement, run
bash scripts/dev/compare-debug-incremental.sh --dry-run first, then --apply
inside Nix during an idle build window. It checks the actual foundation crate
with incremental compilation enabled and disabled, measuring a clean check,
a warm check and a harmless source rebuild. It uses a fixed-commit source
archive and sequential disposable targets, retains logs under
artifacts/disk-budget/debug-comparisons, and retains its source snapshot on
failure. It leaves the main checkout's source, target and E2E evidence intact.
just ci-build-cache-policy runs the isolated Bash safety fixtures, including
default/override inheritance, active-build refusal, symlink containment,
fixed-commit sequencing, evidence retention and atomic installation. Both
GitHub Fast CI and ci-dry-run require this gate; it performs no real build
or shared-cache deletion.
Creating an Agent
Aura provides platform-specific builder presets for creating agents. The CLI preset is the simplest path for terminal applications.
#![allow(unused)] fn main() { use aura_agent::AgentBuilder; // CLI preset - simplest path for terminal applications let agent = AgentBuilder::cli() .data_dir("~/.aura") .testing_mode() .build() .await?; }
The CLI preset provides sensible defaults for command-line tools. It uses file-based storage, real cryptographic operations, and TCP transport.
For custom environments that need explicit control over effect handlers, use AgentBuilder::custom() with typestate enforcement. This requires providing all five core effects (crypto, storage, time, random, console) before build() is available.
Platform-specific presets are available for iOS (AgentBuilder::ios()), Android (AgentBuilder::android()), and Web/WASM (AgentBuilder::web()). These require feature flags to enable. See Effects and Handlers Guide for detailed builder examples.
See Project Structure for details on the 8-layer architecture and effect handler organization.
Ownership Declaration Before You Add New Parity-Critical Code
Before adding a new parity-critical module or workflow, declare its ownership
category in the crate ARCHITECTURE.md.
Use Pure for reducers, validators, and typed contracts. Use MoveOwned for handles, owner tokens, and ownership transfer. Use ActorOwned for long-lived mutable async state and coordinators. Use Observed for rendering, harness reads, and diagnostics.
Also declare which capability gates parity-critical mutation and publication, which module owns terminal lifecycle, and which timeout and backoff policy the owner consumes. If those points are not explicit, the new module is not ready to land.
Hello World Protocol
Create a simple ping-pong choreography. This protocol demonstrates basic message exchange between two devices.
#![allow(unused)] fn main() { use aura_macros::tell; use aura_core::effects::{ConsoleEffects, NetworkEffects, TimeEffects}; use aura_core::time::PhysicalTime; use serde::{Serialize, Deserialize}; /// Sealed supertrait for ping-pong effects pub trait PingPongEffects: ConsoleEffects + NetworkEffects + TimeEffects {} impl<T> PingPongEffects for T where T: ConsoleEffects + NetworkEffects + TimeEffects {} #[derive(Debug, Clone, Serialize, Deserialize)] pub struct Ping { pub message: String, pub timestamp: PhysicalTime, } #[derive(Debug, Clone, Serialize, Deserialize)] pub struct Pong { pub response: String, pub timestamp: PhysicalTime, } tell! { #[namespace = "hello_world"] protocol HelloWorld { roles: Alice, Bob; Alice[guard_capability = "hello_world:send_ping", flow_cost = 10] -> Bob: SendPing(Ping); Bob[guard_capability = "hello_world:send_pong", flow_cost = 10, journal_facts = "pong_sent"] -> Alice: SendPong(Pong); } } }
The choreography defines a global protocol. Alice sends a ping to Bob. Bob responds with a pong. Guard capabilities control access and flow costs manage rate limiting.
Outside the choreography DSL boundary, first-party Rust code should use typed capability families or capability_name! rather than hand-written capability strings.
Implement the Alice session:
#![allow(unused)] fn main() { pub async fn execute_alice_session<E: PingPongEffects>( effects: &E, ping_message: String, bob_device: aura_core::DeviceId, ) -> Result<Pong, HelloWorldError> { let ping = Ping { message: ping_message, timestamp: effects.current_timestamp().await, }; let ping_bytes = serde_json::to_vec(&ping)?; effects.send_to_peer(bob_device.into(), ping_bytes).await?; let (peer_id, pong_bytes) = effects.receive().await?; let pong: Pong = serde_json::from_slice(&pong_bytes)?; Ok(pong) } }
Alice serializes the ping message and sends it to Bob. She then waits for Bob's response and deserializes the pong message. See Effect System for details on effect-based execution.
Local Deployment
Initialize a local Aura account:
just quickstart init
This command creates a 2-of-3 threshold account configuration. The account uses three virtual devices with a threshold of two signatures for operations.
Check account status:
just quickstart status
The status command shows account health, device connectivity, and threshold configuration. All virtual devices should show as connected.
Run quickstart smoke checks:
just quickstart smoke
This command runs a local end-to-end smoke flow (init, status, and threshold-signature checks) across multiple virtual devices.
CLI Interaction
The aura CLI operates on the same account as the TUI. It reads the account from --data-dir, falling back to the TUI's default location ($AURA_PATH/.aura, or ~/.aura). Run aura --help or aura COMMAND --help to see the available commands.
View the account:
aura --data-dir ~/.aura status
This prints the account's authority, nickname, threshold, device count and contact count.
Inspect and use chat, contacts, invitations and homes. Channels are named by name or id:
aura chat list
aura chat send general "hello"
aura chat history general --limit 20
aura contact list
aura invite create --invitee AUTHORITY # prints a shareable code
aura invite import --code CODE
aura invite accept --invitation-id ID
aura home create --name Home
aura home invite AUTHORITY
aura slash "/topic welcome" --channel general
The other command groups follow the TUI's screens: account create|refresh, profile nick, settings show|mfa, contact list|rename|remove|whois|read-receipts, friend send|accept|decline|revoke, chat dm|join|close|members|retry|mark-read, home enter, neighborhood create|add|link, mod kick|ban|unban|mute|unmute|pin|unpin|op|deop|admit, access set, peer list|discover, device threshold|remove, guardians set, rotation status|cancel, ota list|status|publish|recommend|stage, budget and notifications list. aura account create --nickname NAME creates an account the same way the TUI does, so the TUI opens it afterwards.
Every account command runs the same aura_app::ui::workflows functions as the TUI and web, through one typed request model.
Driving a node from a program
aura rpc keeps one runtime online and reads one JSON request per line on stdin; aura serve keeps it online without a client:
aura rpc
{"id":1,"method":"chat_send","params":{"channel":"general","message":"hi"}}
{"id":2,"method":"subscribe","params":{"topics":["messages"]}}
A running node, the TUI or aura serve, also listens on an owner-only local socket (mode 0600, same-user connections only, no network listener). Unix socket paths are short, so the socket lives in the user runtime directory ($XDG_RUNTIME_DIR, else $TMPDIR, else /tmp) as aura-<hash>.sock, and the node records its path in <data-dir>.sock-path beside the data directory. A node that cannot host its socket fails to start. Every aura account command and aura rpc first try that socket, so they work while the TUI holds the account. With no node running, the CLI opens the account's production runtime itself under the profile's exclusive lease.
The protocol schema is published at crates/aura-terminal/schema/aura-rpc-v2.json, generated from the request and response types and kept in sync by just ci-rpc-schema.
RPC response counts use unsigned 64-bit integers. Chat history and search limits use unsigned 32-bit integers, checked before conversion to the workflow's local collection limit. These ranges are the same on native and browser-sized targets. Subscription event payloads use serde_json::Value, whose numeric representation already bounds their counts independently of pointer width.
The first line written is a hello line with the protocol version, methods and event topics. Each response carries the request's id and the same result or error that aura --json prints. After subscribe, event lines ({"type":"event","topic":"messages",...}) interleave with responses; a subscriber that falls behind gets one resync event with a fresh snapshot. The session ends on EOF or {"method":"shutdown"}.
Command output is printed plainly. Add -v to also print runtime diagnostics.
For scripts, the global flags make every command machine-readable:
aura --json status # {"ok":true,"result":{...}} on stdout
aura --yes chat leave general # confirm a destructive command without a prompt
aura --timeout 30 sync once --peers PEER
Under --json, stdout carries exactly one JSON document, either {"ok":true,"result":...} or {"ok":false,"error":{"code":...,"message":...}}; diagnostics go to stderr. Destructive commands prompt on a terminal and fail without --yes otherwise. The exit code classifies failures: 0 success, 1 failed, 2 invalid input, 3 not found, 4 permission denied, 5 timeout, 6 unavailable.
Testing Your Protocol
Create a test script for the hello world protocol:
#![allow(unused)] fn main() { use aura_macros::aura_test; use aura_testkit::*; use aura_agent::runtime::AuraEffectSystem; use aura_agent::AgentConfig; #[aura_test] async fn test_hello_world_protocol() -> aura_core::AuraResult<()> { // Create test fixture with automatic tracing let fixture = create_test_fixture().await?; // Create deterministic test effect systems let alice_effects = AuraEffectSystem::simulation_for_named_test_with_salt( &AgentConfig::default(), "test_hello_world_protocol", 0, )?; let bob_effects = AuraEffectSystem::simulation_for_named_test_with_salt( &AgentConfig::default(), "test_hello_world_protocol", 1, )?; // Get device IDs for routing let alice_device = fixture.create_device_id(); let bob_device = fixture.create_device_id(); let ping_message = "Hello Bob!".to_string(); // Run protocol sessions concurrently let (alice_result, bob_result) = tokio::join!( execute_alice_session(&alice_effects, ping_message.clone(), bob_device), execute_bob_session(&bob_effects, ping_message.clone()) ); assert!(alice_result.is_ok(), "Alice session failed"); assert!(bob_result.is_ok(), "Bob session failed"); let pong = alice_result?; assert!(pong.response.contains(&ping_message)); Ok(()) } }
This test creates deterministic, seeded effect systems for Alice and Bob using simulation_for_named_test_with_salt(...). The identity + salt pair makes failures reproducible. For comprehensive testing approaches, see Testing Guide.
Run the test:
cargo test test_hello_world_protocol
The test validates protocol correctness without requiring network infrastructure. Mock handlers provide deterministic behavior for testing.
Understanding System Invariants
System invariants are defined in System Architecture and Theoretical Model. Key invariants include Charge-Before-Send, CRDT Convergence, Context Isolation, and Secure Channel Lifecycle.
See Project Structure for traceability details. When developing, ensure your protocols respect these invariants to maintain system integrity.
Next Steps
You now have a working Aura development environment. The hello world protocol demonstrates basic choreographic programming concepts.
Continue with Effects and Handlers Guide to learn about effect systems, platform implementation, and handler patterns. Learn choreographic programming in Choreography Guide. For session type theory, see MPST and Choreography.
Explore testing and simulation in Testing Guide and Simulation Guide.
Effects and Handlers Guide
This guide covers how to work with Aura's algebraic effect system. Use it when you need to extend the system at its boundaries: adding handlers, implementing platform support, or creating new effect traits.
For the full effect system specification, see Effect System.
Keep native runtime construction failures source-bearing through preset builders.
Use BuildError::RuntimeConstructionSource for an underlying error rather than
copying its display text into RuntimeConstruction. A declared provider must
reach its actual effect owner; typestate presence alone does not verify wiring.
Exercise injected providers through the built runtime when testing composition.
Required effect initialization uses BuildError::EffectInitSource, retaining the
effect name and original cause through the native agent boundary. Directory
creation and signal registration failures must not become string-only config
errors. Plain configuration rejection can retain its explicit diagnostic shape.
AMP lifecycle failures retain concrete effect causes through the native runtime boundary. Canonical checkpoint absence has a private producer in the AMP journal reader. Scoped duplicate diagnostics require an exact requested entity and an independent successful canonical read before reconciliation; diagnostic wording and error records alone cannot suppress mutation failures. AmpChannelError carries source-bearing AuraError values and no longer promises equality; compare typed variants or stable categories. Foreign diagnostics explicitly discard native causes only at the presentation adapter.
Preserve Concrete Error Causes
Required AMP state, bootstrap and participant reads use the native bridge error contract. Return absence only after a successful canonical checkpoint read proves exact context/channel absence. Participant augmentation uses the required channel invitation reader; the general best-effort invitation listing is an observed diagnostic surface and cannot supply authoritative membership.
Retain the native cause when retrying AMP sends. Publish an initial bounded-call failure through the existing semantic owner, and classify transport outcomes from typed native kinds and timeout-budget variants. Clock unavailability is an unavailable dependency; only deadline evidence yields a timeout. Error display text must not decide retry policy or terminal failure codes.
Use the existing typed conversions into AuraError when wrapping effect
failures. For cryptographic context, use AuraError::crypto_with_source with
the original error in an Arc; avoid reducing the cause to its display text.
If adding an error wrapper that stores an Arc<dyn Error + Send + Sync>, make
its standard Error::source return the wrapped error through as_deref().
Verify this with a concrete downcast_ref assertion after cloning and a nested
source-chain assertion. Checking only source presence or display text cannot
detect an extra shared-storage wrapper. The serialization contract in
Effect System omits these process-local
sources; use typed codes for cross-process failures.
1. Code Location
A critical distinction guides where code belongs in the architecture.
Single-party operations go in aura-effects. These are stateless, context-free handlers that take input and produce output without maintaining state or coordinating with other handlers.
Examples:
sign(key, msg) -> Signature- one device, one cryptographic operationstore_chunk(id, data) -> Ok(())- one device, one writeRealCryptoHandler- self-contained cryptographic operations
Multi-party coordination goes in aura-protocol. These orchestrate multiple handlers together with stateful, context-specific operations.
Examples:
execute_anti_entropy(...)- orchestrates sync across multiple partiesCrdtCoordinator- manages state of multiple CRDT handlersGuardChain- coordinates authorization checks across sequential operations
If removing one effect handler requires changing the logic of how other handlers are called (not just removing calls), it belongs in Layer 4 as orchestration.
Decision Matrix
| Pattern | Characteristics | Location |
|---|---|---|
| Single effect trait method | Stateless, single operation | aura-effects |
| Multiple effects/handlers | Stateful, multi-handler | aura-protocol |
| Multi-party coordination | Distributed state, orchestration | aura-protocol |
| Domain types and semantics | Pure logic, no handlers | Domain crate |
| Complete reusable protocol | End-to-end, no UI | Feature crate |
| Handler/protocol assembly | Runtime composition | aura-agent |
| User-facing application | Has main() entry point | aura-terminal |
Boundary Questions
Stateless code goes in aura-effects. Stateful code goes in aura-protocol. Single-party code goes in aura-effects. Multi-party code goes in aura-protocol. Context-free code goes in aura-effects. Context-specific code goes in aura-protocol.
2. Effect Handler Pattern
Effect handlers are stateless. Each handler implements one or more effect traits from aura-core. It receives input, performs a single operation, and returns output. No state is maintained between calls.
Production handlers (like RealCryptoHandler) use real libraries. Mock handlers (like MockCryptoHandler in aura-testkit) use deterministic implementations for testing.
See Cryptographic Architecture for cryptographic handler requirements.
Implementing a Handler
Step 1: Define the trait in aura-core.
#![allow(unused)] fn main() { #[async_trait] pub trait MyEffects: Send + Sync { async fn my_operation(&self, input: Input) -> Result<Output, EffectError>; } }
Step 2: Implement the production handler in aura-effects.
#![allow(unused)] fn main() { pub struct RealMyHandler; #[async_trait] impl MyEffects for RealMyHandler { async fn my_operation(&self, input: Input) -> Result<Output, EffectError> { // Implementation using real libraries } } }
Step 3: Implement the mock handler in aura-testkit.
#![allow(unused)] fn main() { pub struct MockMyHandler { seed: u64, } #[async_trait] impl MyEffects for MockMyHandler { async fn my_operation(&self, input: Input) -> Result<Output, EffectError> { // Deterministic implementation for testing } } }
Adding a Cryptographic Primitive
- Define the type in
aura-corecrypto module - Implement
aura-coretraits for the type's semantics - Add a single-operation handler in
aura-effectsthat implements the primitive - Use the handler in feature crates or protocols through the effect system
3. Platform Implementation
Use the AgentBuilder API to assemble the runtime with appropriate effect handlers for each platform.
Builder Strategies
| Strategy | Use Case | Compile-Time Safety |
|---|---|---|
| Platform preset | Standard platforms (CLI, iOS, Android, Web) | Configuration validation |
| Custom preset | Full control over all effects | Typestate enforcement |
| Effect overrides | Preset with specific customizations | Mixed |
Platform Presets
#![allow(unused)] fn main() { // CLI let agent = AgentBuilder::cli() .data_dir("~/.aura") .build() .await?; // iOS (requires --features ios) let agent = AgentBuilder::ios() .app_group("group.com.example.aura") .keychain_access_group("com.example.aura") .build() .await?; // Android (requires --features android) let agent = AgentBuilder::android() .application_id("com.example.aura") .use_strongbox(true) .build() .await?; // Web/WASM (requires --features web) let agent = AgentBuilder::web() .storage_prefix("aura_") .build() .await?; }
Custom Preset with Typestate
#![allow(unused)] fn main() { let agent = AgentBuilder::custom() .with_crypto(Arc::new(RealCryptoHandler::new())) .with_storage(Arc::new(FilesystemStorageHandler::new("~/.aura".into()))) .with_time(Arc::new(PhysicalTimeHandler::new())) .with_random(Arc::new(RealRandomHandler::new())) .with_console(Arc::new(RealConsoleHandler::new())) .build() .await?; }
All five required effects must be provided or the code won't compile.
Required Effects
| Effect | Purpose | Trait |
|---|---|---|
| Crypto | Signing, verification, encryption | CryptoEffects |
| Storage | Persistent data storage | StorageEffects |
| Time | Wall-clock timestamps | PhysicalTimeEffects |
| Random | Cryptographically secure randomness | RandomEffects |
| Console | Logging and output | ConsoleEffects |
Optional Effects
| Effect | Default Behavior |
|---|---|
TransportEffects | TCP transport |
LogicalClockEffects | Derived from storage |
OrderClockEffects | Derived from random |
ReactiveEffects | Default reactive handler |
JournalEffects | Derived from storage + crypto |
BiometricEffects | Fallback no-op handler |
Platform Implementation Checklist
- Identify platform-specific APIs for crypto, storage, time, random, console
- Implement the five core effect traits
- Create a preset builder (optional)
- Add feature flags for platform-specific dependencies
- Write integration tests using mock handlers
- Document platform-specific security considerations
- Consider transport requirements (WebSocket, BLE, etc.)
4. Testing Handlers
Test handlers using mock implementations from aura-testkit.
#![allow(unused)] fn main() { use aura_testkit::*; #[aura_test] async fn test_my_handler() -> aura_core::AuraResult<()> { let fixture = create_test_fixture().await?; // Use fixture.effects() to get mock effect system let result = my_operation(&fixture.effects()).await?; assert!(result.is_valid()); Ok(()) } }
Never use real system calls in tests such as SystemTime::now() or thread_rng(). Use deterministic seeds for reproducibility. Test both success and error paths.
See Testing Guide for comprehensive testing patterns.
5. Effect System Architecture
For deeper understanding of the effect system architecture, see:
- Effect System - Full specification
- Cryptographic Architecture - Crypto handler requirements
- System Architecture - Layer boundaries
Key Concepts
The effect system uses three layers:
- Foundation effects in
aura-corecover crypto, storage, time, random, console, and transport. - Infrastructure effects in
aura-effectsprovide production handlers implementing foundation traits. - Composite effects are built by composing foundation effects. For example,
TreeEffectscombines storage and crypto.
All impure operations (time, randomness, filesystem, network) must flow through effect traits. Direct calls break simulation determinism and WASM compatibility.
Run just check-arch to validate effect trait placement and layer boundaries.
Preserving workflow failure causes
Pass the concrete error into runtime_call, journal_op, fact_encoding,
or ceremony_op. These helpers require Error + Send + Sync + 'static;
passing to_string(), a borrowed error, or a display-only value is rejected.
Use a typed domain precondition variant when no underlying failure exists.
Do not invent a source to make a diagnostic message satisfy the helper bound.
Workflow conversion retains the WorkflowError as the standard error source,
followed by the context wrapper and original concrete cause. WorkflowError::Core
passes through unchanged. Time failures likewise retain TimeUnavailable and
the original runtime/query/parity cause. Inspect Error::source() and downcast
when selecting typed policy; display text is for diagnostics.
Compatibility: helper callers must pass owned concrete errors. Time failure
variants now include an owned source field; callers matching their kind use
{ .. }, and constructors must retain the actual failure. Existing outer
workflow categories and diagnostic display prefixes are retained; the journal
encoding path no longer adds a redundant serialization wrapper. Serialized
AuraError values omit process-local sources, so deserialization cannot recover
a typed cause for authorization or retry decisions.
For required canonical-state queries, propagate Err before issuing a
mutation or publishing readiness. Only Ok(false) means that the canonical
entity is absent. A failed query cannot justify creating or joining an entity.
If a failed operation triggers a second canonical read to distinguish an
already-completed operation from failure, that second read is also required;
do not replace its error with false or a stale projection.
Native runtime error classification
Keep RuntimeBridgeError and its original source on native paths. Use the
runtime's structural invitation failure reason when deciding whether acceptance
was already handled or when publishing a contact confirmation failure. A
non-pending invitation is not necessarily accepted: revoked, expired, and
declined states must remain failures. Never infer these decisions from display
text, even when a message is stable or comes from a wrapped error.
When adding a native domain reason, match the concrete runtime cause
exhaustively at the bridge normalization boundary and test both genuine typed
causes and diagnostic lookalikes. Workflow context errors retain that native
cause through Error::source(). Converting to the existing foreign
IntentError or CallbackError payload is an explicit terminal diagnostic
operation and cannot feed native retry or authorization policy.
Preserving timeout causes
For enrollment execution, derive the budget from the original registered ceremony window before creating bounded child attempts. Restarting a task or retrying transport must not create a fresh acceptance window. A pending terminal state is a wait under that budget; it is not deadline evidence.
Use the required trusted-parent metadata reader for cryptographic admission.
Propagate secure retrieval errors and retain codec sources. Validate participant
count, uniqueness and signing policy before using the verifier. Query canonical
package presence through the fallible provider API first. A successful absence
permits legacy layout lookup; failed presence or byte reads must propagate.
Present but corrupt canonical bytes cannot be repaired with legacy bytes.
Observational Option readers cannot establish parent trust.
At native required-read adapters, classify concrete error variants before building display diagnostics. Preserve the original wrapper and source chain. Known storage, codec, authorization and network causes keep their own category; generic internal wrappers may expose a more specific typed source. Required clock failure, rollback and retry-attempt exhaustion are service failures, not observed budget deadlines. Foreign diagnostic text cannot supply that evidence.
Use TimeoutBudgetError::time_source_failure(error) when a required clock operation returns an actual error. The detail-only constructor is for diagnostics without an underlying failure. Match typed timeout variants or stable codes; do not compare source-bearing errors for equality or infer deadline expiry from display text. Forward timeout and retry wrappers as errors so their standard source chains remain available. Serialized diagnostics carry no native source evidence.
Preserve timeout ownership across awaits
Use the existing timeout budget or its child budget for subsequent stages. Clone shares observation and exhaustion; constructing a fresh budget from a prior duration discards the owner contract. Required runtime sleep returns a result: propagate its original source through the owned failure path. Check required time after either awaited branch and after retry backoff. Keep observation guards lexical and release them before awaiting. Cover rollback after progress, cloning, child deadlines, canceled waits, and validated restart with injected clocks. Compile-fail coverage prevents Copy reconstruction; semantic and native classification must exhaustively match timeout-budget variants.
Persist enrollment windows through their sealed owner
Retain the move-owned EnrollmentExecutionRoot in the existing operation owner and pass its attenuated EnrollmentExecutionChild values through nested attempts. Fresh explicit admission must acknowledge its durable Pending birth before exposing usable execution custody. Repeat imports borrow the original retained root under its same provider and endpoint; they never reconstruct authority from persisted phase bytes. Keep all owned descendants in the root's existing task subtree. After actual VM disposal, consuming the root requires independent verified domain terminal evidence and the exact sealed subtree disposal acknowledgment before it can acknowledge Closed. A child checkpoint or empty subtree does not establish successful execution. Missing or obsolete records refuse execution without repair or migration. Do not reconstruct a duration, renew the positive window or call a raw/no-op executor on this path. Interrupted execution remains durably Pending, so negative deadline handling does not need an unbounded post-expiry checkpoint write.
Use fallible owned interval callbacks for required maintenance. Preserve the original error through task supervision, service health consumption, and shutdown. Run just ci-ownership-policy, just ci-annotation-ratchet, and the checkpoint/rollback source regressions after changing these boundaries.
Using shared window arithmetic
Use aura_core::types::window::{WindowInterval, WindowPosition, PhysicalMillis, ReceiptGeneration} for validated interval arithmetic. Keep owner-specific admission and checkpoint APIs separate: interval deserialization validates bounds but grants no provenance. Construct physical execution through TimeoutBudget; its millisecond policy rejects empty or sub-millisecond windows. The flow-window owner should adopt WindowInterval<ReceiptGeneration> when its generation-window module integrates, reject unrepresentable endpoints, and keep checked epoch/base progression in its existing authoritative path. Keep physical clock fields out of flow receipts. Adoption of the shared arithmetic primitive is a separate integration step; existing flow-window code has not been migrated by this change. A subtraction-based membership implementation may admit base u64::MAX with extent one, whereas the checked primitive rejects its unrepresentable exclusive endpoint. Handle this as typed exhaustion or define a reviewed wider coordinate contract; do not silently clamp it.
Recovering enrollment window phases
Retain the original immutable allocation, initial clock, canonical registration and immutable live-boundary marker before inserting the live registry entry. Recover an interrupted pre-live clock from the secure original allocation; never rebuild its duration from current time. Treat either canonical registration or the live marker as evidence that a missing clock cannot be repaired. For older records, mint a missing live marker only after both secure allocation and original clock validate. Preserve original clock/exhaustion identity in the execution capability and hold allocation continuity until required checkpoint storage acknowledges.
Construct native profile writers before accessing secrets
Acquire FilesystemProfileStorageHandler::acquire_owned_native once for the selected physical profile. Attach its concrete Arc<OwnedProfileLease> to ordinary storage and pass the same owner into ProductionSecureStorageHandler::filesystem_fallback_with_profile_owner for an explicitly permitted filesystem provider. This factory opens secure_store relative to the retained profile descriptor before reading or immutably admitting the wrapping key. Keep the returned owned provider intact; rebuilding a backend or generating a replacement for an invalid persisted key breaks provider continuity.
Native Unix file operations retain directory descriptors through staging, renameat or no-replace linkat, unlinkat, and directory sync. NOFOLLOW rejects descendant symlinks. The production effect constructor selects this factory before wrapping-key access. Unowned convenience constructors remain test/simulation surfaces; they do not grant a lifetime profile ownership guarantee. A profile path may cease naming its original directory, while an already-owned descriptor still names that original inode.
After an interrupted publication, reread and validate the canonical record under the retained owner. A successful local replacement does not atomically update the account profile, pending enrollment handoff, and signing generation together; that requires their transaction/WAL owner.
Recover encrypted storage without replacing its master key
Retain the original secure master key when reopening an encrypted namespace. If it is absent, inventory ordinary records through the retained storage owner before first-use key admission. Existing records require the original key; return the native storage failure when inventory or key recovery fails. Generate an immutable first-use key only for an empty namespace. A concurrent wrapper may have published the original key during inventory, so reread that canonical key before rejecting an existing namespace. Preserve ciphertext and avoid publishing new records on recovery failure. Actual owned-provider regressions cover missing and corrupt keys and independent wrappers sharing the admitted key.
Ordering shared physical observations
Use the shared timeout owner's asynchronous observation lease around a required physical read, budget update, and checkpoint acknowledgment. Release the lease before awaiting the operation or timer. Runtime remaining/child/ACK paths and bounded-execution initial and completion paths must use the same gate. Do not nest lease acquisition by calling another observing helper while holding it. Test a provider that captures an earlier timestamp then suspends: a cloned child must wait before querying, and cancelling the suspended observer must release the gate without moving the deadline.
Held enrollment roster inputs
Obtain prepare_authenticated_enrollment_rotation from the actual effect owner and transferred setup before deriving the enrollment ceremony. Use its read-only roster/prestate accessors for packaging, then consume that same plan in prepare_pinned_enrollment_rotation. Preserve generation → tree lock order and keep the returned reservation through manifest retention and canonical registration. Do not acquire either gate recursively or rebuild an issuer participant from an absent tree leaf. Original cleanup recovery uses its negative custody path; live recovery additionally checks the fresh authenticated decision and original clock.
Choosing secure publication
Use secure_create_mutable for the first allocation of records that an existing domain owner must later checkpoint. Check Created versus AlreadyExists and validate retained original state; an existing result does not mean caller bytes match. Use secure_store_immutable for first decisions and durable evidence that must not be overwritten or deleted by generic storage calls. Sealing an existing legacy record preserves its original payload. See the effect contract for publication and protection guarantees.
For enrollment mailbox retirement, keep the original verified issuer return
registration as a move-only owner with its complete signed registration and
exact accepted domain-separated transcript bytes. A statement or reserialized
signature copied out of that owner is evidence to reverify, not birth authority.
The current L3 V3 writer is private: do not expose its raw
descriptor, location, expiry or verifier closure to L6. The next writer packet
must first move the independently admitted baseline/setup verifier and its
private-field proof to a layer the selected provider can consume, or define a
single constrained L6 transaction whose L3 atomic publication method accepts
only an unforgeable provider-bound proof. Rust crate visibility cannot grant
aura-agent friend access to a private aura-effects writer. A public core
constructor, externally implementable proof trait, feature-gated raw writer,
or caller-supplied closure would reopen forgeable birth authority.
For a lower-layer implementation, migrate the admitted-original checks now in
crates/aura-invitation/src/enrollment_mailbox.rs together with the independently
approved baseline and setup-verifier origins now in
crates/aura-invitation/src/enrollment_manifest.rs and
crates/aura-invitation/src/enrollment_setup.rs. The destination must be at or below the selected
provider's dependency boundary and expose a private-field, non-deserializable,
move-only verified proof. crates/aura-effects/src/secure.rs may then consume only
that proof under its existing record_gate, derive the signed expiry and exact
registration bytes itself, and atomically publish the V3 value. The L6
crates/aura-agent/src/runtime_bridge/enrollment_issuance.rs callsite would transfer the proof,
selected provider and value without naming a birth location or deadline. Until
those proof origins migrate, leave publish_retirement_birth private and L6
unwired. A higher-layer alternative needs a new narrowly owned storage
transaction that internalizes the L3 gate; exposing a generic exact-CAS or
delete effect is not that transaction.
The writer fixture must attempt external proof construction, deserialization and cloning; foreign selected provider, altered signed bytes, caller-selected expiry/location, and birth after a legacy immutable publication. A genuine signed issuer registration must publish its V3 descriptor and payload under one record gate, with exact replay/readback after interruption. Credential and setup records are published earlier and need their own original birth policy; the later registration cannot authorize retroactive V3 metadata. Keep terminal-proof and browser retirement as separate acceptance steps.
Recover failed publication by retrieving and validating the actual original through the selected provider. Do not create replacement wrapping keys when prior encrypted records or provider allocation evidence exist. Treat an IndexedDB compare-and-swap conflict as a typed storage conflict; the domain owner decides a bounded recovery. Ordinary profile keys cannot address the infrastructure secure_store subtree, and ordinary clear does not remove secure evidence.
Required participant envelope recovery
Select the participant from the validated signing context. Decrypt retained envelopes using required wrapping-key reads; never call a create-on-absence helper from decryption. Creation belongs to encryption under its actual material owner: use atomic absent-only publication and reread the stored winner. Missing or corrupt active policy, key material, or envelope codecs must preserve their native causes; layout compatibility may use fallible existence checks but must not retry a different layout after an arbitrary read failure.
Required issuer signing context
Pass the sealed context selected by the actual local signing owner to required issuer-key readers. Initial issuance selects required active policy; later confirmation selects its original context through the retained issued-manifest owner while holding current membership custody. Do not search historical epochs or derive participant identity from encrypted envelope metadata. Revalidate explicit layout presence before selecting a same-context compatibility row, and preserve read/decode/decryption causes.
Bounding enrollment caller futures
Use lexical Box::pin delegates at enrollment facade, whole-window selection,
VM attempt and notice boundaries when nested futures exceed the caller budget.
Keep the same capability, references, registered task and original time window;
allocation does not grant another execution owner. The normal-stack actual
enrollment fixture checks issuer and invitee caller futures against a 16 KiB
budget. Do not replace that regression with an increased executor stack size.
Required VM disposal regression lane
Run just ci-vm-session-lifecycle after changing a VM backend, targeted session
close/reap, coroutine index ownership, worker acknowledgment or forced-drop
custody. just ci-ownership-policy includes the same lane. The Rust inventory
checks actual nonignored test declarations and published harness names before
running the dependency and runtime suites in sequence. A renamed, absent,
feature-excluded or ignored required fixture fails instead of producing a
successful zero-test result.
The dependency tests exercise targeted removal, same-role surviving sessions, new-session dispatch, genuine scoped worker acknowledgment, actual poison and epoch faults, natural terminal epoch preservation and cooperative deserialization index continuity. Runtime tests exercise both real backends, original error source chains, exact forced-drop owner retirement, stale-owner rejection and cleanup before supervisor idle publication.
The dependency override is outside the workspace. This lane invokes its actual manifest with the multi-thread feature and shares the selected target directory with runtime validation. It does not run competing builds. Keep its original release provenance and license together with the patch record; update Cargo/Nix pins when replacing the override. Disposal acknowledgment is local cleanup; signed protocol outcome and remote delivery retain their separate owners.
Recovering a negative enrollment notification
Use the existing post-bootstrap registration recovery owner. Retire the failed pending signing generation, then pass its independently retained issued control to the tracker's Cancelled-only notice producer. Transfer that sealed owner into the existing invitation-service task group. Keep required lookup bounded by the local ingress window and actual signing/delivery bounded by the original retained window intersected with signed manifest validity. A local ingress timeout cannot renew original signing eligibility. Propagate required lookup, checkpoint, signer, transport and teardown failures to the task supervisor. Do not replace the already retained Cancelled first decision when its notification fails or expires.
Implementing allocation lifetime providers
Keep the selected physical-profile handoff separate from ordinary secure storage.
Use bounded authenticated records, atomic publication and required directory or
transaction acknowledgment. Keep pending original birth material until its
handoff is acknowledged; recover that exact pending birth instead of generating
a replacement. Record a final handoff phase before returning custody so an empty
previously transferred profile cannot be mistaken for interrupted initialization.
Use original backend objects for decisions and retirement, and retain real
failure sources. See docs/100_crypto.md and docs/103_effect_system.md.
Allocation lifetime provider ownership
Selected allocation lifetime factories and provider identities originate only from the actual exclusive physical profile owner. Native crypto retirement requires the held original negative decision capability; positive sealing requires the original activation capability. A serialized allocation locator is observation, never recovery or retirement authority. Trusted custom effect implementations are an explicit provider boundary.
Run just _policy-check check security-boundary-policy before broader CI when
changing these seams. Its Rust syntax check covers factory references, UFCS
aliases and macro tokens, while private constructors, declaration attributes
and compile-fail guards enforce actual capability custody. Keep immutable
legacy secrets permanent; allocation tombstone ACK is not a physical or backup
erasure guarantee.
Adding platform credential-store lifetime custody
Treat this as a new selected-provider implementation, not an adapter around the
filesystem fallback. The current native lifetime channel admits only the
profile-owned filesystem fallback; platform selection must continue to return
typed UnsupportedSelectedProvider until its own custody and recovery path is
validated. Do not enable a production enrollment flow by substituting that
fallback or copying protected bytes into a second provider.
Build the platform path in reviewable dependencies:
- Bind one credential namespace to the original exclusive
OwnedProfileLease. Carry its private provider identity into the lifetime root. The namespace lock must exclude cooperating profile processes across initialization, recovery, birth, decision and retirement; a service name or serialized profile path is insufficient authority. Refuse a foreign lease or namespace, a second root transfer, and any unsupported platform without a fallback. - Define a versioned, bounded authenticated inventory of allocation IDs,
immutable scopes, record digests and transition phases. Its authentication
key or equivalent trust anchor must remain in the selected credential
namespace; files may carry routing metadata but cannot hold copied live
secrets or independently authorize a record. Authenticate the complete
inventory and enforce count, depth and byte limits before returning any
owner. Missing trust anchor with existing inventory, malformed entries,
conflicting identities and an unexplained credential fail closed. Preserve
a separate completed-handoff marker so lost inventory is not read as an
empty new profile.
The private two-birth native V7 dependency retains each bounded scope inside
the selected keyring's authenticated root before writing its birth
credential. Recovery compares that scope with the sealed intent while it
exists; after erasure, the root remains the authenticated scope source.
V5 roots lack retained scopes; V6 roots lack the V7 birth-roster layout. Both fail closed pending a proved migration.
The private native adapter retains the original selected profile lease while
reconciling empty, one-birth, and two-birth states. It returns owners only
for the original authenticated V7 scopes and refuses a third birth with a
typed capacity cause. Keep this channel unselected in L6 until capacity,
host handoff, and native credential-service evidence are complete.
The runtime contract admits up to 4096 original profile allocations; this
two-birth adapter cannot yet satisfy it. Native platform handoff therefore
keeps the typed
UnsupportedSelectedProviderrefusal before transferring its root or mutating protected birth state. The exact effects host fixture checks that refusal and same-profile reopen. Extend the authenticated roster before attempting L6 selection; the test keyring fixture is separate from actual OS credential-service durability. The private V8 root now anchors a third birth's original identity, sealed intent and candidate three-entry roster before writing its selected credential. Recovery verifies the prior two-entry ACK and only the exact third intent, record and ACK. V7 roots fail closed without migration. This writer grants no third allocation owner: the selected L6 channel and two-entry actor capacity refusal remain in force until per-entry transitions, owner handoff and the full 4096-entry contract are proved. The private V13 root keeps a reusable authenticated tail-append slot. For the first transition, it anchors the exact four-entry target roster and sealed fourth intent before publishing a new selected credential. Recover only that original intent and immutable ACK under the same profile and namespace leases; refuse stale three-entry owners after a tail claim. Its first append accepts count three to four. The original four-entry owner and selected namespace lease also authenticate the fourth decision, AEAD-sealed negative-denial tombstone, and readback-verified erasure of its selected credential and sealed intent. Interrupted transitions replay only root-anchored evidence; the roster marker retains the fourth scope after erasure. V11 roots fail closed without migration. The private generic ledger authenticates the settled fourth scope and decision/denial/erasure proof through a root-bound manifest of immutable, at-most-64-entry pages. It anchors each fifth-through-4096 birth's sealed intent and exact target manifest before selected credential publication, then publishes only the changed page or split pages. A live append authenticates every existing selected credential once before its first write and reuses that exact in-lock roster through publication; it does not cache authority across transactions. Reopen validates every page digest, original record and scope before one owner transfer. A later manifest refuses a completed root rollback. V13 addresses immutable manifests and changed pages by an authenticated monotonic revision, independent of allocation count. Under the original lease and selected namespace lock, exact generic decisions, AEAD-sealed negative denial, and readback-verified original-credential erasure advance that revision. A pending root authenticates each target before provider mutation; reopen completes only the exact anchored change and refuses missing or changed terminal evidence. V12 roots fail closed without migration. An exact selected-provider workload now proves 4096 births, same-profile recovery with page-boundary readbacks, and typed refusal of birth 4097. On the measured host, birth took about 31 minutes, with prior-credential verification dominating; fixture cleanup extended the test to about 49 minutes. This cost needs further work before runtime selection. L6 selection and OS credential-service durability proof remain open. The private V9 root extends this original custody through a three-entry owner handoff, exact third decision, authenticated negative tombstone and provider-owned third credential erasure. Recover the retained third scope from its root-authenticated roster after erasure, while refusing missing terminal markers or changed selected credentials. V8 roots fail closed without migration. This private three-entry evidence does not enable L6 selection or satisfy the 4096-entry runtime contract. - Specify an acknowledged transaction across the credential store and the inventory for each transition. A durable intent must name the exact allocation and desired phase before a credential write. Read and verify the selected provider's resulting record before final inventory acknowledgment. Recovery must classify every intent as not started, provider written but unacknowledged, or fully acknowledged using authenticated evidence; it must either complete that same transition or retain a typed conflict. The credential API supplies no cross-store CAS or enumeration, so an inventory entry must precede every credential birth and cover interrupted writes. Directory fsync alone does not acknowledge a credential write; require the selected platform's documented persistence result and readback.
- Keep first-decision and retirement records in the provider's protected state. Under the namespace lock, compare against the original first decision before any replacement. A negative tombstone must remain recoverable after live secret removal; deleting the only credential entry is not an ACK. Zeroize decoded secret buffers and preserve original native keyring, inventory, codec and I/O causes.
Before L6 selects this channel, run one exact native provider fixture inventory with a fault at every transaction boundary. The required assertions are:
| Boundary / adversary | Required result |
|---|---|
| Fresh namespace, same selected profile and provider | One birth, exact live read and same-profile reopen; one root transfer |
| Foreign profile lease, namespace or provider; second transfer | Typed refusal before protected mutation |
| Birth intent before credential write; credential write before inventory ACK | Reopen either completes the same authenticated birth or retains a typed conflict; no replacement ID or unindexed live secret |
| Missing, corrupt, oversized, duplicated or reordered inventory; missing trust anchor or completed-handoff evidence | Whole-profile recovery refusal before any owner is returned |
| Credential absence, denied access and provider outage | Distinct typed causes; no fresh-profile inference from outage |
| Opposite or byte-different first decision; replay of exact first decision | Conflict for substitution; idempotent exact replay |
| Decision intent/write/ACK interruption; retirement intent/tombstone/ACK interruption | Reopen preserves the original first decision and reconciles the exact tombstone; no live read after acknowledged retirement |
| Wrong allocation scope or record bytes, stale namespace identity, unexpected credential | Typed refusal without selecting another provider or deleting evidence |
| First writer and concurrent contender under one namespace | Exactly one acknowledged transition; contender observes the authentic winner or typed conflict |
Use the test keyring for deterministic transaction faults, then run a separate
native credential-provider lane on the actual OS service. Test-keyring success
does not establish macOS Keychain or another OS provider's durability semantics.
On macOS, Aura's pinned keyring adapter selects the User/login Keychain and
cannot name an explicit temporary keychain. Before any OS-provider diagnostic,
run scripts/dev/os-keychain-preflight.sh --preflight from a separately
provisioned OS account. An administrator must install the root-owned,
non-writable, non-symlink marker
/private/var/db/aura/keychain-diagnostic-identity with exactly two lines,
isolated_uid=<diagnostic UID> and developer_uid=<developer UID>; its parent
directories must also be root-owned and not group/other writable. The script
refuses a missing or unsafe marker, a developer-account match, or execution by
another UID. It never accesses Keychain and a passing preflight is no
durability proof. The separate os-keychain-diagnostic feature builds a native,
non-test aura-os-keychain-diagnostic binary. Under the isolated account, run
AURA_OS_KEYCHAIN_DIAGNOSTIC=isolated-account scripts/dev/run-os-keychain-diagnostic.sh --run <prebuilt-binary> <new-private-receipt-dir>.
The binary repeats the marker/UID preflight before constructing the selected
platform provider, retains one original profile lease, writes an ordinary
diagnostic item, reopens the same profile with a fresh lease, reads and deletes
that item, and emits only typed status/class JSON. The private receipt retains
the result, stderr and exit status. test-keyring and unit-test builds refuse
the positive lane. This is an opt-in diagnostic, not a production lifetime
root or a durability proof. Its real OS-service positive has not run on the
developer account; do not run it against a developer login Keychain.
Only after both the selected-provider fixture and security/ownership gates pass
should L6 transfer the platform lifetime root and the signed production native
enrollment fixture resume. Browser storage has its own provider and evidence.
Supplying custom runtime handlers
Complete AgentBuilder::custom() typestate with crypto, ordinary storage,
physical time, random and console handlers before building. Async and sync
construction retain those same shared providers. Ordinary storage is wrapped
by unified encrypted storage and cannot replace the secure profile owner. The
configured random handler must satisfy the trait's cryptographic entropy
contract; simulation mode does not substitute a different handler.
An explicit transport inventory is bounded to sixteen providers. Declaration
order selects the first established channel, otherwise the first provider,
before sending. A send failure does not try another provider or native route.
Receiving inspects configured providers in order and continues only on typed
NoMessage. Return NoMessage when there is no matching envelope; a blocking
provider can delay later entries. Required provider outages should retain a
concrete native cause. Use the L8 custom-provider regression harness to verify
actual dispatch, encrypted bytes, and source retention.
Bounded final clock observation
Use aura_core::time::timeout::acknowledge_with_timeout_budget after the actual
resource owner has acknowledged completion. Pass the original TimeoutBudget,
the selected PhysicalTimeEffects provider, the required checkpoint callback,
and a synchronous publication callback. The helper races the whole observation
lease/read/checkpoint against wait_until_physical_deadline, polls the endpoint
first when both are ready, and drops losing futures before returning. Publication
runs with the original observation guard held and has no following await.
Wrappers must forward absolute waits to their configured provider. A current
read followed by relative sleep, or a delay based on cached high-water, cannot
bound a stalled current read. Unsupported providers fail explicitly. Native
providers use cancellable timers; the manual provider waits for actual test
clock progress. Test delayed registration, blocked observation, hung reads,
checkpoint delay, native timer faults and same-poll late completion with
just _policy-check check absolute-time-observation.
Choreography Development Guide
This guide covers how to build distributed protocols using Aura's choreographic programming system. Use it when you need to coordinate multiple parties with session types, CRDTs, and multi-phase workflows.
For theoretical foundations, see MPST and Choreography. For operation categorization, see Operation Categories.
1. When to Use Choreography
Use choreographic protocols when:
- Multiple parties must coordinate (threshold signing, consensus, sync)
- Session guarantees matter (no deadlock, no message mismatch)
- You need formal verification of protocol correctness
Do not use choreography for:
- Single-party operations (use effect handlers)
- Simple request-response (use direct transport)
2. Protocol Development Pipeline
This pipeline applies to all Layer 4/5 choreographies and all Category C ceremonies.
Phase 1: Classification and Facts
Operation categories (A, B, C) are defined in Operation Categories. The category determines coordination requirements and affects protocol design choices (local vs. CRDT vs. ceremony).
Define fact types with schema versioning:
#![allow(unused)] fn main() { use aura_macros::ceremony_facts; #[ceremony_facts] pub enum InvitationFact { CeremonyInitiated { ceremony_id: CeremonyId, agreement_mode: Option<AgreementMode>, trace_id: Option<String>, timestamp_ms: u64, }, CeremonyCommitted { ceremony_id: CeremonyId, relationship_id: String, agreement_mode: Option<AgreementMode>, trace_id: Option<String>, timestamp_ms: u64, }, CeremonyAborted { ceremony_id: CeremonyId, reason: String, trace_id: Option<String>, timestamp_ms: u64, }, } }
The macro provides canonical ceremony_id() and ceremony_timestamp_ms() accessors.
Phase 2: Choreography Specification
Write the choreography in a .tell file:
#![allow(unused)] fn main() { use aura_macros::tell; tell! { #[namespace = "secure_request"] protocol SecureRequest { roles: Client, Server; Client[guard_capability = "chat:message:send", flow_cost = 50] -> Server: SendRequest(RequestData); Server[guard_capability = "chat:message:send", flow_cost = 30, journal_facts = "response_sent"] -> Client: SendResponse(ResponseData); } } }
Annotation syntax: Role[guard_capability = "namespace:capability", flow_cost = N, journal_facts = "..."] -> Target: Message
guard_capability is the one sanctioned raw-string boundary for first-party
capability names in choreography source. The macro parses these values into
validated CapabilityNames and fails closed on invalid or legacy names. In
Rust code outside .tell or tell! inputs, prefer typed capability
families from the owning crate.
Canonical Telltale 10 Shape
Aura choreographies should converge on one source shape before theorem-pack rollout expands.
The canonical shape is:
- one
module ... exposing (...)header - one
protocol ... =declaration - one compact
roles ...declaration using scalar roles or role families likeDevices[N] - message edges whose semantics live in the protocol structure itself:
sequencing, fan-out, and
choice at ... - sanctioned Aura edge metadata only where it still represents real policy or
accounting at the source boundary:
guard_capabilityflow_costjournal_factsleakparallel - no choreography-local ownership or migration scaffolding that should instead live in Telltale runtime admission, runtime transition artifacts, or Aura's Rust-side protocol/runtime glue
Use crates/aura-sync/src/protocols/ota_activation.tell and crates/aura-sync/src/protocols/device_epoch_rotation.tell as the current style references.
Legacy-Only Source Surfaces To Remove
The following source patterns are migration debt and should disappear from
first-party .tell files:
link = "bundle=...|exports=...|imports=..."when it is only preserving historical migration lore rather than declaring a live runtime fragment bundle consumed by reconfiguration or ownership code- choreography comments whose only purpose is to preserve pre-Telltale runtime bundle/link ownership lore
journal_merge = trueas a choreography-local escape hatchleakage_budget = "..."tuple syntax- repeated phase comments that restate obvious linear protocol structure rather than documenting a real protocol invariant
These semantics should not remain embedded in source once the runtime and admission layers own them explicitly.
Aura Annotations That Remain Valid On The Clean Surface
These annotations remain valid on the canonical surface because they still map to real Aura admission, accounting, or observation behavior:
guard_capabilityflow_costjournal_factsleakparallel
Later theorem-pack phases may add Telltale-native theorem-pack declarations and
requires clauses, but those are additive and should not bring back legacy
bundle or migration hints.
Semantics That Must Move Out Of Source Over Time
The following concerns should move out of comments or source-local hints and into proper Telltale 10 DSL/runtime constructs or Aura runtime glue:
- reconfiguration and runtime-upgrade bundle ownership
- fragment/link transfer semantics
- journal-merge behavior that is really runtime transition behavior
- recovery or membership handoff lore expressed only in comments
- admission/evidence requirements that should become theorem packs and runtime admission checks
2.1 Current Choreography Convergence Inventory
This inventory defines the target for each current .tell file while Aura
converges on the canonical Telltale 10 shape.
First-Party Protocols
- crates/aura-agent/src/handlers/sessions/coordination.tell:
already structurally close; remove phase-restating comments and the
legacy
journal_merge = truesource hint. - crates/aura-amp/src/choreography.tell: already structurally close; normalize onto the same compact source style and remove redundant “data transmission / acknowledgment” comments.
- crates/aura-authentication/src/dkd.tell: structurally close; remove phase-only comments and keep only sanctioned edge metadata.
- crates/aura-authentication/src/guardian_auth_relational.tell: structurally close; remove phase-only comments and keep the protocol free of source-local coordination lore.
- crates/aura-consensus/src/protocol/choreography.tell:
close to canonical shape; preserve
parallelandleak, but remove phase-restating comments and keep it theorem-pack-free until a later explicit decision. - crates/aura-invitation/src/protocol.device_enrollment.tell:
keep the live
device_migrationbundle contract, but remove surrounding migration comments and any pseudo-annotations that no longer have a runtime consumer. - crates/aura-invitation/src/protocol.guardian_invitation.tell: structurally close; remove phase-only comments and keep only sanctioned edge metadata.
- crates/aura-invitation/src/protocol.invitation_exchange.tell: structurally close; remove phase-only comments and keep the source minimal.
- crates/aura-recovery/src/guardian_ceremony.tell: add sanctioned Aura metadata where this protocol still requires it, normalize branch names and comments, and remove the bare legacy look.
- crates/aura-recovery/src/guardian_membership.tell:
keep the live
guardian_handoffbundle contract, but removeleakage_budget = ...,journal_merge = true, and the surrounding migration comments. - crates/aura-recovery/src/guardian_setup.tell:
remove
leakage_budget = ...andjournal_merge = true, and strip phase-restating comments. - crates/aura-recovery/src/recovery_protocol.tell: structurally close; remove phase-only comments and keep the source ready for later theorem-pack adoption only if the recovery semantics justify it.
- crates/aura-rendezvous/src/protocol.relayed_rendezvous.tell:
keep theorem-pack-free; normalize comments and preserve only real route-flow
metadata like
guard_capability,flow_cost, andleak. - crates/aura-rendezvous/src/protocol.rendezvous_exchange.tell: keep theorem-pack-free; normalize comments and preserve only real publication and connect metadata.
- crates/aura-sync/src/protocols/epochs.tell:
keep the live
epoch_rotation_transferbundle contract, but remove the surrounding migration comments and keep the rest of the protocol in the same compact shape as the OTA and device-epoch references.
Protocol-Compat Fixtures
- crates/aura-testkit/fixtures/protocol_compat/breaking_baseline.tell: already canonical; no migration needed beyond keeping fixture style minimal.
- crates/aura-testkit/fixtures/protocol_compat/breaking_current.tell: remove the explanatory inline comment so the compatibility edge is expressed only by the message-shape difference.
- crates/aura-testkit/fixtures/protocol_compat/compatible_baseline.tell: already canonical; keep unchanged except for style parity if needed.
- crates/aura-testkit/fixtures/protocol_compat/compatible_current.tell: already canonical; keep unchanged except for style parity if needed.
2.2 Theorem-Pack Taxonomy and Admission Policy
Aura should add theorem packs only where they drive a real runtime admission decision. They are not importance labels.
The first production protocols now using this boundary are
aura.sync.ota_activation and aura.sync.device_epoch_rotation. Both declare
the "AuraTransitionSafety" proof bundle, and Aura rejects launch before protocol start when the
runtime lacks the theorem-pack capability surface needed for transition
receipts, bridge admission, and reconfiguration safety.
Current Protocol Split
First-wave theorem-pack candidates:
aura.sync.ota_activationaura.sync.device_epoch_rotation
Second-wave theorem-pack candidates:
aura.recovery.grantaura.recovery.guardian_setupaura.recovery.guardian_ceremonyaura.recovery.guardian_membership_changeaura.invitation.device_enrollmentonce the recovery/finalization path is explicitly theorem-pack-gated end to end
Later explicit evaluation target:
aura.consensus
Current theorem-pack-free protocols:
aura.session.coordinationaura.amp.transportaura.dkg.ceremonyaura.authentication.guardian_auth_relationalaura.invitation.exchangeaura.invitation.guardianaura.rendezvous.exchangeaura.rendezvous.relayaura.sync.epoch_rotation
Current Aura Runtime Admission Surfaces
Aura already has a small runtime capability bridge and several concrete runtime consumers:
aura-core::effects::RuntimeCapabilityEffectsdefines the stable admission interface.aura-effects::RuntimeCapabilityHandlermaps startup runtime contracts into a capability inventory and public protocol-critical surfaces.aura-protocol::admissionmaps protocol ids to current required runtime capability keys.aura-agent::runtime::choreo_engineandaura-agent::runtime::choreography_adapterenforce required runtime capability admission before protocol launch.aura-agent::runtime::contractsandaura-agent::runtime::vm_hardeningalready validate runtime capability requirements for determinism and profile policy.aura-agent::runtime::services::threshold_signingandaura-agent::runtime::services::reconfiguration_manageralready consume protocol-critical runtime capability state on concrete execution paths.
The currently published public protocol-critical surfaces are:
runtime_admissiontheorem_pack_capabilitiesownership_capabilityreadiness_witnessauthoritative_readmaterialization_proofcanonical_handleownership_receiptsemantic_handoffreconfiguration_transition
These are the only current Aura-owned runtime consumers theorem-pack mapping is allowed to target.
Initial Aura Theorem-Pack Taxonomy
Aura should keep the first taxonomy small:
- "AuraTransitionSafety" used for OTA/runtime-upgrade/device-epoch flows that depend on transition safety, reconfiguration continuity, and bridge/admission correctness
- "AuraAuthorityEvidence" used for recovery/finalization flows that depend on authoritative read, canonical materialization, and receipt/evidence-backed transitions
- "AuraConsensusDeployment" reserved for a later explicit consensus decision; do not use until Aura has a concrete runtime consumer beyond the existing envelope capability checks
Pack-to-Capability Mapping
"AuraTransitionSafety":
- reuse Telltale inventory keys:
protocol_machine_envelope_adherence,protocol_machine_envelope_admission,protocol_envelope_bridge,reconfiguration_safety - current Aura runtime consumers:
theorem_pack_capabilities,ownership_receipt,semantic_handoff,reconfiguration_transition - concrete admission checks:
aura-agent::runtime::choreo_engine,aura-agent::runtime::choreography_adapter,aura-agent::runtime::services::reconfiguration_manager
"AuraAuthorityEvidence":
- reuse Telltale inventory keys:
protocol_machine_envelope_adherence,protocol_machine_envelope_admission,protocol_envelope_bridge - Aura-owned runtime capability names already backed by real consumers:
authoritative_read,materialization_proof,canonical_handle - concrete admission checks:
aura-agent::runtime::choreo_engine,aura-agent::runtime::contracts, recovery/guardian launch paths inaura-agent - current adopted production protocols:
aura.recovery.grant,aura.recovery.guardian_setup,aura.recovery.guardian_ceremony - current explicit non-goals in the recovery/invitation area:
aura.recovery.guardian_membership_change,aura.invitation.guardian,aura.invitation.device_enrollment
"AuraConsensusDeployment":
- candidate Telltale inventory keys:
consensus_envelope,atomic_broadcast_ordering,partial_synchrony_liveness - current status:
deferred until Aura adds a runtime admission consumer beyond
byzantine_envelope/ determinism profile checks - revisit only when: the consensus choreography itself owns authoritative admission or evidence branching for those guarantees, and Aura can fail closed on those exact choreography-level requirements instead of the current runtime-local consensus-profile checks
Aura-specific capability names are only allowed when they already have a real
runtime consumer. Today that means authoritative_read,
materialization_proof, and canonical_handle are allowed. New Aura-specific
theorem-pack keys should not be added until the corresponding runtime admission
check exists.
Explicit Non-Goals
The following protocol groups remain theorem-pack-free until they acquire a concrete control-plane admission or evidence need:
- rendezvous exchange and relayed rendezvous
- plain invitation exchange
- protocol-compat fixture choreographies
Symmetry is not a valid reason to add theorem packs to these flows.
Adaptive-Privacy Control Plane Only
Adaptive-privacy theorem-pack usage is reserved for control-plane protocols with
real admission, evidence, transition, or simulation semantics. It must not be
used for onion data-plane forwarding, per-hop Move envelopes, cover traffic,
or ordinary transport forwarding.
The current adaptive-privacy Telltale control-plane inventory is:
- "AnonymousPathEstablishProtocol"
- "MoveReceiptReplyBlockProtocol"
- "HoldDepositReplyBlockProtocol"
- "HoldRetrievalReplyBlockProtocol"
- "HoldAuditReplyBlockProtocol"
Bootstrap and stale-node re-entry remain runtime-local for now. They are still hint lookup and cache-refresh logic, not canonical multi-party admission/evidence protocols.
These adaptive-privacy control-plane protocols are intentionally theorem-pack-free today. Aura does not add a new theorem pack for them until a dedicated runtime-admission surface exists beyond ordinary protocol-machine admission and the current local control services are no longer the canonical executors.
Admission Boundary
Aura consumes theorem-pack metadata only through the generated
CompositionManifest boundary:
- generated manifests carry theorem-pack declarations
- generated manifests carry required theorem-pack names
- generated manifests carry the flattened required theorem-pack capability set
aura-protocol::admission is the single Aura-owned translation layer that maps
required theorem packs onto concrete runtime-admission requirements. That layer
must stay small and fail closed:
- a required theorem pack with no matching generated declaration is rejected
- a required theorem pack with no Aura admission policy is rejected
- a theorem-pack declaration whose declared capability set drifts from Aura's supported taxonomy is rejected
- runtime launch rejects missing required theorem-pack capability coverage before protocol execution begins
aura-agent::runtime::vm_host_bridge, aura-agent::runtime::choreo_engine,
and aura-agent::runtime::choreography_adapter consume that resolved boundary;
they do not invent parallel theorem-pack policy tables.
Acceptance Rule
A choreography may add theorem-pack requirements only when all of the following are true:
- the protocol depends on protocol-critical authority, evidence, or transition semantics
- the required pack maps to existing Telltale inventory keys or to an Aura-specific runtime capability with a real admission consumer
- Aura runtime admission fails closed before launch when that support is absent
- a negative test proves the missing-pack admission failure
- a positive test proves the protocol still runs when the support is present
If any of those conditions is missing, keep the choreography theorem-pack-free.
Migration Rule
When converting a choreography, prefer:
- deleting legacy source hints rather than renaming them
- moving ownership or transition semantics into Rust/runtime admission when they are not true choreography structure
- keeping theorem packs out until the protocol has a real runtime admission consumer
- matching the source compactness of the OTA and device-epoch references
Select the narrowest TimeStamp domain for each time field. See Effect System for time domains.
Phase 3: Runtime Wiring
Create the protocol implementation:
#![allow(unused)] fn main() { use aura_agent::runtime::open_manifest_vm_session_admitted; let (mut engine, handler, vm_sid) = open_manifest_vm_session_admitted( &my_protocol::COMPOSITION_MANIFEST, "Initiator", &my_protocol::global_type(), &my_protocol::local_types(), scheduler_signals, ).await?; let status = engine.run_to_completion(vm_sid)?; }
This wiring opens an admitted VM session from generated choreography metadata. The runtime source of truth is the composition manifest, not an ad hoc adapter. Register the service with the runtime and integrate it with the guard chain. Category C operations must follow the ceremony contract.
Production services should treat the admitted unit as a protocol fragment. If the manifest declares link bundles, each linked bundle becomes its own ownership unit. Runtime transfer must use ReconfigurationManager. Do not bypass fragment ownership through service-local state.
The runtime also derives execution mode from admitted policy. Cooperative protocols stay on the canonical VM path. Replay-deterministic and envelope-bounded protocols select the threaded path only through the admission and hardening surface. Service code should not construct ad hoc threaded runtimes.
Phase 4: Status and Testing
Implement CeremonyStatus for Category C or protocol-specific status views:
#![allow(unused)] fn main() { pub fn ceremony_status(facts: &[InvitationFact]) -> CeremonyStatus { // Reduce facts to current status } }
Definition of Done:
- Operation category declared (A/B/C)
- Facts defined with reducer and schema version
- Choreography specified with roles/messages documented
- Runtime wiring added (role runners + registration)
- Fragment ownership uses manifest admission and runtime ownership APIs
-
delegateandlinkflows useReconfigurationManager - Threaded or envelope-bounded execution uses admitted policy only
- Category C uses ceremony runner and emits standard facts
- Status output implemented
- Shared-bus integration test added
- Simulation test added
- Choreography parity/replay tests added (Category C)
See crates/aura-consensus/src/protocol/ for canonical examples.
3. CRDT Integration
CRDTs handle state consistency in choreographic protocols. See Journal for CRDT theory.
CRDT Coordinator
Use CrdtCoordinator to manage CRDT state in protocols:
#![allow(unused)] fn main() { use aura_protocol::effects::crdt::CrdtCoordinator; // State-based CRDT let coordinator = CrdtCoordinator::with_cv_state(authority_id, initial_journal); // Delta CRDT with compaction threshold let coordinator = CrdtCoordinator::with_delta_threshold(authority_id, 100); // Meet-semilattice for constraints let coordinator = CrdtCoordinator::with_mv_state(authority_id, capability_set); }
Protocol Integration
Protocols consume and return coordinators with updated state:
#![allow(unused)] fn main() { use aura_sync::choreography::anti_entropy::execute_as_requester; let (result, updated_coordinator) = execute_anti_entropy( authority_id, config, is_requester, &effect_system, coordinator, ).await?; let synchronized_state = updated_coordinator.cv_handler().get_state(); }
4. Protocol Composition
Complex applications require composing multiple protocols.
Sequential Composition
Chain protocols for multi-phase workflows:
#![allow(unused)] fn main() { pub async fn execute_authentication_flow( &self, target_device: aura_core::DeviceId, ) -> Result<AuthenticationResult, ProtocolError> { // Phase 1: Identity exchange let identity_result = self.execute_identity_exchange(target_device).await?; // Phase 2: Capability negotiation let capability_result = self.execute_capability_negotiation( target_device, &identity_result ).await?; // Phase 3: Session establishment let session_result = self.execute_session_establishment( target_device, &capability_result ).await?; Ok(AuthenticationResult { identity: identity_result, capabilities: capability_result, session: session_result, }) } }
Each phase uses results from previous phases. Failed phases abort the entire workflow.
Parallel Composition
Independent protocols can execute concurrently using try_join_all.
#![allow(unused)] fn main() { pub async fn execute_distributed_computation( &self, worker_devices: Vec<aura_core::DeviceId>, ) -> Result<ComputationResult, ProtocolError> { // Launch parallel worker protocols let worker_futures = worker_devices.iter().map(|device| { self.execute_worker_protocol(*device) }); // Wait for all workers with timeout let worker_results = tokio::time::timeout( self.config.worker_timeout, futures::future::try_join_all(worker_futures) ).await??; // Aggregate results self.aggregate_worker_results(worker_results).await } }
Worker futures launch in parallel and are joined with a timeout. Results are then aggregated into a single computation result.
Effect Program Composition
Protocols can also be composed through effect programs using a builder pattern.
#![allow(unused)] fn main() { let composed_protocol = Program::new() .ext(ValidateCapability { capability: "coordinate".into(), role: Coordinator }) .then(anti_entropy_program) .then(threshold_ceremony_program) .ext(LogEvent { event: "protocols_complete".into() }) .end(); }
The builder chains validation, protocol execution, and logging into a single composed program.
5. Error Handling and Resilience
Timeout and Retry
Implement timeout handling with exponential backoff.
#![allow(unused)] fn main() { pub async fn execute_with_resilience<T>( &self, protocol_fn: impl Fn() -> BoxFuture<'_, Result<T, ProtocolError>>, operation_name: &str, ) -> Result<T, ProtocolError> { let mut attempt = 0; while attempt < self.config.max_attempts { match tokio::time::timeout( self.config.operation_timeout, protocol_fn() ).await { Ok(Ok(result)) => return Ok(result), Ok(Err(e)) if !e.is_retryable() => return Err(e), _ => { // Exponential backoff with jitter let delay = self.config.base_delay * 2_u32.pow(attempt); tokio::time::sleep(self.add_jitter(delay)).await; attempt += 1; } } } Err(ProtocolError::MaxRetriesExceeded) } }
The function retries on transient errors with exponential backoff and jitter. Non-retryable errors fail immediately.
Compensation and Rollback
For multi-phase protocols, implement compensation for partial failures.
#![allow(unused)] fn main() { pub async fn execute_compensating_transaction( &self, operations: Vec<Operation>, ) -> Result<TransactionResult, TransactionError> { let mut completed = Vec::new(); for operation in &operations { match self.execute_operation(operation).await { Ok(result) => { completed.push((operation.clone(), result)); } Err(e) => { // Compensate in reverse order self.execute_compensation(&completed).await?; return Err(TransactionError::OperationFailed { operation: operation.clone(), cause: e, }); } } } Ok(TransactionResult { completed }) } }
On failure, completed operations are compensated in reverse order. This ensures partial state is cleaned up before the error is returned.
Circuit Breakers
Circuit breakers prevent cascading failures by tracking error rates.
#![allow(unused)] fn main() { pub enum CircuitState { Closed { failure_count: usize }, Open { opened_at: Instant }, HalfOpen { test_requests: usize }, } pub async fn execute_with_circuit_breaker<T>( &self, protocol_fn: impl Fn() -> BoxFuture<'_, Result<T, ProtocolError>>, ) -> Result<T, ProtocolError> { let should_execute = match &*self.circuit_state.lock() { CircuitState::Closed { failure_count } => *failure_count < self.config.failure_threshold, CircuitState::Open { opened_at } => opened_at.elapsed() >= self.config.recovery_timeout, CircuitState::HalfOpen { test_requests } => *test_requests < self.config.test_threshold, }; if !should_execute { return Err(ProtocolError::CircuitBreakerOpen); } match protocol_fn().await { Ok(result) => { self.record_success(); Ok(result) } Err(e) => { self.record_failure(); Err(e) } } } }
The breaker transitions through closed, open, and half-open states based on failure thresholds and recovery timeouts.
6. Guard Chain Integration
The guard chain specification is defined in Authorization. See System Internals Guide for the three-phase implementation pattern.
When integrating guards into choreographies, use the annotation syntax on choreography messages. The annotations compile to guard chain commands that execute before transport sends:
guard_capability: Creates capability check before sendflow_cost: Charges flow budgetjournal_facts: Records facts after successful sendleak: Records leakage budget charge
Snapshot builders must not treat declared choreography guard names as already
granted. They evaluate typed candidate sets against the current Biscuit/policy
frontier and publish only the admitted frontier into the GuardSnapshot.
7. Domain Service Pattern
Domain crates define stateless handlers. The agent layer wraps them with services.
Domain Handler
#![allow(unused)] fn main() { // In domain crate (e.g., aura-chat/src/service.rs) pub struct ChatHandler; impl ChatHandler { pub async fn send_message<E>( &self, effects: &E, channel_id: ChannelId, content: String, ) -> Result<MessageId> where E: StorageEffects + RandomEffects + PhysicalTimeEffects { let message_id = effects.random_uuid().await; // ... domain logic Ok(message_id) } } }
Agent Service Wrapper
#![allow(unused)] fn main() { // In aura-agent/src/handlers/chat_service.rs pub struct ChatService { handler: ChatHandler, effects: Arc<RwLock<AuraEffectSystem>>, } impl ChatService { pub async fn send_message( &self, channel_id: ChannelId, content: String, ) -> AgentResult<MessageId> { let effects = self.effects.read().await; self.handler.send_message(&*effects, channel_id, content) .await .map_err(Into::into) } } }
This keeps the domain crate pure without Tokio-specific locking or runtime coupling. It is testable with mock effects and consistent across crates.
8. Testing Choreographies
Unit Testing Guard Logic
#![allow(unused)] fn main() { #[test] fn test_cap_guard_denies_unauthorized() { let snapshot = GuardSnapshot { capabilities: vec![], flow_budget: FlowBudget { limit: 100, spent: 0, epoch: 0 }, ..Default::default() }; let result = CapGuard::evaluate(&snapshot, &SendRequest::default()); assert!(result.is_err()); } }
Integration Testing Protocols
#![allow(unused)] fn main() { #[aura_test] async fn test_sync_protocol() -> aura_core::AuraResult<()> { let fixture = create_test_fixture().await?; let coordinator = CrdtCoordinator::with_cv_state( fixture.authority_id(), fixture.initial_journal(), ); let (result, _) = execute_anti_entropy( fixture.authority_id(), SyncConfig::default(), true, // is_requester &fixture.effects(), coordinator, ).await?; assert!(result.is_success()); Ok(()) } }
Simulation Testing
See Simulation Guide for fault injection and adversarial testing.
Related Documentation
- MPST and Choreography - Session type theory
- Operation Categories - Category A/B/C classification
- Authorization - Guard chain specification
- Journal - CRDT and fact semantics
- Testing Guide - Test patterns
- Simulation Guide - Fault injection testing
Changing enrollment response messages
When changing the enrollment response wire shape, update the choreography message declaration, generated wrapper imports, runtime codec consumers, and both role owners together. Acceptance and refusal must be exercised with actual independently pinned runtime signatures. Test that relabeling either signed response as the other disposition fails without moving the VM or changing the terminal owner. Test two connected runtimes through the public decline surface and verify the durable failed readout cannot be loaded as an adoption receipt.
Retain the original window across retries. Classify transient sends from the native VM bridge and transport variants, including the expected destination and message phase. Flattened diagnostic text must never authorize retry. Close the owned session on every attempted path and preserve secondary cleanup errors; an unsuccessful close is not a transport retry opportunity.
Testing Guide
Browser onboarding regressions must check guarded signal writes after async enrollment workflows, including identity persistence failures. Completion and error feedback use the browser retry helper; task spawning remains owned by the shared web task owner.
For runtime tests that manually advance physical time, inject
aura_testkit::time::ManualPhysicalClock before service assembly. Its sleeps wait
for explicit clock advancement, so background cleanup loops cannot consume the
ceremony lifetime by advancing time themselves. Retain the same provider across
participants where the scenario requires one physical clock; restart tests must
also retain original durable window evidence. Use real held ownership capabilities
for persistent enrollment fixtures rather than constructing raw registration state.
To isolate a transient required-read rollback, call
ManualPhysicalClock::script_next_observation(at_ms) on the already selected
provider at the owned fixture boundary. The next actual physical_time read
consumes that sample once; subsequent reads use the unchanged base clock. An
occupied or borrowed override slot is a typed failure. The sample neither
advances the clock nor changes or wakes the original absolute deadline waiter.
Use explicit set_time for global clock movement and fail_next_sleep for an
actual selected-provider timer failure, and retain those separate regressions.
Assert the required read actually consumed the sample and that original budget
refusal survives later forward time. Keep the same provider and budget through
the operation; scripting a source observation grants no checkpoint ACK, cleanup
authority or new completion semantics.
Multi-agent runtime tests (several AgentBuilder runtimes on one
SharedTransport) share one aura_testkit::time::QuiescentClock, injected with
AgentBuilder::with_physical_time_provider, and run under
#[tokio::test(start_paused = true)]. The clock advances in small virtual
steps only when every task is idle, so runtime timeouts, retries and periodic
sync fire at the same logical point regardless of host load. Bound waits in
virtual time and re-check conditions at quiescent points (see
crates/aura-agent/tests/support); never wait on wall-clock sleeps.
Checkpoint and final network validation
Before a batch, declare the source revision, package/features, production compile
command, exact test binary/filter, expected fixture names/count and required
gates. Discover fixtures before execution; zero matches or ignored required
fixtures fail the checkpoint. Use --features signals for messaging coverage.
Run narrow checks first and retain receipts only while their dependency scope
remains unchanged. Report state changes with compile result, discovered and
executed tests, blocker, remaining gates and next action.
During implementation, use narrow production compiles and exact deterministic regressions, reusing their compiled binaries while the source and feature scope remain valid. Reserve full-project test suites, broad ownership aggregates and Clippy for a reviewable integration batch. Run those required checks together on the resulting checkpoint, followed by main smoke; a small fixture correction does not require restarting every broad lane. Record deferred gates explicitly and require their results before declaring the batch complete.
When implementation and its required validation are complete and only documentation remains, assign a subagent the bounded documentation closeout. It may work in the main checkout on agreed documentation paths while other work continues. Review the resulting documentation, integrate it, and close the task using the existing implementation and validation evidence. Prose-only changes do not require rerunning builds or tests. This does not waive pending runtime, platform or cross-machine acceptance requirements. Keep the closeout record under that task's Work log. Before checking a parent task, verify every child acceptance task is complete; keep the parent open if any child is incomplete or unverified.
Follow the simulation validation sequence: component checks, complete runtime/app execution in-process, applicable local frontend conformance, checkpoint gates/main smoke, then batched cross-machine confirmation. A missing in-process stage calls for reusable fixture work before network escalation. Keep real platform behavior in its local conformance lane.
For final P2P confirmation, declare the locally proven flows and remaining network/process boundaries, ship the exact clean revision once and run prebuilt artifacts on both hosts. Record per-flow results and independent shutdown acknowledgments. A known local blocker does not justify another unchanged Air run. Reproduce integration failures deterministically where possible before the next confirmation batch.
Keep a per-flow lifecycle inventory using the simulation outcome checklist. Attach actual compile, discovery and execution receipts to the stages they cover. A missing fixture is implementation work with a named blocking task; a broad E2E pass cannot stand in for unexecuted deterministic failure or cancellation cases.
Final P2P batch manifest
Prepare one manifest after the affected local checks and main smoke pass. Record the clean commit, prebuilt artifact identities, locally proven flow names, remaining transport/discovery/process assertions, and independent shutdown acknowledgments for both hosts. Record failures per flow and preserve unaffected receipts. Reproduce a failure in-process where possible before the next batch; a known local failure is a blocker rather than a reason to repeat Air execution.
AMP lifecycle replay
The leave action drives the native runtime key ceremony and member consensus through the simulation factory's bounded, lexically owned peer drivers. Members must agree on canonical membership and epoch before the attempt. Each member verifies the resulting epoch commit against its own DKG group key before retaining the agreement evidence. The replay rereads that exact evidence from each member's canonical typed-fact store and checks identical successor base keys for remaining members and no successor key for Carol. This covers membership rekeying; the later observational transition-policy steps still do not establish native normal/emergency finalization. An adjacent regression enforces a 16 KiB caller-future budget for membership rekeying, alongside execution on the default test stack.
just ci-test first runs just ci-amp-lifecycle-trace, which regenerates the
seed-424242, 24-step AMP harness trace and compares it with
verification/quint/traces/amp_channel.itf.json. The workspace test lane runs
amp_channel_itf::replay_amp_channel_lifecycle_trace against real simulation
agents for steps 1–14. Steps 15–24 use a private simulator-only observational
transition-policy adapter: original scope binding, model phase sequencing,
single-live-successor, conflict suppression and emergency policy invariants.
These steps publish no native certificate/finalization facts, mint no signatures
or consensus IDs, and prove neither cryptographic admission nor physical
cryptoshred. Actual A2 witness issuance and owned A3 committee coverage remain
unfinished in work/8.md (systemic S tasks). Missing artifacts and replay failures fail the test; they cannot skip
execution. Each fixture agent must complete native threshold-service authority
bootstrap before replay, retaining its protected genesis, active epoch and
physical signing allocation. Do not replace that setup with channel bootstrap
metadata or raw seeded epoch/key records. The full replay then checks actual
invitation issuance and acceptance. Join delivery must retain the actual source
producer's membership entries and the original channel checkpoint required by
canonical reduction, with exact context/channel selection and original entry
keys, order and payload. The source actor alone produces a departure; peers
replicate that original Left event and acknowledge absence. Missing evidence or
failed canonical acknowledgment must fail the replay; final membership assertions
must not repair state. Schema-one reduction tests must invert opaque tokens,
insertion and journal merge order, reject unversioned rejoin and all-departed
sender bypass, and preserve original clock failure with no append. Selected
transition commitments are not successor roster/inclusion evidence; that owned
witness remains an explicit unfinished task in work/8.md (systemic S tasks). To regenerate
the fixture, run:
QUINT_TRACE_MAIN=harness_amp_channel QUINT_TRACE_MAX_STEPS=24 scripts/verify/quint-trace.sh generate verification/quint/harness/amp_channel.qnt verification/quint/traces/amp_channel.itf.json
This guide covers how to write tests for Aura protocols using the testing infrastructure. It includes unit testing, integration testing, property-based testing, conformance testing, and runtime harness validation.
For infrastructure details, see Test Infrastructure Reference. For the deterministic shared-flow design rules, see User Flow Harness.
1. Core Philosophy
Aura tests follow four principles. Tests use effect traits and never call direct impure functions. Tests run actual protocol logic through real handlers. Tests produce reproducible results through deterministic configuration. Tests validate both happy paths and error conditions.
Parity-critical ownership work also requires compile-fail coverage for ownership and capability boundaries enforced in types. This includes forbidden capability construction paths such as CapabilityId::from("...") or invalid capability_name!(...) literals. It also includes invariant tests for owner drop, stale-handle rejection, and terminality. Timeout and backoff tests should prove typed timeout failure, remaining-budget propagation, and bounded retries.
Run the relevant ownership just ci-* policy checks alongside crate tests. Run just lint-arch-syntax when changing capability parsing boundaries, typed capability-family usage, or choreography capability admission rules.
Harness Policy
The primary development loop for runtime and app workflows is deterministic in-process execution of the real implementation. Extend reusable simulator/testkit fixtures when a required lifecycle stage is missing. Model-only transitions, seeded projections and fabricated acknowledgments cannot stand in for real protocol, persistence or cleanup outcomes.
The runtime harness supplies frontend integration and final E2E evidence. Its shared semantic lane executes parity-critical shared flows through the shared semantic command plane and waits on typed handles, readiness facts, runtime events, quiescence and authoritative projections. Runtime/app failures should first be reproduced in-process wherever the affected boundary supports it.
The frontend-conformance lane validates renderer-specific control wiring, DOM structure, PTY key mappings, and shell-level integration. It may use renderer-specific mechanics intentionally. It must not be the primary execution substrate for shared scenarios.
Quint and other verification tools generate models, traces, and invariants. They are not a replacement for real frontends.
aura-app owns shared semantic scenario, command-plane and UI contracts. aura-harness consumes them and submits commands to real frontends; aura-simulator supplies controlled runtime execution. Share actions and expected outcomes without creating a second frontend executor or parallel protocol implementation.
Validation order and evidence
- Compile the smallest coherent production slice and run focused component tests.
- Execute the complete runtime/app flow in-process with real protocol and crypto, controlled transport, selected virtual time, required persistence, original terminal ownership, disposal and same-profile restart.
- Run local frontend conformance for actual browser/TUI input, renderer, subscriptions and platform storage. Real local browser tests remain necessary for browser-specific boundaries.
- Run required checkpoint policy gates, integrate and obtain a green main smoke.
- Confirm a declared batch of E2E flows across machines using prebuilt identical revisions. Air does not build, and a LAN run need not remain continuously active.
Declare package, features, test binary/filter and expected discovered fixtures before each batch. Actual discovery and successful nonignored execution are both required. Preserve valid receipts for unchanged scopes; rerun scopes affected by a changed dependency. Keep one active vertical integration batch per worktree and compile before expanding adjacent functionality. The two-worktree and external build setup stay unchanged.
Run the canonical fixed-commit smoke with bash scripts/ci/main-smoke.sh from
a clean checkout. It executes the six declared Clippy, web, app, UI, agent and
terminal commands through separate guarded handoff-smoke lifetimes. The owner
keeps protected output and build receipts for each attempt. Repeating it on the
same clean revision reuses only passed steps whose exact command, selected
tool bytes, build and provider selectors, output hashes and keyring cleanup
still match. A failed or refused step has no complete-smoke marker; resume
starts at that step while retaining its first protected failure log. Each
executed step receives a private empty test keyring, removed after its owned
process finishes. This replaces the ignored work/handoff/smoke.sh runner.
bash scripts/ci/main-smoke.sh --verify is the preflight contract: LAN
helpers require it instead of trusting the commit string in
.tmp/main-smoke-<commit>/validated-commit. Step receipts prove execution of
the six commands, not durability of external native profiles or provenance of
shipped binaries. The LAN ship's artifact hashes and web prebuilt provenance
remain separate required checks.
Reusable compile and web-build identities also bind Cargo configuration from
the actual working directory through checkout ancestors, including files
outside the repository. Adding, changing or removing an ancestor config
invalidates prior exact-input evidence; linked config paths refuse reuse.
Enrollment is the first reusable complete-flow fixture target. Extend canonical setup/export, explicit verifier transfer, issuer/receiver execution, app host-finalization, terminal publication, persistence and cleanup/reopen seams. Keep generic effect controls in testkit and runtime assembly in its sanctioned owner. Existing model-only AMP steps and incomplete fixture paths remain coverage gaps until real execution proves them.
Select the primary evidence using the coverage assignment matrix. When a reusable fixture cannot execute a required stage, record the missing seam and its dependent flow; extending that seam precedes repeated E2E attempts for the same local blocker.
Cross-machine runs establish real transport, discovery and process/platform integration. They should batch locally proven flows after the required gates and smoke. A network-specific investigation may use a targeted real-network test, but record the boundary that requires it and turn reproducible logic failures into deterministic regressions. Retain revision, seeds, exact test inventory, typed action/operation/owner, selected provider/endpoint, fault boundary and first failure in evidence. Detailed workflow: Simulation Guide.
User-facing docs and harness guidance must not point readers at scratch-note or ephemeral local-output paths. Describe outputs in terms of the stable harness artifact bundle, scenario reports, and configured run outputs rather than repo-local scratch directories.
Use this lane matrix when selecting harness mode.
| Lane | Backend | Command |
|---|---|---|
| Local deterministic | mock | just harness-run -- --config configs/harness/local-loopback.toml --scenario scenarios/harness/real-runtime-mixed-startup-smoke.toml |
| Patchbay relay realism | patchbay | just harness-run -- --config configs/harness/local-loopback.toml --scenario scenarios/harness/real-runtime-mixed-startup-smoke.toml --network-backend patchbay |
| Browser | Playwright | just harness-run-browser scenarios/harness/semantic-observation-browser-smoke.toml |
All shared flows should use typed scenario primitives, typed semantic command submission, and structured snapshot and readiness waits.
LAN automation uses the same command plane through the tool REPL's
submit_semantic_command request. Its typed IntentAction constructs one
canonical request on the server; the response retains the original receipt
and shared action contract. Follow that contract's submission kind: required
operation handles must match the exact operation and instance through terminal
success, failure, or cancellation. Immediate account creation instead requires
the reloaded shell's Neighborhood screen and Ready state; a pre-reload handle
does not prove that outcome.
wait_for_ui_snapshot_event carries the backend event version as
after_version, independently of the snapshot's projection revision. Advance
that cursor while preserving the original observation deadline. A null event
is an observation timeout, never success. Command acceptance, diagnostic
wait_for, rendered text, and fixed delays cannot establish completion.
The LAN helpers retain command receipts and pushed snapshot evidence in the
configured run outputs. Native RPC clients obtain the exact owned profile
directory from instance_metadata and connect to its recorded running-node
socket; they must not open another runtime over a profile held by the TUI.
LAN driver PID files retain the launched process's birth, executable, config,
and checkout identity. Missing or mismatched identity, or surviving
checkout-owned REPL/native harness IPC, blocks start, stop, and finish without
signalling an unverified process or discarding active evidence. TERM reaches
the REPL's existing owned shutdown through ctrlc's termination feature.
Unresolved shutdown retains driver state after the unchanged two-second
infrastructure budget; that budget is not a business-flow readiness wait.
Native TUI harness IPC is part of that shared compatibility surface now. In
explicit harness mode the command socket and semantic snapshot mirrors are
scoped under AURA_HARNESS_INSTANCE_TRANSIENT_ROOT, and command submission
must authenticate with the per-run AURA_HARNESS_RUN_TOKEN. Setting
AURA_TUI_COMMAND_SOCKET, AURA_TUI_UI_STATE_SOCKET, or
AURA_TUI_UI_STATE_FILE outside explicit harness mode must stay inert or fail
closed; those env vars are not a production backdoor.
Shared-semantic preflight is intentionally stricter than generic backend startup. A run config that includes SSH instances does not automatically qualify for the shared semantic lane. Until a backend implements the shared semantic contract, SSH remains diagnostic-only for harness purposes. Shared-semantic scenarios must fail closed before execution.
For SSH-backed diagnostic runs, remote artifact capture now has two explicit modes. When ssh_dry_run = true, the harness records a simulated sync summary only. When ssh_dry_run = false, the harness copies logs/ from the instance's remote_workdir back into the local artifact bundle under remote/<instance-id>/logs/ using scp, then records the copied file manifest and checksums in the per-instance sync summary plus remote_artifact_sync.json. Use require_remote_artifact_sync = true when the run should fail closed if that SSH artifact copy does not complete.
aura-app::ui_contract is the canonical module for shared flow support. It defines SharedFlowId, SHARED_FLOW_SUPPORT, SHARED_FLOW_SCENARIO_COVERAGE, UiSnapshot, compare_ui_snapshots_for_parity, OperationInstanceId, and RuntimeEventSnapshot. The root file is a facade; parity metadata, harness/browser bridge metadata, and shared-flow support tables may live in dedicated ui_contract/* modules, but the canonical public contract stays aura-app::ui_contract. Use semantic readiness and state assertions before using fallback text matching.
Direct usage of SystemTime::now(), thread_rng(), File::open(), or Uuid::new_v4() is forbidden. These operations must flow through effect traits.
Shared UX Contract and Determinism
The shared UX contract is defined in User Interface. The aura-app::ui_contract module is the canonical authority for parity-critical UI identity, readiness semantics, and typed observation payloads. The shared semantic scenario contract remains aura-app::scenario_contract. Its root may delegate contract families such as submission, actions, expectations, and values into scenario_contract/* modules without changing the public harness contract.
Harness waits preserve each typed expectation through internal lowering.
ListContains checks membership regardless of the selected row;
SelectionIs requires an explicit matching selection and a present list item.
ListItemConfirmation checks that item's confirmation independently of selection.
ControlVisible can currently establish screen, list and modal presence from
typed snapshots. Other controls fail explicitly until authoritative visibility
observations are available; focused control identity does not prove visibility.
Shared scenarios must submit typed semantic commands through the frontend bridge. They must not use raw PTY keys, raw selector clicks, raw label matching, or incidental focus stepping as primary mechanics. Frontend-specific UI I/O belongs in frontend-conformance coverage rather than the main shared semantic lane. Unsupported semantic commands must fail closed and diagnostically.
Command submission must enter the frontend through its real update and event path. It must not use render-coupled polling or ad hoc harness shims.
Contacts friend management is part of that shared UX contract. The canonical relationship states are contact, pending_outbound, pending_inbound, and friend, and they must be projected from runtime-owned relational facts rather than shell-local heuristics. The shared contract owns the parity-critical contacts controls for send friend request, accept friend request, decline friend request, and remove friend, and both TUI and web tests should assert those actions through the same semantic surface. Harness and frontend-conformance coverage may verify renderer wiring around those controls, but the lifecycle itself stays anchored to Scenario 13 and the shared semantic command/observation path.
Shared Semantic Ownership Model
Parity-critical shared semantic flows must use one explicit ownership category. Do not mix categories casually inside the same flow. The four ownership categories (Pure, MoveOwned, ActorOwned, Observed) are defined in Ownership Model.
aura-app owns authoritative semantic operation coordination and typed lifecycle and error publication. aura-agent owns long-lived runtime and service actors and other actor-owned async state. aura-terminal and aura-web submit commands and observe lifecycle but do not own terminal semantic truth. aura-harness consumes typed handles, readiness, and projections but does not mutate semantic lifecycle directly.
Terminal convenience modals stay in that observed-only category. Opening or editing a local TUI modal such as the contact invitation sheet may prefill or reshape local display state, but it must not become an alternate semantic ingress path or carry authoritative receiver ownership. Tests should prove the real semantic boundary remains the typed dispatch command and upstream aura-app workflow submission path rather than modal-local state.
Contact-code acceptance uses one app-owned acceptance handoff for import,
verification, Contact-kind validation, acceptance, and terminal publication.
Native and browser submissions retain the original invitation_accept_contact
operation and instance before the first awaited workflow step. Required child
stages share its original deadline. Explicit invitation import remains a
distinct operation; its receipt cannot stand in for Contact acceptance. Test
the actual ingress receipt, pending import, invalid invitation kinds, failures,
and cancellation through this handoff. Browser completion display metadata
comes from the verified handle returned by the completed app workflow.
The canonical InvitationAcceptanceRequest covers retained handles, submitted
ids, standalone ids, and Contact codes. Submitted-id tests must reject canonical
kind mismatches and required lookup faults before mutation while retaining the
original instance. Initial clock faults must settle the retained-handle owner,
and accepted signal history alone must not authorize acceptance. Guardian
acknowledgment tests advance the selected virtual clock under the original
endpoint and prove required provider faults stop retries.
Contact acceptance settles from the actual accepted-invitation outcome before
optional link propagation. Both frontends run the same bounded app followup
after settlement; warmup completion cannot publish ContactLinkReady. Channel
acceptance retains its strong channel/context reference through required AMP
state and scoped membership/recipient readiness checks.
Required convergence performs one shared sync and ceremony cycle in every frontend mode. The workflow must still obtain its authoritative readiness or terminal proof; a completed convergence cycle is not that proof. Nested calls, attempts, and backoff receive the original typed endpoint and retained runtime. A child may shorten that window but cannot renew it. Clock and timer failures remain typed failures, including when a domain error retains them as a source. Harness rounds and backoff belong to standalone maintenance; optional discovery belongs to a separate bounded postterminal followup. Exercise these boundaries with a frozen injected clock, explicit provider completion, and an exhausted original endpoint rather than elapsed sleeps.
The native harness maintenance scheduler runs one bounded authenticated ceremony-mailbox pass before sibling sync convergence. A sync error or timeout still fails that maintenance pass, but cannot starve original enrollment receiver registration or broker acknowledgment. Required operation convergence continues to fail closed on sync errors. Verify the scheduler with a genuine signed first envelope, exact broker acknowledgment, and an injected sync fault; direct calls to the agent mailbox drain alone do not prove scheduler progress.
Clipboard copy affordances in TUI modals follow the same rule. Copy buttons and local clipboard helpers are convenience-only observed behavior, not shared semantic evidence. Headless CI and rustdoc builds must not rely on the host system clipboard being available. When a test or harness run needs to assert copied content, use AURA_CLIPBOARD_MODE=file_only together with AURA_CLIPBOARD_FILE and treat that capture file as diagnostic output rather than as proof of semantic success.
If a migrated parity-critical flow needs both actor and move semantics, the split must stay explicit. The actor owns mutable lifecycle state. Move-owned handles and tokens define which caller may advance or transfer it. If that split is not explicit, the flow is not considered correct by construction.
Parity-Critical Observation
UiSnapshot and render-convergence data are authoritative. Observation surfaces must be side-effect free. Recovery and retries must be explicit and separate from observation.
A failed OperationSnapshot carries the owner-reported failure_code (a SemanticFailureCode, serialized in snake case and omitted when absent). Assert refusals on that code, for example permission_denied for a moderation command from an actor without the role or capability, not on toast text.
Home role commands are tracked operations: /op and /deop publish grant_moderator and revoke_moderator, and /admit publishes admit_member (SemanticOperationKind::AdmitMember). A participant must be admitted before /op succeeds; /op on a participant fails with an invalid-target refusal. The multi-runtime regressions live in the home_flows binary (home_membership).
UiSnapshot.supervised_task_failures lists dead runtime-supervised tasks (group, task, cause) from RuntimeBridge::supervised_task_failures. It is diagnostic only: excluded from parity comparison, readiness and quiescence, and never a wait condition. The TUI export populates it; the browser publishes it empty. On LAN runs, deadtasks <inst> in scripts/harness/lan/lib.sh prints it.
Browser ui_state remains observation-only and must not perform implicit navigation or state recovery. Explicit recovery goes through recover_ui_state and readStructuredUiStateWithNavigationRecovery(...). DOM and text fallback paths are diagnostics only and must not become success-path observation behavior.
For fixed-commit browser runs, the guarded web build records the clean source
commit and source tree, actual selected Node, npm, Cargo, Rust, Dioxus,
wasm-bindgen and wasm-opt executable bytes, Binaryen library bytes, effective
compiler configuration, and hashes of its emitted index, JS and WASM files.
The dx.sh owner selects Binaryen version_123 from the source-pinned Nix
derivation, keeping wasm-opt and its dynamic library in one immutable store
output. Missing or foreign outputs refuse the build; the old mutable release
download is not an admitted fallback. The selected output is checked against
the current flake derivation before inventory or build execution. This pins
the tool input, but does not claim bit-for-bit reproducibility of the full web
application build.
Provision the output explicitly from an existing Nix shell before the web
build:
bash scripts/dev/build-budget.sh --lane nix-binaryen --no-prune -- nix build --no-link .#binaryen123
Ordinary nix develop does not realize it.
The selected-tool inventory stays in a protected local artifact; the public
bundle marker contains only its digest. The prebuilt-only
static server accepts that exact build when Dioxus reuses byte-identical assets
without updating their mtimes. A changed source tree or changed asset rejects
the marker; browser startup never rebuilds inside a live harness run.
Prebuilt admission always requires this evidence, including when file mtimes
look fresh. It runs before npm, Tailwind, CSS-link changes or Dioxus configuration
changes. Provision the static server's Node and local ws dependency before
starting the harness; prebuilt mode refuses missing dependencies and never
installs them. Tool-inventory admission reads Cargo metadata once with
--locked --offline, refusing unavailable or ambiguous package versions.
Use the existing fixed-commit ship owner to transfer a completed build:
AURA_E2E_REMOTE=user@host bash scripts/harness/lan/ship.sh --no-build
The producer must pass strict local tool/configuration and output checks first.
Ship sends the original marker and protected tool inventory over authenticated
SSH, with the producer-selected evidence digest supplied separately from its
input stream. The consumer retains them under
artifacts/aura-web/transferred-provenance, outside served assets, in owned
0700 directories and 0600 files. It checks its exact clean source/tree, lock,
platform, build command and emitted bytes, while preserving the producer's
configuration and tool identities. It does not relabel consumer tools as build
inputs or manufacture a completion marker. This contract supports the ship
owner's same-platform transfer; it does not prove a cross-platform build.
A protected selection record binds transferred admission to that checkout and original marker. Missing, changed or unsafe selected evidence refuses; it cannot fall back to local producer checks. Inspect admission without serving:
bash scripts/web/prebuilt-transfer.sh verify "$PWD" \
"$PWD/target/dx/aura-web/release/web/public"
Publication uses one owned lock, bounded input and private staging. Interrupted staging never authorizes serving; an identical valid ship can retry, including after ready evidence was published before selection. An uncatchable process kill may leave private unpublished staging for diagnosis. Retain it until its owner is known to have stopped; do not treat it as admission. A successful local guarded web rebuild can explicitly return to strict local-producer admission, retiring selection while retaining historical transfer evidence. Changing mtimes, copying another checkout's admission or deleting refusal evidence is not a recovery procedure.
The exact shell regressions run through just ci-build-cache-policy. They cover
producer/consumer identity and integrity, interrupted publication, private
custody, no-fallback selection, upload quoting, and the full ship orchestration
with isolated SSH/Nix facades. Those fixtures establish the local contract;
retain real ship receipts and independent browser/network evidence separately.
The browser driver raises a semantic revision floor for mutating commands. The
canonical immediate ExportDeviceEnrollmentSetup command is a runtime read:
its typed page-owned queue result completes the export, and the following
ui_state may retain the same published revision. The Playwright smoke fixture
executes that queue and checks the unchanged revision; it also keeps the floor
for other semantic submissions. Match the canonical serialized submission
value device_enrollment_setup; a test-only PascalCase value does not exercise
the real browser request.
Browser semantic observation must fail closed when the published snapshot is unavailable. It must not silently repair by reading a live controller or model snapshot behind the harness bridge. Channel-binding responses must either carry authoritative context materialization or fail explicitly. Selected ids or labels alone are not semantic bindings.
For enrollment, assert code issuance and ceremony completion as separate
operation instances linked by ceremony ID. Browser stage_runtime_identity
and the page-owned semantic queue may submit or stage work, but neither owns
completion publication. A test that remounts the UI or reboots the browser
must reattach to the app/runtime-owned completion result and compare its typed
state and failure domain/code in ui_state on both frontends. Exercise refusal,
timeout, cancellation, duplicate terminal delivery, and restart with an
authoritative ceremony result; local wizard completion and device counts are
diagnostics only.
The bounded enrollment_host_injection_resumes_separate_role_owners test runs
the actual manifest on separate VM owners and reports scheduler/coroutine state
on stalled progress. device_enrollment_owned_sessions_exchange_request_accept_confirm
exercises device-addressed shared transport and repeats admission after terminal
VM reaping to catch leaked runtime owners. The actual invitee handler test
device_enrollment_invitee_rejects_wrong_request_and_negative_confirmation
requires typed permanent failure before the human retry window. These tests
cover transport, teardown and message binding; authenticated confirmation and
cross-machine terminal parity still require their own end-to-end evidence.
The enrollment_setup domain tests reject substituted identities, nonce,
validity, epoch, package and signatures, along with proof-policy mismatches and
oversized codes. Compile-fail doctests prevent constructing or deserializing
possession evidence directly. Signing-owner tests check runtime device capture,
exact retained code, serialized concurrent bootstrap, corrupt/partial bootstrap
without key replacement, and missing wrapping keys without regeneration.
Service recreation with shared effects tests verifier continuity at that scope;
it does not prove native/browser process restart, explicit user transfer,
request consumption, or authenticated ceremony completion.
Signing lifecycle regressions additionally cover recovery after service-only rotation, immediate removal of stale local membership, pending-package overwrite rejection, stale commit and active rollback rejection. Retained-share tests must check a share from another group before activation and after recovery; requiring a whole quorum is not necessary to prove one local share matches its group. These checks do not replace genesis failure/restart or effects/service activation boundary coverage.
Genesis readiness tests inject a corrupt tree index before materialization and require retry to use the original key without exposing a signing context early. They reject a wrong completion digest and a cached creation without its durable index, and allow legacy migration only with an authenticated existing creation. A missing active epoch after completion requires recovery, rather than defaulting to epoch zero. These service/checkpoint tests do not establish process-restart coverage or every native/browser storage failure boundary.
Channel list item ids and selected-channel snapshot ids must stay keyed by canonical channel ids when the runtime projection already provides them. Harness and browser code should not round-trip through display labels on those paths. Diagnostic tool and query surfaces should say diagnostic_* at the API boundary when they are derived from screen or DOM capture rather than authoritative semantic state. Onboarding must publish through the same semantic snapshot path as the rest of the UI.
Placeholder IDs, override-backed exports, and heuristic success or event synthesis are not acceptable correctness paths.
Parity-Critical Waits and Assertions
Waits must bind to declared readiness, event, or quiescence conditions. They may also bind to typed operation handles or strictly newer authoritative projections when the shared contract defines them.
When a runtime bridge surface exposes typed lifecycle such as DiscoveryTriggerOutcome, CeremonyProcessingOutcome, or an explicit mutation outcome, tests should assert those variants directly. Do not treat a unit success result as sufficient proof of progress. Executor-side follow-on waits should carry typed submission evidence from the issued receipt into the declared contract barriers. Do not keep a second harness-local convergence graph.
Keep production handle construction and accepted receipt issuance in the sanctioned
owners checked by just ci-harness-move-ownership-boundary. Test-only receipt
fixtures may use positive lexical cfg(test) scopes. The checker inspects actual
Rust paths and macro tokens: mixed test/production predicates and production
following a test item remain checked, while comments and diagnostic strings do
not constitute ownership operations.
Projection-based semantic waits may resume across bounded browser or runtime restarts only by clearing stale freshness baselines and re-entering typed snapshot observation. Runtime-event, toast, and exact operation-state waits still fail closed across restarts. Semantic issue success must come from typed command receipts and authoritative runtime facts, not from visible homes, modal closure, message appearance, selected-list state, or a frontend-local submitting phase.
Shared semantic harness core should decode typed ToolPayload and bridge structs directly. Keep raw serde_json::Value plumbing at outer CLI and browser adapters only. Raw sleeps, redraw polling, DOM scraping, and fallback text matching are diagnostics only.
Scenario-language text assertions must keep the same split. message_contains means authoritative UiSnapshot.messages. diagnostic_screen_contains is frontend-conformance-only rendered text. Harness mode may change instrumentation and render stability, but it must not change business-flow semantics.
Ownership Test Expectations
When a change introduces or modifies a parity-critical ownership boundary, the test plan should include compile-fail tests for private constructors, capability misuse, or stale move-owned handles where the boundary is type-enforced. It should include invariant tests proving owner drop reaches explicit failure or cancellation. It should include invariant tests proving terminal lifecycle does not regress on the same logical instance.
It should also include invariant tests proving observed layers do not author semantic lifecycle. Include tests proving frontend-local submission yields immediately to the app-owned workflow owner after handoff. Include timeout and backoff tests proving local wall-clock policy only changes budget and diagnostics, not semantic success or failure rules. Run the relevant ownership and time just ci-* policy checks in addition to crate tests.
For shared semantic workflow changes, aura-app::workflows is the authoritative publication owner. aura-terminal, aura-web, and aura-harness must not retain a parallel terminal publication path after handoff. Review and test plans should name the terminal owner explicitly and treat frontend layers as submit and observe boundaries.
Use physical time for local deadline and backoff policy. Do not use wall-clock timeouts as the primary proof of distributed completion or ordering.
Failure Analysis
Prefer canonical action, event, and state traces along with structured timeout diagnostics. Treat final text or screenshot inspection as supporting evidence, not the primary oracle. Replay bundles should compare typed tool-response payload meaning, not just a binary success-versus-error shape.
Ownership Cleanup Discipline
Every shared UX or harness contract hardening change should remove obsolete compatibility code, stale allowlist entries, and transitional comments in the same milestone or the next explicit cleanup pass. Prefer extending typed governance in cargo run -p aura-harness --bin aura-harness --quiet -- governance ... over adding standalone shell policy logic.
Each parity-critical ownership change must include explicit cleanup work for the abstraction it replaces. Do not treat the ownership model as additive.
For every migrated flow, delete actor wrappers around purely local or value transitions that should stay Pure. Delete shared mutable ownership state where a MoveOwned handoff or owner-token surface is the correct model. Delete detached callback or task ownership for state that should instead live under one ActorOwned coordinator.
If a change leaves one of those old abstractions in place, record it as explicit ownership cleanup debt with the owning module and removal milestone. Do not hide it behind temporary ambient lifecycle helpers, duplicate readiness emitters, or shell-local terminal state.
The authoritative written update map for these surfaces now lives in Aura's toolkit/xtask user-flow guidance sync check and is enforced by just ci-user-flow-policy. Ownership-model policy for the shared semantic lane is enforced through the final CI entrypoints just ci-ownership-policy, just ci-harness-ownership-policy, and just ci-user-flow-policy.
Testing and Enforcement Split
Prefer trybuild compile-fail coverage when the misuse is fundamentally an API-shape or visibility violation. Prefer Rust-native lint binaries in aura-macros when the misuse is a syntax-level boundary or naming and flow-shape rule. Keep shell scripts for repo-wide governance, integration topology, or end-to-end harness policy that cannot realistically be proved at compile time. When a stronger contract lands, remove the superseded legacy helper, compatibility branch, migration shim, or stale regression fixture rather than leaving both paths active.
The authoritative frontend matrix for converted shared scenarios comes from scenarios/harness_inventory.toml and is enforced by just ci-harness-matrix-inventory. Allowlisted harness-mode hooks must carry explicit owner, justification, and design-note references enforced by Aura's toolkit/xtask user-flow policy guardrails. The diff-aware user-flow policy lane accepts a valid empty local diff, but an invalid range or failed Git diff is an error rather than evidence of no changed files.
Changes to the browser harness bridge request, response, or observation surface must update both crates/aura-web/ARCHITECTURE.md and this guide so compatibility expectations stay explicit.
For service-family work, keep the test/evidence split concrete:
- type/API and proc-macro boundaries first
trybuildcompile-fail tests for misuse that should not compileaura-macroslint binaries for syntax-owned rules- thin shell scripts only for integration-wide or artifact-governance checks
The default contributor verification path for this class of change is:
just lint-arch-syntaxjust ci-ownership-policyjust check-archjust ci-adaptive-privacy-tuningif the change touches adaptive privacy policy constants, simulator evidence, or telltale-backed control-plane parity
When a new Establish, Move, or Hold surface lands, the same change should
also add:
- the service-surface declaration macros
- compile-fail or invariant coverage for the strongest rejectable misuse
- any required
aura-macroslint coverage or thin script glue - the updated crate
ARCHITECTURE.mdand authoritative docs - removal of the superseded compatibility helper or explicit inventorying of the deferred cleanup
Browser Compatibility Surface
The browser compatibility surface includes the explicit stage_runtime_identity bootstrap handoff entrypoint plus the page-owned semantic submission queue (window.__AURA_DRIVER_SEMANTIC_ENQUEUE__). The browser also publishes page-owned semantic submit readiness metadata. This includes whether the enqueue surface is installed (enqueue_ready), the active vs ready generation boundary, controller presence, current shell phase, and any in-flight bootstrap transition detail. Driver startup and recovery waits bind to product-owned bootstrap and rebinding state instead of stale driver-local probes.
The bootstrap staging and handoff promise is completion-based. Callers may treat it as confirmation that the owned bootstrap or rebootstrap transition finished, not merely that the request was queued. For generation-changing bootstrap flows, that completion means the new page-owned shell generation has published its semantic snapshot through the canonical publication path. The browser diagnostics window.__AURA_UI_ACTIVE_GENERATION__ and window.__AURA_UI_READY_GENERATION__ reflect the active vs ready generation boundary. Render heartbeat remains the separate browser render-convergence signal.
Browser bootstrap storage is explicit. Preserved-profile recovery correctness depends on the typed selected runtime identity, pending bootstrap metadata, and browser-local AccountConfig metadata remaining distinct. The next generation must recover the canonical runtime bootstrap path without falling back to browser-local semantic repair. Channel-returning bridge responses now distinguish weak selected-channel ids from authoritative channel bindings. A payload that lacks context is not a binding.
For browser enrollment adoption, derive the new account configuration from the sealed import completion's subject authority, while the attached runtime may still identify the provisional invitee. Verify per-authority storage keeps the previous profile's context, creation time and nickname, and that legacy selected-config migration is read-only and accepts only an exact authority match. Reject a per-authority key whose stored authority differs. Fault each host write separately after the app budget ACK: authority config, selected runtime identity and pending-code clear are ordered but not atomic, so tests must preserve the actual partial state and native cause. A ready screen or import terminal result alone does not prove the adopted profile survives same-profile reopen.
Browser bootstrap broker credentials are intentionally not query-string parameters. Tests may stage the broker URL through controlled bootstrap setup, but bearer and invitation-retrieval tokens must use session-scoped browser storage or header-bearing runtime configuration. Harnesses should assert this through the browser storage/bridge contract rather than by inspecting URL parameters.
Browser harness transport upkeep polls the ordinary runtime identity mailbox
and only additional subject/device mailboxes returned by the agent's
pending_enrollment_transport_scopes getter. That getter revalidates the
protected signed pending-enrollment admission on each tick and excludes expired,
confirmed, or failed generations. A failed scope read surfaces a transport-tick
error rather than selecting from a raw manifest, setup code, or scenario value.
Drained envelopes are requeued through the agent VM for normal signed receive
validation. The scope is a mailbox selector, not receipt acceptance,
membership, or outbound broker routing authority. An authenticated broker
mailbox protocol still needs separate implementation and end-to-end evidence.
The browser generation supervisor schedules shared runtime ceremony processing on each tick except a background-sync tick, which invokes it before and after sync. That runtime ingress owns both authenticated enrollment mailbox drains for native and browser. The agent retains registration proof, credential, protected admission, VM ingress, exact return registration, encrypted response frame and broker acknowledgment. The browser supplies no route identifiers or credentials and reports the first mailbox failure once per generation under a consolidated upkeep code with the original typed source error. The app still owns the import terminal result. An exact browser transfer must observe Alice consuming Bob's response and the app/host terminal acknowledgment before this upkeep proves completion. The existing harness relay poll remains a separate compatibility path. Require an actual browser transfer and failure fixture before claiming the authenticated mailbox path validated end to end.
Browser harness failures surface explicit publication-state diagnostics through window.__AURA_UI_PUBLICATION_STATE__, window.__AURA_RENDER_HEARTBEAT_PUBLICATION_STATE__, and the page-owned semantic submit publication surface. Those globals are diagnostic-only and do not replace the authoritative UiSnapshot and RenderHeartbeat payloads. They are the canonical observed source for browser bootstrap and rebinding state. Driver-owned restart_page_session is infrastructure recovery only. Semantic command submission and runtime-identity staging must wait on or fail from the page-owned publication contract rather than replaying work through a restarted browser session.
The approved-transfer browser scenario submits through the mounted modal confirm button, then requires the exact device_enrollment operation instance to reach Succeeded, a device_enrollment_accepted event from the same browser generation's added-device settings projection, and a two-device settings count before restarting Bob. After reopen it checks the projection again. Immediately before restart, the Playwright driver writes a private *-pre-restart-*.json artifact with the observed operation instance and state, typed failure (if any), the two-device host projection witness, revision, and filtered console tail. Preserve this artifact when a later restart loses page diagnostics; neither a generic success state nor a modal dismissal proves the enrollment chain.
The native native_enrollment_host development fixture uses the terminal's
canonical AccountFilesHelper host policy against the original recipient's
selected testing profile owner. It checks signed import, app-issued completion,
one success terminal for the original instance, encrypted identity/account
readback and same-profile reopen after strict shutdown. A second lease is
refused. Testing-owned filesystem secure storage does not prove production
platform-keyring persistence; keep that platform evidence separate.
The scenario captures the instance after mounted submission and checks that same instance again immediately before restart. A success on another device_enrollment instance cannot satisfy these exact waits.
For the scenario restart, restart_actor passes the captured operation instance to the browser backend. Before it stops the old Playwright process, the driver requires that exact operation to be Succeeded and retains the same-generation two-device added-device projection event in a private pre-restart artifact, alongside all observed typed failures. The backend passes only that bounded evidence to the new driver process. A post-restart private artifact is written only after the new page generation observes two devices including that event's device ID; it carries the original instance and host witness beside the reopened device IDs. The scenario report must still prove readiness and the final settings projection.
submitSemanticCommand follows that rule directly. After bounded same-page recovery it must fail closed instead of replaying the semantic request through a fresh browser session. The browser publication owner classifies diagnostics by typed publication status, binding mode, and reliability before serializing them to page globals. Compatibility-sensitive waits keep one canonical publication path instead of ad hoc string assembly.
The driver raises a semantic-revision floor before each browser action so a later ui_state cannot return the pre-action snapshot. A failed action (absent, hidden or disabled control, exhausted click retries) restores the floor it raised, because the page never publishes the newer revision for an action that did not happen. Observation must keep working after a refused action; the Playwright driver smoke test covers a failed click followed by ui_state.
The Playwright cache also compares each candidate semantic_seq with its last
accepted snapshot in the same page generation. Reject a lower sequence without
replacing the cache or advancing its observation version; a delayed console
push must not erase accepted operation/event state. Explicit navigation or
generation reset clears the cache, so a newly observed generation may start
with a lower sequence. The driver self-test covers both cases. This cache
ordering check does not prove a browser enrollment transfer or invitation
export succeeded; those require separate typed workflow evidence.
A successful action is not proof of a no-op. After a successful action (other than submit_semantic_command, which keeps its own typed publication contract) the driver observes the page for a bounded settle window. A snapshot at or above the floor satisfies it. In-flight semantic work reported by the page (operation_submitting or readiness_loading quiescence reasons, or a submitting operation) keeps the floor raised, as does missing quiescence or DOM evidence. Only a settled, unchanged semantic snapshot restores the pre-action floor: a confirmed no-op (DOM unchanged) or DOM-only navigation (DOM changed, then stable). The action result carries post_action_observation with the outcome, and the smoke test covers each case.
Browser semantic navigation follows the same separation. Page-owned navigation helpers such as navigate_screen and settings-section opening may publish the target UiSnapshot before the browser finishes painting the new screen. Harness navigation success must therefore wait for both the target semantic screen and the matching post-render RenderHeartbeat or equivalent render-convergence proof before treating the control activation as complete. DOM selectors remain diagnostic corroboration only; they must not replace the semantic-plus-render contract.
Browser-owned semantic snapshot publication should flow through one helper aligned with UiController::publish_ui_snapshot. Browser-owned maintenance polling should share one bounded helper for sleep, cancellation, and pause reporting so those paths stay uniform and clearly non-semantic. Parity exceptions must remain typed metadata in aura-app::ui_contract with a reason code, scope, affected surface, and authoritative doc reference.
Browser-owned async account/bootstrap flows must also fail closed on shell-state publication. If a Dioxus signal write collides with an unmounting or busy component, the browser shell may retry on the next browser tick for the active generation, but it must not silently drop the state transition.
Browser harness mode now has an authenticated runtime bootstrap rule as well.
When the wasm agent runtime is launched under the browser harness, the
authenticated query parameters __aura_harness_instance and
__aura_harness_token are part of the canonical harness-mode contract. The
browser shell and runtime must agree on that authenticated handoff before
taking any harness-only invitation or device-enrollment relaxation path, and
browser build or cache reuse must preserve the web,harness feature set that
installs that bridge.
Shared-Flow Coverage Anchors
The canonical shared-flow coverage anchors for the current parity-critical user flows are listed below.
real-runtime-mixed-startup-smoke.tomlfor startup, onboarding, and shared neighborhood navigationscenario13-mixed-contact-channel-message-e2e.tomlfor the shared chat, contacts, invitation, home creation, channel join, and message-send flowscenario12-mixed-device-enrollment-removal-e2e.tomlfor device add and removeshared-notifications-and-authority.tomlandshared-settings-parity.tomlfor the remaining shared settings, authority, and navigation flowsamp-transition-normal-shared.toml,amp-transition-delayed-witness-shared.toml,amp-transition-conflict-subtractive-shared.toml,amp-transition-emergency-shared.toml, andamp-transition-negative-shared.tomlfor shared AMP transition observation coverage
The current aura-app split keeps those anchors unchanged while moving the
authoritative flow owners into more specific modules. Shared-flow source-area
metadata should point at the owner modules that now carry those flows:
workflows/context/neighborhood.rs for neighborhood/home creation,
workflows/invitation/{create,accept,readiness}.rs for contacts and
invitation acceptance, and workflows/messaging/{channel_refs,channels,send}.rs
for chat navigation, join, and message-send paths. The aura-app::ui_contract
facade remains the canonical export surface for that coverage metadata.
Scenario 12 has an additional browser parity rule now. The shared semantic
snapshot does not fabricate a selected row for ListId::Devices; current-device
markers and removable-device targeting remain separate concepts. Browser harness
submission for remove_selected_device must therefore fall back to the
authoritative removable device from settings state when the snapshot has no
explicit list selection, and the canonical mixed-runtime anchor remains
scenario12-mixed-device-enrollment-removal-e2e.toml.
For enrollment, create the invitee's real provisional account before
prepare_device_enrollment_setup. That variable action exports its signed setup
code through the runtime semantic queue and stores the exact code for the
initiator's setup_code input. Successful export establishes signing readiness;
an unavailable or unready exporter fails explicitly. Authority staging files,
derived browser device identifiers, and synthetic setup codes cannot replace
this transfer. Keep setup codes out of diagnostic event payloads.
Acceptance fixtures must retain the explicitly transferred verifier before
checking the response. Sign the canonical response with the real prepared
runtime, verify it against that retained key and policy, and record the sealed
evidence. A participant-count fixture or a signature checked only against its
own embedded key is negative coverage. Distinguish crypto/activation tests from
VM delivery, authority adoption and process-restart tests in reported evidence.
The semantic ExportDeviceEnrollmentSetup command returns the exact code in
an immediate DeviceEnrollmentSetup { setup_code } response with no operation
handle. Both shells call the bounded app export workflow; the native socket
ingress and browser page queue are transport owners, while the runtime owns
the signed retained request. An unavailable runtime or signing context fails
explicitly. Contract roundtrip tests check the value and absent ceremony handle;
they do not establish native/browser end-to-end enrollment completion.
LAN bootstrap candidates are observable as ListId::BootstrapCandidates in the
TUI ui_state: items are the candidate authority ids in Contacts display
order, and the selected item follows the LAN peer selection only while the
Contacts list focus is on LAN peers. Assert discovery, selection and invites
through this list rather than the rendered peer panel, which the TUI
diagnostic capture does not include.
Scenario 13 has an additional mixed-runtime receive contract now. On the
current TUI/browser path, authoritative inbound shared-channel messages may
surface as sealed placeholders rather than plaintext payloads. Harness
assertions for scenario13-mixed-contact-channel-message-e2e.toml should treat
the [sealed: prefix as the canonical browser/TUI parity expectation for those
receives instead of requiring renderer-local plaintext recovery.
Harness-mode timing exceptions remain narrowly allowlisted. The current shared allowlist includes the browser maintenance cadence plus the runtime and workflow instrumentation hooks that feed observed-shell timing helpers; those branches may tune observation cadence only and must not change business-flow semantics.
Shared pending-invitation acceptance has an additional invariant now:
SemanticOperationKind::AcceptPendingChannelInvitation entry points must not
strand the authoritative semantic lifecycle at
SemanticOperationPhase::WorkflowDispatched when the shared browser/TUI flow
fails before the owned accept path settles. If an early error escapes the
owned path, the wrapper or *_with_instance entry point must synthesize the
terminal failure publication for the same operation instance before returning
to the shell or harness. Scenario 13 remains the canonical mixed-runtime anchor
for that browser shared-channel receive parity.
Note-to-self is a real AMP channel provisioned at account bootstrap, not a display-only entry. It appears as a first-class channel backed by the runtime from first use, with its own context, deterministic channel ID, and standard message delivery. Channel creation parity coverage must not treat "has at least one contact" as a prerequisite for opening chat creation. TUI and web shells should expose the same semantic create-channel path when the only available participant is self, and scenario coverage should keep that path distinct from pairwise or group-member invitation flows.
The notifications shared-flow anchor remains navigation-only. Parity coverage for notifications navigation requires the TUI and web shells to expose the same semantic screen transition and detail-view contract, but notification empty-state copy is informational only and must not introduce parity-critical invitation or recovery actions outside the canonical shared workflows.
AMP channel transition frontend coverage uses the same semantic observation lane. Transition state, live successor and finalization state, conflict evidence, emergency quarantine, cryptoshred status, and suspect exclusion must be asserted through RuntimeFact::AmpChannelTransitionUpdated entries in UiSnapshot.runtime_events plus shared notification list ids.
Web and TUI frontends may render local affordances for emergency alarm, quarantine approval, cryptoshred approval, conflict evidence, and finalization status, but the controls and operation ids must come from aura-app::ui_contract. Tests must not infer AMP send or receive authority from local message-ratchet state or frontend-specific text. Destructive cryptoshred affordances must surface an explicit confirmation label and the loss of pre-emergency readability.
Native invitation and device-enrollment exports have an additional transport contract now. In non-wasm runs, sender_hint is a transport hint and must use the canonical tcp://host:port form rather than websocket-style ws:// or wss:// URLs. LAN integration and harness assertions should treat that field as a native direct-transport hint, not as a browser transport endpoint. When the runtime has both a stored rendezvous descriptor and a LAN-discovered descriptor for the same peer, invitation seeding should prefer the discovered descriptor if it adds a TcpDirect transport hint that the stored descriptor lacks so native shared-flow tests continue to exercise the direct LAN path.
Shared Semantic Ownership Inventory
Use this as the authoritative ownership map for the shared semantic stack. If code does not match this table, treat it as ownership cleanup debt rather than as an acceptable alternate pattern.
| Subsystem | Crate / locus | Ownership | Authoritative owner | May mutate | May observe |
|---|---|---|---|---|---|
| Semantic command / handle contract | aura-app::ui_contract, aura-app::scenario_contract | Pure + MoveOwned | aura-app contract surfaces | aura-app contract and workflow modules | aura-terminal, aura-web, aura-harness |
| Semantic operation lifecycle | aura-app::workflows::* | MoveOwned | authoritative workflow coordinator | workflow and coordinator modules in aura-app | frontend render crates, harness |
| Channel / invitation / delivery readiness | aura-app::workflows::* | ActorOwned | single-owner readiness coordinator | coordinator modules and sanctioned hooks | shell, subscription, render, harness |
| Runtime-facing async service state | aura-agent::runtime::*, aura-agent::handlers::* | ActorOwned | runtime service actor | actor and sanctioned commands | aura-app, frontends, harness |
| TUI command ingress | aura-terminal::tui::harness_state, update loop | ActorOwned ingress + Observed rendering | TUI update and event loop | ingress and update-loop code only | shell render, harness |
| TUI shell / callbacks / subscriptions | aura-terminal::tui::screens, callbacks | Observed | downstream of authoritative state | local UI state only | harness, rendering |
| Browser harness bridge | aura-web::harness_bridge | ActorOwned bridge + Observed publication | browser bridge module | bridge module only | Playwright, harness, render |
| Harness executor / wait model | aura-harness::executor, backend::* | Observed + orchestration ActorOwned | harness coordinator | harness orchestration state only | scenario authors, CI |
| Ownership transfer / stale-owner invalidation | operation handles, owner tokens | MoveOwned | current token holder | sanctioned transfer APIs only | projections, render, diagnostics |
The required split is that actor-owned subsystems own long-lived mutable async state and lifecycle. Move-owned surfaces own exclusive right-to-act and ownership transfer. Observed surfaces render, wait, and diagnose without authoring semantic truth.
App bootstrap tests must fail each required signal-registration and refresh-hook attachment step, then retry the same runtime generation. A successful hook installation means every signal receiver is attached and its listener has acknowledged startup; tests assert one live subscriber per required signal. Detach must cancel that generation's hook group before rebootstrap attaches another. Query-bound signal registration has the same retry contract, including a failed query binding after signals were registered. A task spawner that discards listeners must fail installation rather than report readiness.
Mounted UI subscription tests must separately fail attachment of every distinct required signal, close an attached stream, and restart the runtime generation. Assert typed health, bounded recovery, one receiver per required signal, and cancellation of the previous generation on unmount and repeated mount. Attach before reading the initial state, then force updates across that boundary and after a lag to prove the projection converges from a fresh snapshot. Test both TUI and browser observation of the recovered authoritative state; neither a stale projection nor an empty default is evidence of success. A listener task that captures a clone of its own lifetime owner must fail the duplicate-ownership regression test.
Do not use this table to justify ambient shared ownership. If a subsystem needs both actor and move semantics, the actor owns mutable lifecycle state while the move-owned handle or token defines who may advance or transfer it.
Reactive Subscription Policy
Subscribing before registration must fail with ReactiveError::SignalNotFound. Tests must not treat an empty stream as equivalent to "signal not registered." Lagging subscribers are allowed to miss intermediate updates. Assertions should target eventual newer snapshots, not lossless delivery.
TUI-local semantic submission is limited to the sanctioned local-terminal and workflow-handoff owner wrappers. Browser bridge concurrency is limited to WebTaskOwner and does not own parity-critical lifecycle. Playwright stages browser runtime identity through the explicit bridge entrypoint before rebootstrap and submits semantic commands through the page-owned semantic queue.
For browser enrollment import, test both the visible form and the page-owned
semantic queue with the declared device-enrollment operation handle. Admit the
same app required import before releasing the frontend's exact instance, then
assert that host identity persistence precedes app terminal success. Destroy
the browser observer during host acknowledgment and require cancellation or
the retained prior failure without a false success. A broker batch must retain
every retrieved delivery through typed purpose routing, including a pending
enrollment prefill, rather than selecting its last item. Prefill alone cannot
authorize import without the independent manifest and initiator verifier.
Test controller replacement after account creation without a component remount:
the browser must bind the persistence host policy to the current controller
before either import surface is exposed. The former controller's policy must
not carry the new submission. On wasm, supply RuntimeOnly deliberately and
require typed pre-admission refusal plus local submission failure, with no app
import or false success in the observed lifecycle.
The mounted browser refusal fixture must observe the actual alert and retained
prefill on the join form, with account readiness false and no semantic
enrollment operation. A visible diagnostic does not prove approval or import.
Submitted-operation regressions must drop an unpolled terminal-observation
future and still find the original synchronous intent, instance, failure and
retained custody at the publisher. Check the returned acknowledgment's exact
instance and scope without treating channel acceptance, controller apply or
component observation as protocol or storage proof. For required frontend
tasks, interrupt a worker and fail cleanup independently: the shared task root
must retain the original owner and source until explicit reconciliation, and
wait_required_disposed must refuse while any obligation lacks an actual
cleanup acknowledgment.
Host-only app fixtures may inject aura_testkit::task_custody::SupervisedTaskTestkit
as the runtime's owned task spawner. Pause, cancel or abort the real borrowed
worker, then explicitly drain the supervisor and inspect execution, domain,
cleanup and acknowledgment fields. A dropped observer or testkit owner is not
a cleanup receipt; preserve the original failure and owner when settlement is
interrupted or fails. This fixture exercises ownership mechanics only and
cannot substitute for enrollment, broker, storage or protocol evidence.
On the native TUI path, inject channel acceptance, receiver refusal and an
interrupted terminal-send observer against the same required publication
owner. Assert exact operation-instance identity, one ChannelAccepted
acknowledgment only after the real UiUpdate send, and retention of the
original terminal failure when the send is unacknowledged. Shutdown must use
its original cleanup window and refuse reload while required native disposal
is unresolved, preserving sender-clearing and disposal sources independently.
For semantic command pre-admission refusals, assert a typed domain/code and
concrete-source reason with no operation handle; changed diagnostic wording
must not alter the reason or create accepted terminal evidence.
Authoritative readiness refresh remains private to aura-app::workflows and is compile-fail tested in both default and signals configurations.
Required Ownership Invariants
Ownership-model migrations are not complete until the following test classes exist for the affected parity-critical surface. Include compile-fail guards for private constructors, wrong-capability issuance, and stale-owner misuse where the boundary is enforced in types. Include dynamic invariant tests proving owner drop reaches explicit terminal failure or cancellation. Include dynamic invariant tests proving terminal states do not regress on the same logical operation instance.
Include handle and instance tests proving stale handles do not match or advance the wrong operation instance after transfer or replacement. Include concurrency tests for actor-owned coordinators where lost updates or multiple live owners are plausible. Include timeout and backoff invariant tests proving typed timeout failure, remaining-budget propagation, bounded attempts, and local-choice scaling.
If a flow changes ownership model or timeout policy and these test classes do not move with it, treat the migration as incomplete.
Release and Update Matrix Expectations
OTA and module release and update validation must follow the same semantic-lane contract as other parity-critical shared flows. The OTA contract requirements are defined in Distributed Maintenance Architecture. These include typed command and control surfaces, scoped activation lifecycle, and rollback semantics. Each release row in UX Flow Coverage Report must map to those typed lifecycle surfaces.
Frontend-conformance coverage may validate release-screen wiring, but it does not satisfy OTA or module lifecycle validation on its own.
2. The #[aura_test] Macro
The macro provides async test setup with tracing and timeout.
#![allow(unused)] fn main() { use aura_macros::aura_test; use aura_testkit::*; #[aura_test] async fn test_basic_operation() -> aura_core::AuraResult<()> { let fixture = create_test_fixture().await?; let result = some_operation(&fixture).await?; assert!(result.is_valid()); Ok(()) } }
The macro wraps the test body with tracing initialization and a 30-second timeout. Create fixtures explicitly rather than relying on ambient test state.
3. Test Fixtures
Platform credential store in tests
Test builds never open the real platform credential store. The test-keyring
feature of aura-effects, enabled only through dev-dependencies (and always
for its own unit tests), routes every keyring::Entry to a file-backed store
under $TMPDIR/aura-test-keyring (override with AURA_TEST_KEYRING_DIR).
Rebuilt test binaries otherwise trigger a macOS Keychain prompt on every run.
Release builds do not compile this store. Add the feature to a crate's
aura-effects dev-dependency when its tests assemble a production runtime.
Fixtures provide consistent test environments with deterministic configuration.
Creating Fixtures
#![allow(unused)] fn main() { use aura_testkit::infrastructure::harness::TestFixture; let fixture = TestFixture::new().await?; let device_id = fixture.device_id(); let context = fixture.context(); }
The TestFixture provides a pre-configured environment with deterministic identifiers and effect handlers.
Custom Configuration
#![allow(unused)] fn main() { use aura_testkit::infrastructure::harness::{TestFixture, TestConfig}; let config = TestConfig { name: "threshold_test".to_string(), deterministic_time: true, capture_effects: true, timeout: Some(Duration::from_secs(60)), }; let fixture = TestFixture::with_config(config).await?; }
Custom configuration controls deterministic time, effect capture, and per-test timeouts. Name each configuration to aid failure identification.
Deterministic Identifiers
#![allow(unused)] fn main() { use aura_core::types::identifiers::AuthorityId; let auth1 = AuthorityId::from_entropy([1u8; 32]); let auth2 = AuthorityId::from_entropy([2u8; 32]); }
Incrementing byte patterns create distinct but reproducible identifiers. This ensures tests produce the same identifiers across runs.
4. Unit Tests
Unit tests validate individual functions or components.
#![allow(unused)] fn main() { #[aura_test] async fn test_single_function() -> aura_core::AuraResult<()> { let fixture = create_test_fixture().await?; let input = TestInput::new(42); let output = process_input(&fixture, input).await?; assert_eq!(output.value, 84); Ok(()) } }
Each unit test should be fast and focused, testing one behavior per function. Name tests descriptively to communicate the expected behavior.
5. Integration Tests
Integration tests validate complete workflows across multiple components.
#![allow(unused)] fn main() { use aura_agent::runtime::AuraEffectSystem; use aura_agent::AgentConfig; #[aura_test] async fn test_threshold_workflow() -> aura_core::AuraResult<()> { let fixture = create_test_fixture().await?; let device_ids: Vec<_> = (0..5) .map(|i| DeviceId::new_from_entropy([i as u8 + 1; 32])) .collect(); let effect_systems: Result<Vec<_>, _> = (0..5) .map(|i| { AuraEffectSystem::simulation_for_named_test_with_salt( &AgentConfig::default(), "test_threshold_workflow", i as u64, ) }) .collect(); let result = execute_protocol(&effect_systems?, &device_ids).await?; assert!(result.is_complete()); Ok(()) } }
Use simulation_for_test* helpers for all tests. For multi-instance tests from one callsite, use simulation_for_named_test_with_salt(...) and keep the identity and salt stable. This allows failures to be replayed deterministically.
6. Property-Based Testing
Property tests validate invariants across diverse inputs using proptest.
Synchronous Properties
#![allow(unused)] fn main() { use proptest::prelude::*; fn arbitrary_message() -> impl Strategy<Value = Vec<u8>> { prop::collection::vec(any::<u8>(), 1..=1024) } proptest! { #[test] fn message_roundtrip(message in arbitrary_message()) { let encoded = encode(&message); let decoded = decode(&encoded).unwrap(); assert_eq!(message, decoded); } } }
Synchronous property tests verify that invariants hold across randomly generated inputs. The arbitrary_message strategy produces byte vectors of varying length.
Async Properties
#![allow(unused)] fn main() { proptest! { #[test] fn async_property(data in arbitrary_message()) { tokio::runtime::Runtime::new().unwrap().block_on(async { let fixture = create_test_fixture().await.unwrap(); let result = async_operation(&fixture, data).await; assert!(result.is_ok()); }); } } }
Async properties require creating a Tokio runtime inside the test body because proptest does not natively support async closures.
7. GuardSnapshot Pattern
The guard chain separates pure evaluation from async execution. This enables testing guard logic without an async runtime.
Testing Pure Guard Logic
#![allow(unused)] fn main() { #[test] fn test_cap_guard_denies_unauthorized() { let snapshot = GuardSnapshot { capabilities: vec![], flow_budget: FlowBudget { limit: 100, spent: 0, epoch: 0 }, ..Default::default() }; let result = CapGuard::evaluate(&snapshot, &SendRequest::default()); assert!(result.is_err()); } }
This test verifies that the capability guard rejects requests when no capabilities are present. The GuardSnapshot captures the state needed for pure evaluation.
Testing Flow Budget
#![allow(unused)] fn main() { #[test] fn test_flow_guard_blocks_over_budget() { let snapshot = GuardSnapshot { flow_budget: FlowBudget { limit: 100, spent: 95, epoch: 0 }, ..Default::default() }; let request = SendRequest { cost: 10, ..Default::default() }; let result = FlowGuard::evaluate(&snapshot, &request); assert!(matches!(result.unwrap_err(), GuardError::BudgetExceeded)); } }
This test verifies that the flow guard blocks sends when the requested cost would exceed the remaining budget.
8. TUI and CLI Testing
TUI State Machine Tests
#![allow(unused)] fn main() { mod support; use support::TestTui; use aura_terminal::tui::screens::Screen; #[test] fn test_screen_navigation() { let mut tui = TestTui::new(); tui.assert_screen(Screen::Block); tui.send_char('2'); tui.assert_screen(Screen::Neighborhood); } }
TUI state machine tests validate screen transitions and keyboard input handling without requiring a real terminal.
CLI and RPC Testing
CLI account commands and aura rpc share one typed command model
(aura_terminal::command::{Request, Response, execute}), so most coverage
drives requests directly:
#![allow(unused)] fn main() { use aura_terminal::command::{execute, Request, Response}; let response = execute(&peer.ctx, Request::ChatList).await?; assert!(matches!(response, Response::Channels(_))); }
tests/cli_rpc.rsruns simulation runtimes on the shared virtual-time fixture (tests/cli_rpc/simnet.rs, paused tokio clock) and drivesaura rpcsessions over in-memory pipes. Wait for outcomes withsubscribeevents or boundedcall_untilre-checks at quiescent points, never wall clock sleeps. It also checks that CLI and RPC give identical responses and that a CLI send matches the TUI send's semantic outcome.- Failures keep their typed category end to end: assert the RPC error
code(for examplenot_foundfor an unknown ceremony id) and, with the real binary intests/cli_production.rs, the process exit code it maps to (not_foundexits 3). - Home settings that other members observe (channel mode, access, roles)
are committed facts reduced by the governance reducer, never local
projection edits. Test them on two simulation peers across a dropped link
and a restart (
home_two_member_moderation), and assert the reduced signal on both clients rather than the writer's local state. - A slash command whose target does not resolve settles its semantic
operation failed with an error toast
(
tests/unit_slash_commands.rs), so lastop never keeps showing an earlier operation. tests/cli_json.rsandtests/cli_socket.rsrun the realaurabinary against a node serving the socket.tests/cli_production.rscreates an account through the TUI's staging path, then runs the binary against the production profile (no node) and throughaura serve. It relies on the test keyring above; setAURA_TEST_KEYRING_DIRper test so the test and binary share one store.- The published protocol schema is checked by
just ci-rpc-schema. - Check RPC count serialization at its
u64boundary and request limits at theiru32boundary. The architecture style lane also checks enum fields and nested containers in scenarios, runtime-event observations and conformance artifacts; skipped internal fields and erased phantom types are not wire integers. Native/browser runtime-event counts share one fixed width, with checked producer conversions.
Quint Trace Usage
Quint traces are model artifacts. Export them through the shared semantic scenario contract and execute real TUI and web flows through aura-harness rather than replaying Quint traces directly against the TUI implementation.
9. Conformance Testing
Conformance tests validate that implementations produce identical results across environments.
Conformance Lanes
CI runs two lanes. The strict lane compares native vs WASM cooperative execution. The differential lane compares native threaded vs cooperative execution.
# Strict lane
just ci-conformance-strict
# Differential lane
just ci-conformance-diff
# Both lanes
just ci-conformance
These commands run the conformance test suite and report any divergence between execution environments.
Mismatch Taxonomy
| Type | Description | Fix |
|---|---|---|
strict | Byte-level difference | Remove hidden state or ordering-sensitive side effects |
envelope_bounded | Outside declared envelopes | Add or correct envelope classification |
surface_missing | Required surface not present | Emit observable, scheduler_step, and effect |
Reproducing Failures
AURA_CONFORMANCE_SCENARIO=scenario_name \
AURA_CONFORMANCE_SEED=42 \
cargo test -p hxrts-aura-agent \
--test telltale_machine test_name \
-- --nocapture
Set the scenario name and seed to reproduce a specific conformance failure deterministically.
10. Runtime Harness
The runtime harness executes real Aura instances in PTYs for end-to-end validation.
Harness Overview
The harness is the single executor for real frontend scenarios. Scripted mode uses the shared semantic scenario contract. Agent mode uses LLM-driven execution toward goals.
Multi-host runs use one harness per host with the same run token. Set [run] fixed_ports = true so configured bind_address and lan_discovery.port values stay literal instead of being namespaced by the run token; peers on different hosts must agree on these ports.
The tracked LAN helpers live in scripts/harness/lan/. configs/harness/lan-host-{a,b}.toml name each host's LAN address as __HOST_ADDR__; drv.sh start renders the config with AURA_E2E_HOST_ADDR (detected from the primary interface by default), so no address is committed. Build and ship the exact commit's binaries, web bundle and runtime Nix closure from Host A with ship.sh; do not build on Air. fresh.sh <run-token> starts both drivers, onboards the standard cast and links contacts; lib.sh provides the request helpers used by scenario scripts.
Schedule these cross-machine helpers after complete in-process validation, required local frontend coverage, checkpoint gates and main smoke. Batch several declared E2E flows into one owned run; preserve per-flow results and both-host cleanup evidence. A successful LAN flow does not replace deterministic fault, cancellation or restart coverage. The patchbay lab (§13) settles one-host transport assertions first: real instances in separate network namespaces behind modeled NATs, link impairment, NAT flushes and link toggles. Only assertions that need real machines, real broadcast domains or independent hosts stay LAN-only.
Run a complete owned batch with AURA_E2E_REMOTE=user@host scripts/harness/lan/batch.sh <fresh-token> -- bash <checklist.sh> [arguments...]. It requires matching clean local/remote commits and the complete local smoke marker. Workflow success, failure and interruption all attempt both hosts' exact-token finalization independently, retain shutdown logs and return failure if cleanup refuses ownership. Interruption first cancels and waits for the owned checklist command before finalizing. The command and commit are recorded in .tmp/lan-checklist-<token>/; the caller must describe which flows its checklist actually covers.
finish-batch.sh <host-or-empty> <checkout> <token> success|failed delegates to the pinned driver's finalize operation. One persistent kernel lock outside the replaceable run directory serializes start, stop, finish and finalization; never unlink its inode while lifecycle users can exist. The driver checks the expected token after Nix bootstrap, binds the process identity to that token plus PID birth, executable and checkout, and retains the same lifecycle owner through shutdown and retention classification. Dead holders release kernel custody automatically; live contention and ambiguous identities fail closed. Background services and read-only process inspection cannot retain the lifecycle descriptor. Isolated retention and batch fixtures cover run replacement during bootstrap, concurrent owners, forced owner death, descriptor inheritance, independent host refusal and interruption. Actual paired-host confirmation remains a separate evidence requirement.
For paired device enrollment, record a fixed-commit manifest before starting the
batch: local and remote commit, the local smoke receipt, native and web artifact
hashes, the shared run token on both hosts, each actor's host and process identity, selected broker
endpoint and bind policy, and the exact test inventory. The ordinary LAN configs
do not enable a bootstrap broker; its default is disabled. A paired enrollment
run therefore needs an explicitly provisioned, authenticated broker reachable
from both hosts. LAN-visible HTTP binding is a development-only opt-in; it is
not evidence of a production-secure internet route. Keep its bearer and
invitation retrieval credentials out of committed configs, command arguments,
URLs, runtime logs and retained scenario snapshots. Do not use lib.sh's
general semantic/wait_snapshot evidence capture for secret-bearing setup,
enrollment and verifier transfers: those helpers retain whole responses and
snapshots. Capture only redacted operation and transport evidence, and retain
the original secret values in the owning process or a private transfer channel.
If private ToolApi receipt validation itself fails, the helper retains the
original response and validator stderr in owner-only 0600 artifacts under
the run's 0700 private directory and writes a separate redacted validation
category. Responses over 1 MiB are refused without parsing; the helper retains
only an explicitly truncated 0600 prefix of at most 1 MiB and a redacted
response_too_large receipt bound to the run, instance, method, and label. Inspect
that protected artifact locally to correct the exact schema mismatch; never
copy its contents into a shared checklist log or infer operation completion
from the broker ACK alone. Browser accepted runtime events carry canonical
runtime-event-<sequence> string IDs.
For a valid failed original approval operation, the paired checklist passes
its exact operation instance to lan_private_receipt. That helper keeps the
full response only as a 0600 private failure artifact, plus a separate
custody receipt naming the candidate source revision, committed tooling
revision and helper digest, run token, instance, method, and operation. The
ordinary receipt still contains only the typed domain/code. A failed foreign
operation is refused; a valid failure response is diagnostic evidence, not a
complete replay bundle or host acknowledgment.
For a local process-boundary diagnostic, run
scripts/harness/lan/single-host-enrollment.sh <fresh-token> <clean-peer-checkout>
with two clean same-commit checkouts and identical prebuilt native binaries.
The runner derives native-only alex-tui and barbara-tui configs from the
LAN templates, omitting browser and second-device instances. It provisions an
authenticated loopback broker and distinct profile ports, then uses the paired
private checklist. The final two-host LAN templates retain their browser
instances. Its single-host-result.json
retains exact operation, broker ACK, host acknowledgment, and reopen evidence;
private per-step receipts retain typed failures, and single-host-disposal.json
records each owner's shutdown.
cross_host_asserted:false prevents this evidence from satisfying the final
two-host batch. Use a fresh token and inspect private receipts on failure.
The terminal's StartDeviceEnrollment submission hands its original instance
to the app-owned setup verification and issuance workflow before awaiting it.
An issuer refusal must retain the workflow's ceremony failure domain and code
in the private operation receipt; a generic callback internal_error cannot
identify the failed enrollment stage. Keep source details inside the protected
owner and inspect the typed receipt before another process-boundary attempt.
The paired enrollment inventory must prove, in order: a provisional device on
one host exports its actual signed setup; the other host's issuer consumes that
exact external setup and emits the original enrollment code, signed manifest
and independently transferred verifier while the recipient has no import
operation; explicit approval submits one exact device_enrollment instance
and gives the receiver its scoped mailbox credential; the first authenticated
envelope reaches the original receiver across host/process boundaries, and
broker ACK of the exact signed-manifest/device/message receipt proves verified
receiver retention before terminal success is accepted; that instance reaches typed success
only after the recipient's actual host acknowledgment; the adopted authority
and two devices persist through same-profile restart; and both hosts release
their owned tasks at batch finalization. A matching authority ID, operation ID
without instance, broker candidate, code-ready event, or local browser run
alone cannot replace these assertions. Record typed failure and original
source on any refusal; keep the original profile and transfer available for a
permitted retry. The local browser approval/persistence/reopen scenario remains
separate evidence for browser storage and mounted controls.
For a browser recipient on Host B, set
AURA_E2E_ENROLLMENT_RECIPIENT=browser for provisioning and the paired batch.
The generated config selects only alex-tui and barbara-web, and keeps the
browser driver's broker endpoint on 127.0.0.1. The paired batch owns a
harness-only SSH reverse forward from Host A's authenticated LAN broker to
Host B's loopback listener, starting before fresh.sh launches the browser.
The browser-only recipient config has no native LAN bind, so the driver also
selects Host B's private LAN address for its owned web transport relay while
the page itself still loads from loopback; a public or malformed host address
refuses startup.
The SSH command carries no broker bearer or invitation token; generated
configuration keeps those in owner-private files,
outside URLs, logs and process arguments. Relay port readiness does not prove
registration, signed delivery, receiver ACK, host acknowledgment or reopen;
the paired checklist still needs those exact authenticated witnesses.
The native LAN finalizer takes an owner-only, bounded exclusive lease after
private ToolApi helpers release their shared leases. It then stops the original
REPL and requires the same-checkout owned-process inventory to be empty before
recording success. A held helper or live child retains the run for inspection;
repeating finalization after verified shutdown is safe for the same outcome.
For a clean checkout with no active run and no private request lease, drv.sh stop succeeds idempotently only while the persistent lifecycle lock is held,
no PID or launch identity remains, and the same-checkout process inventory is
empty. It does not create a private lease merely to acknowledge that state;
stale identity or a live helper still refuses the ship.
If the owned-process inventory is still nonempty, the finalizer retains an
owner-only process-kind and birth receipt in the run's private directory;
the live process still blocks completion.
The same inventory gates the next start; before its private directory exists,
an owner-only pre-start refusal receipt is kept in the existing run root.
The single-host two-process diagnostic starts the local issuer before its
receiver peer and disposes the peer before the issuer. That keeps the strict
same-checkout process inventory meaningful when both owners use one native
binary: a live peer must not be mistaken for a prior local orphan at admission
or still be present when the local finalizer checks its inventory.
The native devices list is a Settings/Devices projection. Open the Devices
section through OpenSettingsSection:"devices"; generic Settings does not
materialize its list. Capture the issuer's single current device there before issuance and
bind it to the signed invitee, original operation, and broker message.
device_enrollment_accepted observations report devices newly seen by the
app; their history is transient. A device_count=2 acknowledgment may name
either the signed invitee or that original issuer device. The event alone does
not prove membership. After the exact approval operation succeeds and this
app-owned acknowledgment appears, the paired checklist opens Settings/Devices
through the semantic command plane. Its canonical two-item list must contain
the signed invitee as current and the original issuer as the distinct peer,
before and after same-profile restart. The shared SettingsSection::Devices semantic value serializes as
"devices" in ToolApi requests. Absence of the list on an onboarding or
other settings section is not evidence that the canonical device record is
missing.
The recipient's hot authority selection may still name its provisional
authority after host acknowledgment. Treat the canonical two-device readback
as the pre-shutdown persistence witness; after same-profile restart, require
the reopened authority to equal the signed manifest's issuer subject. The
hot provisional authority is not evidence of durable adoption.
When a paired batch lacks the exact receiver ACK, retain the owner-only
broker-stage.json receipt from the paired run. Its authenticated broker
progress witness is scoped to the signed manifest subject, invitee device and
digest. The broker records the first successfully queued message ID in insertion
order, so later issuer retries cannot be mistaken for the original envelope.
The checklist observes within the original 120-second registration lifetime
and stops at the first missing registration, queue, receiver selection or exact
ACK stage. The receipt distinguishes no stored registration, a queued first
message, a message selected for authorized receiver retrieval, and an ACK after
verified immutable retention. Retrieval selection does not prove HTTP delivery
or receiver admission; only the exact ACK can satisfy the network-delivery
assertion. The receipt contains message IDs and envelope digests, never mailbox credentials or
envelope bytes, and remains diagnostic evidence when the run fails.
scripts/harness/lan/provision-enrollment.sh <fresh-run-token> prepares the
broker prerequisite without changing the production default. It writes
owner-only generated Host A/Host B configs under
.tmp/e2e/enrollment-provision-<token>/ and sends the Host B config over SSH
stdin, keeping credentials out of command arguments. The generated configs
select fixed ports, one shared random broker bearer, and distinct invitation
credentials for exactly two native TUI owners: alex-tui on Host A and
barbara-tui on Host B. The generated paired configs omit browser and second-device
instances; the general LAN templates retain those for later flows. Only
alex-tui hosts the broker at Host A's LAN address, with the explicit
development-only AllowLanDevOnly bind policy; barbara-tui uses its URL with a separate development-only private-LAN HTTP client
opt-in. The native client still refuses public, DNS, malformed, and HTTPS
endpoints without an authenticated TLS implementation. The client exception is
absent from the ordinary terminal release binary; for this paired LAN diagnostic,
build and ship the exact commit with AURA_E2E_LAN_HTTP_DEV=1 on
scripts/harness/lan/ship.sh, which selects the lan-http-dev Cargo feature.
Pass those generated config paths as
AURA_E2E_LOCAL_CONFIG and AURA_E2E_REMOTE_CONFIG to the owned batch.sh
run. Remote native requests enter drv.sh through the peer's pinned Nix shell,
including the private stdin channel, so login-shell tools cannot determine
whether the selected owner starts or receives a request. This provisions transport only. The ordinary drv.sh req/lib.sh
semantic path still places transferred codes in arguments or retained REPL
output, so it must not be used for the paired enrollment transfer. Send one
complete JSON request on stdin through lib.sh's req_private <instance>;
the selected driver verifies its REPL owner and forwards the request over that
owner's 0600 Unix socket. The private response returns on the same socket,
outside repl.out and the general scenario evidence. Keep it in process
memory, and pass it on stdin to lan_private_receipt <instance> <method> <label>
(with the expected operation instance for an original approval wait).
That helper writes one owner-only 0600 file per label and refuses an existing
file or symlink. It validates and retains only exact operation instance/state,
typed failure domain/code, host acknowledgment, and readiness; free-text
diagnostics, codes, screen names, and device-list IDs are omitted. Do not print
the raw response or store it outside the owner-only failure custody described
above.
For a ToolApi error, the same receipt records an allowlisted tool_failure
domain/code (including browser UI observation unavailability), or
unclassified for an unknown message. The original free-text error and browser
console tail stay outside the receipt.
Each invitation credential is registered by its own receiver and used only to
drain that receiver's broker invitation queue; the sender needs the shared
broker bearer, not the recipient's invitation credential. The signed pending
enrollment mailbox uses its separate scoped credential and verifier checks.
drv.sh start renders __HOST_ADDR__ into a token-specific owner-only copy
under the LAN run directory. Reopen evidence must pair the exact original
operation/host acknowledgment with an authoritative post-restart readiness,
authority and device-list observation; a restarted status alone is insufficient.
For an unlinked native pair, run batch.sh with
AURA_E2E_BOOTSTRAP=paired-enrollment and
bash scripts/harness/lan/paired-enrollment.sh as the checklist command.
That bootstrap creates the two real accounts without the ordinary fresh.sh
contact links. The checklist exports Barbara's signed setup through her
runtime, submits it to Alex, transfers the issued code, signed manifest and
retained verifier through stdin, and records the exact approval operation,
host acknowledgment and same-device reopen evidence in owner-only receipts.
Before fresh.sh starts either host, batch.sh writes an owner-only paired
preflight manifest containing both checked commits, the matching local smoke
receipt, compared local/remote native and web hashes, intended actor/host
process identities, the development-only broker endpoint/policy, and the exact
inventory. After the run, the private result records actual PID/birth identities
and the original operation/host/reopen receipts without any transferred secret.
Native restart does not accept a browser evidence handle; the checklist keeps
that exact operation in its pre-restart receipt and verifies fresh readiness,
authority and devices after restart, without assuming a fixed screen.
The checklist explicitly selects Settings/Devices before its list observation.
For browser recipients, submit_semantic_command acknowledges submission,
not application. The authoritative snapshot must show Settings with the
settings_sections/devices selection and both distinct canonical devices,
including the signed invitee marked current. On an observation failure, the
checklist retains the first and final successful original snapshots for both
acceptance and reopen as private 0600 artifacts. Their redacted witnesses record snapshot version, screen,
section selection, list shape, exact operation, actual authority-response
comparison from a separately retained private response, and the hash of the
earlier exact host-ACK receipt. A later snapshot may no
longer contain the historical host event; the earlier verified receipt supplies
that evidence. The pre-reopen authority comparison is diagnostic because the
live browser controller may still hold its provisional identity. The reopened
same-profile owner must report the signed subject. These snapshots classify a
missing projection; they do not replace the required host ACK or reopen proof.
The checklist decodes only the nonsecret selector from the issuer's exact
signed manifest through the pinned native codec on stdin. After import
submission, it requires one bearer-authenticated broker ACK for that manifest,
device and guarded message ID; the ACK is issued after the original receiver
verifies and immutably retains the frame. It records the redacted ACK with
the distinct host/process identities and sets network_delivery_asserted
only for that complete run. The signed manifest decode is a selector, not a
replacement for the receiver's independently retained verifier.
Local TUI instances write plaintext runtime tracing to runtime.log under the instance's transient root (passed as AURA_TUI_RUNTIME_LOG_FILE, honored only in harness mode, filtered by RUST_LOG). tail_log reads that file first and falls back to the PTY capture. Treat it as diagnostic output, not semantic evidence.
Shared flows should be authored semantically once, then executed through the harness using either the TUI or browser driver. Do not create a second frontend execution path for MBT or simulator replay. Core shared scenarios should use semantic actions and state-based assertions. Avoid raw selector steps, raw press_key steps, and label-based browser clicks except in dedicated low-level driver tests.
When setup and a later operation share an operation ID for one actor, use
capture_operation_instance before the later submission, then give
operation_state_is the captured variable in after_instance. This requires
the requested state on a different observed instance. When the importing actor
has no prior operation of that ID, use assert_operation_absent for that actor
before opening the modal, then assert its operation_state_is = succeeded after
approval. The absence assertion reads the actor's semantic snapshot; it fails
if any prior operation of that ID is present. This prevents setup or another
actor's success from satisfying enrollment-import completion.
The harness checks the selected actor's observed operation ID, state, and
optional after_instance before it consults a matching exact submission
handle. For browser enrollment approval, assert modal_confirm_button is
mounted and activate that control after filling the code, manifest, and
independent verifier; a raw Enter key is not the approval action in this
scenario.
Run Config
schema_version = 1
[run]
name = "local-loopback-smoke"
pty_rows = 40
pty_cols = 120
seed = 4242
[[instances]]
id = "alice"
mode = "local"
data_dir = "artifacts/harness/state/local-loopback/alice"
device_id = "alice-dev-01"
bind_address = "127.0.0.1:41001"
The run config declares the execution environment. Each instance gets a unique data directory, device ID, and bind address. The seed ensures deterministic behavior across runs.
Scenario File
id = "discovery-smoke"
goal = "Validate semantic harness observation against a real TUI"
[[steps]]
id = "launch"
action = "launch_actors"
timeout_ms = 5000
[[steps]]
id = "nav-chat"
actor = "alice"
action = "navigate"
screen_id = "chat"
timeout_ms = 2000
[[steps]]
id = "chat-ready"
actor = "alice"
action = "readiness_is"
readiness = "ready"
timeout_ms = 2000
Scenarios define ordered steps with timeouts. Each step targets a specific actor and asserts a condition or triggers an action.
Running the Harness
# Lint before running
just harness-lint -- --config configs/harness/local-loopback.toml \
--scenario scenarios/harness/semantic-observation-tui-smoke.toml
# Execute
just harness-run -- --config configs/harness/local-loopback.toml \
--scenario scenarios/harness/semantic-observation-tui-smoke.toml
# Replay for deterministic reproduction
just harness-replay -- --bundle artifacts/harness/local-loopback-smoke/replay_bundle.json
Always lint before running to catch configuration errors early. For a failed frontend or Tool API run, replay its existing bundle first with the same prebuilt executable artifacts. The harness checks the recorded checkout revision and exact harness/local-instance executable hashes (and the browser driver script when selected) before launching instances. Hash equality proves the replay uses identical executable bytes; the checkout revision is an additional compatibility label, not a claim about an external binary's build provenance. A divergence reports the first action index, request method, response classes, and redacted JSON field path/value shapes, including same-variant payload drift. Response values, enrollment codes, and raw diagnostics stay in the protected run artifacts. Rebuild and record a new bundle only when source or an executable artifact changes. Older bundles without compatibility evidence cannot authorize replay, and this Tool API replay does not restore runtime checkpoints or credentials. Remote SSH executable identity and browser web assets are not yet verified by this guard; retain their separate build receipts.
Interactive Mode
Use tool_repl for manual validation.
cargo run -p aura-harness --bin tool_repl -- \
--config configs/harness/local-loopback.toml
The REPL accepts JSON requests for screen inspection, key input, and wait conditions.
{"id":1,"method":"screen","params":{"instance_id":"alice"}}
{"id":2,"method":"send_keys","params":{"instance_id":"alice","keys":"3n"}}
{"id":3,"method":"wait_for","params":{"instance_id":"alice","pattern":"Create","timeout_ms":4000}}
These requests query screen state, send key sequences, and wait for patterns to appear in the rendered output.
Harness CI
just ci-harness-build
just ci-harness-contract
just ci-harness-replay
just ci-harness-matrix
just ci-shared-flow-policy
These commands build the harness, validate the contract, replay recorded coverage, run the full shared frontend matrix, and enforce shared-flow policy.
just ci-shared-flow-policy validates the shared-flow contract end to end. It checks that aura-app shared-flow support declarations are internally consistent. It verifies that every fully shared flow has explicit parity-scenario coverage and that required shell and modal ids still exist. It confirms browser control and field mappings still line up with the shared contract and that core shared scenarios have not drifted back to raw mechanics. The shared-flow aggregate now calls Aura policy code for the adaptive-privacy runtime-locality and legacy-sweep gates through toolkit/xtask, while the remaining shared-flow checks stay as thin shell orchestration around harness governance and targeted contract tests.
just ci-user-flow-policy is the diff-aware guidance gate for this surface. When shared UX contributor policy or parity-sensitive TUI and browser semantics change, update this guide in the same change so the user-flow guidance sync stays green. Local .claude skills may remain gitignored, but the authoritative contributor-facing testing guidance must still land in tracked docs.
The shared-flow policy scripts target the published Cargo package names for renamed Layer 6 crates and macros. When invoking raw Cargo commands behind these lanes, use hxrts-aura-app and hxrts-aura-macros package ids instead of the legacy aura-app and aura-macros selectors. File-system crate paths remain crates/aura-app and crates/aura-macros.
When shared flows export data through runtime events, the event payload is part of the contract. Invitation and device-enrollment code capture should come from RuntimeFact payloads in UiSnapshot.runtime_events, not clipboard scraping or frontend-local heuristics. Shared chat waits should bind to semantic selection state so the harness targets the single shared channel instead of falling back to incidental render order.
AMP transition waits follow that runtime-event rule. Shared scenarios for normal transition, delayed or offline witnesses, conflicting A2 certificates, subtractive membership, emergency quarantine, cryptoshred, rejected emergency attempts, cooldowns, duplicate-signing evidence, recovery replay, and authority-governance non-removal should wait on RuntimeEventKind::AmpChannelTransitionUpdated, parity snapshots, operation lifecycle, quiescence, and final reduced channel state.
These scenarios must stay actor-based and semantic-only. Raw DOM selectors, PTY keys, compatibility steps, and label-only assertions are diagnostic or frontend-conformance tools. They are not shared AMP evidence.
Use just ci-ui-parity-contract for the narrower parity gate. That lane validates shared screen and module mappings, shared-flow scenario coverage, and parity-manifest consistency without running a full scenario matrix.
11. Test Organization
Organize tests by category within each crate.
#![allow(unused)] fn main() { #[cfg(test)] mod tests { mod unit { #[aura_test] async fn test_single_function() -> aura_core::AuraResult<()> { Ok(()) } } mod integration { #[aura_test] async fn test_full_workflow() -> aura_core::AuraResult<()> { Ok(()) } } mod properties { proptest! { #[test] fn invariant_holds(input in any::<u64>()) { assert!(input == input); } } } } }
Grouping tests by category makes it easy to run subsets and understand coverage at a glance.
Running Tests
# All tests
just test
# Specific crate
just test-crate aura-agent
# With output
cargo test --workspace -- --nocapture
# TUI state machine tests
cargo test --package aura-terminal --test unit_state_machine
Use just test for the full suite. Use just test-crate for focused iteration on a single crate.
Build and Caching
nix/build-cache-key.nix is the single pure key definition for the proposed
dependency-only warm tree. flake.nix exports that function, and
scripts/dev/build-cache-key.sh INPUT.json queries it with explicit producer
inputs: platform, dev-shell and toolchain store paths, immutable vendor path
and lock hash, dummy manifest/config paths, package, profile, features, target,
Rust flags, C compiler, wrapper, incremental policy, and other declared
build-script environment. scripts/dev/build-cache-key.sh --debug queries the
flake's evaluated debug-lane producer key. The opt-in vendor-deps and
deps-debug flake outputs materialize an immutable full-lock vendor directory
and one debug dependency tree; neither changes the dev-shell Cargo dispatcher
or rehydrates a worktree. The Darwin debug producer compiles from immutable
dummy source, retains the raw Cargo target and generated OUT_DIR files, and
uses declared Rust remap, rpath, and linker inputs. Its check phase still
compiles test dependencies; a checked Cargo artifact record identifies only
the disposable local dummy test executable for omission. The pinned Darwin
producer passed a same-derivation rebuild, and a fresh writable copy ran its
exact check --all-targets and build --lib command graph with external
dependencies fresh. This does not certify other Cargo commands, profiles, or
Linux. Copied depfiles retain the original producer store path, so that output
and its closure must remain GC-rooted for valid consumption. Rehydration and
dispatcher integration remain disabled until command compatibility, integrity,
and recovery checks pass. An
absent vendor path or any unrecorded producer input
must prevent future warm-tree reuse rather than fall back to a guessed key.
prune-inactive-lane.sh --lane LANE --assert-idle -- COMMAND checks the same
checkout lock, scoped builders, open files, and symlink boundaries as guarded
pruning, then keeps that lock until COMMAND exits. An absent lane is allowed
for a future restore; --apply still requires an existing lane and removes it.
The assertion does not validate a warm-tree artifact or enable rehydration.
For the complete browser enrollment scenario, build the native
bootstrap_broker_fixture example with --features simulation in the same guarded batch as the browser
inventory. Set AURA_BROWSER_BROKER_FIXTURE to its executable path and wrap the
harness command with scripts/verify/browser-enrollment-broker.sh. The wrapper
starts a loopback broker with a fresh authorization token, passes its endpoint
and token to the harness, and waits for broker disposal after the harness exits.
The harness gives each page a separate retrieval token. The browser driver
initializes credentials in origin session storage before page bootstrap; only
the endpoint is a query parameter, so startup URLs and logs omit credentials.
Production enrollment authorization and signed verifier checks still run.
Cargo.lock is committed, together with the lockfiles of the excluded
toolkit/xtask and toolkit/lints workspaces, so every checkout, CI runner and
remote host resolves the same dependency graph that the advisory audit and the
hermetic Nix build were run against. Cargo.nix is generated from it by
crate2nix and is also committed; just ci-cargo-nix-check (the Cargo.nix Sync
CI job) regenerates it into a scratch file and fails on any difference. After a
dependency change, run cargo update -p <crate> or edit the manifest, then
just generate-cargo-nix, and commit Cargo.toml, Cargo.lock and Cargo.nix
in the same change. Pre-commit and the dev scripts use --locked, which
requires that committed lockfile. Lockfile merge conflicts are resolved by
taking either side and running cargo update --workspace, which re-resolves
only the conflicting entries.
Workspace Clippy, including just ci-clippy and toolkit-clippy-strict, uses
Aura's pinned shell Cargo dispatcher. scripts/toolkit-shell.sh routes the
aggregate Clippy command through that dispatcher and enters Aura's Nix shell
when needed. The shared toolkit's raw Cargo Clippy command can select installed
Cargo-home plugins; it must not bypass the Aura dispatcher. The isolated
ci-build-cache-policy fixtures verify arguments and exit status for both entry
paths.
just ci-harness-browser and just ci-harness-matrix-web acquire the same
checkout build budget before preparing browser tools, web assets or harness
binaries. Nested invocations reuse the held admission. These lanes preserve
existing tool caches and rely on the canonical sweep and admission policy;
they do not delete build lanes when disk space is low. Use guarded
just prune-inactive-lane <lane> --apply only for an idle lane.
Use wasm-profile for the canonical Cargo [profile.wasm] output at
target/wasm32-unknown-unknown/wasm. It differs from wasm-debug,
wasm-release and wasm-host-release; pruning it preserves those siblings.
Its apply path refuses active checkout builders, production/harness consumers,
open files, build/prune locks and symlinked lanes or parents. This is explicit
idle-lane cleanup, not an added automatic pruning candidate. Isolated
browser admission and command-failure fixtures run in ci-build-cache-policy.
Route builds through scripts/dev/build-budget.sh. It writes to the
checkout's own target/ (it unsets CARGO_TARGET_DIR), uses a per-checkout
soft target (AURA_BUILD_TARGET_CAP_GIB, default 10 GiB), and admits a
build only if the volume keeps AURA_BUILD_MIN_FREE_GIB (default 15) free
after the reservations of other admitted builds and the incoming build's
estimated growth. AURA_BUILD_RESERVE_GIB (default 4) GiB is the fallback
without prior measurements. Admission uses the greater of same-lane receipt
growth and recent TSV growth for the same profile and target triple, plus 1 GiB
for sampling margin. Set AURA_BUILD_MIN_RESERVE_GIB to an explicitly estimated
minimum when cold inputs require more space than the recorded workload; it
raises the measured or fallback reservation and never lowers either one. The
receipt records this minimum separately from the effective reservation. This
estimate does not certify measured growth or change either disk floor.
A failed build that stopped before linking therefore cannot
replace stronger completed-build evidence. Each admitted build holds that amount
under ~/.cache/aura-build/reservations until it exits. The admission lock is
held only while checking and reserving,
and only builders of the same checkout block its sweeps, so two worktrees can
build at once.
For exact gates commands running just ci-user-flow-policy, admission uses
only growth measured for that same recipe, source, toolchain, profile, feature,
target, Git ref map and policy-selector identity. Moving a default diff base
invalidates prior measurements even when checkout files and HEAD are unchanged.
Guidance file overrides distinguish unset from explicitly empty values.
Shallow or grafted history uses the conservative general estimator instead.
Broad ownership-gate and legacy profile peaks do not
describe this workload. The first such run retains the 4 GiB cold reservation;
later runs use the matching measured peak plus the normal 1 GiB margin. The
recipe still runs all its checks, including macro compilation, and the 15 GiB
admission and 5 GiB emergency floors remain unchanged. Other gate commands
continue to use their existing estimates.
The wrapper retains wasm-debug during direct debug Cargo commands with
--target wasm32-unknown-unknown. A shell batch hides its compiler arguments;
pass --preserve-cache-lane wasm-debug to the outer wrapper when that batch
uses the same cache. This prevents pre-admission and post-command guarded
cleanup from deleting its warm artifacts. Other inactive lanes can still be
reclaimed, and insufficient disk headroom still refuses admission. Global
sweep skips any preview that would evict the declared incoming lane.
When recovery is needed, the default nonincremental build first reclaims the
inactive debug-incremental lane through the guarded lane cleaner, preserving
reusable debug dependencies. Explicit CARGO_INCREMENTAL=1 builds retain that
lane and its debug parent. Recovery then tries other guarded inactive lanes.
The target may remain above the soft cap while free space meets the admission
floor; a global Cargo sweep runs only when headroom falls below that floor.
Remaining protected excess is reported. Live-process, open-file,
release-artifact and disk-floor protections still apply.
When measured incoming growth would miss the admission floor, guarded cleanup
ranks nonrelease lanes from stale linked worktrees first, then local inactive
lanes, by reclaimable size. A linked worktree is stale only when it has an old
terminal receipt, no receipt updated in the past 24 hours, no source changes,
and no scoped editor, shell, or builder process. Missing evidence stays unknown.
Soft-cap-only recovery considers local lanes. The selected incoming cache and
release, web-release and canonical wasm-profile outputs are never automatic
candidates. Every candidate still passes the independent lane cleaner's live
process, open-file, symlink and lock checks at deletion time.
To preview admission for a specific command, pass the same lane and command
to scripts/dev/build-budget.sh --dry-run --no-prune --lane <lane> -- <command>.
The preview reads the current source/workload identity, measured receipt peaks,
and live reservations, then prints free space, incoming growth reservation,
the 15 GiB floor, margin, and an advisory admission outcome. With no command,
the incoming reservation is unknown. The exact gates commands
just ci-user-flow-policy, just ci-build-cache-policy, and the actual
_policy-check child argv cargo run --quiet --manifest-path toolkit/xtask/Cargo.toml -- check security-boundary-policy have distinct
source/tool/recipe-bound workload identities. Each retains the conservative
4 GiB cold-start reservation until its own receipts provide measured peaks;
an unrelated native aggregate's profile peak cannot stand in for that command.
Failed runs' measured growth still counts. Extra arguments or command overrides
do not qualify for this exact-command treatment. The outer just _policy-check
invocation is a different argv and remains generic; the recognized security
child still compiles and executes the real toolkit policy check. If a canonical identity
cannot be certified, preview reports unknown with a conservative generic
estimate; it does not claim admission. Preview creates no receipt, reservation,
or lock, runs no command, and removes no stale reservation or cache. Capacity
can change after the snapshot; only the real locked admission decides a build.
For machines with a separate local filesystem, set AURA_COLD_CACHE_STORE to
an existing directory on that volume. Guarded cleanup then exports eligible
nonrelease lanes to a private, signed and checksum-verified snapshot before it removes
the local copy. scripts/dev/cold-cache-store.sh --restore --lane <lane>
restores a snapshot for the same clean checkout and source revision when the
lane is absent and the shared disk reservation still leaves the 15 GiB floor.
The signing key remains in the local build shared directory on the source
filesystem. A dirty checkout refuses cold export and retains its local lane;
admission may refuse until that source is committed or the store is unset.
The store refuses the source filesystem and unrecognized filesystem types,
including network mounts. It is not a LAN transfer mechanism. Without a
separate volume, leave the variable unset; no cold export occurs. The current
Mac has no such volume provisioned, so activation requires mounting one.
On macOS, two APFS volumes in the same container also share free capacity;
the cold store rejects that pairing even when their device IDs differ. Use a
separate APFS container on independent storage, and verify its free capacity
before enabling exports. The /nix volume on the development Mac shares the
source APFS container and is not a cold store.
The optional SSH backend is a separate, explicit operation; setting its
variables does not enable automatic build-budget export. Set
AURA_COLD_CACHE_REMOTE_HOST=user@host and
AURA_COLD_CACHE_REMOTE_DIR=/absolute/private/ext4/path, leave
AURA_COLD_CACHE_STORE unset, then run
scripts/dev/cold-cache-store.sh --export --root /absolute/clean/checkout --lane wasm-root-profile.
To recover the same absent lane, use the same environment and replace
--export with --restore. The host must already be trusted in SSH known
hosts; the script uses batch mode and strict host-key checking. It accepts
only a separately identified Linux host with an owner-only 0700 directory
on a local block-backed ext4 filesystem. An active builder, open lane file,
dirty checkout, linked artifact, existing remote snapshot or stale remote
capacity lock refuses export. Inspect an interrupted .pending snapshot or
lock rather than stealing it or assuming that a partially transferred archive
is ready.
SSH export signs a source-root/revision/lane and archive manifest and a
remote-host/machine/device location receipt with a 0600 key retained on the
source filesystem. It checks remote archive size and hash, atomically publishes
the owner-only ready directory, reads it back, then publishes a private
local rollback receipt before guarded source pruning. Restore requires that
same clean checkout, revision, lane, signing key and remote identity. It
verifies both signatures and the archive, rejects links or unsafe members,
and stages extraction before atomically publishing the absent lane. Admission
reserves room for the downloaded archive and the larger of the original
allocated tree or logical archive size, plus a 1 GiB
margin while retaining the local 15 GiB floor and other builds' reservations;
export separately retains the configured remote free-space floor. These
receipts restore an inactive compiler cache at its original source identity.
The archive's checkout revision identifies its export/restore context; it does
not establish the build revision of each cached binary. Preserve the original
build receipts and web provenance markers for artifact admission.
The LAN ship owner remains responsible for shipping deployable artifacts.
For a large idle compiler lane on the authenticated SSH backend, pass
--compression gzip-1 to --export. This writes a schema 2 archive using the
Nix-selected gzip executable and signs its exact tool identity, compressed
bytes, expanded tar bytes, and a private content/mode/mtime member inventory.
Plain schema 1 snapshots remain supported; restore selects the format from
the signed location receipt without a compression flag. Before extracting a
compressed archive, restore verifies the signed compressed bytes, refuses an
expanded stream beyond the signed bound, checks the full decoder exit status,
validates tar member kinds and paths, and compares the restored member
inventory in private staging before publishing the absent lane. The normal
remote 15 GiB floor plus 1 GiB margin and local 15 GiB floor remain in force;
restore reserves compressed download plus the larger of original allocation
and logical tar size plus 1 GiB. For a complete debug profile, the same
live-builder, live-consumer, open-file, link and clean-source checks apply.
Export is explicit and does not make any cached binary's archive revision its
build provenance. The authenticated compressed roundtrip and refusal fixture
runs separately from just ci-build-cache-policy with
AURA_COLD_CACHE_TEST_REMOTE_HOST=user@host
AURA_COLD_CACHE_TEST_REMOTE_BASE=/private/ext4/path
nix develop --command bash scripts/dev/test-cold-cache-compressed.sh.
Completed LAN run evidence has a separate, explicit SSH archive mode. Use
scripts/dev/cold-cache-store.sh --export --root /absolute/clean/checkout --run-host <host-id> --run-id <run-id>
with the same remote settings above. It accepts only a canonical
.tmp/e2e/run/<host-id>/artifacts/runs/<run-id> bundle with a completed,
unpinned retention manifest; either a successful or failed run may be retained.
The newest successful run remains local. Export refuses active readers,
open files, links, dirty source, and insufficient remote capacity. It signs
the run identity and a private member inventory of content and metadata,
verifies the remote copy, and leaves a local signed location and rollback
receipt before deleting only that exact run directory. Keep that local pointer
and signing key. Restore uses --restore with the same host and run IDs,
requires the original clean revision and an absent original path, verifies
the private inventory, and atomically publishes the restored bundle after
disk admission. An interrupted remote .pending bundle is not a ready copy;
inspect it before retrying. This mode does not archive arbitrary diagnostic
or Codex logs and does not change compiler-cache or LAN artifact provenance.
The authenticated roundtrip regression runs separately from
just ci-build-cache-policy: set AURA_COLD_CACHE_TEST_REMOTE_HOST=user@host
and AURA_COLD_CACHE_TEST_REMOTE_BASE=/absolute/private/ext4/path, then run
nix develop --command bash scripts/dev/test-cold-evidence-remote.sh.
It creates and removes synthetic private bundles only; it does not select or
archive a real run. The ordinary cache-policy gate covers the local cold-store
contract without requiring an SSH host.
Each budgeted command prints a JSON receipt path under
artifacts/disk-budget/receipts/. The atomic snapshot records the source
revision and fingerprint (including nonignored new source files), declared
AURA_BUILD_PACKAGES, AURA_BUILD_FEATURES, and AURA_BUILD_TEST_INVENTORY,
wrapper, driver and active phase command identities, current phase,
command/final exit statuses, cache cleanup
observations and artifact paths. Missing metadata and unexecuted phases remain
unknown; an opaque command's exit does not prove test discovery or execution.
Source capture must succeed before a receipt is allocated: failed Git revision,
tracked diff, untracked enumeration (including partial output), file/symlink read
or digest production refuses initialization and emits no partial fingerprint.
The private source-enumeration directory stays outside the checkout. When CI
selects a checkout-local TMPDIR (including a symlink into it), source capture
uses the system temporary directory instead; compiler/build TMPDIR is unchanged.
The existing receipt source fingerprint retains its legacy SHA-256 encoding;
algorithm migration requires an explicit versioned compatibility change.
Nested scripts that call build-phase.sh publish each actual Cargo phase's
package, features, target and filter under metadata.phase_commands; the
exact expected inventory is attached to its discovery and execution phases.
When a script does not use phase commands, declare known selectors with
AURA_BUILD_PACKAGES, AURA_BUILD_FEATURES and AURA_BUILD_TEST_INVENTORY;
otherwise the receipt leaves them unknown. Every admitted child also gets a
command phase with start, finish and outcome, even for opaque bash/just
gates. Unambiguous nested phase selectors and expected inventories populate
the top-level metadata when no explicit declaration exists.
Admission refusal records its measured headroom reason without claiming a
command started. Command and phase logs live inside the private receipt
directory. The receipt keeps only a short failure identity (test name and
source location when safely parseable, or a status class) and
points to those protected logs for details. At terminal status, an atomic
completion.json beside the receipt provides its path, exit status and UTC
completion time for file watchers, after command output has flushed.
For coordinator wakeups, create a one-shot private subscriber with
bash scripts/dev/receipt-events.sh --create, then block on
bash scripts/dev/receipt-events.sh --next "$FIFO" in a separate caller-owned
session. Pass that exact path as AURA_BUILD_EVENT_FIFO="$FIFO" to the
budgeted command. The next wakeup prints only the receipt path, source
fingerprint, event kind and sequence, and redacted status; open the receipt for
the authoritative admission, dependency, failure, and artifact evidence.
Restart --next for each later wakeup. A reader that starts late recovers
events with bash scripts/dev/receipt-events.sh --recover "$RECEIPT" "$LAST_SEQUENCE";
the receipt's serialized event sequence is durable even when no listener was
present. Close an idle FIFO with --close "$FIFO". A missing or invalid reader
cannot block or change a build result; the receipt records each advisory
delivery as sent, missed, or not configured. The event stream never contains
command arguments or protected output values. Completion wakeup follows the
flushed output and atomic completion.json publication.
The command tree receives stdout/stderr for capture, while the wrapper's extra
FIFO writer is closed before command execution so detached compiler daemons
cannot retain it and delay terminal receipt publication.
Read JSON with jq; never source or evaluate receipt contents.
Receipt read/modify/write updates use a bounded writer lock, preserving
concurrent phase and native-cleanup observations. A stopped writer's lock is
retained and updates refuse with exit 79; each new build uses a fresh receipt
directory, so an old lock cannot block a later build.
The cleanup_events array retains pre-admission and post-command operations,
including native guard refusals, skipped sweeps, raw exits and measured sizes.
Lane removals reuse the cleaner's lane measurement; sweeps observe target
sizes. Reclaimed bytes remain separate from command outcomes and are unknown
when a measurement is unavailable. The cleanup summary describes only
post-command collection, so a failed command can retain successful earlier
reclamation events.
Within one budgeted lifetime, use bash scripts/dev/build-phase.sh compile -- COMMAND..., followed by discovery and execution phases with
--expected-tests FILE -- COMMAND.... The file contains one exact Rust test
name per line. Discovery requires standard --list output, execution requires
pretty text harness output without --quiet (JSON output is unsupported);
--nocapture is supported when protected phase output retains assertions.
Both phases require a nonempty exact match. The runner executes the command itself and records its
raw exit separately from inventory validation. The expected inventory is
selected before command execution; missing tests fail with exit status 78.
Execution counts include pretty harness ok and FAILED terminal results,
with separate passed, failed and ignored counts. An ignored test cannot satisfy
the required execution inventory. A matching inventory preserves a failing
command's original exit status, including 101. The canonical
run-exact-fixtures.sh batch compiles one executable, discovers every declared
exact name before running any fixture, then executes those names with
fail-fast behavior. A missing later declaration prevents all execution; a
source change during discovery or execution refuses the batch.
Pass --timings to collect Cargo's timing report during that same necessary
compilation. The compile phase records the option in its command arguments;
discovery, exact inventories, execution and failure handling remain unchanged.
Use a separate disposal phase for an actual native shutdown/cleanup command;
its result remains independent of semantic or compile failure. Completion
prints the final status and receipt path, so coordinators can inspect one
snapshot instead of reconstructing status from logs and process trees.
The dev shell exports RUSTC_WRAPPER=sccache with one shared store at
SCCACHE_DIR (default ~/.cache/aura-sccache, capped by
SCCACHE_CACHE_SIZE, default 10G). Every worktree and checkout reuses its
compiled dependencies. sccache caches only non-incremental compilations, the
default, and passes CARGO_INCREMENTAL=1 compilations through. Set
AURA_NO_SCCACHE=1 at shell entry or on a single cargo command to opt out.
just disk-report shows the shared store's size. sccache --show-stats
shows hit rates.
LAN run binaries are built by scripts/harness/lan/ship.sh from a clean
commit with Cargo's lan profile: release optimization without whole-program
LTO (lto = false, 16 codegen units). aura (with the terminal feature) and
tool_repl build in the checkout's target/ through the build budget, so
unchanged crates come from target/ and sccache and a one-crate change
rebuilds only that crate and its dependents. ship.sh rsyncs the binaries,
sends the Nix store paths they reference at run time (dev-shell libraries,
listed by scripts/harness/lan/runtime-refs.sh) with nix copy (the remote
user must be a Nix trusted-user), and keeps the web bundle on dx. Web
build-output symlinks are checked against regular files under the
fixed checkout's public assets or the Nix store before transfer, then copied
as files so an absolute local checkout path cannot break the remote bundle.
bash scripts/harness/lan/test-ship-web-assets.sh covers the absolute-link
transfer and escaping-link refusal. The dev shell profile and those run-time
paths are GC roots under .nix-ship/ on both
hosts; just nix-store-gc reports the roots it keeps and the reclaimable
store paths, and just nix-store-gc --apply collects them.
The dev profile builds third-party dependencies at opt-level = 1 (2 for
curve25519-dalek and frost-ed25519) without debuginfo, and workspace crates
with line tables only. Set CARGO_PROFILE_DEV_DEBUG=true for a debugging
session; it rebuilds the workspace crates.
For a local edit-test loop in aura-agent, opt in to incremental compilation
and run one integration binary or a lib filter:
CARGO_INCREMENTAL=1 bash scripts/dev/build-budget.sh --lane agent-loop -- \
cargo test -p hxrts-aura-agent --lib <filter>
CARGO_INCREMENTAL=1 bash scripts/dev/build-budget.sh --lane agent-loop -- \
cargo test -p hxrts-aura-agent --test runtime_integration <module>::
Measure rebuild time and target-directory growth on the selected host; warm
dependencies alone do not establish a fast changed-crate rebuild. Use the
existing exact-fixture runner's --timings option on a necessary compilation
before considering changes to test targets or compiler configuration. The
incremental cache costs several GiB; just prune-inactive-lane debug-incremental reclaims an idle lane. CI and gates stay non-incremental.
aura-agent sets autotests = false and aggregates its integration tests
into a few binaries: runtime_integration, home_flows (also the
reduced-stack accept-chain lane), telltale_machine, plus the separate
lan_integration, compile_fail, custom_provider_fidelity and
web_runtime_bridge_wasm. Add a new test file as a mod of the matching root
file in crates/aura-agent/tests/. Select one file with its module path, for
example --test telltale_machine telltale_machine_parity::.
cargo nextest run -p <crate> is available in the dev shell for local
per-test timing. Gates keep libtest, since their parsers read libtest output.
12. Best Practices
Test one behavior per function and name tests descriptively. Use fixtures for common setup. Prefer real handlers over mocks. Test error conditions explicitly. Avoid testing implementation details and focus on observable behavior.
Keep tests fast and parallelize independent tests.
13. Holepunch Backends and Artifact Triage
Use the harness --network-backend option to select execution mode.
# Deterministic local backend
cargo run -p aura-harness --bin aura-harness -- \
run --config configs/harness/local-loopback.toml \
--network-backend mock
# Native Linux Patchbay (requires Linux + userns/capabilities)
# The Nix shells provide tc, nft and conntrack; patchbay enters a user namespace itself.
cargo run -p aura-harness --bin aura-harness -- \
run --config configs/harness/local-loopback.toml \
--network-backend patchbay
# Real instances inside lab namespaces (Linux; aura built with aura-effects/test-keyring)
AURA_HARNESS_AURA_BIN=target/debug/aura cargo run -p aura-harness --bin aura-harness \
--features patchbay-backend -- \
run --config configs/harness/patchbay-lan.toml \
--scenario scenarios/harness/scenario13-mixed-contact-channel-message-e2e.toml \
--network-backend patchbay
Patchbay is the authoritative NAT-realism backend for holepunch validation and
runs only on a Linux host with unprivileged user namespaces (ubu1 for this
project). The former patchbay-vm mode is retired: it handed Aura topology
TOML to patchbay's sim runner and never launched an Aura process. A run config
with run.network_topology provisions a lab and forks each instance that maps
a lab_authority inside its device namespace; such a run refuses backend
fallback instead of silently running on the host. Multi-instance runs need an
aura built with aura-effects/test-keyring, since a production build takes
one platform keyring lease per OS identity. Keep deterministic non-network
logic in mock backend tests to preserve fast feedback.
The Linux harness pins Patchbay to upstream revision
5cc60db1eb190360dfcd64eaf2f829bce4072551 (the patchbay-v0.7.0 tag). The Nix
flake input that builds the patchbay CLI (for patchbay serve over a lab run
directory) pins the same revision; scripts/ci/holepunch.sh audit fails when
the two disagree. The former hxrts/patchbay fork is retired. Patchbay 0.7
models NAT as three RFC 4787 behavior tiers (Open, Moderate, Strict) and
Aura's deployment-named NatPreset values map onto them in
network_lab::topology_adapter::to_patchbay_nat:
NatPreset | patchbay | RFC 4787 behavior | RFC 3489 name |
|---|---|---|---|
none | None | no translation | public |
full_cone | Open | EIM + EIF | full cone |
restricted | custom NatConfig | EIM + ADF | restricted cone |
home, cgnat | Moderate | EIM + APDF | port-restricted cone |
corporate, cloud_nat | Strict | EDM (random ports) + APDF | symmetric |
Link conditions: the named presets (lan, wifi, wifi_bad, mobile4_g,
mobile3_g, satellite) map onto patchbay's presets; wifi_bursty adds
Gilbert-Elliott bursty loss, mobile4_g_congested a rate cap with a bounded
queue so loss emerges from overflow, and custom carries explicit
latency_ms, jitter_ms, rate_kbit, loss_tenths_pct, loss_burst_pkts
and buffer_ms. The stress presets are for the nightly tier 3 lane, not PR
gating. Patchbay exposes no per-interface control on routers, so a
router-to-router link condition applies on the downstream router's downlink
bridge and its receipt names every authority behind that router.
Patchbay's docs/reference/nat-limitations.md lists what it does not model
(port-preserving symmetric NAT, sequential allocation, vendor quirks); a passing
Strict scenario is not full carrier coverage. The Linux integration tests
enable the patchbay-backend feature through a self dev-dependency, so
cargo test -p aura-harness --test holepunch exercises the native backend when
check_caps succeeds.
The Linux dependency manifest additionally requires Hickory Proto =0.26.1:
0.26.0 is affected by RUSTSEC-2026-0119, while 0.25 is also affected by
RUSTSEC-2026-0118. Keep the backend enabled and validate the Linux harness,
including its integration-test targets; a macOS build cannot establish this
target-specific compatibility. Regenerate the tracked Cargo.nix after changing
these dependencies, commit it together with Cargo.lock, and run
just ci-security-audit; just ci-cargo-nix-check fails when the two drift.
Network events are scenario steps when a lab is provisioned:
network_link_down / network_link_up (actor), network_flush_nat (value =
router), network_set_firewall (value = router, name = firewall preset) and
network_set_link_condition (actor, value = link condition preset). They are
environment actions of the shared scenario contract, apply through the lab
backend, and are recorded in events.json and the lab timeline; without a lab
the step fails rather than being skipped. holepunch-relay-first.toml and its
corporate variant use them after the contact link.
The path the runtime selects toward a peer is observable as the
peer_path_selected runtime event (RuntimeFact::PeerPathSelected with
relay or direct, the link protocol, and the candidate and network
generations). It is the relay-first path state the agent's service registry
keeps per (context, peer) and consults for every send and channel
preparation (docs/113_rendezvous.md §3.2), read through the runtime bridge
into the discovered-peers signal and surfaced by the TUI as a runtime fact. It
records the selection, not that the channel came up. A step can narrow it with
contains: relay, direct, or a generation such as
network_generation:1, which appears after the peer re-established its relay
session. The relay-first scenarios assert relay after the shared channel is
joined and bob's network_generation:1 after the NAT flush on bob's router.
Relay-first topologies (required_relay_authority) give lab instances the
relay environment the aura binary reads: the relay authority's instance gets
AURA_RELAY_SERVE=1, every other instance gets AURA_RELAY_ADDR set to the
relay device's lab address and the relay's configured transport port, both
taken from the provisioned topology. That seed address is the only address a
peer is configured with (the same role the bootstrap broker URL plays); relay
hints name the relay authority, and the relay's descriptor says where it is.
Outside the lab the same settings are --serve-relay and --relay-address
on aura tui.
Lab artifacts land under the run directory: network_lab_runtime.json (device,
namespace and address per authority), network-lab-artifacts/ with the
patchbay run directory copy, one <device>.pcap per device captured by
tcpdump inside its namespace, and network_timeline.json;
network_lab_artifacts.json summarizes them after the lab is torn down.
startup_summary.json records each lab-mapped instance's placement.
Backend Resolution
The harness writes backend resolution details to artifacts/harness/<run>/network_backend_preflight.json. Coverage has three tiers, and each proves something different:
| Tier | Where | Proves | Does not prove |
|---|---|---|---|
| 1 | aura-testkit deterministic and property tests | retry-budget and path-selection invariants of PeerConnectionActor | anything about sockets or NAT |
| 2 | aura-harness holepunch tests and lab runs (PR gating on Linux) | the lab provisions, applies events and collects artifacts; real aura instances in namespaces complete the shared scenarios over modeled NAT and impairment | carrier NAT behavior, cross-machine discovery |
| 3 | nightly stress and flake detection | the same under repeated flushes, link toggles and the stress presets, attributed per condition | correctness of a single run |
What no tier proves: real carrier or vendor NAT behavior. Patchbay models the
RFC 4787 behavior classes with nftables and its own
docs/reference/nat-limitations.md lists what that cannot express
(port-preserving symmetric NAT, sequential port allocation, vendor quirks,
behavior under load). A passing corporate/strict cell means symmetric NAT
with random ports does not punch and the relay path holds, not carrier
coverage. Real machines, real discovery broadcast domains and independent
processes remain the two-host LAN batch's assertions.
Triaging Failures
When a scenario fails, triage artifacts in this order.
- Check
network_backend_preflight.jsonto confirm selected backend and fallback reason. - Check
startup_summary.jsonandscenario_report.jsonfor run context and failing step. - Check
events.jsonfor harness steps andnetwork-lab-artifacts/network_timeline.jsonfor the lab's own event log (provisioning through teardown) merged with each applied network event receipt in time order. Patchbay flushes its log when the lab drops, so the timeline is written by the lab's finish step after instances stop; a bundle whose metadata saystimeline_provisionalwas collected while the lab was still alive. - Check namespace and network dumps and pcap files for packet and routing diagnosis.
- Check agent logs for authority-local failures and retry state transitions.
For harness-specific state debugging, treat timeout_diagnostics.json as the first failure bundle. It includes semantic state snapshots, render readiness, and runtime event history.
14. Browser Harness Workflow
Use this flow to run harness scenarios in browser mode with WASM and Playwright.
# 1) Check wasm/frontend compilation
just web-check
# 2) Install/update Playwright driver deps
cd crates/aura-harness/playwright-driver
npm ci
npm run install-browsers
npm test
cd ../..
# 3) Serve the web app
just web-serve
These steps verify WASM compilation, install Playwright dependencies, and start the web server.
In a second shell, run the browser scenarios.
# Lint browser run/scenario config
just harness-lint-browser scenarios/harness/semantic-observation-browser-smoke.toml
# Run browser scenarios
just harness-run-browser scenarios/harness/semantic-observation-browser-smoke.toml
# Replay the latest browser run bundle
just harness-replay-browser
Browser harness artifacts are written under artifacts/harness/browser/.
LAN Run Artifact Retention
The tracked LAN driver sets AURA_HARNESS_WEB_PREBUILT_ONLY=1. Its static
server requires a current web,harness bundle; missing, stale or non-harness
assets fail startup without an implicit Dioxus build or release-cache deletion.
Stop the run and use scripts/harness/lan/build.sh web before retrying.
The LAN driver explicitly selects AURA_SECURE_STORAGE_BACKEND=filesystem-fallback
for its isolated native profiles. Runtime admission still checks harness
authorization for that provider; ordinary production defaults to platform
credentials. This avoids OS credential prompts without bypassing crypto,
authorization or lifecycle behavior. Required LAN safety fixtures enforce the
provider handoff. Secure retrieval distinguishes exact missing records from
native provider failures; workspace unit coverage enforces that distinction.
just ci-build-cache-policy verifies this boundary with isolated positive and
negative fixtures. Successful asset admission is build evidence only; observe
the authoritative frontend readiness and semantic operation contracts normally.
Enrollment submission carries the exact typed instance from the retained
UiOperationHandle accessor into the app-owned workflow. The app facade
exports the semantic operation kind; private handle fields remain private.
Compile the actual web,harness binary when this bridge changes: an effects
or agent-only WASM check cannot catch stale frontend imports or field access.
The required push-time just ci-agent-wasm gate also checks this browser binary
with web,harness enabled and warnings treated as errors.
LAN E2E bundles under .tmp/e2e/run/<host>/artifacts/runs/ are separate from
Cargo compiler caches. scripts/harness/lan/drv.sh start <config> creates a
unique bundle and active retention manifest using AURA_E2E_RUN_TOKEN.
After stopping the driver and capturing evidence, run
scripts/harness/lan/drv.sh finish success or finish failed on that host.
The driver refuses to mark an outcome while its REPL is running. Use
scripts/dev/retain-e2e-runs.sh --root <runs-dir> pin <run-id> to protect an
important success. Interrupted runs stay active in the manifest and are
preserved for review; an existing bundle cannot be reused by start.
Preview retention with:
scripts/dev/retain-e2e-runs.sh --root <runs-dir> prune --dry-run
Apply it only when no harness consumer is active by replacing --dry-run
with --apply. The default policy retains the newest ten successful runs
within 512 MiB, always keeps the newest success, and preserves failures,
pinned runs, active runs, and older bundles without a manifest. The command
lists exact candidate paths and estimated bytes before removing anything.
Each host runs retention only against its own artifact root. Never delete
the whole .tmp/ tree as CI cleanup.
The harness matrix retains run artifacts under .tmp/harness/ and owns a
separate private short IPC root allocated with mktemp under /tmp. Rust
admission validates the selected native owner directory and derives fixed
scope children; checkout depth and actor labels cannot extend socket paths.
Its run-scope cleanup does not manage LAN bundles or override their
outcome-based retention.
Debugging Browser Failures
Check web-serve.log for bundle and runtime startup issues. Check preflight_report.json for browser prerequisites including Node, Playwright, and app URL. Check timeout_diagnostics.json for authoritative and normalized snapshots and per-instance log tails. Playwright screenshots and traces are stored under each instance data_dir in playwright-artifacts/.
timeout_diagnostics.json is the primary authoritative failure bundle. It contains UiSnapshot, runtime event history through runtime_events, operation lifecycle and instance ids, and render and readiness diagnostics along with backend log tails.
For mixed-runtime debugging, inspect runtime_events before logs when a code exchange or chat handoff fails. The expected evidence is a typed event payload, the selected semantic target in the snapshot, and only then supporting browser or TUI render diagnostics. For browser runs, the harness observes the semantic state contract first and uses DOM and text fallbacks only for diagnostics. If semantic state and rendered UI diverge, treat that as a product or frontend contract bug rather than papering over it with text-based assertions.
Frontend Shell Roadmap
aura-ui is the shared Dioxus UI core. It supports web-first delivery today and future multi-target shells.
aura-web(current): browser shell and harness bridge- Desktop shell (future): desktop-specific shell reusing
aura-ui - Mobile shell (future): mobile-specific shell reusing
aura-ui
Related Documentation
- Test Infrastructure Reference for infrastructure details
- Simulation Guide for fault injection testing
- Verification and MBT Guide for formal methods
Testing independent enrollment transfer
Create the invitee's real provisional account and export its signed setup request. Transfer that request to the initiator's app pin workflow, issue enrollment, then transfer the actual resulting enrollment code, manifest code, and separately obtained initiator verifier code to the invitee. Both native and browser forms expose all three inputs. Shared semantic commands carry the same explicit values and hand off to the app's single import owner.
Capture device_enrollment_code_ready as device_code to obtain ${device_code}, ${device_code_manifest}, and ${device_code_initiator_verifier}. Supply the latter two using the scenario's manifest_code and initiator_verifier_code fields. Readiness capture requires the authoritative runtime payload; clipboard reads are not enrollment evidence. Do not fabricate a digest, key, physical device, or trusted admission witness in a positive fixture.
Security integration coverage must exercise actual export → app setup pin → reserved issuance → independent manifest pin → immutable admission → signed response → issuer expected-manifest verification. Negative cases include missing or substituted external pins, wrong physical invitee, altered baseline/parent/node/package/roster/policy, legacy unbound records, and corrupt admission storage. Process restart must reverify retained evidence. Unsupported exact-node inventory, unclosed profile storage ownership, or unavailable threshold quorum signing cannot count as a completed enrollment test.
Enrollment observation durability regressions
Drive the registered timeout owner before asserting that a restarted readout sees a timed-out terminal decision. Advancing a fake clock alone does not authorize an observed read to publish failure. Exercise secure checkpoint recovery after progress, rollback above the original start, missing state, injected storage failures before operation polling and after completion, and cancellation before checkpoint acknowledgment. Inspect standard error source chains for the original concrete storage error. The Rust-native enrollment boundary fixtures must reject raw/no-op executor aliases and weaker budget parameters while accepting the sealed owner.
Shared window laws
Core types::window tests enforce inclusive start/exclusive end, empty generation allowance, checked endpoint overflow, exact validated serde restore and membership arithmetic near u64::MAX. Its two compile-fail examples prevent physical/receipt coordinate interchange. Physical policy tests additionally reject empty/sub-millisecond and invalid restored budgets while preserving the existing timeout snapshot fields. Existing clone/child/retry/restart rollback and required-checkpoint tests remain mandatory. The flow owner must exercise dual-window epoch closure and checked progression when adopting the shared primitive.
Native semantic failure codes
Native failure projection coverage must assert the operation domain and stable shared code after JSON snapshot roundtrip, alongside the concrete Rust source chain before the foreign boundary. Test cryptographic and codec failures independently of display text, and preserve typed invitation rejection overrides only when actual rejection evidence exists.
Enrollment window phase faults
Inject interruption after immutable allocation but before initial clock/live registration; recovery must retain the exact original start/deadline despite a later clock. Delete the clock after live admission and assert registration/execution fail without recreating it. Delete a legacy live marker together with the clock while retaining canonical registration and assert conservative rejection. Replace a live budget with the same interval and lease but a distinct observation owner and assert no checkpoint overwrite. Existing tests also require durable highwater/sticky-state monotonicity and allocation continuity through acknowledged writes.
For enrollment receipt tests, use actual setup export, explicit app pin transfer, issuer-owned ceremony registration, cryptographically verified invitee acceptance and authoritative finalizer completion. Obtain the committed frame through the real owner signer and verify it under the retained independent initiator pin. Exercise immutable receipt publication, recovery signature verification, exact generation matching, missing/corrupt receipts, modified confirmation epochs, expired-but-originally-valid acknowledgements, later epoch rollback refusal and retirement. Raw statuses, manually completed tracker counts and fabricated manifest digests are not positive trust fixtures. Resource-level process/frame death tests complement, and do not replace, actual enrollment/profile restart and cross-frontend user-flow tests.
Enrollment task source continuity
Persistent profile fixtures allocate a fresh OS temporary directory for each test participant. Process-local counters alone repeat across test binaries and can reuse immutable admissions or secure keys. A restart case reuses its captured original profile path intentionally; unrelated participants and later test runs receive new paths. This applies to simulation effect factories as well as runtime builders.
Exercise an actual registered-window admission rejection through the required enrollment initiator failure settlement path and the fallible one-shot supervisor. Assert the original concrete AgentError is reachable from both retained health failure and drain error, and any failed terminal settlement retains its own native cause. Do not replace real window admission with a fabricated error or synthetic successful task.
Required enhanced-time scheduling propagates actual provider query and sleep failures. A failed timer does not constitute deadline expiration or successful wake-up. Native source traversal retains the concrete time-effect error through runtime scheduling and effect-system forwarding.
Sync command service ownership requires source-preserving timer, shutdown-signal and runtime supervision outcomes. Every daemon run exit awaits service stop. Failed execution remains primary when stop also fails, with a separately retained typed cleanup cause. A failed timer or backward physical clock cannot publish a tick or successful shutdown. Native terminal diagnostics retain concrete sources; cloned source-bearing errors compare retained source identity rather than matching message text.
Enrollment import publication regressions
The protocol tree tests inject failure before and after canonical index publication, reload the handler, and require a complete original or complete replacement history. Replay tests require preservation of later operations and reject an unrelated replacement. The actual two-runtime committed-confirmation fixture installs the independently admitted generation through the production import owner, verifies activation, and then checks that import replay preserves the adopted encrypted share and final configuration. Native encrypted-storage tests share a real profile lease/provider between independently initialized wrappers and preserve a malformed original master key. These tests do not establish the still-required frontend profile WAL, same-epoch revocation authorization, or quorum path.
VM send custody regressions
Exercise the actual runtime bridge queue under an exclusive delivery lease.
Require rejection of a second owner, retained FIFO order after a successful
prefix and definitely-unsent failure, and enqueue behind the retained suffix.
Cancel an awaited in-flight future and verify that the original frame remains
with DeliveryUnknown, preventing automatic replay. Native flush failures must
retain their concrete transport or configuration source and pending frame.
Compile-fail coverage prevents cloning the lease and using a destructive drain
API. Match typed variants; matching rendered diagnostics does not prove custody
or retry authorization. The stateful test provider implements the same delivery
contract instead of claiming success from a drained queue.
Required refresh supervision checks
Exercise the actual signal subscription and refresh owner with a failing native provider, then assert the typed attachment failure, original concrete source, group cancellation, and retained supervisor failure. Required task admission tests cover native/local execution and rejection dropping the supplied unpolled future. Keep the required-owned-task compile-fail guard: a unit future must not satisfy the required task API. Runtime health remains failed until its owner replaces the failed runtime generation; app reattachment alone is not a health reset.
Enrollment first-decision provider tests
Use a real runtime-exported setup and actual app transfer pin to test duplicate retained binding and contradictory generation rejection; verify original secure bytes remain unchanged. Pair owner tests with aura-effects/tests/secure_immutable_publication.rs actual process contention, asserting exactly one complete first publication. Provider lifetime protection must additionally prove generic mutable write cannot replace a previously immutable value; absence-only races do not establish that stronger property.
Held registration boundary checks
Use an actual prepared unissued rotation reservation to reject another runtime's effects and a previous ceremony's authentic invitation/state. Assert structural native causes. Existing real issuance tests supply the positive owned path; rerun them after changes to roster or deadline checks. Keep the reservation type private-field and non-deserializable, and require it in the live registration signature. Raw registration snapshots alone must not satisfy that API.
Persistent allocation owner regression
In the actual prepared unissued-rotation fixture, attempt generic tracker registration while the real generation reservation is held. Assert typed HeldEnrollmentRegistrationError::RequiredOwner and absence of the durable allocated record. Existing actual issuance fixtures exercise successful owned registration. Persistent enrollment clock tests must obtain the real held reservation; do not re-enable raw snapshot allocation or add a test-only authorization bypass to simplify those fixtures. Nonpersistent tracker state-model tests can keep generic registration because they cannot authorize production activation.
Actual secure-provider fault validation
The optional native credential-provider lane uses the selected OS keyring with a private fixture service and the actual profile and namespace owners:
cargo test -p hxrts-aura-effects --features test-support platform_secure_record_fault_tests
The lane checks legacy original sealing, mutation refusal, actual wrapping-key loss without replacement, and legacy payload collisions with the protected record format. Provider unavailability is a typed failure; tests do not skip or switch to the filesystem fallback. Fixture cleanup targets only its private service and is a test-owned backing-provider fault operation. A successful filesystem lane does not validate this OS-provider lane or the browser WebLocks/IndexedDB lane. Cross-process OS-provider recovery and actual browser multi-context fault coverage remain separate required validation.
Enrollment peer epoch fence migration
Run the sync enrollment_epoch_commit_migration_tests lane to verify that the actual historical schema encoded by the runtime DAG-CBOR codec decodes with no v2 fence and cannot authorize enrollment. The old rotation/removal transcript must remain byte-identical. The pure v2 transcript tests check domain separation and binding to each operation hash; they do not substitute for genuine quorum participation, held peer activation, or process-restart tests.
Enrollment notice identity and production compilation
Run the exact retained notice identity regression alongside the actual default-stack enrollment caller fixture. The former rejects digest, transcript and expiry rebinding; the latter uses real setup, registration and admission before checking the issuer/invitee 16 KiB caller-future budget. Neither pure identity tests nor increased stack settings establish complete cancellation delivery or restart behavior.
Check the agent and simulator libraries without cfg(test) as a distinct
validation lane. Notice draining must retain its native failures in production
builds as well as unit tests; a test-only helper cannot supply production
cleanup. Run cargo check -p hxrts-aura-agent -p aura-simulator --lib in the Nix
environment with the same bounded build queue used for the focused tests.
When cancellation observation/window and accepted enrollment-response variants use boxed payloads, keep the public cancellation/retry and accepted-response finalizer regressions in the same coherent native batch. Assert that each consumer receives the original move-owned capability and that a failed supervised child still exposes its concrete source through the resulting error chain. A smaller enum or a green strict lint result alone does not establish either ownership or source preservation.
Startup authorization fault coverage
Run the agent required_biscuit_hydration_ test filter when changing credential
restoration or builder error adapters. Its real profile/token fixtures cover
confirmed absence, malformed payload, successful retained-token hydration,
returning-runtime rejection and encrypted backing corruption. The corruption
fixture changes selected provider ciphertext under native test support; ordinary
production overwrite/delete protections must remain enforced. Check native
error causes as well as the serialized failure classification, and separately
compile the production agent library so test-only methods cannot hide missing
required runtime APIs.
Enrollment custody contention regressions
The runtime tests enrollment_custody_waits_generation_then_decision_then_tree
and physical_generation_cannot_enter_another_runtime_tracker use the actual
export, app pin, retained manifest and physical storage fixture. They poll an
owned future once to verify a held mutex dependency, rather than sleeping for
an assumed ordering. The first test holds the physical generation gate and
checks that activation has not acquired the tracker decision, then holds the
tree lease and checks that fresh roster preparation has already acquired the
tracker decision. It also checks that a second real owner advances only after
the first composite owner releases. The second test rejects custody from a
different real runtime. Run these tests with the agent suite and ownership
compile-fail lane when changing the custody hierarchy; a count-only tracker
fixture does not verify physical generation ownership.
Reserved issuance regressions must exercise the actual pure guard outcome and native boundary, distinguish insufficient budget from missing capability, and assert the concrete structural source remains reachable. Canonical original creation/expiry are tested against a newer guard clock and expired reservations.
Pinned VM lifecycle regressions
The lifecycle gate resolves the locked crates.io telltale-machine release
17.0.1 through Cargo metadata and rejects local overrides or other versions.
Its unit tests have their own development dependencies and run using the resolved
package manifest. Run the required source, discovery and execution inventory:
just ci-vm-session-lifecycle
These regressions exercise actual scoped worker completion, unrelated-session
survival after coroutine compaction, stable IDs for later sessions, and required
lock/index/epoch failures before mutation. They must accompany changes to the
dependency lifecycle API. Also run actual Aura backend close/cancellation tests;
dependency success alone does not verify host binding or fragment retirement.
For session-buffer receive, hold VM startup after claiming a valid envelope,
cancel the participant, and assert return to the original session bucket and
position. Also check malformed-frame consumption and failed startup before VM
ownership. After owner and fragment claim, cancellation must retire that exact
session and its fragments without erasing the inbox or replaying an owned frame.
The exact session-cancel fixture has passed; after-owner-claim coverage remains
pending, so the full VM-open custody boundary is not yet validated.
Cooperative teardown needs its own nonterminal-session and surviving-session
coverage. A closed status or removal from the host's active set alone does not
prove target coroutine/resource disposal. Regenerate Cargo.nix when changing
the pinned dependency release.
Deadline attenuation regressions in aura-core::time::timeout must prove that
shorter signed validity retains the original start and parent deadline, child
exhaustion stays sticky after restore, and parent/child rollback history is shared.
The pure tests reject mismatched paired snapshots; they do not prove durable
checkpoint provenance. Pair them with the actual domain owner's required-write,
restart, expiry and missing-checkpoint fault tests when changing peer admission.
Required VM disposal regression lane
Run just ci-vm-session-lifecycle after changing a VM backend, targeted session
close/reap, coroutine index ownership, worker acknowledgment or forced-drop
custody. just ci-ownership-policy includes the same lane. The Rust inventory
checks actual nonignored test declarations and published harness names before
running the dependency and runtime suites in sequence. A renamed, absent,
feature-excluded or ignored required fixture fails instead of producing a
successful zero-test result.
The dependency tests exercise targeted removal, same-role surviving sessions, new-session dispatch, genuine scoped worker acknowledgment, actual poison and epoch faults, natural terminal epoch preservation and cooperative deserialization index continuity. Runtime tests exercise both real backends, original error source chains, exact forced-drop owner retirement, stale-owner rejection and cleanup before supervisor idle publication.
Session owner coverage additionally uses equal metadata in two actual runtime registries to prove that foreign claims cannot validate, release or transfer ownership. The lane discovers and executes the opaque capability doctests, including a valid observation consumer and rejected construction, field mutation and wire deserialization. Their actual harness inventory prevents absent guards from becoming a successful zero-test run.
The dependency override is outside the workspace. This lane invokes its actual manifest with the multi-thread feature and shares the selected target directory with runtime validation. It does not run competing builds. Keep its original release provenance and license together with the patch record; update Cargo/Nix pins when replacing the override. Disposal acknowledgment is local cleanup; signed protocol outcome and remote delivery retain their separate owners.
Final active enrollment inventory regression gates
Exercise a genuine first enrollment through authoritative commit, then a second independently pinned issuance after its attested epoch fence. Assert that the new final inventory uses the actual active threshold package while all historical parents remain at their authentic earlier epochs. Test canonical prechange version-1 schema bytes, original signature-domain compatibility, missing-inventory rejection, v2 old-domain signature rejection, prefix/version mismatch and tuple substitution. Internal trait assertions guard capture cloning/deserialization. Keep nonroot persistence, existing-peer response restart, distributed quorum and native/browser profile WAL coverage explicitly outstanding until exercised.
Public FROST primitive evidence
Run just ci-public-frost-signing when changing public commitment construction
or independently bound-message signing. The native gate requires real harness
publication of both nonignored primitive regressions and the public-only API
compile-fail guard before running them. The positive test verifies a native
2-of-3 signature; the negative test rejects transcript, roster, policy and nonce
substitutions. Synthetic key bytes cannot substitute for failed dealer
execution. Passing this lane establishes primitive behavior; runtime quorum
admission, durable one-use nonce custody and multi-runtime recovery require
separate owned protocol tests.
The VM lifecycle lane requires public live cancellation/retry to retain its primary Cancelled decision and original interval. It also requires an actual task-registry source-chain/drain regression for subsidiary failures recorded after primary completion. These checks complement signed notice delivery after real runtime reopening; observing local cancellation alone does not establish remote delivery.
The required VM lifecycle inventory also discovers and executes the confirmed parent archive ownership guard and the actual committed-confirmation fixture. That fixture covers immutable v1 preservation, explicit v2 publication, selected provider reload, substituted history and foreign-runtime rejection. It does not establish process restart or native/browser profile WAL handoff; those require their own connected runtime tests.
The same required inventory executes generation-history migration and actual same-epoch reissue. Those tests must preserve original allocation/registration bytes, reject forged mutable slot policy, and complete genuine wrapping-secret retirement before reuse. A slot-only test or a bypass of immutable provider protection cannot satisfy this gate.
Required admitted-clock regressions distinguish immutable original anchors from mutable checkpoints, verify repeated progression/restoration, and reject missing ever-live checkpoints. Legacy intervals remain attenuated; fresh intervals use the signed manifest endpoint. Full process reconstruction and legacy builder migration require additional connected tests.
The lifecycle gate also requires the distinct response-policy regression: remote response quorum and signing-key quorum are separate protected policies. Recovery compares each original commitment exactly, including typed mismatch causes; it cannot clamp recovered signing quorum into a response quorum.
Historical enrollment response-policy coverage must exercise an encoded allocation
that actually lacks the newer response commitment. The required agent fixture
runtime::effects::crypto::missing_response_policy_history_tests::truly_old_missing_response_policy_uses_protected_original_registration_and_preserves_bytes
uses genuine protected original registration/setup evidence and selected-provider
fault injection. It checks unchanged historical bytes and deadline, absence of
verified policy after serialization, and source-bearing failure on supplement
loss. The native VM lifecycle inventory requires discovery and actual execution;
profile-layout migration alone does not prove this old-schema contract. Full
AgentBuilder reconstruction remains separate required integration coverage.
The VM lifecycle gate checks each required suite at three boundaries: nonignored
source declaration, publication by the actual harness, and exact executed
test <required-name> ... ok evidence after successful Cargo execution. A green
process status or test listing alone cannot satisfy execution coverage. Its
adversarial unit coverage rejects zero-test, ignored, failed, listing-only, and
similar-name outputs.
Registered notice binding changes must retain the actual public live cancellation and retry fixture, original-window assertions and exact manifest/transcript/expiry substitution negatives. A single-assignment cell must compare every candidate against its original value; replacing a blocking mutex does not excuse dropping those checks. Strict Clippy and the connected ownership lane remain required.
Threshold enrollment signing-owner selection must cover actual finalization into
a threshold epoch before invoking the next identity selector. Required native
coverage distinguishes genuine QuorumOwnerRequired Service from actual protected
share loss (Storage). A separate deterministic native FROST dealer regression
checks unsupported threshold-one construction; domain-valid metadata alone does
not establish backend support. The second-issuance runtime fixture remains required
until distributed signing and bounded owner assembly are connected.
Registered enrollment window regressions must use the real signed issuance path before acquiring the strongest registered generation. Retain the original manual clock and tracker/runtime provenance; do not create a test-only canonical invitation or weaken admission to a raw ceremony ID. Releasing the sender owner must preserve actual active eligibility, and contention must retain typed AlreadyOwned plus the concrete semaphore cause. Pre-live clock laws use their actual held allocation separately.
The public FROST signing gate requires exact per-test executed ok evidence for
its native dealer and public-only threshold fixtures, in addition to source
inventory and harness discovery. A successful command with zero, ignored or
merely listed tests cannot establish the required primitive evidence. Unified
threshold verification must decode the canonical public package and verify with
its group point; the real two-of-three fixture also rejects substituted messages
and malformed public signature inputs. These tests do not prove distributed
runtime quorum custody or profile recovery.
Rustdoc discovery omits the execution suffixes - compile and - compile fail.
The execution validator normalizes those two suffixes when matching exact test
names; changed source lines, failed/ignored results and discovery-only output
remain rejected. The API guard inventory requires both the positive compile
consumer and the negative compile-fail case to execute successfully.
Compile-fail process lock recovery
App, signal-workflow and agent compile-fail harnesses acquire one TrybuildProcessLock from aura-testkit for the workspace. The helper derives target/tests/.aura-trybuild.lock; suites must not introduce package-specific or signal-specific lock namespaces. It owns an actual file descriptor and uses fs2 0.4.3's Unix/Windows advisory locking, without requiring post-MSRV standard-library file-lock APIs. Closing the descriptor or terminating its process releases the lock. The lock file stays in place, so no removal/recreation can split the lock inode. Old trybuild-lock directories no longer authorize or block acquisition.
Acquisition waits at most 900 seconds in compile-fail suites. A timeout retains the actual last native contention error; opening/locking failures retain the original IO error. The process-lock integration test launches a real holding subprocess, proves contention, kills it without Rust cleanup, and verifies bounded acquisition of the same persistent lock file. Its namespace test also covers stale legacy directories and ordinary descriptor release. Run cargo test -p aura-testkit --test process_lock before the existing app/agent compile-fail ownership gate. Dependency changes require Cargo.lock and Cargo.nix regeneration/validation before integration.
just ci-ownership-policy executes the app/agent compile-fail suites, explicitly enabled signals compile-fail suite and native process-lock integration regression sequentially. Required suites fail when Cargo is unavailable or returns an unsuccessful version status; a signals-disabled build contains no pretend passing guard. The fs2 implementation is pinned to 0.4.3 and uses pre-MSRV descriptor APIs; Windows and Unix use their native process-scoped locks.
For an iteration on a few Rust files, just ci-ownership-fast crates/aura-agent/src/path.rs compiles the ownership lint once in a guarded
ownership-lint-compile receipt, then runs six source-scoped modes in a
separate guarded ownership-lint-exec receipt. The execution receipt names the
original compile receipt and verifies its successful terminal result, source
scope, tool identity, and binary hash. The default run uses Cargo's warm
freshness check and requires the original exact source fingerprint and scope
for execution reuse. When a compile-lane admission is costly or the same lint
binary will check several app source revisions, run
bash scripts/dev/run-ownership-fast.sh --certify-compile-inputs crates/aura-agent/src/path.rs.
That opt-in compile receipt also certifies a compiler input graph. The graph records the three
workspace packages that build the lint, their whole-package file inventories,
Cargo manifests and lock, selected registry package contents and locked archive
checksums, feature resolution, native build selectors and selected tools. The
certified compile stage checks locked archives against their extracted source;
execution rechecks the recorded inputs and uses the original binary. An unrelated app
source change may use that same compile receipt while the new execution receipt
records its own current source fingerprint and checked-file scope. Changed or
uncertifiable compiler inputs refuse certified reuse. Rechecking mutable registry
sources can take longer than a warm Cargo freshness check; use certification
when its compile-lane admission or source-scope reuse matters. If execution
admission is refused, keep
that compile receipt and resume with
bash scripts/dev/run-ownership-fast.sh --compile-receipt /absolute/receipt.json crates/aura-agent/src/path.rs
on a current checked source and the original binary. For the
browser driver contract's static policy check, just ci-policy-static browser-driver-contract-sync similarly separates toolkit compilation from the
selected typed check and records its three canonical Rust/TS inputs. The same
owner accepts user-flow-policy-guardrails and user-flow-guidance-sync as
fast individual checks. Their execution receipts bind the current source,
Git index/ref map, effective Git configuration and diff selectors, then rerun
the Rust check against that source using the original verified toolkit binary.
An invalid diff range or external Git diff/config input refuses this fast lane.
Run the complete just ci-user-flow-policy recipe at its integration checkpoint;
it also includes the harness ownership check. security-boundary-policy runs
required Rust tests and is not eligible for static execution. These
preflights do not replace just ci-ownership-policy; an integrated checkpoint
must retain a successful full-source aggregate receipt. For exact
native fixtures, use just ci-ownership-exact --package hxrts-aura-agent --lib --expected-count 2 --name module::first --name module::second (or
--test <binary>). The driver requires the declared count and distinct exact
names before starting, compiles one libtest executable for a frozen source
fingerprint, then discovers and executes each name under one guarded build
lifetime. Its receipt records the inventory and each compile, discovery and
execution result; a source change, missing fixture, failure or ignored test
fails the batch. Run the full ownership aggregate at the combined checkpoint.
Before that aggregate, freeze the integrated source and compile the affected native targets and web target with the guarded build wrapper. Fix compiler errors on that exact revision first. Then run the full ownership aggregate once; repeat it only after a relevant source change or a gate failure. A source-scoped policy pass or fixture result does not replace the aggregate.
Required ownership coverage checks three separate forms of evidence: Rust test attributes without ignore annotations, exact names published by the selected harness, and successful execution of every required test. The signals harness is selected with --features signals. The process-lock lane requires the forced termination, shared namespace and native IO source regressions; its child-process helper does not satisfy coverage. Captured pretty harness output keeps nested trybuild diagnostics from splitting result lines. Zero-test, ignored, failed and name-lookalike output cannot satisfy the gate. When adding a required ownership test, update the typed suite inventory and its validator regressions; do not replace execution evidence with a successful Cargo exit status.
Public signature ingress provenance regressions
Run both crypto::signature_input::tests cases in hxrts-aura-core for real
SingleSigner inputs and genuine dealer public-package parsing. Run
enrollment_setup::tests::malformed_peer_encoding_is_distinct_from_required_provider_failure
in hxrts-aura-invitation for a genuinely signed request and the Layer 8
aura-testkit verification-outage mock.
Malformed peer package and fixed-length signature inputs must produce
InputEncoding before provider invocation. A correctly encoded signed request
must reach the injected provider and retain the exact original native cause as
Crypto. These tests cover input and error provenance; they do not establish
independent pinning, runtime quorum or restart ownership.
The native public-frost-signing gate requires all three tests as nonignored
source declarations, discovers their exact names from the actual library
harnesses, and checks successful per-test --exact execution. Missing, ignored
or zero-test coverage fails the gate.
The native public-frost-signing gate requires all three ingress tests as
nonignored source declarations, discovers their exact names from the actual
library harnesses, and checks successful per-test --exact execution. Missing,
ignored or zero-test coverage fails the gate.
The ownership aggregate also discovers and executes the two native agent deterministic RNG custody regressions individually with exact test names. The interleaved clone/continuation regression compares actual subsystem draws against one independently seeded reference, including after original handles are dropped. The independent-seed regression proves reproducibility without shared custody. Missing or ignored coverage cannot satisfy the gate.
The production task-spawn lint permits concurrency fault-injection inside
provably test-only configurations. Its parsed configuration rule accepts
cfg(test) and cfg(all(test, unix)), and continues checking cfg(not(test)),
cfg(any(test, unix)) and feature names containing test. Ownership CI requires
actual execution of the adversarial configuration regression.
Core and macros guard suites depend on the same host-only descriptor lock package
that aura-testkit reexports: toolkit/test-support/process_lock.rs. This keeps
L1/L2 test infrastructure free of upward Aura dependencies. Core, choreography,
marker and service-surface suites are part of the exact required ownership
source/discovery/execution inventory; successful zero-test exits do not count.
just ci-agent-wasm, invoked by the existing conformance CI workflow, runs
warnings-as-errors Clippy for the wasm effects library before the agent backend
matrix and the actual aura-web harness binary. This gates browser
secure-provider API, frontend facade and lint regressions that native
Clippy cannot observe.
Capability-boundary changes require the full macro validator regressions and compile-fail suite, followed by ownership CI. Use an exact signature type; when a semantic capability label differs, add capability_type = Type. A held runtime receiver can declare receiver_type = OwnerType and must pass the generated concrete type check. Do not add decorative capability constants or annotate String/AuraError as authorization evidence. Classify pure validators and observed projections accurately. Readiness publication helpers retain the actual readiness capability through publication. The aggregate requires source attributes, actual discovery and successful exact execution of the full-validator adversarial tests; compile-fail snapshots must be checked against real compiler output.
The parsed test-only cfg rule applies to the common ownership lint helper, including enrollment window and semantic boundary visitors. Tests must cover production-capable negations and disjunctions; substring-based exceptions are not permitted in those visitors.
The security boundary gate requires exact source, discovery and executed results for the selected filesystem allocation lifetime inventory. The 24 native tests cover first physical-provider attachment, original seals and checkpoints, retirement ACK/replay, legacy immutable preservation, lifecycle loss, codec classification and total ciphertext limits. Zero-test or ignored output does not satisfy this lane. Native keyring/browser parity needs separate tests. The pending platform-keyring allocation-lifetime lane must execute the exact crash and adversarial matrix in Effects and Handlers Guide before production signed enrollment claims selected-provider persistence. Test-keyring execution establishes transaction behavior, while a separate actual OS credential-provider lane establishes platform integration.
Allocation lifetime syntax checks normalize source paths against the explicit checkout root before comparing sanctioned owner files. Outside-checkout sources fail closed. The security gate self-checks absolute owner and foreign paths; retain these regressions when changing file discovery or path handling.
The private lifetime codec also requires byte-array compatibility and malformed/oversized/later-field decoder regressions. Secret fields retain Zeroizing ownership during incomplete deserialization, before record Drop.
For a scoped secret-codec exception, run both
just _policy-check check secret-field-wrappers and
just _policy-check check security-exception-metadata. The complete security
boundary gate includes both; a focused checker must name a registered command.
just _policy-check check secret-lifetime-regressions runs the security
gate's exact selected-provider source/discovery/execution inventory as a focused
lane. It requires all declared native tests to execute successfully with no
ignored or zero-test substitute. Run it for private lifetime codec/provider changes.
Custom builder changes must run the required custom_provider_fidelity native
integration harness through the ownership aggregate. Its async and sync tests
exercise actual selected storage/crypto/random/console owners and native outage
chains; transport tests reject fallback after selecting a failing provider. Keep
stateful fault providers in L8. Successful construction or a compile-only
typestate guard alone does not prove configured providers reach dispatch.
Allocation lifetime integration fixtures
Use the crate-private native unit-test TestingOwnedProfileCapability::acquire(&config) and EffectSystemBuilder::testing_with_owned_profile(capability) when a real enrollment test requires selected filesystem custody. Acquire it before signing bootstrap. The ordinary Testing builder intentionally has no physical lifetime owner; supplying its production with_profile_owner ingress is an error. Keep the capability paired with the original configuration and use the shared transport and physical-time provider builder methods normally.
For restart evidence, acknowledge old task shutdown, drop the old runtime and any retained effect handles, then acquire the same original profile for the new owned Testing assembly. Preserve original allocation, decision and window checkpoints. Do not copy or synthesize a lifetime root or use a missing-custody fallback. The ownership adapter regression covers actual lease retention, foreign configuration rejection and the unchanged production-lease guard; the real enrollment retirement/reissue and cancelled-notice restart tests exercise ledger recovery end to end.
Owned Testing profile assembly changes must preserve the three actual custody regressions in the required VM lifecycle source/discovery/execution inventory: lease retention through shutdown, foreign configuration rejection, and ordinary Testing rejection of production lease ingress. They supplement the connected enrollment history and cancelled-notice restart evidence.
For canonical participant envelope changes, run the actual threshold-signing producer/consumer regression and connected enrollment history, cancelled-notice restart, and secret-retirement/reissue restart tests. The required VM lifecycle inventory checks their declarations, actual harness discovery and successful execution. Preserve explicit foreign-authority and raw-package rejection and concrete codec sources. A legacy-only fixture cannot prove allocation-version consumer custody.
Required identity envelope changes retain the exact bootstrap codec/AEAD/bounds regression in the VM lifecycle execution inventory. The strongest original runtime/epoch/participant context remains required; failed canonical decoding cannot select a companion package or older identity. Preserve bounded encoded input and nonempty bounded ciphertext before cryptographic work.
Active identity handler changes preserve required rendezvous corrupted-primary and contact missing-key regressions in the VM lifecycle inventory. Fixtures use actual canonical threshold bootstrap and matching runtime authority; do not install raw guessed-epoch packages. Failed signing identity selection or package reads must retain their typed cause and cannot report response success.
Rendezvous manager identity ingress retains the actual selected runtime and active physical identity context. Preserve its required corrupted-primary regression, concrete provider/codec source, and absent-descriptor postcondition in the VM lifecycle inventory. Generic permissive storage/crypto mocks cannot prove authoritative identity selection.
Native test profile allocation is fallible and uses exclusive creation. The required ownership gate executes collision exhaustion/preexisting-permission and native creation-fault regressions. Old temporary directories are never reused, deleted or chmodded to repair a fixture.
The selected-lifetime required inventory includes a real subprocess killed after protected ciphertext staging and before final link at eight initial publication boundaries. It also requires malformed/anonymous/conflicting-stage, once-live loss and actual positive-first-decision preservation regressions. The subprocess helper itself is not counted as coverage. Older anonymous stages and interrupted mutable replacement remain explicit fail-closed cases, not authorization to clear a profile or allocate a replacement root.
Required lifecycle source inventories parse the sanctioned
large_stack_async_test!(name, { ... }) declaration as a typed Rust macro
invocation. Ignored, malformed, unrelated and qualified invocations cannot
satisfy required evidence. Source recognition is followed by actual Cargo
harness discovery and exact successful execution; declaration presence alone
never establishes coverage. Required ownership coverage also executes the
persistent tree's held-decision replacement and authenticated-extension tests.
Required invitation stage adapters retain actual clock, policy and timeout sources. Their child budgets share the original observation owner; rollback and required checkpoint faults must not be classified as elapsed deadlines. Required network retry timers propagate failure, and automatic transport retries are limited to native definitely-unsent destination-unreachable errors for the exact requested destination. The lifecycle gate includes the generated rollback, original deadline and invalid-policy source regression.
Original invitation identity evidence
Run just ci-vm-session-lifecycle after changing invitation signer birth,
retention, recovery, package selection or required test declarations. It requires
actual Contact success and revoked refusal, original Contact/Guardian rotation
and profile restart, copied-record rejection and equal-ID foreign-owner rejection.
Positive fixtures bootstrap real canonical physical identity packages; raw
SingleSignerKeyPackage fixtures do not authorize production export.
The inventory parses the exact large_stack_async_test!(name, { ... }) source
grammar as well as real test functions, rejects ignored/malformed/unrelated
declarations, discovers exact harness names, and requires successful execution.
This recognizes existing legacy contact fixtures; it does not establish their
ordinary-stack compatibility. New original-issuer ownership regressions use
ordinary Tokio tests. Missing required records retain their logical absence
cause; tests must not fabricate an operating-system error for absence.
The required contact verifier regression exercises actual Ed25519 signing and
verification, an actual provider key-length failure, and a well-formed invalid
signature. The provider failure must survive standard Error::source downcast;
only the invalid signature may return Ok(false). Run the exact required
required_contact_verifier_retains_native_failure_and_distinguishes_invalid_signature
case through just ci-vm-session-lifecycle.
Required selected-lifetime coverage includes the actual target-insertion interleavings after staged observation and between the held source check and link (including equal ciphertext on a substituted inode), identical ciphertext acknowledgment, foreign stages in nested namespaces before and after initial handoff, and an allowed filename carrying invalid ciphertext. The Rust-native required gate checks source declarations, test discovery and exact execution; zero executed tests cannot satisfy this coverage. Mutable successor process-death recovery requires separate original monotonic-transition evidence and coverage.
Stage-inventory coverage also scans the maximum supported allocation-leaf layout together with more than 4096 ordinary leaves, and verifies actual typed ambiguity/depth failures retain backing evidence. The scan is constant-memory with respect to ordinary leaf count; its native IO latency is linear and original builder execution-window integration remains open.
The exact original-stage reader also streams unrelated namespace entries while retaining at most one candidate name. Required execution reopens a genuinely initialized profile with more than 4096 namespace siblings and acknowledges only its identical original protected seal. An ordinary namespace count is not a new lifetime-admission limit.
Required initialization tests also terminate the actual writer after successful link and before stage removal at seven original immutable targets, then reopen the same original selected profile. They verify inode link counts return from two to one, root identity and immutable ciphertext remain unchanged, and an unrelated identical ciphertext alias is rejected with retained native evidence. Mutable successor publication remains a separately verified transition scope.
Process-death checkpoint waits use PhysicalTimeEffects and one original
TimeoutBudget; each diagnostic pause is bounded by the remaining budget.
Test-only fault registries use tokio::sync::Mutex::try_lock with explicit
busy failures and never hold locks across awaits. Strict effects test Clippy
enforces these boundaries.
Contact continuation ownership regression inventory
The VM lifecycle lane requires the actual signed-import corruption, decision lease, original-parent deadline/shared rollback and native clock failure tests in owned_contact_continuation_tests. Run the existing Contact confirmed and revoked integration cases in the same serialized lane. ManualPhysicalClock::provider_faults_are_one_shot_and_wake_original_waiting_sleep verifies provider fault injection without physical progress. Automatic recovery of an interrupted Contact wait requires retained original-window and payload evidence; these in-process tests do not establish that recovery contract.
The required VM lifecycle lane executes Contact continuation regressions through the agent harness and the one-shot physical clock fault/wakeup regression through the testkit harness. Each suite must provide nonignored source declarations, actual harness discovery and successful exact-name execution; tests assigned to a different package cannot satisfy the requirement.
Required transcript encoding evidence runs in the hxrts-aura-signature library
harness within just ci-vm-session-lifecycle; Guardian partial-key reopen,
concurrent original-pair birth, and native signer/verifier failure evidence runs
in the hxrts-aura-agent harness. The inventory requires real source declarations,
harness discovery, and successful execution by exact name. Partial-key tests
reopen actual exclusively owned encrypted profiles and verify that retained
original bytes survive without a replacement half. This evidence does not cover
interrupted initial pair publication or complete historical loss of both halves.
The mandatory signed Guardian offline-response regression also corrupts actual retained imported metadata before invoking the response handler. It requires a native JSON codec failure and absence of both recovery key halves, restores the original stored record, and retains the original offline-principal timeout expectation. Cached imported state cannot substitute for required backing evidence.
Required Guardian window coverage holds the actual owned runtime's imported decision lease before polling the public response operation. Advancing its selected manual physical provider past the original deadline, or failing the already waiting provider sleep, must terminate with the corresponding typed cause before any recovery key birth. This is actual operation/preparation coverage; acknowledged VM teardown remains a separate requirement.
The required Guardian terminal-close regression uses the actual VM engine and runtime session owner. It retires that owner before advance/close, checks that a successful primary cannot hide failed close, and checks that simultaneous native operation and close failures both survive. It also verifies no runtime binding or fragment custody remains. Generic mocked close results do not prove this boundary.
Required original runtime shutdown regressions
The native VM lifecycle gate runs the exact operation-drain, capacity and actual effects-admission suites plus the retained invitation-service clone and original TaskGroup shutdown tests. Each required name must be discovered and reported as executed successfully. These fixtures cover original lease retention through awaits, equal-valued foreign profiles, closed admission, cancellation, required clock source retention, and actual supervised descendant destruction. Run the existing required lifecycle/ownership lane after changing these contracts. Passing this slice does not certify quorum enrollment or provider handoff.
Runtime activity observation doc guards require three real cases in ownership CI: permitted state observation, compile-fail external admission closure, and compile-fail external shutdown-completion publication. Required discovery and execution must retain both privacy negatives rather than accepting only a positive getter example.
Architecture lint scan inputs
Architecture syntax lints validate each requested path and inspect tracked plus
new untracked Rust sources. Directory scans exclude ignored artifacts; explicitly
requested Rust files remain inputs even when ignored. Missing input or malformed
new source fails the command. Run cargo test -p hxrts-aura-macros --test lint_input_discovery for the actual CLI discovery regressions.
A scan with no Rust inputs fails explicitly. An empty Git inventory does not
fall back to traversing ignored artifacts; filesystem fallback is reserved for
unavailable Git discovery.
Run just _policy-check check secret-lifetime-regressions after changing original
initialization cutover or recovery. The required native inventory covers actual
child termination at journal stage/ACK, individual custody publications, atomic
exchange, ACK and archival, plus source/target substitution, consecutive original
index transitions, historical corruption, unknown metadata and first-decision
preservation. Worker helpers are not standalone coverage. Preserve the original
selected lease and use backing filesystem faults in negative fixtures; never
weaken immutable-provider APIs to corrupt evidence. The initial transaction tests
do not complete live mutable checkpoint or original builder-window recovery.
The archived-custody regression physically removes or substitutes each predecessor, successor and displaced record with identical ciphertext at a different inode. Actual reopen must retain the original native failure and preserve both conflicting evidence and original bytes.
Required archived-custody validation also rejects ciphertext corruption at each of the three retained paths, preserving the original birth and current root checkpoint bytes without replacement.
Original service-stop regression
The required VM lifecycle lane executes the exact
required_service_stop_retains_original_shutdown_deadline_under_actual_state_contention
regression. It holds actual threshold-service state across the original shutdown
deadline, checks retained native time/provider failures, and verifies that failed
required disposal leaves authority status nonterminal. A second actual owned-task
failure regression verifies that successful later service cleanup cannot publish
authority termination after prior task-tree failure. Run just ci-ownership-policy
when changing this boundary; discovery without actual execution is insufficient.
The required original service-stop suite also blocks the actual threshold service's health read after its stop completes, using its real fair lifecycle lock. Deadline expiry must leave runtime/authority termination unpublished. Retrying with a rolled-back then restored physical clock retains the original sticky rollback cause rather than starting another observation window.
The required Guardian native-provider regression constructs the actual custom
runtime with CustomCryptoProbe, then faults generation, continuity signing and
verification, and canonical response signing/verification. It requires retained
native provider causes, no key publication after failed generation, unchanged
original keys on later faults, and genuine verification after restoring the
same provider. This does not certify interrupted key birth or VM disposal.
Required session-owner and runtime-admission doctests use exact rustdoc discovery
and execution evidence in the VM lifecycle lane. Every unique published guard
must pass; a successful Cargo exit or duplicate/name-lookalike listings cannot
replace execution. Adding or removing guards requires updating the expected
inventory and its validator regressions. Run just ci-ownership-policy when
changing these ownership boundaries.
Repo-local policy validators have a separate strict lint lane:
just ci-policy-toolkit-clippy. The crate is excluded from the Aura Cargo
workspace, so workspace Clippy does not validate it. just ci-clippy includes
both lanes. The repo-local lane also executes all policy-toolkit unit tests,
including lexical test-scope and semantic-owner raw-commit regressions.
Pair validator changes with the relevant toolkit tests; warnings
must be repaired without weakening validation predicates or adding suppressions.
The mandatory Guardian lifecycle inventory also verifies exact recovery-key continuity transcript encoding against the original domain/schema/payload. Continuity uses the required typed signing and verification helpers, so concrete provider faults remain errors rather than signature refusal or replacement-key permission. The signed-transcript policy must pass without widening exceptions.
The Contact required-verifier regression uses a genuinely issued and imported invitation, acknowledged acceptance and original retained issuer signing context. It checks actual matching-key verification, foreign-runtime rejection, exclusive custody across verification, signature refusal without terminal proof, and native provider failure from a malformed required stored key. The typed syntax validator requires the primitive key to come from the original capability's checked accessor, rejecting peer keys, fallback repair, shadowed inputs and deserialization.
The mandatory lifecycle lane also discovers and executes the public invitation handler's three verifier guards: public observation compiles, private verifier construction fails, and observed envelopes cannot call internal terminal response publication. Preserve both the positive control and exact compile-fail execution; private helpers must not become raw-key or observation-based authority APIs.
Required sync native-source evidence
ci-vm-session-lifecycle also executes the exact aura-sync native-source inventory: real malformed JSON decoding with direct concrete downcast and Clone, pure diagnostic category preservation, and retained nested/terminal causes. Source validation, Cargo discovery, and execution are all required. The same lane discovers and executes the SyncDiagnostic and sync_error_with_cause compile-fail guards, rejecting existing error/terminal conversion and string-only native causes. These tests establish provenance; they do not establish requested-peer success or remote teardown.
Guardian verifier role regression coverage
Guardian verification has distinct required owners for original local-pair integrity, imported issuer continuity, and first-binding recovery possession. The Rust key-origin validator checks exact immutable helper inputs, retained key accessors and original runtime/lease checks. Its negative cases reject raw and peer keys, qualified or wrong-role types, public fields, reconstructed owners, and shadowed bindings. Production-source mutation cases also reject missing issued-runtime, invitation-id and issuer-key comparisons.
Required runtime regressions use actual owned profiles, genuinely issued
invitations and real two-runtime choreography. Same-authority foreign-runtime
pair verification is rejected; original configured-provider faults retain native
causes. Primitive provider-fault fixtures have no terminal publication authority.
Run the strict toolkit lane and just _policy-check check security-boundary-policy
with the required lifecycle inventory. A focused validator result does not prove
whole-runtime teardown, durable historical recovery, or enrollment quorum handoff.
Owned Guardian verifier byte origins also use a Rust AST check: a declared
SecurityTranscript and the fallible required canonical encoder must produce
immutable bytes passed into the primitive. Actual-source mutations reject raw
or fallback bytes, shadowed bindings, missing trait declarations, wrong
confirmation factory return types and replaced encoder origins. Unproved paths
retain the existing syntax checks; a nearby transcript comment cannot override
a rejected typed origin. Run just _policy-check check signed-transcript-boundary
and then the complete security boundary policy.
Security bypass test exclusions are lexical Rust cfg(test) scopes. Mixed
any(test, production_feature) remains checked as production. Actual-source
coverage removes the Contact fixture's test cfg and verifies that its test-like
module name does not exempt the unsigned source. Nested test impls and later
production items are covered separately; parse failures fail the policy check.
Required Sync command evidence
The lifecycle aggregate discovers and executes exact Sync registry, requested-session and session-window tests. Registry coverage includes actual foreign admission rejection, clock failure before actor birth, admission release at registered handoff, real requested-peer authorization failure, idle-round classification, actual periodic protocol failure and whole-runtime stop ordering. Session tests cover exact local entry custody under cancellation, partial admission cleanup, endpoint overflow, original deadlines and sticky rollback. These tests do not establish remote session teardown, network delivery or durable restart continuation. Failed-start cleanup and retained command stop retries remain required integration scope.
The required construction inventory includes production_seed_rejection_precedes_profile_io_with_custom_real_crypto. Typed entropy-origin syntax validation checks the exact private factory, capability signature and consumer receiver; decorative metadata, public seed fields, success/error generic substitution, raw seeds and an unchecked extra factory are rejected. Runtime rejection remains necessary evidence; syntax alone does not prove provider entropy quality.
Nonproduction constructor entropy fidelity
The required secret-lifetime gate discovers and executes the actual Simulation constructor stream-continuation and configured-provider regressions. Constructor tests interleave effect dispatch with a clone of the constructed crypto subsystem and compare against an independently seeded reference, including the receipt-key draw performed during assembly. Configured crypto and random handlers must remain the actual dispatch owners even when deterministic fallback entropy is admitted. Owned Testing constructor coverage uses the original pre-IO build operation and selected profile custody; primitive unowned fixtures do not establish that contract.
Required committed Chat read faults
The VM lifecycle gate also discovers and executes the two exact matching Chat fact corruption regressions. Each persists a matching malformed JSON or unsupported-schema envelope through the actual required journal ingress, then checks all three committed group/message/group-list readers. A matching corrupt record must retain its native codec/schema cause rather than report absence or an empty successful result. Test disposal awaits the actual scheduler under one effect-backed resource window.
Raw threshold route enforcement
public-frost-signing parses the raw threshold service and rejects quorum primitive calls on that surface, including calls hidden in renamed helpers. This syntax fence complements the actual finalized-enrollment native-source regression runtime_bridge::error_boundary::actual_enrolled_identity_quorum_tests::actual_activated_threshold_identity_requires_quorum_owner_with_native_source, which checks both valid threshold state and actual local backing loss. The fence does not prove the distributed owner implementation. Genuine repeated enrollment after threshold activation remains required integration coverage.
Required reactive callback outcomes
Reactive callback fixtures must return explicit typed outcomes. The scheduler
regression required_projection_failure_preserves_native_cause_and_blocks_batch_ack
checks native failure provenance, skipped later projection work, unchanged
processing acknowledgment and absence of successful batch diagnostics. Issued
target failure propagation and domain codec failures require their own runtime
regressions; this batch-level test alone does not establish full readiness.
The required VM lifecycle inventory also discovers and executes the actual fallible reactive batch, issued-target failure and all-five signal-view snapshot fault regressions. A required projection failure retains its native cause and cannot acknowledge processing progress for that batch or issued target. An unregistered required signal snapshot must fail explicitly on each view.
The matching invitation and Chat projection codec regression feeds malformed JSON and unsupported schemas through actual registered signal views and checks that native causes are retained without advancing either projection revision. Invitation projection additionally validates the payload context against its journal wrapper. Codec failures are terminal outcomes, not display-only errors.
The core regressions
required_fact_decoder_rejects_json_through_both_entry_points and
required_fact_decoder_retains_native_cbor_cause_through_both_entry_points
feed declared JSON and malformed DAG-CBOR through both the envelope and encoded
fact APIs: JSON is rejected as non-canonical, and a DAG-CBOR failure keeps its
concrete serialization source.
Domain projections must use required decoders on matching fact types; optional
observational decoding does not establish processing success.
The required source inventory includes actual matching Invitation/Chat projection codec faults and the core JSON decoder's native-source regression through both validated envelope and byte entry points. These tests must be discovered and executed in their actual package harnesses; corruption cannot become an empty successful projection or erase its original codec category.
The projection codec regression also covers matching Contact, Friendship and Recovery records through their domain-owned required decoders. Malformed JSON and unsupported schemas must retain native causes and leave Contact and Recovery source revisions unchanged, alongside Invitation and Chat revisions.
The required core timeout inventory executes
required_timeout_drops_cancelled_query_before_reacquiring_observation_owner
against the actual shared observation gate. Cancellation must destroy the
losing query future before the timeout owner reacquires that gate. This
regression proves cancellation custody; it does not establish bounded initial
clock queries or final service cleanup acknowledgement.
required_signal_views_matching_domain_codec_faults_are_terminal also covers all
nine moderation domains before Home materialization. Declared corruption and
unsupported schemas cannot be hidden behind absent Home state. The required
lifecycle inventory tracks this expanded name and each native cause.
Required Sync local session-custody tests inspect the actual retained session
records, including initializing allocations. Operational total_sessions
statistics count terminal outcomes and cannot prove allocation presence or
retirement. Exact owner Drop, partial admission and cancelled-future regressions
must establish removal of real original allocations and preservation of foreign
records; a diagnostic zero count is insufficient.
Required absolute terminal observation coverage
just _policy-check check absolute-time-observation verifies exact source,
nonignored harness discovery and successful execution for the core terminal
acknowledgment tests, the real native provider, and ManualPhysicalClock.
The same inventory runs in ci-vm-session-lifecycle. Required cases include a
hung current read, observation-lock contention, delayed checkpoint with endpoint
priority, expiry caused inside the checkpoint's completion poll, a hung or failed
selected postcheckpoint read, postcheckpoint rollback, native timer failure
without invented expiry, unsupported providers, and publication under the original
guard. Postcheckpoint validation retains the selected provider and original
endpoint; it is local validity evidence, not a durable domain acknowledgment. Actual provider cases exercise fixed
endpoints after delayed registration, rollback, native failure custody and real
native timer wake observations. A focused pass does not prove the broader
runtime shutdown, command admission, browser execution or enrollment lifecycle.
Initial-publication coverage executes the actual generic owner seam with a move-owned acknowledgment. It requires publication before any physical read, bounds hung writes, readbacks, postpublication reads and gate acquisition, and checks deadline-first arbitration, losing acknowledgment disposal, concrete provider and publication errors, rollback refusal and exact-endpoint expiry. This local race does not itself prove durable enrollment birth or settlement; the sealed enrollment owner supplies and validates that actual acknowledgment.
The inventory also verifies provider identity and uncertainty preservation
through the runtime facade.
Required workflows retain the selected PhysicalTimeEffects provider directly;
timestamp-only adapters cannot substitute for its actual witness.
The fixed-endpoint inventory also discovers and executes the exact physical-
deadline trait compile-fail doctest. It rejects receipt-generation coordinates;
positive provider tests simultaneously require the physical coordinate API.
The manual TimeError display and source matches are exhaustive, so new variants
require an explicit native-source decision at compile time.
Architecture reactive enforcement inspects actual direct generic fact commits inside declared semantic owners. Those owners use required commit and processing capabilities when their terminal contract requires projection acknowledgment. Durable actor publication is a separate contract; invitation acceptance need not wait for contact-link convergence. AST regressions reject marker-word and unrelated-helper substitutes for completion while preserving ordinary actor publication. Interprocedural ownership remains enforced by the annotation ratchet and typed capability gates. The required policy-toolkit lane executes these regressions before strict Clippy.
Fresh terminal bootstrap history continuity
A fresh terminal account starts with a runtime-free AppCore. Its bootstrap
shell transition retains that exact app in process and attaches the first
runtime, preserving the original account creation terminal operation. The
shared semantic snapshot must continue to expose that operation after runtime
readiness; account files or a stale pending bootstrap record cannot manufacture
another success. The original global tracing writer remains owned across this
shell transition.
The app regression
bootstrap_attachment_retains_original_terminal_history_and_rejects_replacement
checks exact operation history and rejects an existing runtime replacement,
including after detachment. First-runtime attachment is irreversibly spent;
it runs in the required workspace test lane. Production shared settings parity
also exercises account creation, runtime readiness and the subsequent semantic
snapshot across the transition. Provisional enrollment and explicit authority
switching still use process reload; first-runtime attachment does not establish
physical provider transfer or runtime retirement.
Projection observations and authoritative readiness
Browser and terminal shells describe observed canonical chat/contact snapshots
with the same pure aura-app::ui_contract builders. ChatSignalUpdated describes
the current selected (or deterministic default) channel and view counts. The
default orders equal names by canonical channel ID, and browser message lookup
keeps that selected ID rather than resolving again by display name. The
legacy RemoteFactsPulled name describes contact/discovery projection counts;
it does not attest to transport activity or successful anti-entropy. These
observations replace earlier counts rather than retaining stale count keys.
Shared parity still compares them. Business-flow waits must use the app-owned
membership, recipient, delivery, and operation facts; frontend projection loaders
cannot synthesize readiness from a channel row or a member list.
Frontend task shutdown must acknowledge destruction of admitted futures before another in-process shell generation starts. The terminal closes task admission and observes completion with its bounded cleanup helper after dropping fullscreen hook futures. Cancellation flags alone cannot satisfy this boundary; drain failure prevents reload. Required workspace tests cover escaped owned-spawner work, rejected post-shutdown admission and never-polled future destruction before completion acknowledgment. Bootstrap continuity coverage also reads the newly attached runtime's semantic signal, rather than checking only the app store.
The native shell starts one effect-backed shutdown window when a bootstrap
handoff notification arrives, or after ordinary fullscreen termination. The
same original deadline bounds fullscreen exit, clearing harness submission
ownership, and acknowledged child destruction. Failed clock allocation or an
expired window cannot start a replacement deadline. Teardown preserves native
notification, clock, sender-clearing, fullscreen, and child-drain failures.
The controlled-clock bootstrap_exit_and_task_drain_share_original_shutdown_endpoint
regression verifies that four seconds spent exiting leaves one second to drain;
workspace unit CI runs this test alongside the actual shared parity scenarios.
The sender-clearing failure regression verifies that a later drain timeout
retains both native causes even when the bounded future is dropped.
Runtime-free account creation ownership
The configured native staging adapter delegates actual pending-bootstrap and encrypted account-profile writes to the app-owned staging workflow. The original operation instance transfers before the first awaited producer step. Only acknowledged writes mint app-owned terminal success; frontend callbacks observe completion and request bootstrap reload. The retained AppCore supplies that original history to the new runtime signal graph. Runtime attachment rejects replacement, and pending-file reconciliation cannot manufacture account-create success.
Regression coverage must exercise actual storage production and observe the original operation after runtime attachment; manually seeded semantic facts do not establish producer ownership. The CreateAccount callback requires a workflow handoff owner, preventing submission with a local terminal owner.
Account creation submission enforcement
Run just ci-frontend-handoff-boundary after changing account creation callbacks
or submission ownership. Its parsed Rust guard rejects local-terminal submission
with the actual SemanticOperationKind::CreateAccount argument. Preserve the
callback's workflow handoff type and the original operation instance before the
first awaited native staging step. The guard's positive/negative Syn fixtures
cover helper/direct calls, qualified paths, unrelated strings/types, and proven
lexical test scopes. These syntax checks supplement actual storage-producer
regressions; seeded operation history alone does not prove production lifecycle
publication or continuity after runtime attachment.
Required native enrollment quorum evidence
After quorum signing-owner, prepared issuer, packet authentication, retained
initial Request or restricted completion observer changes, run the serialized
just ci-vm-session-lifecycle, ownership/annotation and security-boundary lanes.
Required fixtures must be nonignored, discovered by the actual selected harness,
and individually reported as successfully executed. A zero-match green Cargo
process or compile-fail import alone does not prove runtime custody.
The real confirmation fixture activates and reopens the original enrolled physical profile before explicit approval on both actual native threshold devices. It must retain all archive, immutable envelope, replay and corruption assertions, then prove genuine next issuance with no local aggregation of remote shares. Initial Request signature substitution, old intent replay, current package/epoch mismatch, expired original window, actor cancellation and native drain failure need adversarial execution evidence. Initial issuance is not later confirmation quorum, profile restart continuity or complete service disposal evidence.
Public approval compile-fail guards cover construction, Clone and serde rejection. The completion observer public opacity guard is distinct from native internal regressions proving permit release, protected-clock continuity and the absence of arbitrary execution/child/raw-clock authority. Keep exact required names in the typed VM lifecycle inventory and retain its discovery/execution validator tests.
The required native
real_committed_confirmation_is_durable_and_reverified_before_activation_capability
fixture also checks actual repeated confirmed handoff, preservation of signed raw
share/configuration bytes, unchanged original activation envelope, refusal to
recreate a lost envelope after birth, and the native codec source for a corrupt
envelope. Fault injection uses the selected provider's test boundary and restores
only the captured original bytes before the existing profile reopen and actual
explicit two-runtime quorum issuance assertions. These cases do not establish
profile WAL or process restart continuity.
Confirmed wrapping evidence must also exercise the actual allocation manager: original birth, read and positive sealing under the verified import receipt, exact scope/reference substitution refusal, and interrupted publication refusing a second allocation for an already born scope. An unchanged envelope alone does not establish managed secret lifetime custody. Preserve native provider sources and distinguish these assertions from legacy envelope encryption coverage.
Authoritative fact policy test scopes
Frontend authoritative-fact restrictions inspect Rust paths and macro tokens.
Genuine lexical test scopes may observe the original published facts in native
producer regressions. Comments, string diagnostics, and preceding test modules
cannot exempt adjacent production. Mixed cfg(any(test, feature = ...)) remains
production-capable and checked; the toolkit regression suite enforces this split.
Schema-one AMP membership projection regressions must cover both opaque fact orders, split updates, duplicate replay, restart replay and metadata after leave. The shared compact remove-wins reducer supplies both native and reactive views. A foreign context must not hide a channel, and local departure cannot be undone by an unversioned join or channel hint. Departed senders must fail projection admission even with known-member or invitation enrichment. App readiness tests must prove native participant counts defeat stale row/published count hints and removed peers do not enable recipient or delivery readiness. Certified successor membership requires actual verified inclusion evidence; transition ids and hashes are insufficient.
Ownership checks in clean checkouts
Service-surface governance scans required production roots even when ignored
local work/ notes are absent. Existing scratch remains subject to exception
metadata checks. The toolkit regression exercises a clean fixture without
scratch, rejects an unowned production exception, and checks existing scratch
metadata. Do not create or publish work plans merely to satisfy a CI validator.
Mock runtime physical time and required tasks
MockRuntimeBridge observes one manually controlled physical clock. Reads and
polling sleep_ms do not advance it. Drive timer expiration explicitly with
advance_time_ms; use set_time_ms to inject rollback and retain the resulting
native TimeError. Register notifications before rechecking the clock so a
concurrent advance cannot be lost. Entity and message uniqueness use their
separate sequence owners rather than changing physical time on observation.
Required refresh hooks must run through the mock's fallible task owner. Observe
named native failures and cancellation with shutdown_owned_tasks, which awaits
actual future destruction. Keep the native error/destruction, explicit timer
progress/rollback, and genuine listener-startup regressions in ordinary test
coverage. A timeout poll must not spend a listener's entire startup window before
that listener can acknowledge readiness.
Required app budget waits retain their typed physical endpoint through the runtime bridge and selected provider. Tests advance virtual time between operation polling and timer registration to prove the endpoint cannot move; relative-only providers must fail explicitly instead of choosing another clock.
For plain timeout and app adapter tests, stall the selected provider's initial or success clock read and contend the original observation gate. Release the actual absolute endpoint, then assert that losing reads/operations were dropped, no pre-observation operation ran, and the original typed deadline or native cause survived. Child and retry observations use that same bounded core primitive. These observations prove local window handling, not domain completion or durable enrollment checkpoint acknowledgment. Exercise native transport separately from AMP/member/journal readiness; absence of sibling devices must not invalidate an already established cross-authority transport.
Both frontend observation surfaces use version 2 and require UiSnapshot.home_modes: a stable list of canonical channel ID, context ID and optional mode flags. The app-owned projection helper derives these observations solely from materialized HomesState; entries lacking a canonical context are omitted. Native and browser exports bind these values to projection_source_revisions.homes from the same app snapshot. Wait on pushed semantic snapshots for the expected binding and flags, then compare both frontends; DOM labels and rendered mode text are diagnostic only. Loading snapshots contain an explicit empty vector, and missing wire fields fail decoding. Mode changes still require the sanctioned command owner; these observed strings grant no authority.
If the shared controller cannot acquire the app snapshot, it exports the existing loading/busy snapshot rather than claiming authoritative empty home modes with ready state.
Completed owned runtime refreshes schedule semantic publication even when rendered view values compare equal: mode-only canonical changes must wake pushed snapshot observers. Display signals remain updated only when their values change, and the existing snapshot sink deduplicates identical observations.
Renderer-backed control observations
Ordinary control_visible expectations use renderer-committed control layout,
not focus, eligibility, screen selection, or DOM-selector fallbacks. Onboarding
is the first explicit native/web producer. Unsupported controls fail explicitly
until their actual renderer owners publish observations. Observation wire version
3 adds required rendered_controls and rendered_control_frame without a legacy decoder. An empty Committed frame requires the real renderer commit receipt; an empty Unavailable frame is not unmount evidence. Fresh layout measurements retain that same renderer receipt and advance a separate layout revision. Capture receipts
are private to the UI publication owner; serialized capture revisions cannot
replace receipt identity. A superseding render first invalidates old visibility,
and stale callbacks from a previous mount cannot overwrite the active capture.
Browser regression execution must use wasm-bindgen-test in a real browser with
feature web; the fixture runs the actual dioxus-web renderer through the
sanctioned WebTaskOwner. Native canvas regressions draw the actual account modal
and its clipping ancestry. Neither a pure capture test nor native VirtualDom
simulated mounted events substitute for these producer tests. This first producer
does not close the full control inventory or the paired-client LAN release gate.
On browser scenario failure, the harness retains a bounded 2,000-line merged app/console log tail so the original typed error context survives high-volume UI publication and wait diagnostics.
Native nested clipping instrumentation delegates the original iocraft View props,
layout and drawing on the same node. Hidden and Scroll overflow boundaries, the
terminal-provided viewport and actual registered field/list nodes compose their
bounds; keyboard-only actions do not gain fabricated button observations.
Browser layout fixtures include child-owned rerenders with a memoized parent,
exact-target actual resize and scroll-listener witnesses and a fresh canonical
snapshot measurement. DOM references arrange these changes;
typed renderer observations are their postconditions. The web producer uses an
unmodified, exactly pinned dioxus-web 0.7.4 renderer. Its owned future wrapper
revokes observations before each poll and can acknowledge only the final flushed
state after the renderer suspends. Tests must cover a no-edit wakeup, reentrant
reads during revocation, cancellation, child-only rerenders, exact-target resize
and scroll callbacks, and stylesheet replacement before asynchronous
MutationObserver delivery. The UI publication owner must reject a frame if
its final app source differs. Exercise a memoized parent with child-only
Settings navigation to Devices: the new capture and semantic sequence must
advance, the old nickname control must disappear, and the visible import
control must match the committed source. Hydration remains unsupported;
renderer upgrades require a real-browser audit of run suspension and
synchronous flush_edits ordering, not compilation alone. Component effects
and mutation notifications cannot acknowledge a root-wide render. The
diagnostic two-browser run reached signed code, mounted import control,
explicit three-field approval and import success, then Bob readiness after
restart; it failed the two-device retention assertion and does not prove
same-profile adoption or complete enrollment persistence.
Modal focus observation retains the exact canonical ControlId::Field(FieldId)
from the active modal field. A generic modal-input identity cannot replace that
field and focus does not prove rendered visibility. The unused invitation-type
list/field and generic modal-input wire variants are removed with their raw-key
selector/fallback paths; no compatibility decoder remains. Actual native and
shared UI snapshot regressions cover all four contact-invitation fields. These
are local observation checks, not paired-client business completion evidence.
LAN lifecycle locking uses the pinned cross-platform flock tool in both the
normal and CI Nix shells. The driver takes a nonblocking lock on its persistent
lifecycle-file descriptor; process death releases custody, and long-lived
children close that descriptor. A missing tool refuses lifecycle mutation before
creating run state. Platform-provided lockf is not a dependency.
ship.sh enters the candidate's pinned shell first. It copies and roots the
portable lock tool's Nix closure on the remote host before stopping an older
checkout, then streams the exact clean candidate driver into that host's existing
pinned environment with its real script path. Existing remote configuration,
helper paths and exact process/run identity checks remain in force. The remote
does not build a binary. Run the retention lifecycle and ship fixtures to verify
contention, dead-holder release, descriptor noninheritance, missing-tool refusal
and old-checkout bootstrap before another LAN confirmation batch.
The remote checkout explicitly refuses tracked changes and a HEAD different
from the requested candidate before creating artifact directories or replacing
runtime roots. These predicates use explicit failure exits because remote Bash
versions do not consistently apply errexit to conditional commands. The exact
checkout fixture covers dirty, ahead, failed-status and matching checkouts.
The browser WASM test lane uses scripts/verify/wasm-browser.sh to validate the
selected Chromium and ChromeDriver build versions, write private capabilities,
and delegate to the existing Cargo.lock-matched wasm-bindgen runner. Linux Nix
shells supply both executables from the same pinned package set. Native macOS
runs must explicitly select their actual browser and matching driver with
AURA_TEST_CHROMIUM and AURA_TEST_CHROMEDRIVER; an absent or mismatched pair
refuses before runner execution. The wrapper preserves runner status and removes
its private capabilities file after success or failure. Playwright is a separate
protocol and cannot serve as a WebDriver executable.
For aura-effects/tests/browser_secret_lifetime.rs, use that external real
browser runner with the web feature and actual Web Lock/IndexedDB origin;
native libtests or the Playwright harness cannot execute its wasm_bindgen_test
fixtures. The selected-owner test covers one-shot/foreign lease refusal, live
birth, durable negative retirement and reopen of the same encrypted inventory.
The external-conflict test overwrites the fixture's selected IndexedDB record
and requires state/read/reconciliation refusal without fresh secret issuance.
These provider fixtures prove local selected-writer custody only. In the
two-browser flow, Alice's device_enrollment_code_ready under that provider
does not prove Bob's mounted Devices control, explicit approval, host
persistence or same-profile reopen; each needs its own observed result.
Canonical signed-owner checkpoint validation
Declare the source fingerprint, package/features and source-declared fixture inventory before compiling. Keep native production compilation, applicable WASM compilation, exact discovery and execution in one guarded source lifetime. Discover the complete timeout inventory and canonical launch, participant, cancellation, peer and opaque-disposal regressions before executing exact names; source declarations and zero-match/ignored harness output cannot establish a passing fixture. Derive execution counts from the actual selected harness.
Checkpoint regressions must retain the actual final receipt, native operation failure, first checkpoint failure and independent selected-clock validation. Exercise original Pending birth, fixed provider/interval, observer disposal, refused required admission, partial native acquisition and actual participant completion before Closed. Proposal/consent negatives must reject another manifest, enrolling device, purpose, historical intent, substituted domain order and noncanonical transfer bytes. Task disposal tests must distinguish same-named foreign custody and successful cleanup from failed domain execution. Pure or component evidence does not establish genuine signed enrollment, platform persistence, reopen correctness or final independent-process network behavior.
For original issuer reconciliation, exercise genuine cancellation and actual cancelled-generation retirement before retrying cleanup through the retained control. Drop an in-flight reconciliation attempt and verify the canonical entry still owns that exact control; reject a same-named foreign task. Assert no new spawn, provider or budget birth, and preserve concrete operation failures apart from final negative-budget validation. Cover already disposed resource observation without granting positive authority, and active-execution refusal without unbounded polling or a fabricated ACK. Complete durable cleanup and original-window validation before asserting full resource acknowledgment. These requirements are fixture scope, not evidence that the candidate ran.
Run security-boundary policy first and strict Clippy once for the complete integration checkpoint, with required syntax, ownership, absolute-time, annotation and retained architecture gates. Preserve the existing main smoke and final paired-host requirements; do not repeat broad checks per fixture or treat this documentation as evidence that the candidate executed.
Security scanner test scope
Security policy scanners compute parsed positive-test scope once per file and
reuse its line inventory across checks. A prior test module, _for_tests name,
comment, string or nearby test attribute cannot exempt production declarations
or macro tokens. Mixed test/production cfg predicates remain production.
Exercise the actual production scanner with production following a closed test
module, text decoys and macro tokens; classifier-only coverage does not prove
scanner wiring. Run just _policy-check check security-boundary-policy before
broader CI.
Simulation Guide
The AMP lifecycle harness uses a checked-in deterministic Quint trace.
just ci-amp-lifecycle-trace checks regeneration, and
cargo test -p aura-simulator --test amp_channel_itf replays it with isolated
storage. The creation action commits the protocol checkpoint and complete
canonical chat creation before an invitation resolves its context. See
Testing Guide for regeneration.
This guide covers how to use Aura's simulation infrastructure for testing distributed protocols under controlled conditions.
When to Use Simulation
Simulation suits scenarios that unit tests cannot address. Use simulation for fault injection testing. Use it for multi-participant protocol testing. Use it for time-dependent behavior validation.
Use direct effect-handler tests for single-component validation. For distributed runtime and app workflows, the primary feedback loop is deterministic in-process execution of the real implementation. Use controlled transport, selected virtual-time providers and real cryptographic, journal and ownership paths. A model-only adapter or a mock success response cannot establish complete-flow correctness.
See Simulation Infrastructure Reference for the complete architecture documentation.
For enrollment, aura-simulator --test enrollment_lifecycle uses a
simulation-feature agent adapter with genuine signed setup, transferred verifier
pins and native profile owners. Its public-app fixtures cover an acknowledged
nonsecret host completion write followed by same-profile reopen and a real
filesystem write refusal with the original app instance and storage source.
Run exact test discovery and execution together inside one guarded build. The
fixture does not prove production identity persistence, browser host behavior,
or network delivery to a pre-adoption device; those require their own adapters.
After the in-process fixture passes, scripts/harness/lan/single-host-enrollment.sh <fresh-token> <clean-peer-checkout> runs the private paired checklist through
two separate native owner processes on one host. Both clean checkouts must
contain the same commit; the caller supplies prebuilt tool_repl and aura
binaries through AURA_E2E_TOOL_REPL and AURA_E2E_AURA_BIN or their defaults.
The runner checks their hashes, uses disjoint private profiles and loopback
ports, and records the authenticated broker ACK, exact operation instance,
host acknowledgment, process identities, reopen, and independent shutdown.
Its result states cross_host_asserted:false. The final two-host batch remains
the evidence for cross-machine delivery and platform behavior.
Simulation vs Harness
The simulation architecture is specified in Simulation Infrastructure Reference. The harness architecture is specified in User Flow Harness.
Validate complete runtime and app workflows in-process before escalating to frontend or cross-machine execution. The harness remains the executor for real frontend scenarios. Local browser and TUI conformance tests establish submission, rendering, subscriptions and platform storage behavior. Cross-machine P2P runs are a final, batched integration check for real transport, discovery and process/platform boundaries.
If a required flow cannot execute completely in-process, identify the missing production adapter or reusable fixture and extend that seam before using LAN runs as the development loop. Keep genuinely platform-specific checks in their appropriate local lane. Share semantic actions and expected outcomes through aura-app; do not create a second protocol implementation or frontend executor.
Validation sequence
| Stage | Required evidence |
|---|---|
| Narrow compile and component tests | Production APIs compile; focused invariants and error sources hold |
| Complete in-process flow | Real participants, protocol, app owner, persistence, cancellation, disposal and restart under selected virtual time |
| Local frontend conformance | Actual renderer/input wiring, browser or native storage, subscription and teardown behavior |
| Checkpoint gates and main smoke | Required policy and integration checks on the resulting source revision |
| Batched cross-machine confirmation | Prebuilt identical revisions; declared E2E flows and real network/platform integration |
Use narrow compiles and exact deterministic regressions while implementing each slice. Batch full-project tests, broad ownership aggregates and Clippy at the reviewable integration checkpoint rather than rerunning them after each fixture change. Deferred gates remain required acceptance evidence. Reuse compiled fixtures and valid results for unchanged scopes, then run main smoke on the integrated revision before final network confirmation.
Declare package, features, exact test inventory and expected count before building. Discover intended fixtures before executing them; zero or ignored matches fail validation. Reuse valid evidence for unchanged scopes and rerun affected scopes when their dependencies change. Record the first failing typed action, original operation/owner, seed, provider, endpoint and fault boundary so a later LAN failure can become a deterministic regression.
Select stages that cover the affected contract. A pure component or documentation change does not require an unrelated full-flow run. Preserve explicit task and policy requirements, and never use a narrow result to claim broader lifecycle or platform coverage.
Assign coverage before execution
Use the lowest stage that executes the affected contract. Record unsupported stages as fixture or adapter work, with a named owner and dependency, before scheduling broader runs.
| Contract under test | Primary evidence | Remaining integration evidence |
|---|---|---|
| Admission, signing, journal convergence, replay and cancellation | Actual runtime/app execution with controlled effects and deterministic fault boundaries | Final network integration of locally proven flows |
| Required persistence, task disposal and profile reopen | Real storage and owned runtime lifecycle in-process | Platform-specific persistence and process integration |
| Browser storage, renderer events and TUI input wiring | Actual local browser/TUI conformance | Cross-machine user-flow integration |
| Socket discovery, real transport and independent processes | Focused network diagnostics when necessary | One declared, batched both-host E2E run |
A passing runtime fixture does not close an app terminal-publication or browser persistence gap. Keep those dependencies explicit while reusing the same participant setup and semantic contract. Likewise, a passing model or scenario adapter does not certify production execution. Report discovered and executed fixtures separately for each stage.
When a complete flow is missing
Record the first unsupported stage, its canonical production owner and the smallest adapter or fixture needed to execute it. Implement that seam with its focused regression in the active batch, compile it, then reuse it in the actual flow. Keep the broader task open until that flow executes. Do not substitute a mock success, copied protected state or repeated LAN attempts for the missing stage. Reuse participant setup, fault controls and cleanup across scenarios.
Before implementation, settle ownership, provider, original deadline and cancellation behavior. Keep one coherent integration batch per worktree and at most one next draft. Compile before expanding adjacent functionality; review the implementation using compiler and focused test feedback. Classify new findings as current blockers or subsequent work.
Declare the next checkpoint
Before editing, attach this short declaration to the active task or batch:
Source revision and affected contract:
Canonical producer and retained owner:
Package / features / test binary / exact names / expected count:
In-process stages covered:
Missing reusable seam and blocking task:
Local frontend evidence required:
Final P2P assertions remaining:
Required gates:
After the check, report compilation, discovery and execution separately. Extend the existing fixture for a missing stage before growing the dependent feature. Preserve valid receipts for unchanged dependencies; do not repeatedly run a broad suite while a known shared compiler blocker remains.
Inventory lifecycle outcomes
For each real flow, record success, rejection, failure after partial progress, cancellation, persistence, disposal and same-profile restart independently. Identify the canonical producer, deterministic control and actual acknowledgment for every applicable stage. Mark a stage not applicable with a reason; name the missing reusable seam when it is unsupported. Compile and execute one coherent slice before adding the next stage. This inventory guides fixture development and keeps the final network batch focused on remaining integration assertions.
First reusable complete flow
Enrollment is the first target for extending complete-flow coverage. Reuse genuine account/profile setup, signed setup export, explicit independent verifier transfer, original issuer registration, actual acceptance/rejection, app terminal publication, host persistence acknowledgment, required disposal and same-profile reopen. Obtain all capabilities and receipts from their canonical producers. Named fault boundaries should cover preparation, required writes, host finalization, terminal observation and shutdown.
Include a failure after actual issuance in the fixture inventory. Route early errors through cleanup of every assembled owner, retain the primary native error separately from cleanup errors, and observe task disposal before attempting same-profile reacquisition. A dropped fixture or empty task snapshot alone does not acknowledge cleanup.
Keep effect providers and reusable fault controls in aura-testkit, runtime assembly in sanctioned aura-agent test support/factories, and scenario orchestration in the simulator or existing integration tests. Preserve downward production dependencies. This is a coverage target, not a claim that a complete reusable enrollment fixture already exists. Extend the same pattern to other flows once this vertical slice compiles and executes.
Bootstrap delivery checkpoint
For the recipient and purpose contract in Rendezvous, start with the existing in-process broker and canonical signed invitation producers. Register two actual devices of one authority with different retrieval credentials. Verify that each receives only its own deliveries, a foreign device's credential cannot retrieve them, and refreshing one registration cannot replace the other. Check empty retrieval separately from the one-use credential consumed by an actual nonempty delivery.
Deliver enrollment and contact invitations together. Require the existing bootstrap owner to retain both, dispatch each by its declared purpose, and preserve explicit enrollment approval and canonical contact verification. Exercise wrong-purpose, foreign-recipient, verification-failure and cancellation outcomes without losing unrelated deliveries. Observe workflow completion and required disposal independently of the broker's transport receipt.
Declare and confirm the exact discovered tests before execution. After this checkpoint, use the existing local browser fixture for real HTTP, cross-origin headers and browser dispatch. Reserve cross-machine transport and full frontend integration for the final batched Air run. These are required coverage cases; the current broker client receipts alone do not prove them.
Two Simulation Systems
The two simulation systems (TOML scenarios and Quint actions) are specified in Simulation Infrastructure Reference.
| Use Case | System |
|---|---|
| End-to-end integration | TOML scenarios |
| Named fault injection | TOML scenarios |
| Conformance testing | Quint actions |
| State space exploration | Quint actions |
When you need user-facing coverage, promote the scenario into the real-runtime harness lane after it is stable in simulation. Treat simulation as a substrate for controlled runtime conditions, not as the final UI executor.
TOML Scenario Authoring
Creating Scenarios
Scenario files live in the scenarios/ directory.
[metadata]
name = "recovery_basic"
description = "Basic guardian recovery flow"
[[phases]]
name = "setup"
actions = [
{ type = "create_participant", id = "owner" },
{ type = "create_participant", id = "guardian1" },
{ type = "create_participant", id = "guardian2" },
]
[[phases]]
name = "recovery"
actions = [
{ type = "run_choreography", choreography = "guardian_recovery", participants = ["owner", "guardian1", "guardian2"] },
]
[[properties]]
name = "owner_recovered"
property_type = "safety"
Each scenario has metadata, ordered phases, and property definitions.
Defining Phases
Phases execute in order. Each phase contains a list of actions.
[[phases]]
name = "fault_injection"
actions = [
{ type = "apply_network_condition", condition = "partition", duration = "5s" },
{ type = "advance_time", duration = "10s" },
]
Actions within a phase execute sequentially. Use multiple phases to organize complex scenarios.
Adding Fault Injection
Fault injection actions simulate adverse conditions.
[[phases]]
name = "chaos"
actions = [
{ type = "simulate_data_loss", participant = "guardian1", percentage = 50 },
{ type = "apply_network_condition", condition = "high_latency", duration = "30s" },
]
Available conditions include partition, high_latency, packet_loss, and byzantine.
Running Scenarios
cargo run --package aura-terminal -- scenario run scenarios/recovery_basic.toml
The scenario handler parses and executes the TOML file. Results report property pass/fail status.
Working with Handlers
Basic Handler Composition
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationEffectComposer; use aura_core::DeviceId; let device_id = DeviceId::new_from_entropy([1u8; 32]); let composer = SimulationEffectComposer::for_testing(device_id).await?; let env = composer .with_time_control() .with_fault_injection() .build()?; }
The composer builds a complete effect environment from handler components.
Time Control
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationTimeHandler; let mut time = SimulationTimeHandler::new(); let start = time.physical_time().await?; time.jump_to_time(Duration::from_secs(60)); let later = time.physical_time().await?; }
This handler advances time through explicit calls and its own sleep operations. For concurrent real-runtime fixtures, inject ManualPhysicalClock before service assembly when the test controls exact boundaries, or use the shared QuiescentClock with paused Tokio time for whole-flow scheduling. Sleeps on these runtime providers wait for controlled progress; one background sleeper must not advance every participant past a ceremony deadline. Retain original providers and durable endpoints across restart. Wall clock never decides distributed ordering, and timeout widening cannot repair readiness.
For a manually driven runtime replay, install
ManualPhysicalClock::observe_next_relative_sleep on the selected provider before
polling the build or replay operation. Its one-shot receiver reports the actual
typed relative-sleep target after wake notification registration. Clones share
the observer slot; a second installed observer is rejected. Verify the expected
wait was admitted (for example, the real five-millisecond reactive batch wait),
then explicitly drive the same provider to that target while continuing to poll
the original operation. The observation grants no processing acknowledgment:
await the real replay completion and retain all original provider/window and
failure custody. Do not auto-advance sleeps or renew a budget to make the fixture
finish. After forward progress, use an actual provider read for refusal
assertions, so an artificial earlier timestamp cannot create the rollback being
asserted.
Fault Injection
#![allow(unused)] fn main() { use aura_simulator::handlers::SimulationFaultHandler; use aura_core::{AuraFault, AuraFaultKind, FaultEdge}; let faults = SimulationFaultHandler::new(42); faults.inject_fault( AuraFault::new(AuraFaultKind::MessageDelay { edge: FaultEdge::new("alice", "bob"), min: Duration::from_millis(100), max: Duration::from_millis(500), }), None, )?; faults.inject_fault( AuraFault::new(AuraFaultKind::MessageDrop { edge: FaultEdge::new("alice", "bob"), probability: 0.1, }), None, )?; }
AuraFault is the canonical simulator fault model. Legacy scenario fault forms should be converted to AuraFault before injection or replay.
Triggered Scenarios
#![allow(unused)] fn main() { use aura_simulator::handlers::{ SimulationScenarioHandler, ScenarioDefinition, TriggerCondition, InjectionAction, }; use aura_core::{AuraFault, AuraFaultKind}; let handler = SimulationScenarioHandler::new(42); handler.register_scenario(ScenarioDefinition { id: "late_partition".to_string(), name: "Late Partition".to_string(), trigger: TriggerCondition::AfterTime(Duration::from_secs(30)), actions: vec![InjectionAction::TriggerFault { fault: AuraFault::new(AuraFaultKind::NetworkPartition { partition: vec![vec!["device1".into(), "device2".into()], vec!["device3".into()]], duration: Some(Duration::from_secs(15)), }), }, duration: Some(Duration::from_secs(45)), priority: 10, }); }
Triggered scenarios inject faults at specific times or protocol states.
Integrating Feature Crates
Layer 5 feature crates (sync, recovery, chat, etc.) integrate with simulation through the effect system. This section covers patterns for wiring feature crates into simulation environments.
Required Effects
Feature crates are generic over effect traits. Common requirements include:
| Effect Trait | Purpose |
|---|---|
NetworkEffects | Transport and peer communication |
JournalEffects | Fact retrieval and commits |
CryptoEffects | Hashing and signature verification |
PhysicalTimeEffects | Timeouts and scheduling |
RandomEffects | Nonce generation |
Pass the effect system from aura-simulator or aura-testkit for deterministic testing. In production, use aura-agent's runtime effects.
Configuration for Simulation
Feature crates typically provide testing configurations that minimize timeouts and remove jitter:
#![allow(unused)] fn main() { use aura_sync::SyncConfig; // Production: conservative timeouts, adaptive scheduling let prod_config = SyncConfig::for_production(); // Testing: fast timeouts, no jitter, predictable behavior let test_config = SyncConfig::for_testing(); // Validate before use test_config.validate()?; }
Environment variables (prefixed per-crate, e.g., AURA_SYNC_*) allow per-process tuning without code changes.
Guard Chain Integration
The guard chain sequence is specified in Authorization.
For simulation, capability checks rely on Biscuit tokens evaluated by AuthorizationEffects. Guard evaluators must be provided by the runtime before sync operations. Validation occurs before sending or applying any protocol data.
Observability in Simulation
Connect feature crates to MetricsCollector for simulation diagnostics:
#![allow(unused)] fn main() { use aura_core::metrics::MetricsCollector; let metrics = MetricsCollector::new(); // Protocol timings, retries, and failure reasons flow to metrics // Log transport and authorization failures for debugging }
Safety Requirements
Feature crates must follow effect system rules. All I/O and timing must flow through effects with no direct runtime calls. Validate Biscuit tokens before accepting peer data. Enforce flow budgets and leakage constraints at transport boundaries.
Verify compliance before simulation:
just ci-effects
Debugging Simulations
Deterministic Configuration
Always use deterministic settings for reproducible debugging.
#![allow(unused)] fn main() { let config = SimulatorConfig { device_id: DeviceId::new_from_entropy([1u8; 32]), network: NetworkConfig::default(), enable_fault_injection: false, deterministic_time: true, }; }
Deterministic identifiers and time enable exact failure reproduction.
Effect System Compliance
Verify protocol code follows effect guidelines before simulation.
just check-arch
The architecture checker flags direct time, randomness, or I/O usage. Non-compliant code breaks simulation determinism.
Monitoring State
#![allow(unused)] fn main() { let metrics = middleware.get_metrics(); println!("Messages: {}", metrics.messages_sent); println!("Faults: {}", metrics.faults_injected); println!("Duration: {:?}", metrics.simulation_duration); }
Middleware metrics help identify unexpected behavior.
Common Issues
Flaky simulation results indicate non-determinism. Check for direct system calls. Check for uncontrolled concurrency. Check for ordering assumptions.
Slow simulations indicate inefficient fault configuration. Reduce fault rates for initial debugging. Increase rates for stress testing.
Online Property Monitoring
Aura simulator supports per-tick property monitoring through aura_simulator::AuraProperty, aura_simulator::AuraPropertyMonitor, and aura_simulator::default_property_suite(...).
The monitor checks properties on each simulation tick using PropertyStateSnapshot input. This includes events, buffer sizes, local-type depths, flow budgets, and optional session, coroutine, and journal snapshots.
#![allow(unused)] fn main() { use aura_simulator::{ AuraPropertyMonitor, ProtocolPropertyClass, ProtocolPropertySuiteIds, PropertyMonitoringConfig, SimulationScenarioConfig, }; let monitoring = PropertyMonitoringConfig::new( ProtocolPropertyClass::Consensus, ProtocolPropertySuiteIds { session, context }, ) .with_check_interval(1) .with_snapshot_provider(|tick| build_snapshot_for_tick(tick)); let config = SimulationScenarioConfig { property_monitoring: Some(monitoring), ..SimulationScenarioConfig::default() }; let results = env.run_scenario("consensus".into(), "with property checks".into(), config).await?; assert!(results.property_violations.is_empty()); }
Default suites are available for consensus, sync, chat, and recovery protocol classes. Scenario results include properties_checked and property_violations for CI reporting.
Adaptive Privacy Simulation
Adaptive privacy validation uses simulation for cross-layer evidence. The simulator exercises anonymous path establishment, established-path reuse and expiry, move batching, cover traffic, selector-based retrieval, hold retention, provider saturation, partitions, churn, and long-offline bootstrap re-entry.
The adaptive privacy matrix should include small, medium, and large reachable sets. It should also include clustered social topologies, partition and heal cycles, sparse sync opportunities, low organic traffic, provider saturation, and stale-node return with dead remembered descriptors.
The evidence path tunes policy constants for production. Production ships one fixed adaptive policy. Development and simulation may vary constants such as cover floor, path-diversity floor, delay gain, hold retention, and retrieval rotation, but those tuning surfaces must not become user-facing production configuration.
The current fixed-policy evidence is anchored by crates/aura-simulator/tests/adaptive_privacy_phase_six.rs. That lane checks the tuned policy, archived control-plane reports, bootstrap-observer reports, Telltale-backed anonymous path establishment, and reply-block accountability.
Quint Integration
Quint actions enable model-based testing. See Verification and MBT Guide for complete workflows.
When to Use Quint
Use Quint actions for conformance testing against formal specifications. Use them for generative state exploration. Do not use them for simple integration tests.
Basic Trace Replay
#![allow(unused)] fn main() { use aura_simulator::quint::itf_loader::ITFLoader; use aura_simulator::quint::generative_simulator::GenerativeSimulator; let trace = ITFLoader::load("trace.itf.json")?; let simulator = GenerativeSimulator::new(config)?; let result = simulator.replay_trace(&trace).await?; assert!(result.all_properties_passed()); }
Trace replay validates implementation against Quint model behavior.
AMP epoch-transition simulation has a focused regression lane in
crates/aura-simulator/tests/amp_transition_scenarios.rs. It covers delayed
witnesses, partitions that create conflicting A2 certificates, subtractive
old-epoch receive cutover, emergency quarantine, emergency cryptoshred, replay,
abort, supersession, and alarm-spam cases. Run it with
cargo test -p aura-simulator --test amp_transition_scenarios; broader local
development can continue to use just test-crate aura-simulator without
requiring an exhaustive Quint/Apalache matrix.
Conformance Workflow
Simulation feeds native/WASM conformance testing. See Testing Guide for conformance lanes and corpus policy.
Generating Corpus
quint run --out-itf=trace.itf.json verification/quint/consensus/core.qnt
ITF traces from Quint become conformance test inputs.
Running Conformance
just ci-conformance
Conformance lanes compare execution across platforms using simulation-controlled environments.
Checkpoints, Contracts, and Shared Replay
Phase 0 hardening uses three simulator workflows as CI gates.
Checkpoint Snapshot Workflow
SimulationScenarioHandler exports and imports scenario-counter checkpoints. An imported snapshot is registered in a fresh handler; restore_checkpoint then restores only its captured scenario tick. Missing or invalid tick data fails closed. It does not restore live runtime owners, credentials, broker queues, storage, tasks, or capabilities.
For production-flow regression, record the seed, selected physical-time inputs, original operation and owner, broker stage transitions, injected fault, and typed outcome. Recreate the original profile and replay those inputs through the real runtime and app owners. A scenario-counter checkpoint alone is not an upgrade or durable-state migration test.
The simulator-checkpoint Cargo feature exposes native test infrastructure;
it is not a terminal, web, RPC, or production feature. To inspect the current
owner-level checkpoint contract, run the exact hxrts-aura-effects tests:
scripts/dev/run-exact-fixtures.sh --root "$PWD" --lane debug \
--package hxrts-aura-effects --lib --features simulator-checkpoint \
--expected-count 2 \
--name profile_checkpoint::tests::quiescent_filesystem_checkpoint_resets_authenticated_ordinary_branch_record \
--name profile_checkpoint::tests::quiescent_filesystem_checkpoint_refuses_unauthenticated_ordinary_branch_record
The native setup owner SimulatedEnrollment::prepare_quiescent_native_signing_profiles
assembles each original agent with the selected PhysicalTimeEffects provider,
obtains a one-use proof of the runtime-selected ProfileOwned(FilesystemFallback)
handler, and acknowledges both shutdowns before returning. A configuration
default or an existing fallback key does not prove this selection. Consume each
proof with QuiescentFilesystemProfileCheckpoint::capture, using the same
canonical original profile path, a private 0700 artifact directory outside
that profile, and a new artifact filename. Capture creates the file at 0600
and refuses an existing name. Bind capture to the source revision and participant.
Keep the artifact in private test storage; the wrapping key stays under the
original profile owner. Neither is a portable credential export. A branch must
reacquire that original path exclusively and call restore(...).await with the exact revision and
participant before constructing fresh agent, app, and broker owners. Restore
authenticates the artifact and complete file inventory before mutation, then
uses an incomplete-restore marker so interrupted reset blocks ordinary profile
acquisition. It refuses foreign, plaintext, and undecryptable branch files.
The simulator fixture can inject a SimulatorNonceRetirementLedger into the
normal threshold-signing owner through NativeEnrollmentFixture::prepare_with_nonce_retirement.
Keep that ledger outside the checkpoint and share it across sequential branches;
it rejects reuse of the same actual FROST commitment for one signer and epoch.
The current 1-of-1 signed-enrollment fixture uses its normal single-signer path,
so it does not prove a FROST retirement or deterministic nonce-counter replay.
No branch may manufacture an approval signature. Record the seed, original
operation and owners, selected clock inputs and deadlines, broker stage IDs,
named fault, typed outcome, and exact original-message ACK in a private receipt.
Current limit: the genuine signed enrollment branch creates a protected allocation-lifetime record in a reserved secure-provider namespace. Its simulator-only allocation-lifetime owner authenticates the complete quiescent index and exact added birth files, then retires only those branch-created records after the durable incomplete-restore marker. The generic checkpoint never deletes or copies them through ordinary storage or secure-location APIs. The signed fixture exercises this reset, reacquires fresh original owners, revalidates normal signed issuance, and checks the original broker message's receiver ACK and typed host outcome on each branch. Run its exact inventory:
scripts/dev/run-exact-fixtures.sh --root "$PWD" --lane debug \
--package aura-simulator --test enrollment_lifecycle \
--features simulator-checkpoint --expected-count 4 \
--name original_signed_host_refusal_replays_from_protected_selected_profiles \
--name restored_original_agent_issues_new_normal_signed_enrollment \
--name selected_replay_refuses_foreign_owner_and_stale_epoch_before_mutation \
--name protected_selected_profile_replay_benchmarks_three_branches_against_full_setups
The benchmark keeps a redacted 0600 JSON receipt under an owner-only temporary
directory in the checkout's ignored artifacts/. It reports capture plus
three restores and signed branches beside three independent full setups;
elapsed wall time is diagnostic, not a CI pass threshold. The build wrapper's
receipt supplies the full source fingerprint and exact discovered/executed
inventory. The replay receipt records only a fixture source digest, seed,
selected clock, operation/owner, named fault, ordered broker milestones,
typed result, exact first-message ACK, reopen result, and elapsed times.
The current three-branch benchmark is diagnostic: recent local runs measured
roughly 7.8–8.0 seconds with checkpoint capture and three restores against
6.9–7.2 seconds for three fresh setups. Restore of the two original profile
inventories costs roughly 0.5–0.9 seconds per branch, so this fixture does
not yet establish a speedup. Preserve the effect owner's authenticated
inventory, exclusive lease, and incomplete-restore marker when optimizing it.
Use the receipt's checkpoint_capture_ms, restore_ms, signed_branch_ms,
and full_setup_ms to calculate the break-even branch count for the same
compiled fixture. For n branches, compare capture + n × (restore + branch)
with n × full_setup, using representative phase timings from repeated runs.
If restore + branch >= full_setup, this checkpoint has no positive
break-even count. Recent unoptimized receipts have representative phases of
about 0.54 seconds capture, 0.73 seconds restore, 1.70 seconds signed branch,
and 2.31 seconds full setup; the per-branch checkpoint path is slower even
before capture. An unmerged exact-byte retention experiment reduced restore
time, but its four-run median total was still about 7.65 seconds versus
7.02 seconds for three fresh setups. Its phase medians suggest a tentative
break-even near twelve branches, too variable to make it a default speed
lane. Prefer a genuinely quiescent boundary after a more expensive signed
setup or a workflow needing many branches, and remeasure capture, restore,
branch, and full setup on one fixed source. Restore only through fresh canonical
owners when their durable continuation and broker state can be authenticated;
fail closed if that later boundary cannot be recovered.
The named BrokerOwnerShutdownAfterFirstQueue branch reuses the same protected
quiescent profiles. It starts the ordinary signed VM/app/broker owners,
observes the original first envelope in the authenticated broker queue, and
stops that broker before receiver retrieval. The shared app maintenance pass
retains the native broker connection-refusal source through its typed runtime
bridge call. Dropping the accepted app observer then requests its real
cancellation; the host callback remains uncalled. The fixture compares two
restored branches' ordered stage names and typed terminal result, checks
strict shutdown, and reacquires the same profiles under fresh owners. Its
private 0600 receipt records only stage names, typed cause and terminal
categories, the selected clock input, fixture binding, and reopen result:
scripts/dev/run-exact-fixtures.sh --root "$PWD" --lane debug \
--package aura-simulator --test enrollment_lifecycle \
--features simulator-checkpoint --expected-count 1 \
--name protected_original_broker_delivery_fault_retains_cause_and_cancels
This branch proves a local broker-owner failure and app cancellation before
receiver ACK; it does not claim that an independent process or host delivered
the first envelope. The HostPathIsFile branch above remains the genuine
required host-write refusal after exact receiver ACK and same-profile reopen.
For actual FROST one-use custody, the separately scoped threshold-service fixture injects the same retirement effect into original and restored owners and refuses an identical real public commitment in the second owner:
scripts/dev/run-exact-fixtures.sh --root "$PWD" --lane debug \
--package hxrts-aura-agent --lib --features simulator-checkpoint \
--expected-count 1 \
--name runtime::services::threshold_signing::device_quorum::tests::injected_original_service_refuses_reused_actual_frost_nonce_across_branches
There is no simulator nonce-counter selector yet, so there is no duplicate
counter warning or byte-identical crypto replay claim. Reusing an actual
one-time commitment is a hard refusal. The 1-of-1 enrollment fast path uses
normal signing but does not exercise FROST retirement. This checkpoint is only
for quiescent pre-issuance selected filesystem profiles with an empty broker;
each branch creates its broker registration and queue through the normal issue
path. Post-issuance owners, nonempty broker queues, live capabilities, OS
keyrings, browser storage, independent processes, and two-host delivery remain
outside this checkpoint contract. The runtime-selected filesystem provider
does not prove production platform keyring custody.
Before reviewing a deployable change, run
nix develop --command bash scripts/check/simulator-checkpoint-reachability.sh;
it checks the terminal/RPC, app-host, and web release feature graphs for the
absence of simulator checkpoint and test-keyring code.
The local broker has a simulator-checkpoint stop gate. It seals admission, stops and awaits its original task group, and refuses live owners, unsettled delivery, retained credential residue, ACK replay metadata, and test-only one-shot hooks. A versioned registration-only codec can encode this stopped owner's candidates and receiver/return registrations, including their original retention deadlines and selected-time high-water mark. Private decoding rejects duplicates, malformed scope, expiry, backward time, noncanonical bytes and versions. The canonical signed setup fixture confirms its original return registration appears in that codec. Raw bytes confer no restore authority; only the V2 effect-owned artifact below can supply bytes to a fresh broker. The original native broker handle survives signed setup for one-shot stop acknowledgment. The canonical rendezvous manager likewise takes its broker child through its actor and refuses outstanding clones. The fixture authorization token is never a checkpoint encryption key.
The selected filesystem checkpoint also has a simulator-only V2 auxiliary channel. It encrypts one bounded opaque payload with the original profile inventory and authenticates payload kind/version, owner, epoch, fixture configuration, selected physical-clock observation, source revision and profile identity before restoration. The V1 restore path refuses V2 artifacts, and the V2 path refuses V1 or missing payloads. The stopped original broker seals the quiescent registration codec only with an opaque witness minted by the original issuer runtime. It reloads the immutable return registration, revalidates the protected signed manifest, approved baseline and setup proof, and runs the admitted-original return verifier. Exact broker registration bytes must match that verified original. The witness retains the selected filesystem source and signed pending epoch, but cannot authorize a fresh issuer. A one-use simulator owner authenticates the profile and broker bytes through the effect before installing them in an empty, unstarted fresh broker with the same retention policy and a nonbackward selected clock. Genuine signed issuer registration is read back there. Foreign owner or epoch context and stale selected time refuse before profile mutation; the effect owner authenticates changed artifact bytes and source revision. The original profile path is fixed in the sealed handle; a different path is refused. Capture binds the original verified pending epoch; restore remains limited to the same original selected-profile context because a fresh issuer does not yet rederive that approval witness. Cross-profile or fresh-issuer continuation restore remains unsupported. The signed broker handoff fixture also reaches a real receiver envelope through the public app workflow and checks that the stopped original broker refuses queued, retrieval-selected, and retained receiver-ACK history. The served branch injects a simulator-only, one-shot ACK failure for the exact queued message ID after the recipient's genuine retrieval. These are negative checkpoint gates, not a restorable VM continuation or a speedup result. This does not restore an app or VM continuation. An older valid artifact with the same context cannot be detected without a separate monotonic anchor. Do not use fixture bearer tokens as encryption keys or count this as full replay.
Scenario Contract Workflow
Conformance CI includes scenario contracts for consensus, sync, recovery, and reconfiguration. Each bundle is validated over a seed corpus. Validation checks terminal status (AllDone), required labels observed in trace, and minimum observable event count.
Contract results are written as JSON artifacts. CI fails on any violation with structured output.
Shared Replay Workflow
Replay-heavy parity lanes should use shared replay APIs. Use run_replay_shared(...) and run_concurrent_replay_shared(...) for this purpose.
These APIs reduce duplicate replay state across lanes and keep replay artifacts compatible with canonical trace fragments. Conformance lanes also emit deterministic replay metrics artifacts so regressions in replay footprint are visible during CI review.
For fault-aware replays, persist entries + faults bundles and re-inject faults before replay. Use aura_testkit::ReplayTrace::load_file(...) to load traces. Use ReplayTrace::replay_faults(...) and aura_simulator::AsyncSimulatorHostBridge::replay_expected_with_faults(...) to replay with faults.
Differential Replay Workflow
Use aura_simulator::DifferentialTester to compare baseline and candidate conformance artifacts. Two profiles are available. The strict profile requires byte-identical surfaces. The envelope_bounded profile uses Aura law-aware comparison with commutative and algebraic envelopes. In supported Telltale 11-backed report lanes, this is the low-level surface comparator, not the theorem-facing semantic authority: use the parity report's upstream semantic summary and run context.
For Telltale 11-backed parity lanes, prefer
aura_simulator::run_telltale_parity_with_runner(...) or
aura_simulator::run_telltale_control_plane_with_runner(...) over manually
assembling candidate upstream sidecar paths. These helpers invoke the
configured Telltale runner command, attach the generated candidate run-output
sidecar, and then emit the normal Aura parity report. Supported file lanes
still require a baseline upstream run sidecar, and they attach optional
decision/sweep sidecars when available. Override the command with
AURA_TELLTALE_SIMULATOR_RUNNER when needed.
For environment-oriented simulation state, Aura now exposes a bridge layer that
uses Telltale 11-aligned names for migrated slices. Prefer the scenario-run
artifact lane over ad hoc handler inspection: after run_scenario(...),
inspect SimulationResults::environment_artifacts and the persisted
environment_snapshot.json / environment_trace.json files under the
configured simulator artifact root. When richer Aura-only environment detail is
needed, read the optional environment_overlay.json supplement instead of
expanding the core bridge schema.
For comparative experiment work, use
aura_simulator::run_adaptive_privacy_policy_sweep(...) plus
aura_simulator::compare_policy_sweeps(...) instead of ad hoc local sweep
scripts. Those APIs keep Aura-specific bindings on top of the shared Telltale
execution machinery while emitting Aura-owned AuraSweepArchiveV1 and
AuraPolicyDiffReportV1 artifacts.
For reusable regression bundles, use aura_simulator::run_suite_catalog(...)
and aura_simulator::compare_suite_catalogs(...). The suite catalogs are
Aura-owned, but execution still goes through the shared Telltale harness and
the archived comparison surface is AuraSuiteTournamentReportV1.
For theorem-aware failure evidence, convert parity reports with
aura_simulator::counterexample_from_parity_report(...) or
aura_simulator::counterexample_from_control_plane_report(...). These helpers
preserve the shared Telltale counterexample witness and record whether the
observed mismatch is schedule noise only.
For parity debugging, run:
just ci-choreo-parity
aura replay --trace-file artifacts/choreo-parity/native_replay/<scenario>__seed_<seed>.json
The replay command validates required conformance surfaces and verifies stored step/run digests against recomputed values.
Best Practices
Start with simple scenarios and add faults incrementally. Use deterministic seeds. Capture metrics for analysis.
Prefer TOML scenarios for human-readable tests. Prefer Quint actions for specification conformance. Combine both for comprehensive coverage.
Related Documentation
- Simulation Infrastructure Reference - Handler APIs
- Verification and MBT Guide - Quint workflows
- Testing Guide - Conformance testing
Verification and MBT Guide
This guide covers how to use formal verification and model-based testing to validate Aura protocols. It focuses on practical workflows with Quint, Lean, and generative testing.
Quint, simulator, and harness have distinct responsibilities. Quint defines models, traces, and invariants. The aura-simulator crate is a selectable deterministic runtime substrate. The aura-harness crate is the single executor for real TUI and web frontend flows. Shared semantic UI and scenario contracts live in aura-app.
aura-app is also the home of the shared-flow support and parity contract used by the real-runtime harness. This includes SharedFlowId, SHARED_FLOW_SUPPORT, SHARED_FLOW_SCENARIO_COVERAGE, UiSnapshot, semantic parity comparison helpers, and typed runtime event diagnostics.
When to Verify
Verification suits protocols with complex state machines or security-critical properties. Use Quint model checking for exhaustive state exploration. Use Lean proofs for mathematical guarantees. Use generative testing to validate implementations against models.
Unit tests suffice for simple, well-understood behavior. Do not over-invest in verification for straightforward code.
See Formal Verification Reference for the complete architecture documentation.
Quint evaluator advisory exception
Aura uses the upstream Quint v0.33.0 Rust evaluator. Its imbl 5 dependency
resolves to imbl-sized-chunks 0.1.3, affected by
RUSTSEC-2026-0292.
The user-approved, reason-bearing exception in deny.toml accepts this known
panic-safety double-free/use-after-free vulnerability; upgrading Quint does not
fix it. The exception suppresses only this advisory in the required
just ci-security-audit gate; other advisories retain their existing policy.
Remove the exception when upstream uses imbl-sized-chunks >=0.2.0, regenerate
Cargo.nix, and require the advisory gate to pass without this exception.
Validate evaluator upgrades with cargo check -p aura-quint --all-targets and
cargo test -p aura-quint. Retain an immutable resolved git revision; no local
path override or fork is required for this accepted upstream dependency.
Writing Quint Specifications
Getting Started
Create a new specification in verification/quint/.
module protocol_example {
type State = { phase: str, value: int }
var state: State
action init = {
state' = { phase: "setup", value: 0 }
}
action increment(amount: int): bool = all {
amount > 0,
state' = { ...state, value: state.value + amount }
}
val nonNegative = state.value >= 0
}
Run quint typecheck to validate syntax. Run quint run to simulate execution.
Enrollment import custody model
verification/quint/time_system.qnt includes pure enrollment-import transitions for bound admission, exact operation handoff, selected-provider postread and exclusive deadline, observer cancellation, retained first failure, acknowledged host commit and single terminal publication after required domain/resource disposal. The custodian registry acknowledges its own disposal separately after cleanup returns; observing the terminal or result alone does not prove that acknowledgment. Refused or unarmed admission retains the prior owner's publication responsibility. An actual host acknowledgment takes precedence over later observer cancellation; required failure retains its original cause.
Run quint typecheck verification/quint/time_system.qnt and quint test verification/quint/time_system.qnt --main=time_system. These finite regression examples validate the modeled contract, not exhaustive state exploration, runtime execution or liveness. Acknowledgment inputs represent receipts that actual production owners must issue. Pair them with supervised runtime/app cancellation and disposal tests, including cancellation immediately after handoff before the worker first polls, and platform-specific persistence tests where required.
Authority Model
Specifications should use AuthorityId for identity, not DeviceId. Model relational semantics without device-level details.
type AuthorityId = str
type Participant = { authority: AuthorityId, role: Role }
This aligns specifications with Aura's authority-centric design.
State Machine Design
Define clear phases with explicit transitions.
type Phase = Setup | Active | Completed | Failed
action transition(target: Phase): bool = all {
state.phase != Completed,
state.phase != Failed,
validTransition(state.phase, target),
state' = { ...state, phase: target }
}
Disallow transitions from terminal states. Validate transition legality explicitly.
Invariant Design
Define invariants before actions. Clear invariants guide action design.
val safetyInvariant = or {
state.phase != Failed,
hasRecoveryPath(state)
}
val progressInvariant = state.step < MAX_STEPS
Invariants should be checkable at every state. Avoid invariants that require execution history.
Harness Modules
Create harness modules for simulation and trace generation.
module harness_example {
import protocol_example.*
action register(): bool = init
action step(amount: int): bool = increment(amount)
action done(): bool = state.phase == Completed
}
Harnesses provide standardized entry points for tooling. They should emit semantic traces and invariants, not frontend-specific scripts or key sequences.
Model Checking Workflow
Type Checking
quint typecheck verification/quint/protocol_example.qnt
Type checking validates syntax and catches type errors. Run it before any other operation.
Simulation
quint run --main=harness_example verification/quint/protocol_example.qnt
Simulation executes random traces. It finds bugs quickly but does not provide exhaustive coverage.
Invariant Checking
quint run --invariant=safetyInvariant verification/quint/protocol_example.qnt
Invariant checking verifies properties hold across simulated traces.
Model Checking with Apalache
quint verify --max-steps=10 --invariant=safetyInvariant verification/quint/protocol_example.qnt
Apalache performs exhaustive model checking. It proves invariants hold for all reachable states up to the step bound.
Interpreting Violations
Violations produce counterexample traces. The trace shows the state sequence leading to the violated invariant.
[State 0] phase: Setup, value: 0
[State 1] phase: Active, value: 5
[State 2] phase: Active, value: -3 <- VIOLATION: nonNegative
Use counterexamples to identify specification bugs or missing preconditions.
Generative Testing Workflow
Generative testing validates Rust implementations against Quint models.
For AMP channel epoch transitions, the Quint model in
verification/quint/amp/channel.qnt includes transition identity, reducer
states, A2Live, A2Conflict, A3Finalized, A3Conflict, abort,
supersession, and emergency non-retroactivity semantics. The focused Rust
conformance lane is
cargo test -p aura-simulator --test amp_transition_scenarios; it compares
proposal/certificate/finalization/abort/conflict sequences against a small
deterministic oracle and exercises old-epoch acceptance boundaries.
The Trust Chain
Quint Specification
│
▼ generates
ITF Traces
│
▼ replayed through
Rust Effect Handlers
│
▼ produces
Property Verdicts
Each link adds verification value. Specifications validate design. Traces validate reachability. Replay validates implementation.
Generating Semantic Traces
just quint-semantic-trace spec=verification/quint/harness/flows.qnt \
out=verification/quint/traces/harness_flows.itf.json
ITF traces capture semantic state sequences and non-deterministic choices. These traces are model artifacts. Real TUI and web execution belongs to the harness, which consumes the shared semantic scenario contract. Shared web/TUI parity assertions also run against the same UiSnapshot contract rather than renderer text or DOM structure.
Do not add direct Quint-to-TUI or Quint-to-browser execution paths. Quint should hand off semantic traces to the shared contract layer, then let the harness or simulator consume them through their own adapters.
For shared end-to-end flows, the harness contract is semantic and state-based. Do not introduce frontend-specific Quint replay formats that encode raw keypress sequences, browser selectors, or label-based button targeting. Those belong in driver adapters and diagnostics, not in the semantic trace contract.
Direct Conformance Testing
The recommended approach compares Rust behavior to Quint expected states.
#![allow(unused)] fn main() { use aura_simulator::quint::itf_loader::ITFLoader; #[test] fn test_matches_quint() { let trace = ITFLoader::load("trace.itf.json").unwrap(); for states in trace.states.windows(2) { let pre = State::from_quint(&states[0]).unwrap(); let action = states[1].meta.action.as_deref().unwrap(); let actual = apply_action(&pre, action).unwrap(); let expected = State::from_quint(&states[1]).unwrap(); assert_eq!(actual, expected); } } }
This tests production code directly. Quint serves as the single source of truth.
Generative Exploration
For state space exploration with Rust-driven non-determinism, use the action registry.
#![allow(unused)] fn main() { use aura_simulator::quint::action_registry::ActionRegistry; let mut registry = ActionRegistry::new(); registry.register("increment", Box::new(IncrementHandler)); let result = registry.execute("increment", ¶ms, &effects).await?; }
This approach requires handlers that re-implement Quint logic. Prefer direct conformance testing for new protocols.
ITF Trace Handling
Loading Traces
#![allow(unused)] fn main() { use aura_simulator::quint::itf_loader::ITFLoader; let trace = ITFLoader::load("trace.itf.json")?; for state in &trace.states { let index = state.meta.index; let action = state.meta.action.as_deref(); let picks = &state.meta.nondet_picks; } }
The loader parses ITF JSON into typed Rust structures.
Non-Deterministic Choices
ITF traces capture non-deterministic choices for reproducible replay.
{
"#meta": { "index": 3, "nondet_picks": { "leader": "alice" } }
}
The simulator injects these choices into RandomEffects to ensure deterministic replay.
State Mapping
Types implementing QuintMappable convert between Quint and Rust representations.
#![allow(unused)] fn main() { use aura_core::effects::quint::QuintMappable; let rust_state = State::from_quint(&quint_value)?; let quint_value = rust_state.to_quint(); }
Bidirectional mapping enables state comparison during replay.
Feeding Conformance Corpus
MBT traces should feed conformance testing.
Deriving Seeds
AURA_CONFORMANCE_ITF_TRACE=trace.itf.json cargo test conformance
ITF traces become inputs for native/WASM conformance lanes.
Coupling Model to Corpus
When Quint models change, regenerate traces and update the conformance corpus. This couples model evolution to test coverage.
quint run --out-itf=artifacts/traces/new_trace.itf.json verification/quint/updated_spec.qnt
just ci-conformance
See Testing Guide for corpus policy details.
The main repository policy gate for shared-flow drift is:
just ci-shared-flow-policy
This complements Quint and simulator checks by enforcing that shared real-runtime scenarios still use the semantic contract and that the shared-flow support map in aura-app remains consistent with the harness/frontend surfaces.
Telltale Verification Workflow in Aura
Use this workflow for choreography and simulator-level verification that depends on Telltale-derived checks.
1) Choreography compatibility gate (CI/tooling)
Run:
nix develop --command scripts/check/protocol-compat.sh --self-test
nix develop --command just ci-protocol-compat
This validates that known-compatible fixture pairs pass async subtyping checks. It confirms known-breaking fixture pairs fail as expected. It ensures changed .tell files stay backward-compatible unless intentionally breaking.
Fixtures live in crates/aura-testkit/fixtures/protocol_compat/.
2) Macro-time coherence gate
Run:
nix develop --command cargo test -p aura-macros
This enforces compile-time coherence validation for choreographies, including negative compile-fail coverage.
3) Simulator invariant monitoring under injected faults
Run:
nix develop --command cargo test -p aura-simulator --test fault_invariant_monitor
This verifies that injected faults produce monitor-visible invariant violations (for example, NoFaults violations), and that a gate configured to require zero violations fails accordingly.
4) telltale-bridge integration status
As of April 1, 2026, Aura includes telltale-bridge as a workspace dependency and integrates it through aura-quint on the Telltale 10.0.0 public bridge/runtime model.
This adds direct access to upstream Lean runner and equivalence utilities from the Telltale project. It provides explicit schema and version linkage with upstream bridge contracts for cross-tool consistency. It also keeps Aura verification aligned with the same public capability/finalization/runtime-upgrade model used by production runtime code rather than a private compatibility layer. Read upstream docs/38_capability_model.md before debugging capability-driven admission, authoritative-read/finalization behavior, or runtime-upgrade proofs.
Call aura_quint::upstream_telltale_bridge_schema_version() to get the upstream bridge schema version. CI lanes are just ci-telltale-bridge and just ci-simulator-telltale-parity.
5) aura-testkit Lean verification API migration (March 5, 2026)
The canonical Lean API types are specified in Formal Verification Reference.
Import Lean verification payload types from aura_testkit::verification which re-exports from lean_types. Construct structured journals with LeanJournal and LeanNamespace. Update tests to compare LeanTimestampOrdering values directly.
Telltale Bridge Cross-Validation
The bridge connects Quint model checking with Telltale and Lean proof artifacts. It enables exporting Quint session models to a stable interchange format, importing Telltale and Lean properties back into Quint harnesses, and running cross-validation to detect divergence early in CI.
Operator Workflow
Run the bridge lane:
just ci-telltale-bridge
Inspect outputs at artifacts/telltale-bridge/bridge.log, artifacts/telltale-bridge/bridge_discrepancy_report.json, and artifacts/telltale-bridge/report.json.
Run the simulator telltale parity lane:
just ci-simulator-telltale-parity
Inspect output at artifacts/telltale-parity/report.json.
Data Contract
The bridge data contract is specified in Formal Verification Reference.
Export Workflow
Export moves session models from Quint to Telltale format.
- Parse Quint JSON IR with
parse_quint_modules(...) - Build the bridge bundle with
export_quint_to_telltale_bundle(...) - Validate structural correctness with
validate_export_bundle(...)
Import Workflow
Import brings Telltale and Lean properties back into Quint harnesses.
- Select importable properties with
parse_telltale_properties(...) - Generate Quint invariant module text with
generate_quint_invariant_module(...) - Map certificates into Quint assertion comments with
map_certificates_to_quint_assertions(...)
Cross-Validation Workflow
Cross-validation detects proof and model divergence. Use run_cross_validation(...) from aura-quint to execute Quint checks through a QuintModelCheckExecutor, compare outcomes to bridge proof certificates, and emit a CrossValidationReport with explicit discrepancy entries.
Run cross-validation in CI:
just ci-telltale-bridge
This command produces artifacts under artifacts/telltale-bridge/ including bridge.log and report.json.
Handling Discrepancies
When cross-validation reports discrepancies, follow these steps. First confirm the property identity mapping (property_id) between model and proof pipelines. Then re-run the failing property in Quint and capture the trace or counterexample. Next re-check proof certificate assumptions against the current protocol model. Do not merge until the mismatch is resolved or explicitly justified.
For telltale parity mismatches, read comparison_classification, first_mismatch_surface, and first_mismatch_step_index first. Re-run the failing lane with the same scenario and seed. Confirm that required surfaces (observable, scheduler_step, effect) were captured before examining envelope differences.
Lean Proof Development
Adding Theorems
Create or extend modules in verification/lean/Aura/Proofs/.
theorem new_property : ∀ s : State, isValid s → preservesInvariant s := by
intro s h
simp [isValid, preservesInvariant] at *
exact h
Use Lean 4 tactic mode for proofs.
Using Claims Bundles
Access related theorems through claims bundles.
import Aura.Proofs.Consensus
#check Aura.Consensus.Validity.validityClaims.commit_has_threshold
Bundles organize proofs by domain.
Working with Axioms
Cryptographic assumptions appear in Assumptions.lean.
axiom frost_threshold_unforgeability : ...
Proofs depending on axioms are sound under standard hardness assumptions. Document axiom dependencies clearly.
Building Proofs
cd verification/lean
lake build
The build succeeds only if all proofs complete without sorry.
Checking Status
just lean-status
This reports per-module proof status including incomplete proofs.
Running Verification
Quint Commands
quint typecheck spec.qnt # Type check
quint run --main=harness spec.qnt # Simulate
quint run --invariant=inv spec.qnt # Check invariant
quint verify --max-steps=10 spec.qnt # Model check
Lean Commands
just verify-lean # Build proofs
just lean-status # Check status
just test-differential # Rust vs Lean tests
Full Verification
just verify-all
This runs Quint model checking, Lean proof building, and conformance tests.
Best Practices
Start with invariants. Define properties before implementing actions. Clear invariants guide design.
Use unique variant names. Quint requires globally unique sum type variants. Prefix with domain names.
Test harnesses separately. Verify harness modules parse before integrating with the simulator.
Start with short traces. Debug action mappings with 3-5 step traces before exhaustive exploration.
Isolate properties. Test one property at a time during development. Combine for coverage testing.
Adding or Updating Invariants
When adding or modifying invariants, follow this workflow to maintain traceability across docs, tests, and proofs.
- Add or update the invariant under
## Invariantsin the crate'sARCHITECTURE.md. - Add a detailed specification section in the same file with invariant name, enforcement locus, failure mode, and verification hooks.
- Use canonical
InvariantXxxnaming for traceability across docs, tests, and proofs. - Add or update tests and simulator scenarios that detect violations.
- Update the traceability matrix in Project Structure if the invariant is cross-crate or contract-level.
Formal and model checks should reference the same canonical names listed in the traceability matrix.
Quint-Lean Correspondence
The Quint-Lean correspondence mapping is maintained in Formal Verification Reference.
Related Documentation
See Formal Verification Reference for architecture details. See Simulation Guide for trace replay. See Testing Guide for conformance testing. See Project Structure for the invariant index and traceability matrix.
Consensus Kani verification
Run nix develop --command just ci-kani from the checkout. The tracked
_run-kani entry bootstraps Kani into the checkout-local tool root and supplies
its bundled verifier toolchain; the development shell itself remains the
required default pinned shell. For a focused property use:
nix develop --command just _run-kani cargo kani \
--package hxrts-aura-consensus --harness threshold_met_matches_reference \
--output-format terse
The fourteen original properties run the same allocation-free decision kernel as production. Fixed storage bounds remain 2–4 witnesses, at most three existing proposals plus one incoming proposal, and three equality-distinct results. Share payloads are opaque to admission/counting. The additional actual-wrapper refinement executes the production storage and signature path and checks original payload preservation, append order, phase/timer changes and commit identity/prestate binding. It is required alongside all fourteen properties; passing a detached model or only a filtered proof does not complete this lane.
Production selects a maximal-count qualifying result and retains first proposal occurrence for ties. The threshold-checking contract permits a qualifying winner and does not specify map iteration order. Independent reference counting therefore requires the exact unique maximum, and qualification plus maximal count for ties; wrapper/kernel refinement always requires the exact result.
When changing this seam, retain actual Kani harness discovery and completed
results, then measure the entire just ci-kani invocation (target under ten
minutes). Demonstrate sensitivity by temporarily changing the shared threshold
comparison from >= to > and by admitting shares in a terminal phase: the
reference/agreement and terminal-state properties respectively must fail.
Restore the production code and rerun the complete lane. A passing bounded
kernel cannot excuse an unexecuted or intractable production-wrapper refinement.
The canonical ci-kani entry owns build-budget admission (including tool setup
and actual Cargo/Kani), pins four Cargo jobs and runs all discovered proofs.
workflow.sh kani delegates to it; its four isolated status/log fixtures run via
bash scripts/verify/test-workflow-kani.sh. Those mocks verify forwarding only,
never proof discovery or verification. Linux CI remains the supported actual
Kani execution environment; macOS refusal/tool failure is not proof success.
| Evidence | Required execution |
|---|---|
| Independent native decision/storage equivalence | cargo test -p hxrts-aura-consensus --lib exhaustive_native_storage_refines_independent_decisions under the normal build budget |
| Real allocation-backed wrapper, including bounded independent identity/prestate fields | Full 120-member production_wrappers_refine_bounded_decisions_p*_t*_b* family, retain each result and elapsed time |
| Fourteen original properties plus real wrapper | Complete canonical just ci-kani, retain all 134 results and whole-gate elapsed time under ten minutes |
| Required-property mutation sensitivity | On a clean committed Linux candidate, AURA_KANI_SENSITIVITY_ARTIFACTS=/absolute/artifacts bash scripts/verify/test-kani-sensitivity.sh |
The native fixture independently counts three results over every bounded unique witness proposal assignment, admissible equivocator set, threshold and phase, including valid stored commits, and checks actual wrapper guards/payloads. It also varies independent identity/prestate bindings. The wrapper Kani family covers all eight independent tuples of two representatives for consensus identity, operation and prestate; this is bounded binding-discriminator coverage, not a claim of universal 256-bit cryptographic injectivity. Signature production remains the actual production implementation.
The mutation script verifies a stricter threshold and terminal-share admission against the actual named Kani properties in disposable committed source copies. A nonzero tool exit alone does not pass: each artifact must contain verifier failure and the required assertion. Review the actual counterexample; compilation, installer, missing tool, timeout and unwind errors cannot replace it. Re-run the unchanged full canonical gate after sensitivity evidence. No timeout is widened.
Complete allocation-backed consensus refinement inventory
just ci-kani discovers and executes the exact tracked
scripts/verify/kani-consensus-inventory.txt: fourteen existing kernel proofs and
120 partitions covering the complete production-wrapper refinement obligation. Names encode phase p0–p4
(Pending/FastPathActive/FallbackActive/Committed/Failed), transition t0–t2
(apply/fallback/fail), and independent binding bits b0–b7. The binding domain is
exactly cid21/22, operation31/32 and prestate41/42. All other original symbolic
domains remain universal in each partition. Unsupported/terminal branches retain
actual wrapper rejection checks; committed prestates retain actual commit payloads
and the original threshold-qualified result requirement. No crypto producer is
stubbed. Exact signature format checks use independent concatenation and canonical
BLAKE3, not an assumption about hash uniqueness.
For the supported Linux commit-producing pilot, use the existing pinned installer and budget custody:
nix develop --command bash scripts/dev/build-budget.sh --lane kani-wrapper-pilot -- \
just _run-kani cargo kani --package hxrts-aura-consensus \
--harness production_wrappers_refine_bounded_decisions_p1_t0_b0 \
--output-format regular
That partition retains commit and noncommit outcomes; it does not constrain the
state to a successful commit. Retain compiler/solver status and timing. A pilot,
native tests, or fourteen kernel successes cannot close the complete gate.
Canonical CI still requires full proofs, both actual threshold/terminal mutation
counterexamples, and the unchanged full just ci-kani rerun. The runner refuses
zero/partial discovery and execution, preserving logs even on proof failure.
No Linux timing success is claimed by this source decomposition.
Discovery uses the actual installed CI Kani 0.68.0 cargo kani list --format json
contract: kani-list.json, schema 0.1, standard-harnesses file-to-name arrays.
The exact version/schema and complete nonzero inventory are required, retained
in gate artifacts, and unknown versions fail closed for deliberate review.
The canonical installer pins 0.68.0, verifies cached binaries and force-reinstalls
a different release; an unverifiable cache or wrong installed version refuses.
Upgrading the pin requires auditing this discovery contract. Existing
cwd discovery output is refused to prevent stale data from certifying a run.
Execution parsing accepts Kani 0.68.0's exact Checking harness line, including
its optional numeric Thread prefix; proof exit success and complete executed
inventory are both required.
CI retains initial full-gate discovery/results under artifacts/kani/initial
and the post-mutation unchanged rerun under artifacts/kani/unchanged. The
existing always-upload step retains both complete trees and
artifacts/kani-sensitivity; the rerun cannot overwrite initial proof evidence.
The canonical ci-kani recipe first runs isolated inventory, installer, and workflow-dispatch regressions. Their success does not replace the subsequent complete production proof run; any fixture failure stops the recipe. Fixture artifacts use their own temporary directory even when CI supplies AURA_KANI_ARTIFACTS.
System Internals Guide
This guide covers deep system patterns for contributors working on Aura core. Use it when you need to understand guard chain internals, service layer patterns, core types, and reactive scheduling.
1. Guard Chain Internals
The guard chain coordinates authorization, flow budgets, and journal effects in strict sequence. See Authorization for the full specification.
Three-Phase Pattern
Guards are pure: evaluation runs synchronously over a prepared GuardSnapshot and yields EffectCommand items that an async interpreter executes.
#![allow(unused)] fn main() { // Phase 1: Authorization via Biscuit + policy (async, cached) let token = effects.verify_biscuit(&request.token).await?; let capabilities = evaluate_candidate_frontier( &token, evaluation_candidates_for_chat_guard(), &policy, )?; // Phase 2: Prepare snapshot and evaluate guards (sync) let snapshot = GuardSnapshot { capabilities, flow_budget: current_budget, leakage_budget: current_leakage, ..Default::default() }; let commands = guard_chain.evaluate(&snapshot, &request)?; // Phase 3: Execute commands (async) for command in commands { match command { EffectCommand::ChargeBudget { cost } => { budget_handler.charge(cost).await?; } EffectCommand::RecordLeakage { budget } => { leakage_handler.record(budget).await?; } EffectCommand::CommitJournal { facts } => { journal_handler.commit(facts).await?; } EffectCommand::SendTransport { message } => { transport_handler.send(message).await?; } } } }
No transport observable occurs until the interpreter executes commands in order.
Guard Chain Sequence
The guards execute in this order:
CapabilityGuardvalidates the evaluated Biscuit and policy frontier.FlowBudgetGuardchecks and charges flow budget.LeakageTrackerrecords privacy leakage.JournalCouplercommits facts to journal.TransportEffectssends messages.
Security Patterns
Privacy budget enforcement supports three modes.
#![allow(unused)] fn main() { // Secure default: denies undefined budgets let tracker = LeakageTracker::new(); // Backward compatibility: allows undefined budgets let tracker = LeakageTracker::legacy_permissive(); // Configurable default let tracker = LeakageTracker::with_undefined_policy(DefaultBudget(1000)); }
2. Service Layer Patterns
Domain crates define stateless handlers that take effect references per-call. The agent layer wraps these with services that manage RwLock access.
Domain Handler (Layer 2-5)
#![allow(unused)] fn main() { // In domain crate (e.g., aura-chat/src/service.rs) pub struct ChatFactService; impl ChatFactService { pub fn new() -> Self { Self } pub async fn send_message<E>( &self, effects: &E, channel_id: ChannelId, content: String, ) -> Result<MessageId> where E: StorageEffects + RandomEffects + PhysicalTimeEffects { let message_id = effects.random_uuid().await; let timestamp = effects.physical_time().await?; // ... domain logic using effects Ok(message_id) } } }
Agent Service Wrapper (Layer 6)
#![allow(unused)] fn main() { // In aura-agent/src/handlers/chat_service.rs pub struct ChatService { handler: ChatFactService, effects: Arc<RwLock<AuraEffectSystem>>, } impl ChatService { pub fn new(effects: Arc<RwLock<AuraEffectSystem>>) -> Self { Self { handler: ChatFactService::new(), effects } } pub async fn send_message( &self, channel_id: ChannelId, content: String, ) -> AgentResult<MessageId> { let effects = self.effects.read().await; self.handler.send_message(&*effects, channel_id, content) .await .map_err(Into::into) } } }
Agent API Exposure
#![allow(unused)] fn main() { // In aura-agent/src/core/api.rs impl AuraAgent { pub fn chat_service(&self) -> ChatService { ChatService::new(self.runtime.effects()) } } }
This pattern keeps the domain crate pure without Tokio-specific locking or runtime coupling. Domain logic is testable with mock effects. The pattern is consistent across crates.
Core + Orchestrator Rule
The Core + Orchestrator Rule is defined in System Architecture. Layer 4 crates split logic into pure core modules and effectful orchestrator modules.
3. Type Reference
ProtocolType
Canonical definition in aura-core. All crates re-export this definition.
#![allow(unused)] fn main() { pub enum ProtocolType { Dkd, // Deterministic Key Derivation Counter, // Counter reservation protocol Resharing, // Key resharing for threshold updates Locking, // Resource locking protocol Recovery, // Account recovery protocol Compaction, // Ledger compaction protocol } }
SessionStatus
Lifecycle order:
Initializing- Session initializingActive- Session executingWaiting- Waiting for participant responsesCompleted- Completed successfullyFailed- Failed with errorExpired- Expired due to timeoutTimedOut- Timed out during executionCancelled- Was cancelled
TimeStamp Domains
The time domain system is specified in Effect System. See that document for domain definitions, effect trait mappings, and usage constraints.
Capability System Layering
The capability system uses multiple layers:
- Canonical types in
aura-coreprovide validatedCapabilityName. - Owning families in feature and domain crates provide typed first-party capability declarations.
- The authorization layer in
aura-authorizationhandles explicit issuance profiles and Biscuit and policy evaluation. - Guard snapshots in
aura-guardsplus runtime handlers carry evaluated frontiers only. - The storage layer in
aura-storeprovides capability-based access control.
Clear conversion paths enable inter-layer communication.
4. Reactive Scheduling
The ReactiveScheduler in aura-agent/src/reactive/ processes journal facts and emits application signals.
Signal System Overview
#![allow(unused)] fn main() { // Application signals pub const CHAT_SIGNAL: &str = "chat"; pub const CONTACTS_SIGNAL: &str = "contacts"; pub const CHANNELS_SIGNAL: &str = "channels"; pub const RECOVERY_SIGNAL: &str = "recovery"; }
The scheduler:
- Subscribes to journal fact streams
- Reduces facts to view state
- Emits signals when state changes
- TUI/CLI components subscribe to signals
TUI Reactive State
The TUI uses futures-signals for fine-grained reactive state management.
The reactive architecture pattern below represents the target design for TUI state management. Implementation status varies by view.
Signal Types
#![allow(unused)] fn main() { use futures_signals::signal::Mutable; use futures_signals::signal_vec::MutableVec; // Single reactive value let count = Mutable::new(0); count.set(5); let value = count.get_cloned(); // Reactive collection let items = MutableVec::new(); items.lock_mut().push_cloned("item1"); }
View Pattern
#![allow(unused)] fn main() { pub struct ChatView { channels: MutableVec<Channel>, messages: MutableVec<Message>, selected_channel: Mutable<Option<String>>, } impl ChatView { // Synchronous delta application pub fn apply_delta(&self, delta: ChatDelta) { match delta { ChatDelta::ChannelAdded { channel } => { self.channels.lock_mut().push_cloned(channel); // Signals automatically notify subscribers } ChatDelta::MessageReceived { channel_id, message } => { if self.selected_channel.get_cloned() == Some(channel_id) { self.messages.lock_mut().push_cloned(message); } } } } } }
Best Practices
- Delta application should be synchronous (not async)
- Use
.get_cloned()for reading,.set()for mutations - Never hold lock guards across await points
- Use derived signals for computed values
5. Policy Compliance
Application code must follow policies defined in Project Structure.
Impure Function Usage
All time, randomness, filesystem, and network operations must flow through effect traits.
Direct system calls are forbidden because they break simulation and WASM compatibility.
#![allow(unused)] fn main() { // Forbidden: direct system calls let now = SystemTime::now(); let random = thread_rng().gen(); let file = File::open("path")?; }
Use effect traits instead.
#![allow(unused)] fn main() { // Use effect traits let now = effects.physical_time().await?; let random = effects.random_bytes(32).await?; let data = effects.read_storage("key").await?; }
Serialization
- Wire protocols and facts: DAG-CBOR via
aura_core::util::serialization - User-facing configs: JSON allowed
- Debug output: JSON allowed
Architectural Validation
Run just check-arch before submitting changes. The checker validates:
- Layer boundaries
- Effect trait placement
- Impure function routing
- Guard chain integrity
6. Architecture Compliance Checklist
- Layer dependencies flow downward only
-
Effect traits defined in
aura-coreonly -
Infrastructure effects implemented in
aura-effects - Application effects in domain crates
- No direct impure function usage outside effect implementations
-
All async functions propagate
EffectContext -
Production handlers are stateless, test handlers in
aura-testkit - Guard chain sequence respected
Workflow Error Types
Workflow operations in aura-app use WorkflowError (aura-app::workflows::error) for typed error propagation. The enum provides structured variants for common failure modes:
RuntimeUnavailable: runtime bridge not initializedRuntimeCall { operation, source }: a named runtime bridge call failedConnectivityRequired: peer connectivity prerequisite not metJournal { operation, source }: journal load/merge/persist failureFactEncoding { source }: fact serialization failureCeremony { operation, source }: ceremony lifecycle failureDeliveryFailed { peer, attempts, detail }: transport delivery exhausted retriesPrecondition: static invariant violation
From<WorkflowError> for AuraError enables workflows to keep Result<T, AuraError> signatures while constructing typed errors internally.
7. Instrumentation Contract
The instrumentation contract is specified in Runtime. All long-lived services must emit the required event families defined there.
Related Documentation
- Effect System - Effect specification
- Runtime - Runtime specification
- Authorization - Guard chain specification
- System Architecture - Layer boundaries
- CLI and TUI - Terminal specification
Legacy physical bootstrap migration validation
Run the agent proved_legacy_bootstrap_tests filter after changing bootstrap
representation recovery. The fixture uses actual cryptographic key generation,
Guardian envelope/AAD encoding, retained signed physical creation, and service
restart. Use selected backing-loss helpers for immutable-record negatives;
generic protected overwrite/delete must remain rejected. Verify missing
original decision and missing durable creation index both prevent signing or
migration publication. Multi-device, other-epoch, and original unissued
enrollment continuation require their separate owner paths.
Required publication processing
Use the runtime's required canonical commit owner to retain its exact original scheduler target. Await that target under the existing operation or startup owner. Diagnostic Batch subscriptions are suitable for observation and instrumentation; they do not identify which canonical publication completed. Preserve the original owner through helper calls and retries. Startup context carries the original shared window into replay before a service publishes Running. Chat's local public operation resource policy is 30 seconds; startup uses a separate 30-second resource policy. Signed protocol intervals and retained continuation deadlines remain separately enforced and are attenuated rather than renewed.
Run just ci-vm-session-lifecycle after modifying runtime processing custody. The native inventory validates source declarations, discovers exact test harness names and requires actual execution of closed/foreign ingress, lag/coalescing, cancelled backpressure, original deadline and scheduler clock faults, coupled Chat mutation and retained startup replay. Failed startup cleanup has its own effect-backed five-second local cleanup policy; this cannot extend protocol eligibility or turn cleanup completion into full runtime drainage. Keep any inherited construction owner through startup rather than replacing its original deadline.
Distributed Maintenance Guide
This guide covers practical workflows for the Maintenance and OTA (Over-the-Air) update system in Aura. Use it for snapshots, cache invalidation, and distributed upgrades.
For the maintenance architecture specification, see Distributed Maintenance Architecture.
Maintenance Philosophy
Maintenance architectural principles are defined in Distributed Maintenance Architecture.
The system supports snapshots for garbage collection, cache management, and both soft and hard fork upgrades.
Maintenance Events
The maintenance service publishes events to the journal as facts. These events are replicated across all replicas and interpreted deterministically.
Event Types
Maintenance event types are defined in Distributed Maintenance Architecture.
Snapshot Protocol
The snapshot protocol coordinates garbage collection with threshold approval. It implements writer fencing to ensure consistent snapshot capture across all devices.
Snapshot Workflow
The snapshot process follows five steps:
- Propose snapshot at target epoch with state digest
- Activate writer fence to block concurrent writes
- Capture state and verify digest
- Collect M-of-N threshold approvals
- Commit snapshot and clean obsolete facts
Basic Snapshot Operation
#![allow(unused)] fn main() { use aura_sync::services::{MaintenanceService, MaintenanceServiceConfig}; use aura_core::{Epoch, Hash32}; async fn propose_snapshot( service: &MaintenanceService, authority_id: aura_core::AuthorityId, target_epoch: Epoch, state_digest: Hash32, ) -> Result<(), Box<dyn std::error::Error>> { // Propose snapshot at target epoch service .propose_snapshot(authority_id, target_epoch, state_digest) .await?; // Writer fence is now active - all concurrent writes blocked // Collect approvals from M-of-N authorities // Once threshold reached, commit service.commit_snapshot().await?; Ok(()) } }
Snapshots provide deterministic checkpoints of authority state at specific epochs. This enables garbage collection of obsolete facts while maintaining verifiable state recovery.
Snapshot Proposal
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; use aura_core::{AuthorityId, Epoch, Hash32}; async fn snapshot_workflow( service: &MaintenanceService, authority_id: AuthorityId, ) -> Result<(), Box<dyn std::error::Error>> { // Determine target epoch and compute state digest let target_epoch = 100; let current_state = service.get_current_state().await?; let state_digest = current_state.compute_digest(); // Propose snapshot service .propose_snapshot(authority_id, Epoch::new(target_epoch), state_digest) .await?; // Wait for other authorities to activate fence // and collect approvals Ok(()) } }
Proposals include the proposer authority identifier, unique proposal ID, target epoch, and canonical state digest. All participants must agree on the digest before committing.
Writer Fence
The writer fence blocks all writes during snapshot capture. This prevents concurrent modifications that could invalidate the snapshot digest.
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; async fn capture_with_fence( service: &MaintenanceService, ) -> Result<(), Box<dyn std::error::Error>> { // Writer fence is automatically activated by snapshot proposal // All write operations will be blocked or queued // Capture state atomically let snapshot = service.capture_snapshot().await?; // Once snapshot is committed, fence is released service.commit_snapshot().await?; Ok(()) } }
Fence enforcement is implicit in snapshot proposal. The protocol guarantees no conflicting writes occur during snapshot capture.
Approval Collection
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; async fn collect_approvals( service: &MaintenanceService, threshold: usize, ) -> Result<(), Box<dyn std::error::Error>> { // Get pending snapshot proposals let proposals = service.pending_snapshots().await?; for proposal in proposals { // Verify state digest let current_state = service.get_current_state().await?; let digest = current_state.compute_digest(); if digest == proposal.state_digest { // Approve the snapshot service.approve_snapshot(&proposal.proposal_id).await?; } } Ok(()) } }
Each device verifies the state digest independently and approves if correct. The system collects approvals until threshold is reached.
Snapshot Commitment
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; async fn finalize_snapshot( service: &MaintenanceService, ) -> Result<(), Box<dyn std::error::Error>> { // Commit snapshot once threshold reached service.commit_snapshot().await?; // This records SnapshotCompleted fact to journal // All devices deterministically reduce this fact // Obsolete facts before this epoch can be garbage collected Ok(()) } }
Commitment publishes SnapshotCompleted fact to the journal. All devices deterministically reduce this fact to the same relational state. Facts older than the snapshot epoch can then be safely discarded.
OTA (Over-the-Air) Upgrade Protocol
Aura OTA is split into two layers:
- release distribution: manifests, artifacts, and build certificates spread through Aura storage and anti-entropy
- scoped activation: each device, authority, context, or managed quorum decides when a staged release may activate
There is no network-wide authoritative cutover phase for the whole Aura network. Hard cutover is valid only inside a scope that actually has agreement or a legitimate fence.
Upgrade Types
The upgrade classification (soft fork vs hard fork) is defined in Distributed Maintenance Architecture.
Releases from the CLI
aura ota drives release distribution and staging for the account (also as ota_* methods over aura rpc). Each command commits maintenance facts through aura_app::ui::workflows::ota, and list and status read the state reduced from those facts (aura_maintenance::OtaView).
aura ota publish --manifest FILE [--artifact FILE]...verifies a signed release manifest (provenance-derived release id and signature) and each artifact's hash and size, stores the bundle, and commits its distribution facts.aura ota listshows declared releases with their artifact and certificate counts and whether they are recommended to this account.aura ota recommend RELEASErecommends a declared release to this account.aura ota stage RELEASE [--from RELEASE]stages a declared release for this account.--fromnames the running release when no completed cutover records it.aura ota statusshows this account's staged, approved, completed or rolled-back upgrades.
Cutover and rollback execution stay with the updater/launcher control plane and the runtime's activation ceremony.
Basic Upgrade Operation
#![allow(unused)] fn main() { use aura_maintenance::AuraReleaseActivationPolicy; use aura_sync::services::{ActivationCandidate, OtaPolicyEvaluator}; async fn evaluate_activation( policy: &AuraReleaseActivationPolicy, candidate: &ActivationCandidate<'_>, ) { // Activation is local or scope-bound. // Discovery and sharing do not imply activation. // The evaluator checks trust, compatibility, staged artifacts, // health gates, threshold approval, and scope-owned fences. let _decision = OtaPolicyEvaluator::new().evaluate_activation(policy, candidate); } }
If policy enables it, suggested_activation_time_unix_ms acts only as a local "not before" hint against the local clock. It is advisory metadata, not a global synchronization fence.
Soft Fork Workflow
#![allow(unused)] fn main() { use aura_maintenance::AuraCompatibilityClass; use aura_sync::services::{cutover_session_plan, InFlightIncompatibilityAction}; fn soft_fork_workflow() { let plan = cutover_session_plan( AuraCompatibilityClass::BackwardCompatible, InFlightIncompatibilityAction::Drain, false, ); assert!(!plan.partition_required); } }
Soft forks do not require a globally shared instant. Each scope moves from legacy-only residency to coexistence and then to target-only residency based on its own evidence and policy.
Hard Fork Workflow
#![allow(unused)] fn main() { use aura_maintenance::AuraCompatibilityClass; use aura_sync::services::{cutover_session_plan, InFlightIncompatibilityAction}; fn execute_managed_quorum_cutover() { let plan = cutover_session_plan( AuraCompatibilityClass::ScopedHardFork, InFlightIncompatibilityAction::Delegate, true, ); assert!(plan.partition_required || plan.in_flight == InFlightIncompatibilityAction::Delegate); } }
For hard forks, the operator must define:
- the activation scope
- the compatibility class
- how incompatible in-flight sessions are handled: drain, abort, or delegate
- whether threshold approval or an epoch fence is actually available in that scope
If post-cutover checks fail, rollback is explicit and deterministic.
Managed Quorum Approval Runbook
Use managed quorum cutover only when the scope has an explicit participant set. Record approval from every participant in the quorum before starting cutover. Reject approval from authorities that are not members of that scope.
If one participant has not approved, keep the scope waiting for cutover evidence. Do not begin launcher activation for that scope. Resolve membership or policy disagreement before retrying.
Failed Rollout Runbook
Check the failure classification before acting. AuraUpgradeFailureClass::HealthGateFailed means the new release started and failed local verification. AuraUpgradeFailureClass::LauncherActivationFailed means the launcher handoff failed before healthy activation.
If policy uses AuraRollbackPreference::Automatic, allow the queued rollback to execute and confirm the scope returns to legacy-only residency with an idle transition state. If policy uses AuraRollbackPreference::ManualApproval, keep the scope failed and require operator approval before rollback.
Revoked Release Runbook
Treat a revoked staged release differently from a revoked active release. If the target release is only staged, cancel the staged scope and remove it from activation consideration. Do not proceed to cutover for that scope.
If the revoked release is already active, follow the configured rollback preference. Automatic rollback should queue a rollback to the prior staged release. Manual rollback should leave the scope failed until an operator approves the revert path.
Partition Response Runbook
If SessionCompatibilityPlan.partition_required is true, assume incompatible peers may separate cleanly rather than interoperate. Stop admitting incompatible new sessions in that scope. Drain, abort, or delegate in-flight sessions according to the recorded incompatibility action.
Record partition observations with the associated failure classification and scope. This keeps rollback and peer-partition handling auditable.
Cache Management
The maintenance system coordinates cache invalidation across all devices. Cache invalidation facts specify which keys must be refreshed and the epoch where the cache entry is no longer valid.
Cache Invalidation
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; use aura_core::Epoch; async fn invalidate_cache( service: &MaintenanceService, keys: Vec<String>, epoch_floor: Epoch, ) -> Result<(), Box<dyn std::error::Error>> { // Publish cache invalidation fact service.invalidate_cache_keys(keys, epoch_floor).await?; // All devices receive fact through journal // Each device deterministically invalidates matching keys Ok(()) } }
Cache invalidation facts are replicated through the journal. All devices apply the invalidation deterministically based on epoch and key matching.
Cache Query Patterns
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; use aura_core::Epoch; async fn query_cache( service: &MaintenanceService, key: &str, epoch: Epoch, ) -> Result<Option<Vec<u8>>, Box<dyn std::error::Error>> { // Check if cache entry is valid at epoch if service.is_cache_valid(key, epoch).await? { service.get_cached(key).await } else { // Cache invalidated - fetch fresh let value = service.fetch_fresh(key).await?; service.cache_set(key, value.clone(), epoch).await?; Ok(Some(value)) } } }
Cache validity is epoch-based. Entries are valid up to their invalidation epoch. After that, fresh data must be fetched and cached at the new epoch.
Configuration and Best Practices
Service Configuration
#![allow(unused)] fn main() { use aura_sync::services::{MaintenanceService, MaintenanceServiceConfig}; use aura_sync::protocols::{SnapshotConfig, OTAConfig}; use std::time::Duration; fn create_maintenance_service() -> Result<MaintenanceService, Box<dyn std::error::Error>> { let config = MaintenanceServiceConfig { snapshot: SnapshotConfig { proposal_timeout: Duration::from_secs(300), approval_timeout: Duration::from_secs(600), max_proposals: 10, }, ota: OTAConfig { readiness_timeout: Duration::from_secs(3600), max_pending: 5, soft_fork_auto_activate: true, }, cache: Default::default(), }; Ok(MaintenanceService::new(config)?) } }
Configuration controls timeouts, limits, and behavior. Snapshot timeouts should be shorter than OTA staging and activation timeouts since snapshots are more frequent. OTA policies should separately configure discovery, sharing, and activation rather than bundling them into one setting.
Snapshot Best Practices
Keep snapshots frequent but not excessive. Snapshot every 100-500 epochs depending on journal size. Too frequent snapshots create overhead. Too infrequent snapshots reduce garbage collection effectiveness.
Always verify state digest before approving. Use canonical serialization for digest computation. Record all snapshots in the journal for audit trail.
Upgrade Best Practices
Plan upgrades carefully. Soft forks can be deployed flexibly inside one scope. Hard forks require a clear activation scope, an explicit compatibility class, and an operator decision about whether in-flight incompatible sessions drain, abort, or delegate.
Always test upgrades in simulation before deployment. Use threshold approval or epoch fences only in scopes that actually own those mechanisms. Treat suggested_activation_time_unix_ms as advisory rollout metadata, not as a coordination primitive.
Include rollback procedures for hard forks. Document migration paths for state format changes and keep launcher activation/rollback steps separate from the running runtime.
Cache Best Practices
Invalidate cache conservatively. Over-invalidation reduces performance. Under-invalidation risks stale data.
Use epoch floors to scope invalidation. Invalidate only keys that actually changed at that epoch.
Monitor cache hit rates. Low hit rates indicate invalidation is too aggressive.
Monitoring and Debugging
Snapshot Status
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; async fn monitor_snapshots( service: &MaintenanceService, ) -> Result<(), Box<dyn std::error::Error>> { let status = service.snapshot_status().await?; println!("Last snapshot: epoch {}", status.last_snapshot_epoch); println!("Pending proposals: {}", status.pending_proposals); println!("Writer fence active: {}", status.fence_active); Ok(()) } }
Check snapshot status regularly to ensure the snapshot cycle is healthy. Long intervals between snapshots may indicate approval delays.
Upgrade Status
#![allow(unused)] fn main() { use aura_sync::services::MaintenanceService; async fn monitor_upgrades( service: &MaintenanceService, ) -> Result<(), Box<dyn std::error::Error>> { let status = service.upgrade_status().await?; for upgrade in status.active_upgrades { println!("Upgrade: version {}", upgrade.version); println!(" Ready devices: {}/{}", upgrade.ready_count, upgrade.total_devices); println!(" Threshold: {}", upgrade.threshold); } Ok(()) } }
Monitor upgrade progress to catch devices that are not ready. Missing devices may need manual intervention.
Integration with Choreography
The maintenance system integrates with the choreography runtime for threshold approval ceremonies. Snapshot and upgrade proposals are published to the journal where choreography protocols can coordinate approval.
The maintenance service publishes events as facts. Choreography protocols subscribe to these facts and coordinate the necessary approvals through their own message flows.
Summary
The Maintenance and OTA system provides coordinated maintenance operations with threshold approval and epoch fencing where those mechanisms actually exist. Snapshots enable garbage collection with writer fencing. OTA release distribution is eventual, while activation is local or scope-bound. Cache invalidation is replicated through the journal for consistency.
Use snapshots regularly for garbage collection. Plan upgrades carefully with sufficient notice for hard forks. Test all upgrades in simulation. Monitor snapshot and upgrade cycles to ensure system health.
Implementation References
- Maintenance Service:
aura-sync/src/services/maintenance.rs - Snapshot Protocol:
aura-sync/src/protocols/snapshots.rs - OTA Protocol:
aura-sync/src/protocols/ota.rs - Cache Management:
aura-sync/src/infrastructure/cache_manager.rs - Integration Examples:
aura-agent/src/handlers/maintenance.rs
Capability Vocabulary Inventory
This Phase 0 artifact inventories the current authorization capability strings, classifies their status, and records the canonical migration targets for the clean-cutover capability-vocabulary refactor.
Scope
This inventory covers authorization capability names used in:
- product Rust call sites
- Biscuit token issuance
- guard snapshots and guard checks
- choreography
.tellfiles - docs and examples that currently teach or exercise capability annotations
- test fixtures that still exercise legacy naming
This inventory does not treat the following as authorization capability names:
aura_core::effects::CapabilityKeyruntime-admission keys- version-handshake feature flags such as
ceremony_supersession - explicit negative-test placeholders such as
unknown_capability - documentation placeholders such as
capability_name - diagnostic labels such as
bundle linkingandsession delegation - unrelated "capability" terminology in ownership or crypto docs
No out-of-tree module manifests currently exist in-tree. The module namespace rules below therefore reserve the future extension path, but no concrete module capabilities are currently admitted.
Reserved Namespaces
First-Party Authorization Namespaces
These namespace roots are reserved for first-party Aura capability families:
| Namespace | Owner crate | Notes |
|---|---|---|
amp | aura-amp | AMP message-flow capabilities |
auth | aura-authentication | Authentication and guardian-auth capabilities |
chat | aura-chat | Chat and channel message capabilities |
consensus | aura-consensus | Consensus ceremony capabilities |
dkd | aura-authentication | Distributed key derivation choreography capabilities |
example | host-owned docs/examples namespace | Reserved for teaching examples and macro tests |
invitation | aura-invitation | Invitation, guardian, channel, and device flows |
recovery | aura-recovery | Recovery, guardian setup, membership change |
relay | aura-rendezvous | Relay-forward subfamily |
rendezvous | aura-rendezvous | Descriptor and rendezvous exchange |
sync | aura-sync | Anti-entropy and epoch rotation |
Generic Host-Owned Capabilities
These names stay reserved by the host and are not owned by a feature crate:
readwriteexecutedelegatemoderatorflow_charge
Reserved Module Namespace
Out-of-tree module-defined capabilities must use:
module:<module_id>:<capability_path>
Rules:
<module_id>is the admitted host-reviewed module identity, not an arbitrary author-chosen prefix.<capability_path>uses the same validated lower-case segment grammar as first-party names.- modules may not claim first-party namespace roots such as
invitation,consensus, orsync - modules may not claim generic host-owned names such as
readorwrite - host runtime code must consume admitted descriptors, not hand-written
module:<module_id>:...strings
Canonical First-Party Capability Inventory
These are the canonical migration targets for first-party product code.
| Canonical name | Owner crate | Current sources | Notes |
|---|---|---|---|
amp:send | aura-amp | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs, crates/aura-simulator/tests/guarded_amp_anti_entropy.rs | Canonical AMP send capability |
amp:receive | aura-amp | crates/aura-amp/src/choreography.tell currently uses cap:amp_recv | Canonical AMP receive capability |
auth:request | aura-authentication | crates/aura-authentication/src/guards.rs | Canonical authentication request capability |
auth:submit_proof | aura-authentication | crates/aura-authentication/src/guards.rs | Canonical proof-submission capability |
auth:verify | aura-authentication | crates/aura-authentication/src/guards.rs | Canonical proof-verification capability |
auth:create_session | aura-authentication | crates/aura-authentication/src/guards.rs | Authentication-owned session creation capability |
auth:guardian:request_approval | aura-authentication | crates/aura-authentication/src/guardian_auth_relational.tell, crates/aura-authentication/src/guards.rs | Canonical guardian-auth request capability |
auth:guardian:coordinate | aura-authentication | crates/aura-authentication/src/guardian_auth_relational.tell | Coordinator-side guardian-auth capability |
auth:guardian:submit_proof | aura-authentication | crates/aura-authentication/src/guardian_auth_relational.tell | Guardian proof submission |
auth:guardian:verify | aura-authentication | crates/aura-authentication/src/guardian_auth_relational.tell, crates/aura-authentication/src/guards.rs | Canonical guardian-auth verification capability |
chat:channel:create | aura-chat | crates/aura-chat/src/guards.rs | Canonical chat channel-create capability |
chat:message:send | aura-chat | crates/aura-chat/src/guards.rs | Canonical chat send capability |
consensus:initiate | aura-consensus | crates/aura-consensus/src/protocol/guards.rs | Canonical start-of-ceremony capability |
consensus:witness_nonce | aura-consensus | crates/aura-consensus/src/protocol/guards.rs | Witness nonce submission |
consensus:aggregate_nonces | aura-consensus | crates/aura-consensus/src/protocol/guards.rs | Coordinator aggregation capability |
consensus:witness_sign | aura-consensus | crates/aura-consensus/src/protocol/guards.rs | Witness sign-share submission |
consensus:finalize | aura-consensus | crates/aura-consensus/src/protocol/guards.rs | Final consensus completion capability |
dkd:initiate | aura-authentication | crates/aura-authentication/src/dkd.tell | DKD initiation |
dkd:commit | aura-authentication | crates/aura-authentication/src/dkd.tell | DKD commitment |
dkd:reveal | aura-authentication | crates/aura-authentication/src/dkd.tell | DKD reveal |
dkd:finalize | aura-authentication | crates/aura-authentication/src/dkd.tell | DKD finalize |
invitation:send | aura-invitation | crates/aura-invitation/src/guards.rs, crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.invitation_exchange.tell, token issuance | Canonical invitation send capability |
invitation:accept | aura-invitation | crates/aura-invitation/src/guards.rs, crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.invitation_exchange.tell, token issuance | Canonical invitation accept capability |
invitation:decline | aura-invitation | crates/aura-invitation/src/guards.rs, crates/aura-invitation/src/protocol.rs, token issuance | Canonical invitation decline capability |
invitation:cancel | aura-invitation | crates/aura-invitation/src/guards.rs, token issuance | Canonical invitation cancel capability |
invitation:guardian | aura-invitation | crates/aura-invitation/src/guards.rs, crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.guardian_invitation.tell, token issuance | Guardian invitation send capability |
invitation:guardian:accept | aura-invitation | crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.guardian_invitation.tell | Guardian invitation accept capability |
invitation:channel | aura-invitation | crates/aura-invitation/src/guards.rs, token issuance | Shared-channel invitation capability |
invitation:device:enroll | aura-invitation | crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.device_enrollment.tell | Device-enrollment send capability |
invitation:device:accept | aura-invitation | crates/aura-invitation/src/protocol.rs, crates/aura-invitation/src/protocol.device_enrollment.tell | Device-enrollment accept capability |
recovery:initiate | aura-recovery | crates/aura-authentication/src/guards.rs, crates/aura-agent/src/handlers/recovery.rs, crates/aura-recovery/src/recovery_protocol.tell | Recovery initiation |
recovery:coordinate | aura-recovery | crates/aura-recovery/src/recovery_protocol.tell | Recovery coordination capability |
recovery:approve | aura-recovery | crates/aura-authentication/src/guards.rs, crates/aura-agent/src/handlers/recovery.rs, crates/aura-recovery/src/recovery_protocol.tell | Guardian approval capability |
recovery:finalize | aura-recovery | crates/aura-agent/src/handlers/recovery.rs, crates/aura-recovery/src/recovery_protocol.tell | Canonical completion/finalization capability |
recovery:cancel | aura-recovery | crates/aura-agent/src/handlers/recovery.rs | Recovery cancellation capability |
recovery:guardian_setup:initiate | aura-recovery | crates/aura-recovery/src/guardian_setup.tell | Guardian setup initiation |
recovery:guardian_setup:accept_invitation | aura-recovery | crates/aura-recovery/src/guardian_setup.tell | Guardian setup invitation acceptance |
recovery:guardian_setup:verify_invitation | aura-recovery | crates/aura-recovery/src/guardian_setup.tell | Guardian setup verification |
recovery:guardian_setup:complete | aura-recovery | crates/aura-recovery/src/guardian_setup.tell | Guardian setup completion |
recovery:membership_change:initiate | aura-recovery | crates/aura-recovery/src/guardian_membership.tell | Membership-change initiation |
recovery:membership_change:vote | aura-recovery | crates/aura-recovery/src/guardian_membership.tell | Guardian vote capability |
recovery:membership_change:verify_proposal | aura-recovery | crates/aura-recovery/src/guardian_membership.tell | Proposal verification |
recovery:membership_change:complete | aura-recovery | crates/aura-recovery/src/guardian_membership.tell | Membership-change completion |
relay:forward | aura-rendezvous | crates/aura-rendezvous/src/protocol.rs, crates/aura-rendezvous/src/protocol.relayed_rendezvous.tell, docs/113_rendezvous.md | Relay forwarding subfamily |
rendezvous:publish | aura-rendezvous | crates/aura-rendezvous/src/protocol.rs, crates/aura-rendezvous/src/protocol.rendezvous_exchange.tell, crates/aura-agent/src/handlers/rendezvous.rs, crates/aura-agent/src/runtime/services/rendezvous_manager.rs, token issuance, docs/113_rendezvous.md | Canonical descriptor publish capability |
rendezvous:connect | aura-rendezvous | crates/aura-rendezvous/src/protocol.rs, crates/aura-rendezvous/src/protocol.rendezvous_exchange.tell, crates/aura-agent/src/handlers/rendezvous.rs, crates/aura-agent/src/runtime/services/rendezvous_manager.rs, docs/113_rendezvous.md | Canonical direct connect capability |
rendezvous:relay | aura-rendezvous | crates/aura-rendezvous/src/protocol.rs, crates/aura-rendezvous/src/protocol.relayed_rendezvous.tell, crates/aura-agent/src/handlers/rendezvous.rs, docs/113_rendezvous.md | Canonical relayed connect capability |
sync:request_digest | aura-sync | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs | Anti-entropy digest request capability |
sync:request_ops | aura-sync | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs | Anti-entropy op request capability |
sync:push_ops | aura-sync | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs | Anti-entropy batch push capability |
sync:announce_op | aura-sync | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs | Anti-entropy announcement capability |
sync:push_op | aura-sync | crates/aura-authorization/src/biscuit_token.rs, crates/aura-agent/src/runtime/effects.rs | Anti-entropy single-op push capability |
sync:epoch:propose_rotation | aura-sync | crates/aura-sync/src/protocols/epochs.tell | Epoch rotation proposal |
sync:epoch:confirm_readiness | aura-sync | crates/aura-sync/src/protocols/epochs.tell | Epoch rotation readiness confirmation |
sync:epoch:commit_rotation | aura-sync | crates/aura-sync/src/protocols/epochs.tell | Epoch rotation commit |
Legacy Aliases and Invalid Drift
These strings are present today but are not approved as long-lived capability surface. They exist only as migration or deletion targets.
| Current string | Classification | Canonical target | Current sources | Disposition |
|---|---|---|---|---|
amp:send and cap:amp_send coexist | legacy split-brain naming | amp:send | crates/aura-simulator/tests/guarded_amp_anti_entropy.rs, crates/aura-amp/src/choreography.tell, token issuance | Keep amp:send; delete cap:amp_send |
cap:amp_recv | legacy alias | amp:receive | crates/aura-amp/src/choreography.tell | Delete alias during Phase 4 |
auth:request_guardian | legacy alias | auth:guardian:request_approval | crates/aura-authentication/src/guards.rs | Rename in typed family |
auth:approve_guardian | legacy alias | auth:guardian:verify | crates/aura-authentication/src/guards.rs | Rename in typed family |
auth:authenticate | invalid drift | auth:verify or a new explicit auth:status if the owner decides status needs its own capability | crates/aura-agent/src/handlers/auth.rs | Phase 2/5 owner decision, then delete drift |
initiate_consensus | legacy choreography alias | consensus:initiate | crates/aura-consensus/src/protocol/choreography.tell, crates/aura-consensus/src/protocol/guards.rs | Temporary parse bridge only if needed in Phase 4 |
witness_nonce | legacy choreography alias | consensus:witness_nonce | same as above | Temporary parse bridge only if needed in Phase 4 |
aggregate_nonces | legacy choreography alias | consensus:aggregate_nonces | same as above | Temporary parse bridge only if needed in Phase 4 |
witness_sign | legacy choreography alias | consensus:witness_sign | same as above | Temporary parse bridge only if needed in Phase 4 |
finalize_consensus | legacy choreography alias | consensus:finalize | same as above | Temporary parse bridge only if needed in Phase 4 |
invitation:device | legacy umbrella name | split to invitation:device:enroll and invitation:device:accept | crates/aura-invitation/src/guards.rs, token issuance | Remove umbrella capability |
message:send | legacy unowned namespace | chat:message:send | token issuance, crates/aura-agent/src/runtime/effects.rs, docs/tests in aura-guards, aura-mpst, aura-macros | Migrate examples/tests or move to example:*; product code uses chat:* |
rendezvous:publish_descriptor | invalid drift | rendezvous:publish | crates/aura-agent/src/handlers/rendezvous.rs | Delete drift |
rendezvous:initiate_channel | invalid drift | rendezvous:connect | crates/aura-agent/src/handlers/rendezvous.rs | Delete drift |
rendezvous:relay_request | invalid drift | rendezvous:relay | crates/aura-agent/src/handlers/rendezvous.rs | Delete drift |
recovery:complete | legacy alias | recovery:finalize | crates/aura-agent/src/handlers/recovery.rs | Rename to finalized vocabulary |
accept_guardian_invitation,verify_setup_invitation | invalid composite choreography string | split to recovery:guardian_setup:accept_invitation and recovery:guardian_setup:verify_invitation | crates/aura-recovery/src/guardian_setup.tell | Delete comma-joined string syntax on this path |
vote_membership_change,verify_membership_proposal | invalid composite choreography string | split to recovery:membership_change:vote and recovery:membership_change:verify_proposal | crates/aura-recovery/src/guardian_membership.tell | Delete comma-joined string syntax on this path |
sync:read | invalid umbrella name | replace with operation-specific sync:* capability per call site | crates/aura-sync/src/infrastructure/peers.rs | Delete umbrella capability |
sync_journal | invalid legacy name | replace with operation-specific sync:* capability per call site | crates/aura-sync/src/protocols/anti_entropy.rs, archived work notes | Delete legacy name |
recover:device | invalid drift in test payload | owner should replace with a canonical recovery:* capability or a typed role field | crates/aura-invitation/src/protocol.rs test serialization | Do not preserve as compatibility alias |
invitation:create | invalid test-only drift | delete or replace with a real invitation capability | crates/aura-core/src/ownership.rs test helper | Do not preserve |
recovery_initiate | legacy test fixture alias | recovery:initiate | crates/aura-testkit/src/fixtures/biscuit.rs | Delete alias in fixture |
recovery_approve | legacy test fixture alias | recovery:approve | crates/aura-testkit/src/fixtures/biscuit.rs | Delete alias in fixture |
threshold_sign | invalid / unowned test fixture name | owner must replace with canonical family or remove fixture dependency | crates/aura-testkit/src/fixtures/biscuit.rs | Delete or replace |
Choreography and Example Names That Must Become Namespaced
These current names are intentionally not approved as canonical product
capabilities. They either move into an owned first-party namespace or into the
reserved host-owned example:* namespace for teaching material.
| Current string(s) | Classification | Canonical target |
|---|---|---|
send_ping, send_pong, send_request, send_response, send_message, send, coordinate, coordinate_signing, participate_signing | docs/examples legacy placeholders | example:* names in docs, examples, macro tests, and MPST tests |
create_session, join_session, decline_session, activate_session, broadcast_message, check_status, report_status, end_session | example-only session choreography names | example:* names unless the session protocol becomes a real first-party family |
request_session, invite_participants, respond_session, create_session, notify_participants, reject_session_creation, notify_participants_failure | invalid unnamespaced internal choreography names | future owned session:* family if retained; otherwise delete |
request_guardian_approval, coordinate_guardians, submit_guardian_proof, verify_guardian | legacy unnamespaced auth choreography names | auth:guardian:* family |
initiate_recovery, approve_recovery, coordinate_recovery, finalize_recovery, initiate_guardian_setup, accept_guardian_invitation, verify_setup_invitation, complete_guardian_setup, initiate_membership_change, vote_membership_change, verify_membership_proposal, complete_membership_change | legacy unnamespaced recovery choreography names | recovery:* subfamilies |
propose_epoch_rotation, confirm_epoch_readiness, commit_epoch_rotation | legacy unnamespaced sync choreography names | sync:epoch:* family |
Explicit Audit Exclusions
These strings were caught by broad Phase 0 grep passes but are not part of the authorization capability vocabulary:
| String | Reason for exclusion | Current sources |
|---|---|---|
ceremony_supersession | version-handshake feature flag, not an authorization capability | crates/aura-protocol/src/handlers/version_handshake.rs, crates/aura-core/src/protocol/versions.rs |
fact_journal | version-handshake feature flag, not an authorization capability | same as above plus docs |
unknown_capability | negative-test placeholder for version capability queries | crates/aura-protocol/src/handlers/version_handshake.rs, crates/aura-core/src/protocol/versions.rs |
capability_name | documentation placeholder in MPST docs | crates/aura-mpst/src/lib.rs |
bundle linking | diagnostic label passed to a reconfiguration capability check, not a capability name | crates/aura-agent/src/runtime/services/reconfiguration_manager.rs |
session delegation | diagnostic label passed to a reconfiguration capability check, not a capability name | same as above |
Quarantine Notes
- Historical scratch notes remain explicitly quarantined as non-authoritative archive material.
- This file replaces ad hoc capability-name scratch lists for the Phase 0 refactor inventory.
- Remaining legacy names are recorded here only as migration/deletion targets. They are not approved compatibility surfaces.
Audit Commands
Phase 0 inventory data was gathered with:
rg -n --no-heading 'CAP_[A-Z0-9_]+: &str = "[^"]+"' crates -g'*.rs'
rg -n --no-heading 'CapabilityId::from\("[^"]+"|has_capability\("[^"]+"' crates -g'*.rs'
rg -n --no-heading 'guard_capability = "[^"]+"|#\[guard_capability\("[^"]+"\)\]' crates docs examples -g'*.rs' -g'*.md' -g'*.tell'
rg -n --no-heading 'capability\("[^"]+"\)' crates docs examples -g'*.rs' -g'*.md'
Environment Configuration Guide
This guide is the working registry for Aura environment variables.
Use three buckets:
product runtime: user-facing runtime configuration that affects production shells or handlersharness / tooling: local automation, browser harness, CI, or workflow bring-up knobstest-only: fixture generation, compatibility baselines, compile-fail helpers, or artifact capture used only in tests
Do not add new env reads ad hoc. Add the variable to the appropriate bucket first, then expose it through a small typed helper near the owning runtime boundary.
Product Runtime
| Variable | Owner | Purpose |
|---|---|---|
AURA_PATH | aura-agent::core::config | Base root used to resolve the default Aura storage directory |
AURA_BOOTSTRAP_BROKER_BIND | aura-terminal::env | Override bootstrap-broker bind address for mixed native/browser startup |
AURA_BOOTSTRAP_BROKER_URL | aura-terminal::env | Override externally reachable bootstrap-broker base URL |
AURA_BOOTSTRAP_BROKER_ALLOW_LAN_BIND | aura-terminal::env | Explicitly allow a bootstrap broker bind address that is visible off loopback |
AURA_BOOTSTRAP_BROKER_AUTH_TOKEN | aura-terminal::env | Bearer token required for bootstrap-broker HTTP endpoints |
AURA_BOOTSTRAP_BROKER_INVITATION_TOKEN | aura-terminal::env | Unguessable one-time token sent as the bootstrap-broker invitation retrieval header |
AURA_CLIPBOARD_MODE | aura-terminal::env | Select clipboard behavior for terminal code display (system, file_only, disabled) |
AURA_CLIPBOARD_FILE | aura-terminal::env | Capture clipboard writes to a file for constrained or automated environments |
AURA_DEMO_DEVICE_ID | aura-terminal::env | Enable demo-only neighborhood assist behavior when a demo device id is staged |
AURA_TCP_LISTEN_ADDR | aura-effects::transport::env | Override the stateless TCP receive bind address |
AURA_TUI_ALLOW_STDIO | aura-terminal::env | Disable fullscreen stdio redirection for debugging |
AURA_TUI_LOG_PATH | aura-terminal::env | Override the storage key/path used for persisted TUI logs |
Harness / Tooling
| Variable family | Owner | Purpose |
|---|---|---|
AURA_HARNESS_* | aura-harness, aura-app::workflows::runtime, aura-agent::runtime_bridge, aura-ui::app::shell::modal_submit | Harness orchestration, convergence, browser bootstrap, and render-stability controls |
AURA_WEB_APP_URL | aura-harness | Fallback browser app URL for harness/browser bring-up |
AURA_ALLOW_FLOW_COVERAGE_SKIP, AURA_FLOW_COVERAGE_* | aura-harness::governance | Governance/coverage policy knobs |
GITHUB_*, CI | harness/tooling only | CI-aware defaults for harness governance and parity rotation |
Harness env reads may stay close to the owning harness boundary, but they should still be routed through small typed helpers when reused in multiple places.
Test-only
Examples:
AURA_PROTOCOL_COMPAT_*AURA_CONSENSUS_ITF_*AURA_CONFORMANCE_*AURA_PROPERTY_MONITOR_*AURA_TELLTALE_*- compile-fail helpers that only inspect Cargo-provided environment variables
These should not be mixed into product-runtime or harness-runtime registries. Keep them local to the owning test module unless they become shared fixture infrastructure.
User Flow Coverage Report
This document tracks end-to-end user coverage for Aura's runtime harness scenarios across TUI and web surfaces.
Coverage Boundary Statement
User flow coverage validates user-visible behavior and interaction wiring through runtime harness scenarios. It does not replace protocol conformance, theorem proofs, or differential parity lanes. Use this report for UI/product flow traceability and regression targeting.
The harness coverage model has two explicit lanes:
- shared semantic lane:
- parity-critical shared flows execute through the shared semantic command plane
- this establishes real frontend semantic integration after deterministic in-process runtime/app validation
- frontend-conformance lane:
- renderer-specific control wiring, DOM/PTy mechanics, and shell integration are validated separately
- these scenarios are intentionally not the primary shared-flow substrate
Coverage in this report describes frontend execution. Complete runtime/app flow regressions run first in-process using the real implementation and controlled effects. Local frontend checks follow; cross-machine P2P confirmation batches locally proven flows after checkpoint gates and main smoke. A harness coverage row does not imply simulator, fault/restart or cross-machine evidence. See Testing Guide.
Summary Metrics
| Metric | Count |
|---|---|
| Harness User Flow Scenarios | 17 |
| Shared Semantic Scenarios | 11 |
| Mixed-Runtime Scenarios (TUI + Web distinct keys) | 3 |
| Frontend-Conformance Scenarios | 6 |
| Core User Flow Domains | 13 |
Coverage Classes
Aura tracks three different coverage classes in this document:
| Class | Meaning | Main Artifact |
|---|---|---|
| Parity-critical shared flow | One semantic flow that must remain portable across TUI and web and execute through the shared semantic command plane | aura-app::ui_contract + canonical harness scenarios |
| Mixed-runtime interoperability | User-visible flow that intentionally spans different frontend/runtime combinations | Canonical mixed-runtime scenarios |
| Frontend-specific or auxiliary coverage | Focused smoke, modal, renderer-specific, or conformance-only coverage that is useful but not the parity contract | Supplementary scenarios |
This report is a traceability document for those classes. It is not a proof of protocol correctness, and it does not replace conformance or verification lanes.
Exact semantic expectation coverage
The harness library regressions distinguish list membership, item confirmation and explicit selection through the canonical scenario lowering and matcher. They cover missing and unrelated selections, absent members, changed confirmation, and exclusion of private lowering metadata from serialized compatibility fixtures. Focused control identity cannot establish control visibility.
Typed snapshots currently establish screen, list and modal presence. Ordinary
ControlVisible expectations fail explicitly until render-bound observations
exist. This includes the onboarding_root expectations in semantic-observation
and frontend-conformance smoke scenarios; the matcher tests do not establish
those flows. Actual native and browser render producers, source-revision binding,
and paired-client execution remain required before claiming visibility coverage.
Reactive observation health
Both frontends export per-owner, per-signal UiSnapshot.subscription_health with
typed attaching, healthy, degraded, and recovering states. A failed
registration, closed stream, or failed snapshot read must remain observable;
reattachment reads the current value before claiming healthy convergence.
The shared UI and TUI library tests cover failure and recovery transitions,
duplicate shell observer prevention, and snapshot serialization. The browser
and TUI semantic-observation smoke scenarios remain the end-to-end anchors for
startup, navigation, and ui_state convergence; they do not yet inject stream
closure or runtime rebootstrap. The recovery smoke in work/8.md Task S14
must add those fault-injection cases to the PR lane.
The TUI export also carries diagnostic UiSnapshot.supervised_task_failures
(group, task, cause of dead runtime-supervised tasks). It is not
parity-classified, gates no readiness or quiescence, and the browser publishes
it empty. Coverage is the aura-app serialization test and the aura-agent
bridge accessor test; LAN runs read it with deadtasks <inst>.
Projection source revisions
UiSnapshot.projection_source_revisions reports the graph revision last copied
into each observed app projection (chat, contacts, homes, invitations,
recovery, and neighborhood). TUI and browser exports use the same app snapshot
source. These values are separate from UiSnapshot.revision, which advances
with frontend semantic or render publication. After both observers are
quiescent on one runtime, their entity sets and source revisions should agree.
The Task 4 transaction and mirror tests cover stale publication and delayed
view-copy races; the Task 14 PR smoke must exercise this through both frontend
observers after a forced stale projection and recovery.
Canonical home mode observations
Observation surface version 2 requires UiSnapshot.home_modes on both
frontends. The shared app projection helper exports each materialized home's
channel, context, and mode flags from the same app snapshot as its homes source
revision. Missing contexts are withheld; unavailable browser app reads publish
loading/busy rather than authoritative absence. Shared parity comparison checks
these bindings and mode flags independently of list order.
Focused app, native terminal, and shared UI tests cover canonical projection, required wire fields, parity differences, matching homes provenance, and unavailable reads. The shared UI's real HOMES subscription-to-render-to-sink regression changes only mode flags while display values remain equal, verifies a newer homes revision in the pushed snapshot, and fails with the old render-equality gate. Subscription attachment is acknowledged before healthy publication; immediate-update and repeated-mount cancellation tests cover that ownership boundary. These are in-process observations: paired LAN mode-change publication and convergence through both frontends remain unproven.
Canonical UX Scenario Set
| Scenario | File | Primary Flow |
|---|---|---|
| Startup Smoke | scenarios/harness/real-runtime-mixed-startup-smoke.toml | Shared runtime startup and onboarding readiness |
| TUI Global Navigation/Help Hotkeys | scenarios/harness/tui-conformance-global-navigation-help-hotkeys.toml | TUI frontend-conformance: global navigation, key mappings, and help modal behavior |
| TUI Neighborhood Keypaths/Detail | scenarios/harness/tui-conformance-neighborhood-keypaths-and-detail.toml | TUI frontend-conformance: neighborhood keypaths, rendered map/detail text, and toast wiring |
| Scenario 12 | scenarios/harness/scenario12-mixed-device-enrollment-removal-e2e.toml | Mixed TUI/Web device enrollment + removal |
| Browser Enrollment Approved Transfer/Reopen | scenarios/harness/web-conformance-enrollment-approved-transfer-reopen.toml | Browser-only mounted approval of a real signed enrollment transfer, host persistence, and same-profile reopen |
| Scenario 13 | scenarios/harness/scenario13-mixed-contact-channel-message-e2e.toml | Shared contact invite + channel messaging |
| Contact Invite Notification Roundtrip | scenarios/harness/mixed-contact-invite-notification-roundtrip.toml | Mixed TUI/Web symmetric contact invite acceptance notifications |
| Shared Settings | scenarios/harness/shared-settings-parity.toml | Shared semantic settings parity |
| Shared Notifications/Authority | scenarios/harness/shared-notifications-and-authority.toml | Shared semantic notifications navigation and authority-switch handling |
| AMP Normal Transition | scenarios/harness/amp-transition-normal-shared.toml | Shared AMP observed to A2 live to A3 finalized transition observation |
| AMP Delayed Witness Transition | scenarios/harness/amp-transition-delayed-witness-shared.toml | Shared AMP delayed/offline witness pending and convergence observation |
| AMP Conflict/Subtractive Transition | scenarios/harness/amp-transition-conflict-subtractive-shared.toml | Shared AMP conflicting A2 certificate and subtractive membership observation |
| AMP Emergency Transition | scenarios/harness/amp-transition-emergency-shared.toml | Shared AMP emergency quarantine, cryptoshred, and governance non-removal observation |
| AMP Negative Transition | scenarios/harness/amp-transition-negative-shared.toml | Shared AMP rejected emergency, cooldown duplicate evidence, and recovery replay observation |
| Browser Observation | scenarios/harness/semantic-observation-browser-smoke.toml | Browser semantic observation contract smoke |
| TUI Observation | scenarios/harness/semantic-observation-tui-smoke.toml | TUI semantic observation contract smoke |
| Quint Observation | scenarios/harness/quint-semantic-observation-smoke.toml | Quint-origin semantic observation reference |
The TUI-only conformance scenarios and browser enrollment transfer/reopen are frontend-conformance coverage; Scenario 13 remains the shared contact/chat anchor. All harness scenarios in this inventory use the semantic scenario format.
User Flow Matrix
| Flow Domain | Main Coverage | Secondary Coverage | Runtime Context |
|---|---|---|---|
| Startup and onboarding readiness | real-runtime-mixed-startup-smoke.toml | quint-semantic-observation-smoke.toml | TUI + Web |
| Navigate neighborhood | real-runtime-mixed-startup-smoke.toml | TUI Neighborhood Keypaths/Detail | TUI + Web |
| Navigate chat | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Navigate contacts | Scenario 13 | mixed-contact-invite-notification-roundtrip.toml, semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Send friend request | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Accept inbound friend request | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Decline inbound friend request | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Remove friend / revoke outbound friendship | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Navigate notifications | shared-notifications-and-authority.toml | mixed-contact-invite-notification-roundtrip.toml, semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Contact link over one LAN inside patchbay namespaces (real instances, modeled router) | Scenario 13 under configs/harness/patchbay-lan.toml --network-backend patchbay (ubu1) | tier 2 tests/holepunch/ | TUI in lab namespaces |
| Relay-first contact link across two home NATs | Scenario 13 under configs/harness/patchbay-double-nat.toml (ubu1); currently fails at invitation acceptance, which is evidence about the rendezvous relay path, not the lab | tier 2 tests/holepunch/ NAT cells | TUI in lab namespaces |
| Direct-path upgrade and re-upgrade after NAT flush | holepunch-relay-first.toml asserts peer_path_selected with relay after the shared channel is joined, then flushes NAT and toggles the link and asserts bob's network_generation:1 once its relay session is re-established. Direct probes are bounded per generation (PeerPathState unit tests cover promotion, degradation and budget reset). | tier 1 holepunch_tier1 invariants, peer_path_state unit tests | TUI in lab namespaces |
| Corporate (symmetric) NAT stays on relay with bounded attempts | holepunch-relay-first-corporate.toml asserts peer_path_selected with relay after the shared channel is joined and bob's network_generation:1 after the NAT flush; the symmetric NAT keeps every direct probe failing, so the state stays on the relay. | tier 2 corporate/udp_blocked cells | TUI in lab namespaces |
| Navigate settings | shared-settings-parity.toml | shared-notifications-and-authority.toml, semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml, quint-semantic-observation-smoke.toml | TUI + Web |
| Create invitation | Scenario 13 | mixed-contact-invite-notification-roundtrip.toml, semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Accept invitation | Scenario 13 | mixed-contact-invite-notification-roundtrip.toml, semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Create home | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Join channel | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Send chat message | Scenario 13 | semantic-observation-browser-smoke.toml, semantic-observation-tui-smoke.toml | TUI + Web |
| Add device | Scenario 12 | shared-settings-parity.toml, web-conformance-enrollment-approved-transfer-reopen.toml (browser mounted control and reopen) | Mixed runtime + browser conformance |
| Remove device | Scenario 12 | shared-settings-parity.toml | Mixed runtime |
| Switch authority | shared-notifications-and-authority.toml | shared-settings-parity.toml | TUI + Web |
| Global navigation/help | TUI Global Navigation/Help Hotkeys | None | TUI frontend-conformance |
| Neighborhood keypath navigation | TUI Neighborhood Keypaths/Detail | real-runtime-mixed-startup-smoke.toml | TUI frontend-conformance + shared startup |
| Semantic observation contract | semantic-observation-browser-smoke.toml | semantic-observation-tui-smoke.toml, quint-semantic-observation-smoke.toml | Browser + TUI |
| AMP transition frontend observation | amp-transition-normal-shared.toml, amp-transition-delayed-witness-shared.toml, amp-transition-conflict-subtractive-shared.toml, amp-transition-emergency-shared.toml, amp-transition-negative-shared.toml | Runtime-event parity contract tests; simulator transition scenarios from Phase 9 | TUI + Web observation contract |
Current parity-critical source changes touched the following shared-flow areas and continue to map to the same canonical coverage anchors:
- Shared flow and scenario contract metadata now live behind facade roots in
aura-app::ui_contractandaura-app::scenario_contract, with dedicated module families for parity metadata, harness metadata, shared-flow support, action contracts, expectations, submission, and value types. The canonical public contract and the coverage anchors below do not change with that internal split. - Notifications navigation remains anchored by
shared-notifications-and-authority.toml, withsemantic-observation-browser-smoke.tomlandsemantic-observation-tui-smoke.tomlas secondary observation coverage. The current notifications-screen change is limited to neutral empty-state copy and detail text, and the coverage expectation remains that notifications navigation exercises shared semantic navigation only rather than frontend-specific invitation or recovery actions. - The TUI semantic-observation contract keeps the same canonical anchor in
semantic-observation-tui-smoke.toml, but the native harness ingress now requires explicit harness mode, the per-runAURA_HARNESS_RUN_TOKEN, and transient-root-scopedAURA_TUI_COMMAND_SOCKET,AURA_TUI_UI_STATE_SOCKET, andAURA_TUI_UI_STATE_FILEvalues. That change hardens the existing observation scenario; it does not introduce a new shared-flow anchor or a production-only harness surface. - Neighborhood navigation stays anchored by
real-runtime-mixed-startup-smoke.toml - Chat/contact navigation, the contact-to-friend lifecycle, invitation, home
creation, channel join, and message-send flows stay anchored by
scenario13-mixed-contact-channel-message-e2e.toml - Contacts navigation, invitation creation, and invitation acceptance remain mapped to Scenario 13 plus the semantic observation smoke scenarios. The current terminal-side change only removes stale modal-local ownership assumptions and keeps those flows on the same typed dispatch and shared workflow path.
- Mixed contact-invite acceptance notifications now also have a dedicated
symmetric mixed-runtime anchor in
mixed-contact-invite-notification-roundtrip.toml. That scenario exercises TUI-create/Web-accept and Web-create/TUI-accept flows and verifies the creator-visible acceptance notification on the notifications screen without replacing Scenario 13 as the canonical contacts/chat lifecycle anchor. - Pending channel-invitation acceptance now also requires terminal-status
wrappers and
*_with_instanceentry points to publish a terminal failure for the same operation instance if a browser/TUI shared-flow error escapes before the owned accept path settles. That keeps Scenario 13 authoritative for contacts navigation, invitation create/accept, channel join, and shared-channel receive parity rather than leaving the lifecycle stranded atSemanticOperationPhase::WorkflowDispatched. aura-appsplits these same flows across more specific owner modules while preserving the coverage anchors above:workflows/context/neighborhood.rs,workflows/invitation/{create,accept,readiness}.rs, andworkflows/messaging/{channel_refs,channels,send}.rs. Shared-flow source metadata continues to publish through theaura-app::ui_contractfacade.- Settings/device and notifications/authority work keep the same canonical
anchors. Device add/remove and shared settings remain bound to
scenario12-mixed-device-enrollment-removal-e2e.tomlplusshared-settings-parity.toml, while notifications navigation and authority switching remain bound toshared-notifications-and-authority.toml. - Scenario 12 now also carries the browser-specific removable-device parity
rule: the shared semantic snapshot exports current-device markers without
fabricating a selected device row, so mixed browser runs must resolve
remove_selected_devicefrom the authoritative removable device in settings state when no explicitListId::Devicesselection exists. - The browser enrollment approved-transfer/reopen scenario supplements Scenario
12 with mounted Settings import control, explicit code/manifest/independent
verifier entry and approval, the original import operation's success, and
same-profile restart with two retained devices. Its
web_conformanceclassification tests browser control and persistence wiring; it does not replace the mixed-runtime parity anchor or prove threshold protocol closure. - Scenario 13 now also carries the mixed-runtime sealed-message receive rule:
the current TUI/browser shared-channel receive path may converge on sealed
authoritative placeholders, so the canonical receive assertions for the
mixed-runtime anchor match the
[sealed:prefix instead of renderer-local plaintext recovery. - AMP channel transition frontend observation is covered by shared semantic AMP
transition scenarios plus runtime-event parity contract tests. TUI and web
consume
RuntimeFact::AmpChannelTransitionUpdatedthroughUiSnapshot.runtime_eventsand sharedaura-app::ui_contractaction/control ids; the shared scenarios drive typed AMP transition fixtures through the semantic command plane and assertRuntimeEventKind::AmpChannelTransitionUpdatedwithout frontend-specific compatibility steps. - Browser bootstrap broker credential handling remains frontend-conformance coverage. Bearer and invitation retrieval tokens must come from session-scoped browser storage rather than URL query parameters, while the broker endpoint may still be staged through controlled bootstrap metadata. The native storage boundary test and browser observation smoke coverage protect the bridge/storage contract without creating a new shared semantic user flow.
Scenario 13 remains the canonical anchor for the shared contacts lifecycle
because it exercises the parity-critical semantic controls for send friend request, accept friend request, decline friend request, and remove friend while preserving the runtime-projected relationship states contact,
pending_outbound, pending_inbound, and friend across both TUI and web.
Frontend-Conformance Coverage
These scenarios are maintained outside the main shared semantic lane:
| Scenario File | Focus |
|---|---|
tui-conformance-global-navigation-help-hotkeys.toml | TUI hotkeys, global navigation, help modal wiring |
tui-conformance-neighborhood-keypaths-and-detail.toml | TUI neighborhood keypaths, rendered map/detail text, toast wiring |
semantic-observation-browser-smoke.toml | Browser observation contract smoke |
semantic-observation-tui-smoke.toml | TUI observation contract smoke |
quint-semantic-observation-smoke.toml | Reference semantic observation smoke |
web-conformance-enrollment-approved-transfer-reopen.toml | Browser mounted enrollment transfer approval, host persistence and same-profile reopen |
Planned Release And Update Validation Matrix
This matrix is the planned coverage target for harness-driven validation of module and OTA distribution/update behavior.
The intended rollout order is:
- mechanism validation matrix
- candidate-release rehearsal matrix
- live-release promotion gates
Mechanism validation proves the lifecycle machinery itself under synthetic releases and controlled failures. Candidate-release rehearsal proves that one specific release works before promotion or real cutover.
| Order | Domain | Mode | Target | Example Coverage Goal | Status |
|---|---|---|---|---|---|
| 1 | OTA | Mechanism validation | Native host shell + runtime payload | Synthetic release publication, staging, bootloader handoff, health confirmation, rollback | Planned |
| 2 | OTA | Mechanism validation | Browser-extension host shell + runtime payload | Synthetic extension-target OTA staging, compatibility block, handoff, recovery | Planned |
| 3 | OTA | Mechanism validation | Mobile host shell + runtime payload | Synthetic mobile-target staging, blocked activation when host shell is too old | Planned |
| 4 | Module | Mechanism validation | Generic module lifecycle | Synthetic module discovery, verification, staging, admission, cutover, rollback | Planned |
| 5 | Module | Mechanism validation | Cross-host artifact availability | Non-executing hosts serve artifacts to execution-compatible hosts | Planned |
| 6 | OTA | Candidate-release rehearsal | Specific Aura runtime release | Candidate runtime release staged and rehearsed before promotion/cutover | Planned |
| 7 | Module | Candidate-release rehearsal | Specific module release | Candidate module release staged and rehearsed before promotion/cutover | Planned |
| 8 | Example module | Candidate-release rehearsal | Browser-extension host | Candidate Example module release exercised end to end before promotion | Planned |
| 9 | OTA | Promotion gate | Release operation | Real cutover remains blocked until rehearsal passes | Planned |
| 10 | Module | Promotion gate | Release operation | Real publication/activation remains blocked until rehearsal passes | Planned |
This matrix should remain typed-lifecycle driven. It should not be satisfied by log scraping or ad hoc manual release notes.
Typed Release Validation Contract
Each planned release/update row above must map to a typed harness contract before it is counted as implemented.
| Coverage Entry | Typed command/control surface | Typed lifecycle evidence | Primary lane |
|---|---|---|---|
| OTA mechanism validation | PublishSyntheticOtaRelease, StageOtaCandidate, TriggerBootloaderHandoff, ConfirmCandidateHealth, RollbackOtaCandidate | OtaReleasePublished, OtaArtifactAvailable, OtaStaged, OtaCompatibilityBlocked, OtaCandidateLaunched, OtaHealthConfirmed, OtaRolledBack | Shared semantic lane |
| OTA candidate-release rehearsal | PublishCandidateOtaRelease, StageOtaCandidate, ApproveOtaCutover, ConfirmCandidateHealth, RollbackOtaCandidate | OtaCandidatePublished, OtaStaged, OtaPromotionStateChanged, OtaCandidateLaunched, OtaHealthConfirmed, OtaRehearsalPassed | Shared semantic lane |
| Module mechanism validation | PublishSyntheticModuleRelease, StageModuleCandidate, PrepareModuleAdmission, CommitModuleCutover, RollbackModuleCutover | ModuleReleasePublished, ModuleArtifactAvailable, ModuleVerified, ModuleStaged, ModuleAdmissionPrepared, ModuleCutoverCommitted, ModuleRolledBack | Shared semantic lane |
| Module candidate-release rehearsal | PublishCandidateModuleRelease, StageModuleCandidate, ApproveModuleCutover, CommitModuleCutover, RollbackModuleCutover | ModuleCandidatePublished, ModuleStaged, ModulePromotionStateChanged, ModuleCutoverCommitted, ModuleHealthConfirmed, ModuleRehearsalPassed | Shared semantic lane |
These rows are intentionally semantic-lane requirements. Frontend-conformance coverage may validate renderer wiring for release screens or controls, but it does not satisfy release/update lifecycle coverage on its own.
Coverage Expectations
Shared Flow Contract Expectations
Every parity-critical shared flow should have, in code and metadata:
- a canonical shared flow identifier in
aura-app::ui_contract - a typed semantic command path on both TUI and web
- semantic action contracts with preconditions and terminal success/failure conditions
- an authoritative readiness, event, or quiescence owner for waits
- any parity exception recorded as typed metadata in
aura-app::ui_contractwith a reason code, scope, affected surface, and authoritative doc reference - at least one canonical scenario reference in this report
Shared-flow scenarios must not rely on raw PTY keys, raw selector clicks, raw label matching, or incidental focus-stepping as their primary mechanics. Those behaviors belong in frontend-conformance coverage instead.
Frontend-specific flows may still have scenario coverage, but they are not part of the portability contract unless explicitly promoted into the shared contract.
PR Gate Expectations
- Changes to global navigation, settings, chat, contacts, neighborhood, or ceremonies should have at least one impacted canonical scenario updated or re-validated.
- Changes that affect both TUI and web behavior should be validated against parity-critical scenarios in the shared semantic lane on both runtimes.
- Changes to mixed-instance behavior should include scenario 12 and/or 13 coverage.
- Contacts-surface changes that alter relationship state or action availability must preserve the shared semantic lifecycle for
contact,pending_outbound,pending_inbound, andfriend, and they must stay anchored to Scenario 13 rather than shell-specific smoke coverage. - Mixed-runtime code exchange and chat routing changes should preserve the event-driven contract used by scenarios 12 and 13: invitation/device codes come from typed runtime-event payloads, and chat assertions bind to the selected shared channel rather than frontend-specific ordering.
- Browser shared-flow bridge changes should preserve the explicit runtime identity staging handoff and the page-owned semantic command queue used by the Playwright lane. Coverage remains anchored in the shared semantic scenarios rather than DOM-driving fallback mechanics.
- Changes to renderer-specific control wiring should add or update frontend-conformance coverage rather than weakening the shared semantic lane.
- Browser bootstrap broker credential changes must preserve the rule that bearer and invitation retrieval tokens are not URL parameters, and should update frontend-conformance tests or documentation when the storage boundary changes.
- Changes to OTA or module release/update architecture should update the planned release/update matrix above when they add, remove, or reorder mechanism-validation or release-rehearsal coverage.
CI Enforcement
Fast CI currently uses two separate gates:
just ci-user-flow-coverageenforces traceability heuristics between changed user flow-facing source files, canonical scenarios, and this reportAURA_ALLOW_FLOW_COVERAGE_SKIP=1is a local-only escape hatch. CI rejects it.just ci-user-flow-policyenforces documentation and contributor-guidance updates for shared user flow contract and determinism surfaces via Aura'stoolkit/xtaskuser-flow guidance sync check- OTA and module release/update validation rows in this report are part of that same user-flow guidance surface and must be kept in sync as the release matrix evolves
- The release/update rows are expected to land in staged order: mechanism validation first, candidate rehearsal second, and promotion-gate coverage last
just ci-harness-matrix-inventoryenforces that scenario classification drives the TUI/web matrix lanes- shared semantic scenarios and frontend-conformance scenarios are expected to remain distinct classifications. CI policy should reject shared-flow drift back to renderer-driven mechanics.
Current limitation:
ci-user-flow-coveragestill infers some ownership from filenames and does not yet prove that the correct scenario set changed- docs updates and coverage traceability are distinct concerns. This report should not claim stronger behavioral enforcement than CI actually provides.
Residual Risk Areas
| Area | Current Risk | Mitigation Direction |
|---|---|---|
| Long-tail modal sequencing | Medium | Add focused scenario fragments for rare wizard branch paths |
| Toast timing/race windows | Medium | Prefer persistent-state assertions over toast-only checks |
| Cross-topology regressions | Medium | Keep mixed-topology smoke scenarios in scheduled lanes |
References
- Testing Guide
toolkit/xtaskuser-flow guidance sync check- Simulation Guide
- Verification Coverage Report
- Project Structure
Noninteractive native startup provider coverage
LAN tooling explicitly configures filesystem secure storage for isolated
production harness profiles; runtime admission retains the harness requirement.
Required driver fixtures verify that configuration reaches the child process
and reject requests after shutdown. Platform retrieval unit coverage verifies
exact-location missing-record classification and retained native provider
failures without touching OS credentials. TUI account reload must retain native
agent causes and reach authoritative ready/settled state after account creation;
compile success and the pre-reload success operation alone are insufficient.
See docs/804_testing_guide.md for the provider and live-run procedure.
Renderer visibility coverage adds first-producer onboarding observations from actual native canvas drawing and browser registered-node/post-flush rendering. Required regressions cover hidden/zero-clipped layout, disposal, same-semantic source rerender/remount, stale capture refusal, final AppCore source mismatch, and duplicate control-instance preservation. These regression declarations are source-only until the native/browser gates execute; paired LAN control visibility and the remaining complete control inventory remain unproven.
Modal focus observation retains the exact canonical ControlId::Field(FieldId)
from the active modal field. A generic modal-input identity cannot replace that
field and focus does not prove rendered visibility. The unused invitation-type
list/field and generic modal-input wire variants are removed with their raw-key
selector/fallback paths; no compatibility decoder remains. Actual native and
shared UI snapshot regressions cover all four contact-invitation fields. These
are local observation checks, not paired-client business completion evidence.
Verification Coverage Report
This document provides an overview of the formal verification, model checking, and conformance testing infrastructure in Aura.
Verification Boundary Statement
Aura keeps consensus and CRDT domain proof ownership in Quint models and Lean theorems. Telltale parity lanes validate runtime conformance behavior from replay artifacts. Telltale parity success does not count as new domain theorem coverage. See Formal Verification Reference for the assurance classification and limits.
Summary Metrics
| Metric | Count |
|---|---|
| Quint Specifications | 42 |
| Quint Invariants | 191 |
| Quint Temporal Properties | 11 |
| Quint Type Definitions | 362 |
| Lean Source Files | 38 |
| Lean Theorems | 118 |
| Conformance Fixtures | 4 |
| ITF Trace Harnesses | 9 |
| Testkit Tests | 118 |
| Bridge Modules | 4 |
| CI Verification Gates | 11 |
| Telltale Parity Modules | 1 |
| Bridge Pipeline Fixtures | 3 |
Verification Layers
Layer 1: Quint Specifications
Formal protocol specifications in verification/quint/ organized by subsystem.
| Subsystem | Files | Contents |
|---|---|---|
| Root | 11 | core, authorization, recovery, invitation, interaction, leakage, sbb, time_system, transport, epochs, cli_recovery_demo |
| consensus/ | 4 | core, liveness, adversary, frost |
| journal/ | 3 | core, counter, anti_entropy |
| keys/ | 3 | dkg, dkd, resharing |
| sessions/ | 4 | core, choreography, groups, locking |
| amp/ | 1 | channel |
| liveness/ | 3 | connectivity, timing, properties |
| harness/ | 9 | amp_channel, counter, dkg, flows, groups, locking, recovery, resharing, semantic_observation_smoke |
| tui/ | 4 | demo_recovery, flows, signals, state |
Harness modules generate ITF traces on demand via just quint-generate-traces. Traces are not checked into the repository. CI runs just ci-conformance-itf to generate traces and replay them through Rust handlers.
Key Specifications
| Specification | Purpose | Key Properties |
|---|---|---|
consensus/core.qnt | Fast-path consensus protocol | UniqueCommitPerInstance, CommitRequiresThreshold, EquivocatorsExcluded |
consensus/liveness.qnt | Progress guarantees | ProgressUnderSynchrony, RetryBound, CommitRequiresHonestParticipation |
consensus/adversary.qnt | Byzantine tolerance | ByzantineThreshold, EquivocationDetected, HonestMajorityCanCommit |
consensus/frost.qnt | Threshold signatures | Share aggregation, commitment validation |
journal/core.qnt | CRDT journal semantics | NonceUnique, FactsOrdered, NonceMergeCommutative, LamportMonotonic |
journal/anti_entropy.qnt | Sync protocol | FactsMonotonic, EventualConvergence, VectorClockConsistent |
authorization.qnt | Guard chain security | NoCapabilityWidening, ChargeBeforeSend |
time_system.qnt | Timestamp ordering | TimeStamp domain semantics and comparison |
Layer 2: Rust Integration
Files implementing Quint-Rust correspondence and model-based testing.
Core Integration (aura-core)
effects/quint.rs-QuintMappabletrait for bidirectional type mappingeffects/mod.rs- Effect trait definitions with Quint correspondence
Quint Crate (aura-quint)
runner.rs-QuintRunnerwith property caching and verification statisticsproperties.rs-PropertySpec,PropertySuite, and property categorizationevaluator.rs-QuintEvaluatorsubprocess wrapper for Quint CLIhandler.rs- Effect handler integration
Telltale Bridge (aura-quint)
Cross-validation modules for Lean↔Quint correspondence:
| Module | Purpose |
|---|---|
bridge_export.rs | Export Quint state to Lean-readable format |
bridge_import.rs | Import Lean outputs back to Quint structures |
bridge_format.rs | Shared serialization format definitions |
bridge_validate.rs | Cross-validation assertions and checks |
Simulator Integration (aura-simulator/src/quint/)
17 modules implementing generative simulation:
| Module | Purpose |
|---|---|
action_registry.rs | Maps Quint action names to Rust handlers |
state_mapper.rs | Bidirectional state conversion (Rust <-> Quint JSON) |
generative_simulator.rs | Orchestrates ITF trace replay with property checking |
itf_loader.rs | Parses ITF traces from Quint model checking |
itf_fuzzer.rs | Model-based fuzzing with coverage analysis |
trace_converter.rs | Converts between trace formats |
simulation_evaluator.rs | Evaluates properties during simulation |
properties.rs | Property extraction and classification |
domain_handlers.rs | Domain-specific action handlers |
amp_channel_handlers.rs | AMP reliable channel handlers |
byzantine_mapper.rs | Byzantine fault strategy mapping |
chaos_generator.rs | Chaos/fault scenario generation |
aura_state_extractors.rs | Aura-specific state extraction |
cli_runner.rs | CLI integration for Quint verification |
ast_parser.rs | Quint AST parsing for analysis |
mod.rs | Module exports and re-exports |
types.rs | Shared type definitions |
Differential Verification (aura-simulator)
differential_tester.rs- Cross-implementation parity testing between Quint models and Rust handlerstelltale_parity.rs- Telltale-backed parity boundary, canonical surface mapping, and report artifact generation
Consensus Verification (aura-consensus)
core/verification/mod.rs- Verification module facadecore/verification/quint_mapping.rs- Consensus type mappings
Layer 3: Lean Proofs
Lean 4 mathematical proofs in verification/lean/ providing formal guarantees.
Type Modules (10 files)
| Module | Content |
|---|---|
Types/ByteArray32.lean | 32-byte hash representation (6 theorems) |
Types/OrderTime.lean | Opaque ordering tokens (4 theorems) |
Types/TimeStamp.lean | 4-variant time enum |
Types/FactContent.lean | Structured fact types |
Types/ProtocolFacts.lean | Protocol-specific fact types |
Types/AttestedOp.lean | Attested operation types |
Types/TreeOp.lean | Tree operation types |
Types/Namespace.lean | Authority/Context namespaces |
Types/Identifiers.lean | Identifier types |
Types.lean | Type module aggregation |
Domain Modules (9 files)
| Module | Purpose |
|---|---|
Domain/Consensus/Types.lean | Consensus message types (8 definitions) |
Domain/Consensus/Frost.lean | FROST signature types |
Domain/Journal/Types.lean | Fact and Journal structures |
Domain/Journal/Operations.lean | merge, reduce, factsEquiv (1 theorem) |
Domain/FlowBudget.lean | Budget types and charging |
Domain/GuardChain.lean | Guard types and evaluation |
Domain/TimeSystem.lean | Timestamp comparison |
Domain/KeyDerivation.lean | Key derivation types |
Domain/ContextIsolation.lean | Context isolation model |
Proof Modules (14 files, 118 theorems)
Consensus Proofs
| Module | Theorems | Content |
|---|---|---|
Proofs/Consensus/Agreement.lean | 3 | No two honest parties commit different values |
Proofs/Consensus/Validity.lean | 7 | Only valid proposals can be committed |
Proofs/Consensus/Equivocation.lean | 5 | Detection soundness and completeness |
Proofs/Consensus/Evidence.lean | 8 | Evidence CRDT semilattice properties |
Proofs/Consensus/Frost.lean | 12 | FROST share aggregation safety |
Proofs/Consensus/Liveness.lean | 3 | Progress under timing assumptions (axioms) |
Proofs/Consensus/Adversary.lean | 7 | Byzantine model bounds |
Proofs/Consensus/Summary.lean | - | Master consensus claims bundle |
Infrastructure Proofs
| Module | Theorems | Content |
|---|---|---|
Proofs/Journal.lean | 14 | CRDT semilattice (commutativity, associativity, idempotence) |
Proofs/FlowBudget.lean | 5 | Charging correctness |
Proofs/GuardChain.lean | 7 | Guard evaluation determinism |
Proofs/TimeSystem.lean | 8 | Timestamp ordering properties |
Proofs/KeyDerivation.lean | 3 | PRF isolation proofs |
Proofs/ContextIsolation.lean | 16 | Context separation and bridge authorization |
Entry Points (4 files)
Aura.lean- Top-level documentationAura/Proofs.lean- Main reviewer entry with all Claims bundlesAura/Assumptions.lean- Cryptographic axioms (FROST unforgeability, hash collision resistance, PRF security)Aura/Runner.lean- CLI for differential testing
Layer 4: Conformance Testing
Deterministic parity validation infrastructure in aura-testkit.
Conformance Fixtures
| Fixture | Purpose |
|---|---|
consensus.json | Consensus protocol conformance |
sync.json | Synchronization protocol conformance |
recovery.json | Guardian recovery conformance |
invitation.json | Invitation protocol conformance |
Conformance Modules
| Module | Purpose |
|---|---|
conformance.rs | Artifact loading, replay, and verification |
conformance_diff.rs | Law-aware comparison with envelope classifications |
Effect Envelope Classifications
| Class | Effect Kinds | Comparison Rule |
|---|---|---|
strict | handle_recv, handle_choose, handle_acquire, handle_release | Byte-exact match required |
commutative | send_decision, invoke_step | Order-insensitive under normalization |
algebraic | topology_event | Reduced via domain-normal form |
Verified Invariants
Consensus Invariants
| Invariant | Location |
|---|---|
InvariantUniqueCommitPerInstance | consensus/core.qnt |
InvariantCommitRequiresThreshold | consensus/core.qnt |
InvariantCommittedHasCommitFact | consensus/core.qnt |
InvariantEquivocatorsExcluded | consensus/core.qnt |
InvariantProposalsFromWitnesses | consensus/core.qnt |
InvariantProgressUnderSynchrony | consensus/liveness.qnt |
InvariantRetryBound | consensus/liveness.qnt |
InvariantCommitRequiresHonestParticipation | consensus/liveness.qnt |
InvariantQuorumPossible | consensus/liveness.qnt |
InvariantByzantineThreshold | consensus/adversary.qnt |
InvariantEquivocationDetected | consensus/adversary.qnt |
InvariantCompromisedNoncesExcluded | consensus/adversary.qnt |
InvariantHonestMajorityCanCommit | consensus/adversary.qnt |
Journal Invariants
| Invariant | Location |
|---|---|
InvariantNonceUnique | journal/core.qnt |
InvariantFactsOrdered | journal/core.qnt |
InvariantFactsMatchNamespace | journal/core.qnt |
InvariantLifecycleCompletedImpliesStable | journal/core.qnt |
InvariantNonceMergeCommutative | journal/core.qnt |
InvariantLamportMonotonic | journal/core.qnt |
InvariantReduceDeterministic | journal/core.qnt |
InvariantPhaseRegistered | journal/counter.qnt |
InvariantCountersRegistered | journal/counter.qnt |
InvariantLifecycleStatusDefined | journal/counter.qnt |
InvariantOutcomeWhenCompleted | journal/counter.qnt |
InvariantFactsMonotonic | journal/anti_entropy.qnt |
InvariantFactsSubsetOfGlobal | journal/anti_entropy.qnt |
InvariantVectorClockConsistent | journal/anti_entropy.qnt |
InvariantEventualConvergence | journal/anti_entropy.qnt |
InvariantDeltasFromSource | journal/anti_entropy.qnt |
InvariantCompletedSessionsConverged | journal/anti_entropy.qnt |
Temporal Properties
| Property | Location |
|---|---|
livenessEventualCommit | consensus/core.qnt |
safetyImmutableCommit | consensus/core.qnt |
authorizationSoundness | authorization.qnt |
budgetMonotonicity | authorization.qnt |
flowBudgetFairness | authorization.qnt |
canAlwaysExit | tui/state.qnt |
modalEventuallyCloses | tui/state.qnt |
insertModeEventuallyExits | tui/state.qnt |
InvariantLeakageBounded | leakage.qnt |
InvariantObserverHierarchyMaintained | leakage.qnt |
InvariantBudgetsPositive | leakage.qnt |
Contract Coverage Mapping
This section maps the contract clauses in Privacy and Information Flow Contract and Distributed Systems Contract to the current verification and assurance evidence.
Coverage status uses three classes:
Verified: directly covered by Quint invariants, Lean proofs, or bothConformance-backed: covered by replay, parity, or deterministic conformance lanes rather than domain theorem proofsSpecified only: documented as a contract requirement, but not yet directly mapped to a proof or conformance artifact in this report
Privacy and Information Flow Contract Coverage
| Contract Area | Status | Evidence |
|---|---|---|
| Context-specific identity separation | Verified | Aura.Proofs.KeyDerivation, Aura.Proofs.ContextIsolation |
| Budgeted send invariant | Verified | authorization.qnt, transport.qnt, Aura.Proofs.FlowBudget, Aura.Proofs.GuardChain |
| Epoch-scoped receipt validity | Verified | epochs.qnt |
| Observer-budgeted metadata leakage | Verified | leakage.qnt |
| Cross-context isolation | Verified | Aura.Proofs.ContextIsolation, transport.qnt |
| Physical vs logical time privacy boundary | Verified | time_system.qnt, Aura.Proofs.TimeSystem |
| Error-channel privacy boundary | Specified only | No direct proof or conformance mapping recorded here |
| Retrieval not identity-addressed | Conformance-backed | crates/aura-simulator/tests/adaptive_privacy_phase_six.rs, selector-based Hold retrieval scenarios |
| Custody remains opaque and non-authoritative | Conformance-backed | crates/aura-simulator/tests/adaptive_privacy_phase_six.rs, Hold custody and cache-replica validation |
| Accountability evidence verified before local consequences | Conformance-backed | crates/aura-simulator/tests/adaptive_privacy_phase_six.rs, reply-block accountability control-plane lanes |
| External observer protection level varies by deployment mode | Specified only | No direct proof or conformance mapping recorded here |
Distributed Systems Contract Coverage
| Contract Area | Status | Evidence |
|---|---|---|
| Journal CRDT laws | Verified | journal/core.qnt, Aura.Proofs.Journal |
| Consensus agreement and validity | Verified | consensus/core.qnt, Aura.Proofs.Consensus.Agreement, Aura.Proofs.Consensus.Validity |
| Fault-bound consensus safety assumptions | Verified | consensus/adversary.qnt, Aura.Proofs.Consensus.Adversary |
| Evidence CRDT laws | Verified | Aura.Proofs.Consensus.Evidence |
| Equivocation detection | Verified | consensus/adversary.qnt, Aura.Proofs.Consensus.Equivocation |
| FROST threshold safety | Verified | consensus/frost.qnt, Aura.Proofs.Consensus.Frost |
| Context isolation | Verified | transport.qnt, Aura.Proofs.ContextIsolation |
| Anti-entropy convergence | Verified | journal/anti_entropy.qnt |
| Fast-path and fallback liveness under assumptions | Verified | consensus/liveness.qnt, Aura.Proofs.Consensus.Liveness |
| Invitation lifecycle safety | Verified | invitation.qnt |
| Cross-protocol deadlock freedom | Verified | interaction.qnt |
| Operation-scoped and journal consistency model | Verified | journal/core.qnt, journal/anti_entropy.qnt, consensus/core.qnt |
| Runtime conformance against formal artifacts | Conformance-backed | ITF trace replay, Telltale parity, conformance fixtures |
| Onion accountability witness return and verification | Conformance-backed | Simulator Telltale parity and reply_block_accountability control-plane scenarios |
| Hold availability and custody-failure boundaries | Conformance-backed | crates/aura-simulator/tests/adaptive_privacy_phase_six.rs, weak-connectivity and sparse-sync Hold scenarios |
| Failure-class boundaries and local-only failure | Specified only | No direct proof or conformance mapping recorded here |
| Error-channel privacy requirements | Specified only | No direct proof or conformance mapping recorded here |
CI Verification Gates
Automated verification lanes wired into CI pipelines.
Core Verification
| Gate | Command | Purpose |
|---|---|---|
| Property Monitor | just ci-property-monitor | Runtime property assertion monitoring |
| Simulator Telltale Parity | just ci-simulator-telltale-parity | Artifact-driven telltale vs Aura simulator differential comparison |
| Choreography Parity | just ci-choreo-parity | Session type projection consistency |
| Quint Typecheck | just ci-quint-typecheck | Quint specification type safety |
Conformance Gates
| Gate | Command | Purpose |
|---|---|---|
| Conformance Policy | just ci-conformance-policy | Policy rule validation |
| Conformance Contracts | just ci-conformance-contracts | Contract satisfaction checks |
Formal Methods
| Gate | Command | Purpose |
|---|---|---|
| Lean Build | just ci-lean-build | Compile Lean proofs |
| Lean Completeness | just ci-lean-check-sorry | Check for incomplete proofs (sorry) |
| Telltale Bridge | just ci-telltale-bridge | Cross-validation between Lean and Quint |
| Kani BMC | just ci-kani | Bounded model checking for unsafe code |
CI Artifacts
Conformance artifacts upload to CI for failure triage:
artifacts/conformance/
├── native_coop/
│ └── scenario_seed_artifact.json
├── wasm_coop/
│ └── scenario_seed_artifact.json
└── diff_report.json
The diff report highlights specific mismatches for investigation.
Telltale parity and bridge lanes emit additional artifacts:
artifacts/telltale-parity/
└── report.json
artifacts/telltale-bridge/
├── bridge.log
├── bridge_discrepancy_report.json
└── report.json
artifacts/telltale-parity/report.json uses schema aura.telltale-parity.report.v1.
artifacts/telltale-bridge/bridge_discrepancy_report.json uses schema aura.telltale-bridge.discrepancy.v1.
Bridge Pipeline Fixtures
aura-quint bridge pipeline checks use deterministic fixture inputs:
| Fixture | Purpose |
|---|---|
positive_bundle.json | Expected consistent cross-validation outcome |
negative_bundle.json | Expected discrepancy detection outcome |
quint_ir_fixture.json | Export/import pipeline coverage for Quint IR |
Fixtures live in crates/aura-quint/tests/fixtures/bridge/.
Related Documentation
- Formal Verification Reference - Architecture and specification patterns
- Verification and MBT Guide - Practical verification workflows
- Simulation Infrastructure Reference - Generative simulation details
- Testing Guide - Testing infrastructure and conformance testing
Project Structure
This document provides the authoritative reference for Aura's crate organization, dependencies, and development policies.
The primary specifications live in docs/ (e.g., consensus in docs/108_consensus.md, ceremony lifecycles in docs/109_operation_categories.md). Non-authoritative scratch notes may be removed at any time.
The repo-wide ownership taxonomy is defined in Ownership Model. This document specifies how those ownership rules map onto Aura's crate and layer structure.
8-Layer Architecture
Aura's codebase is organized into 8 clean architectural layers. Each layer builds on the layers below without circular dependencies.
┌────────────────────────────────────────────────────┐
│ Layer 8: Testing & Development Tools │
│ • aura-testkit • aura-quint • aura-harness │
├────────────────────────────────────────────────────┤
│ Layer 7: User Interface │
│ • aura-terminal • aura-ui • aura-web │
├────────────────────────────────────────────────────┤
│ Layer 6: Runtime Composition │
│ • aura-agent • aura-simulator • aura-app │
├────────────────────────────────────────────────────┤
│ Layer 5: Feature/Protocol Implementation │
│ • aura-authentication • aura-chat │
│ • aura-invitation • aura-recovery │
│ • aura-relational • aura-rendezvous │
│ • aura-sync • aura-social │
├────────────────────────────────────────────────────┤
│ Layer 4: Orchestration │
│ • aura-protocol • aura-guards │
│ • aura-consensus • aura-amp │
│ • aura-anti-entropy │
├────────────────────────────────────────────────────┤
│ Layer 3: Implementation │
│ • aura-effects • aura-composition │
├────────────────────────────────────────────────────┤
│ Layer 2: Specification │
│ Domain Crates: │
│ • aura-journal • aura-authorization │
│ • aura-signature • aura-store │
│ • aura-transport • aura-maintenance │
│ Choreography: │
│ • aura-mpst • aura-macros │
├────────────────────────────────────────────────────┤
│ Layer 1: Foundation │
│ • aura-core │
└────────────────────────────────────────────────────┘
Repo-Wide Ownership Categories
Pinned external runtime dependency
Telltale packages are pinned to crates.io release 17.0.1, which includes the
required session lifecycle APIs. They are external dependencies and do not add
an Aura architectural layer. No local protocol-machine override is needed.
Dependency changes must preserve upstream attribution, regenerate Cargo.nix,
and run dependency lifecycle regressions as well as Aura adapter tests described
in Testing Guide.
Aura uses four ownership categories:
PureMoveOwnedActorOwnedObserved
These categories are architectural, not stylistic.
Purecode is deterministic and effect-free.MoveOwnedcode represents exclusive authority through consumed values such as handles, owner tokens, and transfer records.ActorOwnedcode owns long-lived mutable async state under one live task or supervisor.Observedcode reads authoritative state and may submit typed commands, but must not author semantic truth.
Two repo-wide rules apply across every layer:
- Parity-critical mutation and publication must be capability-gated.
- Parity-critical operations must end in typed terminal success, failure, or cancellation.
For Layer 6 runtime code this means:
aura-agentowns the production structured-concurrency model- long-lived runtime services use actor-owned bounded ingress
- session/delegation/fragment transfer stays move-owned even when hosted by runtime services
- raw task spawn is implementation detail inside the sanctioned supervisor boundary, not a public runtime programming model
If a parity-critical subsystem cannot explain who owns state, how ownership is transferred, and how failure terminates, the architecture is incomplete.
Layer 1: Foundation (aura-core)
Purpose: Single source of truth for all domain concepts and interfaces.
Contains:
- Effect traits for core infrastructure, authentication, storage, network, cryptography, privacy, configuration, and testing
- Domain types:
AuthorityId,ContextId,SessionId,FlowBudget,ObserverClass,Capability - Cryptographic utilities: key derivation, FROST types, merkle trees, Ed25519 helpers
- Semantic traits:
JoinSemilattice,MeetSemilattice,CvState,MvState - Error types:
AuraError, error codes, and guard metadata - Configuration system with validation and multiple formats
- Causal context types for CRDT ordering
- AMP channel lifecycle effect surface:
aura-core::effects::amp::AmpChannelEffects(implemented by runtime, simulator, and testkit mocks).
Key principle: Interfaces only, no implementations or business logic.
Ownership expectation:
- primarily
Pure - defines the shared ownership, capability, and terminality vocabulary used by higher layers
- does not own long-lived mutable runtime state
- provides capability-gated boundaries rather than bypassing them
- the canonical ownership/runtime API lives in
aura-core::ownershipand is explicitly split intoactor_owned::*,move_owned::*, andcapability_gated::*
Exceptions:
-
Extension traits providing convenience methods are allowed (e.g.,
LeakageChoreographyExt,SimulationEffects,AuthorityRelationalEffects). These blanket implementations extend existing effect traits with domain-specific convenience methods while maintaining interface-only semantics. -
Arc
blanket implementations for effect traits are required in aura-core due to Rust's orphan rules. These are not "runtime instantiations" - they are purely mechanical delegations that enableArc<AuraEffectSystem>to satisfy trait bounds. Example:#![allow(unused)] fn main() { impl<T: CryptoEffects + ?Sized> CryptoEffects for std::sync::Arc<T> { async fn ed25519_sign(&self, msg: &[u8], key: &[u8]) -> Result<Vec<u8>, CryptoError> { (**self).ed25519_sign(msg, key).await // Pure delegation } } }Arcis a language-level primitive (likeVec,Box, or&), not a "runtime" in the architectural sense. These implementations add no behavior or state. They simply say "if T can do X, then Arccan too by asking T." Without these, any handler wrapped in Arcwould fail to satisfy effect trait bounds, breaking the entire dependency injection pattern.
Architectural compliance: aura-core maintains strict interface-only semantics. Test utilities like MockEffects are provided in aura-testkit (Layer 8) where they architecturally belong.
Dependencies: None (foundation crate).
Commitment Tree Types and Functions
Location: aura-core/src/tree/
Contains:
- Core tree types:
TreeOp,AttestedOp,Policy,LeafNode,BranchNode,BranchSigningKey,TreeCommitment,Epoch - Commitment functions:
commit_branch(),commit_leaf(),policy_hash(),compute_root_commitment() - Policy meet-semilattice implementation for threshold refinement
- Snapshot types:
Snapshot,Cut,ProposalId,Partial - Verification module:
verify_attested_op()(cryptographic),check_attested_op()(state consistency),compute_binding_message()
Why Layer 1?
Commitment tree types MUST remain in aura-core because:
- Effect traits require them:
TreeEffectsandSyncEffectsinaura-core/src/effects/use these types in their signatures - FROST primitives depend on them:
aura-core/src/crypto/tree_signing.rsimplements threshold signing over tree operations - Authority abstraction needs them:
aura-core/src/authority.rsusesPolicy,AttestedOp, andTreeOpKind - Foundational cryptographic structures: Commitment trees are merkle trees with threshold policies - core cryptographic primitives, not domain logic
Layer 2 separation (aura-journal) contains:
- Tree state machine: Full
TreeStatewith branches, leaves, topology, and path validation - Reduction logic: Deterministic state derivation from
OpLog<AttestedOp> - Domain validation: Business rules for tree operations (e.g., policy monotonicity, leaf lifecycle)
- Application logic:
apply_verified(), compaction, garbage collection - Re-exports:
pub use aura_core::tree::*for convenience viaaura_journal::commitment_tree
Key architectural distinction:
- Layer 1 (
aura-core): Tree types and cryptographic commitment functions (pure primitives) - Layer 2 (
aura-journal): Tree state machine, CRDT semantics, and validation rules (domain implementation)
This separation allows effect traits in Layer 1 to reference tree types without creating circular dependencies, while keeping the stateful CRDT logic in the appropriate domain crate.
Layer 2: Specification (Domain Crates and Choreography)
Purpose: Define domain semantics and protocol specifications.
Ownership expectation:
- default to
Pure - use
MoveOwnedonly when transfer semantics are part of the domain model - avoid
ActorOwnedruntime-style state - expose typed results and typed domain failures rather than implicit failure
Layer 2 Architecture Diff (Invariants)
Layer 2 is the specification layer: pure domain semantics with zero runtime coupling.
Must hold:
- No handler composition, runtime assembly, or UI dependencies.
- Domain facts are versioned and encoded via canonical DAG-CBOR.
- Fact reducers register through
FactRegistry. No direct wiring inaura-journal. - Authorization scopes use
aura-coreResourceScopeand typed operations. - No in-memory production state. Stateful test handlers live in
aura-testkit.
Forbidden:
- Direct OS access (time, fs, network) outside effect traits.
- Tokio/async-std usage in domain protocols.
- State-bearing singletons or process-wide caches.
Domain Crates
| Crate | Domain | Responsibility |
|---|---|---|
aura-journal | Fact-based journal | CRDT semantics, tree state machine, reduction logic, validation (re-exports tree types from aura-core) |
aura-authorization | Trust and authorization | Capability refinement, Biscuit token helpers |
aura-signature | Identity semantics | Signature verification, device lifecycle |
aura-store | Storage domain | Storage types, capabilities, domain logic |
aura-transport | Transport semantics | P2P communication abstractions |
aura-maintenance | Maintenance facts | Snapshot, cache invalidation, OTA activation, admin replacement facts + reducer |
Key characteristics: Implement domain logic without effect handlers or coordination.
Extensible Fact Types (aura-journal)
The journal provides generic fact infrastructure that higher-level crates extend with domain-specific fact types. This follows the Open/Closed Principle: the journal is open for extension but closed for modification.
Protocol-Level vs Domain-Level Facts
The RelationalFact enum in aura-journal/src/fact.rs contains two categories:
Protocol-Level Facts (stay in aura-journal):
These are core protocol constructs with complex reduction logic in reduce_context(). They have interdependencies and specialized state derivation that cannot be delegated to simple domain reducers:
| Fact | Purpose | Why Protocol-Level |
|---|---|---|
Protocol(GuardianBinding) | Guardian relationship | Core recovery protocol |
Protocol(RecoveryGrant) | Recovery capability | Core recovery protocol |
Protocol(Consensus) | Aura Consensus results | Core agreement mechanism |
Protocol(AmpChannelCheckpoint) | Ratchet window anchoring | Complex epoch state computation |
Protocol(AmpProposedChannelEpochBump) | Optimistic epoch transitions | Spacing rules, bump selection |
Protocol(AmpCommittedChannelEpochBump) | Finalized epoch transitions | Epoch chain validation |
Protocol(AmpChannelPolicy) | Channel policy overrides | Skip window derivation |
Domain-Level Facts (via Generic + FactRegistry):
Application-specific facts use RelationalFact::Generic and are reduced by registered FactReducer implementations.
| Domain Crate | Fact Type | Purpose |
|---|---|---|
aura-chat | ChatFact | Channels, messages |
aura-invitation | InvitationFact | Invitation lifecycle |
aura-relational | ContactFact | Contact management |
aura-social/moderation | Block*Fact | Block, mute, ban, kick |
Design Pattern:
-
aura-journalprovides:DomainFacttrait for fact type identity and serializationFactReducertrait for domain-specific reduction logicFactRegistryfor runtime fact type registrationRelationalFact::Genericas the extensibility mechanism
-
Domain crates implement:
- Their own typed fact enums (e.g.,
ChatFact,InvitationFact) DomainFacttrait withto_generic()for storageFactReducerfor reduction toRelationalBinding
- Their own typed fact enums (e.g.,
-
aura-agent/src/fact_registry.rsregisters all domain reducers:#![allow(unused)] fn main() { pub fn build_fact_registry() -> FactRegistry { let mut registry = FactRegistry::new(); registry.register::<ChatFact>(CHAT_FACT_TYPE_ID, Box::new(ChatFactReducer)); registry.register::<InvitationFact>(INVITATION_FACT_TYPE_ID, Box::new(InvitationFactReducer)); registry.register::<ContactFact>(CONTACT_FACT_TYPE_ID, Box::new(ContactFactReducer)); register_moderation_facts(&mut registry); registry } }
Why This Architecture:
- Open/Closed Principle: New domain facts don't require modifying
aura-journal - Domain Isolation: Each crate owns its fact semantics
- Protocol Integrity: Core protocol facts with complex reduction stay in
aura-journal - Testability: Domain facts can be tested independently
- Type Safety: Compile-time guarantees within each domain
Core Fact Types in aura-journal:
Only facts fundamental to journal operation remain as direct enum variants:
AttestedOp: Commitment tree operations (cryptographic primitives)Snapshot: Journal compaction checkpointsRendezvousReceipt: Cross-authority coordination receipts- Protocol-level
RelationalFactvariants listed above
Fact Implementation Patterns by Layer
Aura uses two distinct fact patterns based on architectural layer to prevent circular dependencies:
Layer 2 Pattern (Domain Crates: aura-maintenance, aura-authorization, aura-signature, aura-store, aura-transport):
These crates use the aura-core::types::facts pattern with no dependency on aura-journal:
#![allow(unused)] fn main() { use aura_core::types::facts::{FactTypeId, FactError, FactEnvelope, FactDeltaReducer}; pub static MY_FACT_TYPE_ID: FactTypeId = FactTypeId::new("my_domain"); pub const MY_FACT_SCHEMA_VERSION: u16 = 1; impl MyFact { pub fn try_encode(&self) -> Result<Vec<u8>, FactError> { aura_core::types::facts::try_encode_fact( &MY_FACT_TYPE_ID, MY_FACT_SCHEMA_VERSION, self, ) } pub fn to_envelope(&self) -> Result<FactEnvelope, FactError> { // Create envelope manually for Generic wrapping } } impl FactDeltaReducer<MyFact, MyFactDelta> for MyFactReducer { fn apply(&self, fact: &MyFact) -> MyFactDelta { /* ... */ } } }
Layer 4/5 Pattern (Feature Crates: aura-chat, aura-invitation, aura-relational, aura-recovery, aura-social):
These crates use the aura-journal::extensibility::DomainFact pattern and register with FactRegistry:
#![allow(unused)] fn main() { use aura_journal::extensibility::{DomainFact, FactReducer}; use aura_macros::DomainFact; #[derive(DomainFact)] #[domain_fact(type_id = "my_domain", schema_version = 1, context_fn = "context_id")] pub enum MyFact { /* ... */ } impl FactReducer for MyFactReducer { fn handles_type(&self) -> &'static str { /* ... */ } fn reduce_envelope(...) -> Option<RelationalBinding> { /* ... */ } } }
Why Two Patterns?
- Layer 2 → Layer 2 dependencies create circular risk:
aura-journalis itself a Layer 2 crate. If other Layer 2 crates depend onaura-journalfor theDomainFacttrait, we risk circular dependencies. - Layer 4/5 can safely depend on Layer 2: Higher layers depend on lower layers by design, so feature crates can use the
DomainFacttrait fromaura-journal. - Registration location differs: Layer 2 facts are wrapped manually in
RelationalFact::Generic. Layer 4/5 facts register withFactRegistryinaura-agent/src/fact_registry.rs.
For a quick decision tree on pattern selection, see CLAUDE.md under "Agent Decision Aids".
Choreography Specification
aura-mpst: Aura-facing boundary crate over Telltale's public language,
runtime, and type surfaces. Re-exports choreography/runtime surfaces and Aura extension traits used by generated
protocols, VM artifacts, and testing utilities, including canonical
choreography capability parsing into validated CapabilityName values.
aura-macros: Compile-time choreography frontend. Parses Aura annotations
(guard_capability, flow_cost, journal_facts, leak), generates typed
first-party capability-family surfaces, and emits Telltale-backed generated
modules plus Aura effect-bridge helpers.
Layer 3: Implementation (aura-effects and aura-composition)
Purpose: Effect implementation and handler composition.
Ownership expectation:
aura-effectshandlers remain stateless by defaultaura-compositionmay assemble and configure systems, but should not grow ad hoc authority ownership or hidden semantic lifecycle- capability checks should flow through shared contracts, not handler-local shortcuts
aura-effects: Stateless Effect Handlers
Purpose: Stateless, single-party effect implementations.
aura-effects is the designated singular point of interaction with non-deterministic operating system services (entropy, wall-clock time, network I/O, file system). This design choice makes the architectural boundary explicit and centralizes impure operations.
Contains:
- Production handlers:
RealCryptoHandler,TcpTransportHandler,FilesystemStorageHandler,PhysicalTimeHandler - OS integration adapters that delegate to system services
- Pure functions that transform inputs to outputs without state
What doesn't go here:
- Handler composition or registries
- Multi-handler coordination
- Stateful implementations
- Mock/test handlers
Key characteristics: Each handler should be independently testable and reusable. No handler should know about other handlers. This enables clean dependency injection and modular testing.
Dependencies: aura-core and external libraries.
Note: Mock and test handlers are located in aura-testkit (Layer 8) to maintain clean separation between production and testing concerns.
aura-composition: Handler Composition
Purpose: Assemble individual handlers into cohesive effect systems.
Contains:
- Effect registry and builder patterns
- Handler composition utilities
- Effect system configuration
- Handler lifecycle management (start/stop/configure)
- Reactive infrastructure:
Dynamic<T>FRP primitives for composing view updates over effect changes
What doesn't go here:
- Individual handler implementations
- Multi-party protocol logic
- Runtime-specific concerns
- Application lifecycle
Key characteristics: Feature crates need to compose handlers without pulling in full runtime infrastructure. This is about "how do I assemble handlers?" not "how do I coordinate distributed protocols?"
Dependencies: aura-core, aura-effects.
Layer 4: Orchestration (aura-protocol and subcrates)
Purpose: Multi-party coordination and distributed protocol orchestration.
Ownership expectation:
- use
MoveOwnedfor delegation, session ownership, endpoint transfer, and stale-owner invalidation - use
ActorOwnedonly for justified long-lived orchestration state - coordination authority and semantic publication should be capability-gated
- async orchestration flows should have typed terminal outcomes
Contains:
- Guard chain coordination (
CapGuard → FlowGuard → JournalCoupler) inaura-guards - Multi-party protocol orchestration (consensus in
aura-consensus, anti-entropy inaura-anti-entropy) - Quorum-driven DKG orchestration and transcript handling in
aura-consensus/src/dkg/ - Cross-handler transport and storage coordination logic
- Distributed state management
- Stateful coordinators for multi-party protocols
What doesn't go here:
- Effect trait definitions (all traits belong in
aura-core) - Handler composition infrastructure (belongs in
aura-composition) - Single-party effect implementations (belongs in
aura-effects) - Test/mock handlers (belong in
aura-testkit) - Runtime assembly (belongs in
aura-agent) - Application-specific business logic (belongs in domain crates)
Key characteristics: This layer coordinates multiple handlers working together across network boundaries. It implements the "choreography conductor" pattern, ensuring distributed protocols execute correctly with proper authorization, flow control, and state consistency. All handlers here manage multi-party coordination, not single-party operations.
Dependencies: aura-core, aura-effects, aura-composition, aura-mpst, domain crates, and Layer 4 subcrates (aura-guards, aura-consensus, aura-amp, aura-anti-entropy). Performance-critical protocol operations may require carefully documented exceptions for direct cryptographic library usage.
Layer 5: Feature/Protocol Implementation
Purpose: Complete end-to-end protocol implementations.
Ownership expectation:
- feature workflows should have one authoritative semantic owner
- wrappers, adapters, and compatibility helpers must not publish stronger semantics than canonical workflows
- long-running feature operations need typed lifecycle and typed terminal failure
- parity-critical mutation/publication must be capability-gated
Crates:
| Crate | Protocol | Purpose |
|---|---|---|
aura-authentication | Authentication | Device, threshold, and guardian auth flows |
aura-chat | Chat | Chat domain facts and view reducers. Local chat prototype. |
aura-invitation | Invitations | Peer onboarding and relational facts |
aura-recovery | Guardian recovery | Recovery grants and dispute escalation |
aura-relational | Cross-authority relationships | RelationalContext protocols (domain types in aura-core) |
aura-rendezvous | Peer discovery | Context-scoped rendezvous and routing |
aura-social | Social topology | Block/neighborhood materialized views, relay selection, progressive discovery layers, role/access semantics (Member/Participant, Full/Partial/Limited) |
aura-sync | Synchronization | Journal sync and anti-entropy protocols |
Key characteristics: Reusable building blocks with no UI or binary entry points.
Notes:
- Layer 5 crates now include
ARCHITECTURE.mddescribing facts, invariants, and operation categories. OPERATION_CATEGORIESconstants in each Layer 5 crate map operations to A/B/C classes.- Runtime-owned caches (e.g., invitation/rendezvous descriptors) live in Layer 6 handlers, not in Layer 5 services.
- Layer 5 facts use versioned binary encoding (bincode) with JSON fallback for debug and compatibility.
- FactKey helper types are required for reducers/views to keep binding key derivation consistent.
- Ceremony facts carry optional
trace_idvalues to support cross-protocol traceability.
Dependencies: aura-core, aura-effects, aura-composition, aura-mpst, plus Layer 4 orchestration crates (aura-protocol, aura-guards, aura-consensus, aura-amp, aura-anti-entropy).
Layer 6: Runtime Composition (aura-agent, aura-simulator, and aura-app)
Purpose: Assemble complete running systems for production deployment.
Ownership expectation:
- this is the primary
ActorOwnedlayer - runtime services, supervisors, readiness coordinators, and caches should be actor-owned
- ownership transfer still uses
MoveOwnedhandoff surfaces rather than direct shared mutable rewrites - runtime mutation and publication should require explicit capabilities
- long-running operations and services must have typed terminal lifecycle
aura-agent: Production runtime for deployment with application lifecycle management, runtime-specific configuration, production deployment concerns, and system integration.
aura-app: Portable headless application core providing the business logic and state management layer for all platforms. Exposes a platform-agnostic API consumed by terminal, iOS, Android, and web frontends. Contains intent processing, view derivation, and platform feature flags (native, ios, android, web-js, web-dominator).
aura-simulator: Deterministic simulation runtime with virtual time, transport shims, failure injection, and generative testing via Quint integration (see aura-simulator/src/quint/ for generative simulation bridge).
Contains:
- Application lifecycle management (startup, shutdown, signals)
- Runtime-specific configuration and policies
- Production deployment concerns
- System integration and monitoring hooks
- Reactive event loop:
ReactiveScheduler(Tokio task) that orchestrates fact ingestion, journal updates, and view propagation
What doesn't go here:
- Effect handler implementations
- Handler composition utilities
- Protocol coordination logic
- CLI or UI concerns
Key characteristics: This is about "how do I deploy and run this as a production system?" It's the bridge between composed handlers/protocols and actual running applications.
Dependencies: All domain crates, aura-effects, aura-composition, and Layer 4 orchestration crates (aura-protocol, aura-guards, aura-consensus, aura-amp, aura-anti-entropy).
Layer 7: User Interface (aura-terminal, aura-ui, and aura-web)
Purpose: User-facing applications with main entry points.
Ownership expectation:
- primarily
Observed - command ingress mechanics may be
ActorOwnedat the shell boundary - UI must not co-author parity-critical semantic lifecycle or readiness truth
- render and projection layers consume authoritative state rather than inventing it
aura-terminal: Terminal-based interface combining CLI commands and an interactive TUI (Terminal User Interface). Provides account and device management, recovery status visualization, chat interfaces, and scenario execution. Consumes aura-app for all business logic and state management.
aura-ui: Shared Dioxus UI core. Owns cross-frontend semantic snapshot shaping, deterministic keyboard routing, and shared presentation state, while remaining platform agnostic and downstream of aura-app's authoritative semantic contract.
aura-web: Browser/WASM shell. Mounts aura-ui, integrates browser-specific adapters and harness bridge surfaces, and remains an observed shell rather than a semantic owner for parity-critical workflows.
Key characteristics:
- Layer 7 includes both shell binaries (
aura-terminal,aura-web) and the shared UI core (aura-ui) they consume. aura-terminalandaura-webcontain user-facing entry points and platform interop.aura-uistays platform neutral and expresses shared UI structure overaura-appcontracts.
Dependencies:
aura-ui:aura-app,aura-coreaura-terminal:aura-app,aura-agent,aura-core,aura-recovery, and selected Layer 4/5 crates needed for terminal shell integrationaura-web:aura-ui,aura-app,aura-agent,aura-core,aura-effects, and browser-only ecosystem crates for WASM interop
Layer 8: Testing and Development Tools
Purpose: Cross-cutting test utilities, formal verification bridges, and generative testing infrastructure.
Ownership expectation:
- test infrastructure may simulate
ActorOwnedandMoveOwnedsystems - parity-critical lanes must still respect production ownership boundaries
- harness and diagnostics are primarily
Observed - test-only mutation shortcuts should be narrow, documented, and capability-aware
aura-testkit: Comprehensive testing infrastructure including:
- Shared test fixtures and scenario builders
- Property test helpers and deterministic utilities
- Mock effect handlers:
MockCryptoHandler,SimulatedTimeHandler,MemoryStorageHandler, etc. - Stateful test handlers that maintain controllable state for deterministic testing
aura-quint: Formal verification bridge to Quint model checker including:
- Native Quint subprocess interface for parsing and type checking
- Property specification management with classification (authorization, budget, integrity)
- Verification runner with caching and counterexample generation
- Effect trait implementations for property evaluation during simulation
aura-harness: Multi-instance runtime harness for orchestrating test scenarios including:
- Coordinator and executor for managing multiple Aura instances
- Scenario definition and replay capabilities
- Artifact synchronization and determinism validation
- Screen normalization and VT100 terminal emulation for TUI testing
- Shared semantic contracts from
aura-appfor scenario actions and UI snapshots - Backend selection for
mockandpatchbayholepunch lanes - Resource guards and capability checking
Shared UX contract ownership is split intentionally:
aura-app::ui_contractowns parity-critical ids, action contracts, support declarations, and typed observation shapes- Layer 7 frontends consume that contract and export observed semantic projections
aura-harnessconsumes those observed projections and must treat them as side-effect-free authoritative observation surfaces
Deterministic observation policy:
- parity-critical waits bind to declared readiness, event, or quiescence conditions
- harness mode may change instrumentation or rendering stability, but not business-flow semantics
- placeholder IDs, exporter override caches, and heuristic success/event synthesis are not valid parity-critical correctness paths
Key characteristics: Mock handlers in aura-testkit are allowed to be stateful (using Arc<Mutex<>>, etc.) since they need controllable, deterministic state for testing. This maintains the stateless principle for production handlers in aura-effects while enabling comprehensive testing.
Deterministic seed policy: Test construction of AuraEffectSystem must use seeded helper constructors (simulation_for_test*). Do not call legacy testing* or raw simulation* constructors from test code. For multiple instances from the same callsite, use simulation_for_named_test_with_salt(...) so each seed is unique and replayable.
Dependencies: aura-core (for aura-harness). For aura-testkit and aura-quint: aura-agent, aura-composition, aura-journal, aura-transport, aura-core, aura-protocol, aura-guards, aura-consensus, aura-amp, aura-anti-entropy.
Workspace Structure
crates/
├── aura-agent Runtime composition and agent lifecycle
├── aura-app Portable headless application core (multi-platform)
├── aura-authentication Authentication protocols
├── aura-anti-entropy Anti-entropy sync and reconciliation
├── aura-amp Authenticated messaging protocol (AMP)
├── aura-chat Chat facts + local prototype service
├── aura-composition Handler composition and effect system assembly
├── aura-consensus Consensus protocol implementation
├── aura-core Foundation types and effect traits
├── aura-effects Effect handler implementations
├── aura-guards Guard chain enforcement
├── aura-harness Multi-instance runtime harness
├── aura-invitation Invitation choreographies
├── aura-journal Fact-based journal domain
├── aura-macros Choreography DSL compiler
├── aura-maintenance Maintenance facts and reducers
├── aura-mpst Session types and choreography specs
├── aura-protocol Orchestration and coordination
├── aura-quint Quint formal verification
├── aura-recovery Guardian recovery protocols
├── aura-relational Cross-authority relationships
├── aura-rendezvous Peer discovery and routing
├── aura-simulator Deterministic simulation engine
├── aura-social Social topology and progressive disclosure
├── aura-store Storage domain types
├── aura-sync Synchronization protocols
├── aura-terminal Terminal UI (CLI + TUI)
├── aura-testkit Testing utilities and fixtures
├── aura-transport P2P communication layer
├── aura-ui Shared Dioxus UI core
├── aura-web Browser frontend and harness bridge
├── aura-signature Identity verification
└── aura-authorization Web-of-trust authorization
Dependency Graph
graph TD
%% Layer 1: Foundation
core[aura-core]
%% Layer 2: Specification
signature[aura-signature]
journal[aura-journal]
authorization[aura-authorization]
store[aura-store]
transport[aura-transport]
mpst[aura-mpst]
macros[aura-macros]
maintenance[aura-maintenance]
%% Layer 3: Implementation
effects[aura-effects]
composition[aura-composition]
%% Layer 4: Orchestration
guards[aura-guards]
anti_entropy[aura-anti-entropy]
consensus[aura-consensus]
amp[aura-amp]
protocol[aura-protocol]
%% Layer 5: Feature
social[aura-social]
chat[aura-chat]
relational[aura-relational]
auth[aura-authentication]
rendezvous[aura-rendezvous]
invitation[aura-invitation]
recovery[aura-recovery]
sync[aura-sync]
%% Layer 6: Runtime
app[aura-app]
agent[aura-agent]
simulator[aura-simulator]
%% Layer 7: Application
ui[aura-ui]
terminal[aura-terminal]
web[aura-web]
%% Layer 8: Testing
testkit[aura-testkit]
quint[aura-quint]
harness[aura-harness]
%% Layer 2 dependencies
signature --> core
journal --> core
authorization --> core
store --> core
transport --> core
mpst --> core
macros --> core
maintenance --> core
%% Layer 3 dependencies
effects --> core
composition --> core
composition --> effects
composition --> mpst
%% Layer 4 dependencies
guards --> core
guards --> authorization
guards --> mpst
guards --> journal
anti_entropy --> core
anti_entropy --> guards
anti_entropy --> journal
consensus --> core
consensus --> macros
consensus --> journal
consensus --> mpst
consensus --> guards
amp --> core
amp --> effects
amp --> journal
amp --> transport
amp --> consensus
amp --> guards
protocol --> core
protocol --> effects
protocol --> composition
protocol --> journal
protocol --> guards
protocol --> consensus
protocol --> amp
protocol --> anti_entropy
protocol --> authorization
protocol --> transport
protocol --> mpst
protocol --> store
%% Layer 5 dependencies
social --> core
social --> journal
chat --> core
chat --> journal
chat --> composition
chat --> guards
relational --> core
relational --> journal
relational --> consensus
relational --> effects
auth --> core
auth --> effects
auth --> journal
auth --> protocol
auth --> guards
auth --> relational
auth --> signature
auth --> authorization
rendezvous --> core
rendezvous --> journal
rendezvous --> guards
rendezvous --> social
invitation --> core
invitation --> effects
invitation --> guards
invitation --> authorization
invitation --> auth
invitation --> journal
invitation --> composition
recovery --> core
recovery --> journal
recovery --> composition
recovery --> signature
recovery --> auth
recovery --> authorization
recovery --> effects
recovery --> protocol
recovery --> relational
sync --> core
sync --> protocol
sync --> guards
sync --> journal
sync --> authorization
sync --> maintenance
sync --> rendezvous
sync --> effects
sync --> anti_entropy
%% Layer 6 dependencies
app --> core
app --> effects
app --> journal
app --> relational
app --> chat
app --> social
app --> maintenance
app --> protocol
app --> recovery
agent --> core
agent --> app
agent --> effects
agent --> composition
agent --> protocol
agent --> guards
agent --> consensus
agent --> journal
agent --> relational
agent --> chat
agent --> auth
agent --> invitation
agent --> rendezvous
agent --> social
agent --> sync
agent --> maintenance
agent --> transport
agent --> recovery
agent --> authorization
agent --> signature
agent --> store
simulator --> core
simulator --> agent
simulator --> effects
simulator --> journal
simulator --> amp
simulator --> consensus
simulator --> protocol
simulator --> testkit
simulator --> sync
simulator --> quint
simulator --> guards
%% Layer 7 dependencies
ui --> app
ui --> core
terminal --> app
terminal --> core
terminal --> agent
terminal --> protocol
terminal --> recovery
terminal --> invitation
terminal --> auth
terminal --> sync
terminal --> effects
terminal --> authorization
terminal --> maintenance
terminal --> chat
terminal --> journal
terminal --> relational
web --> ui
web --> app
web --> core
web --> agent
web --> effects
%% Layer 8 dependencies
testkit --> core
testkit --> effects
testkit --> mpst
testkit --> journal
testkit --> relational
testkit --> social
testkit --> transport
testkit --> authorization
testkit --> consensus
testkit --> anti_entropy
testkit --> amp
testkit --> protocol
testkit --> app
quint --> core
quint --> effects
harness --> core
%% Styling
classDef foundation fill:#e1f5fe
classDef spec fill:#f3e5f5
classDef impl fill:#e8f5e9
classDef orch fill:#fff3e0
classDef feature fill:#fce4ec
classDef runtime fill:#f1f8e9
classDef application fill:#e0f2f1
classDef test fill:#ede7f6
class core foundation
class signature,journal,authorization,store,transport,mpst,macros,maintenance spec
class effects,composition impl
class guards,anti_entropy,consensus,amp,protocol orch
class social,chat,relational,auth,rendezvous,invitation,recovery,sync feature
class app,agent,simulator runtime
class ui,terminal,web application
class testkit,quint,harness test
Effect Trait Classification
Not all effect traits are created equal. Aura organizes effect traits into three categories that determine where their implementations should live:
All effect trait definitions belong in aura-core (Layer 1) to maintain a single source of truth for interfaces. This includes infrastructure effects (OS integration), application effects (domain-specific), and protocol coordination effects (multi-party orchestration).
Infrastructure Effects (Implemented in aura-effects)
Infrastructure effects are truly foundational capabilities that every Aura system needs. These traits define OS-level operations that are universal across all Aura use cases.
Characteristics:
- OS integration (file system, network, cryptographic primitives)
- No Aura-specific semantics
- Reusable across any distributed system
- Required for basic system operation
Examples:
CryptoEffects: Ed25519 signing, key generation, hashingNetworkEffects: TCP connections, message sending/receivingStorageEffects: File read/write, directory operationsPhysicalTimeEffects,LogicalClockEffects,OrderClockEffects: Unified time systemRandomEffects: Cryptographically secure random generationConfigurationEffects: Configuration file parsingConsoleEffects: Terminal input/outputLeakageEffects: Cross-cutting metadata leakage tracking (composable infrastructure)ReactiveEffects: Type-safe signal-based state management for UI and inter-component communication
Implementation Location: These traits have stateless handlers in aura-effects that delegate to OS services.
Application Effects (Implemented in Domain Crates)
Application effects encode Aura-specific abstractions and business logic. These traits capture domain concepts that are meaningful only within Aura's architecture.
Characteristics:
- Aura-specific semantics and domain knowledge
- Built on top of infrastructure effects
- Implement business logic and domain rules
- May have multiple implementations for different contexts
Examples:
JournalEffects: Fact-based journal operations, specific to Aura's CRDT design (aura-journal)AuthorityEffects: Authority-specific operations, central to Aura's identity modelFlowBudgetEffects: Privacy budget management, unique to Aura's information flow control (aura-authorization)AuthorizationEffects: Biscuit token evaluation, tied to Aura's capability system (aura-authorization)RelationalEffects: Cross-authority relationship managementGuardianEffects: Recovery protocol operations
Protocol Coordination Effects (new category):
ChoreographicEffects: Multi-party protocol coordinationEffectApiEffects: Event sourcing and audit for protocolsSyncEffects: Anti-entropy synchronization operations
Application effects are implemented in their respective domain crates (aura-journal, aura-authorization, etc.). Protocol coordination effects are implemented in Layer 4 orchestration crates (aura-protocol, aura-guards, aura-consensus, aura-amp, aura-anti-entropy) as they manage multi-party state.
Moving these to aura-effects would create circular dependencies. Domain crates need to implement these effects using their own domain logic, but aura-effects cannot depend on domain crates due to the layered architecture.
Domain crates implement application effects by creating domain-specific handler structs that compose infrastructure effects for OS operations while encoding Aura-specific business logic.
#![allow(unused)] fn main() { // Example: aura-journal implements JournalEffects pub struct JournalHandler<C: CryptoEffects, S: StorageEffects> { crypto: C, storage: S, // Domain-specific state } impl<C: CryptoEffects, S: StorageEffects> JournalEffects for JournalHandler<C, S> { async fn append_fact(&self, fact: Fact) -> Result<(), AuraError> { // 1. Domain validation using Aura-specific rules self.validate_fact_semantics(&fact)?; // 2. Cryptographic operations via infrastructure effects let signature = self.crypto.sign(&fact.hash()).await?; // 3. Storage operations via infrastructure effects let entry = JournalEntry { fact, signature }; self.storage.write_chunk(&entry.id(), &entry.encode()).await?; // 4. Domain-specific post-processing self.update_fact_indices(&fact).await?; Ok(()) } } }
Common Effect Placement Mistakes
Here are examples of incorrect effect placement and how to fix them:
#![allow(unused)] fn main() { // WRONG: Domain handler using OS operations directly // File: aura-journal/src/effects.rs impl JournalEffects for BadJournalHandler { async fn read_facts(&self, namespace: Namespace) -> Vec<Fact> { // VIOLATION: Direct file system access in domain handler let data = std::fs::read("journal.dat")?; serde_json::from_slice(&data)? } } // CORRECT: Inject StorageEffects for OS operations impl<S: StorageEffects> JournalEffects for GoodJournalHandler<S> { async fn read_facts(&self, namespace: Namespace) -> Vec<Fact> { // Use injected storage effects let data = self.storage.read_chunk(&namespace.to_path()).await?; self.deserialize_facts(data) } } }
#![allow(unused)] fn main() { // WRONG: Application effect implementation in aura-effects // File: aura-effects/src/journal_handler.rs pub struct JournalHandler { } impl JournalEffects for JournalHandler { // VIOLATION: Domain logic in infrastructure crate async fn validate_fact(&self, fact: &Fact) -> bool { match fact { Fact::TreeOp(op) => self.validate_tree_semantics(op), Fact::Commit(c) => self.validate_commit_rules(c), } } } // CORRECT: Application effects belong in domain crates // File: aura-journal/src/effects.rs impl<C, S> JournalEffects for JournalHandler<C, S> { // Domain validation logic belongs here } }
#![allow(unused)] fn main() { // WRONG: Infrastructure effect in domain crate // File: aura-journal/src/network_handler.rs pub struct CustomNetworkHandler { } impl NetworkEffects for CustomNetworkHandler { // VIOLATION: OS-level networking in domain crate async fn connect(&self, addr: &str) -> TcpStream { TcpStream::connect(addr).await? } } // CORRECT: Use existing NetworkEffects from aura-effects impl<N: NetworkEffects> MyDomainHandler<N> { async fn send_fact(&self, fact: Fact) -> Result<()> { // Compose with injected network effects self.network.send(fact.encode()).await } } }
Key principles for domain effect implementations:
- Domain logic first: Encode business rules and validation specific to the domain
- Infrastructure composition: Use infrastructure effects for OS operations, never direct syscalls
- Clean separation: Domain handlers should not contain OS integration code
- Testability: Mock infrastructure effects for unit testing domain logic
Fallback Handlers and the Null Object Pattern
Infrastructure effects sometimes require fallback implementations for platforms or environments where the underlying capability is unavailable (e.g., biometric hardware on servers, secure enclaves in CI, HSMs in development).
When fallback handlers are appropriate:
- The effect trait represents optional hardware/OS capabilities
- Code must run on platforms without the capability
- Graceful degradation is preferable to compile-time feature flags everywhere
Naming conventions:
- Good:
FallbackBiometricHandler,NoOpSecureEnclaveHandler,UnsupportedHsmHandler - Avoid:
RealBiometricHandler(misleading - implies real implementation)
Fallback handler behavior:
- Return
falsefor capability checks (is_available(),supports_feature()) - Return descriptive errors for operations (
Err(NotSupported)) - Never panic or silently succeed when the capability is unavailable
For a checklist on removing stub handlers, see CLAUDE.md under "Agent Decision Aids".
A fallback handler is not dead code if its trait is actively used. It represents the Null Object Pattern providing safe defaults. The architectural violation is a misleading name, not the existence of the fallback.
Composite Effects (Convenience Extensions)
Composite effects provide convenience methods that combine multiple lower-level operations. These are typically extension traits that add domain-specific convenience to infrastructure effects.
Characteristics:
- Convenience wrappers around other effects
- Domain-specific combinations of operations
- Often implemented as blanket implementations
- Improve developer ergonomics
Examples:
TreeEffects: CombinesCryptoEffectsandStorageEffectsfor merkle tree operationsSimulationEffects: Testing-specific combinations for deterministic simulationLeakageChoreographyExt: Combines leakage tracking with choreography operations
Implementation Location: Usually implemented as extension traits in aura-core or as blanket implementations in domain crates.
Effect Classification
For quick decision aids (decision matrix, decision tree), see CLAUDE.md under "Agent Decision Aids".
Examples:
- CryptoEffects → Infrastructure (OS crypto, no Aura semantics, reusable)
- JournalEffects → Application (Aura facts, domain validation, not reusable)
- NetworkEffects → Infrastructure (TCP/UDP, no domain logic, reusable)
- FlowBudgetEffects → Application (Aura privacy model, domain rules)
This classification ensures that:
- Infrastructure effects have reliable, stateless implementations available in
aura-effects - Application effects can evolve with their domain logic in domain crates
- Composite effects provide ergonomic interfaces without architectural violations
- The dependency graph remains acyclic
- Domain knowledge stays in domain crates, OS knowledge stays in infrastructure
- Clean composition enables testing domain logic independently of OS integration
Architecture Principles
No Circular Dependencies
Each layer builds on lower layers without reaching back down. This enables independent testing, reusability, and clear responsibility boundaries.
The layered architecture means that Layer 1 has no dependencies on any other Aura crate. Layer 2 depends only on Layer 1. Layer 3 depends on Layers 1 and 2. This pattern continues through all 8 layers.
Code Location Policy
The 8-layer architecture enforces strict placement rules. Violating these rules creates circular dependencies or breaks architectural invariants.
For a quick reference table of layer rules, see CLAUDE.md under "Agent Decision Aids".
For practical guidance on effects and handlers, see Effects Guide. For choreography development, see Choreography Guide.
Pure Mathematical Utilities
Some effect traits in aura-core (e.g., BloomEffects) represent pure mathematical operations without OS integration. These follow the standard trait/handler pattern for consistency, but are technically not "effects" in the algebraic sense (no side effects).
This is acceptable technical debt - the pattern consistency outweighs the semantic impurity. Future refactoring may move pure math to methods on types in aura-core.
Architectural Compliance Checking
The project includes an automated architectural compliance checker to enforce these layering principles:
Command: just check-arch
Implementation: toolkit/xtask orchestration plus retained thin repo checks
What it validates:
- Layer boundary violations (no upward dependencies)
- Dependency direction (Lx→Ly where y≤x only)
- Effect trait classification and placement
- Domain effect implementation patterns
- Stateless handler requirements in
aura-effects(noArc<Mutex>,Arc<RwLock>) - Mock handler location in
aura-testkit - Guard chain integrity (no bypass of CapGuard → FlowGuard → JournalCoupler)
- Impure function routing through effects (
SystemTime::now,thread_rng, etc.) - Physical time guardrails (
tokio::time::sleepconfinement) - Handler composition patterns (no direct instantiation)
- Parsed production placeholder and terminal facade syntax:
just lint-arch-syntax(style lane); positive lexical test cfg only, ordinary identifier substrings are not WIP evidence - Invariants documentation schema validation
The checker reports violations that must be fixed and warnings for review. Run it before submitting changes to ensure architectural compliance.
Feature Flags
Aura uses a minimal set of deliberate feature flags organized into three tiers.
Tier 1: Workspace-Wide Features
| Feature | Crate | Purpose |
|---|---|---|
simulation | aura-core, aura-effects | Enables simulation/testing effect traits and handlers. Required by aura-simulator, aura-quint, aura-testkit. |
proptest | aura-core | Property-based testing support via the proptest crate. |
Tier 2: Platform Features (aura-app)
| Feature | Purpose |
|---|---|
native | Rust consumers (aura-terminal, tests). Enables futures-signals API. |
ios | iOS via UniFFI → Swift bindings. |
android | Android via UniFFI → Kotlin bindings. |
wasm | Web via wasm-bindgen → JavaScript/TypeScript. |
web-dominator | Pure Rust WASM apps using futures-signals + dominator. |
Development features: instrumented (tracing), debug-serialize (JSON debug output), host (binding stub).
Tier 3: Crate-Specific Features
| Crate | Feature | Purpose |
|---|---|---|
aura-terminal | terminal | TUI mode (default). |
aura-terminal | development | Includes simulator, testkit, debug features. |
aura-testkit | full-effect-system | Optional aura-agent integration for higher-layer tests. |
aura-testkit | lean | Lean oracle for differential testing against formal models. |
aura-agent | dev-console | Optional development console server. |
aura-agent | real-android-keystore | Real Android Keystore implementation. |
aura-mpst | debug | Choreography debugging output. |
aura-macros | proc-macro | Proc-macro compilation (default). |
Feature Usage Examples
# Standard development (default features)
cargo build
# With simulation support
cargo build -p aura-core --features simulation
# Terminal with development tools
cargo build -p aura-terminal --features development
# Lean differential testing (requires Lean toolchain)
just lean-oracle-build
cargo test -p aura-testkit --features lean --test lean_differential
# iOS build
cargo build -p aura-app --features ios
Effect System and Impure Function Guidelines
Core Principle: Deterministic Simulation
Aura's effect system ensures fully deterministic simulation by requiring all impure operations (time, randomness, filesystem, network) to flow through effect traits. This enables:
- Predictable testing: Mock all external dependencies for unit tests
- WASM compatibility: No blocking operations or OS thread assumptions
- Cross-platform support: Same code runs in browsers and native environments
- Simulation fidelity: Virtual time and controlled randomness for property testing
Impure Function Classification
FORBIDDEN: Direct impure function usage
#![allow(unused)] fn main() { // VIOLATION: Direct system calls let now = SystemTime::now(); let random = thread_rng().gen::<u64>(); let file = File::open("data.txt")?; let socket = TcpStream::connect("127.0.0.1:8080").await?; // VIOLATION: Global state static CACHE: Mutex<HashMap<String, String>> = Mutex::new(HashMap::new()); }
REQUIRED: Effect trait usage
#![allow(unused)] fn main() { // CORRECT: Via effect traits with explicit context async fn my_operation<T: TimeEffects + RandomEffects + StorageEffects>( ctx: &EffectContext, effects: &T, ) -> Result<ProcessedData> { let timestamp = effects.current_time().await; let nonce = effects.random_bytes(32).await?; let data = effects.read_chunk(&chunk_id).await?; // ... business logic with pure functions Ok(ProcessedData { timestamp, nonce, data }) } }
Legitimate Effect Injection Sites
The architectural compliance checker allows direct impure function usage only in these specific locations:
1. Effect Handler Implementations (aura-effects)
#![allow(unused)] fn main() { // ALLOWED: Production effect implementations impl PhysicalTimeEffects for PhysicalTimeHandler { async fn physical_time(&self) -> Result<PhysicalTime, TimeError> { // OK: This IS the effect implementation let now = SystemTime::now().duration_since(UNIX_EPOCH)?; Ok(PhysicalTime::from_ms(now.as_millis() as u64)) } } impl RandomCoreEffects for RealRandomHandler { async fn random_bytes(&self, len: usize) -> Vec<u8> { let mut bytes = vec![0u8; len]; rand::thread_rng().fill_bytes(&mut bytes); // OK: Legitimate OS randomness source bytes } } }
2. Runtime Effect Assembly (runtime/effects.rs)
#![allow(unused)] fn main() { // ALLOWED: Effect system bootstrapping pub fn create_production_effects() -> AuraEffectSystem { AuraEffectSystemBuilder::new() .with_handler(Arc::new(PhysicalTimeHandler::new())) .with_handler(Arc::new(RealRandomHandler::new())) // OK: Assembly point .build() } }
3. Pure Functions (aura-core::hash)
#![allow(unused)] fn main() { // ALLOWED: Deterministic, pure operations pub fn hash(data: &[u8]) -> [u8; 32] { blake3::hash(data).into() // OK: Pure function, no external state } }
Exemption Rationale
Why these exemptions are architecturally sound:
- Effect implementations MUST access the actual system - that's their purpose
- Runtime assembly is the controlled injection point where production vs. mock effects are chosen
- Pure functions are deterministic regardless of when/where they're called
Why broad exemptions are dangerous:
- Crate-level exemptions (
aura-agent,aura-protocol,aura-guards,aura-consensus,aura-amp,aura-anti-entropy) would allow business logic to bypass effects - This breaks simulation determinism and WASM compatibility
- Makes testing unreliable by introducing hidden external dependencies
Effect System Usage Patterns
Correct: Infrastructure Effects in aura-effects
#![allow(unused)] fn main() { // File: crates/aura-effects/src/transport/tcp.rs pub struct TcpTransportHandler { config: TransportConfig, } impl TcpTransportHandler { pub async fn connect(&self, addr: TransportSocketAddr) -> TransportResult<TransportConnection> { let stream = TcpStream::connect(*addr.as_socket_addr()).await?; // OK: Implementation // ... connection setup Ok(connection) } } }
Correct: Domain Effects in Domain Crates
#![allow(unused)] fn main() { // File: crates/aura-journal/src/effects.rs pub struct JournalHandler<C: CryptoEffects, S: StorageEffects> { crypto: C, storage: S, } impl<C: CryptoEffects, S: StorageEffects> JournalEffects for JournalHandler<C, S> { async fn append_fact(&self, ctx: &EffectContext, fact: Fact) -> Result<()> { // Domain validation (pure) self.validate_fact_semantics(&fact)?; // Infrastructure effects for impure operations let signature = self.crypto.sign(&fact.hash()).await?; self.storage.write_chunk(&entry.id(), &entry.encode()).await?; Ok(()) } } }
Violation: Direct impure access in domain logic
#![allow(unused)] fn main() { // File: crates/aura-core/src/crypto/tree_signing.rs pub async fn start_frost_ceremony() -> Result<()> { let start_time = SystemTime::now(); // VIOLATION: Should use TimeEffects let session_id = Uuid::new_v4(); // VIOLATION: Should use RandomEffects // This breaks deterministic simulation! ceremony_with_timing(start_time, session_id).await } }
Context Propagation Requirements
All async operations must propagate EffectContext:
#![allow(unused)] fn main() { // CORRECT: Explicit context propagation async fn process_request<T: AllEffects>( ctx: &EffectContext, // Required for tracing/correlation effects: &T, request: Request, ) -> Result<Response> { let start = effects.current_time().await; // Context flows through the call chain let result = process_business_logic(ctx, effects, request.data).await?; let duration = effects.current_time().await.duration_since(start)?; tracing::info!( request_id = %ctx.request_id, duration_ms = duration.as_millis(), "Request processed" ); Ok(result) } }
Mock Testing Pattern
Tests use controllable mock effects:
#![allow(unused)] fn main() { // File: tests/integration/frost_test.rs #[tokio::test] async fn test_frost_ceremony_timing() { // Controllable time for deterministic tests let mock_time = SimulatedTimeHandler::new(); mock_time.set_time(PhysicalTime::from_ms(1000_000)); let effects = TestEffectSystem::new() .with_time(mock_time) .with_random(MockRandomHandler::deterministic()) .build(); let ctx = EffectContext::test(); // Test runs deterministically regardless of wall-clock time let result = start_frost_ceremony(&ctx, &effects).await; assert!(result.is_ok()); } }
WASM Compatibility Guidelines
Forbidden in all crates (except effect implementations):
std::thread- No OS threads in WASMstd::fs- No filesystem in browsersSystemTime::now()- Time must be injectedrand::thread_rng()- Randomness must be controllable- Blocking operations - Everything must be async
Required patterns:
- Async/await for all I/O operations
- Effect trait injection for all impure operations
- Explicit context propagation through call chains
- Builder patterns for initialization with async setup
Compliance Checking
The just check-arch command validates these principles by:
- Scanning for direct impure usage: Detects
SystemTime::now,thread_rng(),std::fs::, etc. - Enforcing precise exemptions: Only allows usage in
impl.*Effects,runtime/effects.rs - Context propagation validation: Warns about async functions without
EffectContext - Global state detection: Catches
lazy_static,Mutex<static>anti-patterns
Run before every commit to maintain architectural compliance and simulation determinism.
The retained reactive fact-commit/view-sync heuristic applies to production
modules; files named tests.rs and other test-only modules are excluded, since
fixture commits do not own a production view-sync contract.
Serialization Policy
Aura uses DAG-CBOR as the canonical serialization format for:
- Wire protocols: Network messages between peers
- Facts: CRDT state, journal entries, attestations
- Cryptographic commitments: Content-addressable hashes (determinism required)
Canonical Module
All serialization should use aura_core::util::serialization:
#![allow(unused)] fn main() { use aura_core::util::serialization::{to_vec, from_slice, hash_canonical}; use aura_core::util::serialization::{VersionedMessage, SemanticVersion}; // Serialize to DAG-CBOR let bytes = to_vec(&value)?; // Deserialize from DAG-CBOR let value: MyType = from_slice(&bytes)?; // Content-addressable hash (deterministic) let hash = hash_canonical(&value)?; }
Why DAG-CBOR?
- Deterministic canonical encoding: Required for FROST threshold signatures where all parties must produce identical bytes
- Content-addressable: IPLD compatibility for content hashing and Merkle trees
- Forward/backward compatible: Semantic versioning support via
VersionedMessage<T> - Efficient binary encoding: Better than JSON, comparable to bincode
Allowed Alternatives
| Format | Use Case | Example |
|---|---|---|
serde_json | User-facing config files | .aura/config.json |
serde_json | Debug output and logging | tracing spans |
serde_json | Dynamic metadata | HashMap<String, Value> |
Versioned Facts Pattern
All fact types should use the versioned serialization pattern:
#![allow(unused)] fn main() { use aura_core::util::serialization::{to_vec, from_slice, SerializationError}; const CURRENT_VERSION: u32 = 1; impl MyFact { pub fn to_bytes(&self) -> Result<Vec<u8>, SerializationError> { to_vec(self) } pub fn from_bytes(bytes: &[u8]) -> Result<Self, SerializationError> { // Try DAG-CBOR first, fall back to JSON for compatibility from_slice(bytes).or_else(|_| { serde_json::from_slice(bytes) .map_err(|e| SerializationError::Deserialization(e.to_string())) }) } } }
Enforcement
The just check-arch --serialization command validates:
- Wire protocol files use canonical serialization
- Facts files use versioned serialization
Invariant Traceability
This section indexes invariants across Aura and maps them to enforcement loci. Invariant specifications live in crate ARCHITECTURE.md files. Contracts in Theoretical Model, Privacy and Information Flow Contract, and Distributed Systems Contract define the cross-crate safety model.
Canonical Naming
Use InvariantXxx names in proofs and tests. Use prose aliases for readability when needed. When both forms appear, introduce the alias once and then reference the canonical name.
Examples:
Charge-Before-Sendmaps toInvariantSentMessagesHaveFactsandInvariantFlowBudgetNonNegative.Context Isolationmaps toInvariantContextIsolation.Secure Channel Lifecyclemaps toInvariantReceiptValidityWindowandInvariantCrossEpochReplayPrevention.
Use shared terminology from Theoretical Model:
- Role terms:
Member,Participant,Moderator - Access terms:
AccessLevelwithFull,Partial,Limited - Storage/pinning terms:
Shared Storage,allocation, andpinnedfacts
Core Invariant Index
| Alias | Canonical Name(s) | Primary Enforcement | Related Contracts |
|---|---|---|---|
| Charge-Before-Send | InvariantSentMessagesHaveFacts, InvariantFlowBudgetNonNegative | crates/aura-guards/ARCHITECTURE.md | Privacy and Information Flow Contract, Distributed Systems Contract |
| CRDT Convergence | InvariantCRDTConvergence | crates/aura-journal/ARCHITECTURE.md | Theoretical Model, Distributed Systems Contract |
| Context Isolation | InvariantContextIsolation | crates/aura-core/ARCHITECTURE.md | Theoretical Model, Privacy and Information Flow Contract, Distributed Systems Contract |
| Secure Channel Lifecycle | InvariantSecureChannelLifecycle, InvariantReceiptValidityWindow, InvariantCrossEpochReplayPrevention | crates/aura-rendezvous/ARCHITECTURE.md | Privacy and Information Flow Contract, Distributed Systems Contract |
| Authority Tree Topology and Commitment Coherence | InvariantAuthorityTreeTopologyCommitmentCoherence | crates/aura-journal/ARCHITECTURE.md | Theoretical Model, Distributed Systems Contract |
Distributed Contract Invariants
The distributed and privacy contracts define additional canonical names used by proofs and conformance tests:
InvariantUniqueCommitPerInstanceInvariantCommitRequiresThresholdInvariantEquivocatorsExcludedInvariantNonceUniqueInvariantSequenceMonotonicInvariantReceiptValidityWindowInvariantCrossEpochReplayPreventionInvariantVectorClockConsistentInvariantHonestMajorityCanCommitInvariantCompromisedNoncesExcluded
When a crate enforces one of these invariants, record the same canonical name in that crate's ARCHITECTURE.md.
Traceability Matrix
This matrix provides a single cross-reference for contract names, owning crate docs, and proof/test artifacts.
| Canonical Name | Crate Architecture Spec | Proof/Test Artifact |
|---|---|---|
InvariantSentMessagesHaveFacts | crates/aura-guards/ARCHITECTURE.md | verification/quint/transport.qnt |
InvariantFlowBudgetNonNegative | crates/aura-guards/ARCHITECTURE.md | verification/quint/transport.qnt |
InvariantContextIsolation | crates/aura-core/ARCHITECTURE.md, crates/aura-transport/ARCHITECTURE.md | verification/quint/transport.qnt |
InvariantSequenceMonotonic | crates/aura-transport/ARCHITECTURE.md | verification/quint/transport.qnt |
InvariantReceiptValidityWindow | crates/aura-rendezvous/ARCHITECTURE.md | verification/quint/epochs.qnt |
InvariantCrossEpochReplayPrevention | crates/aura-rendezvous/ARCHITECTURE.md | verification/quint/epochs.qnt |
InvariantNonceUnique | crates/aura-journal/ARCHITECTURE.md | verification/quint/journal/core.qnt |
InvariantVectorClockConsistent | crates/aura-anti-entropy/ARCHITECTURE.md | verification/quint/journal/anti_entropy.qnt |
InvariantUniqueCommitPerInstance | crates/aura-consensus/ARCHITECTURE.md | verification/quint/consensus/core.qnt, verification/lean/Aura/Proofs/Consensus/Agreement.lean |
InvariantCommitRequiresThreshold | crates/aura-consensus/ARCHITECTURE.md | verification/quint/consensus/core.qnt, verification/lean/Aura/Proofs/Consensus/Validity.lean |
InvariantEquivocatorsExcluded | crates/aura-consensus/ARCHITECTURE.md | verification/quint/consensus/core.qnt, verification/lean/Aura/Proofs/Consensus/Adversary.lean |
InvariantHonestMajorityCanCommit | crates/aura-consensus/ARCHITECTURE.md | verification/quint/consensus/adversary.qnt, verification/lean/Aura/Proofs/Consensus/Adversary.lean |
InvariantCompromisedNoncesExcluded | crates/aura-consensus/ARCHITECTURE.md | verification/quint/consensus/adversary.qnt |
Use just check-invariants to validate system invariants across the workspace.
Ownership annotation changes
The annotation ratchet inspects the attributes attached to current Rust function, impl-method and actor declarations. Signature-only changes preserve their existing declarations even when an attribute is unchanged diff context. A nearby attribute or an annotated namesake does not authorize an unannotated boundary. Explicit semantic wrapper declarations continue to identify their corresponding owner.
The ownership aggregate also runs just ci-public-frost-signing's native check.
It requires actual discovery and execution of audited public-commitment signing
and substitution regressions, plus positive and negative public API consumers.
This primitive lane complements the runtime ownership and recovery lanes.
Compile-fail harness process custody lives in aura-testkit::process_lock (native test infrastructure). App, agent and explicitly enabled signals guards share one workspace-derived descriptor lock. The ownership aggregate runs these guards and the actual forced-process recovery regression sequentially; Cargo absence and bounded acquisition failure fail the gate. Contributor policy and workflow details are in docs/804_testing_guide.md.
Host compile-fail infrastructure
toolkit/test-support is an unpublished host-only Cargo package outside the
runtime workspace layers. It supplies the single process-scoped descriptor lock
used by core/macros dev tests and reexported by native aura-testkit. It depends
only on platform libraries, so foundation tests gain no upward Aura dependency.
Keeping it a package also gives crate2nix a complete source root; cross-crate
Rust path inclusion must not escape a crate's filtered source directory.