@reyaxyz/api-sdk 0.12.0 → 0.14.0

package/dist/clients/api-client.js

@@ -18,6 +18,7 @@ exports.ApiClient = void 0;
 var constants_1 = require("./helpers/constants");
 var markets_1 = __importDefault(require("./modules/markets"));
 var account_1 = __importDefault(require("./modules/account"));
+var trade_simulation_1 = __importDefault(require("./modules/trade.simulation"));
 /**
  * @description Client for API
  */
@@ -27,6 +28,7 @@ var ApiClient = /** @class */ (function () {
         ApiClient.config = __assign(__assign({}, ApiClient.config), config);
         this._markets = new markets_1.default(this.apiEndpoint);
         this._account = new account_1.default(this.apiEndpoint);
+        this._trade_simulation = new trade_simulation_1.default();
     }
     ApiClient.configure = function (config) {
         ApiClient.config = config;
@@ -66,6 +68,26 @@ var ApiClient = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ApiClient, "tradeSimulation", {
+        /**
+         * Provides access to the TradeSimulationClient instance.
+         * This getter allows for interacting with trade simulation functionalities.
+         * It ensures a singleton pattern by fetching the instance from the ApiClient's
+         * private `_trade_simulation` property, ensuring that trade simulation operations
+         * use a consistent client configuration and state.
+         *
+         * @returns {TradeSimulationClient} An instance of TradeSimulationClient for trade simulation operations.
+         * @memberof ApiClient
+         * @example
+         * // Access the trade simulation client from the ApiClient
+         * const tradeSimulationClient = ApiClient.tradeSimulation;
+         */
+        get: function () {
+            return ApiClient.getInstance()._trade_simulation;
+        },
+        enumerable: false,
+        configurable: true
+    });
     ApiClient.config = {
         production: true, // default value
         timeout: constants_1.API_TIMEOUT, // default value, e.g., 5000 milliseconds

package/dist/clients/api-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-client.js","sourceRoot":"/","sources":["clients/api-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAK6B;AAC7B,8DAA8C;AAC9C,8DAA8C;AAE9C;;GAEG;AACH;IAUE,mBAAoB,MAAqB;QACvC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,0BAAc,CAAC,CAAC,CAAC,uBAAW,CAAC;QACpE,SAAS,CAAC,MAAM,yBAAQ,SAAS,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAEa,mBAAS,GAAvB,UAAwB,MAAqB;QAC3C,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,QAAQ,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAEc,qBAAW,GAA1B;QACE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC;IAC5B,CAAC;IASD,sBAAkB,oBAAO;QAPzB;;;;;;WAMG;aACH;YACE,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC;QAC1C,CAAC;;;OAAA;IASD,sBAAkB,oBAAO;QAPzB;;;;;;WAMG;aACH;YACE,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC;QAC1C,CAAC;;;OAAA;IAjDc,gBAAM,GAAkB;QACrC,UAAU,EAAE,IAAI,EAAE,gBAAgB;QAClC,OAAO,EAAE,uBAAW,EAAE,yCAAyC;KAChE,CAAC;IA+CJ,gBAAC;CAAA,AApDD,IAoDC;AApDY,8BAAS","sourcesContent":["import {\n  ServiceConfig,\n  API_TIMEOUT,\n  API_TESTNET,\n  API_PRODUCTION,\n} from './helpers/constants';\nimport MarketsClient from './modules/markets';\nimport AccountClient from './modules/account';\n\n/**\n * @description Client for API\n */\nexport class ApiClient {\n  private static instance: ApiClient;\n  private static config: ServiceConfig = {\n    production: true, // default value\n    timeout: API_TIMEOUT, // default value, e.g., 5000 milliseconds\n  };\n  private readonly apiEndpoint: string;\n  private readonly _markets: MarketsClient;\n  private readonly _account: AccountClient;\n\n  private constructor(config: ServiceConfig) {\n    this.apiEndpoint = config.production ? API_PRODUCTION : API_TESTNET;\n    ApiClient.config = { ...ApiClient.config, ...config };\n    this._markets = new MarketsClient(this.apiEndpoint);\n    this._account = new AccountClient(this.apiEndpoint);\n  }\n\n  public static configure(config: ServiceConfig): void {\n    ApiClient.config = config;\n    ApiClient.instance = new ApiClient(config);\n  }\n\n  private static getInstance(): ApiClient {\n    if (!ApiClient.instance) {\n      throw new Error(\n        'ApiClient is not configured. Please configure it before using.',\n      );\n    }\n    return ApiClient.instance;\n  }\n\n  /**\n   * Provides access to the MarketsClient instance.\n   * This getter allows for interacting with market-related API functionalities.\n   *\n   * @returns {MarketsClient} An instance of MarketsClient for market-related operations.\n   * @memberof ApiClient\n   */\n  public static get markets(): MarketsClient {\n    return ApiClient.getInstance()._markets;\n  }\n\n  /**\n   * Provides access to the AccountClient instance.\n   * This getter allows for interacting with account-related API functionalities.\n   *\n   * @returns {AccountClient} An instance of AccountClient for account-related operations.\n   * @memberof ApiClient\n   */\n  public static get account(): AccountClient {\n    return ApiClient.getInstance()._account;\n  }\n}\n"]}
+{"version":3,"file":"api-client.js","sourceRoot":"/","sources":["clients/api-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAK6B;AAC7B,8DAA8C;AAC9C,8DAA8C;AAC9C,gFAA+D;AAE/D;;GAEG;AACH;IAWE,mBAAoB,MAAqB;QACvC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,0BAAc,CAAC,CAAC,CAAC,uBAAW,CAAC;QACpE,SAAS,CAAC,MAAM,yBAAQ,SAAS,CAAC,MAAM,GAAK,MAAM,CAAE,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,iBAAiB,GAAG,IAAI,0BAAqB,EAAE,CAAC;IACvD,CAAC;IAEa,mBAAS,GAAvB,UAAwB,MAAqB;QAC3C,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,QAAQ,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAEc,qBAAW,GAA1B;QACE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC;IAC5B,CAAC;IASD,sBAAkB,oBAAO;QAPzB;;;;;;WAMG;aACH;YACE,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC;QAC1C,CAAC;;;OAAA;IASD,sBAAkB,oBAAO;QAPzB;;;;;;WAMG;aACH;YACE,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC;QAC1C,CAAC;;;OAAA;IAgBD,sBAAkB,4BAAe;QAdjC;;;;;;;;;;;;WAYG;aAEH;YACE,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC;QACnD,CAAC;;;OAAA;IArEc,gBAAM,GAAkB;QACrC,UAAU,EAAE,IAAI,EAAE,gBAAgB;QAClC,OAAO,EAAE,uBAAW,EAAE,yCAAyC;KAChE,CAAC;IAmEJ,gBAAC;CAAA,AAxED,IAwEC;AAxEY,8BAAS","sourcesContent":["import {\n  ServiceConfig,\n  API_TIMEOUT,\n  API_TESTNET,\n  API_PRODUCTION,\n} from './helpers/constants';\nimport MarketsClient from './modules/markets';\nimport AccountClient from './modules/account';\nimport TradeSimulationClient from './modules/trade.simulation';\n\n/**\n * @description Client for API\n */\nexport class ApiClient {\n  private static instance: ApiClient;\n  private static config: ServiceConfig = {\n    production: true, // default value\n    timeout: API_TIMEOUT, // default value, e.g., 5000 milliseconds\n  };\n  private readonly apiEndpoint: string;\n  private readonly _markets: MarketsClient;\n  private readonly _account: AccountClient;\n  private readonly _trade_simulation: TradeSimulationClient;\n\n  private constructor(config: ServiceConfig) {\n    this.apiEndpoint = config.production ? API_PRODUCTION : API_TESTNET;\n    ApiClient.config = { ...ApiClient.config, ...config };\n    this._markets = new MarketsClient(this.apiEndpoint);\n    this._account = new AccountClient(this.apiEndpoint);\n    this._trade_simulation = new TradeSimulationClient();\n  }\n\n  public static configure(config: ServiceConfig): void {\n    ApiClient.config = config;\n    ApiClient.instance = new ApiClient(config);\n  }\n\n  private static getInstance(): ApiClient {\n    if (!ApiClient.instance) {\n      throw new Error(\n        'ApiClient is not configured. Please configure it before using.',\n      );\n    }\n    return ApiClient.instance;\n  }\n\n  /**\n   * Provides access to the MarketsClient instance.\n   * This getter allows for interacting with market-related API functionalities.\n   *\n   * @returns {MarketsClient} An instance of MarketsClient for market-related operations.\n   * @memberof ApiClient\n   */\n  public static get markets(): MarketsClient {\n    return ApiClient.getInstance()._markets;\n  }\n\n  /**\n   * Provides access to the AccountClient instance.\n   * This getter allows for interacting with account-related API functionalities.\n   *\n   * @returns {AccountClient} An instance of AccountClient for account-related operations.\n   * @memberof ApiClient\n   */\n  public static get account(): AccountClient {\n    return ApiClient.getInstance()._account;\n  }\n\n  /**\n   * Provides access to the TradeSimulationClient instance.\n   * This getter allows for interacting with trade simulation functionalities.\n   * It ensures a singleton pattern by fetching the instance from the ApiClient's\n   * private `_trade_simulation` property, ensuring that trade simulation operations\n   * use a consistent client configuration and state.\n   *\n   * @returns {TradeSimulationClient} An instance of TradeSimulationClient for trade simulation operations.\n   * @memberof ApiClient\n   * @example\n   * // Access the trade simulation client from the ApiClient\n   * const tradeSimulationClient = ApiClient.tradeSimulation;\n   */\n\n  public static get tradeSimulation(): TradeSimulationClient {\n    return ApiClient.getInstance()._trade_simulation;\n  }\n}\n"]}

package/dist/clients/modules/trade.simulation.js

@@ -0,0 +1,112 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// The maximum is inclusive and the minimum is inclusive
+function getRandomIntInclusive(min, max) {
+    min = Math.ceil(min);
+    max = Math.floor(max);
+    return Math.floor(Math.random() * (max - min + 1) + min);
+}
+var randomHealth = function () {
+    return Math.random() * 100 > 50
+        ? 'healthy'
+        : Math.random() * 100 > 50
+            ? 'danger'
+            : 'warning';
+};
+function getRandomFloat(min, max) {
+    return Math.random() * (max - min) + min;
+}
+var TradeSimulationClient = /** @class */ (function () {
+    function TradeSimulationClient() {
+        this.marketId = null;
+        this.accountId = null;
+        this.loadedData = null;
+    }
+    // Method to asynchronously load data based on marketId and accountId
+    TradeSimulationClient.prototype.loadData = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var marketData;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.marketId = params.market_id;
+                        this.accountId = params.marginAccountId;
+                        return [4 /*yield*/, this.fetchMarketData(this.marketId, this.accountId)];
+                    case 1:
+                        marketData = _a.sent();
+                        // Store the loaded data
+                        this.loadedData = { marketData: marketData };
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    TradeSimulationClient.prototype.fetchMarketData = function (marketId, accountId) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 500); })];
+                    case 1:
+                        _a.sent(); // wait for 500ms
+                        return [2 /*return*/, 1 + marketId + accountId];
+                }
+            });
+        });
+    };
+    // Synchronous method to simulate operations based on an amount
+    TradeSimulationClient.prototype.simulate = function (params) {
+        if (!this.loadedData) {
+            throw new Error('Data not loaded. Call loadData() first.');
+        }
+        // @todo perform simulation
+        return {
+            estimatedPrice: getRandomIntInclusive(1000, 100000) + params.amount,
+            estimatedSlippage: getRandomFloat(0.00001, 0.05),
+            fees: getRandomIntInclusive(1000, 100000),
+            impliedLeverage: getRandomIntInclusive(20, 50),
+            imr: getRandomIntInclusive(1000, 100000),
+            liquidationPrice: getRandomIntInclusive(1000, 100000),
+            marginRatio: getRandomIntInclusive(0, 100),
+            marginRatioHealth: randomHealth(),
+        };
+    };
+    return TradeSimulationClient;
+}());
+exports.default = TradeSimulationClient;
+//# sourceMappingURL=trade.simulation.js.map

