Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / CheckpointState

Interface: CheckpointState

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

The canonical-history snapshot at a turn boundary.

Properties

PropertyTypeDescriptionDefined in
compactionnumber[]Compaction points; producers arrive with M4-T03.packages/core/dist/index.d.ts
messagesMsg[]Canonical history up to and including the boundary.packages/core/dist/index.d.ts
pending?PendingToolTurnPresent while an ask suspension holds the turn open (M3-T03).packages/core/dist/index.d.ts
providerCalls?ProviderCallRecord[]The per-dispatch reconciliation ledger so far (P1.3), carried at every boundary so a kill-and-resume keeps pre-kill wire calls attributable. Absent before the first call and on checkpoints written before the ledger shipped: those restore none, and the invoice fold surfaces the restored usage as an unattributed remainder instead of losing it.packages/core/dist/index.d.ts
schemaAttemptsnumber-packages/core/dist/index.d.ts
toolCallsUsednumber-packages/core/dist/index.d.ts
turnsnumberModel turns already paid.packages/core/dist/index.d.ts
usageUsageUsage accumulated so far (not yet journaled: terminals carry totals).packages/core/dist/index.d.ts
usageByModel?UsageSlice[]The same usage split by serving model, so a dangling redispatch restores the per-model breakdown instead of collapsing every paid turn onto the loop model. Absent on checkpoints written before the split shipped: those restore the aggregate against the loop model, exactly as they did then.packages/core/dist/index.d.ts
v1-packages/core/dist/index.d.ts