@quantform/core 0.6.6 → 0.7.0-beta.10

package/src/adapter/backtester/backtester-cursor.ts

@@ -1,47 +0,0 @@
-import { InstrumentSelector } from '../../domain';
-import { timestamp } from '../../shared';
-import { Feed, StorageEvent } from '../../storage';
-import { backtestPageNotEmpty } from '../error';
-
-export class BacktesterCursor {
-  private page = new Array<StorageEvent>();
-  private pageIndex = 0;
-  completed = false;
-
-  get size(): number {
-    return this.page.length - this.pageIndex;
-  }
-
-  constructor(readonly instrument: InstrumentSelector, private readonly feed: Feed) {}
-
-  peek(): StorageEvent | undefined {
-    if (!this.page) {
-      return undefined;
-    }
-
-    return this.page[this.pageIndex];
-  }
-
-  dequeue(): StorageEvent {
-    return this.page[this.pageIndex++];
-  }
-
-  async fetchNextPage(from: timestamp, to: number): Promise<void> {
-    if (this.completed) {
-      return;
-    }
-
-    if (this.size > 0) {
-      throw backtestPageNotEmpty();
-    }
-
-    this.pageIndex = 0;
-    this.page = await this.feed.query(this.instrument, {
-      from,
-      to,
-      count: 10000
-    });
-
-    this.completed = this.page.length == 0;
-  }
-}

package/src/adapter/backtester/backtester-streamer.spec.ts

@@ -1,60 +0,0 @@
-import { Asset, Commission, Instrument } from '../../domain';
-import { d } from '../../shared';
-import { Feed, InMemoryStorage } from '../../storage';
-import { Store, TradePatchEvent } from '../../store';
-import { BacktesterStreamer } from './backtester-streamer';
-
-describe('BacktesterStreamer', () => {
-  const instrument = new Instrument(
-    0,
-    new Asset('btc', 'binance', 8),
-    new Asset('usdt', 'binance', 2),
-    'binance:btc-usdt',
-    Commission.Zero
-  );
-
-  test('should repeat specific events', done => {
-    const feed = new Feed(new InMemoryStorage());
-    const store = new Store();
-
-    store.snapshot.universe.instrument.upsert(instrument);
-    store.snapshot.subscription.instrument.upsert(instrument);
-
-    const streamer = new BacktesterStreamer(
-      store,
-      feed,
-      {
-        from: 0,
-        to: 10
-      },
-      {
-        onBacktestCompleted: () => {
-          const trade = store.snapshot.trade.get(instrument.id) ?? fail();
-
-          expect(trade.timestamp).toEqual(8);
-          expect(trade.rate).toEqual(d(8));
-          expect(trade.quantity).toEqual(d(8));
-          expect(store.snapshot.timestamp).toEqual(8);
-
-          done();
-        }
-      }
-    );
-
-    feed
-      .save([
-        new TradePatchEvent(instrument, d(1), d(1), 1),
-        new TradePatchEvent(instrument, d(2), d(2), 2),
-        new TradePatchEvent(instrument, d(3), d(3), 3),
-        new TradePatchEvent(instrument, d(4), d(4), 4),
-        new TradePatchEvent(instrument, d(5), d(5), 5),
-        new TradePatchEvent(instrument, d(6), d(6), 6),
-        new TradePatchEvent(instrument, d(7), d(7), 7),
-        new TradePatchEvent(instrument, d(8), d(8), 8)
-      ])
-      .then(() => {
-        streamer.subscribe(instrument);
-        streamer.tryContinue();
-      });
-  });
-});

package/src/adapter/backtester/backtester-streamer.ts

