@nadohq/trigger-client 0.14.0 → 0.17.0

package/dist/clientModelTypes-C7K17sS2.d.cts

@@ -0,0 +1,69 @@
+import { BigNumberish } from "@nadohq/shared";
+import { EngineServerExecuteResult } from "@nadohq/engine-client";
+
+//#region src/types/clientModelTypes.d.ts
+type PriceTriggerRequirementType = 'oracle_price_above' | 'oracle_price_below' | 'last_price_above' | 'last_price_below' | 'mid_price_above' | 'mid_price_below';
+interface PriceTriggerDependency {
+  /**
+   * Digest of the order that this trigger depends on.
+   */
+  digest: string;
+  /**
+   * Whether to trigger on partial fills.
+   */
+  onPartialFill: boolean;
+}
+interface PriceTriggerCriteria {
+  type: PriceTriggerRequirementType;
+  triggerPrice: BigNumberish;
+  dependency?: PriceTriggerDependency;
+}
+interface TimeTriggerCriteria {
+  /**
+   * For TWAP: Trigger interval in seconds
+   */
+  interval: BigNumberish;
+  /**
+   * For TWAP: By default, trigger service will split up orders as per total amount / interval
+   * If you want to specify the amounts for each interval, you can provide them here.
+   */
+  amounts?: BigNumberish[];
+}
+/**
+ * All possible trigger conditions that can be used to place a trigger order.
+ */
+type TriggerCriteria = {
+  type: 'price';
+  criteria: PriceTriggerCriteria;
+} | {
+  type: 'time';
+  criteria: TimeTriggerCriteria;
+};
+type TriggerCriteriaType = TriggerCriteria['type'];
+type TriggerOrderStatus = {
+  type: 'cancelled';
+  reason: string;
+} | {
+  type: 'triggered';
+  result: EngineServerExecuteResult;
+} | {
+  type: 'internal_error';
+  error: string;
+} | {
+  type: 'triggering';
+} | {
+  type: 'waiting_price';
+} | {
+  type: 'waiting_dependency';
+} | {
+  type: 'twap_executing';
+  currentExecution: number;
+  totalExecutions: number;
+} | {
+  type: 'twap_completed';
+  executed: number;
+  total: number;
+};
+//#endregion
+export { TriggerCriteria as a, TimeTriggerCriteria as i, PriceTriggerDependency as n, TriggerCriteriaType as o, PriceTriggerRequirementType as r, TriggerOrderStatus as s, PriceTriggerCriteria as t };
+//# sourceMappingURL=clientModelTypes-C7K17sS2.d.cts.map

package/dist/clientModelTypes-C7K17sS2.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientModelTypes-C7K17sS2.d.cts","names":[],"sources":["../src/types/src/types/clientModelTypes.ts"],"mappings":";;;;KAOY,2BAAA;AAAA,UAQK,sBAAA;EARL;;;EAYV,MAAA;EAZqC;AAQvC;;EAQE,aAAa;AAAA;AAAA,UAGE,oBAAA;EACf,IAAA,EAAM,2BAAA;EACN,YAAA,EAAc,YAAA;EACd,UAAA,GAAa,sBAAA;AAAA;AAAA,UAOE,mBAAA;EAPF;;;EAWb,QAAA,EAAU,YAAA;EAbJ;;;;EAkBN,OAAA,GAAU,YAAY;AAAA;AAhBa;AAOrC;;AAPqC,KAsBzB,eAAA;EAEN,IAAA;EACA,QAAA,EAAU,oBAAA;AAAA;EAGV,IAAA;EACA,QAAA,EAAU,mBAAmB;AAAA;AAAA,KAGvB,mBAAA,GAAsB,eAAe;AAAA,KAErC,kBAAA;EAEN,IAAA;EACA,MAAA;AAAA;EAGA,IAAA;EACA,MAAA,EAAQ,yBAAyB;AAAA;EAGjC,IAAA;EACA,KAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;EACA,gBAAA;EACA,eAAA;AAAA;EAGA,IAAA;EACA,QAAA;EACA,KAAA;AAAA"}

package/dist/clientModelTypes-CZv3IB5D.d.ts

