@nadohq/engine-client 0.1.0-alpha.1

package/dist/EngineExecuteBuilder.cjs

@@ -0,0 +1,304 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/EngineExecuteBuilder.ts
+var EngineExecuteBuilder_exports = {};
+__export(EngineExecuteBuilder_exports, {
+  EngineExecuteBuilder: () => EngineExecuteBuilder
+});
+module.exports = __toCommonJS(EngineExecuteBuilder_exports);
+var import_contracts = require("@nadohq/contracts");
+var EngineExecuteBuilder = class {
+  constructor(engineClient) {
+    this.engineClient = engineClient;
+  }
+  /**
+   * Builds server payload for the `liquidate_subaccount` execute action.
+   * @param clientParams Client LiquidateSubaccount params.
+   * @returns `liquidate_subaccount` payload
+   */
+  async buildLiquidateSubaccountPayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("liquidate_subaccount", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "liquidate_subaccount",
+      paramsWithNonce
+    );
+    return {
+      signature,
+      tx
+    };
+  }
+  /**
+   * Builds server payload for the `withdraw_collateral` execute action.
+   * @param clientParams Client WithdrawCollateral params.
+   * @returns `liquidate_subaccount` payload
+   */
+  async buildWithdrawCollateralPayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const signature = await this.getSignatureIfNeeded(
+      "withdraw_collateral",
+      paramsWithNonce
+    );
+    const tx = (0, import_contracts.getNadoEIP712Values)("withdraw_collateral", paramsWithNonce);
+    return {
+      signature,
+      tx,
+      spot_leverage: clientParams.spotLeverage ?? null
+    };
+  }
+  /**
+   * Builds server payload for the `place_order` execute action.
+   *
+   * @param clientParams Client PlaceOrder params.
+   * @returns `place_order` payload
+   */
+  async buildPlaceOrderPayload(clientParams) {
+    const nonce = this.getOrderNonceIfNeeded(clientParams);
+    const orderWithNonce = { ...clientParams.order, nonce };
+    const signature = await this.getSignatureIfNeeded("place_order", {
+      // Gets expected type
+      ...clientParams,
+      ...orderWithNonce
+    });
+    return this.buildPlaceOrderPayloadSync({
+      ...clientParams,
+      order: orderWithNonce,
+      signature
+    });
+  }
+  /**
+   * Synchronously builds server payload for the `place_order` execute action.
+   *
+   * @param clientParams Client PlaceOrder params.
+   * @returns `place_order` payload
+   */
+  buildPlaceOrderPayloadSync(clientParams) {
+    const orderEIP712Values = (0, import_contracts.getNadoEIP712Values)(
+      "place_order",
+      clientParams.order
+    );
+    return {
+      payload: {
+        id: clientParams.id ?? null,
+        product_id: clientParams.productId,
+        order: orderEIP712Values,
+        signature: clientParams.signature,
+        spot_leverage: clientParams.spotLeverage ?? null
+      },
+      orderParams: clientParams.order
+    };
+  }
+  /**
+   * Builds server payload for the `place_isolated_order` execute action.
+   *
+   * @param clientParams Client PlaceIsolatedOrder params.
+   * @returns `place_isolated_order` payload
+   */
+  async buildIsolatedPlaceOrderPayload(clientParams) {
+    const nonce = this.getOrderNonceIfNeeded(clientParams);
+    const orderWithNonce = { ...clientParams.order, nonce };
+    const signature = await this.getSignatureIfNeeded("place_isolated_order", {
+      // Gets expected type
+      ...clientParams,
+      ...orderWithNonce
+    });
+    return this.buildPlaceIsolatedOrderPayloadSync({
+      ...clientParams,
+      order: orderWithNonce,
+      signature
+    });
+  }
+  /**
+   * Synchronously builds server payload for the `place_isolated_order` execute action.
+   *
+   * @param clientParams Client PlaceIsolatedOrder params.
+   * @returns `place_isolated_order` payload
+   */
+  buildPlaceIsolatedOrderPayloadSync(clientParams) {
+    const isolatedOrderEIP712Values = (0, import_contracts.getNadoEIP712Values)(
+      "place_isolated_order",
+      clientParams.order
+    );
+    return {
+      payload: {
+        id: clientParams.id ?? null,
+        product_id: clientParams.productId,
+        isolated_order: isolatedOrderEIP712Values,
+        signature: clientParams.signature,
+        borrow_margin: clientParams.borrowMargin ?? null
+      },
+      orderParams: clientParams.order
+    };
+  }
+  /**
+   * Builds server payload for the `cancel_orders` execute action. As such, requires a signature to be given
+   *
+   * @param clientParams Client CancelOrders params.
+   * @returns `cancel_orders` payload
+   */
+  async buildCancelOrdersPayload(clientParams) {
+    const nonce = this.getOrderNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const signature = await this.getSignatureIfNeeded(
+      "cancel_orders",
+      paramsWithNonce
+    );
+    return this.buildCancelOrdersPayloadSync({
+      ...paramsWithNonce,
+      signature
+    });
+  }
+  /**
+   * Synchronously builds server payload for the `cancel_orders` execute action.
+   *
+   * @param clientParams Client CancelOrders params.
+   * @returns `cancel_orders` payload
+   */
+  buildCancelOrdersPayloadSync(clientParams) {
+    const tx = (0, import_contracts.getNadoEIP712Values)("cancel_orders", clientParams);
+    return {
+      tx,
+      signature: clientParams.signature
+    };
+  }
+  /**
+   * Builds server payload for the `cancel_product_orders` execute action.
+   * @param clientParams Client CancelProductOrders params.
+   * @returns `cancel_product_orders` payload
+   */
+  async buildCancelProductOrdersPayload(clientParams) {
+    const nonce = this.getOrderNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("cancel_product_orders", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "cancel_product_orders",
+      paramsWithNonce
+    );
+    return {
+      tx,
+      signature
+    };
+  }
+  /**
+   * Builds server payload for the `link_signer` execute action.
+   *
+   * @param clientParams Client LinkSigner params.
+   * @returns `link_signer` payload
+   */
+  async buildLinkSignerPayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("link_signer", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "link_signer",
+      paramsWithNonce
+    );
+    return {
+      tx,
+      signature
+    };
+  }
+  /**
+   * Builds server payload for the `transfer_quote` execute action.
+   *
+   * @param clientParams Client TransferQuote params.
+   * @returns `transfer_quote` payload
+   */
+  async buildTransferQuotePayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("transfer_quote", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "transfer_quote",
+      paramsWithNonce
+    );
+    return {
+      tx,
+      signature
+    };
+  }
+  /**
+   * Builds server payload for the `mint_vlp` execute action.
+   * @param clientParams Client MintVlp params.
+   * @returns `mint_vlp` payload
+   */
+  async buildMintVlpPayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("mint_vlp", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "mint_vlp",
+      paramsWithNonce
+    );
+    return {
+      signature,
+      tx,
+      spot_leverage: clientParams.spotLeverage ?? null
+    };
+  }
+  /**
+   * Builds server payload for the `burn_vlp` execute action.
+   * @param clientParams Client BurnVlp params.
+   * @returns `burn_vlp` payload
+   */
+  async buildBurnVlpPayload(clientParams) {
+    const nonce = await this.getTxNonceIfNeeded(clientParams);
+    const paramsWithNonce = { ...clientParams, nonce };
+    const tx = (0, import_contracts.getNadoEIP712Values)("burn_vlp", paramsWithNonce);
+    const signature = await this.getSignatureIfNeeded(
+      "burn_vlp",
+      paramsWithNonce
+    );
+    return {
+      signature,
+      tx
+    };
+  }
+  async getSignatureIfNeeded(requestType, paramsWithNonce) {
+    if ("signature" in paramsWithNonce) {
+      return paramsWithNonce.signature;
+    }
+    return await this.engineClient.sign(
+      requestType,
+      paramsWithNonce.verifyingAddr,
+      paramsWithNonce.chainId,
+      paramsWithNonce
+    );
+  }
+  async getTxNonceIfNeeded(params) {
+    if (params.nonce) {
+      return params.nonce;
+    }
+    return await this.engineClient.getTxNonce(params.subaccountOwner);
+  }
+  getOrderNonceIfNeeded(params) {
+    if (params.nonce) {
+      return params.nonce;
+    }
+    return (0, import_contracts.getOrderNonce)();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EngineExecuteBuilder
+});
+//# sourceMappingURL=EngineExecuteBuilder.cjs.map

