diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/federation.md | 65 |
1 files changed, 34 insertions, 31 deletions
diff --git a/docs/federation.md b/docs/federation.md index a43dadc..43f5856 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -119,7 +119,10 @@ Spread out: * **`deps`**: the IDs of its dependencies, as 64 lower-case hex digits, one at least, ascending, none twice; a client gives the heads it read. * **`party`** and **`key`**: the party that signs it, and the key it signs with: - `ssh-ed25519`, one space, and the key's base64, padded and canonical, with no comment. + `ssh-ed25519`, one space, and the key's base64, padded and canonical, with no comment, + its 32 bytes an Ed25519 public key. Keys in a version and a key set are spelled so + too, and node IDs as continuum spells them: `continuum:` and the 64 lower-case hex + digits of the node's Ed25519 public key. * **What it does**, one of: `write`, a value at a place (The policy); `keys`, the party's key set (Keys); `nodes`, its node list (Nodes); `proposal` and `vote` (Changing the policy). @@ -160,9 +163,9 @@ current at its heads, Forks). Spread out: ```json { "federation": 1, "number": 7, "changes": "<hash of the version it changes>", - "keys": { "tv": { "since": 0, "keys": ["ssh-ed25519 AAAA… tv"] }, - "lass": { "since": 4, "keys": ["ssh-ed25519 AAAA… lass"] }, - "makefu": { "since": 7, "keys": ["ssh-ed25519 AAAA… makefu"] } }, + "keys": { "tv": { "since": 0, "keys": ["ssh-ed25519 AAAA…"] }, + "lass": { "since": 4, "keys": ["ssh-ed25519 AAAA…"] }, + "makefu": { "since": 7, "keys": ["ssh-ed25519 AAAA…"] } }, "nodes": { "tv": { "since": 0, "nodes": ["<node ID>"] }, "lass": { "since": 4, "nodes": [] }, "makefu": { "since": 7, "nodes": [] } }, @@ -178,18 +181,17 @@ current at its heads, Forks). Spread out: * **The federation** it follows, and its **number**, one more than that of the version it changes. * **The parties and their keys** (`keys`): one party at least, each by name, as - continuum's user names, 1 to 64 of `A-Z a-z 0-9 . _ @ -`, with one - `ssh-ed25519` key or more, compared as keys (their comments aside), none twice in the - version. With them the party signs its votes and proposals on this version, its key - set and its node list (Keys, Nodes). Its `since` is the number of the version that - named them anew: this one's where it does (a party new in it, keys the parties - replace, or the same keys named anew), else the `since` the version it changes gives - the party, whose keys it then names unchanged. -* **The node lists** (`nodes`): every party's, a list of node IDs with its `since` as - keys have one. The version that lets a party in names its list anew, empty where it - gives it no nodes, so that a list it wrote before it was taken out counts no more; a - later version may name it anew again; the first version and a fork's name those of the - parties that start it (Nodes). + continuum's user names, 1 to 64 of `A-Z a-z 0-9 . _ @ -`, with one `ssh-ed25519` key + or more, none twice in the version. With them the party signs its votes and proposals + on this version, its key set and its node list (Keys, Nodes). Its `since` is the + number of the version that named them anew: this one's where it does (a party new in + it, keys the parties replace, or the same keys named anew), else the `since` the + version it changes gives the party, whose keys it then names unchanged. +* **The node lists** (`nodes`): every party's, a list of node IDs, none twice, with its + `since` as keys have one. The version that lets a party in names its list anew, empty + where it gives it no nodes, so that a list it wrote before it was taken out counts no + more; a later version may name it anew again; the first version and a fork's name + those of the parties that start it (Nodes). * **The checkpoint** (`checkpoint`), where the version names one: the heads at which the store moves to a checkpoint once the version is current (Checkpoints). * **The rules**, in order: the first whose path matches a path says who writes there. A @@ -330,9 +332,9 @@ federation itself, by naming another (Changing the federation). A party votes and proposes with the keys its version names for it, and signs with them its key set and its node list. Everything else it signs with the keys of its **key -set**: a `keys` event, the list of its keys, signed with a key the version it is written -under names for the party. A set is checked only where it is written, never by the keys -of a set (What counts, 2). +set**: a `keys` event, the list of its keys, none twice, signed with a key the version +it is written under names for the party. A set is checked only where it is written, +never by the keys of a set (What counts, 2). A party's keys are those of its set (What counts, 5) where the set is written under a version numbered at least the `since` its version gives the party's keys; otherwise, and @@ -487,18 +489,19 @@ forbids: a party votes from one client, and that node is it. ### Nodes A party lists the nodes that carry for it, by node ID, in its **node list**: a `nodes` -event, the list of its nodes' IDs, signed with a key the version it is written under -names for the party. A party's list is that one (What counts, 5) where it is written -under a version numbered at least the `since` its version gives the party's list, -otherwise the list its version gives, if any, as with keys (Keys). The store's members -are the nodes each party's list names, each as its party's ([`store.md`](store.md), -Members); another party's list does nothing for a node. A party's list counts until the -party writes another or a version names one anew, whatever keys its version names since, -so that no change of keys leaves a swarm without members; a list a stolen key wrote -stays until the party writes one under the version that replaced that key, which it can -at once, through any member. A node puts whatever events it is given, its party's and -others' alike: what counts is who signed an event, not which node put it. So a party -without nodes of its own writes through any node that takes its events. +event, the list of its nodes' IDs, none twice, signed with a key the version it is +written under names for the party. A party's list is that one (What counts, 5) where it +is written under a version numbered at least the `since` its version gives the party's +list, otherwise the list its version gives, if any, as with keys (Keys). The store's +members are the nodes each party's list names, each as its party's +([`store.md`](store.md), Members); another party's list does nothing for a node. A +party's list counts until the party writes another or a version names one anew, whatever +keys its version names since, so that no change of keys leaves a swarm without members; +a list a stolen key wrote stays until the party writes one under the version that +replaced that key, which it can at once, through any member. A node puts whatever events +it is given, its party's and others' alike: what counts is who signed an event, not +which node put it. So a party without nodes of its own writes through any node that +takes its events. ### Forks |
