Feature - Revamp Okx

.alunarc

@@ -19,5 +19,9 @@ VALR_API_SECRET=
 GATE_API_KEY=
 GATE_API_SECRET=
 
+OKX_API_KEY=
+OKX_API_SECRET=
+OKX_API_PASSPHRASE=
+
 FTX_API_KEY=
 FTX_API_SECRET=

.playground/aluna-spec.json

@@ -1,8 +1,8 @@
 {
     "_type": "export",
     "__export_format": 4,
-    "__export_date": "2022-05-19T15:38:33.998Z",
-    "__export_source": "insomnia.desktop.app:v2022.2.1",
+    "__export_date": "2022-05-20T15:20:36.520Z",
+    "__export_source": "insomnia.desktop.app:v2022.3.0",
     "resources": [
         {
             "_id": "req_638f9118078540b8a309cfcf9a6189ee",
@@ -149,7 +149,7 @@
         {
             "_id": "req_f44dbbbcceb3496da709be542a08706b",
             "parentId": "fld_51ff43abd0e041e7a35891223e170a16",
-            "modified": 1652316606203,
+            "modified": 1653053386793,
             "created": 1651252489507,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "listRaw",
@@ -453,7 +453,7 @@
         {
             "_id": "req_b3c64285e4b84d6da77a0046f8224ab3",
             "parentId": "fld_f3ad5c457d5b4433a90c91d2d9963d18",
-            "modified": 1652632762679,
+            "modified": 1653053366612,
             "created": 1651251269522,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "fetchDetails",
@@ -509,7 +509,7 @@
         {
             "_id": "req_e147340c7ecd4eb785265d1b060ff2a6",
             "parentId": "fld_404131e490e9469898d0a610690c9775",
-            "modified": 1652632757871,
+            "modified": 1653053200021,
             "created": 1652142980199,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "getTradableBalance",
@@ -553,7 +553,7 @@
         {
             "_id": "req_f17e55c1a50f477aa3747ee7a7b497ca",
             "parentId": "fld_404131e490e9469898d0a610690c9775",
-            "modified": 1652632759741,
+            "modified": 1653056431259,
             "created": 1651516666747,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "listRaw",
@@ -585,7 +585,7 @@
         {
             "_id": "req_bdd09e4f5a9b4e3a87ecb690dfa739c9",
             "parentId": "fld_404131e490e9469898d0a610690c9775",
-            "modified": 1652632760923,
+            "modified": 1653053355581,
             "created": 1651505463599,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "list",
@@ -617,7 +617,7 @@
         {
             "_id": "req_db9088aa9fcf45b18e85ddd994aa99c1",
             "parentId": "fld_1eb1fdf26dfd46298cacc08fd05b469e",
-            "modified": 1652632764897,
+            "modified": 1653053390709,
             "created": 1651505373653,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "listRaw",
@@ -757,7 +757,7 @@
         {
             "_id": "req_0fe5c5ec55604eb48a47233c69fe1ee4",
             "parentId": "fld_1eb1fdf26dfd46298cacc08fd05b469e",
-            "modified": 1652974669549,
+            "modified": 1653060021597,
             "created": 1651595326974,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "place:limit",
@@ -789,7 +789,7 @@
         {
             "_id": "req_8cc2810f054d4681914645b0e9324e2b",
             "parentId": "fld_1eb1fdf26dfd46298cacc08fd05b469e",
-            "modified": 1652974668889,
+            "modified": 1653060015308,
             "created": 1651597897328,
             "url": "{{ _.PLAYGROUND_URL }}/exchanges",
             "name": "place:market",
@@ -1410,6 +1410,38 @@
             "metaSortKey": 7,
             "_type": "environment"
         },
+        {
+            "_id": "env_5120e1e15b634398bb1ca97c3b48b386",
+            "parentId": "env_0294ce45850974a6280b61215be346094da99682",
+            "modified": 1653060020939,
+            "created": 1653009615092,
+            "name": "Okx",
+            "data": {
+                "EXCHANGE_ID": "okx",
+                "KEY": "{% dotenv _.ALUNAJS_RC, 'OKX_API_KEY' %}",
+                "SECRET": "{% dotenv _.ALUNAJS_RC, 'OKX_API_SECRET' %}",
+                "PASSPHRASE": "{% dotenv _.ALUNAJS_RC, 'OKX_API_PASSPHRASE' %}",
+                "ORDER_SYMBOL_PAIR": "BTC-USDT",
+                "ORDER_RATE": 1000,
+                "ORDER_AMOUNT": 0.001,
+                "ORDER_EDITED_AMOUNT": 0.0011
+            },
+            "dataPropertyOrder": {
+                "&": [
+                    "EXCHANGE_ID",
+                    "KEY",
+                    "SECRET",
+                    "PASSPHRASE",
+                    "ORDER_SYMBOL_PAIR",
+                    "ORDER_RATE",
+                    "ORDER_AMOUNT",
+                    "ORDER_EDITED_AMOUNT"
+                ]
+            },
+            "color": "#0929aa",
+            "isPrivate": false,
+            "metaSortKey": 1653009615092
+        },
         {
             "_id": "env_e524d6c1fb6247348832a850cae3e36d",
             "parentId": "env_0294ce45850974a6280b61215be346094da99682",

docs/exchanges-table.md

@@ -21,4 +21,5 @@ Full list of currently supported exchanges.
 |Gate|✅ v4|❌|❌|
 |Poloniex|✅ v1|—|—|
 |Valr|✅ v1|—|—|
+|Okx|✅ v5|❌|❌|
 |Ftx|✅ v1|❌|❌|

src/aluna.spec.ts

@@ -20,7 +20,7 @@ describe(__filename, () => {
 
     const exchangeIds = Object.keys(exchanges)
 
-    expect(exchangeIds.length).to.eq(8)
+    expect(exchangeIds.length).to.eq(9)
 
     each(exchangeIds, (exchangeId) => {
 
@@ -51,7 +51,7 @@ describe(__filename, () => {
 
     const exchangeIds = Object.keys(exchanges)
 
-    expect(exchangeIds.length).to.eq(8)
+    expect(exchangeIds.length).to.eq(9)
 
     each(exchangeIds, (exchangeId) => {
 

src/exchanges/binance/modules/authed/order/parse.spec.ts

@@ -1,5 +1,6 @@
 import { expect } from 'chai'
 import { cloneDeep } from 'lodash'
+import { ImportMock } from 'ts-mock-imports'
 
 import { AlunaAccountEnum } from '../../../../../lib/enums/AlunaAccountEnum'
 import { IAlunaCredentialsSchema } from '../../../../../lib/schemas/IAlunaCredentialsSchema'
@@ -181,15 +182,20 @@ describe(__filename, () => {
       symbol,
       type,
       status,
-      updateTime,
     } = rawOrder
 
-    const updatedAt = new Date(updateTime!)
-
     const exchange = new BinanceAuthed({ credentials })
 
+    const timestamp = new Date()
+
     // mocking
 
+    ImportMock.mockFunction(
+      global,
+      'Date',
+      timestamp,
+    )
+
     const { translateSymbolId } = mockTranslateSymbolId()
 
     translateSymbolId.onFirstCall().returns(baseAsset)
@@ -214,16 +220,8 @@ describe(__filename, () => {
     expect(order.status).to.be.eq(orderStatus)
     expect(order.side).to.be.eq(orderSide)
     expect(order.type).to.be.eq(orderType)
-    expect(order.filledAt?.getTime()).to.be.eq(updatedAt.getTime())
-    expect(order.placedAt
-      .getTime()
-      .toString()
-      .substring(0, 11)).to.be.eq(
-      new Date()
-        .getTime()
-        .toString()
-        .substring(0, 11),
-    )
+    expect(order.filledAt?.getTime()).to.be.eq(timestamp.getTime())
+    expect(order.placedAt.getTime()).to.be.eq(timestamp.getTime())
 
   })
 

src/exchanges/okx/Okx.spec.ts

@@ -0,0 +1,28 @@
+import { expect } from 'chai'
+
+import { IAlunaSettingsSchema } from '../../lib/schemas/IAlunaSettingsSchema'
+import { Okx } from './Okx'
+
+
+
+describe(__filename, () => {
+
+  it('should contain public modules', async () => {
+
+    const settings: IAlunaSettingsSchema = {
+      referralCode: '123',
+    }
+
+    const okx = new Okx({ settings })
+
+    expect(okx.id).to.eq('okx')
+
+    expect(okx.symbol).to.be.ok
+    expect(okx.market).to.be.ok
+
+    expect(okx.specs).to.be.ok
+    expect(okx.settings).to.deep.eq(okx.settings)
+
+  })
+
+})

src/exchanges/okx/Okx.ts

@@ -0,0 +1,38 @@
+import { IAlunaExchangePublic } from '../../lib/core/IAlunaExchange'
+import { IAlunaMarketModule } from '../../lib/modules/public/IAlunaMarketModule'
+import { IAlunaSymbolModule } from '../../lib/modules/public/IAlunaSymbolModule'
+import { IAlunaExchangeSchema } from '../../lib/schemas/IAlunaExchangeSchema'
+import { IAlunaSettingsSchema } from '../../lib/schemas/IAlunaSettingsSchema'
+import { buildOkxSpecs } from './okxSpecs'
+import { market } from './modules/public/market'
+import { symbol } from './modules/public/symbol'
+
+
+
+export class Okx implements IAlunaExchangePublic {
+
+  public id: string
+  public specs: IAlunaExchangeSchema
+  public settings: IAlunaSettingsSchema
+
+  public symbol: IAlunaSymbolModule
+  public market: IAlunaMarketModule
+
+
+
+  constructor(params: {
+    settings?: IAlunaSettingsSchema
+  }) {
+
+    const { settings = {} } = params
+
+    this.settings = settings
+    this.specs = buildOkxSpecs({ settings })
+    this.id = this.specs.id
+
+    this.market = market(this)
+    this.symbol = symbol(this)
+
+  }
+
+}

src/exchanges/okx/OkxAuthed.spec.ts

@@ -0,0 +1,39 @@
+import { expect } from 'chai'
+
+import { IAlunaCredentialsSchema } from '../../lib/schemas/IAlunaCredentialsSchema'
+import { IAlunaSettingsSchema } from '../../lib/schemas/IAlunaSettingsSchema'
+import { OkxAuthed } from './OkxAuthed'
+
+
+
+describe(__filename, () => {
+
+  it('should contain public & authed modules', async () => {
+
+    const credentials: IAlunaCredentialsSchema = {
+      key: 'some-key',
+      secret: 'some-secret',
+    }
+
+    const settings: IAlunaSettingsSchema = {
+      referralCode: '123',
+    }
+
+    const okx = new OkxAuthed({ settings, credentials })
+
+    expect(okx.id).to.eq('okx')
+
+    expect(okx.symbol).to.be.ok
+    expect(okx.market).to.be.ok
+
+    expect(okx.key).to.be.ok
+    expect(okx.balance).to.be.ok
+    expect(okx.order).to.be.ok
+    expect(okx.position).to.be.ok
+
+    expect(okx.specs).to.be.ok
+    expect(okx.settings).to.deep.eq(okx.settings)
+
+  })
+
+})

src/exchanges/okx/OkxAuthed.ts

@@ -0,0 +1,50 @@
+import { IAlunaExchangeAuthed } from '../../lib/core/IAlunaExchange'
+import { IAlunaBalanceModule } from '../../lib/modules/authed/IAlunaBalanceModule'
+import { IAlunaKeyModule } from '../../lib/modules/authed/IAlunaKeyModule'
+import { IAlunaOrderWriteModule } from '../../lib/modules/authed/IAlunaOrderModule'
+import { IAlunaPositionModule } from '../../lib/modules/authed/IAlunaPositionModule'
+import { IAlunaCredentialsSchema } from '../../lib/schemas/IAlunaCredentialsSchema'
+import { IAlunaSettingsSchema } from '../../lib/schemas/IAlunaSettingsSchema'
+import { balance } from './modules/authed/balance'
+import { key } from './modules/authed/key'
+import { order } from './modules/authed/order'
+import { position } from './modules/authed/position'
+import { Okx } from './Okx'
+
+
+
+export class OkxAuthed extends Okx implements IAlunaExchangeAuthed {
+
+  public credentials: IAlunaCredentialsSchema
+
+  public key: IAlunaKeyModule
+  public order: IAlunaOrderWriteModule
+  public balance: IAlunaBalanceModule
+  public position: IAlunaPositionModule
+
+
+
+  constructor(params: {
+    settings?: IAlunaSettingsSchema
+    credentials: IAlunaCredentialsSchema
+  }) {
+
+    const {
+      settings,
+      credentials,
+    } = params
+
+    super({ settings })
+
+    this.credentials = credentials
+
+    this.key = key(this)
+    this.balance = balance(this)
+    this.order = order(this)
+    this.position = position(this)
+
+    return this
+
+  }
+
+}