Skip to main content

Creating Strategies

This page explains the core strategy contract in TradeJS and where to place strategy logic.

TradeJS supports two strategy creation paths:

Typical Strategy Layout​

Each strategy package (built-ins in packages/strategies, user plugins in src/strategies) usually has:

  • config.ts
  • core.ts
  • figures.ts (if strategy draws custom lines/points/zones)
  • strategy.ts
  • manifest.ts
  • adapters/ai.ts (optional)
  • adapters/ml.ts (optional)
  • hooks.ts (optional)

Runtime Contract​

core.ts returns one of three decisions:

  • skip
  • entry
  • exit

Shared runtime handles:

  • signal enrichment (AI/ML)
  • policy gates
  • order execution
  • lifecycle hooks

Files:

Import rule:

  • import Node runtime wiring from @tradejs/node/strategies
  • import pure strategy helpers from @tradejs/core/strategies
  • import shared contracts from @tradejs/types
  • avoid non-public deep imports

Minimal core.ts Example​

export const createMyStrategyCore: CreateStrategyCore<
  MyStrategyConfig
> = async ({ strategyApi }) => {
  return async () => {
    const positionExists = await strategyApi.isCurrentPositionExists();
    if (positionExists) {
      return strategyApi.skip('POSITION_EXISTS');
    }

    const { currentPrice } = await strategyApi.getMarketData();

    const { stopLossPrice, takeProfitPrice } =
      strategyApi.getDirectionalTpSlPrices({
        price: currentPrice,
        direction: 'LONG',
        takeProfitDelta: 2,
        stopLossDelta: 1,
        unit: 'percent',
      });

    return strategyApi.entry({
      direction: 'LONG',
      orderPlan: {
        qty: 1,
        stopLossPrice,
        takeProfits: [{ rate: 1, price: takeProfitPrice }],
      },
    });
  };
};

Where Runtime Behavior Is Defined​

  • manifest.ts:

    • entryRuntimeDefaults
    • hooks
    • aiAdapter
    • mlAdapter

  • tradejs.config.ts:

    • hooks for shared behavior across all strategies in the current project
    • useful for common risk rules, cross-strategy position handling, and shared order filters

  • adapters/*:

    • runtime policy mapping from config (mapEntryRuntimeFromConfig)
    • AI/ML payload normalization

Step-by-Step Guides​

External Strategy as an npm Plugin​

import { defineConfig } from '@tradejs/core/config';
import { basePreset } from '@tradejs/base';

export default defineConfig(basePreset, {
  strategies: ['@scope/tradejs-strategy-pack'],
});

Plugin example:

  • publish your strategy as an npm package and register it in strategies