openalgo-script 0.4.0 → 0.5.0

package/dist/core/backtest/case.js

@@ -0,0 +1,319 @@
+/**
+ * A run record, turned into the files a conformance case is made of.
+ *
+ * **The suite is harvested rather than written.** A case invented by hand tests
+ * what somebody imagined a run does; a case taken from a run tests what a run
+ * actually did. `conformance.md` section 2 says a case is one directory of named
+ * files, and a record already holds every one of them: the script it ran, the
+ * bars it ran over, the settings it ran with, and what came back. So this is a
+ * projection and not a computation. Nothing here folds money, re-reads a report
+ * or decides anything a run did not already decide.
+ *
+ * **Text out, and no I/O.** Core writes no files, so this returns the bytes and
+ * the caller puts them where it likes. That also makes it testable without a
+ * disk and usable from a browser, which is where most runs happen.
+ *
+ * **What it refuses, it refuses loudly.** A case with a missing file is worse
+ * than no case: it fails on somebody else's engine and the blame lands on them.
+ * So a record that cannot make a whole case does not make a partial one, and a
+ * record that cannot make a faithful file does not guess at one: the script it
+ * has no text for and the instrument fact its host never stated are both
+ * refusals, never a hole and never a default.
+ *
+ * **Every setting of the run has a place in the case, and the table below says
+ * which.** A run once harvested to a case that said nothing about the digit
+ * count its money was rounded to, the charge schedule its host supplied or the
+ * window its report was about, so a second engine ran under other values and
+ * took the blame. `CARRIED` names the file each field of the settings is
+ * carried in, the type refuses to compile when the settings gain a field with
+ * no row, and a record whose settings hold a field the table does not know is
+ * refused by name rather than written into a case that ran under something it
+ * does not state.
+ */
+import { diagnosticFor } from '../diagnostics/index.js';
+import { canonicalNumber, canonicalise } from '../emit/index.js';
+/**
+ * The channels a strategy run can be held to.
+ *
+ * Only what the record carries folded, and only what another engine could
+ * produce independently. A case asserts the channels it names and no others, so
+ * a change to drawing output cannot break a case about money.
+ */
+const STRATEGY_ASSERTS = ['diagnostics', 'orders', 'trades', 'performance'];
+/**
+ * `conformance.md` section 6: the loosest bounds a conformance case may declare.
+ *
+ * Core reads no page, so the two figures are written here, and
+ * `tests/backtest/case-settings.test.ts` reads them out of section 6 and holds
+ * these to the page, which is the arrangement `stdlib.md` section 20's figures
+ * are under. Past either bound a run may still be a useful comparison; what it
+ * is not is a case, so the projection makes no file of it.
+ */
+export const TOLERANCE_CAP = {
+    rel: 1e-9,
+    abs: 1e-12,
+};
+/**
+ * Where each setting of a run is carried in a case, sections 2 and 3.
+ *
+ * Every field of the settings has a row and the type makes a field without one
+ * a compile error, so a setting the record gains cannot be left out of a case
+ * by forgetting. `fill` is the simulated destination's policy, and what it
+ * decided is the frames, which are input: an engine handed `frames.csv` folds
+ * them and fills nothing itself.
+ */
+const CARRIED = {
+    contract: 'instrument.json, and backtest.json for the digit count',
+    costs: 'backtest.json',
+    range: 'backtest.json',
+    inputs: 'settings.json',
+    now: 'case.json',
+    tolerance: 'case.json',
+    fill: 'frames.csv, as the frames it decided',
+};
+/**
+ * Where a refusal about a setting points: nowhere in the script.
+ *
+ * A run setting is what the host stated before the first bar, and a caret
+ * under a line of the strategy would blame the one party that did not choose
+ * it. The run's own settings check states the same position for the same reason.
+ */
+const NO_POSITION = { offset: 0, length: 0, line: 0, column: 0 };
+/**
+ * The files for one case, or the reason there are none.
+ *
+ * `now` is written only when the run pinned one. A case that names it when the
+ * script never asked pins a clock the run did not depend on, and the next
+ * reader has to work out whether it mattered.
+ */
+export function caseFilesFrom(record, identity) {
+    if (record.sourceText === null) {
+        return refused('the record carries no source text, so the case would have no script.os: ' +
+            'record it with sourceText, or re-run the script to record one that has it');
+    }
+    if (record.bars.form !== 'inline') {
+        return refused('the record points at its bars instead of holding them, and a case holds every ' +
+            'byte of its own input: record it with form "inline"');
+    }
+    if (identity.id.trim() === '')
+        return refused('a case needs an id');
+    if (identity.description.trim() === '') {
+        return refused('a case needs a one-sentence description, which is its failure message');
+    }
+    const instrument = instrumentOf(record);
+    if (!instrument.ok)
+        return instrument;
+    const settings = settingsRefusal(record.settings);
+    if (settings !== null)
+        return settings;
+    const files = {
+        'case.json': json({
+            id: identity.id,
+            category: identity.category ?? 'strategy',
+            profile: 'strategy',
+            languageVersion: Number(record.languageVersion),
+            description: identity.description,
+            asserts: [...STRATEGY_ASSERTS],
+            ...(record.settings.now === null ? {} : { now: record.settings.now }),
+            tolerance: record.settings.tolerance,
+        }),
+        'script.os': endsWithNewline(record.sourceText),
+        'bars.csv': barsCsv(record.bars.rows),
+        // `conformance.md` section 4: performance is a list of one flat object
+        // holding the summary statistics and nothing nested. The trades are their
+        // own channel and are not repeated inside it, because a figure stated
+        // twice in one case is a figure that can disagree with itself. The equity
+        // curve, the monthly table and the markers are not written at all: the
+        // first two are not conformance channels, being derived from fills and
+        // closes the case already fixes, and a marker is a chart output the
+        // `markers` channel owns, which a case about money does not assert.
+        'expected.json': json({
+            diagnostics: record.diagnostics,
+            orders: record.orders,
+            trades: record.report.trades,
+            performance: [record.report.summary],
+        }),
+        // Section 2: the record of `host-interface.md` 4.1, which is what the
+        // engine was handed and not the money layer's contract. The suite's
+        // defaults for an absent file are boring on purpose and are not this run's
+        // instrument, so the file is always written.
+        'instrument.json': json(instrument.value),
+        // Section 3: what the report was folded under and the script never states.
+        // Always written, because every run rounds money to some digit count, and a
+        // strategy case that left it out would be run under whatever count a runner
+        // assumed. `costs` is null for the declaration's own schedule and `range`
+        // carries null for a bound nobody stated, so the file says what the run ran
+        // under in every case rather than leaving a default to a runner.
+        'backtest.json': json({
+            digits: record.settings.contract.digits,
+            costs: record.settings.costs,
+            range: record.settings.range,
+        }),
+    };
+    // Without this the case is unpassable, on every engine including the one that
+    // wrote it. `conformance.md` section 3 ends "a case with no `frames.csv` is
+    // handed no frames at all", and what `expected.json` asserts through the
+    // orders channel is what came of the frames: a status, a cumulative quantity,
+    // an average fill price. An engine handed none of them folds nothing and
+    // disagrees with every row, and the failure reads as a defect in that engine.
+    //
+    // Written only when the run had frames, because an empty file and an absent
+    // one mean the same thing here and the absent one says it in fewer bytes.
+    if (record.frames.length > 0)
+        files['frames.csv'] = framesCsv(record.frames);
+    // Written only when the run had inputs to write. An empty settings.json says
+    // "these are the values" about nothing, and section 2 reads an absent one as
+    // every input taking its declared default, which is what actually happened.
+    if (Object.keys(record.settings.inputs).length > 0) {
+        files['settings.json'] = json(record.settings.inputs);
+    }
+    return { ok: true, files };
+}
+/** A refusal about what the record holds, which no catalogue entry is about. */
+function refused(reason) {
+    return { ok: false, reason, code: null };
+}
+/**
+ * The instrument record a case can state faithfully, or why there is none.
+ *
+ * Two refusals, and both are the same refusal: the file `conformance.md`
+ * section 2 names is the record of `host-interface.md` 4.1, and a record that
+ * cannot produce that record cannot produce the file.
+ *
+ * A record written before version 3 carries none, because the facts beside
+ * the contract were handed to the engine and written down nowhere. And 4.1
+ * requires one fact of every host, `hasVolume`, which is the one the engine
+ * does not refuse a run without: a run whose host never stated it ran with the
+ * flag absent, so a file stating it would hand a second engine a different
+ * study than the one the expected output came from, and a file omitting it is
+ * not a 4.1 record. The other rules that page states about a record, a session
+ * with no timezone to read it in, are refused at load, so a run that happened
+ * cannot carry one.
+ */
+function instrumentOf(record) {
+    if (record.instrument === null) {
+        return refused('the record carries no instrument record, so the case would have no instrument.json: ' +
+            'it was written before record version 3, and re-running the script records one');
+    }
+    if (typeof record.instrument.hasVolume !== 'boolean') {
+        return refused('the run was handed no hasVolume, which host-interface.md 4.1 requires of every ' +
+            'host, so instrument.json cannot be the record that page defines: run the script ' +
+            'with the instrument facts stated');
+    }
+    return { ok: true, value: record.instrument };
+}
+/**
+ * Whether every setting the run was carried out under has a place in the case,
+ * and whether its tolerance is one the suite accepts.
+ *
+ * The first question is asked of the record rather than of the type, because a
+ * record read back from JSON is whatever was written: a field this projection
+ * has no file for is refused with its name, never passed over into a case that
+ * then ran under a value it does not state.
+ */
+function settingsRefusal(settings) {
+    for (const key of Object.keys(settings)) {
+        if (key in CARRIED)
+            continue;
+        return refused(`the record's settings carry ${key}, which no file of conformance.md section 2 has a ` +
+            'place for, so a case written from it would run under a setting it does not state: ' +
+            'give the setting a file on that page and a row in this projection first');
+    }
+    return toleranceRefusal(settings.tolerance);
+}
+/**
+ * A tolerance past the cap is a comparison somebody may find useful and is not
+ * a case, `conformance.md` section 6.
+ *
+ * Refused here, where the case is written, and not only where one is read,
+ * because a directory the suite will not accept fails every runner it meets
+ * and the blame lands on the engine under test. The run's own settings check
+ * refuses a bound with no reason and a bound below zero before a record
+ * exists; the cap is the one rule about a tolerance that is the suite's rather
+ * than the run's, so it is the one asked here.
+ */
+function toleranceRefusal(tolerance) {
+    const { abs, rel } = tolerance;
+    if (!Number.isFinite(abs) || !Number.isFinite(rel)) {
+        return settingRefusal('a bound is not a finite number');
+    }
+    if (abs <= TOLERANCE_CAP.abs && rel <= TOLERANCE_CAP.rel)
+        return null;
+    return settingRefusal(`a bound of ${canonicalNumber(abs)} absolute and ${canonicalNumber(rel)} relative is ` +
+        'past the cap conformance.md section 6 puts on a conformance case, ' +
+        `${canonicalNumber(TOLERANCE_CAP.abs)} absolute and ${canonicalNumber(TOLERANCE_CAP.rel)} ` +
+        'relative, so this run is a comparison and not a case');
+}
+/** A refusal about the comparison tolerance, filed under the run's own code for a setting. */
+function settingRefusal(problem) {
+    const diagnostic = diagnosticFor('OS6021', NO_POSITION, {
+        setting: 'The comparison tolerance',
+        problem,
+    });
+    return { ok: false, reason: diagnostic.message, code: diagnostic.code };
+}
+/**
+ * Through the canonical writer, so a case's bytes are the record's bytes.
+ *
+ * There is one canonical writer in this repository and this is not a second
+ * one: key order and number form are fixed for everybody, which is what lets a
+ * case be compared as text at all.
+ */
+function json(value) {
+    return `${canonicalise(value)}\n`;
+}
+/** `conformance.md` section 3: header, one row per bar, oldest first, `none` for absent. */
+function barsCsv(rows) {
+    const lines = ['time,open,high,low,close,volume'];
+    for (const bar of rows) {
+        lines.push([bar.time, bar.open, bar.high, bar.low, bar.close, bar.volume].map(cell).join(','));
+    }
+    return `${lines.join('\n')}\n`;
+}
+/**
+ * `conformance.md` section 3: the fields of a frame, in the order that page names.
+ *
+ * A projection and not a translation. The record already holds an intent as an
+ * ordinal rather than as this engine's own id, for the reason the same section
+ * gives: a case cannot know the id another engine minted and must not depend on
+ * its spelling.
+ *
+ * The instant is written on every row, `none` where the destination stated
+ * none, through the same cell writer as an absent price. A case whose frames
+ * carried instants and whose file did not would assert an `updatedAt` that its
+ * own input cannot reproduce, which is what the column closes.
+ */
+function framesCsv(frames) {
+    const lines = ['afterBar,intent,status,filledQty,avgFillPrice,orderRef,text,time'];
+    for (const frame of frames) {
+        lines.push([
+            canonicalNumber(frame.afterBar),
+            canonicalNumber(frame.intent),
+            frame.status,
+            canonicalNumber(frame.filledQty),
+            cell(frame.avgFillPrice),
+            frame.orderRef ?? '',
+            frame.text ?? '',
+            cell(frame.time),
+        ].join(','));
+    }
+    return `${lines.join('\n')}\n`;
+}
+/**
+ * One cell, through the one number writer.
+ *
+ * An absent field is `none` rather than empty, because an empty cell between two
+ * commas is indistinguishable from a file somebody's editor trimmed, and a
+ * language whose central idea is the absent value cannot be vague about it. A
+ * case is compared as text, so the number is written by the rule of
+ * `language.md` 5.5 and by the same function that writes every other number in
+ * the repository, never by a second spelling that agrees until it does not.
+ */
+function cell(value) {
+    return value === null || !Number.isFinite(value) ? 'none' : canonicalNumber(value);
+}
+/** A text file ends with a newline, so appending to it never joins two lines. */
+function endsWithNewline(text) {
+    return text.endsWith('\n') ? text : `${text}\n`;
+}
+//# sourceMappingURL=case.js.map