package/dist/clients/modules/trade.simulation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade.simulation.js","sourceRoot":"/","sources":["clients/modules/trade.simulation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,wDAAwD;AACxD,SAAS,qBAAqB,CAAC,GAAW,EAAE,GAAW;IACrD,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,IAAM,YAAY,GAAG;IACnB,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE;QAC7B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE;YACxB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,SAAS,cAAc,CAAC,GAAW,EAAE,GAAW;IAC9C,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;AAC3C,CAAC;AAED;IAAA;QACU,aAAQ,GAAkB,IAAI,CAAC;QAC/B,cAAS,GAAkB,IAAI,CAAC;QAChC,eAAU,GAAsB,IAAI,CAAC;IA4C/C,CAAC;IA1CC,qEAAqE;IAC/D,wCAAQ,GAAd,UAAe,MAAqC;;;;;;wBAClD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC;wBACjC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC;wBAGrB,qBAAM,IAAI,CAAC,eAAe,CAC3C,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,CACf,EAAA;;wBAHK,UAAU,GAAG,SAGlB;wBAED,wBAAwB;wBACxB,IAAI,CAAC,UAAU,GAAG,EAAE,UAAU,YAAA,EAAE,CAAC;;;;;KAClC;IAEa,+CAAe,GAA7B,UACE,QAAgB,EAChB,SAAiB;;;;4BAEjB,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,EAAxB,CAAwB,CAAC,EAAA;;wBAAxD,SAAwD,CAAC,CAAC,iBAAiB;wBAC3E,sBAAO,CAAC,GAAG,QAAQ,GAAG,SAAS,EAAC;;;;KACjC;IAED,+DAA+D;IAC/D,wCAAQ,GAAR,UAAS,MAAqC;QAC5C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,2BAA2B;QAE3B,OAAO;YACL,cAAc,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM;YACnE,iBAAiB,EAAE,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;YAChD,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC;YACzC,eAAe,EAAE,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC;YAC9C,GAAG,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC;YACxC,gBAAgB,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC;YACrD,WAAW,EAAE,qBAAqB,CAAC,CAAC,EAAE,GAAG,CAAC;YAC1C,iBAAiB,EAAE,YAAY,EAAE;SACX,CAAC;IAC3B,CAAC;IACH,4BAAC;AAAD,CAAC,AA/CD,IA+CC","sourcesContent":["import {\n  SimulateTradeEntity,\n  TradeSimulationLoadDataParams,\n  TradeSimulationSimulateParams,\n} from '../types';\n\ntype LoadedData = {\n  marketData: number;\n};\n\n// The maximum is inclusive and the minimum is inclusive\nfunction getRandomIntInclusive(min: number, max: number) {\n  min = Math.ceil(min);\n  max = Math.floor(max);\n  return Math.floor(Math.random() * (max - min + 1) + min);\n}\n\nconst randomHealth = () => {\n  return Math.random() * 100 > 50\n    ? 'healthy'\n    : Math.random() * 100 > 50\n      ? 'danger'\n      : 'warning';\n};\n\nfunction getRandomFloat(min: number, max: number): number {\n  return Math.random() * (max - min) + min;\n}\n\nexport default class TradeSimulationClient {\n  private marketId: number | null = null;\n  private accountId: number | null = null;\n  private loadedData: LoadedData | null = null;\n\n  // Method to asynchronously load data based on marketId and accountId\n  async loadData(params: TradeSimulationLoadDataParams): Promise<void> {\n    this.marketId = params.market_id;\n    this.accountId = params.marginAccountId;\n\n    // Simulate fetching data (@todo replace this with actual data fetching logic)\n    const marketData = await this.fetchMarketData(\n      this.marketId,\n      this.accountId,\n    );\n\n    // Store the loaded data\n    this.loadedData = { marketData };\n  }\n\n  private async fetchMarketData(\n    marketId: number,\n    accountId: number,\n  ): Promise<number> {\n    await new Promise((resolve) => setTimeout(resolve, 500)); // wait for 500ms\n    return 1 + marketId + accountId;\n  }\n\n  // Synchronous method to simulate operations based on an amount\n  simulate(params: TradeSimulationSimulateParams): SimulateTradeEntity {\n    if (!this.loadedData) {\n      throw new Error('Data not loaded. Call loadData() first.');\n    }\n\n    // @todo perform simulation\n\n    return {\n      estimatedPrice: getRandomIntInclusive(1000, 100000) + params.amount,\n      estimatedSlippage: getRandomFloat(0.00001, 0.05),\n      fees: getRandomIntInclusive(1000, 100000),\n      impliedLeverage: getRandomIntInclusive(20, 50),\n      imr: getRandomIntInclusive(1000, 100000),\n      liquidationPrice: getRandomIntInclusive(1000, 100000),\n      marginRatio: getRandomIntInclusive(0, 100),\n      marginRatioHealth: randomHealth(),\n    } as SimulateTradeEntity;\n  }\n}\n"]}

