refactor(strategies): rename gridBotLite to grid

bludnic · May 24, 2024 · 3cef5da · 3cef5da
1 parent 1f74f31
commit 3cef5da
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/packages/bot-templates/src/templates/grid-bot.ts b/packages/bot-templates/src/templates/grid-bot.ts
@@ -1,6 +1,6 @@
 import { z } from "zod";
 import type { IExchange } from "@opentrader/exchanges";
-import {
+import type {
   IBotConfiguration,
   SmartTradeService,
   TBotContext,
@@ -14,6 +14,10 @@ import { computeGridLevelsFromCurrentAssetPrice } from "@opentrader/tools";
 import type { IGetMarketPriceResponse } from "@opentrader/types";
 import { logger } from "@opentrader/logger";
 
+/**
+ * Advanced grid bot template.
+ * The template allows specifying grid lines with custom prices and quantities.
+ */
 export function* gridBot(ctx: TBotContext<GridBotConfig>) {
   const { config: bot, onStart, onStop } = ctx;
   const symbol = `${bot.baseCurrency}/${bot.quoteCurrency}`;

diff --git a/...-templates/src/templates/grid-bot-lite.ts → packages/bot-templates/src/templates/grid.ts b/...-templates/src/templates/grid-bot-lite.ts → packages/bot-templates/src/templates/grid.ts
@@ -8,7 +8,7 @@ import { gridBot } from "./grid-bot";
  * Wrapper for the `gridBot` template with a simplified configuration.
  * @param ctx - Bot context
  */
-export function* gridBotLite(ctx: TBotContext<GridBotLiteConfig>) {
+export function* grid(ctx: TBotContext<GridBotLiteConfig>) {
   const { config } = ctx;
 
   const gridLines = calcGridLines(
@@ -32,8 +32,8 @@ export function* gridBotLite(ctx: TBotContext<GridBotLiteConfig>) {
   yield* gridBot(gridBotCtx);
 }
 
-gridBotLite.displayName = "Grid Bot Lite";
-gridBotLite.schema = z.object({
+grid.displayName = "Grid Bot Lite";
+grid.schema = z.object({
   highPrice: z.number().positive().describe("Highest price of the grid"),
   lowPrice: z.number().positive().describe("Lowest price of the grid"),
   gridLevels: z.number().positive().describe("Number of grid lines"),
@@ -43,6 +43,4 @@ gridBotLite.schema = z.object({
     .describe("Quantity of base currency per each grid"),
 });
 
-export type GridBotLiteConfig = IBotConfiguration<
-  z.infer<typeof gridBotLite.schema>
->;
+export type GridBotLiteConfig = IBotConfiguration<z.infer<typeof grid.schema>>;
diff --git a/packages/bot-templates/src/templates/index.ts b/packages/bot-templates/src/templates/index.ts
@@ -1,4 +1,4 @@
 export * from "./grid-bot";
-export * from "./grid-bot-lite";
+export * from "./grid";
 export * from "./rsi";
 export * from "./test";