Merge pull request #97 from Open-Trader/feat/strategies-meta

Add `description` property to the strategy template
Open-Trader · Jan 12, 2025 · 0070c37 · 0070c37
2 parents 8ab088f + 4914229
commit 0070c37
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/packages/bot-processor/src/types/bot/bot-template.type.ts b/packages/bot-processor/src/types/bot/bot-template.type.ts
@@ -20,6 +20,10 @@ export interface BotTemplate<T extends IBotConfiguration> {
    * Display name of the bot. Used in the UI.
    */
   displayName?: string;
+  /**
+   * Strategy description. What does the strategy do?
+   */
+  description?: string;
   /**
    * Number of candles the strategy requires for warm-up.
    * When the bot starts, it will download the required number of candles.

diff --git a/packages/bot-templates/src/templates/dca.ts b/packages/bot-templates/src/templates/dca.ts
@@ -51,6 +51,8 @@ export function* dca(ctx: TBotContext<DCABotConfig>) {
 }
 
 dca.displayName = "DCA Bot";
+dca.description =
+  "Dollar-Cost Averaging (DCA) is a trading strategy that involves entering a position through multiple smaller orders, known as Safety Orders. These orders are placed at predetermined levels, below the initial entry price. This method helps reduce the impact of adverse price movements by lowering the overall cost of the position. Once the market reverses and the price reaches a favorable level, the position is closed at the Take Profit level. This strategy is especially effective in volatile markets, allowing traders to capitalize on price fluctuations while minimizing the risks of poor timing with a single large entry.";
 dca.hidden = true;
 dca.schema = z.object({
   entry: z.object({

diff --git a/packages/bot-templates/src/templates/grid-bot.ts b/packages/bot-templates/src/templates/grid-bot.ts
@@ -60,7 +60,7 @@ export function* gridBot(ctx: TBotContext<GridBotConfig>) {
   }
 }
 
-gridBot.displayName = "Grid Bot";
+gridBot.displayName = "Grid Bot Advanced";
 gridBot.hidden = true;
 gridBot.schema = z.object({
   gridLines: z.array(

diff --git a/packages/bot-templates/src/templates/grid.ts b/packages/bot-templates/src/templates/grid.ts
@@ -32,7 +32,9 @@ export function* grid(ctx: TBotContext<GridBotLiteConfig>) {
   yield* gridBot(gridBotCtx);
 }
 
-grid.displayName = "Grid Bot Lite";
+grid.displayName = "Grid Bot";
+grid.description =
+  "A grid trading strategy is a market-neutral approach that works by placing a series of buy and sell orders at predetermined intervals above and below the current price. It capitalizes on market volatility, aiming to profit from price fluctuations rather than predicting market direction.";
 grid.hidden = true;
 grid.schema = z.object({
   highPrice: z.number().positive().describe("Highest price of the grid"),

diff --git a/packages/trpc/src/routers/private/bot/get-strategies/handler.ts b/packages/trpc/src/routers/private/bot/get-strategies/handler.ts
@@ -12,9 +12,9 @@ type Options = {
 };
 
 type StrategyName = keyof typeof templates | string;
-type StrategyInfo = { schema: JsonSchema7Type; isCustom: boolean } & Pick<
+type StrategyInfo = { name: string; schema: JsonSchema7Type; isCustom: boolean } & Pick<
   BotTemplate<any>,
-  "displayName" | "hidden" | "runPolicy" | "watchers" | "requiredHistory"
+  "displayName" | "description" | "hidden" | "runPolicy" | "watchers" | "requiredHistory"
 >;
 
 // Helper function to check if the schema is a ZodObject
@@ -37,9 +37,11 @@ export async function getStrategies({ ctx }: Options) {
     const zodSchema = isZodObject(strategy.schema) ? strategy.schema : z.object({});
 
     result[strategyName] = {
+      name: strategyName,
       schema: zodToJsonSchema(zodSchema),
       isCustom: strategyName in customStrategies,
       displayName: strategy.displayName,
+      description: strategy.description,
       hidden: !!strategy.hidden,
       runPolicy: strategy.runPolicy,
       watchers: strategy.watchers,