package/dist/clients/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,+CAA0B,CAAA;IAC1B,8CAAyB,CAAA;IACzB,uCAAkB,CAAA;IAClB,0CAAqB,CAAA;IACrB,qCAAgB,CAAA;AAClB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B","sourcesContent":["export enum CandlesResolution {\n  ONE_MINUTE = '1MIN',\n  FIVE_MINUTES = '5MINS',\n  FIFTEEN_MINUTES = '15MINS',\n  THIRTY_MINUTES = '30MINS',\n  ONE_HOUR = '1HOUR',\n  FOUR_HOURS = '4HOURS',\n  ONE_DAY = '1DAY',\n}\n\n// -- Candles --\nexport interface Candle {\n  startedAt: string;\n  ticker: string;\n  resolution: CandlesResolution;\n  low: string;\n  high: string;\n  open: string;\n  close: string;\n  baseTokenVolume: string;\n  usdVolume: string;\n  trades: number;\n  startingOpenInterest: string;\n  id: string;\n}\n\nexport interface MarketCandlesResponse {\n  candles: Candle[];\n}\n\n// -- Markets --\n\nexport type MarketOrderInfo = {\n  counterpartyAccountIds: number[];\n  exchangeId: number;\n};\n\nexport type MarketEntity = {\n  id: number;\n  ticker: string;\n  underlyingAsset: string;\n  quoteToken: string;\n  markPrice: number;\n  isActive: boolean;\n  maxLeverage: number;\n  volume24H: number;\n  priceChange24H: number;\n  priceChange24HPercentage: number;\n  openInterest: number;\n  fundingRate: number;\n  description: string;\n  orderInfo: MarketOrderInfo;\n  tickSizeDecimals: number;\n};\n\nexport type GetMarketsResult = MarketEntity[];\n\nexport type GetMarketResult = MarketEntity;\n\nexport type GetMarketParams = {\n  id: MarketEntity['id'];\n};\n\nexport type GetCandlesParams = {\n  marketId: MarketEntity['id'];\n  resolution: CandlesResolution;\n  fromISO?: string | null;\n  toISO?: string | null;\n  limit?: number | null;\n};\n\n// -- Account --\n\nexport type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';\nexport type Side = 'LONG' | 'SHORT';\n\nexport type GetMarginAccountsParams = {\n  address: string;\n  limit?: number;\n};\n\nexport type GetMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n};\n\nexport type GetPositionsForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: number;\n};\n\nexport type MarginAccountEntity = {\n  id: number;\n  name: string;\n  marginRatioHealth: 'danger' | 'healthy' | 'warning';\n  marginRatioPercentage: number;\n  totalBalance: number;\n  totalBalanceUnderlyingAsset: string;\n  collaterals: {\n    token: string;\n    percentage: number;\n    balance: number;\n    balanceRUSD: number;\n  }[];\n};\n\nexport type GetMarginAccountsResult = MarginAccountEntity[];\nexport type GetMarginAccountResult = MarginAccountEntity;\n\nexport type PositionEntity = {\n  id: number;\n  side: Side;\n  size: number;\n  price: number;\n  markPrice: number;\n  orderStatus: Status;\n  realisedPnl?: number | null;\n  unrealisedPnl?: number | null;\n  liquidationPrice: number;\n  fundingRate: number;\n  market: MarketEntity;\n  date: Date;\n};\n\nexport type GetPositionsForMarginAccountResult = {\n  positions: PositionEntity[];\n  totalUnrealizedPNL: number;\n};\n\n// --- Trading History ----\n\nexport type GetMarketTradingHistoryParams = {\n  marketId: number;\n  limit?: number;\n};\n\nexport type TradingHistoryEntity = {\n  id: number;\n  price: number;\n  priceUnderlyingToken: string;\n  size: number;\n  sizeUnderlyingToken: string;\n  timestampMillisecondsUTC: number;\n};\n\nexport type GetTradingHistoryResult = TradingHistoryEntity[];\n\n// --- Position History ---\n\nexport type GetPositionsHistoryForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: number;\n};\n\nexport type OrderType = 'market';\n\nexport type PositionHistoryType =\n  | 'long-trade'\n  | 'short-trade'\n  | 'long-liquidation'\n  | 'short-liquidation';\n\nexport type PositionHistoryEntity = {\n  id: number;\n  action: PositionHistoryType;\n  orderType: OrderType;\n  size: number;\n  executionPrice: number;\n  realisedPnl?: number | null;\n  fees: number;\n  timestamp: number;\n  market: MarketEntity;\n};\n\nexport type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];\n\n// -- Max Order Size --\n\nexport type GetMaxOrderSizeAvailableParams = {\n  marketId: MarketEntity['id'];\n  marginAccountId: MarginAccountEntity['id'];\n  direction: 'long' | 'short';\n};\n\nexport type GetMaxOrderSizeAvailableResult = number;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,+CAA0B,CAAA;IAC1B,8CAAyB,CAAA;IACzB,uCAAkB,CAAA;IAClB,0CAAqB,CAAA;IACrB,qCAAgB,CAAA;AAClB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B","sourcesContent":["export enum CandlesResolution {\n  ONE_MINUTE = '1MIN',\n  FIVE_MINUTES = '5MINS',\n  FIFTEEN_MINUTES = '15MINS',\n  THIRTY_MINUTES = '30MINS',\n  ONE_HOUR = '1HOUR',\n  FOUR_HOURS = '4HOURS',\n  ONE_DAY = '1DAY',\n}\n\n// -- Candles --\nexport interface Candle {\n  startedAt: string;\n  ticker: string;\n  resolution: CandlesResolution;\n  low: string;\n  high: string;\n  open: string;\n  close: string;\n  baseTokenVolume: string;\n  usdVolume: string;\n  trades: number;\n  startingOpenInterest: string;\n  id: string;\n}\n\nexport interface MarketCandlesResponse {\n  candles: Candle[];\n}\n\n// -- Markets --\n\nexport type MarketOrderInfo = {\n  counterpartyAccountIds: number[];\n  exchangeId: number;\n};\n\nexport type MarketEntity = {\n  id: number;\n  ticker: string;\n  underlyingAsset: string;\n  quoteToken: string;\n  markPrice: number;\n  isActive: boolean;\n  maxLeverage: number;\n  volume24H: number;\n  priceChange24H: number;\n  priceChange24HPercentage: number;\n  openInterest: number;\n  fundingRate: number;\n  description: string;\n  orderInfo: MarketOrderInfo;\n  tickSizeDecimals: number;\n};\n\nexport type GetMarketsResult = MarketEntity[];\n\nexport type GetMarketResult = MarketEntity;\n\nexport type GetMarketParams = {\n  id: MarketEntity['id'];\n};\n\nexport type GetCandlesParams = {\n  marketId: MarketEntity['id'];\n  resolution: CandlesResolution;\n  fromISO?: string | null;\n  toISO?: string | null;\n  limit?: number | null;\n};\n\n// -- Account --\n\nexport type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';\nexport type Side = 'LONG' | 'SHORT';\n\nexport type GetMarginAccountsParams = {\n  address: string;\n  limit?: number;\n};\n\nexport type GetMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n};\n\nexport type GetPositionsForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: number;\n};\n\nexport type MarginAccountEntity = {\n  id: number;\n  name: string;\n  marginRatioHealth: 'danger' | 'healthy' | 'warning';\n  marginRatioPercentage: number;\n  totalBalance: number;\n  totalBalanceUnderlyingAsset: string;\n  collaterals: {\n    token: string;\n    percentage: number;\n    balance: number;\n    balanceRUSD: number;\n  }[];\n};\n\nexport type GetMarginAccountsResult = MarginAccountEntity[];\nexport type GetMarginAccountResult = MarginAccountEntity;\n\nexport type PositionEntity = {\n  id: number;\n  side: Side;\n  size: number;\n  base: number;\n  price: number;\n  markPrice: number;\n  orderStatus: Status;\n  realisedPnl?: number | null;\n  unrealisedPnl?: number | null;\n  liquidationPrice: number;\n  fundingRate: number;\n  market: MarketEntity;\n  date: Date;\n};\n\nexport type GetPositionsForMarginAccountResult = {\n  positions: PositionEntity[];\n  totalUnrealizedPNL: number;\n};\n\n// --- Trading History ----\n\nexport type GetMarketTradingHistoryParams = {\n  marketId: number;\n  limit?: number;\n};\n\nexport type TradingHistoryEntity = {\n  id: number;\n  price: number;\n  priceUnderlyingToken: string;\n  size: number;\n  sizeUnderlyingToken: string;\n  timestampMillisecondsUTC: number;\n};\n\nexport type GetTradingHistoryResult = TradingHistoryEntity[];\n\n// --- Position History ---\n\nexport type GetPositionsHistoryForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: number;\n};\n\nexport type OrderType = 'market';\n\nexport type PositionHistoryType =\n  | 'long-trade'\n  | 'short-trade'\n  | 'long-liquidation'\n  | 'short-liquidation';\n\nexport type PositionHistoryEntity = {\n  id: number;\n  action: PositionHistoryType;\n  orderType: OrderType;\n  size: number;\n  executionPrice: number;\n  realisedPnl?: number | null;\n  fees: number;\n  timestamp: number;\n  market: MarketEntity;\n};\n\nexport type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];\n\n// -- Max Order Size --\n\nexport type GetMaxOrderSizeAvailableParams = {\n  marketId: MarketEntity['id'];\n  marginAccountId: MarginAccountEntity['id'];\n  direction: 'long' | 'short';\n};\n\nexport type GetMaxOrderSizeAvailableResult = number;\n\n// --- Trade Simulation ----\n\nexport type SimulateTradeEntity = {\n  liquidationPrice: number;\n  fees: number;\n  estimatedPrice: number;\n  estimatedSlippage: number;\n  imr: number;\n  impliedLeverage: number;\n  marginRatio: MarginAccountEntity['marginRatioPercentage'];\n  marginRatioHealth: MarginAccountEntity['marginRatioHealth'];\n};\n\nexport type TradeSimulationLoadDataParams = {\n  market_id: MarketEntity['id'];\n  marginAccountId: MarginAccountEntity['id'];\n};\n\nexport type TradeSimulationSimulateParams = {\n  amount: number; // position size, + for long | - for short\n};\n"]}

