From 560aee55df39220d9dda3383b5fa2e49a5edcfaa Mon Sep 17 00:00:00 2001 From: tv Date: Mon, 16 Nov 2026 21:52:05 +0000 Subject: docs: what of the federation is built The federation's design says what of it is built: the store in a swarm's document, members by the federation and the store at a node's API, as the store's design says; and a party's client, which signs its party's events, votes by its record, signs again what a move refused, and names a party that voted twice. --- docs/federation.md | 18 +++++++++++------- src/federation/mod.rs | 7 ++++--- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/federation.md b/docs/federation.md index 8700e45..f1229b0 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -1,12 +1,16 @@ # Federation: a design -A design, built stage by stage (Stages): so far, the store it builds on, held in memory, -and the federation as its fold (`federation::fold`), with the byte formats. It says how -a swarm can be kept by parties that don't trust each other, for a first use: the krebs -registry ([krebs/kartei](https://github.com/krebs/kartei)), today plain files in a git -repository that one maintainer merges into. What it is for is narrow: to hand out -identifiers (names, addresses, keys), and to give every party a namespace of its own -that everyone reads. +A design, built stage by stage (Stages): so far, the store it builds on, held in memory +and in a swarm's document, members by the federation and the store at a node's API, as +[`store.md`](store.md) says; the federation as its fold (`federation::fold`), with the +byte formats; and a party's client (`continuum-party`, `federation::client`), which +signs its party's events, votes by its record, signs again what a move refused, and +names a party that voted twice. It says how a swarm can be kept by parties that don't +trust each other, for a first use: the krebs registry +([krebs/kartei](https://github.com/krebs/kartei)), today plain files in a git repository +that one maintainer merges into. What it is for is narrow: to hand out identifiers +(names, addresses, keys), and to give every party a namespace of its own that everyone +reads. It asks as little as it can of continuum and promises the least that makes a federation possible. A federation that cooperates settles fast; one that doesn't comes apart, and diff --git a/src/federation/mod.rs b/src/federation/mod.rs index 20ade61..8d059cc 100644 --- a/src/federation/mod.rs +++ b/src/federation/mod.rs @@ -1,8 +1,9 @@ //! A federation of parties that don't trust each other (`docs/federation.md`), on a store -//! of events generic over what they read as (`docs/store.md`). Built stage by stage behind -//! the `federation` feature; no node runs any of it yet. +//! of events generic over what they read as (`docs/store.md`): what a node of a swarm +//! holding one reads from its document (`held`), and a party's client (`client`, `party`). +//! Built stage by stage behind the `federation` feature. -// Until a node runs it (stage 3), parts of it are used by nothing, or by tests alone. +// Built stage by stage: parts of it are used by nothing yet, or by tests alone. #![allow(dead_code)] #[cfg(test)] -- cgit v1.3.1