aboutsummaryrefslogtreecommitdiffstats
path: root/docs/architecture.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 21:38:52 +0000
committertv <tv@krebsco.de>2026-11-16 23:07:02 +0100
commit0023300b417b2375026750b1b0924adfd94c4e03 (patch)
tree31d7dc44200ecbb25400a96327bfb410140a9790 /docs/architecture.md
parent96eacbbd2df4127920976fc2e7c4efc53cd83f52 (diff)
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.
Diffstat (limited to 'docs/architecture.md')
-rw-r--r--docs/architecture.md3
1 files changed, 2 insertions, 1 deletions
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));