package/dist/types/clients/api-client.d.ts

@@ -1,6 +1,7 @@
 import { ServiceConfig } from './helpers/constants';
 import MarketsClient from './modules/markets';
 import AccountClient from './modules/account';
+import TradeSimulationClient from './modules/trade.simulation';
 /**
  * @description Client for API
  */
@@ -10,6 +11,7 @@ export declare class ApiClient {
     private readonly apiEndpoint;
     private readonly _markets;
     private readonly _account;
+    private readonly _trade_simulation;
     private constructor();
     static configure(config: ServiceConfig): void;
     private static getInstance;
@@ -29,5 +31,19 @@ export declare class ApiClient {
      * @memberof ApiClient
      */
     static get account(): AccountClient;
+    /**
+     * Provides access to the TradeSimulationClient instance.
+     * This getter allows for interacting with trade simulation functionalities.
+     * It ensures a singleton pattern by fetching the instance from the ApiClient's
+     * private `_trade_simulation` property, ensuring that trade simulation operations
+     * use a consistent client configuration and state.
+     *
+     * @returns {TradeSimulationClient} An instance of TradeSimulationClient for trade simulation operations.
+     * @memberof ApiClient
+     * @example
+     * // Access the trade simulation client from the ApiClient
+     * const tradeSimulationClient = ApiClient.tradeSimulation;
+     */
+    static get tradeSimulation(): TradeSimulationClient;
 }
 //# sourceMappingURL=api-client.d.ts.map

package/dist/types/clients/api-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-client.d.ts","sourceRoot":"/","sources":["clients/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAId,MAAM,qBAAqB,CAAC;AAC7B,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAE9C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAY;IACnC,OAAO,CAAC,MAAM,CAAC,MAAM,CAGnB;IACF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAEzC,OAAO;WAOO,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAKpD,OAAO,CAAC,MAAM,CAAC,WAAW;IAS1B;;;;;;OAMG;IACH,WAAkB,OAAO,IAAI,aAAa,CAEzC;IAED;;;;;;OAMG;IACH,WAAkB,OAAO,IAAI,aAAa,CAEzC;CACF"}
+{"version":3,"file":"api-client.d.ts","sourceRoot":"/","sources":["clients/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAId,MAAM,qBAAqB,CAAC;AAC7B,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAE/D;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAY;IACnC,OAAO,CAAC,MAAM,CAAC,MAAM,CAGnB;IACF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAwB;IAE1D,OAAO;WAQO,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAKpD,OAAO,CAAC,MAAM,CAAC,WAAW;IAS1B;;;;;;OAMG;IACH,WAAkB,OAAO,IAAI,aAAa,CAEzC;IAED;;;;;;OAMG;IACH,WAAkB,OAAO,IAAI,aAAa,CAEzC;IAED;;;;;;;;;;;;OAYG;IAEH,WAAkB,eAAe,IAAI,qBAAqB,CAEzD;CACF"}

package/dist/types/clients/modules/trade.simulation.d.ts

@@ -0,0 +1,10 @@
+import { SimulateTradeEntity, TradeSimulationLoadDataParams, TradeSimulationSimulateParams } from '../types';
+export default class TradeSimulationClient {
+    private marketId;
+    private accountId;
+    private loadedData;
+    loadData(params: TradeSimulationLoadDataParams): Promise<void>;
+    private fetchMarketData;
+    simulate(params: TradeSimulationSimulateParams): SimulateTradeEntity;
+}
+//# sourceMappingURL=trade.simulation.d.ts.map

package/dist/types/clients/modules/trade.simulation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade.simulation.d.ts","sourceRoot":"/","sources":["clients/modules/trade.simulation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,UAAU,CAAC;AAyBlB,MAAM,CAAC,OAAO,OAAO,qBAAqB;IACxC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,UAAU,CAA2B;IAGvC,QAAQ,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;YActD,eAAe;IAS7B,QAAQ,CAAC,MAAM,EAAE,6BAA6B,GAAG,mBAAmB;CAkBrE"}

package/dist/types/clients/types.d.ts

@@ -92,6 +92,7 @@ export type PositionEntity = {
     id: number;
     side: Side;
     size: number;
+    base: number;
     price: number;
     markPrice: number;
     orderStatus: Status;
@@ -144,4 +145,21 @@ export type GetMaxOrderSizeAvailableParams = {
     direction: 'long' | 'short';
 };
 export type GetMaxOrderSizeAvailableResult = number;
+export type SimulateTradeEntity = {
+    liquidationPrice: number;
+    fees: number;
+    estimatedPrice: number;
+    estimatedSlippage: number;
+    imr: number;
+    impliedLeverage: number;
+    marginRatio: MarginAccountEntity['marginRatioPercentage'];
+    marginRatioHealth: MarginAccountEntity['marginRatioHealth'];
+};
+export type TradeSimulationLoadDataParams = {
+    market_id: MarketEntity['id'];
+    marginAccountId: MarginAccountEntity['id'];
+};
+export type TradeSimulationSimulateParams = {
+    amount: number;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types/clients/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":"AAAA,oBAAY,iBAAiB;IAC3B,UAAU,SAAS;IACnB,YAAY,UAAU;IACtB,eAAe,WAAW;IAC1B,cAAc,WAAW;IACzB,QAAQ,UAAU;IAClB,UAAU,WAAW;IACrB,OAAO,SAAS;CACjB;AAGD,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,iBAAiB,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAID,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,eAAe,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,YAAY,EAAE,CAAC;AAE9C,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC;AAE3C,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAIF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;AACjE,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpC,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IACpD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B,EAAE,MAAM,CAAC;IACpC,WAAW,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAC5D,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAIF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,EAAE,CAAC;AAI7D,MAAM,MAAM,yCAAyC,GAAG;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;AAEjC,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,aAAa,GACb,kBAAkB,GAClB,mBAAmB,CAAC;AAExB,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,EAAE,CAAC;AAIhF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":"AAAA,oBAAY,iBAAiB;IAC3B,UAAU,SAAS;IACnB,YAAY,UAAU;IACtB,eAAe,WAAW;IAC1B,cAAc,WAAW;IACzB,QAAQ,UAAU;IAClB,UAAU,WAAW;IACrB,OAAO,SAAS;CACjB;AAGD,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,iBAAiB,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAID,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,eAAe,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,YAAY,EAAE,CAAC;AAE9C,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC;AAE3C,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAIF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;AACjE,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpC,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IACpD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B,EAAE,MAAM,CAAC;IACpC,WAAW,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAC5D,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAIF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,EAAE,CAAC;AAI7D,MAAM,MAAM,yCAAyC,GAAG;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;AAEjC,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,aAAa,GACb,kBAAkB,GAClB,mBAAmB,CAAC;AAExB,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,EAAE,CAAC;AAIhF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC;AAIpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;IAC1D,iBAAiB,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9B,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reyaxyz/api-sdk",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -36,5 +36,5 @@
     "axios": "^1.6.2"
   },
   "packageManager": "pnpm@8.10.4",
-  "gitHead": "87c152da16dea3405a23f0e6957a3fb7da79fd3b"
+  "gitHead": "4d95847e468540e2377e3c45f67f8635f1143a08"
 }

package/src/clients/api-client.ts

@@ -6,6 +6,7 @@ import {
 } from './helpers/constants';
 import MarketsClient from './modules/markets';
 import AccountClient from './modules/account';
+import TradeSimulationClient from './modules/trade.simulation';
 
 /**
  * @description Client for API
@@ -19,12 +20,14 @@ export class ApiClient {
   private readonly apiEndpoint: string;
   private readonly _markets: MarketsClient;
   private readonly _account: AccountClient;
+  private readonly _trade_simulation: TradeSimulationClient;
 
   private constructor(config: ServiceConfig) {
     this.apiEndpoint = config.production ? API_PRODUCTION : API_TESTNET;
     ApiClient.config = { ...ApiClient.config, ...config };
     this._markets = new MarketsClient(this.apiEndpoint);
     this._account = new AccountClient(this.apiEndpoint);
+    this._trade_simulation = new TradeSimulationClient();
   }
 
   public static configure(config: ServiceConfig): void {
@@ -62,4 +65,22 @@ export class ApiClient {
   public static get account(): AccountClient {
     return ApiClient.getInstance()._account;
   }
+
+  /**
+   * Provides access to the TradeSimulationClient instance.
+   * This getter allows for interacting with trade simulation functionalities.
+   * It ensures a singleton pattern by fetching the instance from the ApiClient's
+   * private `_trade_simulation` property, ensuring that trade simulation operations
+   * use a consistent client configuration and state.
+   *
+   * @returns {TradeSimulationClient} An instance of TradeSimulationClient for trade simulation operations.
+   * @memberof ApiClient
+   * @example
+   * // Access the trade simulation client from the ApiClient
+   * const tradeSimulationClient = ApiClient.tradeSimulation;
+   */
+
+  public static get tradeSimulation(): TradeSimulationClient {
+    return ApiClient.getInstance()._trade_simulation;
+  }
 }

package/src/clients/modules/trade.simulation.ts

@@ -0,0 +1,77 @@
+import {
+  SimulateTradeEntity,
+  TradeSimulationLoadDataParams,
+  TradeSimulationSimulateParams,
+} from '../types';
+
+type LoadedData = {
+  marketData: number;
+};
+
+// The maximum is inclusive and the minimum is inclusive
+function getRandomIntInclusive(min: number, max: number) {
+  min = Math.ceil(min);
+  max = Math.floor(max);
+  return Math.floor(Math.random() * (max - min + 1) + min);
+}
+
+const randomHealth = () => {
+  return Math.random() * 100 > 50
+    ? 'healthy'
+    : Math.random() * 100 > 50
+      ? 'danger'
+      : 'warning';
+};
+
+function getRandomFloat(min: number, max: number): number {
+  return Math.random() * (max - min) + min;
+}
+
+export default class TradeSimulationClient {
+  private marketId: number | null = null;
+  private accountId: number | null = null;
+  private loadedData: LoadedData | null = null;
+
+  // Method to asynchronously load data based on marketId and accountId
+  async loadData(params: TradeSimulationLoadDataParams): Promise<void> {
+    this.marketId = params.market_id;
+    this.accountId = params.marginAccountId;
+
+    // Simulate fetching data (@todo replace this with actual data fetching logic)
+    const marketData = await this.fetchMarketData(
+      this.marketId,
+      this.accountId,
+    );
+
+    // Store the loaded data
+    this.loadedData = { marketData };
+  }
+
+  private async fetchMarketData(
+    marketId: number,
+    accountId: number,
+  ): Promise<number> {
+    await new Promise((resolve) => setTimeout(resolve, 500)); // wait for 500ms
+    return 1 + marketId + accountId;
+  }
+
+  // Synchronous method to simulate operations based on an amount
+  simulate(params: TradeSimulationSimulateParams): SimulateTradeEntity {
+    if (!this.loadedData) {
+      throw new Error('Data not loaded. Call loadData() first.');
+    }
+
+    // @todo perform simulation
+
+    return {
+      estimatedPrice: getRandomIntInclusive(1000, 100000) + params.amount,
+      estimatedSlippage: getRandomFloat(0.00001, 0.05),
+      fees: getRandomIntInclusive(1000, 100000),
+      impliedLeverage: getRandomIntInclusive(20, 50),
+      imr: getRandomIntInclusive(1000, 100000),
+      liquidationPrice: getRandomIntInclusive(1000, 100000),
+      marginRatio: getRandomIntInclusive(0, 100),
+      marginRatioHealth: randomHealth(),
+    } as SimulateTradeEntity;
+  }
+}

package/src/clients/types.ts

@@ -112,6 +112,7 @@ export type PositionEntity = {
   id: number;
   side: Side;
   size: number;
+  base: number;
   price: number;
   markPrice: number;
   orderStatus: Status;
@@ -185,3 +186,25 @@ export type GetMaxOrderSizeAvailableParams = {
 };
 
 export type GetMaxOrderSizeAvailableResult = number;
+
+// --- Trade Simulation ----
+
+export type SimulateTradeEntity = {
+  liquidationPrice: number;
+  fees: number;
+  estimatedPrice: number;
+  estimatedSlippage: number;
+  imr: number;
+  impliedLeverage: number;
+  marginRatio: MarginAccountEntity['marginRatioPercentage'];
+  marginRatioHealth: MarginAccountEntity['marginRatioHealth'];
+};
+
+export type TradeSimulationLoadDataParams = {
+  market_id: MarketEntity['id'];
+  marginAccountId: MarginAccountEntity['id'];
+};
+
+export type TradeSimulationSimulateParams = {
+  amount: number; // position size, + for long | - for short
+};