From 0023300b417b2375026750b1b0924adfd94c4e03 Mon Sep 17 00:00:00 2001 From: tv Date: Mon, 16 Nov 2026 21:38:52 +0000 Subject: continuum is a library Everything the node is moves from the binary into a library (`src/lib.rs`), so that other binaries can use it: a party's client of a federation next. The node's binary (`src/main.rs`) runs it (`continuum::run`), which wires things together as `main` did. The library's doc comments are prose, not examples to test (`doctest = false`); its tests are the library's, as `cargo quick` and `cargo sim` run them. --- docs/architecture.md | 3 ++- docs/lifecycle.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/architecture.md b/docs/architecture.md index 9edf086..8fc152f 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -163,7 +163,8 @@ Argon2), [`dashboard/`](../src/api/dashboard/) (with the `dashboard` feature: th come from [`remake/api.rs`](../src/remake/api.rs). [`docs/openapi.yaml`](openapi.yaml) describes it all; nodes serve it at `/openapi.yaml`, with a Swagger UI at `/swagger-ui`. -**Top level** — [`main.rs`](../src/main.rs) reads the configuration, picks the starting document and +**Top level** — continuum is a library: its `run` ([`lib.rs`](../src/lib.rs)), which the node's +binary ([`main.rs`](../src/main.rs)) calls, reads the configuration, picks the starting document and runs the shutdown sequence; [`node.rs`](../src/node.rs) builds a node's state and starts its workers (also used by the simulator); [`config/`](../src/config/) loads options from defaults, files and arguments ([`configuration.md`](configuration.md)); diff --git a/docs/lifecycle.md b/docs/lifecycle.md index e6ac31b..3140fa8 100644 --- a/docs/lifecycle.md +++ b/docs/lifecycle.md @@ -22,7 +22,7 @@ stateDiagram-v2 In the code there are two lifecycle states, `Joining` and `Ready` (`NodeLifecycle`); rejoining is `Joining` with the swarm ID kept, and starting and stopping are what -[`main.rs`](../src/main.rs) does before and after. The phases below are the operator's view. +`run` ([`lib.rs`](../src/lib.rs)) does before and after. The phases below are the operator's view. | Phase | Reads | Writes | Registers, votes, syncs as a source | Files written | |---|---|---|---|---| -- cgit v1.3.1