diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/example.toml | 8 | ||||
| -rw-r--r-- | docs/federation.md | 27 | ||||
| -rw-r--r-- | docs/guides/federation/checkpoints.md | 7 | ||||
| -rw-r--r-- | docs/guides/federation/voting-by-itself.md | 15 |
4 files changed, 37 insertions, 20 deletions
diff --git a/docs/example.toml b/docs/example.toml index 7f01df7..4bb5c98 100644 --- a/docs/example.toml +++ b/docs/example.toml @@ -151,10 +151,11 @@ htpasswd = "/etc/continuum/htpasswd" # Behind the `federation` feature: this node votes and proposes for its party by itself # (docs/federation.md, Votes a node casts by itself), with a key its party's version # names, kept here, and its party's one record of its votes; its party then votes by -# hand only through it (POST /admin/events/vote). It follows the parties named (by -# default only on versions that only move to a checkpoint), votes `false` on a +# hand only through it (POST /admin/events/vote). It follows the `true` of the parties +# named (by default only on versions that only move to a checkpoint), votes `false` on a # checkpoint proposed beside one it backs, if told, and proposes a checkpoint once it -# holds so many events beyond its checkpoint, or so long after it moved there. +# holds so many events beyond its checkpoint, or so long after it moved there; it backs +# and proposes none sooner than store-back-after after a move or its start. # store-vote-key = "/var/lib/continuum/party.key" # store-vote-record = "/var/lib/continuum/party-record.json" # store-follow = ["lass"] @@ -163,6 +164,7 @@ htpasswd = "/etc/continuum/htpasswd" # store-propose-events = 10000 # store-propose-every = "7d" # store-held-for = "10m" +# store-back-after = "10m" # SSH keys, as authorized_keys lines (ssh-ed25519 <base64> [comment]), whose signature # on a strict remake's manifest this node takes: the values kept when the swarm turns diff --git a/docs/federation.md b/docs/federation.md index ade27a9..784915a 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -505,14 +505,18 @@ A party may have one of its nodes vote and propose for it, by rules its operator the rules are written nowhere in the swarm, and every node judges what such a node signs as it judges any vote or proposal. The design has two in mind: -* **Following**: back a proposal where a party the rule names backed it, and vote - `false` where that party did; a proposal binds its proposer to nothing, so following - one would bind the node where that party is free. By default it follows only on a - version that only moves to a checkpoint ([Checkpoints](#checkpoints)), a `true` as a - `false`; its operator may have it follow on any version, which hands that party the - node's vote, its `false` among it: a party followed so by more than a third of the - parties, its key kept on a node, ends every proposal, the one naming that key anew among - them. +* **Following**: back a proposal where a party the rule names backed it; a proposal + binds its proposer to nothing, so following one would bind the node where that party is + free. A `false` it copies not: copied, one party's `false` would free bound followers, + 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. * **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 @@ -529,7 +533,10 @@ rule for checkpoints, none for a version that changes more than its number, what changes and its checkpoint, which it checks against the current one, nor for one whose heads leave out what it held for a while ([Checkpoints](#checkpoints)). Where two checkpoints are proposed at once, the votes split, as any do; a rule may vote `false` on -the one it doesn't back, so that one dies and its backers are free. A node that stopped +the one it doesn't back, so that one dies and its backers are free. It backs, and +proposes, a checkpoint only once its store held its checkpoint, or ran, for a while, by +its own clock: so the parties it follows move the store at most once that long, and a +node just started, which holds nothing for a while yet, backs none. A node that stopped at a version it doesn't read casts nothing, by itself or by hand, as what it reads is behind ([Changing the federation](#changing-the-federation)). @@ -722,7 +729,7 @@ fold, with crafted events. *Sim*: a simulation. *Bench*: measured, not judged. | 55 | A checkpoint a node can't build, handed to it by peers, or a fork's root it can't check | Taken only where its operator pinned it, or named the fork | unit | | 56 | Two versions changing one, naming different checkpoints | As 12: each node keeps the one it took, and moves to its checkpoint | unit | | 57 | A key added back, or a place given back, after a checkpoint | Brings back nothing signed before the checkpoint that counted no more there | unit | -| 58 | A party a node follows backs, or votes `false` on, a version that changes more than its checkpoint | By default the node follows neither; one following on any version does, as its operator chose | unit | +| 58 | A party a node follows backs, or votes `false` on, a version that changes more than its checkpoint | By default the node follows neither; one following on any version backs the one, as its operator chose, and copies no `false` | unit | | 59 | Two checkpoints proposed at once, by nodes voting by themselves | The votes split; nays from the nodes backing one make the other dead, and its backers are free | sim | | 60 | Two nodes of one party, each voting by itself | They can vote twice, answered as any party voting twice: a party has one node vote by itself | — | | 61 | A key a version names, kept on a node that votes by itself, stolen with it | As 23: it counts while that version is current | unit | diff --git a/docs/guides/federation/checkpoints.md b/docs/guides/federation/checkpoints.md index 69debaf..345bc98 100644 --- a/docs/guides/federation/checkpoints.md +++ b/docs/guides/federation/checkpoints.md @@ -50,8 +50,11 @@ only so, and so does a vote by hand through it (`continuum-party vote … --thro 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. +* `--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. +* `--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 checkpoint, where it backs one that can still pass: of two checkpoints proposed at once, the other dies, and its backers are free. diff --git a/docs/guides/federation/voting-by-itself.md b/docs/guides/federation/voting-by-itself.md index b88947a..97f4eff 100644 --- a/docs/guides/federation/voting-by-itself.md +++ b/docs/guides/federation/voting-by-itself.md @@ -37,11 +37,16 @@ or `POST /admin/events/vote` with `{"proposal": "8d02…", "yes": true}`. ## Its rules * **Following** (`--store-follow PARTY,…`): it votes `true` on a proposal where a party - it follows voted `true`, and `false` where one voted `false`; by default only on a - version that only moves to a checkpoint. With `--store-follow-any`, on any version: - that hands those parties the node's vote, its `false` among it. A party followed so by - more than a third of the parties, with its key kept on a node, can end every proposal, - the one naming that key anew among them. + 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 + 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. +* **After a move** (`--store-back-after`, ten minutes unless set): it backs, and proposes, + 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 |
