Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
137 commits
Select commit Hold shift + click to select a range
00e191a
docs: standardize document headers across major CrypSA docs
Copilot Apr 9, 2026
c14ee51
docs: tighten header sections across four architecture docs
Copilot Apr 9, 2026
dd3f5e6
Rename section from 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
959d09f
Rename 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
18b502c
Update section header to include emoji
godofthunder101 Apr 9, 2026
43126d9
Add emoji to Authority Level section header
godofthunder101 Apr 9, 2026
e5402c7
Rename section from 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
7685e1d
Update Authority Level section header with emoji
godofthunder101 Apr 9, 2026
799edaf
Update section title in architecture document
godofthunder101 Apr 9, 2026
cfd130e
Update section title in CrypSA_State_Model.md
godofthunder101 Apr 9, 2026
9a11afa
Rename 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
3b4cf11
Rename 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
1994e16
Rename section from 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
c68bb89
Rename 'Terminology Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
e40bc63
Rename section from 'Specification Authority' to 'Authority Level'
godofthunder101 Apr 9, 2026
52ebb32
Add emoji to Authority Level section header
godofthunder101 Apr 9, 2026
4a0f3b6
Update CrypSA_Terminology_Primer.md
godofthunder101 Apr 9, 2026
1da2006
Fix link to How_To_Read_CrypSA.md in README
godofthunder101 Apr 9, 2026
c12b3e5
Add implementation guidance for CrypSA
godofthunder101 Apr 9, 2026
7a1335d
Add implementation guidance for CrypSA design pattern
godofthunder101 Apr 9, 2026
8153992
Add implementation guidance to development approach
godofthunder101 Apr 9, 2026
6287274
Add implementation guidance to migration guide
godofthunder101 Apr 9, 2026
c7529fb
Add implementation guidance for CrypSA
godofthunder101 Apr 9, 2026
a89274e
Add implementation guidance for CrypSA
godofthunder101 Apr 9, 2026
4c218b3
Revise CrypSA Adapter Rules for clarity and guidance
godofthunder101 Apr 9, 2026
2c1804f
Update guidance on implementation patterns
godofthunder101 Apr 9, 2026
ba49a58
Update recommendation wording for implementation patterns
godofthunder101 Apr 9, 2026
1f541b0
Update guidance on implementation patterns
godofthunder101 Apr 9, 2026
ed3818b
Update guidance on implementation patterns
godofthunder101 Apr 9, 2026
9a5ef8e
Update recommendation note for implementation patterns
godofthunder101 Apr 9, 2026
2f47bf9
Revise CrypSA Local-First Design Pattern documentation
godofthunder101 Apr 9, 2026
59522de
Clarify development approach for CrypSA systems
godofthunder101 Apr 9, 2026
1b6b5aa
Update validation logic warning in migration guide
godofthunder101 Apr 9, 2026
4faf94b
Revise CrypSA Project Status document
godofthunder101 Apr 9, 2026
71c38ea
Refine CrypSA Quick Start for Engineers
godofthunder101 Apr 9, 2026
a6f6da8
Update wording for clarity in teaching prototype lessons
godofthunder101 Apr 9, 2026
73984dd
Add implementation guidance to README
godofthunder101 Apr 9, 2026
3e11cb7
Enhance documentation for CrypSA Minimal Validator structure
godofthunder101 Apr 9, 2026
5bf253f
Update CrypSA_Minimal_Validator_v0.1.md
godofthunder101 Apr 9, 2026
fed50da
Fix capitalization of 'canonical event history'
godofthunder101 Apr 9, 2026
675892c
Refine language in CrypSA Validator Runtime Flow document
godofthunder101 Apr 9, 2026
ff9d928
Enhance CrypSA Validator Runtime Invariants documentation
godofthunder101 Apr 9, 2026
c5dd0bc
Revise CrypSA Validator Runtime Test Plan
godofthunder101 Apr 9, 2026
8570a98
Include terminology disclaimer in CrypSA Offline Mode
godofthunder101 Apr 9, 2026
f0546ff
Add terminology disclaimer to README
godofthunder101 Apr 9, 2026
2772388
Include terminology disclaimer in CrypSA Concept Map
godofthunder101 Apr 9, 2026
6f2e715
Include terminology disclaimer in event flow diagram
godofthunder101 Apr 9, 2026
291de99
Include terminology disclaimer in CrypSA Event Flow
godofthunder101 Apr 9, 2026
62c26de
Update CrypSA Event Lifecycle with terminology disclaimer
godofthunder101 Apr 9, 2026
5275284
Include terminology disclaimer in CrypSA Invariant Model
godofthunder101 Apr 9, 2026
1a70a46
Include disclaimer and exploratory note in document
godofthunder101 Apr 9, 2026
f202f4f
Include terminology disclaimer in CrypSA Object Model
godofthunder101 Apr 9, 2026
b1768b3
Include terminology disclaimer in README
godofthunder101 Apr 9, 2026
9245ca8
Revise CrypSA foundational paper for clarity and updates
godofthunder101 Apr 9, 2026
bb9db16
Update CrypSA Origin Statement with terminology note
godofthunder101 Apr 9, 2026
6cb1fe1
Add terminology disclaimer to CrypSA Universe Model
godofthunder101 Apr 9, 2026
2f17bcb
Add terminology disclaimer to CrypSA vs Traditional Multiplayer
godofthunder101 Apr 9, 2026
a825ebf
Update README with terminology note
godofthunder101 Apr 9, 2026
7162797
Refine language and clarify concepts in FAQ.md
godofthunder101 Apr 9, 2026
10861a1
Enhance terminology and clarify canonical event rules
godofthunder101 Apr 9, 2026
36f0583
Update CrypSA event model documentation
godofthunder101 Apr 9, 2026
955551d
Refine terminology and structure in README.md
godofthunder101 Apr 9, 2026
10c780c
Update validation model documentation for clarity
godofthunder101 Apr 9, 2026
6ada1b7
Clarify candidate event terminology and validation process
godofthunder101 Apr 9, 2026
6fda2ef
Update terminology and clarify validation process
godofthunder101 Apr 9, 2026
9ad85b2
Refine terminology and clarify consistency model
godofthunder101 Apr 9, 2026
8004aa5
Enhance documentation with Replay Authority and Reconciliation
godofthunder101 Apr 9, 2026
6eb931b
Revise CrypSA development approach and clarify terms
godofthunder101 Apr 9, 2026
6449c83
Update terminology and clarify event processing
godofthunder101 Apr 9, 2026
17ea3b7
Update FAQ for clarity on canonical event history
godofthunder101 Apr 9, 2026
a7d0035
Refine language for clarity in CrypSA documentation
godofthunder101 Apr 9, 2026
9f6e98f
Refine terminology related to canonical events and validation
godofthunder101 Apr 9, 2026
25f698d
Format and clarify How_To_Read_CrypSA.md
godofthunder101 Apr 9, 2026
4aeba6c
Refactor CrypSA design document for clarity and consistency
godofthunder101 Apr 9, 2026
15c1678
Create REVIEWER_GUIDE.md for project evaluation
godofthunder101 Apr 9, 2026
a8ba439
Revise Reviewer Guide for CrypSA context
godofthunder101 Apr 9, 2026
590c583
Update README with reviewer guide notice
godofthunder101 Apr 9, 2026
88b3329
Update README.md with additional details and corrections
godofthunder101 Apr 9, 2026
1865825
Clarify validator's role in canonical truth and replay
godofthunder101 Apr 9, 2026
32f4628
Update CrypSA Quick Start with clarifications and details
godofthunder101 Apr 14, 2026
35585db
Revise terminology and clarify validator design details
godofthunder101 Apr 14, 2026
e088781
Clarify validator's role in canonical truth
godofthunder101 Apr 14, 2026
8a77003
Clarify documentation on system behavior and authority
godofthunder101 Apr 14, 2026
0453b04
Update README.md for clarity and terminology
godofthunder101 Apr 14, 2026
c7ae3c7
Fix formatting issue in architecture overview
godofthunder101 Apr 14, 2026
bf62c64
Refine CrypSA runtime model documentation
godofthunder101 Apr 14, 2026
93b841d
Revise README for clarity and additional resources
godofthunder101 Apr 14, 2026
e6bb47d
Update CrypSA_In_5_Minutes.md
godofthunder101 Apr 14, 2026
6e9f00a
Update CrypSA_Worked_Example.md for clarity and accuracy
godofthunder101 Apr 14, 2026
91746c9
Enhance CrypSA_Event_Model with runtime model references
godofthunder101 Apr 14, 2026
de8cf34
Enhance validation model documentation
godofthunder101 Apr 14, 2026
cac3280
Enhance consistency model documentation with runtime references
godofthunder101 Apr 14, 2026
577ae67
Update CrypSA_Observer_Model.md with runtime model references
godofthunder101 Apr 14, 2026
7062bdf
Enhance documentation on observer behavior and security
godofthunder101 Apr 14, 2026
fe39f37
Update CrypSA Validator Deployment Model documentation
godofthunder101 Apr 14, 2026
950032e
Refactor validator responsibilities and model details
godofthunder101 Apr 14, 2026
6e3469b
Clarify authoritative flow and lifecycle in diagram
godofthunder101 Apr 14, 2026
421a78c
Update CrypSA Adapter Lens documentation
godofthunder101 Apr 14, 2026
7ee962f
Enhance CrypSA Conflict Resolution documentation
godofthunder101 Apr 14, 2026
ddccb2d
Clarify control flow documentation and references
godofthunder101 Apr 14, 2026
09b80cb
Enhance CrypSA Event Flow documentation
godofthunder101 Apr 14, 2026
8150a8a
Update CrypSA documentation with flow references
godofthunder101 Apr 14, 2026
af6d190
Enhance documentation with conceptual flow references
godofthunder101 Apr 14, 2026
935e6f4
Revise CrypSA snapshot and replay documentation
godofthunder101 Apr 14, 2026
55f453a
Enhance CrypSA State Transition Diagram documentation
godofthunder101 Apr 14, 2026
0fa9bdf
Enhance CrypSA System Stack Diagram details
godofthunder101 Apr 14, 2026
d700a49
Update CrypSA_Ten_Diagrams.md
godofthunder101 Apr 14, 2026
034a33b
Enhance CrypSA Validation Pipeline documentation
godofthunder101 Apr 14, 2026
a285e73
Clarify documentation structure and authoritative sources
godofthunder101 Apr 14, 2026
3ba731d
Revise CrypSA Terminology Primer with diagrams and authority model
godofthunder101 Apr 14, 2026
704c91e
Update CrypSA_Boundary_Definitions.md for clarity
godofthunder101 Apr 14, 2026
f520b60
Update README.md with clarifications and references
godofthunder101 Apr 14, 2026
f845ce8
Clarify architecture and canonical event definitions
godofthunder101 Apr 14, 2026
96d5665
Refactor How_To_Read_CrypSA.md for clarity
godofthunder101 Apr 14, 2026
8fe9fc8
Update README for clarity and navigation improvements
godofthunder101 Apr 14, 2026
274e199
Revise CrypSA runtime model documentation
godofthunder101 Apr 14, 2026
e84ec32
Update CrypSA runtime model documentation
godofthunder101 Apr 14, 2026
309cdfc
Improve clarity and consistency in CrypSA documentation
godofthunder101 Apr 14, 2026
cd7d41e
Update README for clarity and implementation guidance
godofthunder101 Apr 14, 2026
485f4c9
Clarify roles and responsibilities in architecture overview
godofthunder101 Apr 14, 2026
b0726e5
Update CrypSA Observer Model documentation
godofthunder101 Apr 14, 2026
c2773ba
Refine definitions and clarify validator responsibilities
godofthunder101 Apr 14, 2026
a8d4fd2
Refine language on adapters' data transformation roles
godofthunder101 Apr 15, 2026
f3c24c9
Update CrypSA Lens Model documentation for clarity
godofthunder101 Apr 15, 2026
cbcabf1
Revise CrypSA Terminology Primer for clarity
godofthunder101 Apr 15, 2026
e70a7db
Revise authority model and terminology in README
godofthunder101 Apr 15, 2026
f991b4a
Refine terminology and structure in CONTRIBUTING.md
godofthunder101 Apr 15, 2026
0363ce0
Update references and terminology in CrypSA example
godofthunder101 Apr 15, 2026
1fe7a3c
Add CrypSA Infrastructure Implications document
godofthunder101 Apr 15, 2026
1a9b2c6
Update architecture overview with infrastructure reference
godofthunder101 Apr 15, 2026
9e2f792
Enhance README with infrastructure implications and build steps
godofthunder101 Apr 15, 2026
e9130a5
Refine language and add infrastructure implications reference
godofthunder101 Apr 15, 2026
fb9584a
Update CrypSA_Worked_Example with infrastructure reference
godofthunder101 Apr 15, 2026
55af8a0
Update CrypSA runtime walkthrough for clarity
godofthunder101 Apr 15, 2026
3ac9d09
Update CrypSA documentation with infrastructure details
godofthunder101 Apr 15, 2026
9dbe5e2
Clarify validator's role in event canonicalization
godofthunder101 Apr 15, 2026
970b8ff
Update validator description in CrypSA diagram
godofthunder101 Apr 15, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ CrypSA is **architecture-first**.
This means:

