Skip to main content

RunStateStore

@totemsdk/agent-policy

@totemsdk/agent-policy / RunStateStore

Interface: RunStateStore

Methods​

abortStep()​

abortStep(reservationId, reason): Promise<void>

Parameters​

reservationId​

string

reason​

string

Returns​

Promise<void>

checkNonce()​

checkNonce(runId, nonce): Promise<boolean>

Parameters​

runId​

string

nonce​

string

Returns​

Promise<boolean>

commitStep()​

commitStep(reservationId, receipt): Promise<void>

Parameters​

reservationId​

string

receipt​

RunStepReceipt

Returns​

Promise<void>

createRun()​

createRun(snapshot): Promise<void>

Parameters​

snapshot​

RunStateSnapshot

Returns​

Promise<void>

getReceipt()​

getReceipt(reservationId): Promise<RunStepReceipt | undefined>

Parameters​

reservationId​

string

Returns​

Promise<RunStepReceipt | undefined>

getReservation()​

getReservation(reservationId): Promise<RunReservation | undefined>

Parameters​

reservationId​

string

Returns​

Promise<RunReservation | undefined>

getRun()​

getRun(runId): Promise<RunStateSnapshot | undefined>

Parameters​

runId​

string

Returns​

Promise<RunStateSnapshot | undefined>

listStepReceipts()​

listStepReceipts(runId): Promise<RunStepReceipt[]>

Parameters​

runId​

string

Returns​

Promise<RunStepReceipt[]>

reconcileReservation()​

reconcileReservation(reservationId, outcome, opts?): Promise<void>

Settle a recovered (unknown) reservation. The ONLY way an unsettled reservation releases its budget is an explicit 'definitely-not-executed' reconciliation; 'completed' commits it and folds the receipt into the run totals.

Parameters​

reservationId​

string

outcome​

ReservationSettlementOutcome

opts?​
reason?​

string

receipt?​

RunStepReceipt

Returns​

Promise<void>

recoverReservations()​

recoverReservations(runId?): Promise<OutOfBandReservation[]>

Conservative reservation recovery (RFC-007 §3.5): a reservation that was never settled before its deadline is classified unknown — its budget is HELD, never restored by expiry. Returns every unsettled reservation.

Parameters​

runId?​

string

Returns​

Promise<OutOfBandReservation[]>

reserveStep()​

reserveStep(reservation): Promise<void>

Parameters​

reservation​

RunReservation

Returns​

Promise<void>