Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / AdmitSpec

Interface: AdmitSpec

Defined in: packages/core/dist/index.d.ts

What the admission point needs to know about one spawn.

Properties

PropertyTypeDescriptionDefined in
ancestry?string[]Decomposition parent-LTID chain (relation 'decompose-child' only).packages/core/dist/index.d.ts
approach?stringRaw approach tag; normalized by the engine.packages/core/dist/index.d.ts
budgetUsd?numberExplicit child budget; clamped by childBudgetFraction.packages/core/dist/index.d.ts
childScopestringThe child's journal scope; doubles as its budget account scope.packages/core/dist/index.d.ts
estCostUsd?numberReserve hint; falls back to the flat engine default.packages/core/dist/index.d.ts
ladderLength?numberThe declared ladder length of the resolved profile (K_l); default 1, the single implicit rung. Under a termination account, a length beyond the frozen kMax rejects with ladder_exceeds_frozen and a NEW lineage is allocated E0 escalation units plus K_l - 1 rungs (DEF-2).packages/core/dist/index.d.ts
lineage?SpawnLineageOptLineage continuation (DEF-3); absence mints a fresh lineage root. A continuation demands a causeRef: the seq of the entry that caused the rebirth.packages/core/dist/index.d.ts
namestringRegistered workflow name or agent profile name; telemetry and cards only.packages/core/dist/index.d.ts
nodeKey?stringThe children-quota key (maxChildrenPerNode); defaults to parentAccountScope. Orchestrators pass their own scope so each node counts its own children.packages/core/dist/index.d.ts
originSpawnOrigin-packages/core/dist/index.d.ts
parentAccountScopestringThe nearest enclosing budget account of the spawner.packages/core/dist/index.d.ts
signature?Partial<ApproachSignatureInputs>Coarse-signature identity inputs; unspecified fields canonize onto the deterministic legacy constants so signatures stay byte-stable (the toolset/schema registries land in M7-T05).packages/core/dist/index.d.ts