* the **spec defines runtime behavior**
* the **architecture defines structure and boundaries**
* the **architecture defines system structure and conceptual models**
* implementation follows these definitions

> Contributions must preserve clarity and consistency of the model.
Expand All @@ -27,13 +27,13 @@ This means:

The repository is structured by document authority:

| Layer | Purpose | Authority |
| ----------------- | ------------------------------ | ----------------- |
| `spec/` | Runtime behavior | **Highest** |
| `architecture/` | Structure and responsibilities | High |
| `implementation/` | How to build | Support |
| `diagrams/` | Visualization | Non-authoritative |
| `exploratory/` | Ideas | Non-authoritative |
| Layer | Purpose | Authority |
| ----------------- | ----------------------------------------- | ----------------- |
| `spec/` | Authoritative runtime behavior | **Highest** |
| `architecture/` | System structure and responsibilities | High |
| `implementation/` | How to build | Support |
| `diagrams/` | Visualization | Non-authoritative |
| `exploratory/` | Ideas | Non-authoritative |

### Rules

Expand Down Expand Up @@ -75,13 +75,13 @@ All contributors must follow the terminology defined in:

✔ Correct:

``` id="tr8wq5"
```
validator validates events
````
```

❌ Incorrect:

```id="83nmq2"
```
server validates events
```