package/dist/core/backtest/case.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"case.js","sourceRoot":"","sources":["../../../src/core/backtest/case.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AA+CjE;;;;;;GAMG;AACH,MAAM,gBAAgB,GAAG,CAAC,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAU,CAAC;AAErF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAmD;IAC3E,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,KAAK;CACX,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,OAAO,GAAqD;IAChE,QAAQ,EAAE,wDAAwD;IAClE,KAAK,EAAE,eAAe;IACtB,KAAK,EAAE,eAAe;IACtB,MAAM,EAAE,eAAe;IACvB,GAAG,EAAE,WAAW;IAChB,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,sCAAsC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAuB,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,MAAiB,EAAE,QAAsB;IACrE,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,OAAO,CACZ,0EAA0E;YACxE,2EAA2E,CAC9E,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,OAAO,CACZ,gFAAgF;YAC9E,qDAAqD,CACxD,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACpE,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACvC,OAAO,OAAO,CAAC,uEAAuE,CAAC,CAAC;IAC1F,CAAC;IACD,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,UAAU,CAAC;IACtC,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,QAAQ,CAAC;IAEvC,MAAM,KAAK,GAA2B;QACpC,WAAW,EAAE,IAAI,CAAC;YAChB,EAAE,EAAE,QAAQ,CAAC,EAAE;YACf,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,UAAU;YACzC,OAAO,EAAE,UAAU;YACnB,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC;YAC/C,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,OAAO,EAAE,CAAC,GAAG,gBAAgB,CAAC;YAC9B,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACrE,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;SACrC,CAAC;QACF,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC;QAC/C,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACrC,uEAAuE;QACvE,0EAA0E;QAC1E,sEAAsE;QACtE,0EAA0E;QAC1E,uEAAuE;QACvE,uEAAuE;QACvE,oEAAoE;QACpE,oEAAoE;QACpE,eAAe,EAAE,IAAI,CAAC;YACpB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;YAC5B,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACrC,CAAC;QACF,sEAAsE;QACtE,oEAAoE;QACpE,2EAA2E;QAC3E,6CAA6C;QAC7C,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;QACzC,2EAA2E;QAC3E,4EAA4E;QAC5E,4EAA4E;QAC5E,0EAA0E;QAC1E,4EAA4E;QAC5E,iEAAiE;QACjE,eAAe,EAAE,IAAI,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM;YACvC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;YAC5B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;SAC7B,CAAC;KACH,CAAC;IAEF,8EAA8E;IAC9E,4EAA4E;IAC5E,yEAAyE;IACzE,8EAA8E;IAC9E,yEAAyE;IACzE,8EAA8E;IAC9E,EAAE;IACF,4EAA4E;IAC5E,0EAA0E;IAC1E,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE7E,6EAA6E;IAC7E,6EAA6E;IAC7E,4EAA4E;IAC5E,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,KAAK,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,gFAAgF;AAChF,SAAS,OAAO,CAAC,MAAc;IAC7B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,YAAY,CACnB,MAAiB;IAEjB,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,OAAO,CACZ,sFAAsF;YACpF,+EAA+E,CAClF,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,MAAM,CAAC,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACrD,OAAO,OAAO,CACZ,iFAAiF;YAC/E,kFAAkF;YAClF,kCAAkC,CACrC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CAAC,QAA0B;IACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxC,IAAI,GAAG,IAAI,OAAO;YAAE,SAAS;QAC7B,OAAO,OAAO,CACZ,+BAA+B,GAAG,oDAAoD;YACpF,oFAAoF;YACpF,yEAAyE,CAC5E,CAAC;IACJ,CAAC;IACD,OAAO,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,gBAAgB,CAAC,SAAoB;IAC5C,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;IAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnD,OAAO,cAAc,CAAC,gCAAgC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,GAAG,IAAI,aAAa,CAAC,GAAG,IAAI,GAAG,IAAI,aAAa,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtE,OAAO,cAAc,CACnB,cAAc,eAAe,CAAC,GAAG,CAAC,iBAAiB,eAAe,CAAC,GAAG,CAAC,eAAe;QACpF,oEAAoE;QACpE,GAAG,eAAe,CAAC,aAAa,CAAC,GAAG,CAAC,iBAAiB,eAAe,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG;QAC3F,sDAAsD,CACzD,CAAC;AACJ,CAAC;AAED,8FAA8F;AAC9F,SAAS,cAAc,CAAC,OAAe;IACrC,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE;QACtD,OAAO,EAAE,0BAA0B;QACnC,OAAO;KACR,CAAC,CAAC;IACH,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC;AAC1E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,IAAI,CAAC,KAAc;IAC1B,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;AACpC,CAAC;AAED,4FAA4F;AAC5F,SAAS,OAAO,CAAC,IAA4B;IAC3C,MAAM,KAAK,GAAG,CAAC,iCAAiC,CAAC,CAAC;IAClD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CACR,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACnF,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,SAAS,CAAC,MAAgC;IACjD,MAAM,KAAK,GAAG,CAAC,kEAAkE,CAAC,CAAC;IACnF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CACR;YACE,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC/B,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7B,KAAK,CAAC,MAAM;YACZ,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACxB,KAAK,CAAC,QAAQ,IAAI,EAAE;YACpB,KAAK,CAAC,IAAI,IAAI,EAAE;YAChB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;SACjB,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,IAAI,CAAC,KAAoB;IAChC,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;AACrF,CAAC;AAED,iFAAiF;AACjF,SAAS,eAAe,CAAC,IAAY;IACnC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC;AAClD,CAAC"}

