Interface IStateInstance

Interface for state instance implementations. Defines the contract for local, persist, and dummy backends.

Intended use: per-signal mutable state for LLM-driven strategies that track trade confirmation metrics across the position lifetime — e.g. peak unrealised PnL, minutes since entry, and capitulation thresholds.

Example shape:

{ peakPercent: number; minutesOpen: number }

Profitable trades endure -0.5–2.5% drawdown yet still reach peak 2–3%+. SL trades either never go positive (Feb25) or show peak < 0.15% (Feb08, Feb13). Capitulation rule: if position open N minutes and peak < threshold (e.g. 0.3%) — LLM thesis was not confirmed by market, exit immediately.

interface IStateInstance {
    dispose(): Promise<void>;
    getState<Value extends object = object>(when: Date): Promise<Value>;
    setState<Value extends object = object>(
        dispatch: Value | Dispatch<Value>,
        when: Date,
    ): Promise<Value>;
    waitForInit(initial: boolean): Promise<void>;
}

Methods

dispose getState setState waitForInit

Methods

dispose

  • dispose(): Promise<void>

    Releases any resources held by this instance.

    Returns Promise<void>

getState

  • getState<Value extends object = object>(when: Date): Promise<Value>

    Read the current state value. Returns initialValue when the stored when is greater than the requested when (look-ahead bias protection).

    Type Parameters

    • Value extends object = object

    Parameters

    • when: Date

      Logical timestamp at which the read is happening

    Returns Promise<Value>

    Current state value

setState

  • setState<Value extends object = object>(
        dispatch: Value | Dispatch<Value>,
        when: Date,
    ): Promise<Value>

    Update the state value. A write with a smaller when overwrites an existing record — that lets a restarted backtest reset live-written state without breaking live. The dispatch updater receives the look-ahead-guarded current value (or initialValue when the stored when is in the future).

    Type Parameters

    • Value extends object = object

    Parameters

    • dispatch: Value | Dispatch<Value>

      New value or updater function receiving current value

    • when: Date

      Logical timestamp this value belongs to

    Returns Promise<Value>

    Updated state value

waitForInit

  • waitForInit(initial: boolean): Promise<void>

    Initialize the state instance.

    Parameters

    • initial: boolean

      Whether this is the first initialization

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods