aboutsummaryrefslogtreecommitdiffstats
path: root/docs/development.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 16:15:04 +0000
committertv <tv@krebsco.de>2026-11-16 18:00:40 +0100
commit7bb467a013a9146620b633e3c3cdd21e3a48f80f (patch)
tree0fe86ef999faaf3547803aa73e391982a8ea3af8 /docs/development.md
parent40db32407a341f8fec2795ffb11821842e79334d (diff)
federation: the feature, and the store's fold
`federation`, a feature of its own, builds what `docs/federation.md` and `docs/store.md` design, stage by stage; without it continuum builds and behaves as it does. The aliases build with it, and `docs/development.md` says so. Its first part is the store's: an event's ID, the SHA-256 of its bytes written as 64 lower-case hex digits and read back only so, and the `Fold` trait as `docs/store.md` gives it. The trait reads a checkpoint's parts too, the heads it was built at and the events it keeps, which a node taking a pinned checkpoint needs; the design names it. Nothing uses either yet, but a test.
Diffstat (limited to 'docs/development.md')
-rw-r--r--docs/development.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/development.md b/docs/development.md
index 85f6fce..314ae11 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -3,19 +3,22 @@
## The loop
```sh
-cargo check --features mycelium,libp2p,tor,dashboard # does it compile: seconds
-cargo quick # every test but the simulations: seconds
-cargo sim # the simulations (src/simtest/): under a minute
-cargo test --features mycelium,libp2p,tor,dashboard # both
-cargo benchmarks # the benchmarks, in release builds
+cargo check --features mycelium,libp2p,tor,dashboard,federation # does it compile: seconds
+cargo quick # every test but the simulations: seconds
+cargo sim # the simulations (src/simtest/): under a minute
+cargo test --features mycelium,libp2p,tor,dashboard,federation # both
+cargo benchmarks # the benchmarks, in release builds
```
`cargo quick`, `cargo sim` and `cargo benchmarks` are aliases ([`.cargo/config.toml`](../.cargo/config.toml)),
-with every transport and the dashboard (`dashboard`, `GET /admin/dashboard`;
-[`docs/dashboard.md`](dashboard.md)). Each transport is a feature, none of them default, and a build
-needs at least one: a transport left out takes its tests and dependencies with it
-(`--features libp2p` builds neither `reqwest` and the daemon supervision of Mycelium,
-nor arti; among Mycelium's tests is a swarm simulated on its envelope).
+with every transport, the dashboard (`dashboard`, `GET /admin/dashboard`;
+[`docs/dashboard.md`](dashboard.md)) and the federation (`federation`, built stage by stage and
+not yet run by a node: [`docs/federation.md`](federation.md), [`docs/store.md`](store.md)); a
+build without `federation` runs the tests continuum has without it. Each transport is a feature,
+none of them default, and a build needs at least one: a transport left out takes its tests
+and dependencies with it (`--features libp2p` builds neither `reqwest` and the daemon
+supervision of Mycelium, nor arti; among Mycelium's tests is a swarm simulated on its
+envelope).
The benchmarks are ignored tests named `bench_*`: the document's (writes and sync
messages, what signing and checking every change would cost: `bench_change_signatures`,