Class FakeBroker

constructor

• new FakeBroker(options?: FakeBrokerOptions): FakeBroker

• Parameters

  • options: FakeBrokerOptions = {}

  Returns FakeBroker

rejectNextPlace

features

• get features(): undefined | TradingFeatureSource

• What this simulated provider declares. Undefined without accounts.

  Returns undefined | TradingFeatureSource

accountPositions

• accountPositions(accountId: string): Position[]

• An account's open positions, synchronously (test and demo helper).

  Parameters

  • accountId: string

  Returns Position[]

cancel

• cancel(orderId: string): Promise<void>

• Parameters

  • orderId: string

  Returns Promise<void>

closePosition

• closePosition(
      req: ClosePositionRequest & { mode: TradeMode },
  ): Promise<CommandReceipt>

• Parameters

  • req: ClosePositionRequest & { mode: TradeMode }

  Returns Promise<CommandReceipt>

disconnect

• disconnect(): void

• Drop the connection. Every call fails without applying: one made while it is down as never sent (isPreflightFailure), one already out with a plain error. Account streams report the loss.

  Returns void

emitDepth

• emitDepth(symbol: string, depth: MarketDepth): void

• Parameters

  • symbol: string
  • depth: MarketDepth

  Returns void

emitLtp

• emitLtp(symbol: string, ltp: number): void

• Parameters

  • symbol: string
  • ltp: number

  Returns void

failNext

• failNext(
      operation: FakeBrokerOperation,
      failure: FakeBrokerFailure,
      reason?: string,
  ): void

• Make the next call of operation fail as described (test hook).

  Parameters

  • operation: FakeBrokerOperation
  • failure: FakeBrokerFailure
  • Optionalreason: string

  Returns void

fill

• fill(orderId: string): void

• Simulate a fill for an order (test hook).

  Parameters

  • orderId: string

  Returns void

getAccountPositions

• getAccountPositions(
      accountId: string,
      _signal?: AbortSignal,
  ): Promise<readonly Position[]>

• Parameters

  • accountId: string
  • Optional_signal: AbortSignal

  Returns Promise<readonly Position[]>

getAccountSnapshot

• getAccountSnapshot(
      accountId: string,
      _signal?: AbortSignal,
  ): Promise<AccountSnapshot>

• Parameters

  • accountId: string
  • Optional_signal: AbortSignal

  Returns Promise<AccountSnapshot>

getExecutions

• getExecutions(
      query: AccountHistoryQuery,
      _signal?: AbortSignal,
  ): Promise<readonly Execution[]>

• Parameters

  • query: AccountHistoryQuery
  • Optional_signal: AbortSignal

  Returns Promise<readonly Execution[]>

getOrderHistory

• getOrderHistory(
      query: AccountHistoryQuery,
      _signal?: AbortSignal,
  ): Promise<readonly OrderHistoryEntry[]>

• Parameters

  • query: AccountHistoryQuery
  • Optional_signal: AbortSignal

  Returns Promise<readonly OrderHistoryEntry[]>

listAccounts

• listAccounts(_signal?: AbortSignal): Promise<readonly TradingAccount[]>

• Parameters

  • Optional_signal: AbortSignal

  Returns Promise<readonly TradingAccount[]>

modify

• modify(
      orderId: string,
      patch: { price?: number; qty?: number; triggerPrice?: number },
  ): Promise<void>

• Parameters

  • orderId: string
  • patch: { price?: number; qty?: number; triggerPrice?: number }

  Returns Promise<void>

muteOrderUpdates

• muteOrderUpdates(muted: boolean): void

• Stop delivering order-stream updates, as a dropped stream would (test hook).

  Parameters

  • muted: boolean

  Returns void

onBook

• onBook(cb: (orders: Order[], positions: Position[]) => void): void

• Parameters

  • cb: (orders: Order[], positions: Position[]) => void

  Returns void

onDepth

• onDepth(cb: (symbol: string, depth: MarketDepth) => void): void

• Parameters

  • cb: (symbol: string, depth: MarketDepth) => void

  Returns void

onLtp

• onLtp(cb: (symbol: string, ltp: number) => void): void

• Parameters

  • cb: (symbol: string, ltp: number) => void

  Returns void

onOrderUpdate

• onOrderUpdate(cb: (order: Order, info: FakeOrderInfo) => void): void

• The order stream: every status change of every order, with the account and client token behind it.

  Parameters

  • cb: (order: Order, info: FakeOrderInfo) => void

  Returns void

orders

• orders(): readonly Order[]

• Returns readonly Order[]

place

• place(req: PlaceRequest & { mode: TradeMode }): Promise<{ orderId: string }>

• Parameters

  • req: PlaceRequest & { mode: TradeMode }

  Returns Promise<{ orderId: string }>

placeBracket

• placeBracket(
      req: BracketOrderRequest & {
          legClientTokens?: { stopLoss: string; takeProfit: string };
          mode: TradeMode;
      },
  ): Promise<BracketReceipt>

• legClientTokens are the client tokens the engine gives the stop and target legs. A provider that echoes them on the legs' rows lets a bracket whose answer was lost be reconciled leg by leg.

  Parameters

  • req: BracketOrderRequest & {
        legClientTokens?: { stopLoss: string; takeProfit: string };
        mode: TradeMode;
    }

  Returns Promise<BracketReceipt>

positions

• positions(): readonly Position[]

• Returns readonly Position[]

previewOrder

• previewOrder(req: PlaceRequest & { mode: TradeMode }): Promise<OrderPreview>

• Read-only: what the order would cost. Must not place anything.

  Parameters

  • req: PlaceRequest & { mode: TradeMode }

  Returns Promise<OrderPreview>

reconnect

• reconnect(): void

• Returns void

reversePosition

• reversePosition(
      req: PositionCommandRequest & { mode: TradeMode },
  ): Promise<CommandReceipt>

• Parameters

  • req: PositionCommandRequest & { mode: TradeMode }

  Returns Promise<CommandReceipt>

setBook

• setBook(orders: Order[], positions: Position[]): void

• Replace the current book snapshot and notify (simulates a poll / WS update / reconnect).

  Parameters

  • orders: Order[]
  • positions: Position[]

  Returns void

setMark

• setMark(symbol: string, price: number): void

• The price market orders fill at and positions are valued at. Pushes fresh figures to holders.

  Parameters

  • symbol: string
  • price: number

  Returns void

subscribeAccount

• subscribeAccount(
      accountId: string,
      onSnapshot: (s: AccountSnapshot) => void,
      onError?: (e: unknown) => void,
  ): () => void

• Push readings as they change. onError reports a dead stream; the returned function stops it.

  Parameters

  • accountId: string
  • onSnapshot: (s: AccountSnapshot) => void
  • OptionalonError: (e: unknown) => void

  Returns () => void

StaticmakeDepth

• makeDepth(ltp: number, levels: number, tickSize?: number): MarketDepth

• Build a deterministic N-level synthetic book around ltp (demo/test helper).

  Parameters

  • ltp: number
  • levels: number
  • tickSize: number = 0.05

  Returns MarketDepth