Merge pull request #1 from nash-io/ts/autostatesync

change default behavior to auto sign state when necessary

Author: localhuman

README.md

@@ -114,3 +114,25 @@ See also the [websockets example](https://gitlab.com/nash-io-public/api-client-t
 ## Managing API key policies
 
 For more information on how to set up policies for API keys, consult the [API key policies wiki page](https://gitlab.com/nash-io-public/api-client-typescript/-/wikis/Apikey-policies).
+
+
+## State signing
+
+In order to assure your blockchain balances remain in sync with your trading balances, the client must 'sign' their state every so often before placing more orders.  By default, the client will take care of this in the background for you and you will not need to worry about this.
+
+In special cases where a user has more than one client process running at once which is placing a high volume of orders, it is advisable to take a more custom approach.  To turn of auto state syncing, initialize the client like so: 
+
+```
+const nash = new Client(EnvironmentConfiguration.sandbox, {autoSignState: false})
+```
+
+You will then be responsible for signing states when necessary.  The current restriction is that states must be signed every 100 open orders, so the client should keep track and make sure to sign state before this limit is reached, otherwise placing an order will raise an error.
+
+This is done using the following call: 
+
+```
+const states = await client.getSignAndSyncStates()
+```
+
+If you are running a high volume of orders from different clients on the same account and having difficulty managing this process, please reach out to support and we will be glad to help with an optimal solution.
+

src/client/client.ts

@@ -272,8 +272,10 @@ const BLOCKCHAIN_TO_BIP44 = {
   [Blockchain.NEO]: BIP44.NEO
 }
 
+const ORDERS_REMAINING_TO_AUTOSYNC_AT = 20
 const NEP5_OLD_ASSETS = ['nos', 'phx', 'guard', 'lx', 'ava']
 export const MISSING_NONCES = 'missing_asset_nonces'
+export const MAX_ORDERS_REACHED = 'Maximal number of orders have been reached'
 export const MAX_SIGN_STATE_RECURSION = 5
 
 export class Client {
@@ -317,7 +319,7 @@ export class Client {
   private tradedAssets: string[] = []
   private assetNonces: { [key: string]: number[] }
   private currentOrderNonce: number
-
+  private signStateInProgress: boolean
   /**
    * Create a new instance of [[Client]]
    *
@@ -337,6 +339,7 @@ export class Client {
       ...opts
     }
     this.clientOpts = {
+      autoSignState: true,
       runRequestsOverWebsockets: false,
       headers: {},
       ...clientOpts
@@ -1608,6 +1611,8 @@ export class Client {
   public async getSignAndSyncStates(
     sync = false
   ): Promise<SyncStatesData | SignStatesData> {
+    this.signStateInProgress = true
+
     const emptyStates: GetStatesData = {
       states: [],
       recycledOrders: [],
@@ -1616,6 +1621,8 @@ export class Client {
     const signStatesRecursive: SignStatesData = await this.signStates(
       emptyStates
     )
+    this.signStateInProgress = false
+
     if (sync) {
       const syncResult = await this.syncStates(signStatesRecursive)
       return syncResult
@@ -1936,10 +1943,22 @@ export class Client {
       })
       measurementPlaceOrder.end()
       measurementPlaceLimitOrder.end()
+
+      await this.handleOrderPlaced(result.data.placeLimitOrder)
+
       return result.data.placeLimitOrder
     } catch (e) {
+      let replaceOrder = false
       if (e.message.includes(MISSING_NONCES)) {
+        replaceOrder = true
         await this.updateTradedAssetNonces()
+      } else if (e.message.includes(MAX_ORDERS_REACHED)) {
+        if (this.clientOpts.autoSignState && !this.signStateInProgress) {
+          replaceOrder = true
+          await this.getSignAndSyncStates()
+        }
+      }
+      if (replaceOrder) {
         return await this.placeLimitOrder(
           allowTaker,
           amount,
@@ -2026,12 +2045,23 @@ export class Client {
       })
       measurementPlaceOrder.end()
       measurementPlaceMarketOrder.end()
+      await this.handleOrderPlaced(result.data.placeMarketOrder)
       return result.data.placeMarketOrder
     } catch (e) {
+      let replaceOrder = false
       if (e.message.includes(MISSING_NONCES)) {
+        replaceOrder = true
         await this.updateTradedAssetNonces()
+      } else if (e.message.includes(MAX_ORDERS_REACHED)) {
+        if (this.clientOpts.autoSignState && !this.signStateInProgress) {
+          replaceOrder = true
+          await this.getSignAndSyncStates()
+        }
+      }
+      if (replaceOrder) {
         return await this.placeMarketOrder(amount, buyOrSell, marketName)
       }
+
       return this.handleOrderError(e, signedPayload)
     }
   }
@@ -2136,11 +2166,20 @@ export class Client {
       })
       measurementPlaceOrder.end()
       measurementPlaceMarketOrder.end()
-
+      await this.handleOrderPlaced(result.data.placeStopLimitOrder)
       return result.data.placeStopLimitOrder
     } catch (e) {
+      let replaceOrder = false
       if (e.message.includes(MISSING_NONCES)) {
+        replaceOrder = true
         await this.updateTradedAssetNonces()
+      } else if (e.message.includes(MAX_ORDERS_REACHED)) {
+        if (this.clientOpts.autoSignState && !this.signStateInProgress) {
+          replaceOrder = true
+          await this.getSignAndSyncStates()
+        }
+      }
+      if (replaceOrder) {
         return await this.placeStopLimitOrder(
           allowTaker,
           amount,
@@ -2238,10 +2277,20 @@ export class Client {
       })
       measurementPlaceOrder.end()
       measurementPlaceMarketOrder.end()
+      await this.handleOrderPlaced(result.data.placeStopMarketOrder)
       return result.data.placeStopMarketOrder
     } catch (e) {
+      let replaceOrder = false
       if (e.message.includes(MISSING_NONCES)) {
+        replaceOrder = true
         await this.updateTradedAssetNonces()
+      } else if (e.message.includes(MAX_ORDERS_REACHED)) {
+        if (this.clientOpts.autoSignState && !this.signStateInProgress) {
+          replaceOrder = true
+          await this.getSignAndSyncStates()
+        }
+      }
+      if (replaceOrder) {
         return await this.placeStopMarketOrder(
           amount,
           buyOrSell,
@@ -2254,6 +2303,17 @@ export class Client {
     }
   }
 
+  private handleOrderPlaced = async (order: OrderPlaced): Promise<void> => {
+    if (
+      this.clientOpts.autoSignState &&
+      order.ordersTillSignState < ORDERS_REMAINING_TO_AUTOSYNC_AT &&
+      !this.signStateInProgress
+    ) {
+      console.info('Will auto sign state: ', order.ordersTillSignState)
+      await this.getSignAndSyncStates()
+    }
+  }
+
   private handleOrderError(error: Error, signedPayload: any): any {
     if (error.message.includes(MISSING_NONCES)) {
       this.updateTradedAssetNonces()

src/client/environments.ts

@@ -20,6 +20,7 @@ export interface ClientOptions {
   // The socketsocket conneciton supports 1 header. "User-Agent"
   // while the others support all, but you cannot override content-type nor the authorization token
   headers?: Record<string, string>
+  autoSignState?: boolean
 }
 export const EnvironmentConfiguration = {
   production: {

src/mutations/orders/fragments/orderPlacedFragment.ts

@@ -4,5 +4,6 @@ export const ORDER_PLACED_FRAGMENT = gql`
   fragment orderPlacedFields on OrderPlaced {
     id
     status
+    ordersTillSignState
   }
 `

src/types/order.ts

@@ -55,4 +55,5 @@ export enum OrderType {
 export interface OrderPlaced {
   id: string
   status: OrderStatus
+  ordersTillSignState: number
 }