Glossary

Application

The exported C++23 program that derives from sdk::Application. It binds data sources and executors, declares handlers, and runs the Aurum engine. See C++ SDK Reference.

Athanor

The build-time compiler that turns declarative .at factor formulas into typed C++ plugins. Generated plugins execute inside an Application.

Aurum home

The configuration and state root selected by --home, AURUM_HOME, or the default ~/.aurum. See Configuration.

aurumd

The per-user daemon that maintains installed instance inventory, lifecycle intent, managed process state, and control-plane RPCs.

Capability

A runtime-reported statement that a query or stream family is available, such as resources, books, factors, ledger, orders, or portfolios. An absent optional capability is not by itself a health failure.

Credential reference

A name such as okx-live or an absolute file:// URI resolved by aurum run --auth. The reference selects a credential document; it is not the secret material itself.

Effect

An operation that can complete asynchronously, such as an order submission, cancellation, or runtime query. Effects report outcomes through typed receipt branches.

Factor

A scalar value derived from a source resource. Athanor-generated factors use canonical factor:// keys and may become available only after a window is ready.

Forge

Aurum’s deployment and operations boundary. Forge accepts project versions, controls instances, exposes the public REST/WebSocket API, and serves durable history.

Instance

One installed project version and its runtime state. Forge instance IDs distinguish versions and are the scope used by runtime and history APIs.

LIVE mode

Runtime mode in which logical time follows admitted live inputs under the configured late-event and watermark policies.

Logical time

Engine time used to order source events, timers, deadlines, and controls. In replay it follows event data rather than wall-clock arrival.

Paper account

An in-process simulated account bound through paper::Account. It uses the same executor and receipt interfaces as a live account without sending orders to an exchange.

Project

A directory with an aurum_project(NAME ... VERSION ...) declaration and one exported Application. A published name@version is immutable.

Receipt

A typed handle returned by an effect. Named branches such as accepted, filled, rejected, timeout, and err deliver the possible outcomes.

REPLAY mode

Runtime mode in which eligible recorded events drive logical time. ReplayConfig::speed controls pacing without changing event timestamps.

Resource

A runtime-declared data product identified by a canonical key and a contract describing its payload, delivery, history, replay, merge, drop, and visibility semantics. See Resource Contracts.

Resource catalog

The authoritative inventory of resources exposed by one running Application. Forge and Terminal use it instead of guessing topic keys.

Run

One start-to-stop execution of an instance. Durable data is scoped by run_id; restarting the same project version creates a different run.

Runtime control

pause and resume for a replay instance, or freeze and unfreeze for a live instance. These controls are distinct from starting and stopping the managed process.

Terminal

The browser client for Forge. Terminal operates projects, inspects live resources, and queries history through the public Forge API.

Topic

A typed in-process stream selected by a TOPIC<"..."> literal. Public market, factor, and scalar topics also appear as runtime resources.

Venue package

A released exchange adapter that normalizes native market data and account operations into Aurum resources and executor behavior. Current packages include OKX and Binance.

Window

Stateful history used by a factor operator. A fixed Athanor window is declared with ~window:N; a generated plugin may otherwise receive a compatible runtime window from its attachment.

wire

The wire<source, Plugins...>() SDK template that attaches generated factors to one bar or book resource and publishes their semantic factor:// outputs.