@nadohq/engine-client 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,2 @@
+# `@nadohq/engine-client`
+

package/dist/EngineBaseClient.cjs

@@ -0,0 +1,166 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/EngineBaseClient.ts
+var EngineBaseClient_exports = {};
+__export(EngineBaseClient_exports, {
+  EngineBaseClient: () => EngineBaseClient
+});
+module.exports = __toCommonJS(EngineBaseClient_exports);
+var import_contracts = require("@nadohq/contracts");
+var import_utils = require("@nadohq/utils");
+var import_axios = __toESM(require("axios"), 1);
+var import_EngineServerFailureError = require("./types/EngineServerFailureError.cjs");
+var EngineBaseClient = class {
+  constructor(opts) {
+    this.opts = opts;
+    this.axiosInstance = import_axios.default.create({
+      withCredentials: true
+    });
+  }
+  /**
+   * Sets the linked signer for execute requests
+   *
+   * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer
+   */
+  setLinkedSigner(linkedSignerWalletClient) {
+    this.opts.linkedSignerWalletClient = linkedSignerWalletClient ?? void 0;
+  }
+  async getTxNonce(address) {
+    const addr = address ?? this.opts.walletClient?.account.address;
+    if (!addr) {
+      throw new import_utils.WalletNotProvidedError();
+    }
+    return (await this.getNonces({
+      address: addr
+    })).txNonce;
+  }
+  async getNonces(params) {
+    const baseResp = await this.query("nonces", params);
+    return {
+      orderNonce: baseResp.order_nonce,
+      txNonce: baseResp.tx_nonce
+    };
+  }
+  /**
+   * Queries the engine, all query params are stringified into the query string
+   *
+   * @param requestType
+   * @param params
+   * @public
+   */
+  async query(requestType, params) {
+    const request = this.getQueryRequest(requestType, params);
+    const response = await this.axiosInstance.post(
+      `${this.opts.url}/query`,
+      request
+    );
+    this.checkResponseStatus(response);
+    this.checkServerStatus(response);
+    const successResponse = response;
+    return successResponse.data.data;
+  }
+  /**
+   * A simple, typechecked fn for constructing a query request in the format expected by the server.
+   *
+   * @param requestType
+   * @param params
+   */
+  getQueryRequest(requestType, params) {
+    return {
+      type: requestType,
+      ...params
+    };
+  }
+  /**
+   * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped
+   * in an EngineServerFailureError on failure.
+   *
+   * @param requestType
+   * @param params
+   * @public
+   */
+  async execute(requestType, params) {
+    const reqBody = this.getExecuteRequest(requestType, params);
+    const response = await this.axiosInstance.post(`${this.opts.url}/execute`, reqBody);
+    this.checkResponseStatus(response);
+    this.checkServerStatus(response);
+    return response.data;
+  }
+  /**
+   * A simple, typechecked fn for constructing an execute request in the format expected by the server.
+   *
+   * @param requestType
+   * @param params
+   */
+  getExecuteRequest(requestType, params) {
+    return {
+      [requestType]: params
+    };
+  }
+  /**
+   * Signs a given request with the signer provided to the engine
+   *
+   * @param requestType
+   * @param verifyingContract
+   * @param chainId
+   * @param params
+   * @public
+   */
+  async sign(requestType, verifyingContract, chainId, params) {
+    const walletClient = this.opts.linkedSignerWalletClient ?? this.opts.walletClient;
+    if (!walletClient) {
+      throw new import_utils.WalletNotProvidedError();
+    }
+    return (0, import_contracts.getSignedTransactionRequest)({
+      chainId,
+      requestParams: params,
+      requestType,
+      walletClient,
+      verifyingContract
+    });
+  }
+  checkResponseStatus(response) {
+    if (response.status !== 200 || !response.data) {
+      throw Error(
+        `Unexpected response from server: ${response.status} ${response.statusText}`
+      );
+    }
+  }
+  checkServerStatus(response) {
+    if (response.data.status !== "success") {
+      throw new import_EngineServerFailureError.EngineServerFailureError(response.data);
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EngineBaseClient
+});
+//# sourceMappingURL=EngineBaseClient.cjs.map

package/dist/EngineBaseClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/EngineBaseClient.ts"],"sourcesContent":["import {\n  getSignedTransactionRequest,\n  SignableRequestType,\n  SignableRequestTypeToParams,\n  WalletClientWithAccount,\n} from '@nadohq/contracts';\nimport { WalletNotProvidedError } from '@nadohq/utils';\nimport axios, { AxiosInstance, AxiosResponse } from 'axios';\nimport {\n  EngineServerExecuteRequestByType,\n  EngineServerExecuteRequestType,\n  EngineServerExecuteResult,\n  EngineServerExecuteSuccessResult,\n  EngineServerQueryRequest,\n  EngineServerQueryRequestByType,\n  EngineServerQueryRequestType,\n  EngineServerQueryResponse,\n  EngineServerQueryResponseByType,\n  EngineServerQuerySuccessResponse,\n  GetEngineNoncesParams,\n  GetEngineNoncesResponse,\n} from './types';\nimport { EngineServerFailureError } from './types/EngineServerFailureError';\n\nexport interface EngineClientOpts {\n  // Server URL\n  url: string;\n  // Wallet client for EIP712 signing\n  walletClient?: WalletClientWithAccount;\n  // Linked signer registered through the engine, if provided, execute requests will use this signer\n  linkedSignerWalletClient?: WalletClientWithAccount;\n}\n\n// Only 1 key can be defined per execute request\ntype EngineExecuteRequestBody = Partial<EngineServerExecuteRequestByType>;\n\ntype EngineQueryRequestResponse<\n  T extends EngineServerQueryRequestType = EngineServerQueryRequestType,\n> = EngineServerQueryResponse<T>;\n\n/**\n * Base client for all engine requests\n */\nexport class EngineBaseClient {\n  readonly opts: EngineClientOpts;\n  readonly axiosInstance: AxiosInstance;\n\n  constructor(opts: EngineClientOpts) {\n    this.opts = opts;\n    this.axiosInstance = axios.create({\n      withCredentials: true,\n    });\n  }\n\n  /**\n   * Sets the linked signer for execute requests\n   *\n   * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer\n   */\n  public setLinkedSigner(\n    linkedSignerWalletClient: WalletClientWithAccount | null,\n  ) {\n    this.opts.linkedSignerWalletClient = linkedSignerWalletClient ?? undefined;\n  }\n\n  public async getTxNonce(address?: string): Promise<string> {\n    const addr = address ?? this.opts.walletClient?.account.address;\n\n    if (!addr) {\n      throw new WalletNotProvidedError();\n    }\n\n    return (\n      await this.getNonces({\n        address: addr,\n      })\n    ).txNonce;\n  }\n\n  public async getNonces(\n    params: GetEngineNoncesParams,\n  ): Promise<GetEngineNoncesResponse> {\n    const baseResp = await this.query('nonces', params);\n\n    return {\n      orderNonce: baseResp.order_nonce,\n      txNonce: baseResp.tx_nonce,\n    };\n  }\n\n  /**\n   * Queries the engine, all query params are stringified into the query string\n   *\n   * @param requestType\n   * @param params\n   * @public\n   */\n  public async query<TRequestType extends EngineServerQueryRequestType>(\n    requestType: TRequestType,\n    params: EngineServerQueryRequestByType[TRequestType],\n  ): Promise<EngineServerQueryResponseByType[TRequestType]> {\n    const request = this.getQueryRequest(requestType, params);\n    const response = await this.axiosInstance.post<EngineQueryRequestResponse>(\n      `${this.opts.url}/query`,\n      request,\n    );\n\n    this.checkResponseStatus(response);\n    this.checkServerStatus(response);\n\n    // checkServerStatus throws on failure responses so the cast to the success response is acceptable here\n    const successResponse = response as AxiosResponse<\n      EngineServerQuerySuccessResponse<TRequestType>\n    >;\n\n    return successResponse.data.data;\n  }\n\n  /**\n   * A simple, typechecked fn for constructing a query request in the format expected by the server.\n   *\n   * @param requestType\n   * @param params\n   */\n  public getQueryRequest<TRequestType extends EngineServerQueryRequestType>(\n    requestType: TRequestType,\n    params: EngineServerQueryRequestByType[TRequestType],\n  ): EngineServerQueryRequest<TRequestType> {\n    return {\n      type: requestType,\n      ...params,\n    };\n  }\n\n  /**\n   * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped\n   * in an EngineServerFailureError on failure.\n   *\n   * @param requestType\n   * @param params\n   * @public\n   */\n  public async execute<TRequestType extends EngineServerExecuteRequestType>(\n    requestType: TRequestType,\n    params: EngineServerExecuteRequestByType[TRequestType],\n  ): Promise<EngineServerExecuteSuccessResult<TRequestType>> {\n    const reqBody = this.getExecuteRequest(requestType, params);\n    const response = await this.axiosInstance.post<\n      EngineServerExecuteResult<TRequestType>\n    >(`${this.opts.url}/execute`, reqBody);\n\n    this.checkResponseStatus(response);\n    this.checkServerStatus(response);\n\n    // checkServerStatus catches the failure result and throws the error, so the cast to the success response is acceptable here\n    return response.data as EngineServerExecuteSuccessResult<TRequestType>;\n  }\n\n  /**\n   * A simple, typechecked fn for constructing an execute request in the format expected by the server.\n   *\n   * @param requestType\n   * @param params\n   */\n  public getExecuteRequest<TRequestType extends EngineServerExecuteRequestType>(\n    requestType: TRequestType,\n    params: EngineServerExecuteRequestByType[TRequestType],\n  ): EngineExecuteRequestBody {\n    return {\n      [requestType]: params,\n    };\n  }\n\n  /**\n   * Signs a given request with the signer provided to the engine\n   *\n   * @param requestType\n   * @param verifyingContract\n   * @param chainId\n   * @param params\n   * @public\n   */\n  public async sign<T extends SignableRequestType>(\n    requestType: T,\n    verifyingContract: string,\n    chainId: number,\n    params: SignableRequestTypeToParams[T],\n  ) {\n    // Use the linked signer if provided, otherwise use the default signer provided to the engine\n    const walletClient =\n      this.opts.linkedSignerWalletClient ?? this.opts.walletClient;\n\n    if (!walletClient) {\n      throw new WalletNotProvidedError();\n    }\n\n    return getSignedTransactionRequest({\n      chainId,\n      requestParams: params,\n      requestType,\n      walletClient,\n      verifyingContract,\n    });\n  }\n\n  private checkResponseStatus(response: AxiosResponse) {\n    if (response.status !== 200 || !response.data) {\n      throw Error(\n        `Unexpected response from server: ${response.status} ${response.statusText}`,\n      );\n    }\n  }\n\n  private checkServerStatus(\n    response: AxiosResponse<\n      EngineServerExecuteResult | EngineQueryRequestResponse\n    >,\n  ) {\n    if (response.data.status !== 'success') {\n      throw new EngineServerFailureError(response.data);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAKO;AACP,mBAAuC;AACvC,mBAAoD;AAepD,sCAAyC;AAqBlC,IAAM,mBAAN,MAAuB;AAAA,EAI5B,YAAY,MAAwB;AAClC,SAAK,OAAO;AACZ,SAAK,gBAAgB,aAAAA,QAAM,OAAO;AAAA,MAChC,iBAAiB;AAAA,IACnB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,gBACL,0BACA;AACA,SAAK,KAAK,2BAA2B,4BAA4B;AAAA,EACnE;AAAA,EAEA,MAAa,WAAW,SAAmC;AACzD,UAAM,OAAO,WAAW,KAAK,KAAK,cAAc,QAAQ;AAExD,QAAI,CAAC,MAAM;AACT,YAAM,IAAI,oCAAuB;AAAA,IACnC;AAEA,YACE,MAAM,KAAK,UAAU;AAAA,MACnB,SAAS;AAAA,IACX,CAAC,GACD;AAAA,EACJ;AAAA,EAEA,MAAa,UACX,QACkC;AAClC,UAAM,WAAW,MAAM,KAAK,MAAM,UAAU,MAAM;AAElD,WAAO;AAAA,MACL,YAAY,SAAS;AAAA,MACrB,SAAS,SAAS;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,MACX,aACA,QACwD;AACxD,UAAM,UAAU,KAAK,gBAAgB,aAAa,MAAM;AACxD,UAAM,WAAW,MAAM,KAAK,cAAc;AAAA,MACxC,GAAG,KAAK,KAAK,GAAG;AAAA,MAChB;AAAA,IACF;AAEA,SAAK,oBAAoB,QAAQ;AACjC,SAAK,kBAAkB,QAAQ;AAG/B,UAAM,kBAAkB;AAIxB,WAAO,gBAAgB,KAAK;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,gBACL,aACA,QACwC;AACxC,WAAO;AAAA,MACL,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,QACX,aACA,QACyD;AACzD,UAAM,UAAU,KAAK,kBAAkB,aAAa,MAAM;AAC1D,UAAM,WAAW,MAAM,KAAK,cAAc,KAExC,GAAG,KAAK,KAAK,GAAG,YAAY,OAAO;AAErC,SAAK,oBAAoB,QAAQ;AACjC,SAAK,kBAAkB,QAAQ;AAG/B,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,kBACL,aACA,QAC0B;AAC1B,WAAO;AAAA,MACL,CAAC,WAAW,GAAG;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAa,KACX,aACA,mBACA,SACA,QACA;AAEA,UAAM,eACJ,KAAK,KAAK,4BAA4B,KAAK,KAAK;AAElD,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,oCAAuB;AAAA,IACnC;AAEA,eAAO,8CAA4B;AAAA,MACjC;AAAA,MACA,eAAe;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,oBAAoB,UAAyB;AACnD,QAAI,SAAS,WAAW,OAAO,CAAC,SAAS,MAAM;AAC7C,YAAM;AAAA,QACJ,oCAAoC,SAAS,MAAM,IAAI,SAAS,UAAU;AAAA,MAC5E;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,kBACN,UAGA;AACA,QAAI,SAAS,KAAK,WAAW,WAAW;AACtC,YAAM,IAAI,yDAAyB,SAAS,IAAI;AAAA,IAClD;AAAA,EACF;AACF;","names":["axios"]}

package/dist/EngineBaseClient.d.cts

@@ -0,0 +1,75 @@
+import { WalletClientWithAccount, SignableRequestType, SignableRequestTypeToParams } from '@nadohq/contracts';
+import { AxiosInstance } from 'axios';
+import { GetEngineNoncesParams, GetEngineNoncesResponse } from './types/clientQueryTypes.cjs';
+import { EngineServerExecuteRequestType, EngineServerExecuteRequestByType, EngineServerExecuteSuccessResult } from './types/serverExecuteTypes.cjs';
+import { EngineServerQueryRequestType, EngineServerQueryRequestByType, EngineServerQueryResponseByType, EngineServerQueryRequest } from './types/serverQueryTypes.cjs';
+import '@nadohq/utils';
+import './types/serverQueryModelTypes.cjs';
+
+interface EngineClientOpts {
+    url: string;
+    walletClient?: WalletClientWithAccount;
+    linkedSignerWalletClient?: WalletClientWithAccount;
+}
+type EngineExecuteRequestBody = Partial<EngineServerExecuteRequestByType>;
+/**
+ * Base client for all engine requests
+ */
+declare class EngineBaseClient {
+    readonly opts: EngineClientOpts;
+    readonly axiosInstance: AxiosInstance;
+    constructor(opts: EngineClientOpts);
+    /**
+     * Sets the linked signer for execute requests
+     *
+     * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer
+     */
+    setLinkedSigner(linkedSignerWalletClient: WalletClientWithAccount | null): void;
+    getTxNonce(address?: string): Promise<string>;
+    getNonces(params: GetEngineNoncesParams): Promise<GetEngineNoncesResponse>;
+    /**
+     * Queries the engine, all query params are stringified into the query string
+     *
+     * @param requestType
+     * @param params
+     * @public
+     */
+    query<TRequestType extends EngineServerQueryRequestType>(requestType: TRequestType, params: EngineServerQueryRequestByType[TRequestType]): Promise<EngineServerQueryResponseByType[TRequestType]>;
+    /**
+     * A simple, typechecked fn for constructing a query request in the format expected by the server.
+     *
+     * @param requestType
+     * @param params
+     */
+    getQueryRequest<TRequestType extends EngineServerQueryRequestType>(requestType: TRequestType, params: EngineServerQueryRequestByType[TRequestType]): EngineServerQueryRequest<TRequestType>;
+    /**
+     * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped
+     * in an EngineServerFailureError on failure.
+     *
+     * @param requestType
+     * @param params
+     * @public
+     */
+    execute<TRequestType extends EngineServerExecuteRequestType>(requestType: TRequestType, params: EngineServerExecuteRequestByType[TRequestType]): Promise<EngineServerExecuteSuccessResult<TRequestType>>;
+    /**
+     * A simple, typechecked fn for constructing an execute request in the format expected by the server.
+     *
+     * @param requestType
+     * @param params
+     */
+    getExecuteRequest<TRequestType extends EngineServerExecuteRequestType>(requestType: TRequestType, params: EngineServerExecuteRequestByType[TRequestType]): EngineExecuteRequestBody;
+    /**
+     * Signs a given request with the signer provided to the engine
+     *
+     * @param requestType
+     * @param verifyingContract
+     * @param chainId
+     * @param params
+     * @public
+     */
+    sign<T extends SignableRequestType>(requestType: T, verifyingContract: string, chainId: number, params: SignableRequestTypeToParams[T]): Promise<`0x${string}`>;
+    private checkResponseStatus;
+    private checkServerStatus;
+}
+
+export { EngineBaseClient, type EngineClientOpts };

package/dist/EngineBaseClient.d.ts

@@ -0,0 +1,75 @@
+import { WalletClientWithAccount, SignableRequestType, SignableRequestTypeToParams } from '@nadohq/contracts';
+import { AxiosInstance } from 'axios';
+import { GetEngineNoncesParams, GetEngineNoncesResponse } from './types/clientQueryTypes.js';
+import { EngineServerExecuteRequestType, EngineServerExecuteRequestByType, EngineServerExecuteSuccessResult } from './types/serverExecuteTypes.js';
+import { EngineServerQueryRequestType, EngineServerQueryRequestByType, EngineServerQueryResponseByType, EngineServerQueryRequest } from './types/serverQueryTypes.js';
+import '@nadohq/utils';
+import './types/serverQueryModelTypes.js';
+
+interface EngineClientOpts {
+    url: string;
+    walletClient?: WalletClientWithAccount;
+    linkedSignerWalletClient?: WalletClientWithAccount;
+}
+type EngineExecuteRequestBody = Partial<EngineServerExecuteRequestByType>;
+/**
+ * Base client for all engine requests
+ */
+declare class EngineBaseClient {
+    readonly opts: EngineClientOpts;
+    readonly axiosInstance: AxiosInstance;
+    constructor(opts: EngineClientOpts);
+    /**
+     * Sets the linked signer for execute requests
+     *
+     * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer
+     */
+    setLinkedSigner(linkedSignerWalletClient: WalletClientWithAccount | null): void;
+    getTxNonce(address?: string): Promise<string>;
+    getNonces(params: GetEngineNoncesParams): Promise<GetEngineNoncesResponse>;
+    /**
+     * Queries the engine, all query params are stringified into the query string
+     *
+     * @param requestType
+     * @param params
+     * @public
+     */
+    query<TRequestType extends EngineServerQueryRequestType>(requestType: TRequestType, params: EngineServerQueryRequestByType[TRequestType]): Promise<EngineServerQueryResponseByType[TRequestType]>;
+    /**
+     * A simple, typechecked fn for constructing a query request in the format expected by the server.
+     *
+     * @param requestType
+     * @param params
+     */
+    getQueryRequest<TRequestType extends EngineServerQueryRequestType>(requestType: TRequestType, params: EngineServerQueryRequestByType[TRequestType]): EngineServerQueryRequest<TRequestType>;
+    /**
+     * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped
+     * in an EngineServerFailureError on failure.
+     *
+     * @param requestType
+     * @param params
+     * @public
+     */
+    execute<TRequestType extends EngineServerExecuteRequestType>(requestType: TRequestType, params: EngineServerExecuteRequestByType[TRequestType]): Promise<EngineServerExecuteSuccessResult<TRequestType>>;
+    /**
+     * A simple, typechecked fn for constructing an execute request in the format expected by the server.
+     *
+     * @param requestType
+     * @param params
+     */
+    getExecuteRequest<TRequestType extends EngineServerExecuteRequestType>(requestType: TRequestType, params: EngineServerExecuteRequestByType[TRequestType]): EngineExecuteRequestBody;
+    /**
+     * Signs a given request with the signer provided to the engine
+     *
+     * @param requestType
+     * @param verifyingContract
+     * @param chainId
+     * @param params
+     * @public
+     */
+    sign<T extends SignableRequestType>(requestType: T, verifyingContract: string, chainId: number, params: SignableRequestTypeToParams[T]): Promise<`0x${string}`>;
+    private checkResponseStatus;
+    private checkServerStatus;
+}
+
+export { EngineBaseClient, type EngineClientOpts };

package/dist/EngineBaseClient.js

@@ -0,0 +1,133 @@
+// src/EngineBaseClient.ts
+import {
+  getSignedTransactionRequest
+} from "@nadohq/contracts";
+import { WalletNotProvidedError } from "@nadohq/utils";
+import axios from "axios";
+import { EngineServerFailureError } from "./types/EngineServerFailureError.js";
+var EngineBaseClient = class {
+  constructor(opts) {
+    this.opts = opts;
+    this.axiosInstance = axios.create({
+      withCredentials: true
+    });
+  }
+  /**
+   * Sets the linked signer for execute requests
+   *
+   * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer
+   */
+  setLinkedSigner(linkedSignerWalletClient) {
+    this.opts.linkedSignerWalletClient = linkedSignerWalletClient ?? void 0;
+  }
+  async getTxNonce(address) {
+    const addr = address ?? this.opts.walletClient?.account.address;
+    if (!addr) {
+      throw new WalletNotProvidedError();
+    }
+    return (await this.getNonces({
+      address: addr
+    })).txNonce;
+  }
+  async getNonces(params) {
+    const baseResp = await this.query("nonces", params);
+    return {
+      orderNonce: baseResp.order_nonce,
+      txNonce: baseResp.tx_nonce
+    };
+  }
+  /**
+   * Queries the engine, all query params are stringified into the query string
+   *
+   * @param requestType
+   * @param params
+   * @public
+   */
+  async query(requestType, params) {
+    const request = this.getQueryRequest(requestType, params);
+    const response = await this.axiosInstance.post(
+      `${this.opts.url}/query`,
+      request
+    );
+    this.checkResponseStatus(response);
+    this.checkServerStatus(response);
+    const successResponse = response;
+    return successResponse.data.data;
+  }
+  /**
+   * A simple, typechecked fn for constructing a query request in the format expected by the server.
+   *
+   * @param requestType
+   * @param params
+   */
+  getQueryRequest(requestType, params) {
+    return {
+      type: requestType,
+      ...params
+    };
+  }
+  /**
+   * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped
+   * in an EngineServerFailureError on failure.
+   *
+   * @param requestType
+   * @param params
+   * @public
+   */
+  async execute(requestType, params) {
+    const reqBody = this.getExecuteRequest(requestType, params);
+    const response = await this.axiosInstance.post(`${this.opts.url}/execute`, reqBody);
+    this.checkResponseStatus(response);
+    this.checkServerStatus(response);
+    return response.data;
+  }
+  /**
+   * A simple, typechecked fn for constructing an execute request in the format expected by the server.
+   *
+   * @param requestType
+   * @param params
+   */
+  getExecuteRequest(requestType, params) {
+    return {
+      [requestType]: params
+    };
+  }
+  /**
+   * Signs a given request with the signer provided to the engine
+   *
+   * @param requestType
+   * @param verifyingContract
+   * @param chainId
+   * @param params
+   * @public
+   */
+  async sign(requestType, verifyingContract, chainId, params) {
+    const walletClient = this.opts.linkedSignerWalletClient ?? this.opts.walletClient;
+    if (!walletClient) {
+      throw new WalletNotProvidedError();
+    }
+    return getSignedTransactionRequest({
+      chainId,
+      requestParams: params,
+      requestType,
+      walletClient,
+      verifyingContract
+    });
+  }
+  checkResponseStatus(response) {
+    if (response.status !== 200 || !response.data) {
+      throw Error(
+        `Unexpected response from server: ${response.status} ${response.statusText}`
+      );
+    }
+  }
+  checkServerStatus(response) {
+    if (response.data.status !== "success") {
+      throw new EngineServerFailureError(response.data);
+    }
+  }
+};
+export {
+  EngineBaseClient
+};
+//# sourceMappingURL=EngineBaseClient.js.map

package/dist/EngineBaseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/EngineBaseClient.ts"],"sourcesContent":["import {\n  getSignedTransactionRequest,\n  SignableRequestType,\n  SignableRequestTypeToParams,\n  WalletClientWithAccount,\n} from '@nadohq/contracts';\nimport { WalletNotProvidedError } from '@nadohq/utils';\nimport axios, { AxiosInstance, AxiosResponse } from 'axios';\nimport {\n  EngineServerExecuteRequestByType,\n  EngineServerExecuteRequestType,\n  EngineServerExecuteResult,\n  EngineServerExecuteSuccessResult,\n  EngineServerQueryRequest,\n  EngineServerQueryRequestByType,\n  EngineServerQueryRequestType,\n  EngineServerQueryResponse,\n  EngineServerQueryResponseByType,\n  EngineServerQuerySuccessResponse,\n  GetEngineNoncesParams,\n  GetEngineNoncesResponse,\n} from './types';\nimport { EngineServerFailureError } from './types/EngineServerFailureError';\n\nexport interface EngineClientOpts {\n  // Server URL\n  url: string;\n  // Wallet client for EIP712 signing\n  walletClient?: WalletClientWithAccount;\n  // Linked signer registered through the engine, if provided, execute requests will use this signer\n  linkedSignerWalletClient?: WalletClientWithAccount;\n}\n\n// Only 1 key can be defined per execute request\ntype EngineExecuteRequestBody = Partial<EngineServerExecuteRequestByType>;\n\ntype EngineQueryRequestResponse<\n  T extends EngineServerQueryRequestType = EngineServerQueryRequestType,\n> = EngineServerQueryResponse<T>;\n\n/**\n * Base client for all engine requests\n */\nexport class EngineBaseClient {\n  readonly opts: EngineClientOpts;\n  readonly axiosInstance: AxiosInstance;\n\n  constructor(opts: EngineClientOpts) {\n    this.opts = opts;\n    this.axiosInstance = axios.create({\n      withCredentials: true,\n    });\n  }\n\n  /**\n   * Sets the linked signer for execute requests\n   *\n   * @param linkedSignerWalletClient The linkedSigner to use for all signatures. Set to null to revert to the chain signer\n   */\n  public setLinkedSigner(\n    linkedSignerWalletClient: WalletClientWithAccount | null,\n  ) {\n    this.opts.linkedSignerWalletClient = linkedSignerWalletClient ?? undefined;\n  }\n\n  public async getTxNonce(address?: string): Promise<string> {\n    const addr = address ?? this.opts.walletClient?.account.address;\n\n    if (!addr) {\n      throw new WalletNotProvidedError();\n    }\n\n    return (\n      await this.getNonces({\n        address: addr,\n      })\n    ).txNonce;\n  }\n\n  public async getNonces(\n    params: GetEngineNoncesParams,\n  ): Promise<GetEngineNoncesResponse> {\n    const baseResp = await this.query('nonces', params);\n\n    return {\n      orderNonce: baseResp.order_nonce,\n      txNonce: baseResp.tx_nonce,\n    };\n  }\n\n  /**\n   * Queries the engine, all query params are stringified into the query string\n   *\n   * @param requestType\n   * @param params\n   * @public\n   */\n  public async query<TRequestType extends EngineServerQueryRequestType>(\n    requestType: TRequestType,\n    params: EngineServerQueryRequestByType[TRequestType],\n  ): Promise<EngineServerQueryResponseByType[TRequestType]> {\n    const request = this.getQueryRequest(requestType, params);\n    const response = await this.axiosInstance.post<EngineQueryRequestResponse>(\n      `${this.opts.url}/query`,\n      request,\n    );\n\n    this.checkResponseStatus(response);\n    this.checkServerStatus(response);\n\n    // checkServerStatus throws on failure responses so the cast to the success response is acceptable here\n    const successResponse = response as AxiosResponse<\n      EngineServerQuerySuccessResponse<TRequestType>\n    >;\n\n    return successResponse.data.data;\n  }\n\n  /**\n   * A simple, typechecked fn for constructing a query request in the format expected by the server.\n   *\n   * @param requestType\n   * @param params\n   */\n  public getQueryRequest<TRequestType extends EngineServerQueryRequestType>(\n    requestType: TRequestType,\n    params: EngineServerQueryRequestByType[TRequestType],\n  ): EngineServerQueryRequest<TRequestType> {\n    return {\n      type: requestType,\n      ...params,\n    };\n  }\n\n  /**\n   * POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped\n   * in an EngineServerFailureError on failure.\n   *\n   * @param requestType\n   * @param params\n   * @public\n   */\n  public async execute<TRequestType extends EngineServerExecuteRequestType>(\n    requestType: TRequestType,\n    params: EngineServerExecuteRequestByType[TRequestType],\n  ): Promise<EngineServerExecuteSuccessResult<TRequestType>> {\n    const reqBody = this.getExecuteRequest(requestType, params);\n    const response = await this.axiosInstance.post<\n      EngineServerExecuteResult<TRequestType>\n    >(`${this.opts.url}/execute`, reqBody);\n\n    this.checkResponseStatus(response);\n    this.checkServerStatus(response);\n\n    // checkServerStatus catches the failure result and throws the error, so the cast to the success response is acceptable here\n    return response.data as EngineServerExecuteSuccessResult<TRequestType>;\n  }\n\n  /**\n   * A simple, typechecked fn for constructing an execute request in the format expected by the server.\n   *\n   * @param requestType\n   * @param params\n   */\n  public getExecuteRequest<TRequestType extends EngineServerExecuteRequestType>(\n    requestType: TRequestType,\n    params: EngineServerExecuteRequestByType[TRequestType],\n  ): EngineExecuteRequestBody {\n    return {\n      [requestType]: params,\n    };\n  }\n\n  /**\n   * Signs a given request with the signer provided to the engine\n   *\n   * @param requestType\n   * @param verifyingContract\n   * @param chainId\n   * @param params\n   * @public\n   */\n  public async sign<T extends SignableRequestType>(\n    requestType: T,\n    verifyingContract: string,\n    chainId: number,\n    params: SignableRequestTypeToParams[T],\n  ) {\n    // Use the linked signer if provided, otherwise use the default signer provided to the engine\n    const walletClient =\n      this.opts.linkedSignerWalletClient ?? this.opts.walletClient;\n\n    if (!walletClient) {\n      throw new WalletNotProvidedError();\n    }\n\n    return getSignedTransactionRequest({\n      chainId,\n      requestParams: params,\n      requestType,\n      walletClient,\n      verifyingContract,\n    });\n  }\n\n  private checkResponseStatus(response: AxiosResponse) {\n    if (response.status !== 200 || !response.data) {\n      throw Error(\n        `Unexpected response from server: ${response.status} ${response.statusText}`,\n      );\n    }\n  }\n\n  private checkServerStatus(\n    response: AxiosResponse<\n      EngineServerExecuteResult | EngineQueryRequestResponse\n    >,\n  ) {\n    if (response.data.status !== 'success') {\n      throw new EngineServerFailureError(response.data);\n    }\n  }\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,OAIK;AACP,SAAS,8BAA8B;AACvC,OAAO,WAA6C;AAepD,SAAS,gCAAgC;AAqBlC,IAAM,mBAAN,MAAuB;AAAA,EAI5B,YAAY,MAAwB;AAClC,SAAK,OAAO;AACZ,SAAK,gBAAgB,MAAM,OAAO;AAAA,MAChC,iBAAiB;AAAA,IACnB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,gBACL,0BACA;AACA,SAAK,KAAK,2BAA2B,4BAA4B;AAAA,EACnE;AAAA,EAEA,MAAa,WAAW,SAAmC;AACzD,UAAM,OAAO,WAAW,KAAK,KAAK,cAAc,QAAQ;AAExD,QAAI,CAAC,MAAM;AACT,YAAM,IAAI,uBAAuB;AAAA,IACnC;AAEA,YACE,MAAM,KAAK,UAAU;AAAA,MACnB,SAAS;AAAA,IACX,CAAC,GACD;AAAA,EACJ;AAAA,EAEA,MAAa,UACX,QACkC;AAClC,UAAM,WAAW,MAAM,KAAK,MAAM,UAAU,MAAM;AAElD,WAAO;AAAA,MACL,YAAY,SAAS;AAAA,MACrB,SAAS,SAAS;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,MACX,aACA,QACwD;AACxD,UAAM,UAAU,KAAK,gBAAgB,aAAa,MAAM;AACxD,UAAM,WAAW,MAAM,KAAK,cAAc;AAAA,MACxC,GAAG,KAAK,KAAK,GAAG;AAAA,MAChB;AAAA,IACF;AAEA,SAAK,oBAAoB,QAAQ;AACjC,SAAK,kBAAkB,QAAQ;AAG/B,UAAM,kBAAkB;AAIxB,WAAO,gBAAgB,KAAK;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,gBACL,aACA,QACwC;AACxC,WAAO;AAAA,MACL,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,QACX,aACA,QACyD;AACzD,UAAM,UAAU,KAAK,kBAAkB,aAAa,MAAM;AAC1D,UAAM,WAAW,MAAM,KAAK,cAAc,KAExC,GAAG,KAAK,KAAK,GAAG,YAAY,OAAO;AAErC,SAAK,oBAAoB,QAAQ;AACjC,SAAK,kBAAkB,QAAQ;AAG/B,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,kBACL,aACA,QAC0B;AAC1B,WAAO;AAAA,MACL,CAAC,WAAW,GAAG;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAa,KACX,aACA,mBACA,SACA,QACA;AAEA,UAAM,eACJ,KAAK,KAAK,4BAA4B,KAAK,KAAK;AAElD,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,uBAAuB;AAAA,IACnC;AAEA,WAAO,4BAA4B;AAAA,MACjC;AAAA,MACA,eAAe;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,oBAAoB,UAAyB;AACnD,QAAI,SAAS,WAAW,OAAO,CAAC,SAAS,MAAM;AAC7C,YAAM;AAAA,QACJ,oCAAoC,SAAS,MAAM,IAAI,SAAS,UAAU;AAAA,MAC5E;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,kBACN,UAGA;AACA,QAAI,SAAS,KAAK,WAAW,WAAW;AACtC,YAAM,IAAI,yBAAyB,SAAS,IAAI;AAAA,IAClD;AAAA,EACF;AACF;","names":[]}

package/dist/EngineClient.cjs

@@ -0,0 +1,40 @@
+"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/EngineClient.ts
+var EngineClient_exports = {};
+__export(EngineClient_exports, {
+  EngineClient: () => EngineClient
+});
+module.exports = __toCommonJS(EngineClient_exports);
+var import_ts_mixer = require("ts-mixer");
+var import_EngineExecuteClient = require("./EngineExecuteClient.cjs");
+var import_EngineQueryClient = require("./EngineQueryClient.cjs");
+var import_EngineWebClient = require("./EngineWebClient.cjs");
+var EngineClient = class extends (0, import_ts_mixer.Mixin)(
+  import_EngineQueryClient.EngineQueryClient,
+  import_EngineExecuteClient.EngineExecuteClient,
+  import_EngineWebClient.EngineWebClient
+) {
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EngineClient
+});
+//# sourceMappingURL=EngineClient.cjs.map

package/dist/EngineClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/EngineClient.ts"],"sourcesContent":["import { Mixin } from 'ts-mixer';\nimport { EngineExecuteClient } from './EngineExecuteClient';\nimport { EngineQueryClient } from './EngineQueryClient';\nimport { EngineWebClient } from './EngineWebClient';\n\n/**\n * Combined Engine client providing query, execution, and WebSocket functionality for off-chain matching engine communication\n */\nexport class EngineClient extends Mixin(\n  EngineQueryClient,\n  EngineExecuteClient,\n  EngineWebClient,\n) {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAAsB;AACtB,iCAAoC;AACpC,+BAAkC;AAClC,6BAAgC;AAKzB,IAAM,eAAN,kBAA2B;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AACF,EAAE;AAAC;","names":[]}

package/dist/EngineClient.d.cts

@@ -0,0 +1,23 @@
+import * as ts_mixer_dist_types_types from 'ts-mixer/dist/types/types';
+import { EngineExecuteClient } from './EngineExecuteClient.cjs';
+import { EngineQueryClient } from './EngineQueryClient.cjs';
+import { EngineWebClient } from './EngineWebClient.cjs';
+import './types/clientExecuteTypes.cjs';
+import '@nadohq/contracts';
+import './types/serverExecuteTypes.cjs';
+import './types/serverQueryTypes.cjs';
+import './types/serverQueryModelTypes.cjs';
+import './EngineBaseClient.cjs';
+import 'axios';
+import './types/clientQueryTypes.cjs';
+import '@nadohq/utils';
+import './EngineExecuteBuilder.cjs';
+
+declare const EngineClient_base: ts_mixer_dist_types_types.Class<any[], EngineQueryClient & EngineExecuteClient & EngineWebClient, typeof EngineQueryClient & typeof EngineExecuteClient & typeof EngineWebClient>;
+/**
+ * Combined Engine client providing query, execution, and WebSocket functionality for off-chain matching engine communication
+ */
+declare class EngineClient extends EngineClient_base {
+}
+
+export { EngineClient };

package/dist/EngineClient.d.ts

@@ -0,0 +1,23 @@
+import * as ts_mixer_dist_types_types from 'ts-mixer/dist/types/types';
+import { EngineExecuteClient } from './EngineExecuteClient.js';
+import { EngineQueryClient } from './EngineQueryClient.js';
+import { EngineWebClient } from './EngineWebClient.js';
+import './types/clientExecuteTypes.js';
+import '@nadohq/contracts';
+import './types/serverExecuteTypes.js';
+import './types/serverQueryTypes.js';
+import './types/serverQueryModelTypes.js';
+import './EngineBaseClient.js';
+import 'axios';
+import './types/clientQueryTypes.js';
+import '@nadohq/utils';
+import './EngineExecuteBuilder.js';
+
+declare const EngineClient_base: ts_mixer_dist_types_types.Class<any[], EngineQueryClient & EngineExecuteClient & EngineWebClient, typeof EngineQueryClient & typeof EngineExecuteClient & typeof EngineWebClient>;
+/**
+ * Combined Engine client providing query, execution, and WebSocket functionality for off-chain matching engine communication
+ */
+declare class EngineClient extends EngineClient_base {
+}
+
+export { EngineClient };

package/dist/EngineClient.js

@@ -0,0 +1,15 @@
+// src/EngineClient.ts
+import { Mixin } from "ts-mixer";
+import { EngineExecuteClient } from "./EngineExecuteClient.js";
+import { EngineQueryClient } from "./EngineQueryClient.js";
+import { EngineWebClient } from "./EngineWebClient.js";
+var EngineClient = class extends Mixin(
+  EngineQueryClient,
+  EngineExecuteClient,
+  EngineWebClient
+) {
+};
+export {
+  EngineClient
+};
+//# sourceMappingURL=EngineClient.js.map

package/dist/EngineClient.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/EngineClient.ts"],"sourcesContent":["import { Mixin } from 'ts-mixer';\nimport { EngineExecuteClient } from './EngineExecuteClient';\nimport { EngineQueryClient } from './EngineQueryClient';\nimport { EngineWebClient } from './EngineWebClient';\n\n/**\n * Combined Engine client providing query, execution, and WebSocket functionality for off-chain matching engine communication\n */\nexport class EngineClient extends Mixin(\n  EngineQueryClient,\n  EngineExecuteClient,\n  EngineWebClient,\n) {}\n"],"mappings":";AAAA,SAAS,aAAa;AACtB,SAAS,2BAA2B;AACpC,SAAS,yBAAyB;AAClC,SAAS,uBAAuB;AAKzB,IAAM,eAAN,cAA2B;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AACF,EAAE;AAAC;","names":[]}