@@ -0,0 +1,69 @@
+import { BigNumberish } from "@nadohq/shared";
+import { EngineServerExecuteResult } from "@nadohq/engine-client";
+
+//#region src/types/clientModelTypes.d.ts
+type PriceTriggerRequirementType = 'oracle_price_above' | 'oracle_price_below' | 'last_price_above' | 'last_price_below' | 'mid_price_above' | 'mid_price_below';
+interface PriceTriggerDependency {
+  /**
+   * Digest of the order that this trigger depends on.
+   */
+  digest: string;
+  /**
+   * Whether to trigger on partial fills.
+   */
+  onPartialFill: boolean;
+}
+interface PriceTriggerCriteria {
+  type: PriceTriggerRequirementType;
+  triggerPrice: BigNumberish;
+  dependency?: PriceTriggerDependency;
+}
+interface TimeTriggerCriteria {
+  /**
+   * For TWAP: Trigger interval in seconds
+   */
+  interval: BigNumberish;
+  /**
+   * For TWAP: By default, trigger service will split up orders as per total amount / interval
+   * If you want to specify the amounts for each interval, you can provide them here.
+   */
+  amounts?: BigNumberish[];
+}
+/**
+ * All possible trigger conditions that can be used to place a trigger order.
+ */
+type TriggerCriteria = {
+  type: 'price';
+  criteria: PriceTriggerCriteria;
+} | {
+  type: 'time';
+  criteria: TimeTriggerCriteria;
+};
+type TriggerCriteriaType = TriggerCriteria['type'];
+type TriggerOrderStatus = {
+  type: 'cancelled';
+  reason: string;
+} | {
+  type: 'triggered';
+  result: EngineServerExecuteResult;
+} | {
+  type: 'internal_error';
+  error: string;
+} | {
+  type: 'triggering';
+} | {
+  type: 'waiting_price';
+} | {
+  type: 'waiting_dependency';
+} | {
+  type: 'twap_executing';
+  currentExecution: number;
+  totalExecutions: number;
+} | {
+  type: 'twap_completed';
+  executed: number;
+  total: number;
+};
+//#endregion
+export { TriggerCriteria as a, TimeTriggerCriteria as i, PriceTriggerDependency as n, TriggerCriteriaType as o, PriceTriggerRequirementType as r, TriggerOrderStatus as s, PriceTriggerCriteria as t };
+//# sourceMappingURL=clientModelTypes-CZv3IB5D.d.ts.map

package/dist/clientModelTypes-CZv3IB5D.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientModelTypes-CZv3IB5D.d.ts","names":[],"sources":["../src/types/src/types/clientModelTypes.ts"],"mappings":";;;;KAOY,2BAAA;AAAA,UAQK,sBAAA;EARL;;;EAYV,MAAA;EAZqC;AAQvC;;EAQE,aAAa;AAAA;AAAA,UAGE,oBAAA;EACf,IAAA,EAAM,2BAAA;EACN,YAAA,EAAc,YAAA;EACd,UAAA,GAAa,sBAAA;AAAA;AAAA,UAOE,mBAAA;EAPF;;;EAWb,QAAA,EAAU,YAAA;EAbJ;;;;EAkBN,OAAA,GAAU,YAAY;AAAA;AAhBa;AAOrC;;AAPqC,KAsBzB,eAAA;EAEN,IAAA;EACA,QAAA,EAAU,oBAAA;AAAA;EAGV,IAAA;EACA,QAAA,EAAU,mBAAmB;AAAA;AAAA,KAGvB,mBAAA,GAAsB,eAAe;AAAA,KAErC,kBAAA;EAEN,IAAA;EACA,MAAA;AAAA;EAGA,IAAA;EACA,MAAA,EAAQ,yBAAyB;AAAA;EAGjC,IAAA;EACA,KAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;AAAA;EAGA,IAAA;EACA,gBAAA;EACA,eAAA;AAAA;EAGA,IAAA;EACA,QAAA;EACA,KAAA;AAAA"}

package/dist/clientTypes-Bn3lA19Y.d.cts