package/dist/EngineExecuteBuilder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/EngineExecuteBuilder.ts"],"sourcesContent":["import {\n  EIP712IsolatedOrderParams,\n  EIP712OrderParams,\n  getNadoEIP712Values,\n  getOrderNonce,\n  SignableRequestType,\n  SignableRequestTypeToParams,\n} from '@nadohq/contracts';\nimport { EngineBaseClient } from './EngineBaseClient';\nimport {\n  EngineExecuteRequestParamsByType,\n  EngineServerExecutePlaceIsolatedOrderPayload,\n  EngineServerExecutePlaceOrderPayload,\n  EngineServerExecuteRequestByType,\n  SignatureParams,\n  WithBaseEngineExecuteParams,\n  WithSignature,\n} from './types';\n\n/**\n * Builds execute payloads as expected by the server.\n * @param nonce A nonce is computed when one is not provided.\n * @param signature A signature is computed when one is not provided.\n */\nexport class EngineExecuteBuilder {\n  readonly engineClient: EngineBaseClient;\n\n  constructor(engineClient: EngineBaseClient) {\n    this.engineClient = engineClient;\n  }\n\n  /**\n   * Builds server payload for the `liquidate_subaccount` execute action.\n   * @param clientParams Client LiquidateSubaccount params.\n   * @returns `liquidate_subaccount` payload\n   */\n  async buildLiquidateSubaccountPayload(\n    clientParams: EngineExecuteRequestParamsByType['liquidate_subaccount'],\n  ): Promise<EngineServerExecuteRequestByType['liquidate_subaccount']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('liquidate_subaccount', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'liquidate_subaccount',\n      paramsWithNonce,\n    );\n\n    return {\n      signature,\n      tx,\n    };\n  }\n\n  /**\n   * Builds server payload for the `withdraw_collateral` execute action.\n   * @param clientParams Client WithdrawCollateral params.\n   * @returns `liquidate_subaccount` payload\n   */\n  async buildWithdrawCollateralPayload(\n    clientParams: EngineExecuteRequestParamsByType['withdraw_collateral'],\n  ): Promise<EngineServerExecuteRequestByType['withdraw_collateral']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const signature = await this.getSignatureIfNeeded(\n      'withdraw_collateral',\n      paramsWithNonce,\n    );\n\n    const tx = getNadoEIP712Values('withdraw_collateral', paramsWithNonce);\n    return {\n      signature,\n      tx,\n      spot_leverage: clientParams.spotLeverage ?? null,\n    };\n  }\n\n  /**\n   * Builds server payload for the `place_order` execute action.\n   *\n   * @param clientParams Client PlaceOrder params.\n   * @returns `place_order` payload\n   */\n  async buildPlaceOrderPayload(\n    clientParams: EngineExecuteRequestParamsByType['place_order'],\n  ): Promise<EngineServerExecutePlaceOrderPayload> {\n    const nonce = this.getOrderNonceIfNeeded(clientParams);\n    const orderWithNonce = { ...clientParams.order, nonce };\n\n    const signature = await this.getSignatureIfNeeded('place_order', {\n      // Gets expected type\n      ...clientParams,\n      ...orderWithNonce,\n    });\n\n    return this.buildPlaceOrderPayloadSync({\n      ...clientParams,\n      order: orderWithNonce,\n      signature,\n    });\n  }\n\n  /**\n   * Synchronously builds server payload for the `place_order` execute action.\n   *\n   * @param clientParams Client PlaceOrder params.\n   * @returns `place_order` payload\n   */\n  buildPlaceOrderPayloadSync(\n    clientParams: WithSignature<\n      EngineExecuteRequestParamsByType['place_order'] & {\n        order: EIP712OrderParams;\n      }\n    >,\n  ): EngineServerExecutePlaceOrderPayload {\n    const orderEIP712Values = getNadoEIP712Values(\n      'place_order',\n      clientParams.order,\n    );\n\n    return {\n      payload: {\n        id: clientParams.id ?? null,\n        product_id: clientParams.productId,\n        order: orderEIP712Values,\n        signature: clientParams.signature,\n        spot_leverage: clientParams.spotLeverage ?? null,\n      },\n      orderParams: clientParams.order,\n    };\n  }\n\n  /**\n   * Builds server payload for the `place_isolated_order` execute action.\n   *\n   * @param clientParams Client PlaceIsolatedOrder params.\n   * @returns `place_isolated_order` payload\n   */\n  async buildIsolatedPlaceOrderPayload(\n    clientParams: EngineExecuteRequestParamsByType['place_isolated_order'],\n  ): Promise<EngineServerExecutePlaceIsolatedOrderPayload> {\n    const nonce = this.getOrderNonceIfNeeded(clientParams);\n    const orderWithNonce = { ...clientParams.order, nonce };\n\n    const signature = await this.getSignatureIfNeeded('place_isolated_order', {\n      // Gets expected type\n      ...clientParams,\n      ...orderWithNonce,\n    });\n\n    return this.buildPlaceIsolatedOrderPayloadSync({\n      ...clientParams,\n      order: orderWithNonce,\n      signature,\n    });\n  }\n\n  /**\n   * Synchronously builds server payload for the `place_isolated_order` execute action.\n   *\n   * @param clientParams Client PlaceIsolatedOrder params.\n   * @returns `place_isolated_order` payload\n   */\n  buildPlaceIsolatedOrderPayloadSync(\n    clientParams: WithSignature<\n      EngineExecuteRequestParamsByType['place_isolated_order'] & {\n        order: EIP712IsolatedOrderParams;\n      }\n    >,\n  ): EngineServerExecutePlaceIsolatedOrderPayload {\n    const isolatedOrderEIP712Values = getNadoEIP712Values(\n      'place_isolated_order',\n      clientParams.order,\n    );\n\n    return {\n      payload: {\n        id: clientParams.id ?? null,\n        product_id: clientParams.productId,\n        isolated_order: isolatedOrderEIP712Values,\n        signature: clientParams.signature,\n        borrow_margin: clientParams.borrowMargin ?? null,\n      },\n      orderParams: clientParams.order,\n    };\n  }\n\n  /**\n   * Builds server payload for the `cancel_orders` execute action. As such, requires a signature to be given\n   *\n   * @param clientParams Client CancelOrders params.\n   * @returns `cancel_orders` payload\n   */\n  async buildCancelOrdersPayload(\n    clientParams: EngineExecuteRequestParamsByType['cancel_orders'],\n  ): Promise<EngineServerExecuteRequestByType['cancel_orders']> {\n    const nonce = this.getOrderNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n    const signature = await this.getSignatureIfNeeded(\n      'cancel_orders',\n      paramsWithNonce,\n    );\n\n    return this.buildCancelOrdersPayloadSync({\n      ...paramsWithNonce,\n      signature,\n    });\n  }\n\n  /**\n   * Synchronously builds server payload for the `cancel_orders` execute action.\n   *\n   * @param clientParams Client CancelOrders params.\n   * @returns `cancel_orders` payload\n   */\n  buildCancelOrdersPayloadSync(\n    clientParams: WithSignature<\n      EngineExecuteRequestParamsByType['cancel_orders'] & { nonce: string }\n    >,\n  ): EngineServerExecuteRequestByType['cancel_orders'] {\n    const tx = getNadoEIP712Values('cancel_orders', clientParams);\n\n    return {\n      tx,\n      signature: clientParams.signature,\n    };\n  }\n\n  /**\n   * Builds server payload for the `cancel_product_orders` execute action.\n   * @param clientParams Client CancelProductOrders params.\n   * @returns `cancel_product_orders` payload\n   */\n  async buildCancelProductOrdersPayload(\n    clientParams: EngineExecuteRequestParamsByType['cancel_product_orders'],\n  ): Promise<EngineServerExecuteRequestByType['cancel_product_orders']> {\n    const nonce = this.getOrderNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('cancel_product_orders', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'cancel_product_orders',\n      paramsWithNonce,\n    );\n\n    return {\n      tx,\n      signature,\n    };\n  }\n\n  /**\n   * Builds server payload for the `link_signer` execute action.\n   *\n   * @param clientParams Client LinkSigner params.\n   * @returns `link_signer` payload\n   */\n  async buildLinkSignerPayload(\n    clientParams: EngineExecuteRequestParamsByType['link_signer'],\n  ): Promise<EngineServerExecuteRequestByType['link_signer']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('link_signer', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'link_signer',\n      paramsWithNonce,\n    );\n\n    return {\n      tx,\n      signature,\n    };\n  }\n\n  /**\n   * Builds server payload for the `transfer_quote` execute action.\n   *\n   * @param clientParams Client TransferQuote params.\n   * @returns `transfer_quote` payload\n   */\n  async buildTransferQuotePayload(\n    clientParams: EngineExecuteRequestParamsByType['transfer_quote'],\n  ): Promise<EngineServerExecuteRequestByType['transfer_quote']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('transfer_quote', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'transfer_quote',\n      paramsWithNonce,\n    );\n\n    return {\n      tx,\n      signature,\n    };\n  }\n\n  /**\n   * Builds server payload for the `mint_vlp` execute action.\n   * @param clientParams Client MintVlp params.\n   * @returns `mint_vlp` payload\n   */\n  async buildMintVlpPayload(\n    clientParams: EngineExecuteRequestParamsByType['mint_vlp'],\n  ): Promise<EngineServerExecuteRequestByType['mint_vlp']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('mint_vlp', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'mint_vlp',\n      paramsWithNonce,\n    );\n\n    return {\n      signature,\n      tx,\n      spot_leverage: clientParams.spotLeverage ?? null,\n    };\n  }\n\n  /**\n   * Builds server payload for the `burn_vlp` execute action.\n   * @param clientParams Client BurnVlp params.\n   * @returns `burn_vlp` payload\n   */\n  async buildBurnVlpPayload(\n    clientParams: EngineExecuteRequestParamsByType['burn_vlp'],\n  ): Promise<EngineServerExecuteRequestByType['burn_vlp']> {\n    const nonce = await this.getTxNonceIfNeeded(clientParams);\n    const paramsWithNonce = { ...clientParams, nonce };\n\n    const tx = getNadoEIP712Values('burn_vlp', paramsWithNonce);\n    const signature = await this.getSignatureIfNeeded(\n      'burn_vlp',\n      paramsWithNonce,\n    );\n\n    return {\n      signature,\n      tx,\n    };\n  }\n\n  protected async getSignatureIfNeeded<T extends SignableRequestType>(\n    requestType: T,\n    paramsWithNonce: SignatureParams & SignableRequestTypeToParams[T],\n  ) {\n    if ('signature' in paramsWithNonce) {\n      return paramsWithNonce.signature;\n    }\n\n    return await this.engineClient.sign(\n      requestType,\n      paramsWithNonce.verifyingAddr,\n      paramsWithNonce.chainId,\n      paramsWithNonce,\n    );\n  }\n\n  protected async getTxNonceIfNeeded(\n    params: WithBaseEngineExecuteParams<{ subaccountOwner: string }>,\n  ) {\n    if (params.nonce) {\n      return params.nonce;\n    }\n    return await this.engineClient.getTxNonce(params.subaccountOwner);\n  }\n\n  protected getOrderNonceIfNeeded(\n    params: WithBaseEngineExecuteParams<unknown>,\n  ) {\n    if (params.nonce) {\n      return params.nonce;\n    }\n    return getOrderNonce();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAOO;AAiBA,IAAM,uBAAN,MAA2B;AAAA,EAGhC,YAAY,cAAgC;AAC1C,SAAK,eAAe;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,gCACJ,cACmE;AACnE,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,wBAAwB,eAAe;AACtE,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,+BACJ,cACkE;AAClE,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,UAAM,SAAK,sCAAoB,uBAAuB,eAAe;AACrE,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,eAAe,aAAa,gBAAgB;AAAA,IAC9C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,uBACJ,cAC+C;AAC/C,UAAM,QAAQ,KAAK,sBAAsB,YAAY;AACrD,UAAM,iBAAiB,EAAE,GAAG,aAAa,OAAO,MAAM;AAEtD,UAAM,YAAY,MAAM,KAAK,qBAAqB,eAAe;AAAA;AAAA,MAE/D,GAAG;AAAA,MACH,GAAG;AAAA,IACL,CAAC;AAED,WAAO,KAAK,2BAA2B;AAAA,MACrC,GAAG;AAAA,MACH,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,2BACE,cAKsC;AACtC,UAAM,wBAAoB;AAAA,MACxB;AAAA,MACA,aAAa;AAAA,IACf;AAEA,WAAO;AAAA,MACL,SAAS;AAAA,QACP,IAAI,aAAa,MAAM;AAAA,QACvB,YAAY,aAAa;AAAA,QACzB,OAAO;AAAA,QACP,WAAW,aAAa;AAAA,QACxB,eAAe,aAAa,gBAAgB;AAAA,MAC9C;AAAA,MACA,aAAa,aAAa;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,+BACJ,cACuD;AACvD,UAAM,QAAQ,KAAK,sBAAsB,YAAY;AACrD,UAAM,iBAAiB,EAAE,GAAG,aAAa,OAAO,MAAM;AAEtD,UAAM,YAAY,MAAM,KAAK,qBAAqB,wBAAwB;AAAA;AAAA,MAExE,GAAG;AAAA,MACH,GAAG;AAAA,IACL,CAAC;AAED,WAAO,KAAK,mCAAmC;AAAA,MAC7C,GAAG;AAAA,MACH,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,mCACE,cAK8C;AAC9C,UAAM,gCAA4B;AAAA,MAChC;AAAA,MACA,aAAa;AAAA,IACf;AAEA,WAAO;AAAA,MACL,SAAS;AAAA,QACP,IAAI,aAAa,MAAM;AAAA,QACvB,YAAY,aAAa;AAAA,QACzB,gBAAgB;AAAA,QAChB,WAAW,aAAa;AAAA,QACxB,eAAe,aAAa,gBAAgB;AAAA,MAC9C;AAAA,MACA,aAAa,aAAa;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,yBACJ,cAC4D;AAC5D,UAAM,QAAQ,KAAK,sBAAsB,YAAY;AACrD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AACjD,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO,KAAK,6BAA6B;AAAA,MACvC,GAAG;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,6BACE,cAGmD;AACnD,UAAM,SAAK,sCAAoB,iBAAiB,YAAY;AAE5D,WAAO;AAAA,MACL;AAAA,MACA,WAAW,aAAa;AAAA,IAC1B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,gCACJ,cACoE;AACpE,UAAM,QAAQ,KAAK,sBAAsB,YAAY;AACrD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,yBAAyB,eAAe;AACvE,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,uBACJ,cAC0D;AAC1D,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,eAAe,eAAe;AAC7D,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,0BACJ,cAC6D;AAC7D,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,kBAAkB,eAAe;AAChE,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,oBACJ,cACuD;AACvD,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,YAAY,eAAe;AAC1D,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,eAAe,aAAa,gBAAgB;AAAA,IAC9C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,oBACJ,cACuD;AACvD,UAAM,QAAQ,MAAM,KAAK,mBAAmB,YAAY;AACxD,UAAM,kBAAkB,EAAE,GAAG,cAAc,MAAM;AAEjD,UAAM,SAAK,sCAAoB,YAAY,eAAe;AAC1D,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAgB,qBACd,aACA,iBACA;AACA,QAAI,eAAe,iBAAiB;AAClC,aAAO,gBAAgB;AAAA,IACzB;AAEA,WAAO,MAAM,KAAK,aAAa;AAAA,MAC7B;AAAA,MACA,gBAAgB;AAAA,MAChB,gBAAgB;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAgB,mBACd,QACA;AACA,QAAI,OAAO,OAAO;AAChB,aAAO,OAAO;AAAA,IAChB;AACA,WAAO,MAAM,KAAK,aAAa,WAAW,OAAO,eAAe;AAAA,EAClE;AAAA,EAEU,sBACR,QACA;AACA,QAAI,OAAO,OAAO;AAChB,aAAO,OAAO;AAAA,IAChB;AACA,eAAO,gCAAc;AAAA,EACvB;AACF;","names":[]}

package/dist/EngineExecuteBuilder.d.cts

@@ -0,0 +1,118 @@
+import { EIP712OrderParams, EIP712IsolatedOrderParams, SignableRequestType, SignableRequestTypeToParams } from '@nadohq/contracts';
+import { EngineBaseClient } from './EngineBaseClient.cjs';
+import { EngineExecuteRequestParamsByType, WithSignature, SignatureParams, WithBaseEngineExecuteParams } from './types/clientExecuteTypes.cjs';
+import { EngineServerExecuteRequestByType, EngineServerExecutePlaceOrderPayload, EngineServerExecutePlaceIsolatedOrderPayload } from './types/serverExecuteTypes.cjs';
+import 'axios';
+import './types/clientQueryTypes.cjs';
+import '@nadohq/utils';
+import './types/serverQueryTypes.cjs';
+import './types/serverQueryModelTypes.cjs';
+
+/**
+ * Builds execute payloads as expected by the server.
+ * @param nonce A nonce is computed when one is not provided.
+ * @param signature A signature is computed when one is not provided.
+ */
+declare class EngineExecuteBuilder {
+    readonly engineClient: EngineBaseClient;
+    constructor(engineClient: EngineBaseClient);
+    /**
+     * Builds server payload for the `liquidate_subaccount` execute action.
+     * @param clientParams Client LiquidateSubaccount params.
+     * @returns `liquidate_subaccount` payload
+     */
+    buildLiquidateSubaccountPayload(clientParams: EngineExecuteRequestParamsByType['liquidate_subaccount']): Promise<EngineServerExecuteRequestByType['liquidate_subaccount']>;
+    /**
+     * Builds server payload for the `withdraw_collateral` execute action.
+     * @param clientParams Client WithdrawCollateral params.
+     * @returns `liquidate_subaccount` payload
+     */
+    buildWithdrawCollateralPayload(clientParams: EngineExecuteRequestParamsByType['withdraw_collateral']): Promise<EngineServerExecuteRequestByType['withdraw_collateral']>;
+    /**
+     * Builds server payload for the `place_order` execute action.
+     *
+     * @param clientParams Client PlaceOrder params.
+     * @returns `place_order` payload
+     */
+    buildPlaceOrderPayload(clientParams: EngineExecuteRequestParamsByType['place_order']): Promise<EngineServerExecutePlaceOrderPayload>;
+    /**
+     * Synchronously builds server payload for the `place_order` execute action.
+     *
+     * @param clientParams Client PlaceOrder params.
+     * @returns `place_order` payload
+     */
+    buildPlaceOrderPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['place_order'] & {
+        order: EIP712OrderParams;
+    }>): EngineServerExecutePlaceOrderPayload;
+    /**
+     * Builds server payload for the `place_isolated_order` execute action.
+     *
+     * @param clientParams Client PlaceIsolatedOrder params.
+     * @returns `place_isolated_order` payload
+     */
+    buildIsolatedPlaceOrderPayload(clientParams: EngineExecuteRequestParamsByType['place_isolated_order']): Promise<EngineServerExecutePlaceIsolatedOrderPayload>;
+    /**
+     * Synchronously builds server payload for the `place_isolated_order` execute action.
+     *
+     * @param clientParams Client PlaceIsolatedOrder params.
+     * @returns `place_isolated_order` payload
+     */
+    buildPlaceIsolatedOrderPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['place_isolated_order'] & {
+        order: EIP712IsolatedOrderParams;
+    }>): EngineServerExecutePlaceIsolatedOrderPayload;
+    /**
+     * Builds server payload for the `cancel_orders` execute action. As such, requires a signature to be given
+     *
+     * @param clientParams Client CancelOrders params.
+     * @returns `cancel_orders` payload
+     */
+    buildCancelOrdersPayload(clientParams: EngineExecuteRequestParamsByType['cancel_orders']): Promise<EngineServerExecuteRequestByType['cancel_orders']>;
+    /**
+     * Synchronously builds server payload for the `cancel_orders` execute action.
+     *
+     * @param clientParams Client CancelOrders params.
+     * @returns `cancel_orders` payload
+     */
+    buildCancelOrdersPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['cancel_orders'] & {
+        nonce: string;
+    }>): EngineServerExecuteRequestByType['cancel_orders'];
+    /**
+     * Builds server payload for the `cancel_product_orders` execute action.
+     * @param clientParams Client CancelProductOrders params.
+     * @returns `cancel_product_orders` payload
+     */
+    buildCancelProductOrdersPayload(clientParams: EngineExecuteRequestParamsByType['cancel_product_orders']): Promise<EngineServerExecuteRequestByType['cancel_product_orders']>;
+    /**
+     * Builds server payload for the `link_signer` execute action.
+     *
+     * @param clientParams Client LinkSigner params.
+     * @returns `link_signer` payload
+     */
+    buildLinkSignerPayload(clientParams: EngineExecuteRequestParamsByType['link_signer']): Promise<EngineServerExecuteRequestByType['link_signer']>;
+    /**
+     * Builds server payload for the `transfer_quote` execute action.
+     *
+     * @param clientParams Client TransferQuote params.
+     * @returns `transfer_quote` payload
+     */
+    buildTransferQuotePayload(clientParams: EngineExecuteRequestParamsByType['transfer_quote']): Promise<EngineServerExecuteRequestByType['transfer_quote']>;
+    /**
+     * Builds server payload for the `mint_vlp` execute action.
+     * @param clientParams Client MintVlp params.
+     * @returns `mint_vlp` payload
+     */
+    buildMintVlpPayload(clientParams: EngineExecuteRequestParamsByType['mint_vlp']): Promise<EngineServerExecuteRequestByType['mint_vlp']>;
+    /**
+     * Builds server payload for the `burn_vlp` execute action.
+     * @param clientParams Client BurnVlp params.
+     * @returns `burn_vlp` payload
+     */
+    buildBurnVlpPayload(clientParams: EngineExecuteRequestParamsByType['burn_vlp']): Promise<EngineServerExecuteRequestByType['burn_vlp']>;
+    protected getSignatureIfNeeded<T extends SignableRequestType>(requestType: T, paramsWithNonce: SignatureParams & SignableRequestTypeToParams[T]): Promise<string>;
+    protected getTxNonceIfNeeded(params: WithBaseEngineExecuteParams<{
+        subaccountOwner: string;
+    }>): Promise<string>;
+    protected getOrderNonceIfNeeded(params: WithBaseEngineExecuteParams<unknown>): string;
+}
+
+export { EngineExecuteBuilder };