Expand Down Expand Up @@ -125,9 +125,11 @@ The following phrases are **canonical** and must be used exactly as written.

Do not rephrase, simplify, substitute, or partially restate these phrases.

If a sentence expresses one of these concepts, it must use the canonical phrasing exactly.
If a sentence expresses one of these concepts, it must use the canonical phrasing exactly.
Near matches are not acceptable.

These phrases are enforced by documentation linting and must not be altered.

---

### Validator Authority
Expand Down Expand Up @@ -169,11 +171,11 @@ CrypSA enforces strict separation:
| Truth | Validation + canonical event history |
| Translation | Adapters |
| Interpretation | Lenses |
| Experience | UI / simulation |
| Experience | UI and local simulation |

### Rules

* Adapters **change structure, not meaning**
* Adapters **change structure without interpreting meaning**
* Lenses **define meaning, not structure**
* UI **does not define truth**
* Observers **never define canonical truth**
Expand All @@ -200,7 +202,7 @@ Do not blur these boundaries in contributions.

2. Reference it elsewhere:

```id="f6o525"
```
See: Terminology Primer → [Term]
```

Expand Down Expand Up @@ -234,9 +236,9 @@ When contributing documentation:

Examples:

❌ Spec logic inside architecture docs
❌ Implementation details inside spec
❌ New concepts defined inside diagrams
❌ Spec logic inside architecture docs
❌ Implementation details inside spec
❌ New concepts defined inside diagrams

---

Expand Down
87 changes: 66 additions & 21 deletions CrypSA_Architecture_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,22 @@ For a worked example, see:

---

## 📜 Specification Authority
## 📜 Authority Level

The `/spec` directory is the **authoritative definition of runtime behavior**.
CrypSA documentation is structured across layers:

Architecture documents explain the system.
The spec defines how it must behave.
* `/spec` — authoritative definition of runtime behavior
* `/architecture` — system structure and conceptual models

If there is any conflict, **the spec takes precedence**.
This document provides a high-level structural overview.

For strict separation of responsibilities, see:

→ `CrypSA_Boundary_Definitions.md`

If there is any conflict:

* spec takes precedence over architecture

---

Expand Down Expand Up @@ -57,6 +65,10 @@ They are responsible for local simulation and experience.

Observers do **not define truth**.

For the boundary between observers and the validator, see:

→ `CrypSA_Boundary_Definitions.md`

---

### Validator
Expand All @@ -68,12 +80,14 @@ The validator:
* accepts or rejects them
* assigns canonical ordering (`canonical_sequence`)

Accepted events become canonical and are appended to canonical event history, which defines what is true.
If accepted, an event becomes canonical and is appended to canonical event history.

> Canonical event history is the source of truth.

The validator is a **logical role**, not a specific machine.

It is the only component that defines what becomes canonical.

It may run:

* locally (within an observer environment)
Expand All @@ -97,13 +111,16 @@ Not all validators are servers, but all servers host a validator.

Adapters:

* reshape canonical and observer data
* reshape canonical data and observer-local data
* prepare structured outputs for interpretation and UI

Adapters are the **translation layer**.

They change structure, not meaning.
They do not define truth.
They reshape data for downstream systems.

For strict responsibility boundaries between adapters and lenses, see:

→ `CrypSA_Boundary_Definitions.md`

---

Expand All @@ -117,7 +134,11 @@ Lenses:

Lenses are the **interpretation layer**.

They do not define truth or mutate canonical data.
They interpret data for observer experience.

For strict responsibility boundaries between lenses and adapters, see:

→ `CrypSA_Boundary_Definitions.md`

---

Expand Down Expand Up @@ -152,6 +173,22 @@ This separation prevents:

---

## Responsibility Boundaries

CrypSA enforces strict boundaries between system responsibilities.

These boundaries prevent:

* responsibility overlap
* architectural drift
* ambiguity in system design

For formal definitions of these boundaries, see:

→ `CrypSA_Boundary_Definitions.md`

---

## Why This Structure Exists

Traditional architectures often combine:
Expand All @@ -169,30 +206,36 @@ CrypSA separates them to:
* support multiple observer perspectives
* allow independent evolution of layers

For how this architecture affects infrastructure design, see:

→ `CrypSA_Infrastructure_Implications.md`

---

## Data Flow (Simplified)

```mermaid id="e9z2gk"
```mermaid
flowchart LR

A[Canonical Event History] --> B[Derived Canonical State]
B --> C[Adapters]
C --> D[Lenses]
D --> E[UI / Experience]
A["Canonical Event History"] --> B["Derived Canonical State"]
B --> C["Adapters"]
C --> D["Lenses"]
D --> E["UI / Experience"]
```

