@nadohq/engine-client 0.13.0 → 0.14.0

package/dist/EngineWebClient.cjs

@@ -24,6 +24,7 @@ __export(EngineWebClient_exports, {
 });
 module.exports = __toCommonJS(EngineWebClient_exports);
 var import_EngineBaseClient = require("./EngineBaseClient.cjs");
+var COUNTRY_HEADER = "x-nado-country";
 var EngineWebClient = class extends import_EngineBaseClient.EngineBaseClient {
   /**
    * Determines the IP block status for the current client
@@ -43,6 +44,21 @@ var EngineWebClient = class extends import_EngineBaseClient.EngineBaseClient {
       return resData.reason === "ip_query_only" ? "query_only" : "blocked";
     });
   }
+  /**
+   * Retrieves the caller's country code as detected by the gateway, sourced
+   * from the `x-nado-country` response header on `/ip`. Returns `null` when
+   * the gateway does not provide it (e.g. local environments).
+   *
+   * Useful for region-based UI gating such as geoblocking trading competitions.
+   */
+  async getCountryCode() {
+    const res = await this.axiosInstance.get(`${this.opts.url}/ip`, {
+      // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false
+      withCredentials: false
+    });
+    const rawCountry = res.headers?.[COUNTRY_HEADER];
+    return rawCountry ?? null;
+  }
   /**
    * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API
    *

package/dist/EngineWebClient.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/EngineWebClient.ts"],"sourcesContent":["import { EngineBaseClient } from './EngineBaseClient';\nimport {\n  EngineServerIpBlockResponse,\n  GetEngineIpBlockStatusResponse,\n  GetEngineTimeResponse,\n} from './types';\n\n/**\n * Queries that talk directly to web, _not_ the engine. Placing here in the `engine-client` as we don't have enough\n * use cases to justify a separate package\n */\nexport class EngineWebClient extends EngineBaseClient {\n  /**\n   * Determines the IP block status for the current client\n   */\n  async getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse> {\n    return (\n      this.axiosInstance\n        // Use the /time endpoint and listen to 403 responses\n        .get(`${this.opts.url}/ip`, {\n          // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n          withCredentials: false,\n        })\n        .then((res) => {\n          if (res.status !== 403) {\n            return null;\n          }\n          const resData = res.data as EngineServerIpBlockResponse;\n\n          if (!resData.blocked) {\n            return null;\n          }\n\n          return resData.reason === 'ip_query_only' ? 'query_only' : 'blocked';\n        })\n    );\n  }\n\n  /**\n   * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API\n   *\n   * @return true if the client needs to complete the JS challenge at '/challenge', false otherwise\n   */\n  async getRequiresCloudflareAuth(): Promise<boolean> {\n    // We use a generic endpoint and check for the CF challenge header\n    // Note: this uses a CORS set to the relevant frontend endpoint (ex. testnet.vertexprotocol.com) so it will NOT\n    // work from other domains\n    return this.axiosInstance\n      .get(`${this.opts.url}/cf-check`, {\n        // Allow all statuses\n        validateStatus: () => true,\n      })\n      .then((res) => {\n        if (res.status !== 403) {\n          return false;\n        }\n\n        return res.headers['cf-mitigated'] === 'challenge';\n      });\n  }\n\n  /**\n   * Retrieves current server epoch in milliseconds\n   */\n  async getTime(): Promise<GetEngineTimeResponse> {\n    return this.axiosInstance\n      .get(`${this.opts.url}/time`)\n      .then((res) => res.data as GetEngineTimeResponse);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAAiC;AAW1B,IAAM,kBAAN,cAA8B,yCAAiB;AAAA;AAAA;AAAA;AAAA,EAIpD,MAAM,mBAA4D;AAChE,WACE,KAAK,cAEF,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE1B,iBAAiB;AAAA,IACnB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AACA,YAAM,UAAU,IAAI;AAEpB,UAAI,CAAC,QAAQ,SAAS;AACpB,eAAO;AAAA,MACT;AAEA,aAAO,QAAQ,WAAW,kBAAkB,eAAe;AAAA,IAC7D,CAAC;AAAA,EAEP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,4BAA8C;AAIlD,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,aAAa;AAAA;AAAA,MAEhC,gBAAgB,MAAM;AAAA,IACxB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AAEA,aAAO,IAAI,QAAQ,cAAc,MAAM;AAAA,IACzC,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,UAA0C;AAC9C,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO,EAC3B,KAAK,CAAC,QAAQ,IAAI,IAA6B;AAAA,EACpD;AACF;","names":[]}
+{"version":3,"sources":["../src/EngineWebClient.ts"],"sourcesContent":["import { EngineBaseClient } from './EngineBaseClient';\nimport {\n  EngineServerIpBlockResponse,\n  GetEngineCountryCodeResponse,\n  GetEngineIpBlockStatusResponse,\n  GetEngineTimeResponse,\n} from './types';\n\nconst COUNTRY_HEADER = 'x-nado-country';\n\n/**\n * Queries that talk directly to web, _not_ the engine. Placing here in the `engine-client` as we don't have enough\n * use cases to justify a separate package\n */\nexport class EngineWebClient extends EngineBaseClient {\n  /**\n   * Determines the IP block status for the current client\n   */\n  async getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse> {\n    return (\n      this.axiosInstance\n        // Use the /ip endpoint and listen to 403 responses\n        .get(`${this.opts.url}/ip`, {\n          // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n          withCredentials: false,\n        })\n        .then((res) => {\n          if (res.status !== 403) {\n            return null;\n          }\n          const resData = res.data as EngineServerIpBlockResponse;\n\n          if (!resData.blocked) {\n            return null;\n          }\n\n          return resData.reason === 'ip_query_only' ? 'query_only' : 'blocked';\n        })\n    );\n  }\n\n  /**\n   * Retrieves the caller's country code as detected by the gateway, sourced\n   * from the `x-nado-country` response header on `/ip`. Returns `null` when\n   * the gateway does not provide it (e.g. local environments).\n   *\n   * Useful for region-based UI gating such as geoblocking trading competitions.\n   */\n  async getCountryCode(): Promise<GetEngineCountryCodeResponse> {\n    const res = await this.axiosInstance.get(`${this.opts.url}/ip`, {\n      // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n      withCredentials: false,\n    });\n\n    const rawCountry = res.headers?.[COUNTRY_HEADER] as string | undefined;\n    return rawCountry ?? null;\n  }\n\n  /**\n   * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API\n   *\n   * @return true if the client needs to complete the JS challenge at '/challenge', false otherwise\n   */\n  async getRequiresCloudflareAuth(): Promise<boolean> {\n    // We use a generic endpoint and check for the CF challenge header\n    // Note: this uses a CORS set to the relevant frontend endpoint (ex. testnet.vertexprotocol.com) so it will NOT\n    // work from other domains\n    return this.axiosInstance\n      .get(`${this.opts.url}/cf-check`, {\n        // Allow all statuses\n        validateStatus: () => true,\n      })\n      .then((res) => {\n        if (res.status !== 403) {\n          return false;\n        }\n\n        return res.headers['cf-mitigated'] === 'challenge';\n      });\n  }\n\n  /**\n   * Retrieves current server epoch in milliseconds\n   */\n  async getTime(): Promise<GetEngineTimeResponse> {\n    return this.axiosInstance\n      .get(`${this.opts.url}/time`)\n      .then((res) => res.data as GetEngineTimeResponse);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAAiC;AAQjC,IAAM,iBAAiB;AAMhB,IAAM,kBAAN,cAA8B,yCAAiB;AAAA;AAAA;AAAA;AAAA,EAIpD,MAAM,mBAA4D;AAChE,WACE,KAAK,cAEF,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE1B,iBAAiB;AAAA,IACnB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AACA,YAAM,UAAU,IAAI;AAEpB,UAAI,CAAC,QAAQ,SAAS;AACpB,eAAO;AAAA,MACT;AAEA,aAAO,QAAQ,WAAW,kBAAkB,eAAe;AAAA,IAC7D,CAAC;AAAA,EAEP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAwD;AAC5D,UAAM,MAAM,MAAM,KAAK,cAAc,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE9D,iBAAiB;AAAA,IACnB,CAAC;AAED,UAAM,aAAa,IAAI,UAAU,cAAc;AAC/C,WAAO,cAAc;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,4BAA8C;AAIlD,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,aAAa;AAAA;AAAA,MAEhC,gBAAgB,MAAM;AAAA,IACxB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AAEA,aAAO,IAAI,QAAQ,cAAc,MAAM;AAAA,IACzC,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,UAA0C;AAC9C,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO,EAC3B,KAAK,CAAC,QAAQ,IAAI,IAA6B;AAAA,EACpD;AACF;","names":[]}

package/dist/EngineWebClient.d.cts

@@ -1,5 +1,5 @@
 import { EngineBaseClient } from './EngineBaseClient.cjs';
-import { GetEngineIpBlockStatusResponse, GetEngineTimeResponse } from './types/clientQueryTypes.cjs';
+import { GetEngineIpBlockStatusResponse, GetEngineCountryCodeResponse, GetEngineTimeResponse } from './types/clientQueryTypes.cjs';
 import '@nadohq/shared';
 import 'axios';
 import './types/serverExecuteTypes.cjs';
@@ -16,6 +16,14 @@ declare class EngineWebClient extends EngineBaseClient {
      * Determines the IP block status for the current client
      */
     getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse>;
+    /**
+     * Retrieves the caller's country code as detected by the gateway, sourced
+     * from the `x-nado-country` response header on `/ip`. Returns `null` when
+     * the gateway does not provide it (e.g. local environments).
+     *
+     * Useful for region-based UI gating such as geoblocking trading competitions.
+     */
+    getCountryCode(): Promise<GetEngineCountryCodeResponse>;
     /**
      * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API
      *

package/dist/EngineWebClient.d.ts

@@ -1,5 +1,5 @@
 import { EngineBaseClient } from './EngineBaseClient.js';
-import { GetEngineIpBlockStatusResponse, GetEngineTimeResponse } from './types/clientQueryTypes.js';
+import { GetEngineIpBlockStatusResponse, GetEngineCountryCodeResponse, GetEngineTimeResponse } from './types/clientQueryTypes.js';
 import '@nadohq/shared';
 import 'axios';
 import './types/serverExecuteTypes.js';
@@ -16,6 +16,14 @@ declare class EngineWebClient extends EngineBaseClient {
      * Determines the IP block status for the current client
      */
     getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse>;
+    /**
+     * Retrieves the caller's country code as detected by the gateway, sourced
+     * from the `x-nado-country` response header on `/ip`. Returns `null` when
+     * the gateway does not provide it (e.g. local environments).
+     *
+     * Useful for region-based UI gating such as geoblocking trading competitions.
+     */
+    getCountryCode(): Promise<GetEngineCountryCodeResponse>;
     /**
      * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API
      *

package/dist/EngineWebClient.js

@@ -1,5 +1,6 @@
 // src/EngineWebClient.ts
 import { EngineBaseClient } from "./EngineBaseClient.js";
+var COUNTRY_HEADER = "x-nado-country";
 var EngineWebClient = class extends EngineBaseClient {
   /**
    * Determines the IP block status for the current client
@@ -19,6 +20,21 @@ var EngineWebClient = class extends EngineBaseClient {
       return resData.reason === "ip_query_only" ? "query_only" : "blocked";
     });
   }
+  /**
+   * Retrieves the caller's country code as detected by the gateway, sourced
+   * from the `x-nado-country` response header on `/ip`. Returns `null` when
+   * the gateway does not provide it (e.g. local environments).
+   *
+   * Useful for region-based UI gating such as geoblocking trading competitions.
+   */
+  async getCountryCode() {
+    const res = await this.axiosInstance.get(`${this.opts.url}/ip`, {
+      // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false
+      withCredentials: false
+    });
+    const rawCountry = res.headers?.[COUNTRY_HEADER];
+    return rawCountry ?? null;
+  }
   /**
    * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API
    *

package/dist/EngineWebClient.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/EngineWebClient.ts"],"sourcesContent":["import { EngineBaseClient } from './EngineBaseClient';\nimport {\n  EngineServerIpBlockResponse,\n  GetEngineIpBlockStatusResponse,\n  GetEngineTimeResponse,\n} from './types';\n\n/**\n * Queries that talk directly to web, _not_ the engine. Placing here in the `engine-client` as we don't have enough\n * use cases to justify a separate package\n */\nexport class EngineWebClient extends EngineBaseClient {\n  /**\n   * Determines the IP block status for the current client\n   */\n  async getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse> {\n    return (\n      this.axiosInstance\n        // Use the /time endpoint and listen to 403 responses\n        .get(`${this.opts.url}/ip`, {\n          // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n          withCredentials: false,\n        })\n        .then((res) => {\n          if (res.status !== 403) {\n            return null;\n          }\n          const resData = res.data as EngineServerIpBlockResponse;\n\n          if (!resData.blocked) {\n            return null;\n          }\n\n          return resData.reason === 'ip_query_only' ? 'query_only' : 'blocked';\n        })\n    );\n  }\n\n  /**\n   * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API\n   *\n   * @return true if the client needs to complete the JS challenge at '/challenge', false otherwise\n   */\n  async getRequiresCloudflareAuth(): Promise<boolean> {\n    // We use a generic endpoint and check for the CF challenge header\n    // Note: this uses a CORS set to the relevant frontend endpoint (ex. testnet.vertexprotocol.com) so it will NOT\n    // work from other domains\n    return this.axiosInstance\n      .get(`${this.opts.url}/cf-check`, {\n        // Allow all statuses\n        validateStatus: () => true,\n      })\n      .then((res) => {\n        if (res.status !== 403) {\n          return false;\n        }\n\n        return res.headers['cf-mitigated'] === 'challenge';\n      });\n  }\n\n  /**\n   * Retrieves current server epoch in milliseconds\n   */\n  async getTime(): Promise<GetEngineTimeResponse> {\n    return this.axiosInstance\n      .get(`${this.opts.url}/time`)\n      .then((res) => res.data as GetEngineTimeResponse);\n  }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AAW1B,IAAM,kBAAN,cAA8B,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAIpD,MAAM,mBAA4D;AAChE,WACE,KAAK,cAEF,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE1B,iBAAiB;AAAA,IACnB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AACA,YAAM,UAAU,IAAI;AAEpB,UAAI,CAAC,QAAQ,SAAS;AACpB,eAAO;AAAA,MACT;AAEA,aAAO,QAAQ,WAAW,kBAAkB,eAAe;AAAA,IAC7D,CAAC;AAAA,EAEP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,4BAA8C;AAIlD,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,aAAa;AAAA;AAAA,MAEhC,gBAAgB,MAAM;AAAA,IACxB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AAEA,aAAO,IAAI,QAAQ,cAAc,MAAM;AAAA,IACzC,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,UAA0C;AAC9C,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO,EAC3B,KAAK,CAAC,QAAQ,IAAI,IAA6B;AAAA,EACpD;AACF;","names":[]}
+{"version":3,"sources":["../src/EngineWebClient.ts"],"sourcesContent":["import { EngineBaseClient } from './EngineBaseClient';\nimport {\n  EngineServerIpBlockResponse,\n  GetEngineCountryCodeResponse,\n  GetEngineIpBlockStatusResponse,\n  GetEngineTimeResponse,\n} from './types';\n\nconst COUNTRY_HEADER = 'x-nado-country';\n\n/**\n * Queries that talk directly to web, _not_ the engine. Placing here in the `engine-client` as we don't have enough\n * use cases to justify a separate package\n */\nexport class EngineWebClient extends EngineBaseClient {\n  /**\n   * Determines the IP block status for the current client\n   */\n  async getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse> {\n    return (\n      this.axiosInstance\n        // Use the /ip endpoint and listen to 403 responses\n        .get(`${this.opts.url}/ip`, {\n          // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n          withCredentials: false,\n        })\n        .then((res) => {\n          if (res.status !== 403) {\n            return null;\n          }\n          const resData = res.data as EngineServerIpBlockResponse;\n\n          if (!resData.blocked) {\n            return null;\n          }\n\n          return resData.reason === 'ip_query_only' ? 'query_only' : 'blocked';\n        })\n    );\n  }\n\n  /**\n   * Retrieves the caller's country code as detected by the gateway, sourced\n   * from the `x-nado-country` response header on `/ip`. Returns `null` when\n   * the gateway does not provide it (e.g. local environments).\n   *\n   * Useful for region-based UI gating such as geoblocking trading competitions.\n   */\n  async getCountryCode(): Promise<GetEngineCountryCodeResponse> {\n    const res = await this.axiosInstance.get(`${this.opts.url}/ip`, {\n      // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false\n      withCredentials: false,\n    });\n\n    const rawCountry = res.headers?.[COUNTRY_HEADER] as string | undefined;\n    return rawCountry ?? null;\n  }\n\n  /**\n   * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API\n   *\n   * @return true if the client needs to complete the JS challenge at '/challenge', false otherwise\n   */\n  async getRequiresCloudflareAuth(): Promise<boolean> {\n    // We use a generic endpoint and check for the CF challenge header\n    // Note: this uses a CORS set to the relevant frontend endpoint (ex. testnet.vertexprotocol.com) so it will NOT\n    // work from other domains\n    return this.axiosInstance\n      .get(`${this.opts.url}/cf-check`, {\n        // Allow all statuses\n        validateStatus: () => true,\n      })\n      .then((res) => {\n        if (res.status !== 403) {\n          return false;\n        }\n\n        return res.headers['cf-mitigated'] === 'challenge';\n      });\n  }\n\n  /**\n   * Retrieves current server epoch in milliseconds\n   */\n  async getTime(): Promise<GetEngineTimeResponse> {\n    return this.axiosInstance\n      .get(`${this.opts.url}/time`)\n      .then((res) => res.data as GetEngineTimeResponse);\n  }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AAQjC,IAAM,iBAAiB;AAMhB,IAAM,kBAAN,cAA8B,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAIpD,MAAM,mBAA4D;AAChE,WACE,KAAK,cAEF,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE1B,iBAAiB;AAAA,IACnB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AACA,YAAM,UAAU,IAAI;AAEpB,UAAI,CAAC,QAAQ,SAAS;AACpB,eAAO;AAAA,MACT;AAEA,aAAO,QAAQ,WAAW,kBAAkB,eAAe;AAAA,IAC7D,CAAC;AAAA,EAEP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAwD;AAC5D,UAAM,MAAM,MAAM,KAAK,cAAc,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO;AAAA;AAAA,MAE9D,iBAAiB;AAAA,IACnB,CAAC;AAED,UAAM,aAAa,IAAI,UAAU,cAAc;AAC/C,WAAO,cAAc;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,4BAA8C;AAIlD,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,aAAa;AAAA;AAAA,MAEhC,gBAAgB,MAAM;AAAA,IACxB,CAAC,EACA,KAAK,CAAC,QAAQ;AACb,UAAI,IAAI,WAAW,KAAK;AACtB,eAAO;AAAA,MACT;AAEA,aAAO,IAAI,QAAQ,cAAc,MAAM;AAAA,IACzC,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,UAA0C;AAC9C,WAAO,KAAK,cACT,IAAI,GAAG,KAAK,KAAK,GAAG,OAAO,EAC3B,KAAK,CAAC,QAAQ,IAAI,IAA6B;AAAA,EACpD;AACF;","names":[]}

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 export { ENGINE_CLIENT_ENDPOINTS, ENGINE_WS_CLIENT_ENDPOINTS, ENGINE_WS_SUBSCRIPTION_CLIENT_ENDPOINTS } from './endpoints.cjs';
 export { EngineClient } from './EngineClient.cjs';
 export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersParams, EngineCancelProductOrdersParams, EngineExecuteRequestParamsByType, EngineLinkSignerParams, EngineLiquidateSubaccountParams, EngineMintNlpParams, EngineOrderParams, EnginePlaceOrderParams, EnginePlaceOrderResult, EnginePlaceOrdersParams, EngineTransferQuoteParams, EngineWithdrawCollateralParams, SignatureParams, WithBaseEngineExecuteParams, WithSignature } from './types/clientExecuteTypes.cjs';
-export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './types/clientQueryTypes.cjs';
+export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './types/clientQueryTypes.cjs';
 export { EngineServerFailureError } from './types/EngineServerFailureError.cjs';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './types/serverExecuteTypes.cjs';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerOrder, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './types/serverQueryModelTypes.cjs';

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { ENGINE_CLIENT_ENDPOINTS, ENGINE_WS_CLIENT_ENDPOINTS, ENGINE_WS_SUBSCRIPTION_CLIENT_ENDPOINTS } from './endpoints.js';
 export { EngineClient } from './EngineClient.js';
 export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersParams, EngineCancelProductOrdersParams, EngineExecuteRequestParamsByType, EngineLinkSignerParams, EngineLiquidateSubaccountParams, EngineMintNlpParams, EngineOrderParams, EnginePlaceOrderParams, EnginePlaceOrderResult, EnginePlaceOrdersParams, EngineTransferQuoteParams, EngineWithdrawCollateralParams, SignatureParams, WithBaseEngineExecuteParams, WithSignature } from './types/clientExecuteTypes.js';
-export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './types/clientQueryTypes.js';
+export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './types/clientQueryTypes.js';
 export { EngineServerFailureError } from './types/EngineServerFailureError.js';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './types/serverExecuteTypes.js';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerOrder, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './types/serverQueryModelTypes.js';

package/dist/types/clientQueryTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/clientQueryTypes.ts"],"sourcesContent":["import {\n  BalanceHealthContributions,\n  BalanceSide,\n  BalanceWithProduct,\n  EIP712OrderParams,\n  HealthGroup,\n  HealthStatusByType,\n  MarketWithProduct,\n  OrderAppendix,\n  PerpBalanceWithProduct,\n  ProductEngineType,\n  SignedEIP712OrderParams,\n  SpotBalanceWithProduct,\n  Subaccount,\n} from '@nadohq/shared';\nimport BigNumber from 'bignumber.js';\nimport {\n  EngineServerNoncesParams,\n  EngineServerTimeResponse,\n} from './serverQueryTypes';\n\nexport interface GetEngineSubaccountSummaryResponse extends SubaccountSummaryState {\n  exists: boolean;\n  preState?: SubaccountSummaryState;\n}\n\nexport interface SubaccountSummaryState {\n  balances: BalanceWithProduct[];\n  health: HealthStatusByType;\n}\n\nexport type GetEngineSubaccountSummaryParams = Subaccount;\n\nexport type GetEngineIsolatedPositionsParams = Subaccount;\n\nexport interface SubaccountIsolatedPosition {\n  subaccount: Subaccount;\n  healths: BalanceHealthContributions;\n  quoteBalance: SpotBalanceWithProduct;\n  baseBalance: PerpBalanceWithProduct;\n}\n\nexport type GetEngineIsolatedPositionsResponse = SubaccountIsolatedPosition[];\n\nexport type SubaccountTx = {\n  type: 'apply_delta';\n  tx: SubaccountProductDeltaTx;\n};\n\nexport interface SubaccountProductDeltaTx {\n  productId: number;\n  amountDelta: BigNumber;\n  vQuoteDelta: BigNumber;\n}\n\nexport interface GetEngineContractsResponse {\n  chainId: number;\n  endpointAddr: string;\n}\n\nexport type GetEngineEstimatedSubaccountSummaryParams = Subaccount & {\n  txs: SubaccountTx[];\n  preState?: boolean;\n};\n\nexport type GetEngineNoncesParams = EngineServerNoncesParams;\n\nexport interface GetEngineNoncesResponse {\n  orderNonce: string;\n  txNonce: string;\n}\n\nexport interface GetEngineSymbolsParams {\n  productType?: ProductEngineType;\n  productIds?: number[];\n}\n\nexport interface EngineSymbolsResponse {\n  // mapping of product symbol to symbols info\n  symbols: Record<string, EngineSymbol>;\n}\n\nexport interface EngineSymbol {\n  type: ProductEngineType;\n  productId: number;\n  symbol: string;\n  priceIncrement: BigNumber;\n  sizeIncrement: BigNumber;\n  minSize: BigNumber;\n  makerFeeRate: BigNumber;\n  takerFeeRate: BigNumber;\n  longWeightInitial: BigNumber;\n  longWeightMaintenance: BigNumber;\n  // undefined when there is no max open interest limit (always undefined for spot products)\n  maxOpenInterest: BigNumber | undefined;\n  isolatedOnly: boolean;\n}\n\nexport type GetEngineAllMarketsResponse = MarketWithProduct[];\n\nexport interface GetEngineHealthGroupsResponse {\n  healthGroups: HealthGroup[];\n}\n\nexport interface GetEngineOrderParams {\n  productId: number;\n  digest: string;\n}\n\nexport interface EngineOrder extends Subaccount {\n  productId: number;\n  price: BigNumber;\n  // Amount initially requested\n  totalAmount: BigNumber;\n  // Amount still unfilled\n  unfilledAmount: BigNumber;\n  expiration: number;\n  nonce: string;\n  digest: string;\n  placementTime: number;\n  appendix: OrderAppendix;\n}\n\nexport type GetEngineOrderResponse = EngineOrder;\n\nexport interface ValidateSignedEngineOrderParams {\n  productId: number;\n  signedOrder: SignedEIP712OrderParams;\n}\n\nexport interface ValidateEngineOrderParams {\n  productId: number;\n  chainId: number;\n  order: EIP712OrderParams;\n}\n\nexport interface ValidateEngineOrderResponse {\n  productId: number;\n  valid: boolean;\n}\n\nexport interface GetEngineSubaccountOrdersParams extends Subaccount {\n  productId: number;\n}\n\nexport interface EngineSubaccountOrders {\n  productId: number;\n  orders: EngineOrder[];\n}\n\nexport type GetEngineSubaccountOrdersResponse = EngineSubaccountOrders;\n\nexport interface GetEngineSubaccountProductOrdersParams extends Subaccount {\n  productIds: number[];\n}\n\nexport interface GetEngineSubaccountProductOrdersResponse {\n  productOrders: EngineSubaccountOrders[];\n}\n\nexport type GetEngineSubaccountFeeRatesParams = Subaccount;\n\nexport interface SubaccountOrderFeeRates {\n  maker: BigNumber;\n  taker: BigNumber;\n}\n\nexport interface GetEngineSubaccountFeeRatesResponse {\n  // By Product ID\n  orders: Record<number, SubaccountOrderFeeRates>;\n  withdrawal: Record<number, BigNumber>;\n  liquidationSequencerFee: BigNumber;\n  healthCheckSequencerFee: BigNumber;\n  takerSequencerFee: BigNumber;\n  feeTier: number;\n}\n\nexport interface EnginePriceTickLiquidity {\n  price: BigNumber;\n  liquidity: BigNumber;\n}\n\nexport interface GetEngineMarketLiquidityParams {\n  productId: number;\n  // The minimum depth in base price ticks (i.e. per side\n  depth: number;\n}\n\nexport interface GetEngineMarketLiquidityResponse {\n  bids: EnginePriceTickLiquidity[];\n  asks: EnginePriceTickLiquidity[];\n}\n\nexport interface GetEngineMarketPriceParams {\n  productId: number;\n}\n\nexport interface EngineMarketPrice {\n  productId: number;\n  bid: BigNumber;\n  ask: BigNumber;\n}\n\nexport type GetEngineMarketPriceResponse = EngineMarketPrice;\n\nexport interface GetEngineMarketPricesParams {\n  productIds: number[];\n}\n\nexport interface GetEngineMarketPricesResponse {\n  marketPrices: EngineMarketPrice[];\n}\n\nexport interface GetEngineMaxOrderSizeParams extends Subaccount {\n  price: BigNumber;\n  productId: number;\n  // Note: When `reduceOnly` is true, `side` must be opposite of the current position, otherwise it returns 0.\n  side: BalanceSide;\n  // If not given, engine defaults to true (leverage/borrow enabled) for spot\n  // Do not pass this for perp products\n  spotLeverage?: boolean;\n  // If not given, engine defaults to false. If true, the max order size will be capped to the subaccount's current position size;\n  // If no position exists, it will return 0.\n  reduceOnly?: boolean;\n  isolated?: boolean;\n  // If not given, engine defaults to true (do not borrow margin for isolated orders)\n  // Max order size query for `isolated` includes available transfer from the cross subaccount\n  isoBorrowMargin?: boolean;\n}\n\nexport type GetEngineMaxOrderSizeResponse = BigNumber;\n\nexport interface GetEngineMaxWithdrawableParams extends Subaccount {\n  productId: number;\n  // If not given, engine defaults to true (leverage/borrow enabled)\n  spotLeverage?: boolean;\n}\n\nexport type GetEngineMaxWithdrawableResponse = BigNumber;\n\nexport type GetEngineTimeResponse = EngineServerTimeResponse;\n\nexport type GetEngineLinkedSignerParams = Subaccount;\n\nexport interface GetEngineLinkedSignerResponse {\n  signer: string;\n}\n\nexport type GetEngineInsuranceResponse = BigNumber;\n\n/**\n * Given an IP, backend will either:\n * - Allow queries only through archive / engine (query_only)\n * - Block all requests (blocked)\n * - Allow all requests (null)\n */\nexport type GetEngineIpBlockStatusResponse = 'query_only' | 'blocked' | null;\n\nexport interface GetEngineMaxMintNlpAmountParams extends Subaccount {\n  // If not given, engine defaults to true (leverage/borrow enabled)\n  spotLeverage?: boolean;\n}\n\nexport type GetEngineMaxMintNlpAmountResponse = BigNumber;\n\nexport type GetEngineMaxBurnNlpAmountParams = Subaccount;\n\nexport type GetEngineMaxBurnNlpAmountResponse = BigNumber;\n\nexport type GetEngineNlpLockedBalancesParams = Subaccount;\n\nexport interface EngineNlpBalance {\n  productId: number;\n  balance: BigNumber;\n}\n\nexport interface EngineNlpLockedBalance extends EngineNlpBalance {\n  unlockedAt: number;\n}\n\nexport interface GetEngineNlpLockedBalancesResponse {\n  lockedBalances: EngineNlpLockedBalance[];\n  balanceLocked: EngineNlpBalance;\n  balanceUnlocked: EngineNlpBalance;\n}\n\nexport interface NlpPool {\n  poolId: number;\n  subaccountHex: string;\n  ownerAddress: string;\n  balanceWeight: BigNumber;\n  subaccountInfo: GetEngineSubaccountSummaryResponse;\n  openOrders: EngineOrder[];\n}\n\nexport interface GetEngineNlpPoolInfoResponse {\n  nlpPools: NlpPool[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/clientQueryTypes.ts"],"sourcesContent":["import {\n  BalanceHealthContributions,\n  BalanceSide,\n  BalanceWithProduct,\n  EIP712OrderParams,\n  HealthGroup,\n  HealthStatusByType,\n  MarketWithProduct,\n  OrderAppendix,\n  PerpBalanceWithProduct,\n  ProductEngineType,\n  SignedEIP712OrderParams,\n  SpotBalanceWithProduct,\n  Subaccount,\n} from '@nadohq/shared';\nimport BigNumber from 'bignumber.js';\nimport {\n  EngineServerNoncesParams,\n  EngineServerTimeResponse,\n} from './serverQueryTypes';\n\nexport interface GetEngineSubaccountSummaryResponse extends SubaccountSummaryState {\n  exists: boolean;\n  preState?: SubaccountSummaryState;\n}\n\nexport interface SubaccountSummaryState {\n  balances: BalanceWithProduct[];\n  health: HealthStatusByType;\n}\n\nexport type GetEngineSubaccountSummaryParams = Subaccount;\n\nexport type GetEngineIsolatedPositionsParams = Subaccount;\n\nexport interface SubaccountIsolatedPosition {\n  subaccount: Subaccount;\n  healths: BalanceHealthContributions;\n  quoteBalance: SpotBalanceWithProduct;\n  baseBalance: PerpBalanceWithProduct;\n}\n\nexport type GetEngineIsolatedPositionsResponse = SubaccountIsolatedPosition[];\n\nexport type SubaccountTx = {\n  type: 'apply_delta';\n  tx: SubaccountProductDeltaTx;\n};\n\nexport interface SubaccountProductDeltaTx {\n  productId: number;\n  amountDelta: BigNumber;\n  vQuoteDelta: BigNumber;\n}\n\nexport interface GetEngineContractsResponse {\n  chainId: number;\n  endpointAddr: string;\n}\n\nexport type GetEngineEstimatedSubaccountSummaryParams = Subaccount & {\n  txs: SubaccountTx[];\n  preState?: boolean;\n};\n\nexport type GetEngineNoncesParams = EngineServerNoncesParams;\n\nexport interface GetEngineNoncesResponse {\n  orderNonce: string;\n  txNonce: string;\n}\n\nexport interface GetEngineSymbolsParams {\n  productType?: ProductEngineType;\n  productIds?: number[];\n}\n\nexport interface EngineSymbolsResponse {\n  // mapping of product symbol to symbols info\n  symbols: Record<string, EngineSymbol>;\n}\n\nexport interface EngineSymbol {\n  type: ProductEngineType;\n  productId: number;\n  symbol: string;\n  priceIncrement: BigNumber;\n  sizeIncrement: BigNumber;\n  minSize: BigNumber;\n  makerFeeRate: BigNumber;\n  takerFeeRate: BigNumber;\n  longWeightInitial: BigNumber;\n  longWeightMaintenance: BigNumber;\n  // undefined when there is no max open interest limit (always undefined for spot products)\n  maxOpenInterest: BigNumber | undefined;\n  isolatedOnly: boolean;\n}\n\nexport type GetEngineAllMarketsResponse = MarketWithProduct[];\n\nexport interface GetEngineHealthGroupsResponse {\n  healthGroups: HealthGroup[];\n}\n\nexport interface GetEngineOrderParams {\n  productId: number;\n  digest: string;\n}\n\nexport interface EngineOrder extends Subaccount {\n  productId: number;\n  price: BigNumber;\n  // Amount initially requested\n  totalAmount: BigNumber;\n  // Amount still unfilled\n  unfilledAmount: BigNumber;\n  expiration: number;\n  nonce: string;\n  digest: string;\n  placementTime: number;\n  appendix: OrderAppendix;\n}\n\nexport type GetEngineOrderResponse = EngineOrder;\n\nexport interface ValidateSignedEngineOrderParams {\n  productId: number;\n  signedOrder: SignedEIP712OrderParams;\n}\n\nexport interface ValidateEngineOrderParams {\n  productId: number;\n  chainId: number;\n  order: EIP712OrderParams;\n}\n\nexport interface ValidateEngineOrderResponse {\n  productId: number;\n  valid: boolean;\n}\n\nexport interface GetEngineSubaccountOrdersParams extends Subaccount {\n  productId: number;\n}\n\nexport interface EngineSubaccountOrders {\n  productId: number;\n  orders: EngineOrder[];\n}\n\nexport type GetEngineSubaccountOrdersResponse = EngineSubaccountOrders;\n\nexport interface GetEngineSubaccountProductOrdersParams extends Subaccount {\n  productIds: number[];\n}\n\nexport interface GetEngineSubaccountProductOrdersResponse {\n  productOrders: EngineSubaccountOrders[];\n}\n\nexport type GetEngineSubaccountFeeRatesParams = Subaccount;\n\nexport interface SubaccountOrderFeeRates {\n  maker: BigNumber;\n  taker: BigNumber;\n}\n\nexport interface GetEngineSubaccountFeeRatesResponse {\n  // By Product ID\n  orders: Record<number, SubaccountOrderFeeRates>;\n  withdrawal: Record<number, BigNumber>;\n  liquidationSequencerFee: BigNumber;\n  healthCheckSequencerFee: BigNumber;\n  takerSequencerFee: BigNumber;\n  feeTier: number;\n}\n\nexport interface EnginePriceTickLiquidity {\n  price: BigNumber;\n  liquidity: BigNumber;\n}\n\nexport interface GetEngineMarketLiquidityParams {\n  productId: number;\n  // The minimum depth in base price ticks (i.e. per side\n  depth: number;\n}\n\nexport interface GetEngineMarketLiquidityResponse {\n  bids: EnginePriceTickLiquidity[];\n  asks: EnginePriceTickLiquidity[];\n}\n\nexport interface GetEngineMarketPriceParams {\n  productId: number;\n}\n\nexport interface EngineMarketPrice {\n  productId: number;\n  bid: BigNumber;\n  ask: BigNumber;\n}\n\nexport type GetEngineMarketPriceResponse = EngineMarketPrice;\n\nexport interface GetEngineMarketPricesParams {\n  productIds: number[];\n}\n\nexport interface GetEngineMarketPricesResponse {\n  marketPrices: EngineMarketPrice[];\n}\n\nexport interface GetEngineMaxOrderSizeParams extends Subaccount {\n  price: BigNumber;\n  productId: number;\n  // Note: When `reduceOnly` is true, `side` must be opposite of the current position, otherwise it returns 0.\n  side: BalanceSide;\n  // If not given, engine defaults to true (leverage/borrow enabled) for spot\n  // Do not pass this for perp products\n  spotLeverage?: boolean;\n  // If not given, engine defaults to false. If true, the max order size will be capped to the subaccount's current position size;\n  // If no position exists, it will return 0.\n  reduceOnly?: boolean;\n  isolated?: boolean;\n  // If not given, engine defaults to true (do not borrow margin for isolated orders)\n  // Max order size query for `isolated` includes available transfer from the cross subaccount\n  isoBorrowMargin?: boolean;\n}\n\nexport type GetEngineMaxOrderSizeResponse = BigNumber;\n\nexport interface GetEngineMaxWithdrawableParams extends Subaccount {\n  productId: number;\n  // If not given, engine defaults to true (leverage/borrow enabled)\n  spotLeverage?: boolean;\n}\n\nexport type GetEngineMaxWithdrawableResponse = BigNumber;\n\nexport type GetEngineTimeResponse = EngineServerTimeResponse;\n\nexport type GetEngineLinkedSignerParams = Subaccount;\n\nexport interface GetEngineLinkedSignerResponse {\n  signer: string;\n}\n\nexport type GetEngineInsuranceResponse = BigNumber;\n\n/**\n * Given an IP, backend will either:\n * - Allow queries only through archive / engine (query_only)\n * - Block all requests (blocked)\n * - Allow all requests (null)\n */\nexport type GetEngineIpBlockStatusResponse = 'query_only' | 'blocked' | null;\n\n/**\n * ISO 3166-1 alpha-2 country code detected by the gateway (e.g. `'US'`, `'NO'`),\n * or `null` if the gateway did not provide one (e.g. local environments).\n *\n * Suitable for region-based UI gating such as geoblocking trading competitions.\n */\nexport type GetEngineCountryCodeResponse = string | null;\n\nexport interface GetEngineMaxMintNlpAmountParams extends Subaccount {\n  // If not given, engine defaults to true (leverage/borrow enabled)\n  spotLeverage?: boolean;\n}\n\nexport type GetEngineMaxMintNlpAmountResponse = BigNumber;\n\nexport type GetEngineMaxBurnNlpAmountParams = Subaccount;\n\nexport type GetEngineMaxBurnNlpAmountResponse = BigNumber;\n\nexport type GetEngineNlpLockedBalancesParams = Subaccount;\n\nexport interface EngineNlpBalance {\n  productId: number;\n  balance: BigNumber;\n}\n\nexport interface EngineNlpLockedBalance extends EngineNlpBalance {\n  unlockedAt: number;\n}\n\nexport interface GetEngineNlpLockedBalancesResponse {\n  lockedBalances: EngineNlpLockedBalance[];\n  balanceLocked: EngineNlpBalance;\n  balanceUnlocked: EngineNlpBalance;\n}\n\nexport interface NlpPool {\n  poolId: number;\n  subaccountHex: string;\n  ownerAddress: string;\n  balanceWeight: BigNumber;\n  subaccountInfo: GetEngineSubaccountSummaryResponse;\n  openOrders: EngineOrder[];\n}\n\nexport interface GetEngineNlpPoolInfoResponse {\n  nlpPools: NlpPool[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/clientQueryTypes.d.cts

@@ -178,6 +178,13 @@ type GetEngineInsuranceResponse = BigNumber;
  * - Allow all requests (null)
  */
 type GetEngineIpBlockStatusResponse = 'query_only' | 'blocked' | null;
+/**
+ * ISO 3166-1 alpha-2 country code detected by the gateway (e.g. `'US'`, `'NO'`),
+ * or `null` if the gateway did not provide one (e.g. local environments).
+ *
+ * Suitable for region-based UI gating such as geoblocking trading competitions.
+ */
+type GetEngineCountryCodeResponse = string | null;
 interface GetEngineMaxMintNlpAmountParams extends Subaccount {
     spotLeverage?: boolean;
 }
@@ -209,4 +216,4 @@ interface GetEngineNlpPoolInfoResponse {
     nlpPools: NlpPool[];
 }
 
-export type { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams };
+export type { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams };

package/dist/types/clientQueryTypes.d.ts

@@ -178,6 +178,13 @@ type GetEngineInsuranceResponse = BigNumber;
  * - Allow all requests (null)
  */
 type GetEngineIpBlockStatusResponse = 'query_only' | 'blocked' | null;
+/**
+ * ISO 3166-1 alpha-2 country code detected by the gateway (e.g. `'US'`, `'NO'`),
+ * or `null` if the gateway did not provide one (e.g. local environments).
+ *
+ * Suitable for region-based UI gating such as geoblocking trading competitions.
+ */
+type GetEngineCountryCodeResponse = string | null;
 interface GetEngineMaxMintNlpAmountParams extends Subaccount {
     spotLeverage?: boolean;
 }
@@ -209,4 +216,4 @@ interface GetEngineNlpPoolInfoResponse {
     nlpPools: NlpPool[];
 }
 
-export type { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams };
+export type { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams };

package/dist/types/index.d.cts

@@ -1,5 +1,5 @@
 export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersParams, EngineCancelProductOrdersParams, EngineExecuteRequestParamsByType, EngineLinkSignerParams, EngineLiquidateSubaccountParams, EngineMintNlpParams, EngineOrderParams, EnginePlaceOrderParams, EnginePlaceOrderResult, EnginePlaceOrdersParams, EngineTransferQuoteParams, EngineWithdrawCollateralParams, SignatureParams, WithBaseEngineExecuteParams, WithSignature } from './clientExecuteTypes.cjs';
-export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './clientQueryTypes.cjs';
+export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './clientQueryTypes.cjs';
 export { EngineServerFailureError } from './EngineServerFailureError.cjs';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './serverExecuteTypes.cjs';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerOrder, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './serverQueryModelTypes.cjs';

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersParams, EngineCancelProductOrdersParams, EngineExecuteRequestParamsByType, EngineLinkSignerParams, EngineLiquidateSubaccountParams, EngineMintNlpParams, EngineOrderParams, EnginePlaceOrderParams, EnginePlaceOrderResult, EnginePlaceOrdersParams, EngineTransferQuoteParams, EngineWithdrawCollateralParams, SignatureParams, WithBaseEngineExecuteParams, WithSignature } from './clientExecuteTypes.js';
-export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './clientQueryTypes.js';
+export { EngineMarketPrice, EngineNlpBalance, EngineNlpLockedBalance, EngineOrder, EnginePriceTickLiquidity, EngineSubaccountOrders, EngineSymbol, EngineSymbolsResponse, GetEngineAllMarketsResponse, GetEngineContractsResponse, GetEngineCountryCodeResponse, GetEngineEstimatedSubaccountSummaryParams, GetEngineHealthGroupsResponse, GetEngineInsuranceResponse, GetEngineIpBlockStatusResponse, GetEngineIsolatedPositionsParams, GetEngineIsolatedPositionsResponse, GetEngineLinkedSignerParams, GetEngineLinkedSignerResponse, GetEngineMarketLiquidityParams, GetEngineMarketLiquidityResponse, GetEngineMarketPriceParams, GetEngineMarketPriceResponse, GetEngineMarketPricesParams, GetEngineMarketPricesResponse, GetEngineMaxBurnNlpAmountParams, GetEngineMaxBurnNlpAmountResponse, GetEngineMaxMintNlpAmountParams, GetEngineMaxMintNlpAmountResponse, GetEngineMaxOrderSizeParams, GetEngineMaxOrderSizeResponse, GetEngineMaxWithdrawableParams, GetEngineMaxWithdrawableResponse, GetEngineNlpLockedBalancesParams, GetEngineNlpLockedBalancesResponse, GetEngineNlpPoolInfoResponse, GetEngineNoncesParams, GetEngineNoncesResponse, GetEngineOrderParams, GetEngineOrderResponse, GetEngineSubaccountFeeRatesParams, GetEngineSubaccountFeeRatesResponse, GetEngineSubaccountOrdersParams, GetEngineSubaccountOrdersResponse, GetEngineSubaccountProductOrdersParams, GetEngineSubaccountProductOrdersResponse, GetEngineSubaccountSummaryParams, GetEngineSubaccountSummaryResponse, GetEngineSymbolsParams, GetEngineTimeResponse, NlpPool, SubaccountIsolatedPosition, SubaccountOrderFeeRates, SubaccountProductDeltaTx, SubaccountSummaryState, SubaccountTx, ValidateEngineOrderParams, ValidateEngineOrderResponse, ValidateSignedEngineOrderParams } from './clientQueryTypes.js';
 export { EngineServerFailureError } from './EngineServerFailureError.js';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './serverExecuteTypes.js';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerOrder, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './serverQueryModelTypes.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nadohq/engine-client",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "sideEffects": false,
   "description": "HTTP client for the Nado off-chain matching engine",
@@ -41,7 +41,7 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@nadohq/shared": "^0.13.0",
+    "@nadohq/shared": "^0.14.0",
     "axios": "1.14.0",
     "ts-mixer": "6.0.4"
   },
@@ -53,5 +53,5 @@
     "bignumber.js": "10.0.2",
     "viem": "2.45.3"
   },
-  "gitHead": "e1ee8f9301cf6bd6b0775d505e7606a80eed1458"
+  "gitHead": "162e859a10cd0b9e4a14e435fec184f202746cf3"
 }

package/src/EngineWebClient.ts

@@ -1,10 +1,13 @@
 import { EngineBaseClient } from './EngineBaseClient';
 import {
   EngineServerIpBlockResponse,
+  GetEngineCountryCodeResponse,
   GetEngineIpBlockStatusResponse,
   GetEngineTimeResponse,
 } from './types';
 
+const COUNTRY_HEADER = 'x-nado-country';
+
 /**
  * Queries that talk directly to web, _not_ the engine. Placing here in the `engine-client` as we don't have enough
  * use cases to justify a separate package
@@ -16,7 +19,7 @@ export class EngineWebClient extends EngineBaseClient {
   async getIpBlockStatus(): Promise<GetEngineIpBlockStatusResponse> {
     return (
       this.axiosInstance
-        // Use the /time endpoint and listen to 403 responses
+        // Use the /ip endpoint and listen to 403 responses
         .get(`${this.opts.url}/ip`, {
           // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false
           withCredentials: false,
@@ -36,6 +39,23 @@ export class EngineWebClient extends EngineBaseClient {
     );
   }
 
+  /**
+   * Retrieves the caller's country code as detected by the gateway, sourced
+   * from the `x-nado-country` response header on `/ip`. Returns `null` when
+   * the gateway does not provide it (e.g. local environments).
+   *
+   * Useful for region-based UI gating such as geoblocking trading competitions.
+   */
+  async getCountryCode(): Promise<GetEngineCountryCodeResponse> {
+    const res = await this.axiosInstance.get(`${this.opts.url}/ip`, {
+      // IP checks go through Cloudflare, which uses allow-origin as *, so withCredentials needs to be false
+      withCredentials: false,
+    });
+
+    const rawCountry = res.headers?.[COUNTRY_HEADER] as string | undefined;
+    return rawCountry ?? null;
+  }
+
   /**
    * Determines whether a client needs to complete the cloudflare JS challenge to interact with the API
    *

package/src/types/clientQueryTypes.ts

@@ -256,6 +256,14 @@ export type GetEngineInsuranceResponse = BigNumber;
  */
 export type GetEngineIpBlockStatusResponse = 'query_only' | 'blocked' | null;
 
+/**
+ * ISO 3166-1 alpha-2 country code detected by the gateway (e.g. `'US'`, `'NO'`),
+ * or `null` if the gateway did not provide one (e.g. local environments).
+ *
+ * Suitable for region-based UI gating such as geoblocking trading competitions.
+ */
+export type GetEngineCountryCodeResponse = string | null;
+
 export interface GetEngineMaxMintNlpAmountParams extends Subaccount {
   // If not given, engine defaults to true (leverage/borrow enabled)
   spotLeverage?: boolean;