aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 01:48:58 +0000
committertv <tv@krebsco.de>2026-11-19 03:19:23 +0100
commitb00371d1260f4379241a9226d576270dd3a68285 (patch)
tree05e4a4f86689112a75cb05fb09904546345937fa /docs
parent101080b8a62709cd2606dece086f959781bdf38f (diff)
vote: a proposal holds back checkpoints by a third, or new for a while
A node voting by itself proposes no checkpoint beside a proposal that holds it back, as the checkpoint would lapse it, and a follower backs none so. A proposal held one back where someone but its proposer backed it: two parties, or one and a stolen key, kept a junk proposal alive, and no automatic checkpoint came while it lived, ending it taking nays from more than a third each round. And one new, its proposer alone backing it, was lapsed at once by a checkpoint its writes brought about. A proposal that can still pass holds back now where a third of the parties back it, someone but its proposer among them; or where it is new, held for less than a while (`--store-held-for`), and its proposer has none older on the version: so it is heard before a checkpoint lapses it, once a version for each proposer. Row 67 says so, and a test of nine parties checks it.
Diffstat (limited to 'docs')
-rw-r--r--docs/federation.md27
-rw-r--r--docs/guides/federation/checkpoints.md9
-rw-r--r--docs/guides/federation/voting-by-itself.md12
3 files changed, 28 insertions, 20 deletions
diff --git a/docs/federation.md b/docs/federation.md
index 784915a..1d77e4f 100644
--- a/docs/federation.md
+++ b/docs/federation.md
@@ -511,20 +511,23 @@ as it judges any vote or proposal. The design has two in mind:
and its `true` shown to some and its `false` to the rest would pass a proposal at one
history and make it dead at another. By default it follows only on a version that only
moves to a checkpoint ([Checkpoints](#checkpoints)), and only where no proposal that
- changes more can still pass, but one nobody backs but its proposer: such a version
- lapses every other proposal, and the party it follows would end any it disliked by
- passing one. Even so, the parties following one hand it their votes on checkpoints: with
- them, it passes one at heads of its choosing, by the voters' rule (below). Its operator
- may have it follow on any version, which hands that party the node's `true`: a party
- followed so by two thirds of the parties, its key kept on a node, passes what it backs.
+ changes more holds it back (below): such a version lapses every other proposal, and the
+ party it follows would end any it disliked by passing one. Even so, the parties
+ following one hand it their votes on checkpoints: with them, it passes one at heads of
+ its choosing, by the voters' rule (below). Its operator may have it follow on any
+ version, which hands that party the node's `true`: a party followed so by two thirds of
+ the parties, its key kept on a node, passes what it backs.
* **Proposing a checkpoint**: propose a version that only moves to a checkpoint, at
heads the node has held for a while, once conditions its operator sets are met: so
many events or bytes held beyond its checkpoint, so many versions since it, or so long
- by its own clock, by which nothing anyone judges goes. It proposes only where nothing
- that can still pass is proposed on the current version, as such a version lapses what
- is, but a proposal it wouldn't back that nobody backs but its proposer: so a party
- keeping one alive holds back no checkpoint. It backs what it proposes, so that the
- nodes following its party back it too.
+ by its own clock, by which nothing anyone judges goes. It proposes only where no
+ proposal on the current version holds it back, as such a version lapses what is: one it
+ would back that can still pass; one that can still pass that a third of the parties
+ back, someone but its proposer among them; or one new, held for less than a while, whose
+ proposer has none older on the version. So neither a party keeping a proposal alive,
+ nor two of a federation of seven or more, hold back checkpoints, and a new proposal is
+ lapsed by none before its proposer is heard, once a version. It backs what it proposes,
+ so that the nodes following its party back it too.
Such a node keeps to what a party's client keeps to: one yes at a time; never `true` and
`false` on one proposal, so a party has one node vote by itself, as two of its nodes
@@ -738,7 +741,7 @@ fold, with crafted events. *Sim*: a simulation. *Bench*: measured, not judged.
| 64 | Checkpoint heads before the current checkpoint, or at which it isn't current, or one in another's history | No version: a version event naming it is refused | unit |
| 65 | After a checkpoint, a party that backed a second proposal once its first was dead, the nays that freed it withheld by those who cast them | Not named: its client keeps those nays with its `true` | unit |
| 66 | Two clients of one party back two proposals at once, or its operator votes by hand beside the node that votes for it | Voting twice: a party votes from one client, the node that votes for it where it has one, through which it votes by hand | — |
-| 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 |
+| 67 | A party keeps a proposal alive that nobody else backs, or two parties of seven or more, to hold back automatic checkpoints | Holds back none past a while: a node proposes a checkpoint beside a proposal it wouldn't back that fewer than a third of the parties back, or nobody but its proposer; a new one holds back for a while, once a version for 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 |
diff --git a/docs/guides/federation/checkpoints.md b/docs/guides/federation/checkpoints.md
index 345bc98..f935421 100644
--- a/docs/guides/federation/checkpoints.md
+++ b/docs/guides/federation/checkpoints.md
@@ -37,8 +37,9 @@ nothing that can still pass is proposed on the current version.
A node voting for its party by itself proposes checkpoints by its operator's rules: once
it holds so many events beyond its checkpoint (`--store-propose-events`), or so long
after its store moved there (`--store-propose-every`), at the heads of what it held for
-a while (`--store-held-for`, ten minutes unless set), where nothing that can still pass
-is proposed; and it backs what it proposes.
+a while (`--store-held-for`, ten minutes unless set), where no proposal holds it back
+([`voting-by-itself.md`](voting-by-itself.md), [Its rules](voting-by-itself.md#its-rules));
+and it backs what it proposes.
## Backing one
@@ -52,7 +53,9 @@ yourself, or vote through such a node.
* `--store-follow PARTY,…` has a node voting by itself follow those parties' `true`,
by default on versions that only move to a checkpoint, and still by that rule, but not
- where a proposal changing more can still pass that someone but its proposer backs.
+ where a proposal changing more holds it back, as a node proposing one keeps to
+ ([`voting-by-itself.md`](voting-by-itself.md),
+ [Its rules](voting-by-itself.md#its-rules)).
* `--store-back-after` (ten minutes unless set) has it back none before its store held its
checkpoint, or ran, that long.
* `--store-nay-beside` has it vote `false` on every other version only moving to a
diff --git a/docs/guides/federation/voting-by-itself.md b/docs/guides/federation/voting-by-itself.md
index 97f4eff..cfcdcf3 100644
--- a/docs/guides/federation/voting-by-itself.md
+++ b/docs/guides/federation/voting-by-itself.md
@@ -38,8 +38,8 @@ or `POST /admin/events/vote` with `{"proposal": "8d02…", "yes": true}`.
* **Following** (`--store-follow PARTY,…`): it votes `true` on a proposal where a party
it follows voted `true`, never `false`; by default only on a version that only moves to
- a checkpoint, and only where no proposal changing more can still pass that someone but
- its proposer backs, as a checkpoint lapses it. Even so, the parties following one hand
+ a checkpoint, and only where no proposal changing more holds it back (below), as a
+ checkpoint lapses it. Even so, the parties following one hand
it their votes on checkpoints. With `--store-follow-any`, on any version: that hands
those parties the node's `true`. A party followed so by two thirds of the parties, with
its key kept on a node, passes what it backs.
@@ -51,9 +51,11 @@ or `POST /admin/events/vote` with `{"proposal": "8d02…", "yes": true}`.
DURATION`): once it holds so many events beyond its checkpoint, or so long after its
store moved there by its own clock, it proposes a version that only moves to a
checkpoint, at the heads of what it held for a while (`--store-held-for`, ten minutes
- unless set), where nothing that can still pass is proposed on the current version,
- but a proposal it wouldn't back that nobody backs but its proposer. It backs what it
- proposes, so that the nodes following its party back it too.
+ unless set), where no proposal on the current version holds it back: one it would back
+ that can still pass; one that can still pass that a third of the parties back, someone
+ but its proposer among them; or one held for less than a while whose proposer has none
+ older on the version. It backs what it proposes, so that the nodes following its party
+ back it too.
* **`false` beside** (`--store-nay-beside`): where it backs a proposal that can still
pass, it votes `false` on every other version only moving to a checkpoint, so that of
two checkpoints proposed at once the other dies, and its backers are free.