backtest-kit 5.9.0 → 5.10.0

package/README.md

@@ -135,7 +135,7 @@ addFrameSchema({
 ### 💡 Example Strategy (with LLM)
 ```typescript
 import { v4 as uuid } from 'uuid';
-import { addStrategySchema, dumpSignalData, getCandles } from 'backtest-kit';
+import { addStrategySchema, getCandles, Dump } from 'backtest-kit';
 import { json } from './utils/json.mjs';  // LLM wrapper
 import { getMessages } from './utils/messages.mjs';  // Market data prep
 
@@ -159,7 +159,20 @@ addStrategySchema({
 
     const resultId = uuid();
     const signal = await json(messages);  // LLM generates signal
-    await dumpSignalData(resultId, messages, signal);  // Log
+
+    Dump.dumpAgentAnswer(messages, {
+      dumpId: "position-context",
+      bucketName: "multi-timeframe-strategy",
+      signalId: resultId,
+      description: signal.description, // search keywords for BM25 index
+    });
+
+    Dump.dumpRecord(signal, {
+      dumpId: "position-entry",
+      bucketName: "multi-timeframe-strategy",
+      signalId: resultId,
+      description: signal.description, // agent can review the history using RAG
+    });
 
     return { ...signal, id: resultId };
   },
@@ -215,7 +228,7 @@ Backtest Kit is **not a data-processing library** - it is a **time execution eng
 These three functions work together to dynamically manage the position. To reduce position linearity, by default, each DCA entry is formatted as a fixed **unit of $100**. This can be changed. No mathematical knowledge is required.
 
 **Public API:**
-- **`commitAverageBuy`** — adds a new DCA entry. For LONG, **only accepted when current price is below a new low**. Silently rejected otherwise. This prevents averaging up. Can be overridden using `setConfig`
+- **`commitAverageBuy`** — adds a new DCA entry. By default, **only accepted when current price is below a new low**. Silently rejected otherwise. This prevents averaging up. Can be overridden using `setConfig`
 - **`commitPartialProfit`** — closes X% of the position at a profit. Locks in gains while keeping exposure.
 - **`commitPartialLoss`** — closes X% of the position at a loss. Cuts exposure before the stop-loss is hit.
 
@@ -1675,7 +1688,7 @@ npm start
 
 ## ✅ Tested & Reliable
 
-500+ tests cover validation, recovery, reports, and events.
+515+ tests cover validation, recovery, reports, and events.
 
 ## 🤝 Contribute