@@ -1,155 +0,0 @@
-import { InstrumentSelector } from '../../domain';
-import { timestamp } from '../../shared';
-import { Feed } from '../../storage';
-import { Store } from '../../store';
-import { AdapterTimeProvider } from '../adapter';
-import { BacktesterCursor } from './backtester-cursor';
-import { invalidEventSequenceError, missingPeriodParametersError } from './error';
-
-/**
- * Listen to backtest session events.
- */
-export interface BacktesterListener {
-  /**
-   * Called once when backtest started.
-   */
-  onBacktestStarted?(streamer: BacktesterStreamer): void;
-
-  /**
-   * Called every time when backtest progress updated.
-   */
-  onBacktestUpdated?(streamer: BacktesterStreamer): void;
-
-  /**
-   * Called once when backtest completed.
-   */
-  onBacktestCompleted?(streamer: BacktesterStreamer): void;
-}
-
-export class BacktesterStreamer {
-  private sequenceUpdateBatch = 10000;
-  private cursor: Record<string, BacktesterCursor> = {};
-  private stopAcquire = 1;
-
-  timestamp: timestamp;
-  sequence = 0;
-
-  constructor(
-    private readonly store: Store,
-    private readonly feed: Feed,
-    private readonly period: { from: number; to: number },
-    private readonly listener?: BacktesterListener
-  ) {
-    if (period.from == undefined || period.to == undefined) {
-      throw missingPeriodParametersError();
-    }
-
-    this.timestamp = period.from;
-  }
-
-  getTimeProvider(): AdapterTimeProvider {
-    const provider = {
-      timestamp: () => this.timestamp
-    };
-
-    return provider;
-  }
-
-  subscribe(instrument: InstrumentSelector) {
-    if (instrument.id in this.cursor) {
-      return;
-    }
-
-    const cursor = new BacktesterCursor(instrument, this.feed);
-
-    this.cursor[instrument.id] = cursor;
-  }
-
-  /**
-   * Increments stop counter.
-   */
-  stop() {
-    this.stopAcquire++;
-  }
-
-  /**
-   * Decreases stop counter and continues execution if no more stops requested.
-   */
-  tryContinue() {
-    if (this.stopAcquire == 0) {
-      return;
-    }
-
-    this.stopAcquire = Math.max(0, this.stopAcquire - 1);
-
-    if (this.stopAcquire != 0) {
-      return;
-    }
-
-    if (this.sequence == 0) {
-      if (this.listener?.onBacktestStarted) {
-        this.listener.onBacktestStarted(this);
-      }
-    }
-
-    const next = async () => {
-      if (await this.processNext()) {
-        if (this.sequence % this.sequenceUpdateBatch == 0) {
-          if (this.listener?.onBacktestUpdated) {
-            this.listener.onBacktestUpdated(this);
-          }
-        }
-
-        if (this.stopAcquire === 0) {
-          setImmediate(next);
-        }
-      } else {
-        if (this.listener?.onBacktestCompleted) {
-          this.listener.onBacktestCompleted(this);
-        }
-      }
-    };
-
-    next();
-  }
-
-  private async processNext(): Promise<boolean> {
-    const cursor = await this.current(this.timestamp, this.period.to);
-    if (!cursor) {
-      return false;
-    }
-
-    const event = cursor.peek();
-
-    if (!event) {
-      return false;
-    }
-
-    this.timestamp = event.timestamp;
-    this.sequence++;
-
-    this.store.dispatch(event);
-
-    if (cursor.dequeue().timestamp != event.timestamp) {
-      throw invalidEventSequenceError();
-    }
-
-    return true;
-  }
-
-  private async current(
-    from: timestamp,
-    to: timestamp
-  ): Promise<BacktesterCursor | undefined> {
-    for (const cursor of Object.values(this.cursor)) {
-      if (cursor.size == 0 && !cursor.completed) {
-        await cursor.fetchNextPage(from, to);
-      }
-    }
-
-    return Object.values(this.cursor)
-      .filter(it => it !== undefined)
-      .sort((lhs, rhs) => (lhs?.peek()?.timestamp ?? 0) - (rhs?.peek()?.timestamp ?? 0))
-      .find(() => true);
-  }
-}

package/src/adapter/backtester/error.ts

@@ -1,7 +0,0 @@
-export function missingPeriodParametersError() {
-  return new Error('invalid backtest options, please provide from and to period.');
-}
-
-export function invalidEventSequenceError() {
-  return new Error('invalid event to consume');
-}

package/src/adapter/backtester/index.ts

@@ -1,2 +0,0 @@
-export * from './backtester-adapter';
-export * from './backtester-streamer';

package/src/adapter/error.ts

@@ -1,13 +0,0 @@
-export function adapterNotFoundError(adapterName: string) {
-  return new Error(
-    `Unknown adapter: ${adapterName}. You should provide adapter in session descriptor.`
-  );
-}
-
-export function noPaperEngineProvidedError() {
-  return new Error('No paper engine provided.');
-}
-
-export function backtestPageNotEmpty() {
-  return new Error('Backtest page is not empty');
-}

package/src/adapter/index.ts

@@ -1,4 +0,0 @@
-export * from './adapter';
-export * from './adapter-aggregate';
-export * from './backtester';
-export * from './paper';

package/src/adapter/paper/engine/paper-engine.spec.ts

