aboutsummaryrefslogtreecommitdiffstats
path: root/CHANGELOG.md
blob: 427ae2126bddc42b63d28e04a3612d56d483ac61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# Changelog

Notable changes, newest first; fixes and internal work that change nothing anyone relies
on are left out. A release is tagged `v<version>`, and its version says how to upgrade to
it from the release before ([`docs/operations.md`](docs/operations.md),
[Upgrading](docs/operations.md#upgrading)).

## Unreleased

* `continuum-party status` says everything about the federation at the node but the
  values: every party's keys and nodes, when each was heard from and what it runs, every
  proposal with its votes, who hasn't voted, and what it does, and the party's own key,
  record and what to sign again; in colour on a terminal, and with `--json` as one JSON
  object of a versioned format
  ([`docs/guides/federation/watching.md`](docs/guides/federation/watching.md);
  [`src/federation/party/status.rs`](src/federation/party/status.rs)).

* Before a vote, `continuum-party` holds the record against the party's votes the node
  shows, refusing where another record voted, and says what may keep votes away: the
  party's nodes, or a third of the parties, not heard from lately (`heard` in
  `GET /events/counts`); it waits a few seconds and asks again before it casts
  (`--wait`). `restore` takes the party's votes from the node into a record, best effort
  ([`docs/guides/federation/proposing-and-voting.md`](docs/guides/federation/proposing-and-voting.md),
  [Voting](docs/guides/federation/proposing-and-voting.md#voting);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum-party get PATH` reads what counts as JSON: a place's value, or what lies
  under a path as one object, within places' values too; `-r` a string as it is
  ([`docs/guides/federation/writing-and-reading.md`](docs/guides/federation/writing-and-reading.md),
  [Reading](docs/guides/federation/writing-and-reading.md#reading);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum-party status` says the party's keys and nodes a line each, its nodes by the
  names they gave themselves, which `GET /events/counts` shows (`names`)
  ([`docs/guides/federation/watching.md`](docs/guides/federation/watching.md);
  [`src/federation/party.rs`](src/federation/party.rs), [`src/api/events.rs`](src/api/events.rs)).

* `continuum-party --party NAME` names the party it reads as where no record does: one who
  only reads needs no record ([`docs/configuration.md`](docs/configuration.md),
  [The party's client](docs/configuration.md#the-partys-client)).

* `continuum-party` logs in as its party by its key where `--node` names no user and no
  `--token` is given ([`docs/configuration.md`](docs/configuration.md),
  [The party's client](docs/configuration.md#the-partys-client);
  [`src/federation/party.rs`](src/federation/party.rs)).

* A party's keys log in to every federated node without a password, as the party
  (`POST /auth/login/party`): a session that reads and puts events and checks forks, and
  does nothing else ([`docs/guides/federation/running-a-node.md`](docs/guides/federation/running-a-node.md),
  [Its API](docs/guides/federation/running-a-node.md#its-api);
  [`src/api/login.rs`](src/api/login.rs), [`src/api/access.rs`](src/api/access.rs)).

* A federated node's users named in `--store-readers` read the federation there and do
  nothing else; its other users are its operators, as all were
  ([`docs/guides/federation/running-a-node.md`](docs/guides/federation/running-a-node.md),
  [Its API](docs/guides/federation/running-a-node.md#its-api);
  [`src/api/access.rs`](src/api/access.rs)).

* Bash completion for `continuum-party`, with the proposals, parties, places and
  federations it finds
  ([`share/bash-completion/completions/continuum-party`](share/bash-completion/completions/continuum-party);
  [`docs/configuration.md`](docs/configuration.md),
  [The party's client](docs/configuration.md#the-partys-client)).

* `continuum-party found` writes a federation's first version from its parties' keys,
  node lists and rules
  ([`docs/guides/federation/getting-started.md`](docs/guides/federation/getting-started.md);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum node-id FILE` prints the node ID of a node key, `--create` making it, without
  starting a node ([`docs/lifecycle.md`](docs/lifecycle.md); [`src/config/mod.rs`](src/config/mod.rs)).

* `continuum-party status` says at a glance where the party and its node stand: the
  store and its version, the party's keys and nodes, a stop, the proposals, refused
  versions, and what to sign again; `values [PATH]` shows what counts, with who writes
  there ([`docs/guides/federation/watching.md`](docs/guides/federation/watching.md),
  [`docs/guides/federation/writing-and-reading.md`](docs/guides/federation/writing-and-reading.md);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum-party fork` takes the changes `propose` does, or a proposal's version
  (`fork proposal PROPOSAL`), forking at the heads the node shows unless others are named
  (`--at`); `--founder PARTY=NODE,…` names a founder's node list anew in the fork
  ([`docs/guides/federation/forking-and-following.md`](docs/guides/federation/forking-and-following.md);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum-party propose` takes the changes made most by what they are for: `admit`,
  `remove`, `give`, `take`, `keys`, `nodes`, `checkpoint` and `revision` write the next
  version so and propose it. Every proposal says first what it does, and asks on a
  terminal; `--print` writes the version instead
  ([`docs/guides/federation/common-changes.md`](docs/guides/federation/common-changes.md);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `scripts/wire-check` runs a swarm of the last release's nodes and this tree's on one
  host, and checks they talk where their wire versions meet, and say so where they
  don't; `scripts/release` runs it ([`docs/development.md`](docs/development.md),
  [Releasing](docs/development.md#releasing); [`scripts/wire-check`](scripts/wire-check)).

* A node speaks several wire versions side by side and writes each peer the newest both
  speak, as the peer's SPEAKS says; SPEAKS goes ahead of each WHO and ME now, and WHO
  and ME read alike in every version. So a release adding a wire version and keeping
  the older rolls out node by node ([`docs/operations.md`](docs/operations.md),
  [Upgrading](docs/operations.md#upgrading);
  [`src/transport/wire.rs`](src/transport/wire.rs),
  [`src/transport/identity.rs`](src/transport/identity.rs)).

* `scripts/release` makes a release: it checks the tree, says from the last release's
  wire versions, Automerge and revisions whether it rolls out node by node, and commits
  and tags it, pushing nothing ([`docs/development.md`](docs/development.md),
  [Releasing](docs/development.md#releasing); [`scripts/release`](scripts/release)).

* Automerge is pinned to exactly the version `Cargo.toml` names, so no rebuild changes
  what nodes must agree on unnoticed ([`docs/operations.md`](docs/operations.md),
  [Upgrading](docs/operations.md#upgrading); [`Cargo.toml`](Cargo.toml)).

* `continuum-party show` says what a proposal does, in words, before a vote: who voted
  what, the parties let in or taken out, keys by fingerprint, rules added and dropped, a
  checkpoint and what moving there refuses, a revision, who writes where after it.
  `proposals` says each so, and `vote` says it, then asks on a terminal before it casts
  ([`docs/guides/federation/proposing-and-voting.md`](docs/guides/federation/proposing-and-voting.md),
  [Following a vote](docs/guides/federation/proposing-and-voting.md#following-a-vote);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `GET /events/counts` shows, of a proposed checkpoint, what moving there refuses of what
  the parties signed (`beside`), as the docs said a node shows
  ([`docs/guides/federation/checkpoints.md`](docs/guides/federation/checkpoints.md),
  [Backing one](docs/guides/federation/checkpoints.md#backing-one);
  [`src/federation/store/memory.rs`](src/federation/store/memory.rs)).

* `continuum-party` keeps a directory per federation, `~/.config/continuum/federations/
  NAME/`, with its options (`party.toml`), record and key: `--federation` chooses one,
  the only one is used unasked, and `init --federation NAME` begins one
  ([`docs/configuration.md`](docs/configuration.md),
  [The party's client](docs/configuration.md#the-partys-client);
  [`src/federation/party.rs`](src/federation/party.rs)).

* `continuum-party` takes a proposal's hash, or a head's ID, by a prefix of four digits or
  more that names it alone, and marks the shortest such prefix in bold on a terminal
  ([`docs/guides/federation/proposing-and-voting.md`](docs/guides/federation/proposing-and-voting.md),
  [Voting](docs/guides/federation/proposing-and-voting.md#voting);
  [`src/federation/client.rs`](src/federation/client.rs)).

* A node meeting a peer on another wire version names both versions in its warning, and
  which node to upgrade ([`docs/operations.md`](docs/operations.md),
  [Upgrading](docs/operations.md#upgrading); [`src/transport/wire.rs`](src/transport/wire.rs)).

## 0.0.1 (2026-11-19)

The first release to keep this log; a flag day from anything before it. What it holds:

* A replicated Automerge document, read and written as JSON by path over an HTTP API
  ([`docs/api.md`](docs/api.md), [`docs/openapi.yaml`](docs/openapi.yaml)), synced
  over Mycelium, libp2p or Tor, one or several at once
  ([`docs/transports.md`](docs/transports.md)).
* Remakes, compacting the history by a majority of the members
  ([`docs/remakes.md`](docs/remakes.md)).
* Users, tokens, logins by key, and access by path ([`docs/access.md`](docs/access.md)).
* The dashboard ([`docs/dashboard.md`](docs/dashboard.md)).
* Behind the `federation` feature, a swarm kept by parties that don't trust each other,
  deciding by two thirds ([`docs/federation.md`](docs/federation.md), the guides in
  [`docs/guides/federation/`](docs/guides/federation/README.md),
  [`src/federation/`](src/federation/)), and the party's client, `continuum-party`. Its
  federation 1 knows revision 1, merge events; `scripts/federation-check` checks a tree
  against the release tagged `federation-<F>.<R>`
  ([`docs/federation-tests.md`](docs/federation-tests.md)).
* `continuum --version` says the wire versions, the federation's revisions and the
  Automerge version a build has, and nodes tell their peers theirs (`knows` in
  `GET /peers` and `GET /events/counts`).