Dependabot

.eslintrc

@@ -1,24 +1,46 @@
 {
   "root": true,
-  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2021
   },
-  "plugins": [
-    "@typescript-eslint",
-    "prettier"
-  ],
   "extends": [
     "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:promise/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
     "plugin:@typescript-eslint/recommended",
-    "prettier"
+    // must be the last extension
+    "plugin:prettier/recommended"
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true
+      }
+    }
+  },
+  "overrides": [
+    {
+      "files": [
+        ".ts"
+      ],
+      "parserOptions": {
+        "project": "./tsconfig.json"
+      }
+    }
   ],
   "rules": {
     "no-console": "error",
-    "prettier/prettier": "error",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-empty-interface": "off",
+    "import/order": [
+      "error",
+      {
+        "newlines-between": "always",
+        "alphabetize": {
+          "order": "asc",
+          "caseInsensitive": true
+        }
+      }
+    ],
     "@typescript-eslint/explicit-function-return-type": [
       "error",
       {

.github/dependabot.yml

@@ -5,4 +5,4 @@ updates:
     directory: /
     target-branch: dependabot
     schedule:
-      interval: weekly
+      interval: monthly

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint

package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/hastobegood/crypto-bot-artillery.git"
   },
   "engines": {
-    "node": "^14"
+    "node": "14"
   },
   "type": "module",
   "main": "lib/cjs/src/index.js",
@@ -62,6 +62,7 @@
     }
   },
   "scripts": {
+    "prepare": "yarn husky install",
     "clean": "rm -rf out lib reports",
     "build": "yarn build:esm && yarn build:cjs",
     "build:esm": "yarn tsc",
@@ -73,21 +74,25 @@
     "lint:report": "yarn eslint . --ext .ts --format json -o reports/eslint-report.json "
   },
   "dependencies": {
-    "@hastobegood/crypto-clients-binance": "^0.7.0",
+    "@hastobegood/crypto-clients-binance": "^0.8.0",
     "joi": "^17.6.0",
     "pino": "^7.10.0"
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",
-    "@types/lodash": "^4.14.181",
-    "@types/node": "14.x",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "14",
     "@types/pino": "^7.0.5",
     "@types/randomstring": "^1.1.8",
-    "@typescript-eslint/eslint-plugin": "^5.18.0",
-    "@typescript-eslint/parser": "^5.18.0",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^2.7.1",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "husky": "^7.0.4",
     "jest": "^27.5.1",
     "jest-sonar-reporter": "^2.0.0",
     "lodash": "^4.17.21",

src/artillery.ts

@@ -1,6 +1,7 @@
-import { logger } from './common/log/logger.js';
 import { ApiInfoProvider, Client } from '@hastobegood/crypto-clients-binance';
+
 import { ExchangesClients } from './common/exchanges/clients.js';
+import { logger } from './common/log/logger.js';
 
 export interface ArtilleryOptions {
   binanceApiInfoProvider?: ApiInfoProvider;

src/candlestick/artillery.ts

@@ -1,9 +1,10 @@
 import { ExchangesClients } from '../common/exchanges/clients.js';
+
+import { CandlestickClient } from './domain/candlestick-client.js';
+import { FetchCandlestickClient } from './domain/fetch-candlestick-client.js';
 import { BinanceCandlestickClient } from './infrastructure/exchanges/binance/binance-candlestick-client.js';
 import { ExchangeCandlestickClient } from './infrastructure/exchanges/exchange-candlestick-client.js';
 import { HttpCandlestickClient } from './infrastructure/http-candlestick-client.js';
-import { CandlestickClient } from './domain/candlestick-client.js';
-import { FetchCandlestickClient } from './domain/fetch-candlestick-client.js';
 
 let candlestickClient: CandlestickClient;
 

src/candlestick/domain/fetch-candlestick-client.ts

@@ -1,5 +1,5 @@
-import { Candlesticks, FetchAllCandlesticks } from './model/candlestick.js';
 import { CandlestickClient } from './candlestick-client.js';
+import { Candlesticks, FetchAllCandlesticks } from './model/candlestick.js';
 
 export class FetchCandlestickClient {
   constructor(private candlestickClient: CandlestickClient) {}

src/candlestick/infrastructure/exchanges/binance/binance-candlestick-client.ts

@@ -1,7 +1,8 @@
-import { toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
-import { ExchangeCandlestickClient } from '../exchange-candlestick-client.js';
 import { Client, GetCandlestickDataCommand, GetCandlestickDataInput } from '@hastobegood/crypto-clients-binance';
+
 import { CandlestickExchange, Candlesticks, FetchAllCandlesticks } from '../../../../candlestick/domain/model/candlestick.js';
+import { toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
+import { ExchangeCandlestickClient } from '../exchange-candlestick-client.js';
 
 export class BinanceCandlestickClient implements ExchangeCandlestickClient {
   constructor(private client: Client) {}

src/candlestick/infrastructure/http-candlestick-client.ts

@@ -1,7 +1,8 @@
 import { CandlestickClient } from '../domain/candlestick-client.js';
-import { ExchangeCandlestickClient } from './exchanges/exchange-candlestick-client.js';
 import { CandlestickExchange, Candlesticks, FetchAllCandlesticks } from '../domain/model/candlestick.js';
 
+import { ExchangeCandlestickClient } from './exchanges/exchange-candlestick-client.js';
+
 export class HttpCandlestickClient implements CandlestickClient {
   constructor(private exchangeCandlestickClients: ExchangeCandlestickClient[]) {}
 

src/common/exchanges/binance/binance-converter.ts

@@ -1,6 +1,7 @@
-import { extractAssets } from '../../util/symbol.js';
 import { OrderSide as BinanceOrderSide, OrderStatus as BinanceOrderStatus, OrderType as BinanceOrderType } from '@hastobegood/crypto-clients-binance';
+
 import { OrderSide, OrderStatus, OrderType } from '../../../order/domain/model/order.js';
+import { extractAssets } from '../../util/symbol.js';
 
 export const toBinanceSymbol = (symbol: string): string => {
   const assets = extractAssets(symbol);

src/common/log/logger.ts

@@ -1,8 +1,8 @@
-import pino from 'pino';
+import { pino, stdTimeFunctions } from 'pino';
 
 const defaultLogger = pino({
   level: process.env.LOG_LEVEL,
-  timestamp: pino.stdTimeFunctions.isoTime,
+  timestamp: stdTimeFunctions.isoTime,
   messageKey: 'message',
   nestedKey: 'data',
   base: null,

src/order/artillery.ts

@@ -1,11 +1,12 @@
 import { ExchangesClients } from '../common/exchanges/clients.js';
 import { FetchTickerClient } from '../ticker/domain/fetch-ticker-client.js';
+
+import { CheckOrderClient } from './domain/check-order-client.js';
+import { OrderClient } from './domain/order-client.js';
+import { SendOrderClient } from './domain/send-order-client.js';
 import { BinanceOrderClient } from './infrastructure/exchanges/binance/binance-order-client.js';
 import { ExchangeOrderClient } from './infrastructure/exchanges/exchange-order-client.js';
 import { HttpOrderClient } from './infrastructure/http-order-client.js';
-import { OrderClient } from './domain/order-client.js';
-import { SendOrderClient } from './domain/send-order-client.js';
-import { CheckOrderClient } from './domain/check-order-client.js';
 
 let orderClient: OrderClient;
 

src/order/domain/send-order-client.ts

@@ -1,7 +1,9 @@
 import { randomUUID } from 'crypto';
+
 import { truncateNumber } from '../../common/util/math.js';
 import { FetchTickerClient } from '../../ticker/domain/fetch-ticker-client.js';
 import { Ticker } from '../../ticker/domain/model/ticker.js';
+
 import { Order, SendOrder, TransientOrder } from './model/order.js';
 import { OrderClient } from './order-client.js';
 

src/order/infrastructure/exchanges/binance/binance-order-client.ts

@@ -1,9 +1,10 @@
+import { Client, GetAccountTradesListCommand, GetAccountTradesListInput, GetOrderCommand, GetOrderInput, GetOrderOutput, SendOrderCommand, SendOrderInput, SendOrderOutput } from '@hastobegood/crypto-clients-binance';
+
+import { fromBinanceOrderStatus, toBinanceOrderSide, toBinanceOrderType, toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
 import { roundNumber } from '../../../../common/util/math.js';
 import { extractAssets } from '../../../../common/util/symbol.js';
-import { fromBinanceOrderStatus, toBinanceOrderSide, toBinanceOrderType, toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
-import { ExchangeOrderClient } from '../exchange-order-client.js';
-import { Client, GetAccountTradesListCommand, GetAccountTradesListInput, GetOrderCommand, GetOrderInput, GetOrderOutput, SendOrderCommand, SendOrderInput, SendOrderOutput } from '@hastobegood/crypto-clients-binance';
 import { CheckOrder, Order, OrderCheckup, OrderExchange, TransientOrder } from '../../../../order/domain/model/order.js';
+import { ExchangeOrderClient } from '../exchange-order-client.js';
 
 export class BinanceOrderClient implements ExchangeOrderClient {
   constructor(private client: Client) {}

src/order/infrastructure/http-order-client.ts

@@ -1,6 +1,7 @@
+import { CheckOrder, Order, OrderCheckup, OrderExchange, TransientOrder } from '../domain/model/order.js';
 import { OrderClient } from '../domain/order-client.js';
+
 import { ExchangeOrderClient } from './exchanges/exchange-order-client.js';
-import { CheckOrder, Order, OrderCheckup, OrderExchange, TransientOrder } from '../domain/model/order.js';
 
 export class HttpOrderClient implements OrderClient {
   constructor(private exchangeOrderClients: ExchangeOrderClient[]) {}

src/ticker/artillery.ts

@@ -1,9 +1,10 @@
 import { ExchangesClients } from '../common/exchanges/clients.js';
+
+import { FetchTickerClient } from './domain/fetch-ticker-client.js';
+import { TickerClient } from './domain/ticker-client.js';
 import { BinanceTickerClient } from './infrastructure/exchanges/binance/binance-ticker-client.js';
 import { ExchangeTickerClient } from './infrastructure/exchanges/exchange-ticker-client.js';
 import { HttpTickerClient } from './infrastructure/http-ticker-client.js';
-import { TickerClient } from './domain/ticker-client.js';
-import { FetchTickerClient } from './domain/fetch-ticker-client.js';
 
 let tickerClient: TickerClient;
 

src/ticker/infrastructure/exchanges/binance/binance-ticker-client.ts

@@ -1,7 +1,8 @@
-import { toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
-import { ExchangeTickerClient } from '../exchange-ticker-client.js';
 import { Client, GetExchangeInfoCommand, GetExchangeInfoInput, GetExchangeInfoOutputSymbol, GetExchangeInfoOutputSymbolFilter } from '@hastobegood/crypto-clients-binance';
+
+import { toBinanceSymbol } from '../../../../common/exchanges/binance/binance-converter.js';
 import { FetchTicker, Ticker, TickerExchange } from '../../../../ticker/domain/model/ticker.js';
+import { ExchangeTickerClient } from '../exchange-ticker-client.js';
 
 export class BinanceTickerClient implements ExchangeTickerClient {
   constructor(private client: Client) {}

src/ticker/infrastructure/http-ticker-client.ts

@@ -1,6 +1,7 @@
+import { FetchTicker, Ticker, TickerExchange } from '../domain/model/ticker.js';
 import { TickerClient } from '../domain/ticker-client.js';
+
 import { ExchangeTickerClient } from './exchanges/exchange-ticker-client.js';
-import { FetchTicker, Ticker, TickerExchange } from '../domain/model/ticker.js';
 
 export class HttpTickerClient implements TickerClient {
   constructor(private exchangeTickerClients: ExchangeTickerClient[]) {}

test/builders/candlestick/domain/candlestick-test-builder.ts

@@ -1,5 +1,5 @@
-import { randomFromList, randomNumber, randomSymbol } from '../../random-test-builder.js';
 import { Candlestick, Candlesticks, FetchAllCandlesticks } from '../../../../src/candlestick/domain/model/candlestick.js';
+import { randomFromList, randomNumber, randomSymbol } from '../../random-test-builder.js';
 
 export const buildDefaultFetchAllCandlesticks = (): FetchAllCandlesticks => {
   return {

test/builders/candlestick/infrastructure/exchanges/binance/binance-candlestick-test-builder.ts

@@ -1,6 +1,7 @@
-import { randomNumber } from '../../../../random-test-builder.js';
 import { GetCandlestickDataOutput } from '@hastobegood/crypto-clients-binance';
 
+import { randomNumber } from '../../../../random-test-builder.js';
+
 export const buildDefaultBinanceGetCandlestickDataOutput = (): GetCandlestickDataOutput => {
   return [1, 2, 3, 4, 5].map(() => [
     new Date().valueOf(),

test/builders/order/domain/order-test-builder.ts

@@ -1,5 +1,5 @@
-import { randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../random-test-builder.js';
 import { CheckOrder, Order, OrderCheckup, SendOrder, TransientOrder } from '../../../../src/order/domain/model/order.js';
+import { randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../random-test-builder.js';
 
 export const buildDefaultTransientOrder = (): TransientOrder => {
   return buildDefaultTransientMarketOrder();

test/builders/order/infrastructure/exchanges/binance/binance-order-test-builder.ts

@@ -1,6 +1,7 @@
-import { randomAsset, randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../../../random-test-builder.js';
 import { GetAccountTradesListOutput, GetAccountTradesListOutputSymbol, GetOrderOutput, SendOrderOutput, SendOrderOutputFill } from '@hastobegood/crypto-clients-binance';
 
+import { randomAsset, randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../../../random-test-builder.js';
+
 export const buildDefaultBinanceSendOrderOutput = (): SendOrderOutput => {
   return {
     symbol: randomSymbol(),

test/builders/random-test-builder.ts

@@ -1,5 +1,5 @@
-import { generate } from 'randomstring';
 import { sample } from 'lodash';
+import { generate } from 'randomstring';
 
 export const randomString = (): string => {
   return generate({ length: 10, charset: 'alphanumeric' });

test/builders/ticker/domain/ticker-test-builder.ts

@@ -1,5 +1,5 @@
-import { randomFromList, randomNumber, randomSymbol } from '../../random-test-builder.js';
 import { FetchTicker, Ticker } from '../../../../src/ticker/domain/model/ticker.js';
+import { randomFromList, randomNumber, randomSymbol } from '../../random-test-builder.js';
 
 export const buildDefaultFetchTicker = (): FetchTicker => {
   return {

test/builders/ticker/infrastructure/exchanges/binance/binance-ticker-test-builder.ts

@@ -1,6 +1,7 @@
-import { randomAsset, randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../../../random-test-builder.js';
 import { GetExchangeInfoOutput, GetExchangeInfoOutputRateLimit, GetExchangeInfoOutputSymbol, GetExchangeInfoOutputSymbolFilter } from '@hastobegood/crypto-clients-binance';
 
+import { randomAsset, randomBoolean, randomFromList, randomNumber, randomString, randomSymbol } from '../../../../random-test-builder.js';
+
 export const buildDefaultBinanceGetExchangeInfoOutput = (): GetExchangeInfoOutput => {
   return {
     timezone: 'UTC',

test/unit/artillery.test.ts

@@ -1,4 +1,5 @@
 import { ApiInfoProvider, Client } from '@hastobegood/crypto-clients-binance';
+
 import { ArtilleryOptions, loadExchangesClients } from '../../src/artillery.js';
 
 describe('Artillery', () => {

test/unit/candlestick/artillery.test.ts

@@ -1,7 +1,8 @@
 import { Client } from '@hastobegood/crypto-clients-binance';
-import { ExchangesClients } from '../../../src/common/exchanges/clients.js';
-import { FetchCandlestickClient } from '../../../src/candlestick/domain/fetch-candlestick-client.js';
+
 import { loadFetchCandlestickClient } from '../../../src/candlestick/artillery.js';
+import { FetchCandlestickClient } from '../../../src/candlestick/domain/fetch-candlestick-client.js';
+import { ExchangesClients } from '../../../src/common/exchanges/clients.js';
 
 describe('Artillery', () => {
   describe('Given exchanges clients', () => {

test/unit/candlestick/infrastructure/exchanges/binance/binance-candlestick-client.test.ts

@@ -1,8 +1,9 @@
-import { toBinanceSymbol } from '../../../../../../src/common/exchanges/binance/binance-converter.js';
-import { FetchAllCandlesticks } from '../../../../../../src/candlestick/domain/model/candlestick.js';
-import { buildDefaultFetchAllCandlesticks } from '../../../../../builders/candlestick/domain/candlestick-test-builder.js';
 import { Client, GetCandlestickDataOutput } from '@hastobegood/crypto-clients-binance';
+
+import { FetchAllCandlesticks } from '../../../../../../src/candlestick/domain/model/candlestick.js';
 import { BinanceCandlestickClient } from '../../../../../../src/candlestick/infrastructure/exchanges/binance/binance-candlestick-client.js';
+import { toBinanceSymbol } from '../../../../../../src/common/exchanges/binance/binance-converter.js';
+import { buildDefaultFetchAllCandlesticks } from '../../../../../builders/candlestick/domain/candlestick-test-builder.js';
 import { buildDefaultBinanceGetCandlestickDataOutput } from '../../../../../builders/candlestick/infrastructure/exchanges/binance/binance-candlestick-test-builder.js';
 
 const clientMock = jest.mocked(jest.genMockFromModule<Client>('@hastobegood/crypto-clients-binance'), true);

test/unit/candlestick/infrastructure/http-candlestick-client.test.ts

@@ -1,6 +1,6 @@
+import { CandlestickExchange, Candlesticks, FetchAllCandlesticks } from '../../../../src/candlestick/domain/model/candlestick.js';
 import { BinanceCandlestickClient } from '../../../../src/candlestick/infrastructure/exchanges/binance/binance-candlestick-client.js';
 import { HttpCandlestickClient } from '../../../../src/candlestick/infrastructure/http-candlestick-client.js';
-import { CandlestickExchange, Candlesticks, FetchAllCandlesticks } from '../../../../src/candlestick/domain/model/candlestick.js';
 import { buildDefaultCandlesticks, buildDefaultFetchAllCandlesticks } from '../../../builders/candlestick/domain/candlestick-test-builder.js';
 
 const binanceCandlestickClientMock = jest.mocked(jest.genMockFromModule<BinanceCandlestickClient>('../../../../src/candlestick/infrastructure/exchanges/binance/binance-candlestick-client.js'), true);

test/unit/common/exchanges/binance/binance-converter.test.ts

@@ -1,5 +1,6 @@
+import { OrderStatus as BinanceOrderStatus } from '@hastobegood/crypto-clients-binance';
+
 import { fromBinanceOrderStatus, toBinanceOrderSide, toBinanceOrderType, toBinanceSymbol } from '../../../../../src/common/exchanges/binance/binance-converter.js';
-import { OrderStatus as BinanceOrderStatus } from '@hastobegood/crypto-clients-binance/order';
 import { OrderSide, OrderType } from '../../../../../src/order/domain/model/order.js';
 
 describe('BinanceConverter', () => {

test/unit/order/artillery.test.ts

@@ -1,10 +1,11 @@
 import { Client } from '@hastobegood/crypto-clients-binance';
+
 import { ExchangesClients } from '../../../src/common/exchanges/clients.js';
-import { HttpTickerClient } from '../../../src/ticker/infrastructure/http-ticker-client.js';
-import { FetchTickerClient } from '../../../src/ticker/domain/fetch-ticker-client.js';
-import { SendOrderClient } from '../../../src/order/domain/send-order-client.js';
-import { CheckOrderClient } from '../../../src/order/domain/check-order-client.js';
 import { loadCheckOrderClient, loadSendOrderClient } from '../../../src/order/artillery.js';
+import { CheckOrderClient } from '../../../src/order/domain/check-order-client.js';
+import { SendOrderClient } from '../../../src/order/domain/send-order-client.js';
+import { FetchTickerClient } from '../../../src/ticker/domain/fetch-ticker-client.js';
+import { HttpTickerClient } from '../../../src/ticker/infrastructure/http-ticker-client.js';
 
 describe('Artillery', () => {
   describe('Given exchanges clients', () => {

test/unit/order/domain/check-order-client.test.ts

@@ -1,6 +1,6 @@
-import { OrderClient } from '../../../../src/order/domain/order-client.js';
 import { CheckOrderClient } from '../../../../src/order/domain/check-order-client.js';
 import { CheckOrder, OrderCheckup } from '../../../../src/order/domain/model/order.js';
+import { OrderClient } from '../../../../src/order/domain/order-client.js';
 import { buildDefaultCheckOrder, buildDefaultOrderCheckup } from '../../../builders/order/domain/order-test-builder.js';
 
 const orderClientMock = jest.mocked(jest.genMockFromModule<OrderClient>('../../../../src/order/domain/order-client.js'), true);