---

## Intent Flow (Simplified)

```mermaid id="n3b6rq"
```mermaid
flowchart LR

A[User Action] --> B[Candidate Event]
B --> C[Validator]
C -->|Accepted| D[Canonical Event History]
C -->|Rejected| E[Rejection]
A["User Action"] --> B["Invariant Boundary"]
B -->|Remains Local| C["Local Result"]
B -->|Crosses Boundary| D["Candidate Event"]
D --> E["Validator"]
E -->|Accepted| F["Canonical Event History"]
E -->|Rejected| G["Reconciliation"]
```

---
Expand All @@ -209,7 +252,9 @@ Truth is established through validation and recorded in canonical event history.

Derived canonical state is reconstructed via replay.

> Derived canonical state is a projection of canonical event history. It is not the source of truth.
Derived canonical state is not a source of truth.

> Derived canonical state is a projection of canonical event history.

Everything else builds on that.

Expand Down
62 changes: 42 additions & 20 deletions CrypSA_In_5_Minutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Before reading this, you should have seen:

This document explains the same system in words.

For a complete end-to-end explanation of how CrypSA operates at runtime, see:

→ architecture/CrypSA_Runtime_Model.md

For how CrypSA affects infrastructure and scaling, see:

→ CrypSA_Infrastructure_Implications.md

---

## The Core Idea
Expand All @@ -26,28 +34,29 @@ In CrypSA:
* **observers** simulate locally
* actions are proposed as **candidate events**
* a **validator** evaluates those events
* accepted events become **canonical events**
* canonical events are appended to **canonical event history**
* If accepted, an event becomes canonical and is appended to canonical event history

> The shared world is defined by accepted events, not continuously synchronized state.
> Canonical event history is the source of truth.

---

## The Event Flow
## The Event Flow (Conceptual)

Everything in CrypSA follows a consistent event-driven process:

Everything in CrypSA follows this flow:
* observers simulate locally
* candidate events are proposed
* the validator evaluates events against invariants
* if accepted, events become canonical and are appended to canonical event history
* observers derive state through replay and reconcile with canonical event history

1. An observer simulates locally
2. The observer proposes a **candidate event**
3. The **validator** checks invariants
4. If accepted → the event becomes **canonical and is appended to canonical event history**
5. Observers reconcile to canonical truth
👉 For the exact runtime flow, see:
→ architecture/CrypSA_Runtime_Model.md

This is the boundary between:
This defines the boundary between:

* local possibility
* canonical reality
* local possibility
* canonical reality

---

Expand All @@ -57,6 +66,7 @@ The validator is responsible for:

* accepting or rejecting candidate events
* enforcing invariants
* If accepted, an event becomes canonical and is appended to canonical event history
* maintaining canonical event history

> The validator defines what becomes canonical.
Expand Down Expand Up @@ -96,7 +106,7 @@ end

subgraph Experience
E[UI and Observer Experience]
F[Local Simulation]
F[Local Prediction]
end

A --> B
Expand All @@ -113,7 +123,7 @@ Think of CrypSA like this:

* the validator determines what becomes canonical
* observers simulate what they think is happening
* only validated events become part of canonical history
* only validated events become part of canonical event history
* everything else is local prediction

The system is easiest to understand as **four separate responsibilities**.
Expand Down Expand Up @@ -206,6 +216,18 @@ But:
## Derived State

> Derived canonical state is a projection of canonical event history. It is not the source of truth.
> Derived canonical state is reconstructed via replay.

---

## Determinism

Given the same:

* canonical event history
* interpretation logic

all observers derive equivalent derived canonical state via replay.

---

Expand Down Expand Up @@ -284,7 +306,7 @@ It is a way of structuring:
* authority
* validation
* interpretation
* shared reality
* shared system behavior

---

Expand Down Expand Up @@ -317,8 +339,8 @@ CrypSA is not ideal for:

## If You Understand This, You Understand CrypSA

* events become truth only after validation
* truth is an append-only history
* state is derived, not stored
* events become canonical only after validation
* canonical event history is the source of truth
* derived canonical state is reconstructed via replay
* observers simulate locally and reconcile
* the validator defines canonical reality
* the validator defines what becomes canonical
Loading
Loading