@@ -0,0 +1,102 @@
+import { a as TriggerCriteria, s as TriggerOrderStatus } from "./clientModelTypes-C7K17sS2.cjs";
+import { a as TriggerServerOrder, h as TriggerServerTriggerTypeFilter, m as TriggerServerStatusTypeFilter } from "./serverQueryTypes-Cj3yVnLR.cjs";
+import { EIP712CancelOrdersParams, EIP712CancelProductOrdersParams, OrderAppendix, Subaccount } from "@nadohq/shared";
+import { EngineOrderParams, EngineServerExecuteResult } from "@nadohq/engine-client";
+import BigNumber from "bignumber.js";
+
+//#region src/types/clientTypes.d.ts
+type WithOptionalNonce<T> = Omit<T, 'nonce'> & {
+  nonce?: string;
+};
+interface SignatureParams {
+  /**
+   * Address derived from productId for placement (see getOrderVerifyingAddr)
+   * endpoint address for cancellation & listing
+   */
+  verifyingAddr: string;
+  chainId: number;
+}
+/**
+ * Executes
+ */
+interface TriggerPlaceOrderParams extends SignatureParams {
+  id?: number;
+  productId: number;
+  order: EngineOrderParams;
+  triggerCriteria: TriggerCriteria;
+  spotLeverage?: boolean;
+  borrowMargin?: boolean;
+  digest?: string;
+  nonce?: string;
+}
+interface TriggerPlaceOrdersParams {
+  orders: TriggerPlaceOrderParams[];
+  /**
+   * If `true`, aborts the batch after the first failed order; if `false`, remaining orders continue to execute.
+   * If not provided, the default value is `false`.
+   */
+  stopOnFailure?: boolean;
+}
+type TriggerCancelOrdersParams = SignatureParams & WithOptionalNonce<EIP712CancelOrdersParams>;
+type TriggerCancelProductOrdersParams = SignatureParams & WithOptionalNonce<EIP712CancelProductOrdersParams>;
+/**
+ * Queries
+ */
+interface TriggerListOrdersParams extends Subaccount, SignatureParams {
+  recvTime?: BigNumber;
+  productIds?: number[];
+  maxUpdateTimeInclusive?: number;
+  digests?: string[];
+  limit?: number;
+  statusTypes?: TriggerServerStatusTypeFilter[];
+  triggerTypes?: TriggerServerTriggerTypeFilter[];
+  reduceOnly?: boolean;
+}
+interface TriggerOrder {
+  productId: number;
+  triggerCriteria: TriggerCriteria;
+  price: BigNumber;
+  amount: BigNumber;
+  expiration: number;
+  nonce: string;
+  digest: string;
+  appendix: OrderAppendix;
+}
+interface TriggerOrderInfo {
+  order: TriggerOrder;
+  serverOrder: TriggerServerOrder;
+  status: TriggerOrderStatus;
+  updatedAt: number;
+  placementTime: number;
+}
+interface TriggerListOrdersResponse {
+  orders: TriggerOrderInfo[];
+}
+interface TriggerListTwapExecutionsParams {
+  digest: string;
+}
+type TwapExecutionStatus = {
+  type: 'pending';
+} | {
+  type: 'executed';
+  executedTime: number;
+  executeResponse: EngineServerExecuteResult;
+} | {
+  type: 'failed';
+  error: string;
+} | {
+  type: 'cancelled';
+  reason: string;
+};
+interface TwapExecutionInfo {
+  executionId: number;
+  scheduledTime: number;
+  status: TwapExecutionStatus;
+  updatedAt: number;
+}
+interface TriggerListTwapExecutionsResponse {
+  executions: TwapExecutionInfo[];
+}
+//#endregion
+export { TriggerListTwapExecutionsParams as a, TriggerOrderInfo as c, TwapExecutionInfo as d, TwapExecutionStatus as f, TriggerListOrdersResponse as i, TriggerPlaceOrderParams as l, TriggerCancelProductOrdersParams as n, TriggerListTwapExecutionsResponse as o, TriggerListOrdersParams as r, TriggerOrder as s, TriggerCancelOrdersParams as t, TriggerPlaceOrdersParams as u };
+//# sourceMappingURL=clientTypes-Bn3lA19Y.d.cts.map