@@ -1,116 +0,0 @@
-import {
-  Asset,
-  Commission,
-  commissionPercentOf,
-  Instrument,
-  Order
-} from '../../../domain';
-import { d, now } from '../../../shared';
-import {
-  BalancePatchEvent,
-  InstrumentPatchEvent,
-  InstrumentSubscriptionEvent,
-  OrderbookPatchEvent,
-  Store
-} from '../../../store';
-import { PaperEngine } from './paper-engine';
-
-describe('PaperEngine', () => {
-  const instrument = new Instrument(
-    0,
-    new Asset('btc', 'binance', 8),
-    new Asset('usdt', 'binance', 2),
-    'binance:btc-usdt',
-    Commission.Zero
-  );
-
-  const commission = commissionPercentOf({
-    maker: d(0.1),
-    taker: d(0.1)
-  });
-
-  test('should open a new buy market order', () => {
-    const store = new Store();
-    const engine = new PaperEngine(store);
-    const order = new Order(0, '1', instrument, d(1.0), 0);
-
-    store.dispatch(
-      new InstrumentPatchEvent(now(), instrument.base, instrument.quote, commission, ''),
-      new BalancePatchEvent(instrument.base, d(1), d.Zero, now()),
-      new BalancePatchEvent(instrument.quote, d(1000), d.Zero, now())
-    );
-
-    engine.open(order);
-
-    const pendingOrder = store.snapshot.order.get(instrument.id)?.get(order.id) ?? fail();
-    const balance = store.snapshot.balance.get(instrument.quote.id) ?? fail();
-
-    expect(store.snapshot.order.asReadonlyArray().length).toEqual(1);
-    expect(pendingOrder).toEqual(order);
-    expect(balance.free).toEqual(d.Zero);
-    expect(balance.locked).toEqual(d(1000));
-  });
-
-  test('should open a new sell market order', () => {
-    const store = new Store();
-    const engine = new PaperEngine(store);
-    const order = new Order(0, '1', instrument, d(-0.6), 0);
-
-    store.dispatch(
-      new InstrumentPatchEvent(now(), instrument.base, instrument.quote, commission, ''),
-      new BalancePatchEvent(instrument.base, d(1), d.Zero, now()),
-      new BalancePatchEvent(instrument.quote, d(1000), d.Zero, now())
-    );
-
-    engine.open(order);
-
-    const pendingOrder = store.snapshot.order.get(instrument.id)?.get(order.id) ?? fail();
-    const balance = store.snapshot.balance.get(instrument.base.id) ?? fail();
-
-    expect(store.snapshot.order.asReadonlyArray().length).toEqual(1);
-    expect(pendingOrder).toEqual(order);
-    expect(balance.free).toEqual(d(0.4));
-    expect(balance.locked).toEqual(d(0.6));
-  });
-
-  test('should open and fill a new sell limit order', () => {
-    const store = new Store();
-    const engine = new PaperEngine(store);
-    const order = new Order(0, '1', instrument, d(-0.6), 0, d(100));
-
-    store.dispatch(
-      new InstrumentPatchEvent(now(), instrument.base, instrument.quote, commission, ''),
-      new BalancePatchEvent(instrument.base, d(1), d.Zero, now()),
-      new BalancePatchEvent(instrument.quote, d(1000), d.Zero, now()),
-      new InstrumentSubscriptionEvent(now(), instrument, true)
-    );
-
-    engine.open(order);
-
-    const pendingOrder = store.snapshot.order.get(instrument.id)?.get(order.id) ?? fail();
-    const baseBalance = store.snapshot.balance.get(instrument.base.id) ?? fail();
-
-    expect(store.snapshot.order.asReadonlyArray().length).toEqual(1);
-    expect(pendingOrder.state).toEqual('PENDING');
-    expect(baseBalance.free).toEqual(d(0.4));
-    expect(baseBalance.locked).toEqual(d(0.6));
-
-    store.dispatch(
-      new OrderbookPatchEvent(
-        instrument,
-        { rate: d(102), quantity: d(1), next: undefined },
-        { rate: d(101), quantity: d(1), next: undefined },
-        now()
-      )
-    );
-
-    const quoteBalance = store.snapshot.balance.get(instrument.quote.id) ?? fail();
-
-    expect(store.snapshot.order.asReadonlyArray().length).toEqual(1);
-    expect(pendingOrder.state).toEqual('FILLED');
-    expect(baseBalance.free).toEqual(d(0.4));
-    expect(baseBalance.locked).toEqual(d.Zero);
-    expect(quoteBalance.free).toEqual(d(1060.53));
-    expect(quoteBalance.locked).toEqual(d.Zero);
-  });
-});

package/src/adapter/paper/engine/paper-engine.ts

