summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-18 20:12:04 +0000
committertv <tv@krebsco.de>2026-11-18 21:17:57 +0100
commit7404dcef34dbad11a5ac2a6b8a27836b01c82635 (patch)
tree9f2f55ad01130e454f6c6e9f308b459caadea6e9 /docs
parent657765cc512743c248d71b852b4f2e81fa124af7 (diff)
events: why no party's client backs a proposal
`GET /events/counts` gives each proposal on the current version `none`: why a party's client backs it not (`client::backable`), where it is no version as this node reads it, none changing the current one, or one naming the heads of the current one's checkpoint; else `null`. So a node shows that a proposal is none, and why, before it passes: one that passes all the same is never written, or, no version here, the node stops at its version event. The dashboard shows it with the proposal, and `continuum-party proposals` says it by the federation the client knows. Row 48's test checks what a node shows of the proposal.
Diffstat (limited to 'docs')
-rw-r--r--docs/dashboard.md5
-rw-r--r--docs/guides/federation/proposing-and-voting.md14
-rw-r--r--docs/openapi.yaml10
3 files changed, 19 insertions, 10 deletions
diff --git a/docs/dashboard.md b/docs/dashboard.md
index a5676ce..f68fb06 100644
--- a/docs/dashboard.md
+++ b/docs/dashboard.md
@@ -411,8 +411,9 @@ federation again; the page keeps the choice. While shown, it is read every 5 s:
whose path holds what is typed in it;
* **proposals on version …**: each proposal on the current version, by its hash:
whether it passed, is dead, or can still pass; the parties voting `true` and `false`;
- how many events propose it and how many votes are on it; and what its version changes
- of the current one, a line each, as `continuum-party proposals` says it;
+ how many events propose it and how many votes are on it; why no party's client backs
+ it, where none does (no version as this node reads it, say); and what its version
+ changes of the current one, a line each, as `continuum-party proposals` says it;
* **refused**: what this node refused by what it took before (keys voted twice: tell its
party), what it dropped as its operator says, and what it refused as every node does,
each with its kind and why.
diff --git a/docs/guides/federation/proposing-and-voting.md b/docs/guides/federation/proposing-and-voting.md
index 12f8dfd..0f303ea 100644
--- a/docs/guides/federation/proposing-and-voting.md
+++ b/docs/guides/federation/proposing-and-voting.md
@@ -136,17 +136,19 @@ kills it the sooner, and frees its backers for another.
`GET /events/counts` names each proposal on the current version with the events
proposing it (`proposals`) and the votes on it (`votes`), each by its ID; the parties
-voting `true` (`yes`) and `false` (`no`); and whether it passed (`passed`) and whether
-it is dead (`dead`), as the node reads its votes:
+voting `true` (`yes`) and `false` (`no`); whether it passed (`passed`) and whether it is
+dead (`dead`), as the node reads its votes; and why no party's client backs it (`none`),
+where it is no version this node reads, none changing the current one, or one naming the
+heads of the current one's checkpoint, else `null`:
```sh
curl -s -u tv:secret localhost:3000/events/counts | jq .proposals
-# {"8d02…":{"dead":true,"no":["lass"],"passed":false,"proposals":["c41e…"],
-# "votes":["5a77…","e019…"],"yes":["tv"]}}
+# {"8d02…":{"dead":true,"no":["lass"],"none":null,"passed":false,
+# "proposals":["c41e…"],"votes":["5a77…","e019…"],"yes":["tv"]}}
```
-The client shows the same, and what each proposal's version changes of the current one,
-field by field and party by party:
+The client shows the same, why it backs one not, by the federation it knows, and what
+each proposal's version changes of the current one, field by field and party by party:
```sh
continuum-party --node http://tv:secret@localhost:3000 proposals
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index e1e602a..57ef132 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1533,7 +1533,11 @@ paths:
(`proposals`) 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). A passed proposal is written at once, and lapses with the rest.
+ 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,
+ or, no version here, this node stops at its version event. A passed proposal is
+ written at once, and lapses with the rest.
responses:
'200':
description: What counts.
@@ -1559,7 +1563,7 @@ paths:
type: object
additionalProperties:
type: object
- required: [proposals, votes, yes, no, passed, dead]
+ required: [proposals, votes, yes, no, passed, dead, none]
properties:
proposals:
type: array
@@ -1581,6 +1585,8 @@ paths:
type: boolean
dead:
type: boolean
+ none:
+ type: [string, 'null']
'404':
$ref: '#/components/responses/Error'
/events/refused: