aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides
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:39 +0100
commitdd720b2556fa64bd07dc1d087b502ac4ab0f7899 (patch)
tree1a56f3f9c556a3d44197732d66ba0a1af52f3d35 /docs/guides
parentb00371d1260f4379241a9226d576270dd3a68285 (diff)
vote: propose a checkpoint after so many versions
The votes cast before count at a history from before too: a proposal that died, or a rival, needs there only the votes it lacked, and after a close vote one key voting twice is enough, at any time until a checkpoint above the version that followed. Nodes that took that version refuse it; one lagging behind, or joining from the root, may take it. `federation.md` said it took the keys of two thirds of the parties. A node voting by itself proposes a checkpoint once so many versions were written since its store's (`--store-propose-versions`), as the design lists: with 1, after every version, so that what keys voting twice grow beside a version ends at a checkpoint above it. `federation.md` says how little a rival version takes, row 20 too, and the guides the option.
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/federation/checkpoints.md11
-rw-r--r--docs/guides/federation/voting-by-itself.md22
2 files changed, 19 insertions, 14 deletions
diff --git a/docs/guides/federation/checkpoints.md b/docs/guides/federation/checkpoints.md
index f935421..cd77e28 100644
--- a/docs/guides/federation/checkpoints.md
+++ b/docs/guides/federation/checkpoints.md
@@ -35,11 +35,12 @@ Like any version, it lapses the proposals on the version before: propose one whe
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 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.
+it holds so many events beyond its checkpoint (`--store-propose-events`), so many
+versions were written since it (`--store-propose-versions`, after every version with 1),
+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 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
diff --git a/docs/guides/federation/voting-by-itself.md b/docs/guides/federation/voting-by-itself.md
index cfcdcf3..a31595f 100644
--- a/docs/guides/federation/voting-by-itself.md
+++ b/docs/guides/federation/voting-by-itself.md
@@ -47,15 +47,19 @@ or `POST /admin/events/vote` with `{"proposal": "8d02…", "yes": true}`.
no checkpoint until its store held its checkpoint, or ran, that long by its own clock,
by itself or by hand: the parties it follows move the store once that long at most, and
just started, it holds nothing for a while yet.
-* **Proposing checkpoints** (`--store-propose-events COUNT`, `--store-propose-every
- 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 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.
+* **Proposing checkpoints** (`--store-propose-events COUNT`, `--store-propose-versions
+ COUNT`, `--store-propose-every DURATION`): once it holds so many events beyond its
+ checkpoint, so many versions were written since it, 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 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. With
+ `--store-propose-versions 1`, it proposes one after every version: after a close vote,
+ one key voting twice can pass a rival version at a history from before it, any time
+ later, which nodes lagging behind or joining from the root may take; a checkpoint above
+ that version ends that.
* **`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.