@@ -1,151 +0,0 @@
-import { tap } from 'rxjs';
-
-import { Order, Orderbook, Trade } from '../../../domain';
-import { d, decimal } from '../../../shared';
-import {
-  BalanceLockOrderEvent,
-  BalanceTransactEvent,
-  BalanceUnlockOrderEvent,
-  OrderCanceledEvent,
-  OrderCancelingEvent,
-  OrderFilledEvent,
-  OrderNewEvent,
-  OrderPendingEvent,
-  OrderRejectedEvent,
-  Store
-} from '../../../store';
-import { instrumentNotSupportedError } from '../../../store/error';
-
-export class PaperEngine {
-  constructor(private readonly store: Store) {
-    store.changes$
-      .pipe(
-        tap(it => {
-          if (it instanceof Orderbook) {
-            this.onOrderbook(it);
-          } else if (it instanceof Trade) {
-            this.onTrade(it);
-          }
-        })
-      )
-      .subscribe();
-  }
-
-  public open(order: Order) {
-    const { timestamp } = this.store.snapshot;
-
-    try {
-      this.store.dispatch(
-        new OrderNewEvent(order, timestamp),
-        new BalanceLockOrderEvent(order.id, order.instrument, timestamp)
-      );
-
-      this.store.dispatch(new OrderPendingEvent(order.id, order.instrument, timestamp));
-    } catch (error) {
-      this.store.dispatch(
-        new BalanceUnlockOrderEvent(order.id, order.instrument, timestamp),
-        new OrderRejectedEvent(order.id, order.instrument, timestamp)
-      );
-    }
-  }
-
-  public cancel(order: Order) {
-    const { timestamp } = this.store.snapshot;
-
-    this.store.dispatch(new OrderCancelingEvent(order.id, order.instrument, timestamp));
-
-    this.store.dispatch(
-      new BalanceUnlockOrderEvent(order.id, order.instrument, timestamp),
-      new OrderCanceledEvent(order.id, order.instrument, timestamp)
-    );
-  }
-
-  private onOrderbook(orderbook: Orderbook) {
-    const orders = this.store.snapshot.order.get(orderbook.instrument.id);
-    if (!orders) {
-      return;
-    }
-
-    orders.asReadonlyArray().forEach(it => {
-      if (it.state != 'PENDING') {
-        return;
-      }
-
-      if (it.rate) {
-        if (it.quantity.greaterThan(0) && it.rate.greaterThan(orderbook.asks.rate)) {
-          this.completeOrder(it, orderbook.asks.rate);
-        } else if (it.quantity.lessThan(0) && it.rate.lessThan(orderbook.bids.rate)) {
-          this.completeOrder(it, orderbook.bids.rate);
-        }
-      } else {
-        if (it.quantity.greaterThan(0)) {
-          this.completeOrder(it, orderbook.asks.rate);
-        } else if (it.quantity.lessThan(0)) {
-          this.completeOrder(it, orderbook.bids.rate);
-        }
-      }
-    });
-  }
-
-  private onTrade(trade: Trade) {
-    const orders = this.store.snapshot.order.get(trade.instrument.id);
-    if (!orders) {
-      return;
-    }
-
-    orders.asReadonlyArray().forEach(it => {
-      if (it.state != 'PENDING') {
-        return;
-      }
-
-      if (it.rate) {
-        if (it.quantity.greaterThan(0) && it.rate.greaterThan(trade.rate)) {
-          this.completeOrder(it, trade.rate);
-        } else if (it.quantity.lessThan(0) && it.rate.lessThan(trade.rate)) {
-          this.completeOrder(it, trade.rate);
-        }
-      } else {
-        this.completeOrder(it, trade.rate);
-      }
-    });
-  }
-
-  private completeOrder(order: Order, averageExecutionRate: decimal) {
-    const { timestamp } = this.store.snapshot;
-
-    const instrument = this.store.snapshot.universe.instrument.get(order.instrument.id);
-    if (!instrument) {
-      throw instrumentNotSupportedError(order.instrument);
-    }
-
-    const transacted = {
-      base: d.Zero,
-      quote: d.Zero
-    };
-
-    const qty = order.quantity.abs();
-
-    if (order.quantity.greaterThan(0)) {
-      transacted.base = transacted.base.plus(
-        instrument.base.floor(instrument.commission.applyMakerFee(qty))
-      );
-      transacted.quote = transacted.quote.minus(
-        instrument.quote.floor(averageExecutionRate.mul(qty))
-      );
-    } else if (order.quantity.lessThan(0)) {
-      transacted.base = transacted.base.minus(instrument.base.floor(qty));
-      transacted.quote = transacted.quote.plus(
-        instrument.quote.floor(
-          instrument.commission.applyMakerFee(averageExecutionRate.mul(qty))
-        )
-      );
-    }
-
-    this.store.dispatch(
-      new BalanceUnlockOrderEvent(order.id, order.instrument, timestamp),
-      new OrderFilledEvent(order.id, order.instrument, averageExecutionRate, timestamp),
-      new BalanceTransactEvent(instrument.base, transacted.base, timestamp),
-      new BalanceTransactEvent(instrument.quote, transacted.quote, timestamp)
-    );
-  }
-}

