API reference¶
The reference below is auto-generated from the source docstrings
via mkdocstrings. Each top-level
module under src/vacant/ gets its own page. Use the search
(Cmd/Ctrl+K) to jump straight to a
class or function.
| Module | What lives here |
|---|---|
vacant.core |
shared types (VacantId, Logbook, ResidentForm), constants, crypto primitives, errors |
vacant.identity |
Ed25519 keys, layered identity (L0–L3), wash cost, peer attestations, federation root sets |
vacant.runtime |
5-state lifecycle, heartbeat, shadow-self drift, D1–D5 spawn paths |
vacant.reputation |
5-dim Beta posterior, UCB exploration, STYLO discount, cold start, same-controller detection |
vacant.registry |
SQLite halo store, RPC, aggregation, anti-tamper, visibility |
vacant.composite |
composite parents, child manifests, Tree-Only protocol, graduation |
vacant.protocol |
A2A / MCP envelope, dispatch, replay protect, capability cards, vacant serve |
vacant.substrate |
abstract SubstrateBackend + Mock / Deterministic / Anthropic / OpenAI / Gemini / Mistral / Ollama / client-inherited |
vacant.mvp |
the four reference scenarios + dashboard + 8 metrics |
vacant.cli |
vacant console-script (init / serve / call / demo / …) |
Conventions¶
- Docstring style: Google. Each public function has
Args:,Returns:, and (where applicable)Raises:blocks. - Private members: functions and classes whose name starts with
_are hidden from the reference by default. If you need to see them, read the source — every page has a "show source" toggle on individual entries. - Drift between docstring and behaviour: treat as a bug. Open an issue and cite the page URL.