aboutsummaryrefslogtreecommitdiffstats
path: root/docs/store.md
Commit message (Collapse)AuthorAgeFilesLines
* docs/federation-tests: how the store and the federation are testedtv40 hours1-1/+2
| | | | | | | | | | | A plan, the contract the code is built to: the fold and the store tested as pure code, events in and verdicts and states out; a model written plainly from the design, which the store is checked against; every rule by its smallest scenarios; every attack row a test named by its table and number, and a test that every row has one; the promises as properties over generated histories, every order for small ones and seeded ones beyond, cut down before they are printed; the store on Automerge checked against the store in memory; simulations with an adversary node; fixed vectors for every encoding; fuzzing and mutants in longer runs. All of it behind the `federation` feature, by stage.
* docs/store: a remake whose base comes before a checkpointtv40 hours1-7/+11
| | | | | | | | | A node that moved to a checkpoint after a remake's base, and switches to it, would have refused the snapshot for the events it forgot, and stayed apart from the nodes that switched. It keeps its own checkpoint instead, and reads none of what the snapshot holds that its checkpoint forgot, as it reads none of it in the old document; only its own refusals and its operator's drops keep it where it is. A snapshot's checkpoint before its own is one it takes.
* docs/store: merges, forks at heads of several storestv41 hours1-9/+11
| | | | | | | A fork's root may be a checkpoint at heads of several stores, which merges them: it keeps what its fold takes of each. A node holding the history up to all those heads builds it and checks it, and one that doesn't takes it on its operator's word, as with any fork; neither the fork nor the stores it came from take each other's events.
* docs/store: checkpointstv41 hours1-76/+147
| | | | | | | | | | | | | | | A store holds a checkpoint, the state at some heads written down (those heads, the events before them its fold keeps, and what the fold says of the rest), and the events after it. The fold says when a node moves to a later checkpoint: the node builds it itself, forgets what it doesn't keep and every event whose history lacks its heads, and refuses such events from then on, so that it holds what is relevant and nothing else. A checkpoint a node can't build, as it was away too long or joins, it takes only where its operator pins it. A store's root is its first checkpoint, and a fork's root a checkpoint at the heads it forks at, which nodes holding the history up to them check, and others take on their operator's word. On Automerge, a remake's snapshot holds the store as it is at the base, so what a checkpoint forgot leaves the document there.
* docs/store: a store of events, generic over its foldtv41 hours1-0/+306
A set of events that only grows, each named by the SHA-256 of its bytes and naming those it builds on, judged at that history so that every node judges it alike, and read together as one state. What the events are, how one is judged and what they read as is a fold's, a trait the federation is the first to implement. Its first home is a swarm's Automerge document: each event is bytes at `_continuum/events/<ID>`, a change writes events and continuum's protocol data only, and a node puts again every event it doesn't refuse of a change it refuses or drops, so that which change carries an event changes nothing. A compaction's snapshot holds the events at its base, and every event beyond it is put again: remakes, rejoins and a writer's two changes of one number change no event a node holds, and the fold never sees them. It says what is promised, a node's own refusals and drops, forks carrying their root's history, members by the fold, where Automerge sets limits, its attacks, and what its tests check. Nothing of it is built; all of it is to be behind the `federation` feature.