ClientAction

Implements IAction

ClientAction implementation for action handler execution.

Provides lifecycle management and event routing for action handlers:

• Initializes handler instance with strategy context
• Routes events to handler methods and callbacks
• Manages disposal and cleanup

Action handlers implement custom logic for:

• State management (Redux, Zustand, MobX)
• Event logging and monitoring
• Real-time notifications (Telegram, Discord, email)
• Analytics and metrics collection

Used internally by strategy execution to integrate action handlers.

Constructor

constructor(params: IActionParams);
Copy

Properties

params

params: IActionParams
Copy

_handlerInstance

_handlerInstance: ActionProxy
Copy

Handler instance created from params.handler constructor. Starts as null, gets initialized on first use.

waitForInit

waitForInit: (() => Promise<void>) & ISingleshotClearable<() => Promise<void>>
Copy

Initializes handler instance using singleshot pattern. Ensures initialization happens exactly once.

dispose

dispose: (() => Promise<void>) & ISingleshotClearable<() => Promise<void>>
Copy

Cleans up resources and subscriptions when action handler is no longer needed. Uses singleshot pattern to ensure cleanup happens exactly once.

Methods

signal

signal(event: IStrategyTickResult): Promise<void>;
Copy

Handles signal events from all modes (live + backtest).

signalLive

signalLive(event: IStrategyTickResult): Promise<void>;
Copy

Handles signal events from live trading only.

signalBacktest

signalBacktest(event: IStrategyTickResult): Promise<void>;
Copy

Handles signal events from backtest only.

breakevenAvailable

breakevenAvailable(event: BreakevenContract): Promise<void>;
Copy

Handles breakeven events when stop-loss is moved to entry price.

partialProfitAvailable

partialProfitAvailable(event: PartialProfitContract): Promise<void>;
Copy

Handles partial profit level events (10%, 20%, 30%, etc).

partialLossAvailable

partialLossAvailable(event: PartialLossContract): Promise<void>;
Copy

Handles partial loss level events (-10%, -20%, -30%, etc).

pingScheduled

pingScheduled(event: SchedulePingContract): Promise<void>;
Copy

Handles scheduled ping events during scheduled signal monitoring.

scheduleEvent

scheduleEvent(event: ScheduleEventContract): Promise<void>;
Copy

Handles scheduled signal lifecycle events (creation / cancellation).

Manual wiring — EVENT-BASED: users implement IActionCallbacks.onScheduleEvent (via addActionSchema) to drive the exchange (commitActivateScheduled / commitCancelScheduled); see that contract for the full guidance and example. This internal dispatch forwards to the handler/callback.

pendingEvent

pendingEvent(event: SignalEventContract): Promise<void>;
Copy

Handles pending signal lifecycle events (open / close).

Manual wiring — EVENT-BASED: users implement IActionCallbacks.onPendingEvent (via addActionSchema) to drive the exchange; for per-tick fills use onPingActive. See that contract for the full guidance and example. This internal dispatch forwards to the handler/callback.

pingActive

pingActive(event: ActivePingContract): Promise<void>;
Copy

Handles active ping events during active pending signal monitoring.

pingIdle

pingIdle(event: IdlePingContract): Promise<void>;
Copy

Handles idle ping events when no signal is active.

riskRejection

riskRejection(event: RiskContract): Promise<void>;
Copy

Handles risk rejection events when signals fail risk validation.

signalSync

signalSync(event: SignalSyncContract): Promise<void>;
Copy

Gate for position open/close via limit order. NOT wrapped in trycatch — exceptions propagate to CREATE_SYNC_FN.

orderCheck

orderCheck(event: SignalPingContract): Promise<void>;
Copy

Gate for the pending-order ping (order still open on exchange?). NOT wrapped in trycatch — exceptions propagate to CREATE_SYNC_PENDING_FN.