package/src/adapter/paper/index.ts

@@ -1,2 +0,0 @@
-export * from './paper-adapter';
-export * from './engine/paper-engine';

package/src/adapter/paper/paper-adapter.ts

@@ -1,111 +0,0 @@
-import { assetOf, InstrumentSelector, Ohlc, Order } from '../../domain';
-import { d, decimal, timestamp } from '../../shared';
-import { BalancePatchEvent, Store } from '../../store';
-import { Adapter } from '..';
-import { AdapterFactory, FeedAsyncCallback } from '../adapter';
-import { noPaperEngineProvidedError } from '../error';
-import { PaperEngine } from './engine/paper-engine';
-
-export interface PaperOptions {
-  balance: { [key: string]: decimal };
-}
-
-export function createPaperAdapterFactory(
-  decoratedAdapterFactory: AdapterFactory,
-  options: PaperOptions
-): AdapterFactory {
-  return (timeProvider, store, cache) =>
-    new PaperAdapter(decoratedAdapterFactory(timeProvider, store, cache), store, options);
-}
-
-export class PaperAdapter extends Adapter {
-  readonly name = this.decoratedAdapter.name;
-  private engine?: PaperEngine;
-
-  constructor(
-    readonly decoratedAdapter: Adapter,
-    readonly store: Store,
-    readonly options: PaperOptions
-  ) {
-    super({
-      timestamp: () => this.decoratedAdapter.timestamp()
-    });
-  }
-
-  async awake(): Promise<void> {
-    this.engine = this.createPaperEngine(this);
-
-    await this.decoratedAdapter.awake();
-  }
-
-  dispose(): Promise<void> {
-    return this.decoratedAdapter.dispose();
-  }
-
-  subscribe(instruments: InstrumentSelector[]): Promise<void> {
-    return this.decoratedAdapter.subscribe(instruments);
-  }
-
-  async account(): Promise<void> {
-    let subscribed = Object.values(this.store.snapshot.subscription.asset).filter(
-      it => it.adapterName == this.name
-    );
-
-    for (const balance in this.options.balance) {
-      const asset = assetOf(balance);
-
-      if (asset.adapterName != this.name) {
-        continue;
-      }
-
-      const free = this.options.balance[balance];
-
-      subscribed = subscribed.filter(it => it.id != asset.id);
-
-      this.store.dispatch(new BalancePatchEvent(asset, free, d.Zero, this.timestamp()));
-    }
-
-    for (const missingAsset of subscribed) {
-      this.store.dispatch(
-        new BalancePatchEvent(missingAsset, d.Zero, d.Zero, this.timestamp())
-      );
-    }
-  }
-
-  async open(order: Order): Promise<void> {
-    if (!this.engine) {
-      throw noPaperEngineProvidedError();
-    }
-
-    this.engine.open(order);
-  }
-
-  async cancel(order: Order): Promise<void> {
-    if (!this.engine) {
-      throw noPaperEngineProvidedError();
-    }
-
-    this.engine.cancel(order);
-  }
-
-  history(
-    instrument: InstrumentSelector,
-    timeframe: number,
-    length: number
-  ): Promise<Ohlc[]> {
-    return this.decoratedAdapter.history(instrument, timeframe, length);
-  }
-
-  feed(
-    instrument: InstrumentSelector,
-    from: timestamp,
-    to: timestamp,
-    callback: FeedAsyncCallback
-  ): Promise<void> {
-    return this.decoratedAdapter.feed(instrument, from, to, callback);
-  }
-
-  createPaperEngine(adapter: PaperAdapter): PaperEngine {
-    return this.decoratedAdapter.createPaperEngine(adapter);
-  }
-}

package/src/cli/error.ts

@@ -1,5 +0,0 @@
-export function missingDescriptorParameterError(parameterName: string) {
-  return new Error(
-    `please set a "${parameterName}" date in session descriptor or provide the date as parameter.`
-  );
-}