package/dist/core/backtest/compare.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../../src/core/backtest/compare.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,SAAS;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;QACvF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,EAAE,CAAC;IACJ,QAAQ,CAAC,MAAM,EAAE,SAAS;QACxB,0BAA0B;QAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;IACJ,yDAAyD;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,iEAAiE;IACjE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAuCD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,aAAa,CAa9E"}
+{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../../src/core/backtest/compare.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,SAAS;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;QACvF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,EAAE,CAAC;IACJ,QAAQ,CAAC,MAAM,EAAE,SAAS;QACxB,0BAA0B;QAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;IACJ,yDAAyD;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,iEAAiE;IACjE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAyCD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,aAAa,CAa9E"}

package/dist/core/backtest/compare.js

@@ -28,6 +28,8 @@ const COMPARED = [
     'maxDrawdown',
     'maxDrawdownPercent',
     'longestDrawdownBars',
+    'maxRunUp',
+    'maxRunUpPercent',
     'averageBarsHeld',
     'barsInMarket',
     'barCount',

package/dist/core/backtest/compare.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../../src/core/backtest/compare.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AA2BhD;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAsB;IAClC,WAAW;IACX,eAAe;IACf,aAAa;IACb,WAAW;IACX,SAAS;IACT,YAAY;IACZ,gBAAgB;IAChB,MAAM;IACN,QAAQ;IACR,WAAW;IACX,SAAS;IACT,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,yBAAyB;IACzB,cAAc;IACd,aAAa;IACb,oBAAoB;IACpB,qBAAqB;IACrB,iBAAiB;IACjB,cAAc;IACd,UAAU;CACX,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,MAAiB,EAAE,KAAgB;IAC7D,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAE3F,OAAO;QACL,UAAU,EAAE,CAAC,QAAQ;QACrB,WAAW;QACX,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;QAClE,sEAAsE;QACtE,0EAA0E;QAC1E,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5F,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CAAC,MAAiB,EAAE,KAAgB;IAC7D,MAAM,KAAK,GAAiB,EAAE,CAAC;IAE/B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,mBAAmB,MAAM,CAAC,IAAI,CAAC,KAAK,iBAAiB,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;SACxI,CAAC,CAAC;IACL,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrF,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,yCAAyC,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,sBAAsB,MAAM,CAAC,WAAW,aAAa,KAAK,CAAC,WAAW,EAAE;SACjF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,0CAA0C,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,uDAAuD,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,mDAAmD,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACjF,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,iDAAiD,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,MAAe,EAAE,KAAc;IACpD,4EAA4E;IAC5E,4EAA4E;IAC5E,+CAA+C;IAC/C,MAAM,EAAE,GAAG,MAAsD,CAAC;IAClE,MAAM,EAAE,GAAG,KAAqD,CAAC;IACjE,MAAM,MAAM,GAAqE,EAAE,CAAC;IACpF,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,0EAA0E;QAC1E,4CAA4C;QAC5C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;YAAE,SAAS;QACvC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI;YACJ,MAAM,EAAE,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,CAAC,IAAI,CAAC;YACb,KAAK,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2EAA2E;AAC3E,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,iBAAiB,CACxB,MAAiF,EACjF,KAAgF;IAEhF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CACrB,MAAM,CAAC,uBAAuB,GAAG,MAAM,CAAC,uBAAuB;QAC7D,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAChE,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACxD,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACjD,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,mBAAmB,CAC1B,MAA0E,EAC1E,KAAyE;IAEzE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,IAAI,CAAC,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../../src/core/backtest/compare.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AA2BhD;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAsB;IAClC,WAAW;IACX,eAAe;IACf,aAAa;IACb,WAAW;IACX,SAAS;IACT,YAAY;IACZ,gBAAgB;IAChB,MAAM;IACN,QAAQ;IACR,WAAW;IACX,SAAS;IACT,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,yBAAyB;IACzB,cAAc;IACd,aAAa;IACb,oBAAoB;IACpB,qBAAqB;IACrB,UAAU;IACV,iBAAiB;IACjB,iBAAiB;IACjB,cAAc;IACd,UAAU;CACX,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,MAAiB,EAAE,KAAgB;IAC7D,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAE3F,OAAO;QACL,UAAU,EAAE,CAAC,QAAQ;QACrB,WAAW;QACX,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;QAClE,sEAAsE;QACtE,0EAA0E;QAC1E,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5F,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CAAC,MAAiB,EAAE,KAAgB;IAC7D,MAAM,KAAK,GAAiB,EAAE,CAAC;IAE/B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,mBAAmB,MAAM,CAAC,IAAI,CAAC,KAAK,iBAAiB,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;SACxI,CAAC,CAAC;IACL,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrF,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,yCAAyC,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,sBAAsB,MAAM,CAAC,WAAW,aAAa,KAAK,CAAC,WAAW,EAAE;SACjF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,0CAA0C,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,uDAAuD,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,mDAAmD,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACjF,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,iDAAiD,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,MAAe,EAAE,KAAc;IACpD,4EAA4E;IAC5E,4EAA4E;IAC5E,+CAA+C;IAC/C,MAAM,EAAE,GAAG,MAAsD,CAAC;IAClE,MAAM,EAAE,GAAG,KAAqD,CAAC;IACjE,MAAM,MAAM,GAAqE,EAAE,CAAC;IACpF,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,0EAA0E;QAC1E,4CAA4C;QAC5C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;YAAE,SAAS;QACvC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI;YACJ,MAAM,EAAE,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,CAAC,IAAI,CAAC;YACb,KAAK,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2EAA2E;AAC3E,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,iBAAiB,CACxB,MAAiF,EACjF,KAAgF;IAEhF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CACrB,MAAM,CAAC,uBAAuB,GAAG,MAAM,CAAC,uBAAuB;QAC7D,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAChE,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACxD,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACjD,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,mBAAmB,CAC1B,MAA0E,EAC1E,KAAyE;IAEzE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,IAAI,CAAC,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/core/backtest/deliver.d.ts

@@ -0,0 +1,93 @@
+/**
+ * A case's rows and this engine's frames, and the destination between them.
+ *
+ * Both directions are here because they are one correspondence: a case names an
+ * order by an ordinal and an engine knows it by an id, so `Delivery` reads an
+ * ordinal into the id of the intent the run placed, and `framedAs` writes an id
+ * back out as the ordinal a case file prints. Split between two files, the two
+ * halves of it drift, and a suite whose rows say one thing and whose records
+ * say another is one nobody can read.
+ *
+ * `conformance.md` section 3: `frames.csv` supplies order frames the way
+ * `bars.csv` supplies bars, so a strategy case asserts the fold against input
+ * the engine did not choose. `simulate.ts` is the other destination this module
+ * has, the one that reads a bar and works out what a venue would have said.
+ * This one works nothing out. It holds the rows a case supplied, hands over the
+ * ones each boundary names, and the whole of its behaviour is the mapping
+ * between a row and a frame.
+ *
+ * **An ordinal is what a case can name, and an id is not.** A row names the nth
+ * intent the run placed, because no case can know the id an engine minted, so
+ * the intents are counted here in the order the run handed them over and the
+ * ordinal is read against that count. A row naming an ordinal the run never
+ * placed is delivered all the same, carrying an id no run mints: step 1 of
+ * `stdlib.md` 17.8 refuses a frame naming no row of the ledger, and that
+ * refusal is the ledger's to make. A destination that dropped the row instead
+ * would answer nothing at all where section 3 hands an engine a frame about an
+ * order its ledger does not hold, and the case would pass by the frame never
+ * having arrived.
+ *
+ * **What a row does not carry, this does not invent.** `host-interface.md` 7.2
+ * lets a frame say which instrument and product the destination booked the
+ * order under, and the file has no column for either, so neither is stated and
+ * the row keeps what its placement put there. The instant is the one the file
+ * does carry: a row states one or states `none`, and one that states none
+ * leaves `updatedAt` where the placement put it, which is what the fold does
+ * with a frame whose destination stated no instant.
+ */
+import type { OrderFrame, OrderIntent, RoutedEffect } from '../engine/index.js';
+import type { RecordedFrame } from './record.js';
+/** One frame, the boundary it was handed over at, and the row it came from. */
+export interface Delivered {
+    readonly frame: OrderFrame;
+    readonly afterBar: number;
+    /**
+     * The row a case supplied, or null where the run's own destination answered
+     * the frame and there is no row until the record is written.
+     */
+    readonly row: RecordedFrame | null;
+}
+/** Where a run's orders go, and what it is told between two of its bars. */
+export interface Destination {
+    /** Step 9: what the strategy decided, on the bar it decided it. */
+    route(effect: RoutedEffect, barIndex: number): void;
+    /** What this destination hands over at the boundary after `barIndex`. */
+    answers(barIndex: number): readonly Delivered[];
+    /** Every intent it was handed, in the order it was handed them. */
+    readonly intents: readonly OrderIntent[];
+}
+/**
+ * A destination holding one case's frames, ready at the boundaries they name.
+ *
+ * Built before the run rather than during it, because the rows are input: what
+ * a boundary hands over was decided by whoever wrote the case and not by
+ * anything this run does. The one thing it learns as the run goes is which
+ * intent an ordinal names, which only the run can say.
+ */
+export declare class Delivery implements Destination {
+    readonly intents: OrderIntent[];
+    /** The rows of each boundary, in file order, which section 3 fixes as the delivery order. */
+    private readonly rows;
+    constructor(frames: readonly RecordedFrame[]);
+    /** Nothing is decided by an order arriving here: it is counted, and that is all. */
+    route(effect: RoutedEffect): void;
+    answers(barIndex: number): readonly Delivered[];
+}
+/**
+ * The ordinal of every intent, which is how a case names one.
+ *
+ * One, two, three in the order the run placed them, because no engine can know
+ * the id another minted and a case that named one would only ever be readable
+ * by the engine that wrote it.
+ */
+export declare function ordinalsOf(intents: readonly OrderIntent[]): ReadonlyMap<number, number>;
+/**
+ * One delivered frame, in the columns a case file prints.
+ *
+ * The instant travels with it. `stdlib.md` 17.7 folds `updatedAt` from a
+ * frame's `time`, so a driver that dropped the field here wrote a record whose
+ * ledger no engine could fold from the record's own frames: it would have
+ * nothing to move that field to and would leave it at `placedAt`.
+ */
+export declare function framedAs(frame: OrderFrame, afterBar: number, ordinals: ReadonlyMap<number, number>): RecordedFrame;
+//# sourceMappingURL=deliver.d.ts.map

package/dist/core/backtest/deliver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deliver.d.ts","sourceRoot":"","sources":["../../../src/core/backtest/deliver.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,+EAA+E;AAC/E,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI,CAAC;CACpC;AAED,4EAA4E;AAC5E,MAAM,WAAW,WAAW;IAC1B,mEAAmE;IACnE,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD,yEAAyE;IACzE,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,SAAS,EAAE,CAAC;IAChD,mEAAmE;IACnE,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;CAC1C;AAcD;;;;;;;GAOG;AACH,qBAAa,QAAS,YAAW,WAAW;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,CAAM;IACrC,6FAA6F;IAC7F,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsC;gBAE/C,MAAM,EAAE,SAAS,aAAa,EAAE;IAQ5C,oFAAoF;IACpF,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAIjC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,SAAS,EAAE;CAQhD;AAeD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,GAAG,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAMvF;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,aAAa,CAWf"}

package/dist/core/backtest/deliver.js

@@ -0,0 +1,94 @@
+/**
+ * An id no run mints, which a row naming no intent of this run is delivered
+ * under.
+ *
+ * Ids are counted from one by the ledger that mints them, so nothing below one
+ * can name a row and the fold refuses the frame by the rule it refuses every
+ * other unknown one by. The alternative was an id of a real row chosen by some
+ * rule of this file's own, which would fold a case's frame into whichever order
+ * happened to be near it.
+ */
+const NO_INTENT = -1;
+/**
+ * A destination holding one case's frames, ready at the boundaries they name.
+ *
+ * Built before the run rather than during it, because the rows are input: what
+ * a boundary hands over was decided by whoever wrote the case and not by
+ * anything this run does. The one thing it learns as the run goes is which
+ * intent an ordinal names, which only the run can say.
+ */
+export class Delivery {
+    intents = [];
+    /** The rows of each boundary, in file order, which section 3 fixes as the delivery order. */
+    rows = new Map();
+    constructor(frames) {
+        for (const row of frames) {
+            const at = this.rows.get(row.afterBar);
+            if (at === undefined)
+                this.rows.set(row.afterBar, [row]);
+            else
+                at.push(row);
+        }
+    }
+    /** Nothing is decided by an order arriving here: it is counted, and that is all. */
+    route(effect) {
+        for (const intent of effect.intents)
+            this.intents.push(intent);
+    }
+    answers(barIndex) {
+        const due = this.rows.get(barIndex) ?? [];
+        return due.map((row) => ({
+            frame: frameOf(row, this.intents[row.intent - 1]),
+            afterBar: barIndex,
+            row,
+        }));
+    }
+}
+/** One row of a case, as the frame `host-interface.md` 7.2 describes. */
+function frameOf(row, intent) {
+    return {
+        intentId: intent?.intentId ?? NO_INTENT,
+        status: row.status,
+        filledQty: row.filledQty,
+        avgFillPrice: row.avgFillPrice,
+        orderRef: row.orderRef,
+        text: row.text,
+        time: row.time,
+    };
+}
+/**
+ * The ordinal of every intent, which is how a case names one.
+ *
+ * One, two, three in the order the run placed them, because no engine can know
+ * the id another minted and a case that named one would only ever be readable
+ * by the engine that wrote it.
+ */
+export function ordinalsOf(intents) {
+    const out = new Map();
+    for (const intent of intents) {
+        if (!out.has(intent.intentId))
+            out.set(intent.intentId, out.size + 1);
+    }
+    return out;
+}
+/**
+ * One delivered frame, in the columns a case file prints.
+ *
+ * The instant travels with it. `stdlib.md` 17.7 folds `updatedAt` from a
+ * frame's `time`, so a driver that dropped the field here wrote a record whose
+ * ledger no engine could fold from the record's own frames: it would have
+ * nothing to move that field to and would leave it at `placedAt`.
+ */
+export function framedAs(frame, afterBar, ordinals) {
+    return {
+        afterBar,
+        intent: ordinals.get(frame.intentId) ?? 0,
+        status: frame.status,
+        filledQty: frame.filledQty,
+        avgFillPrice: frame.avgFillPrice ?? null,
+        orderRef: frame.orderRef ?? null,
+        text: frame.text ?? null,
+        time: frame.time ?? null,
+    };
+}
+//# sourceMappingURL=deliver.js.map

package/dist/core/backtest/deliver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deliver.js","sourceRoot":"","sources":["../../../src/core/backtest/deliver.ts"],"names":[],"mappings":"AA6DA;;;;;;;;;GASG;AACH,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC;AAErB;;;;;;;GAOG;AACH,MAAM,OAAO,QAAQ;IACV,OAAO,GAAkB,EAAE,CAAC;IACrC,6FAA6F;IAC5E,IAAI,GAAG,IAAI,GAAG,EAA2B,CAAC;IAE3D,YAAY,MAAgC;QAC1C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,EAAE,KAAK,SAAS;gBAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;;gBACpD,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,oFAAoF;IACpF,KAAK,CAAC,MAAoB;QACxB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,CAAC,QAAgB;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC1C,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACvB,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACjD,QAAQ,EAAE,QAAQ;YAClB,GAAG;SACJ,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AAED,yEAAyE;AACzE,SAAS,OAAO,CAAC,GAAkB,EAAE,MAA+B;IAClE,OAAO;QACL,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,SAAS;QACvC,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,YAAY,EAAE,GAAG,CAAC,YAAY;QAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,GAAG,CAAC,IAAI;KACf,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAA+B;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;IACtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAiB,EACjB,QAAgB,EAChB,QAAqC;IAErC,OAAO;QACL,QAAQ;QACR,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;QACzC,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,IAAI;QACxC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;QAChC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;QACxB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;KACzB,CAAC;AACJ,CAAC"}