package/dist/EngineExecuteBuilder.d.ts

@@ -0,0 +1,118 @@
+import { EIP712OrderParams, EIP712IsolatedOrderParams, SignableRequestType, SignableRequestTypeToParams } from '@nadohq/contracts';
+import { EngineBaseClient } from './EngineBaseClient.js';
+import { EngineExecuteRequestParamsByType, WithSignature, SignatureParams, WithBaseEngineExecuteParams } from './types/clientExecuteTypes.js';
+import { EngineServerExecuteRequestByType, EngineServerExecutePlaceOrderPayload, EngineServerExecutePlaceIsolatedOrderPayload } from './types/serverExecuteTypes.js';
+import 'axios';
+import './types/clientQueryTypes.js';
+import '@nadohq/utils';
+import './types/serverQueryTypes.js';
+import './types/serverQueryModelTypes.js';
+
+/**
+ * Builds execute payloads as expected by the server.
+ * @param nonce A nonce is computed when one is not provided.
+ * @param signature A signature is computed when one is not provided.
+ */
+declare class EngineExecuteBuilder {
+    readonly engineClient: EngineBaseClient;
+    constructor(engineClient: EngineBaseClient);
+    /**
+     * Builds server payload for the `liquidate_subaccount` execute action.
+     * @param clientParams Client LiquidateSubaccount params.
+     * @returns `liquidate_subaccount` payload
+     */
+    buildLiquidateSubaccountPayload(clientParams: EngineExecuteRequestParamsByType['liquidate_subaccount']): Promise<EngineServerExecuteRequestByType['liquidate_subaccount']>;
+    /**
+     * Builds server payload for the `withdraw_collateral` execute action.
+     * @param clientParams Client WithdrawCollateral params.
+     * @returns `liquidate_subaccount` payload
+     */
+    buildWithdrawCollateralPayload(clientParams: EngineExecuteRequestParamsByType['withdraw_collateral']): Promise<EngineServerExecuteRequestByType['withdraw_collateral']>;
+    /**
+     * Builds server payload for the `place_order` execute action.
+     *
+     * @param clientParams Client PlaceOrder params.
+     * @returns `place_order` payload
+     */
+    buildPlaceOrderPayload(clientParams: EngineExecuteRequestParamsByType['place_order']): Promise<EngineServerExecutePlaceOrderPayload>;
+    /**
+     * Synchronously builds server payload for the `place_order` execute action.
+     *
+     * @param clientParams Client PlaceOrder params.
+     * @returns `place_order` payload
+     */
+    buildPlaceOrderPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['place_order'] & {
+        order: EIP712OrderParams;
+    }>): EngineServerExecutePlaceOrderPayload;
+    /**
+     * Builds server payload for the `place_isolated_order` execute action.
+     *
+     * @param clientParams Client PlaceIsolatedOrder params.
+     * @returns `place_isolated_order` payload
+     */
+    buildIsolatedPlaceOrderPayload(clientParams: EngineExecuteRequestParamsByType['place_isolated_order']): Promise<EngineServerExecutePlaceIsolatedOrderPayload>;
+    /**
+     * Synchronously builds server payload for the `place_isolated_order` execute action.
+     *
+     * @param clientParams Client PlaceIsolatedOrder params.
+     * @returns `place_isolated_order` payload
+     */
+    buildPlaceIsolatedOrderPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['place_isolated_order'] & {
+        order: EIP712IsolatedOrderParams;
+    }>): EngineServerExecutePlaceIsolatedOrderPayload;
+    /**
+     * Builds server payload for the `cancel_orders` execute action. As such, requires a signature to be given
+     *
+     * @param clientParams Client CancelOrders params.
+     * @returns `cancel_orders` payload
+     */
+    buildCancelOrdersPayload(clientParams: EngineExecuteRequestParamsByType['cancel_orders']): Promise<EngineServerExecuteRequestByType['cancel_orders']>;
+    /**
+     * Synchronously builds server payload for the `cancel_orders` execute action.
+     *
+     * @param clientParams Client CancelOrders params.
+     * @returns `cancel_orders` payload
+     */
+    buildCancelOrdersPayloadSync(clientParams: WithSignature<EngineExecuteRequestParamsByType['cancel_orders'] & {
+        nonce: string;
+    }>): EngineServerExecuteRequestByType['cancel_orders'];
+    /**
+     * Builds server payload for the `cancel_product_orders` execute action.
+     * @param clientParams Client CancelProductOrders params.
+     * @returns `cancel_product_orders` payload
+     */
+    buildCancelProductOrdersPayload(clientParams: EngineExecuteRequestParamsByType['cancel_product_orders']): Promise<EngineServerExecuteRequestByType['cancel_product_orders']>;
+    /**
+     * Builds server payload for the `link_signer` execute action.
+     *
+     * @param clientParams Client LinkSigner params.
+     * @returns `link_signer` payload
+     */
+    buildLinkSignerPayload(clientParams: EngineExecuteRequestParamsByType['link_signer']): Promise<EngineServerExecuteRequestByType['link_signer']>;
+    /**
+     * Builds server payload for the `transfer_quote` execute action.
+     *
+     * @param clientParams Client TransferQuote params.
+     * @returns `transfer_quote` payload
+     */
+    buildTransferQuotePayload(clientParams: EngineExecuteRequestParamsByType['transfer_quote']): Promise<EngineServerExecuteRequestByType['transfer_quote']>;
+    /**
+     * Builds server payload for the `mint_vlp` execute action.
+     * @param clientParams Client MintVlp params.
+     * @returns `mint_vlp` payload
+     */
+    buildMintVlpPayload(clientParams: EngineExecuteRequestParamsByType['mint_vlp']): Promise<EngineServerExecuteRequestByType['mint_vlp']>;
+    /**
+     * Builds server payload for the `burn_vlp` execute action.
+     * @param clientParams Client BurnVlp params.
+     * @returns `burn_vlp` payload
+     */
+    buildBurnVlpPayload(clientParams: EngineExecuteRequestParamsByType['burn_vlp']): Promise<EngineServerExecuteRequestByType['burn_vlp']>;
+    protected getSignatureIfNeeded<T extends SignableRequestType>(requestType: T, paramsWithNonce: SignatureParams & SignableRequestTypeToParams[T]): Promise<string>;
+    protected getTxNonceIfNeeded(params: WithBaseEngineExecuteParams<{
+        subaccountOwner: string;
+    }>): Promise<string>;
+    protected getOrderNonceIfNeeded(params: WithBaseEngineExecuteParams<unknown>): string;
+}
+
+export { EngineExecuteBuilder };