@nadohq/trigger-client 0.1.0-alpha.3 → 0.1.0-alpha.30

package/dist/types/serverQueryTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/serverQueryTypes.ts"],"sourcesContent":["import { EIP712ListTriggerOrdersValues, SignedTx } from '@nadohq/contracts';\nimport { EngineServerExecuteResult } from '@nadohq/engine-client';\nimport { TriggerServerPlaceOrderParams } from './serverExecuteTypes';\n\nexport type TriggerServerOrderStatus =\n  | 'pending'\n  | {\n      // Result from sending to engine\n      triggered: EngineServerExecuteResult;\n    }\n  | {\n      // Reason string\n      cancelled: string;\n    }\n  | {\n      // Error message\n      internal_error: string;\n    };\n\n/**\n * Request types\n */\n\nexport interface TriggerServerListTriggerOrdersParams\n  extends SignedTx<EIP712ListTriggerOrdersValues> {\n  pending: boolean;\n  // If not given, defaults to all products\n  product_id?: number;\n  max_update_time?: number;\n  digests?: string[];\n  limit?: number;\n}\n\nexport interface TriggerServerQueryRequestByType {\n  list_trigger_orders: TriggerServerListTriggerOrdersParams;\n}\n\nexport type TriggerServerQueryRequestType =\n  keyof TriggerServerQueryRequestByType;\n\n/**\n * Response types\n */\n\nexport type TriggerServerOrder = TriggerServerPlaceOrderParams & {\n  // Digest is always populated here\n  digest: string;\n};\n\nexport interface TriggerServerOrderInfo {\n  order: TriggerServerOrder;\n  status: TriggerServerOrderStatus;\n  updated_at: number;\n}\n\nexport interface TriggerServerListTriggerOrdersResponse {\n  orders: TriggerServerOrderInfo[];\n}\n\nexport interface TriggerServerQueryResponseByType {\n  list_trigger_orders: TriggerServerListTriggerOrdersResponse;\n}\n\nexport interface TriggerServerQuerySuccessResponse<\n  TQueryType extends\n    keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType,\n> {\n  status: 'success';\n  data: TriggerServerQueryResponseByType[TQueryType];\n}\n\nexport interface TriggerServerQueryFailureResponse {\n  status: 'failure';\n  error: string;\n  error_code: number;\n}\n\nexport type TriggerServerQueryResponse<\n  TQueryType extends\n    keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType,\n> =\n  | TriggerServerQuerySuccessResponse<TQueryType>\n  | TriggerServerQueryFailureResponse;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/serverQueryTypes.ts"],"sourcesContent":["import { EngineServerExecuteResult } from '@nadohq/engine-client';\nimport { EIP712ListTriggerOrdersValues, SignedTx } from '@nadohq/shared';\nimport { TriggerServerPlaceOrderParams } from './serverExecuteTypes';\n\nexport type TriggerServerOrderStatus =\n  | {\n      cancelled: TriggerServerCancelReason;\n    }\n  | {\n      triggered: EngineServerExecuteResult;\n    }\n  | {\n      internal_error: string;\n    }\n  | 'triggering'\n  | 'waiting_price'\n  | 'waiting_dependency'\n  | {\n      twap_executing: {\n        current_execution: number;\n        total_executions: number;\n      };\n    }\n  | {\n      twap_completed: {\n        executed: number;\n        total: number;\n      };\n    };\n\n/**\n * Request types\n */\n\nexport type TriggerServerTriggerTypeFilter = 'price_trigger' | 'time_trigger';\n\nexport type TriggerServerStatusTypeFilter =\n  | 'cancelled'\n  | 'triggered'\n  | 'internal_error'\n  | 'triggering'\n  | 'waiting_price'\n  | 'waiting_dependency'\n  | 'twap_executing'\n  | 'twap_completed';\n\nexport interface TriggerServerListTriggerOrdersParams\n  extends SignedTx<EIP712ListTriggerOrdersValues> {\n  // If not given, defaults to all products\n  product_ids?: number[];\n  max_update_time?: number;\n  digests?: string[];\n  limit?: number;\n  trigger_types?: TriggerServerTriggerTypeFilter[];\n  status_types?: TriggerServerStatusTypeFilter[];\n  reduce_only?: boolean;\n}\n\nexport interface TriggerServerListTwapExecutionsParams {\n  digest: string;\n}\n\nexport interface TriggerServerQueryRequestByType {\n  list_trigger_orders: TriggerServerListTriggerOrdersParams;\n  list_twap_executions: TriggerServerListTwapExecutionsParams;\n}\n\nexport type TriggerServerQueryRequestType =\n  keyof TriggerServerQueryRequestByType;\n\n/**\n * Response types\n */\n\nexport type TriggerServerOrder = TriggerServerPlaceOrderParams & {\n  // Digest is always populated here\n  digest: string;\n};\n\nexport interface TriggerServerOrderInfo {\n  order: TriggerServerOrder;\n  status: TriggerServerOrderStatus;\n  updated_at: number;\n  placed_at: number;\n}\n\nexport interface TriggerServerListTriggerOrdersResponse {\n  orders: TriggerServerOrderInfo[];\n}\n\nexport type TriggerServerCancelReason =\n  | 'user_requested'\n  | 'linked_signer_changed'\n  | 'expired'\n  | 'account_health'\n  | 'isolated_subaccount_closed'\n  | 'dependent_order_cancelled';\n\nexport type TriggerServerTwapExecutionStatus =\n  | 'pending'\n  | {\n      executed: {\n        executed_time: number;\n        execute_response: EngineServerExecuteResult;\n      };\n    }\n  | {\n      failed: string;\n    }\n  | {\n      cancelled: TriggerServerCancelReason;\n    };\n\nexport interface TriggerServerTwapExecutionInfo {\n  execution_id: number;\n  scheduled_time: number;\n  status: TriggerServerTwapExecutionStatus;\n  updated_at: number;\n}\n\nexport interface TriggerServerTwapExecutionsResponse {\n  executions: TriggerServerTwapExecutionInfo[];\n}\n\nexport interface TriggerServerQueryResponseByType {\n  list_trigger_orders: TriggerServerListTriggerOrdersResponse;\n  list_twap_executions: TriggerServerTwapExecutionsResponse;\n}\n\nexport interface TriggerServerQuerySuccessResponse<\n  TQueryType extends\n    keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType,\n> {\n  status: 'success';\n  data: TriggerServerQueryResponseByType[TQueryType];\n}\n\nexport interface TriggerServerQueryFailureResponse {\n  status: 'failure';\n  error: string;\n  error_code: number;\n}\n\nexport type TriggerServerQueryResponse<\n  TQueryType extends\n    keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType,\n> =\n  | TriggerServerQuerySuccessResponse<TQueryType>\n  | TriggerServerQueryFailureResponse;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/serverQueryTypes.d.cts

@@ -1,26 +1,45 @@
-import { SignedTx, EIP712ListTriggerOrdersValues } from '@nadohq/contracts';
 import { EngineServerExecuteResult } from '@nadohq/engine-client';
+import { SignedTx, EIP712ListTriggerOrdersValues } from '@nadohq/shared';
 import { TriggerServerPlaceOrderParams } from './serverExecuteTypes.cjs';
+import './serverModelTypes.cjs';
 
-type TriggerServerOrderStatus = 'pending' | {
-    triggered: EngineServerExecuteResult;
+type TriggerServerOrderStatus = {
+    cancelled: TriggerServerCancelReason;
 } | {
-    cancelled: string;
+    triggered: EngineServerExecuteResult;
 } | {
     internal_error: string;
+} | 'triggering' | 'waiting_price' | 'waiting_dependency' | {
+    twap_executing: {
+        current_execution: number;
+        total_executions: number;
+    };
+} | {
+    twap_completed: {
+        executed: number;
+        total: number;
+    };
 };
 /**
  * Request types
  */
+type TriggerServerTriggerTypeFilter = 'price_trigger' | 'time_trigger';
+type TriggerServerStatusTypeFilter = 'cancelled' | 'triggered' | 'internal_error' | 'triggering' | 'waiting_price' | 'waiting_dependency' | 'twap_executing' | 'twap_completed';
 interface TriggerServerListTriggerOrdersParams extends SignedTx<EIP712ListTriggerOrdersValues> {
-    pending: boolean;
-    product_id?: number;
+    product_ids?: number[];
     max_update_time?: number;
     digests?: string[];
     limit?: number;
+    trigger_types?: TriggerServerTriggerTypeFilter[];
+    status_types?: TriggerServerStatusTypeFilter[];
+    reduce_only?: boolean;
+}
+interface TriggerServerListTwapExecutionsParams {
+    digest: string;
 }
 interface TriggerServerQueryRequestByType {
     list_trigger_orders: TriggerServerListTriggerOrdersParams;
+    list_twap_executions: TriggerServerListTwapExecutionsParams;
 }
 type TriggerServerQueryRequestType = keyof TriggerServerQueryRequestByType;
 /**
@@ -33,12 +52,34 @@ interface TriggerServerOrderInfo {
     order: TriggerServerOrder;
     status: TriggerServerOrderStatus;
     updated_at: number;
+    placed_at: number;
 }
 interface TriggerServerListTriggerOrdersResponse {
     orders: TriggerServerOrderInfo[];
 }
+type TriggerServerCancelReason = 'user_requested' | 'linked_signer_changed' | 'expired' | 'account_health' | 'isolated_subaccount_closed' | 'dependent_order_cancelled';
+type TriggerServerTwapExecutionStatus = 'pending' | {
+    executed: {
+        executed_time: number;
+        execute_response: EngineServerExecuteResult;
+    };
+} | {
+    failed: string;
+} | {
+    cancelled: TriggerServerCancelReason;
+};
+interface TriggerServerTwapExecutionInfo {
+    execution_id: number;
+    scheduled_time: number;
+    status: TriggerServerTwapExecutionStatus;
+    updated_at: number;
+}
+interface TriggerServerTwapExecutionsResponse {
+    executions: TriggerServerTwapExecutionInfo[];
+}
 interface TriggerServerQueryResponseByType {
     list_trigger_orders: TriggerServerListTriggerOrdersResponse;
+    list_twap_executions: TriggerServerTwapExecutionsResponse;
 }
 interface TriggerServerQuerySuccessResponse<TQueryType extends keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType> {
     status: 'success';
@@ -51,4 +92,4 @@ interface TriggerServerQueryFailureResponse {
 }
 type TriggerServerQueryResponse<TQueryType extends keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType> = TriggerServerQuerySuccessResponse<TQueryType> | TriggerServerQueryFailureResponse;
 
-export type { TriggerServerListTriggerOrdersParams, TriggerServerListTriggerOrdersResponse, TriggerServerOrder, TriggerServerOrderInfo, TriggerServerOrderStatus, TriggerServerQueryFailureResponse, TriggerServerQueryRequestByType, TriggerServerQueryRequestType, TriggerServerQueryResponse, TriggerServerQueryResponseByType, TriggerServerQuerySuccessResponse };
+export type { TriggerServerCancelReason, TriggerServerListTriggerOrdersParams, TriggerServerListTriggerOrdersResponse, TriggerServerListTwapExecutionsParams, TriggerServerOrder, TriggerServerOrderInfo, TriggerServerOrderStatus, TriggerServerQueryFailureResponse, TriggerServerQueryRequestByType, TriggerServerQueryRequestType, TriggerServerQueryResponse, TriggerServerQueryResponseByType, TriggerServerQuerySuccessResponse, TriggerServerStatusTypeFilter, TriggerServerTriggerTypeFilter, TriggerServerTwapExecutionInfo, TriggerServerTwapExecutionStatus, TriggerServerTwapExecutionsResponse };

package/dist/types/serverQueryTypes.d.ts

@@ -1,26 +1,45 @@
-import { SignedTx, EIP712ListTriggerOrdersValues } from '@nadohq/contracts';
 import { EngineServerExecuteResult } from '@nadohq/engine-client';
+import { SignedTx, EIP712ListTriggerOrdersValues } from '@nadohq/shared';
 import { TriggerServerPlaceOrderParams } from './serverExecuteTypes.js';
+import './serverModelTypes.js';
 
-type TriggerServerOrderStatus = 'pending' | {
-    triggered: EngineServerExecuteResult;
+type TriggerServerOrderStatus = {
+    cancelled: TriggerServerCancelReason;
 } | {
-    cancelled: string;
+    triggered: EngineServerExecuteResult;
 } | {
     internal_error: string;
+} | 'triggering' | 'waiting_price' | 'waiting_dependency' | {
+    twap_executing: {
+        current_execution: number;
+        total_executions: number;
+    };
+} | {
+    twap_completed: {
+        executed: number;
+        total: number;
+    };
 };
 /**
  * Request types
  */
+type TriggerServerTriggerTypeFilter = 'price_trigger' | 'time_trigger';
+type TriggerServerStatusTypeFilter = 'cancelled' | 'triggered' | 'internal_error' | 'triggering' | 'waiting_price' | 'waiting_dependency' | 'twap_executing' | 'twap_completed';
 interface TriggerServerListTriggerOrdersParams extends SignedTx<EIP712ListTriggerOrdersValues> {
-    pending: boolean;
-    product_id?: number;
+    product_ids?: number[];
     max_update_time?: number;
     digests?: string[];
     limit?: number;
+    trigger_types?: TriggerServerTriggerTypeFilter[];
+    status_types?: TriggerServerStatusTypeFilter[];
+    reduce_only?: boolean;
+}
+interface TriggerServerListTwapExecutionsParams {
+    digest: string;
 }
 interface TriggerServerQueryRequestByType {
     list_trigger_orders: TriggerServerListTriggerOrdersParams;
+    list_twap_executions: TriggerServerListTwapExecutionsParams;
 }
 type TriggerServerQueryRequestType = keyof TriggerServerQueryRequestByType;
 /**
@@ -33,12 +52,34 @@ interface TriggerServerOrderInfo {
     order: TriggerServerOrder;
     status: TriggerServerOrderStatus;
     updated_at: number;
+    placed_at: number;
 }
 interface TriggerServerListTriggerOrdersResponse {
     orders: TriggerServerOrderInfo[];
 }
+type TriggerServerCancelReason = 'user_requested' | 'linked_signer_changed' | 'expired' | 'account_health' | 'isolated_subaccount_closed' | 'dependent_order_cancelled';
+type TriggerServerTwapExecutionStatus = 'pending' | {
+    executed: {
+        executed_time: number;
+        execute_response: EngineServerExecuteResult;
+    };
+} | {
+    failed: string;
+} | {
+    cancelled: TriggerServerCancelReason;
+};
+interface TriggerServerTwapExecutionInfo {
+    execution_id: number;
+    scheduled_time: number;
+    status: TriggerServerTwapExecutionStatus;
+    updated_at: number;
+}
+interface TriggerServerTwapExecutionsResponse {
+    executions: TriggerServerTwapExecutionInfo[];
+}
 interface TriggerServerQueryResponseByType {
     list_trigger_orders: TriggerServerListTriggerOrdersResponse;
+    list_twap_executions: TriggerServerTwapExecutionsResponse;
 }
 interface TriggerServerQuerySuccessResponse<TQueryType extends keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType> {
     status: 'success';
@@ -51,4 +92,4 @@ interface TriggerServerQueryFailureResponse {
 }
 type TriggerServerQueryResponse<TQueryType extends keyof TriggerServerQueryResponseByType = TriggerServerQueryRequestType> = TriggerServerQuerySuccessResponse<TQueryType> | TriggerServerQueryFailureResponse;
 
-export type { TriggerServerListTriggerOrdersParams, TriggerServerListTriggerOrdersResponse, TriggerServerOrder, TriggerServerOrderInfo, TriggerServerOrderStatus, TriggerServerQueryFailureResponse, TriggerServerQueryRequestByType, TriggerServerQueryRequestType, TriggerServerQueryResponse, TriggerServerQueryResponseByType, TriggerServerQuerySuccessResponse };
+export type { TriggerServerCancelReason, TriggerServerListTriggerOrdersParams, TriggerServerListTriggerOrdersResponse, TriggerServerListTwapExecutionsParams, TriggerServerOrder, TriggerServerOrderInfo, TriggerServerOrderStatus, TriggerServerQueryFailureResponse, TriggerServerQueryRequestByType, TriggerServerQueryRequestType, TriggerServerQueryResponse, TriggerServerQueryResponseByType, TriggerServerQuerySuccessResponse, TriggerServerStatusTypeFilter, TriggerServerTriggerTypeFilter, TriggerServerTwapExecutionInfo, TriggerServerTwapExecutionStatus, TriggerServerTwapExecutionsResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nadohq/trigger-client",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.30",
   "type": "module",
   "sideEffects": false,
   "description": "> TODO: description",
@@ -37,9 +37,8 @@
     }
   },
   "dependencies": {
-    "@nadohq/contracts": "^0.1.0-alpha.3",
-    "@nadohq/engine-client": "^0.1.0-alpha.3",
-    "@nadohq/utils": "^0.1.0-alpha.3",
+    "@nadohq/engine-client": "^0.1.0-alpha.30",
+    "@nadohq/shared": "^0.1.0-alpha.30",
     "axios": "*",
     "ts-mixer": "*"
   },
@@ -49,5 +48,5 @@
   "devDependencies": {
     "viem": "*"
   },
-  "gitHead": "2bfcc344b596b7a33e9b8e4e3256a117de3fda04"
+  "gitHead": "f91906311b3dfc22e8e174d5ed8fa459ec812a08"
 }

package/src/TriggerClient.ts

@@ -7,21 +7,28 @@ import {
   getNadoEIP712Values,
   getOrderNonce,
   getSignedTransactionRequest,
-  getTriggerOrderNonce,
   SignableRequestType,
   SignableRequestTypeToParams,
+  toIntegerString,
   WalletClientWithAccount,
-} from '@nadohq/contracts';
-import { toIntegerString, WalletNotProvidedError } from '@nadohq/utils';
+  WalletNotProvidedError,
+} from '@nadohq/shared';
 import axios, { AxiosInstance, AxiosResponse } from 'axios';
-import { mapServerOrderInfo, mapTriggerCriteria } from './dataMappers';
+import {
+  mapServerOrderInfo,
+  mapTriggerCriteria,
+  mapTwapExecutionStatus,
+} from './dataMappers';
 import {
   TriggerCancelOrdersParams,
   TriggerCancelProductOrdersParams,
   TriggerListOrdersParams,
   TriggerListOrdersResponse,
+  TriggerListTwapExecutionsParams,
+  TriggerListTwapExecutionsResponse,
   TriggerOrderInfo,
   TriggerPlaceOrderParams,
+  TriggerPlaceOrdersParams,
   TriggerServerExecuteRequestByType,
   TriggerServerExecuteRequestType,
   TriggerServerExecuteResult,
@@ -31,6 +38,7 @@ import {
   TriggerServerQueryResponse,
   TriggerServerQueryResponseByType,
   TriggerServerQuerySuccessResponse,
+  TwapExecutionInfo,
 } from './types';
 import { TriggerServerFailureError } from './types/TriggerServerFailureError';
 
@@ -52,7 +60,11 @@ export class TriggerClient {
 
   constructor(opts: TriggerClientOpts) {
     this.opts = opts;
-    this.axiosInstance = axios.create({ withCredentials: true });
+    this.axiosInstance = axios.create({
+      withCredentials: true,
+      // We have custom logic to validate response status and create an appropriate error
+      validateStatus: () => true,
+    });
   }
 
   /**
@@ -71,32 +83,23 @@ export class TriggerClient {
    */
 
   async placeTriggerOrder(params: TriggerPlaceOrderParams) {
-    const orderParams: EIP712OrderParams = {
-      amount: params.order.amount,
-      expiration: params.order.expiration,
-      price: params.order.price,
-      subaccountName: params.order.subaccountName,
-      subaccountOwner: params.order.subaccountOwner,
-      nonce: params.nonce ?? getTriggerOrderNonce(),
-    };
-    const signature = await this.sign(
+    return this.execute(
       'place_order',
-      params.verifyingAddr,
-      params.chainId,
-      orderParams,
+      await this.buildPlaceOrderExecuteParams(params),
     );
+  }
 
-    const executeParams: TriggerServerExecuteRequestByType['place_order'] = {
-      id: params.id ?? null,
-      order: getNadoEIP712Values('place_order', orderParams),
-      trigger: mapTriggerCriteria(params.triggerCriteria),
-      signature,
-      product_id: params.productId,
-      spot_leverage: params.spotLeverage ?? null,
-      digest: params.digest ?? null,
+  async placeTriggerOrders(params: TriggerPlaceOrdersParams) {
+    const executeParams: TriggerServerExecuteRequestByType['place_orders'] = {
+      orders: await Promise.all(
+        params.orders.map(async (orderParam) =>
+          this.buildPlaceOrderExecuteParams(orderParam),
+        ),
+      ),
+      cancel_on_failure: params.cancelOnFailure ?? null,
     };
 
-    return this.execute('place_order', executeParams);
+    return this.execute('place_orders', executeParams);
   }
 
   async cancelTriggerOrders(params: TriggerCancelOrdersParams) {
@@ -173,9 +176,11 @@ export class TriggerClient {
       {
         limit: params.limit,
         max_update_time: params.maxUpdateTimeInclusive,
-        pending: params.pending,
-        product_id: params.productId,
+        status_types: params.statusTypes,
+        product_ids: params.productIds,
         digests: params.digests,
+        trigger_types: params.triggerTypes,
+        reduce_only: params.reduceOnly,
         signature,
         tx,
       };
@@ -190,9 +195,65 @@ export class TriggerClient {
     };
   }
 
+  async listTwapExecutions(
+    params: TriggerListTwapExecutionsParams,
+  ): Promise<TriggerListTwapExecutionsResponse> {
+    const queryParams: TriggerServerQueryRequestByType['list_twap_executions'] =
+      {
+        digest: params.digest,
+      };
+
+    const baseResponse = await this.query('list_twap_executions', queryParams);
+
+    const executions: TwapExecutionInfo[] = baseResponse.executions.map(
+      (execution) => ({
+        executionId: execution.execution_id,
+        scheduledTime: execution.scheduled_time,
+        status: mapTwapExecutionStatus(execution.status),
+        updatedAt: execution.updated_at,
+      }),
+    );
+
+    return {
+      executions,
+    };
+  }
+
   /*
   Base Fns
    */
+
+  async buildPlaceOrderExecuteParams(
+    params: TriggerPlaceOrderParams,
+  ): Promise<TriggerServerExecuteRequestByType['place_order']> {
+    const orderParams: EIP712OrderParams = {
+      amount: params.order.amount,
+      expiration: params.order.expiration,
+      price: params.order.price,
+      subaccountName: params.order.subaccountName,
+      subaccountOwner: params.order.subaccountOwner,
+      nonce: params.nonce ?? getOrderNonce(),
+      appendix: params.order.appendix,
+    };
+    const signature = await this.sign(
+      'place_order',
+      params.verifyingAddr,
+      params.chainId,
+      orderParams,
+    );
+
+    return {
+      id: params.id ?? null,
+      order: getNadoEIP712Values('place_order', orderParams),
+      trigger: mapTriggerCriteria(params.triggerCriteria),
+      signature,
+      product_id: params.productId,
+      spot_leverage: params.spotLeverage ?? null,
+      digest: params.digest ?? null,
+      borrow_margin: params.borrowMargin ?? null,
+    };
+  }
+
   protected async sign<T extends SignableRequestType>(
     requestType: T,
     verifyingContract: string,
@@ -267,7 +328,7 @@ export class TriggerClient {
   private checkResponseStatus(response: AxiosResponse) {
     if (response.status !== 200 || !response.data) {
       throw Error(
-        `Unexpected response from server: ${response.status} ${response.statusText}`,
+        `Unexpected response from server: ${response.status} ${response.statusText}. Data: ${response.data}`,
       );
     }
   }