aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/openapi.yaml17
-rw-r--r--docs/store.md6
2 files changed, 14 insertions, 9 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 349f943..5c90037 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1417,14 +1417,15 @@ paths:
tags: [Events]
summary: The store
description: |
- The store's ID (its root's), its checkpoint's ID, its heads (what a new event
- builds on) and how many events it took after its checkpoint, as this node reads
- it now; the event it stopped at, if any (`stopped`: a version event writing a
- version that passed, which this continuum doesn't read), why, and how many
- events it holds back since, that one among them, taking nothing and refusing
- nothing until upgraded or told to drop it (`/admin/events/drop`); the party this
- node is of (`party`, `--store-party`), and whether it votes for it by itself
- (`votesByItself`), and so casts votes by hand (`POST /admin/events/vote`).
+ The store's ID (its root's), its checkpoint's ID, its heads, as many as an event
+ may name (64), the earliest taken first (what a new event builds on), and how many
+ events it took after its checkpoint, as this node reads it now; the event it
+ stopped at, if any (`stopped`: a version event writing a version that passed,
+ which this continuum doesn't read), why, and how many events it holds back since,
+ that one among them, taking nothing and refusing nothing until upgraded or told to
+ drop it (`/admin/events/drop`); the party this node is of (`party`,
+ `--store-party`), and whether it votes for it by itself (`votesByItself`), and so
+ casts votes by hand (`POST /admin/events/vote`).
responses:
'200':
description: The store.
diff --git a/docs/store.md b/docs/store.md
index ad98f9f..d5159f6 100644
--- a/docs/store.md
+++ b/docs/store.md
@@ -100,7 +100,9 @@ A fold says, of its events:
* **what an event builds on**, read from its bytes; bytes that aren't one of its events
are none, and are refused;
* **how large an event may be**, which the document judges a change by
- ([On Automerge](#on-automerge));
+ ([On Automerge](#on-automerge)), and how many events it may build on: a new event
+ builds on the heads of what a node holds, as many as that, the earliest taken first, so
+ that what is written merges what stayed apart the longest;
* **whether an event is taken where its history reads as a given state**: judging. A
root is taken only as its own store's, never by judging;
* **the state a checkpoint and the events after it read as**, built by adding the events
@@ -126,6 +128,8 @@ pub trait Fold {
type State: Clone;
/// The most bytes an event may have: larger ones are none.
const LARGEST: usize;
+ /// The most events an event may build on.
+ const DEPENDENCIES: usize = usize::MAX;
/// What the event builds on; `None` where its bytes are none of this fold's events.
fn dependencies(event: &[u8]) -> Option<Vec<Id>>;
/// Whether the event is taken where its history reads as `at`, as far as it reads it.