package/dist/clientTypes-Bn3lA19Y.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientTypes-Bn3lA19Y.d.cts","names":[],"sources":["../src/types/src/types/clientTypes.ts"],"mappings":";;;;;;;KAkBK,iBAAA,MAAuB,IAAI,CAAC,CAAA;EAAgB,KAAA;AAAA;AAAA,UAEvC,eAAA;EAFY;;;;EAOpB,aAAA;EACA,OAAO;AAAA;AAR6C;AAAA;;AAAA,UAerC,uBAAA,SAAgC,eAAA;EAC/C,EAAA;EACA,SAAA;EACA,KAAA,EAAO,iBAAA;EACP,eAAA,EAAiB,eAAA;EAEjB,YAAA;EAEA,YAAA;EACA,MAAA;EACA,KAAA;AAAA;AAAA,UAGe,wBAAA;EACf,MAAA,EAAQ,uBAAuB;EAb/B;;;;EAkBA,aAAA;AAAA;AAAA,KAGU,yBAAA,GAA4B,eAAA,GACtC,iBAAA,CAAkB,wBAAA;AAAA,KAER,gCAAA,GAAmC,eAAA,GAC7C,iBAAA,CAAkB,+BAAA;;;;UAMH,uBAAA,SAAgC,UAAA,EAAY,eAAA;EAE3D,QAAA,GAAW,SAAA;EAEX,UAAA;EAEA,sBAAA;EAEA,OAAA;EACA,KAAA;EAEA,WAAA,GAAc,6BAAA;EAEd,YAAA,GAAe,8BAAA;EAEf,UAAA;AAAA;AAAA,UAGe,YAAA;EACf,SAAA;EACA,eAAA,EAAiB,eAAA;EACjB,KAAA,EAAO,SAAA;EACP,MAAA,EAAQ,SAAA;EACR,UAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA,EAAU,aAAA;AAAA;AAAA,UAGK,gBAAA;EACf,KAAA,EAAO,YAAA;EACP,WAAA,EAAa,kBAAA;EACb,MAAA,EAAQ,kBAAA;EACR,SAAA;EACA,aAAA;AAAA;AAAA,UAGe,yBAAA;EACf,MAAA,EAAQ,gBAAgB;AAAA;AAAA,UAGT,+BAAA;EACf,MAAM;AAAA;AAAA,KAGI,mBAAA;EAEN,IAAA;AAAA;EAGA,IAAA;EACA,YAAA;EACA,eAAA,EAAiB,yBAAyB;AAAA;EAG1C,IAAA;EACA,KAAA;AAAA;EAGA,IAAA;EACA,MAAA;AAAA;AAAA,UAGW,iBAAA;EACf,WAAA;EACA,aAAA;EACA,MAAA,EAAQ,mBAAmB;EAC3B,SAAA;AAAA;AAAA,UAGe,iCAAA;EACf,UAAA,EAAY,iBAAiB;AAAA"}

package/dist/clientTypes-CAwuc8HN.d.ts

@@ -0,0 +1,102 @@
+import { a as TriggerCriteria, s as TriggerOrderStatus } from "./clientModelTypes-CZv3IB5D.js";
+import { a as TriggerServerOrder, h as TriggerServerTriggerTypeFilter, m as TriggerServerStatusTypeFilter } from "./serverQueryTypes-C-RiciWB.js";
+import { EIP712CancelOrdersParams, EIP712CancelProductOrdersParams, OrderAppendix, Subaccount } from "@nadohq/shared";
+import { EngineOrderParams, EngineServerExecuteResult } from "@nadohq/engine-client";
+import BigNumber from "bignumber.js";
+
+//#region src/types/clientTypes.d.ts
+type WithOptionalNonce<T> = Omit<T, 'nonce'> & {
+  nonce?: string;
+};
+interface SignatureParams {
+  /**
+   * Address derived from productId for placement (see getOrderVerifyingAddr)
+   * endpoint address for cancellation & listing
+   */
+  verifyingAddr: string;
+  chainId: number;
+}
+/**
+ * Executes
+ */
+interface TriggerPlaceOrderParams extends SignatureParams {
+  id?: number;
+  productId: number;
+  order: EngineOrderParams;
+  triggerCriteria: TriggerCriteria;
+  spotLeverage?: boolean;
+  borrowMargin?: boolean;
+  digest?: string;
+  nonce?: string;
+}
+interface TriggerPlaceOrdersParams {
+  orders: TriggerPlaceOrderParams[];
+  /**
+   * If `true`, aborts the batch after the first failed order; if `false`, remaining orders continue to execute.
+   * If not provided, the default value is `false`.
+   */
+  stopOnFailure?: boolean;
+}
+type TriggerCancelOrdersParams = SignatureParams & WithOptionalNonce<EIP712CancelOrdersParams>;
+type TriggerCancelProductOrdersParams = SignatureParams & WithOptionalNonce<EIP712CancelProductOrdersParams>;
+/**
+ * Queries
+ */
+interface TriggerListOrdersParams extends Subaccount, SignatureParams {
+  recvTime?: BigNumber;
+  productIds?: number[];
+  maxUpdateTimeInclusive?: number;
+  digests?: string[];
+  limit?: number;
+  statusTypes?: TriggerServerStatusTypeFilter[];
+  triggerTypes?: TriggerServerTriggerTypeFilter[];
+  reduceOnly?: boolean;
+}
+interface TriggerOrder {
+  productId: number;
+  triggerCriteria: TriggerCriteria;
+  price: BigNumber;
+  amount: BigNumber;
+  expiration: number;
+  nonce: string;
+  digest: string;
+  appendix: OrderAppendix;
+}
+interface TriggerOrderInfo {
+  order: TriggerOrder;
+  serverOrder: TriggerServerOrder;
+  status: TriggerOrderStatus;
+  updatedAt: number;
+  placementTime: number;
+}
+interface TriggerListOrdersResponse {
+  orders: TriggerOrderInfo[];
+}
+interface TriggerListTwapExecutionsParams {
+  digest: string;
+}
+type TwapExecutionStatus = {
+  type: 'pending';
+} | {
+  type: 'executed';
+  executedTime: number;
+  executeResponse: EngineServerExecuteResult;
+} | {
+  type: 'failed';
+  error: string;
+} | {
+  type: 'cancelled';
+  reason: string;
+};
+interface TwapExecutionInfo {
+  executionId: number;
+  scheduledTime: number;
+  status: TwapExecutionStatus;
+  updatedAt: number;
+}
+interface TriggerListTwapExecutionsResponse {
+  executions: TwapExecutionInfo[];
+}
+//#endregion
+export { TriggerListTwapExecutionsParams as a, TriggerOrderInfo as c, TwapExecutionInfo as d, TwapExecutionStatus as f, TriggerListOrdersResponse as i, TriggerPlaceOrderParams as l, TriggerCancelProductOrdersParams as n, TriggerListTwapExecutionsResponse as o, TriggerListOrdersParams as r, TriggerOrder as s, TriggerCancelOrdersParams as t, TriggerPlaceOrdersParams as u };
+//# sourceMappingURL=clientTypes-CAwuc8HN.d.ts.map

