@quantform/core 0.3.229 → 0.3.233

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

@@ -11,7 +11,7 @@ const instrument = new Instrument(
 );
 
 describe('backtester streamer tests', () => {
-  test('should reapeat specific events', done => {
+  test('should repeat specific events', done => {
     const feed = new Feed(new InMemoryStorage());
     const store = new Store();
 

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

@@ -1,7 +1,7 @@
 import { InstrumentSelector } from '../../domain';
 import { BacktesterCursor } from './backtester-cursor';
 import { Store } from '../../store';
-import { timestamp } from '../../common';
+import { timestamp } from '../../shared';
 import { Feed } from '../../storage';
 import { BacktesterOptions } from './backtester-adapter';
 

package/src/adapter/paper/{model/paper-model.ts → executor/paper-executor.ts}

@@ -3,7 +3,7 @@ import { Component, InstrumentSelector, Order, Orderbook, Trade } from '../../..
 import { PaperAdapter } from '..';
 import { Set } from 'typescript-collections';
 
-export abstract class PaperModel {
+export abstract class PaperExecutor {
   private readonly pending: Record<string, Set<Order>> = {};
 
   constructor(readonly adapter: PaperAdapter) {

package/src/adapter/paper/{model/paper-margin-model.ts → executor/paper-margin-executor.ts}

@@ -1,4 +1,4 @@
-import { pnl, weightedMean } from '../../../common';
+import { pnl, weightedMean } from '../../../shared';
 import { Order } from '../../../domain';
 import {
   BalanceTransactEvent,
@@ -10,9 +10,9 @@ import {
   PositionPatchEvent
 } from '../../../store/event';
 import { PaperAdapter } from '..';
-import { PaperModel } from './paper-model';
+import { PaperExecutor } from './paper-executor';
 
-export class PaperMarginModel extends PaperModel {
+export class PaperMarginExecutor extends PaperExecutor {
   leverage = 10;
 
   constructor(adapter: PaperAdapter) {
@@ -31,7 +31,7 @@ export class PaperMarginModel extends PaperModel {
       this.adapter.store.snapshot.universe.instrument[order.instrument.toString()];
 
     let transact = instrument.quote.floor(
-      -instrument.commision.calculateMakerFee(averageExecutionRate * order.quantity)
+      -instrument.commission.calculateMakerFee(averageExecutionRate * order.quantity)
     );
 
     const id = instrument.toString();

package/src/adapter/paper/{model/paper-spot-model.ts → executor/paper-spot-executor.ts}

@@ -10,10 +10,10 @@ import {
   OrderPendingEvent
 } from '../../../store/event';
 import { PaperAdapter } from '..';
-import { PaperModel } from './paper-model';
-import { timestamp } from '../../../common';
+import { PaperExecutor } from './paper-executor';
+import { timestamp } from '../../../shared';
 
-export class PaperSpotModel extends PaperModel {
+export class PaperSpotExecutor extends PaperExecutor {
   constructor(readonly adapter: PaperAdapter) {
     super(adapter);
   }
@@ -39,7 +39,7 @@ export class PaperSpotModel extends PaperModel {
     switch (order.side) {
       case 'BUY':
         transacted.base += instrument.base.floor(
-          instrument.commision.applyMakerFee(order.quantity)
+          instrument.commission.applyMakerFee(order.quantity)
         );
         transacted.quote -= instrument.quote.floor(averageExecutionRate * order.quantity);
         break;
@@ -47,7 +47,7 @@ export class PaperSpotModel extends PaperModel {
       case 'SELL':
         transacted.base -= instrument.base.floor(order.quantity);
         transacted.quote += instrument.quote.floor(
-          instrument.commision.applyMakerFee(averageExecutionRate * order.quantity)
+          instrument.commission.applyMakerFee(averageExecutionRate * order.quantity)
         );
         break;
     }

package/src/adapter/paper/index.ts

@@ -1,3 +1,3 @@
 export * from './paper-adapter';
-export * from './model/paper-spot-model';
-export * from './model/paper-margin-model';
+export * from './executor/paper-spot-executor';
+export * from './executor/paper-margin-executor';

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

@@ -1,7 +1,7 @@
-import { PaperSpotModel } from '.';
+import { PaperSpotExecutor } from '.';
 import { Store } from '../../store';
 import { Adapter } from '../adapter';
-import { PaperModel } from './model/paper-model';
+import { PaperExecutor } from './executor/paper-executor';
 import { PaperAdapter } from './paper-adapter';
 
 class DefaultAdapter extends Adapter {
@@ -11,8 +11,8 @@ class DefaultAdapter extends Adapter {
     return 123;
   }
 
-  createPaperModel(adapter: PaperAdapter): PaperModel {
-    return new PaperSpotModel(adapter);
+  createPaperExecutor(adapter: PaperAdapter): PaperExecutor {
+    return new PaperSpotExecutor(adapter);
   }
 }
 

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

@@ -1,7 +1,7 @@
 import { Adapter, AdapterContext } from '..';
 import { Store } from '../../store';
-import { PaperModel } from './model/paper-model';
-import { handler } from '../../common/topic';
+import { PaperExecutor } from './executor/paper-executor';
+import { handler } from '../../shared/topic';
 import { assetOf } from '../../domain';
 import { BalancePatchEvent } from '../../store/event';
 import {
@@ -16,7 +16,7 @@ export class PaperOptions {
 
 export class PaperAdapter extends Adapter {
   readonly name = this.decoratedAdapter.name;
-  readonly platform: PaperModel;
+  readonly executor: PaperExecutor;
 
   constructor(
     readonly decoratedAdapter: Adapter,
@@ -25,15 +25,15 @@ export class PaperAdapter extends Adapter {
   ) {
     super();
 
-    this.platform = this.createPaperModel(this);
+    this.executor = this.createPaperExecutor(this);
   }
 
   timestamp() {
     return this.decoratedAdapter.timestamp();
   }
 
-  createPaperModel(adapter: PaperAdapter): PaperModel {
-    return this.decoratedAdapter.createPaperModel(adapter);
+  createPaperExecutor(adapter: PaperAdapter): PaperExecutor {
+    return this.decoratedAdapter.createPaperExecutor(adapter);
   }
 
   onUnknownEvent(event: { type: string }, context: AdapterContext) {
@@ -67,14 +67,14 @@ export class PaperAdapter extends Adapter {
 
   @handler(AdapterOrderOpenCommand)
   onOrderOpen(event: AdapterOrderOpenCommand, context: AdapterContext) {
-    this.platform.open(event.order);
+    this.executor.open(event.order);
 
     return Promise.resolve();
   }
 
   @handler(AdapterOrderCancelCommand)
   onOrderCancel(event: AdapterOrderCancelCommand, context: AdapterContext) {
-    this.platform.cancel(event.order);
+    this.executor.cancel(event.order);
 
     return Promise.resolve();
   }

package/src/bin.ts

@@ -3,201 +3,17 @@ import {
   BacktesterOptions,
   BacktesterStreamer
 } from './adapter/backtester';
-import { AdapterAggregate, AdapterFeedCommand } from './adapter';
+import { AdapterAggregate } from './adapter';
 import { PaperAdapter, PaperOptions } from './adapter/paper';
 import { Session, SessionDescriptor } from './session';
 import { Store } from './store';
-import { instrumentOf } from './domain';
-import { Topic, event, handler } from './common/topic';
-import minimist = require('minimist');
-import { Logger } from './common';
-
-export interface IpcCommand {
-  type;
-}
-
-@event
-export class IpcPaperModeCommand implements IpcCommand {
-  type = 'paper';
-  id?: number;
-  balance: { [key: string]: number };
-}
-
-@event
-export class IpcBacktestModeCommand implements IpcCommand {
-  type = 'backtest';
-  from: number;
-  to: number;
-  balance: { [key: string]: number };
-}
-
-@event
-export class IpcLiveModeCommand implements IpcCommand {
-  id?: number;
-  type = 'live';
-}
-
-@event
-export class IpcUniverseQuery implements IpcCommand {
-  type = 'universe';
-  exchange: string;
-}
-
-@event
-export class IpcFeedCommand implements IpcCommand {
-  type = 'feed';
-  instrument: string;
-  from: number;
-  to: number;
-}
-
-class ExecutionAccessor {
-  session: Session;
-}
-
-class ExecutionHandler extends Topic<{ type: string }, ExecutionAccessor> {
-  constructor(private readonly descriptor: SessionDescriptor) {
-    super();
-  }
-
-  @handler(IpcLiveModeCommand)
-  async onLiveMode(command: IpcLiveModeCommand, accessor: ExecutionAccessor) {
-    if (command.id) {
-      this.descriptor.id = command.id;
-    }
-
-    accessor.session = live(this.descriptor);
-
-    await accessor.session.awake();
-  }
-
-  @handler(IpcPaperModeCommand)
-  async onPaperMode(command: IpcPaperModeCommand, accessor: ExecutionAccessor) {
-    if (command.id) {
-      this.descriptor.id = command.id;
-    }
-
-    accessor.session = paper(this.descriptor, {
-      balance: command.balance
-    });
-
-    await accessor.session.awake();
-  }
-
-  @handler(IpcBacktestModeCommand)
-  onBacktestMode(command: IpcBacktestModeCommand, accessor: ExecutionAccessor) {
-    return new Promise<void>(async resolve => {
-      const [session, streamer] = backtest(this.descriptor, {
-        from: command.from,
-        to: command.to,
-        balance: command.balance,
-        progress: timestamp =>
-          this.notify({
-            type: 'backtest:updated',
-            timestamp,
-            from: command.from,
-            to: command.to
-          }),
-        completed: async () => {
-          const statement = {};
-
-          await accessor.session.dispose();
-
-          accessor.session.statement(statement);
-
-          this.notify({ type: 'backtest:completed', statement });
-
-          resolve();
-        }
-      });
-
-      accessor.session = session;
-
-      this.notify({ type: 'backtest:started' });
-
-      await accessor.session.awake();
-      await streamer.tryContinue().catch(it => Logger.error(it));
-    });
-  }
-
-  @handler(IpcUniverseQuery)
-  onUniverse(query: IpcUniverseQuery, accessor: ExecutionAccessor) {
-    accessor.session = accessor.session ?? idle(this.descriptor);
-  }
-
-  @handler(IpcFeedCommand)
-  async onFeed(command: IpcFeedCommand, accessor: ExecutionAccessor) {
-    accessor.session = accessor.session ?? idle(this.descriptor);
-    const instrument = instrumentOf(command.instrument);
-
-    await accessor.session.awake();
-
-    this.notify({ type: 'feed:started' });
-
-    await accessor.session.aggregate.dispatch(
-      instrument.base.exchange,
-      new AdapterFeedCommand(
-        instrument,
-        command.from,
-        command.to,
-        this.descriptor.feed,
-        timestamp =>
-          this.notify({
-            type: 'feed:updated',
-            timestamp,
-            from: command.from,
-            to: command.to
-          })
-      )
-    );
-
-    this.notify({ type: 'feed:completed' });
-
-    await accessor.session.dispose();
-  }
-
-  private notify(message: any) {
-    if (!process.send) {
-      return;
-    }
-
-    process.send(message);
-  }
-}
-
-export async function run(
-  descriptor: SessionDescriptor,
-  ...commands: IpcCommand[]
-): Promise<Session> {
-  const handler = new ExecutionHandler(descriptor);
-  const accessor = new ExecutionAccessor();
-  const argv = minimist(process.argv.slice(2));
-
-  if (argv.command) {
-    const json = Buffer.from(argv.command, 'base64').toString('utf-8');
-
-    commands.push(JSON.parse(json));
-  } else {
-    if (!commands.length) {
-      commands.push(new IpcPaperModeCommand());
-    }
-  }
-
-  for (const command of commands) {
-    await handler.dispatch(command, accessor);
-  }
-
-  process.on('message', async (request: any) => {
-    const response = await handler.dispatch(request, accessor);
-
-    if (response) {
-      process.send(response);
-    }
-  });
-
-  return accessor.session;
-}
 
+/**
+ * Starts a new backtest session.
+ * @param descriptor session descriptor.
+ * @param options backtest options.
+ * @returns new session object.
+ */
 export function backtest(
   descriptor: SessionDescriptor,
   options: BacktesterOptions
@@ -215,6 +31,12 @@ export function backtest(
   return [new Session(store, aggregate, descriptor), streamer];
 }
 
+/**
+ * Starts a new paper session.
+ * @param descriptor session descriptor.
+ * @param options backtest options.
+ * @returns new session object.
+ */
 export function paper(descriptor: SessionDescriptor, options: PaperOptions): Session {
   const store = new Store();
 
@@ -226,6 +48,11 @@ export function paper(descriptor: SessionDescriptor, options: PaperOptions): Ses
   return new Session(store, aggregate, descriptor);
 }
 
+/**
+ * Starts a new live session.
+ * @param descriptor session descriptor.
+ * @returns new session object.
+ */
 export function live(descriptor: SessionDescriptor): Session {
   const store = new Store();
   const aggregate = new AdapterAggregate(store, descriptor.adapter);
@@ -233,6 +60,10 @@ export function live(descriptor: SessionDescriptor): Session {
   return new Session(store, aggregate, descriptor);
 }
 
+/**
+ * Starts a new idle session.
+ * @param descriptor session descriptor.
+ */
 export function idle(descriptor: SessionDescriptor): Session {
   const store = new Store();
   const aggregate = new AdapterAggregate(store, descriptor.adapter);

package/src/domain/asset.ts

@@ -1,7 +1,7 @@
-import { ceil, fixed, floor } from '../common/decimals';
+import { ceil, fixed, floor } from '../shared/decimals';
 
 /**
- * Supposed to query specific @see Asset from code based.
+ * Supposed to query specific @see Asset from based on string notation.
  */
 export class AssetSelector {
   private readonly id: string;
@@ -58,21 +58,21 @@ export class Asset extends AssetSelector {
   }
 
   /**
-   * Trims a number to the specified precision.
+   * Trims a number to the asset precision.
    */
   fixed(number: number): number {
     return fixed(number, this.scale);
   }
 
   /**
-   * Rounds down a number to the specified precision.
+   * Rounds down a number to the asset precision.
    */
   floor(number: number): number {
     return floor(number, this.scale);
   }
 
   /**
-   * Rounds up a number to the specified precision.
+   * Rounds up a number to the asset precision.
    */
   ceil(number: number): number {
     return ceil(number, this.scale);

package/src/domain/balance.ts

@@ -1,10 +1,10 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 import { Asset } from './';
 import { Position, PositionMode } from './position';
 import { Component } from './component';
 
 /**
- * Represents single asset abalance in your wallet.
+ * Represents single asset balance in your wallet.
  */
 export class Balance implements Component {
   timestamp: timestamp;
@@ -38,9 +38,7 @@ export class Balance implements Component {
    */
   get total(): number {
     return (
-      this._free +
-      this._freezed +
-      this.getEstimatedUnrealizedPnL() /* +
+      this._free + this._freezed + this.getEstimatedUnrealizedPnL() /* +
       this.getEstimatedMaintenanceMargin()*/
     );
   }

package/src/domain/candle-builder.ts

@@ -8,7 +8,7 @@ import {
   skipLast,
   withLatestFrom
 } from 'rxjs/operators';
-import { timestamp, toString } from '../common';
+import { timestamp, toString } from '../shared';
 import { Candle } from './candle';
 import { tf } from './timeframe';
 

package/src/domain/candle.spec.ts

@@ -1,7 +1,7 @@
 import { from } from 'rxjs';
 import { map } from 'rxjs/operators';
 import { TradePatchEvent } from '../store/event';
-import { now } from '../common';
+import { now } from '../shared';
 import { Candle } from './candle';
 import { mergeCandle } from './candle-builder';
 import { instrumentOf } from './instrument';

package/src/domain/candle.ts

@@ -1,4 +1,4 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 
 export class Candle {
   constructor(

package/src/domain/{commision.ts → commission.ts}

@@ -1,4 +1,4 @@
-export class Commision {
+export class Commission {
   constructor(readonly makerRate: number, readonly takerRate: number) {}
 
   calculateMakerFee(value: number) {
@@ -18,6 +18,6 @@ export class Commision {
   }
 }
 
-export function commisionPercentOf(maker: number, taker: number) {
-  return new Commision(maker / 100.0, taker / 100.0);
+export function commissionPercentOf(maker: number, taker: number) {
+  return new Commission(maker / 100.0, taker / 100.0);
 }

package/src/domain/component.ts

@@ -1,4 +1,4 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 
 export interface Component {
   timestamp: timestamp;

package/src/domain/index.ts

@@ -3,7 +3,7 @@ export * from './instrument';
 export * from './balance';
 export * from './order';
 export * from './orderbook';
-export * from './commision';
+export * from './commission';
 export * from './component';
 export * from './candle';
 export * from './candle-builder';

package/src/domain/instrument.ts

@@ -1,6 +1,6 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 import { Asset, AssetSelector } from './asset';
-import { Commision } from './commision';
+import { Commission } from './commission';
 import { Component } from './component';
 
 export class InstrumentSelector {
@@ -21,9 +21,12 @@ export class InstrumentSelector {
   }
 }
 
+/**
+ * Represents trading market which is made up by two trading assets (base and quoted).
+ */
 export class Instrument extends InstrumentSelector implements Component {
   timestamp: timestamp;
-  commision: Commision;
+  commission: Commission;
   cross: Instrument;
   leverage?: number = null;
 

package/src/domain/order.ts

@@ -1,7 +1,7 @@
 import { Component } from './component';
 import { v4 } from 'uuid';
 import { InstrumentSelector } from './instrument';
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 
 export type OrderSide = 'SELL' | 'BUY';
 export type OrderType = 'MARKET' | 'LIMIT' | 'STOP-MARKET' | 'STOP-LIMIT';

package/src/domain/orderbook.ts

@@ -1,14 +1,17 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 import { Instrument } from '../domain';
 import { Component } from './component';
 
+/**
+ * Provides an access to pending buy and sell orders on the specific market.
+ */
 export class Orderbook implements Component {
   timestamp: timestamp;
   bestAskRate: number;
   bestAskQuantity: number;
   bestBidRate: number;
   bestBidQuantity: number;
-
+  az;
   get midRate(): number {
     return this.instrument.quote.fixed((this.bestAskRate + this.bestBidRate) / 2);
   }

package/src/domain/position.ts

@@ -1,6 +1,6 @@
 import { Instrument } from '../domain';
 import { Component } from './component';
-import { pnl, timestamp, weightedMean } from '../common';
+import { pnl, timestamp, weightedMean } from '../shared';
 import { Observable } from 'rxjs';
 import { map, share } from 'rxjs/operators';
 
@@ -34,7 +34,7 @@ export class Position implements Component {
 }
 
 export function positionsFlat() {
-  return function(
+  return function (
     source: Observable<Position[]>
   ): Observable<{ size: number; rate: number }> {
     return source.pipe(

package/src/domain/trade.ts

@@ -1,7 +1,11 @@
-import { timestamp } from '../common';
+import { timestamp } from '../shared';
 import { Instrument } from '.';
 import { Component } from './component';
 
+/**
+ * Simple trade or ticker executed on the market, it's a match of buyer
+ * and seller of the same asset.
+ */
 export class Trade implements Component {
   timestamp: timestamp;
   rate: number;

package/src/index.ts

@@ -1,17 +1,12 @@
-export * from './behaviour';
-export * from './common';
-
+export * from './shared';
 export * from './domain';
-
 export * from './adapter';
 export * from './adapter/backtester';
 export * from './adapter/paper';
-
 export * from './indicator';
 export * from './session';
 export * from './storage';
-
 export * from './store';
 export * from './store/event';
-
 export * from './bin';
+export * from './ipc';

package/src/indicator/truerange.spec.ts

@@ -2,7 +2,7 @@ import { from } from 'rxjs';
 import { Candle } from '../domain';
 import { truerange } from './truerange';
 import { sma } from './sma';
-import { now } from '../common';
+import { now } from '../shared';
 
 describe('truerange atr tests', () => {
   test('should return expected value', done => {