diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/federation.md | 51 | ||||
| -rw-r--r-- | docs/guides/federation/checkpoints.md | 12 | ||||
| -rw-r--r-- | docs/guides/federation/proposing-and-voting.md | 3 | ||||
| -rw-r--r-- | docs/guides/federation/voting-by-itself.md | 10 | ||||
| -rw-r--r-- | docs/openapi.yaml | 8 |
5 files changed, 46 insertions, 38 deletions
diff --git a/docs/federation.md b/docs/federation.md index 669527d..6438c42 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -446,30 +446,32 @@ starting from a checkpoint holds what judging them reads. A proposer names heads held for a while, by its own clock, which judges nothing, so that every node holds them. A party's client, and a node voting by itself, back a checkpoint only where everything they held for a while before it was proposed is among its heads, in their history, or -above them: a move refuses what isn't above its heads, and heads a proposer made up, -built on little, would take back what was written since, a key set dropping a stolen key -among it. A node shows, for a proposed checkpoint, what it holds that its heads lack, as -for a fork ([Forks](#forks)). This is the voter's rule, by its own clock: nothing more is -judged. It is a version only where its proposal is above those heads, and a version event -writing it is taken only where it is above them too, and so is every vote it is written on -([`store.md`](store.md), [Events](store.md#events)): so moving to the checkpoint refuses -nothing that decided it. A party's client, and a node voting by itself, vote on the events -proposing what they vote on, and a node proposes a checkpoint on its heads: so their votes -are above those heads wherever the proposal is. A vote beside them binds its party as any -yes does, until the move refuses it. A node that takes the version moves to the -checkpoint: it builds it, forgets everything before those heads that it doesn't keep, and -every event not above them, and refuses such events from then on. Judging an event after -them needs nothing it forgot: the version, every party's keys and node list, and the -proposals on the current version with their votes all count, and are kept. A node starting -from a checkpoint reads what it keeps as written under its version, as it holds none of -their histories: each was written under that one or an earlier, counting there, a kept -proposal is on it, and a later `since` that leaves one out is past it. A node that can't -build a checkpoint, as it was away across a move and a remake after it, or as it joins, -takes it only where its operator pins it ([`store.md`](store.md), -[Pinned checkpoints](store.md#pinned-checkpoints)). What it can't check of its heads it -takes on its operator's word: that they are after the checkpoint current at the version -naming them, at which that one is current too; so it judges that version as every node -does. +above them, proposals and votes aside, which lapse with the move: a move refuses what +isn't above its heads, and heads a proposer made up, built on little, would take back what +was written since, a key set dropping a stolen key among it. A node shows, for a proposed +checkpoint, what it holds that its heads lack, as for a fork ([Forks](#forks)). This is +the voter's rule, by its own clock: nothing more is judged. It is a version only where its +proposal is above those heads, and a version event writing it is taken only where it is +above them too, and so is every vote it is written on ([`store.md`](store.md), +[Events](store.md#events)): so moving to the checkpoint refuses nothing that decided it. A +party's client, and a node voting by itself, vote on the events proposing what they vote +on that are above those heads, as a node shows them, and a node proposes a checkpoint on +its heads: so their votes are above those heads wherever the proposal is. One proposing it +again beside them they don't build on, as a vote on it would be beside them too. A vote +beside them binds its party as any yes does, until the move refuses it. A node that takes +the version moves to the checkpoint: it builds it, forgets everything before those heads +that it doesn't keep, and every event not above them, and refuses such events from then +on. Judging an event after them needs nothing it forgot: the version, every party's keys +and node list, and the proposals on the current version with their votes all count, and +are kept. A node starting from a checkpoint reads what it keeps as written under its +version, as it holds none of their histories: each was written under that one or an +earlier, counting there, a kept proposal is on it, and a later `since` that leaves one out +is past it. A node that can't build a checkpoint, as it was away across a move and a +remake after it, or as it joins, takes it only where its operator pins it +([`store.md`](store.md), [Pinned checkpoints](store.md#pinned-checkpoints)). What it can't +check of its heads it takes on its operator's word: that they are after the checkpoint +current at the version naming them, at which that one is current too; so it judges that +version as every node does. What a checkpoint loses: what counted no more before it, so that a key added back, or a place given back, brings back nothing signed before it, and a party that voted twice on @@ -730,6 +732,7 @@ fold, with crafted events. *Sim*: a simulation. *Bench*: measured, not judged. | 67 | A party keeps a proposal alive that nobody else backs, to hold back automatic checkpoints | Holds back none: a node proposes a checkpoint beside a proposal it wouldn't back that nobody backs but its proposer | sim | | 68 | A checkpoint proposed at heads that leave out what was written since: a key set dropping a stolen key, say | Not backed: clients and nodes back a checkpoint only where what they held for a while is among its heads, in their history, or above them; a node shows what they lack | unit | | 69 | A key a version names, stolen, writes its party's node list at a history from before the version naming the party's keys anew, beside the list the party writes under that version, several, for the lowest ID | The party's counts: of a party's lists, those written under the latest version come first | unit | +| 70 | A checkpoint's version proposed again, by an event beside its heads | Voters back it all the same, as a proposal lapses with the move, and vote on the events proposing it above its heads, as a node shows them; a version event on votes beside them is refused | unit | ## Roads not taken diff --git a/docs/guides/federation/checkpoints.md b/docs/guides/federation/checkpoints.md index 66f79e9..69debaf 100644 --- a/docs/guides/federation/checkpoints.md +++ b/docs/guides/federation/checkpoints.md @@ -43,12 +43,12 @@ is proposed; and it backs what it proposes. ## Backing one Back a checkpoint only where everything you held for a while before it was proposed is -among its heads, in their history, or above them: heads a proposer made up, built on -little, would take back what was written since, a key set dropping a stolen key among -it. A node voting by itself backs one only so, and so does a vote by hand through it -(`continuum-party vote … --through`). A party's client voting on its own -(`continuum-party vote`) checks no heads: check them yourself, or vote through such a -node. +among its heads, in their history, or above them, proposals and votes aside, which lapse +with the move: heads a proposer made up, built on little, would take back what was +written since, a key set dropping a stolen key among it. A node voting by itself backs one +only so, and so does a vote by hand through it (`continuum-party vote … --through`). A +party's client voting on its own (`continuum-party vote`) checks no heads: check them +yourself, or vote through such a node. * `--store-follow PARTY,…` has a node voting by itself follow those parties' votes, by default on versions that only move to a checkpoint, and still by that rule. diff --git a/docs/guides/federation/proposing-and-voting.md b/docs/guides/federation/proposing-and-voting.md index 0f303ea..2bf0dee 100644 --- a/docs/guides/federation/proposing-and-voting.md +++ b/docs/guides/federation/proposing-and-voting.md @@ -65,7 +65,8 @@ version must (its `number`, `changes`, and each `since`), whose checkpoint, wher one, names none of the heads of the current version's checkpoint, as such a version is never written. It says why it doesn't propose one otherwise. The proposal is on the current version, and its hash is the version's: the node shows it under that -hash (`proposals` in `GET /events/counts`), with the events proposing it. +hash (`proposals` in `GET /events/counts`), with the events proposing it that a vote +may build on: of a checkpoint, those above its heads. Several parties proposing the same version make one proposal. The key a party proposes and votes with is one the current version names for it, not one of its key set: the client checks that before it signs, and records nothing otherwise. diff --git a/docs/guides/federation/voting-by-itself.md b/docs/guides/federation/voting-by-itself.md index 300f60c..b88947a 100644 --- a/docs/guides/federation/voting-by-itself.md +++ b/docs/guides/federation/voting-by-itself.md @@ -61,11 +61,13 @@ no version ([`proposing-and-voting.md`](proposing-and-voting.md), [Voting](proposing-and-voting.md#voting)). And, for a version naming a checkpoint, the voters' rule: it backs one only where it changes nothing of the current version but its number, what it changes and its checkpoint, and its heads leave out nothing it held for a -while before it was proposed ([`checkpoints.md`](checkpoints.md), -[Backing one](checkpoints.md#backing-one)). A vote by hand through it keeps to the same. +while before it was proposed, proposals and votes aside +([`checkpoints.md`](checkpoints.md), [Backing one](checkpoints.md#backing-one)). A vote +by hand through it keeps to the same. -It signs its votes on the events proposing what it votes on, and its checkpoint -proposals on its heads, so that a version event may be written on them. +It signs its votes on the events proposing what it votes on, of a checkpoint those above +its heads, and its checkpoint proposals on its heads, so that a version event may be +written on them. ## Watching it diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 57ef132..349f943 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1529,13 +1529,15 @@ paths: What counts, as the store reads now (docs/federation.md): the current version (its number, its hash, and the version itself), each party's keys and nodes, the value at each place, the members, each `[node, party]`, and the proposals on the - current version, by their hash, each with the IDs of the events proposing it - (`proposals`) and of the votes on it (`votes`), the parties voting `true` (`yes`) + current version, by their hash, each with the IDs of the events proposing it that + a vote may build on (`proposals`: of a version naming a checkpoint, those above + its heads) and of the votes on it (`votes`), the parties voting `true` (`yes`) and `false` (`no`), whether it passed (`passed`: two thirds of the parties voted `true`) and whether it is dead (`dead`: so many voted `false` that the rest can't pass it), and why a party's client backs it not (`none`), where it is no version, none changing the current one, or one naming the heads of the current one's - checkpoint, as this node reads it: one that passed all the same is never written, + checkpoint, as this node reads it, or no event proposing it is above the heads it + names: one that passed all the same is never written, or, no version here, this node stops at its version event. A passed proposal is written at once, and lapses with the rest. responses: |