package/dist/clientTypes-CAwuc8HN.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientTypes-CAwuc8HN.d.ts","names":[],"sources":["../src/types/src/types/clientTypes.ts"],"mappings":";;;;;;;KAkBK,iBAAA,MAAuB,IAAI,CAAC,CAAA;EAAgB,KAAA;AAAA;AAAA,UAEvC,eAAA;EAFY;;;;EAOpB,aAAA;EACA,OAAO;AAAA;AAR6C;AAAA;;AAAA,UAerC,uBAAA,SAAgC,eAAA;EAC/C,EAAA;EACA,SAAA;EACA,KAAA,EAAO,iBAAA;EACP,eAAA,EAAiB,eAAA;EAEjB,YAAA;EAEA,YAAA;EACA,MAAA;EACA,KAAA;AAAA;AAAA,UAGe,wBAAA;EACf,MAAA,EAAQ,uBAAuB;EAb/B;;;;EAkBA,aAAA;AAAA;AAAA,KAGU,yBAAA,GAA4B,eAAA,GACtC,iBAAA,CAAkB,wBAAA;AAAA,KAER,gCAAA,GAAmC,eAAA,GAC7C,iBAAA,CAAkB,+BAAA;;;;UAMH,uBAAA,SAAgC,UAAA,EAAY,eAAA;EAE3D,QAAA,GAAW,SAAA;EAEX,UAAA;EAEA,sBAAA;EAEA,OAAA;EACA,KAAA;EAEA,WAAA,GAAc,6BAAA;EAEd,YAAA,GAAe,8BAAA;EAEf,UAAA;AAAA;AAAA,UAGe,YAAA;EACf,SAAA;EACA,eAAA,EAAiB,eAAA;EACjB,KAAA,EAAO,SAAA;EACP,MAAA,EAAQ,SAAA;EACR,UAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA,EAAU,aAAA;AAAA;AAAA,UAGK,gBAAA;EACf,KAAA,EAAO,YAAA;EACP,WAAA,EAAa,kBAAA;EACb,MAAA,EAAQ,kBAAA;EACR,SAAA;EACA,aAAA;AAAA;AAAA,UAGe,yBAAA;EACf,MAAA,EAAQ,gBAAgB;AAAA;AAAA,UAGT,+BAAA;EACf,MAAM;AAAA;AAAA,KAGI,mBAAA;EAEN,IAAA;AAAA;EAGA,IAAA;EACA,YAAA;EACA,eAAA,EAAiB,yBAAyB;AAAA;EAG1C,IAAA;EACA,KAAA;AAAA;EAGA,IAAA;EACA,MAAA;AAAA;AAAA,UAGW,iBAAA;EACf,WAAA;EACA,aAAA;EACA,MAAA,EAAQ,mBAAmB;EAC3B,SAAA;AAAA;AAAA,UAGe,iCAAA;EACf,UAAA,EAAY,iBAAiB;AAAA"}