cryptobot-types 1.1.7 → 1.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptobot-types",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Type package for the cryptobot trading framework.",
   "types": "types/index.d.ts",
   "registry": "https://registry.npmjs.org/",

package/types/mongodb.d.ts

@@ -16,16 +16,6 @@ export interface Candle {
   start: Date;
 }
 
-export interface GetBacktestOptions {
-  _ids?: string[];
-  testedAfter?: string;
-  rule?: string;
-  minProfit?: number;
-  start?: {
-    $gt: string;
-  };
-}
-
 export interface TimeAndCloseCandle {
   start: Date;
   close: number;
@@ -40,3 +30,24 @@ export interface DatabaseType {
   close: string;
   volume: string;
 }
+
+export interface BacktestingResult {
+  trades: number;
+  identifier: string;
+  name: string;
+  startCapital: number;
+  symbol: string;
+  margin: number;
+  orders: (CloseOrder | Order)[];
+  pnl: number;
+  winRatio: number;
+  stringifiedFunc: string;
+  time: Date;
+  start: Date;
+  end: Date;
+  pnl_pct: number;
+  hodl_pct: number;
+  liquidations: number;
+  exchange: string;
+  hodl_ratio: number;
+}

package/types/orderHelper.d.ts

@@ -42,6 +42,7 @@ export interface BaseOrder {
   posAvgEntryPrice?: number;
   posValue?: number;
   symbol: string;
+  accHash: string;
 }
 
 export interface Order extends BaseOrder {

package/types/strategy.d.ts

@@ -1,5 +1,6 @@
 export interface Strategy {
-  readonly name: string
-  readonly startCapital: number
-  update(price: number, indicators: unknown[], time: Date): Promise<void>
+  readonly name: string;
+  readonly startCapital: number;
+  readonly requiresIndicators: boolean;
+  update(price: number, indicators: unknown[], time: Date): Promise<void>;
 }

package/types/trading.d.ts

@@ -1,72 +0,0 @@
-export type Rule = {
-  long_entry: boolean[][];
-  long_exit: boolean[][];
-  short_entry: boolean[][];
-  short_exit: boolean[][];
-  noStrictVolume?: boolean;
-  saveProfits?: boolean;
-  isCorrelationTest?: boolean;
-};
-
-export type Exchanges =
-  | "binance"
-  | "coinbase"
-  | "dydx"
-  | "kraken"
-  | "okx"
-  | "bybit";
-
-export type EntryOrderTypes = "Long Entry" | "Short Entry";
-type ExitOrderTypes = "Long Exit" | "Short Exit";
-export type OrderTypes = EntryOrderTypes | ExitOrderTypes;
-
-export interface BaseOrderObject {
-  timestamp: Date;
-  platform: Exchanges;
-  invest: number;
-  netInvest: number;
-  portfolio: number;
-  clOrdId?: string;
-  leverage?: number;
-  details: Record<string, unknown>;
-  spread?: number;
-  canExecuteOrder?: boolean;
-}
-
-export interface EntryOrderObject extends BaseOrderObject {
-  price: number;
-  type: EntryOrderTypes;
-  fee: number;
-  holdDuration: number;
-  //trading
-  positionSize?: number;
-  netPositionSize?: number;
-}
-
-export interface ExitOrderObject extends Omit<EntryOrderObject, "type"> {
-  type: ExitOrderTypes;
-  priceChangePercent: number;
-  netProfitInPercent: number;
-  netProfit: number;
-  profit: number;
-  highestPrice?: number;
-  lowestPrice?: number;
-  isLiquidated: boolean;
-  //timeInLoss: number;
-  //timeInLossInPercent: number;
-}
-
-export type OrderObject = EntryOrderObject | ExitOrderObject;
-
-export interface BacktestingResult {
-  trades: number;
-  identifier: string;
-  name: string;
-  pnl: number;
-  winRatio: number;
-  stringifiedFunc: string;
-  time: Date;
-  start: Date;
-  end: Date;
-  pnl_pct: number;
-}