Interface BreakevenContract

Contract for breakeven events.

Emitted by breakevenSubject when a signal's stop-loss is moved to breakeven (entry price). Used for tracking risk reduction milestones and monitoring strategy safety.

Events are emitted only once per signal (idempotent - protected by ClientBreakeven state). Breakeven is triggered when price moves far enough in profit direction to cover transaction costs.

Consumers:

  • BreakevenMarkdownService: Accumulates events for report generation
  • User callbacks via listenBreakeven() / listenBreakevenOnce()

Example

import { listenBreakeven } from "backtest-kit";

// Listen to all breakeven events
listenBreakeven((event) => {
  console.log(`[${event.backtest ? "Backtest" : "Live"}] Signal ${event.data.id} moved to breakeven`);
  console.log(`Symbol: ${event.symbol}, Price: ${event.currentPrice}`);
  console.log(`Position: ${event.data.position}, Entry: ${event.data.priceOpen}`);
  console.log(`Original SL: ${event.data.priceStopLoss}, New SL: ${event.data.priceOpen}`);
});

// Wait for specific signal to reach breakeven
listenBreakevenOnce(
  (event) => event.data.id === "target-signal-id",
  (event) => console.log("Signal reached breakeven:", event.data.id)
);
interface BreakevenContract {
    backtest: boolean;
    currentPrice: number;
    data: IPublicSignalRow;
    exchangeName: string;
    frameName: string;
    strategyName: string;
    symbol: string;
    timestamp: number;
}

Properties

backtest currentPrice data exchangeName frameName strategyName symbol timestamp

Properties

backtest

backtest: boolean

Execution mode flag.

  • true: Event from backtest execution (historical candle data)
  • false: Event from live trading (real-time tick)

currentPrice

currentPrice: number

Current market price at which breakeven was triggered. Used to verify threshold calculation.

data

data: IPublicSignalRow

Complete signal row data with original prices. Contains all signal information including originalPriceStopLoss, originalPriceTakeProfit, and totalExecuted.

exchangeName

exchangeName: string

Exchange name where this signal is being executed. Identifies which exchange this breakeven event belongs to.

frameName

frameName: string

Frame name where this signal is being executed. Identifies which frame this breakeven event belongs to (empty string for live mode).

strategyName

strategyName: string

Strategy name that generated this signal. Identifies which strategy execution this breakeven event belongs to.

symbol

symbol: string

Trading pair symbol (e.g., "BTCUSDT"). Identifies which market this breakeven event belongs to.

timestamp

timestamp: number

Event timestamp in milliseconds since Unix epoch.

Timing semantics:

  • Live mode: when.getTime() at the moment breakeven was set
  • Backtest mode: candle.timestamp of the candle that triggered breakeven

Example

const eventDate = new Date(event.timestamp);
console.log(`Breakeven set at: ${eventDate.toISOString()}`);

Settings

Member Visibility

On This Page

Properties