Reference

The exhaustive surface: what each call does, what it returns, and how it is configured.

Operations

Every state-changing call is one Operation, submitted through the same gate. Browse all operations →

Reads & configuration

• API reference

  The entry points: which import path holds what, each linked to its complete rendered surface on the generated reference.

• The Economy

  Construct an Economy from its ports, then drive it through one submit entry point and read its state through read.

• Reads

  The read surface: balance, statement, postings, saga, entitlements, status, accounts, payouts, and the solvency proof.

• Outcomes & reason codes

  How a submission resolves (committed, duplicate, or rejected) and the reason codes that explain a decline.

• HTTP service

  The HTTP service: submit operations, receive provider webhooks, and health/readiness endpoints.

• Background worker

  The sweeps that run off the request path: payouts, subscriptions, fee realization, checkpoints, the outbox/inbox relay, and the lifecycle jobs — accrual drain, re-proof, orphans, archive, and retention.

• Offline verification

  Export the ledger as one canonical file and re-prove it anywhere: the chain, the Merkle root, and the checkpoint signature, with no database access.

• Configuration

  Every environment variable economy-lab reads, with its meaning and default.

• Performance

  What `make bench` measures and how to read it: submit throughput per storage backend and integrity cost as the ledger grows. These are lab numbers: relative cost and scaling shape.