diff options
Diffstat (limited to 'docs/federation.md')
| -rw-r--r-- | docs/federation.md | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/docs/federation.md b/docs/federation.md index 43f5856..45e7e25 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -123,9 +123,14 @@ Spread out: 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). +* **What it does**, one field of: + * `write`, `{"path": "<path>", "value": <value>}`: a value at a place (The policy); + * `keys`, `["<key>", …]`: the party's key set (Keys); + * `nodes`, `["<node ID>", …]`: its node list (Nodes); + * `proposal`, a version, the object (Changing the policy); + * `vote`, `{"on": "<hash>", "proposal": "<hash>", "yes": true}`, `"yes"` `true` or + `false` (Changing the policy): a version's hash, the SHA-256 of its JCS bytes, + written as an ID is. * **`sig`**: an SSH signature (`ssh-keygen -Y sign`, namespace `continuum-federation`) over the event's bytes without `sig`: the SSHSIG blob of version 1, hashed with `sha512`, its key the event's `key`, its reserved field empty, as `ssh-keygen` writes @@ -234,9 +239,8 @@ signed with one of the keys the version it is written under names for its party: proposal is **on** that version, and its hash is the version's. It counts as signed by those keys, whatever keys the party writes since, until it lapses. -A party **votes** on a proposal by a `vote` event, -`{"on": <hash>, "proposal": <hash>, "yes": true}` or `"yes": false`: the version the -proposal is on, and the proposal, by their hashes. +A party **votes** on a proposal by a `vote` event, naming the version the proposal is on +(`on`) and the proposal, by their hashes, and saying `true` or `false` (`yes`). * **A vote is taken only where, at its history, the version it is on is current and its proposal is proposed on it.** A vote cast at a history from before can't reach a @@ -564,10 +568,11 @@ keeps nothing, its version the first, which no party signs (Checkpoints), so one version makes one federation, named by the root's ID. Among the node lists the version gives, one names a node of its founders', so the federation starts with members, and other nodes come in as their parties list them. Its swarm's genesis change holds the -root, built byte for byte from it ([`store.md`](store.md), On Automerge). So nothing is -from before the federation: it changes by versions, and any group carries on by a fork. -A running swarm doesn't become federated; its parties start one, and sign into it what -they keep. +root, built byte for byte from it, its policy naming the fold `federation` +(`{"version": 2, "store": "federation"}`, [`store.md`](store.md), On Automerge). So +nothing is from before the federation: it changes by versions, and any group carries on +by a fork. A running swarm doesn't become federated; its parties start one, and sign +into it what they keep. ## Why it holds |
