@nightlylabs/dex-sdk 0.3.42 → 1.0.0

package/dist/index.cjs

@@ -30,11 +30,9 @@ __export(index_exports, {
   ExchangeProxies: () => ExchangeProxies,
   GLOBAL_DENOMINATOR: () => GLOBAL_DENOMINATOR,
   MAINNET_CONFIG: () => MAINNET_CONFIG,
-  Network: () => Network2,
   OrderSide: () => OrderSide,
   OrderStatus: () => OrderStatus,
   OrderType: () => OrderType,
-  Status: () => Status,
   TESTNET_CONFIG: () => TESTNET_CONFIG,
   TestFaucet: () => TestFaucet,
   TradeRole: () => TradeRole,
@@ -50,6 +48,7 @@ __export(index_exports, {
   getTopicFromCommand: () => getTopicFromCommand,
   getTopicFromMessage: () => getTopicFromMessage,
   nowInMiliseconds: () => nowInMiliseconds,
+  nowInMilliseconds: () => nowInMilliseconds,
   parseEntryFunctionAbi: () => parseEntryFunctionAbi,
   sleep: () => sleep,
   toSystemValue: () => toSystemValue
@@ -23390,9 +23389,6 @@ function getNetworkModeFromEnv() {
 }
 function createAptosClient(mode) {
   const config = getNetworkConfig(mode);
-  console.log(`Creating Aptos client for ${mode.toUpperCase()}`);
-  console.log(`Fullnode URL: ${config.fullnode}`);
-  console.log(`Indexer URL: ${config.indexer}`);
   const aptosConfig = new import_ts_sdk.AptosConfig({
     network: import_ts_sdk.Network.CUSTOM,
     fullnode: config.fullnode,
@@ -23616,23 +23612,12 @@ var UserStatus = /* @__PURE__ */ ((UserStatus2) => {
 // src/utils.ts
 var import_ts_sdk2 = require("@aptos-labs/ts-sdk");
 
-// src/types.ts
-var Status = /* @__PURE__ */ ((Status2) => {
-  Status2[Status2["Halted"] = 0] = "Halted";
-  Status2[Status2["ReduceOnly"] = 1] = "ReduceOnly";
-  Status2[Status2["PostOnly"] = 2] = "PostOnly";
-  Status2[Status2["Live"] = 3] = "Live";
-  return Status2;
-})(Status || {});
-var Network2 = /* @__PURE__ */ ((Network3) => {
-  Network3["Devnet"] = "Devnet";
-  return Network3;
-})(Network2 || {});
-
 // src/static.ts
 var ExchangeProxies = {
-  ["Devnet" /* Devnet */]: ["0x1"]
-  // TODO define it
+  testnet: ["0x1"],
+  // TODO define actual testnet proxy address(es)
+  mainnet: ["0x1"]
+  // TODO define actual mainnet proxy address(es)
 };
 var GLOBAL_DENOMINATOR = 1e8;
 
@@ -23640,6 +23625,7 @@ var GLOBAL_DENOMINATOR = 1e8;
 var import_decimal = require("decimal.js");
 var sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 var nowInMiliseconds = () => Date.now();
+var nowInMilliseconds = nowInMiliseconds;
 var toSystemValue = (value) => {
   return new import_decimal.Decimal(value).mul(new import_decimal.Decimal(GLOBAL_DENOMINATOR)).toString();
 };
@@ -23647,6 +23633,7 @@ var generateApiKey = () => {
   return import_ts_sdk2.Account.generate({ scheme: 0 });
 };
 var getTopicFromCommand = (data) => {
+  const commandType = data.type;
   switch (data.type) {
     case "SubscribePerpMarket":
       return data.content.market;
@@ -23677,8 +23664,10 @@ var getTopicFromCommand = (data) => {
     case "UnsubscribeLiquidations":
       return "Liquidations";
   }
+  throw new Error(`Unsupported websocket command type: ${commandType}`);
 };
 var getTopicFromMessage = (data) => {
+  const messageType = data.type;
   switch (data.type) {
     case "Ack":
       return data.content.id;
@@ -23777,6 +23766,7 @@ var getTopicFromMessage = (data) => {
     case "CanceledPerpTriggerOrders":
       return data.content.userId;
   }
+  throw new Error(`Unsupported websocket message type: ${messageType}`);
 };
 
 // src/sequenceNumberManager.ts
@@ -23960,8 +23950,14 @@ var AccountSequenceNumber = class {
 // src/client.ts
 var getRandomId = () => (0, import_uuid.v7)();
 var Client = class _Client {
+  /**
+   * constructor.
+   *
+   * @param connection - Aptos connection instance. See {@link Aptos}.
+   * @param config - Client configuration options. See {@link ClientConfig}.
+   */
   constructor(connection, config = {}) {
-    this._apiKeySequenceNumber = 0;
+    this._apiKeySequenceNumber = 0n;
     this._pingIntervalMs = 3e4;
     this._lastPongAt = 0;
     this._subscriptions = /* @__PURE__ */ new Map();
@@ -23972,6 +23968,14 @@ var Client = class _Client {
     // Same as below in init
     this.wsDebug = false;
     /////////////////////////////////// Sponsored transactions
+    /**
+     * submitSponsoredTransaction.
+     *
+     * @param tx - See {@link SimpleTransaction}.
+     * @param signature - See {@link AccountAuthenticator}.
+     *
+     * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+     */
     this.submitSponsoredTransaction = async (tx, signature) => {
       const payload = {
         sender: tx.rawTransaction.sender.toString(),
@@ -23991,6 +23995,15 @@ var Client = class _Client {
       );
       return response;
     };
+    /**
+     * submitSponsoredMultiAgentTransaction.
+     *
+     * @param tx - See {@link MultiAgentTransaction}.
+     * @param signature - See {@link AccountAuthenticator}.
+     * @param secondarySignersAuthenticators - See {@link AccountAuthenticator[]}.
+     *
+     * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+     */
     this.submitSponsoredMultiAgentTransaction = async (tx, signature, secondarySignersAuthenticators) => {
       const payload = {
         sender: tx.rawTransaction.sender.toString(),
@@ -24012,10 +24025,25 @@ var Client = class _Client {
       );
       return response;
     };
+    /**
+     * setReferralParams.
+     *
+     * @param request - See {@link SetReferralParamsRequest}.
+     *
+     * @returns A promise that resolves to {@link SetReferralParamsResponse}.
+     */
     this.setReferralParams = async (request) => {
       return await this.sendPostJson(request, "/v1/set_user_referral_params" /* SetUserReferralParams */);
     };
     //////////////////////////////////////// GETTERS
+    /**
+     * sendGetJson.
+     *
+     * @param endpoint - See string.
+     * @param message - See { [key: string]: any }.
+     *
+     * @returns A promise that resolves to any.
+     */
     this.sendGetJson = async (endpoint, message) => {
       let URL = this._serverUrl + endpoint;
       if (message) {
@@ -24049,6 +24077,14 @@ var Client = class _Client {
         throw new Error(error);
       }
     };
+    /**
+     * sendPostJson.
+     *
+     * @param message - See object.
+     * @param endpoint - See string.
+     *
+     * @returns A promise that resolves to any.
+     */
     this.sendPostJson = async (message, endpoint) => {
       const URL = this._serverUrl + endpoint;
       const headers = {
@@ -24071,56 +24107,115 @@ var Client = class _Client {
         throw new Error(error);
       }
     };
+    /**
+     * getConfig.
+     *
+     * @returns Current exchange configuration. See {@link ExchangeConfig}.
+     */
     this.getConfig = async () => {
       const response = await this.sendGetJson("/v1/get_config" /* GetConfig */);
       return response;
     };
+    /**
+     * getTokensConfig.
+     *
+     * @returns Token configuration map. See {@link GetTokensConfigResponse}.
+     */
     this.getTokensConfig = async () => {
       const response = await this.sendGetJson(
         "/v1/get_tokens_config" /* GetTokensConfig */
       );
       return response;
     };
+    /**
+     * getPerpMarketsConfig.
+     *
+     * @returns Perpetual markets configuration. See {@link GetPerpMarketsConfigResponse}.
+     */
     this.getPerpMarketsConfig = async () => {
       const response = await this.sendGetJson(
         "/v1/get_perp_markets_config" /* GetPerpMarketsConfig */
       );
       return response;
     };
+    /**
+     * getSpotMarketsConfig.
+     *
+     * @returns Spot markets configuration. See {@link GetSpotMarketsConfigResponse}.
+     */
     this.getSpotMarketsConfig = async () => {
       const response = await this.sendGetJson(
         "/v1/get_spot_markets_config" /* GetSpotMarketsConfig */
       );
       return response;
     };
+    /**
+     * getUserData.
+     *
+     * @param userId - See string.
+     *
+     * @returns A promise that resolves to {@link GetUserDataResponse}.
+     */
     this.getUserData = async (userId) => {
       const response = await this.sendGetJson("/v1/get_user_data" /* GetUserData */, {
         userId
       });
       return response;
     };
+    /**
+     * getOrderBookData.
+     *
+     * @param marketName - See string.
+     *
+     * @returns A promise that resolves to {@link GetOrderBookDataResponse}.
+     */
     this.getOrderBookData = async (marketName) => {
       const response = await this.sendGetJson("/v1/get_orderbook_data" /* GetOrderBookData */, {
         marketName
       });
       return response;
     };
+    /**
+     * getPerpMarketsData.
+     *
+     * @param markets - See string[].
+     *
+     * @returns A promise that resolves to {@link GetPerpMarketsDataResponse}.
+     */
     this.getPerpMarketsData = async (markets) => {
       const response = await this.sendGetJson("/v1/get_perp_markets_data" /* GetPerpMarketsData */, {
         markets
       });
       return response;
     };
+    /**
+     * getSpotMarketsData.
+     *
+     * @param markets - See string[].
+     *
+     * @returns A promise that resolves to {@link GetSpotMarketsDataResponse}.
+     */
     this.getSpotMarketsData = async (markets) => {
       const response = await this.sendGetJson("/v1/get_spot_markets_data" /* GetSpotMarketsData */, {
         markets
       });
       return response;
     };
+    /**
+     * getBorrowLendingData.
+     *
+     * @returns Borrow/lending-related market data. See {@link GetBorrowLendingDataResponse}.
+     */
     this.getBorrowLendingData = async () => {
       const response = await this.sendGetJson("/v1/get_borrow_lending_data" /* GetBorrowLendingData */);
       return response;
     };
+    /**
+     * getChartCandlesInRange.
+     *
+     * @param request - See {@link GetChartCandlesInRangeRequest}.
+     * @returns A promise that resolves to {@link GetChartCandlesInRangeResponse}.
+     */
     this.getChartCandlesInRange = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24128,22 +24223,49 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/public/chart_candles_in_range" /* GetChartCandlesInRange */, request);
       return response;
     };
+    /**
+     * getPriceIndexes.
+     *
+     * @returns Current price index values. See {@link GetPriceIndexesResponse}.
+     */
     this.getPriceIndexes = async () => {
       const response = await this.sendGetJson("/v1/get_price_indexes" /* GetPriceIndexes */);
       return response;
     };
+    /**
+     * getUsersByAddress.
+     *
+     * @param payload - See {@link GetUsersByAddressRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUsersByAddressResponse}.
+     */
     this.getUsersByAddress = async (payload) => {
       const response = await this.sendGetJson("/v1/get_users_by_address" /* GetUsersByAddress */, payload);
       return response;
     };
+    /**
+     * getPerpRecentTrades.
+     *
+     * @param request - See {@link GetPerpRecentTradesRequest}.
+     */
     this.getPerpRecentTrades = async (request) => {
       const response = await this.sendGetJson("/v1/get_perp_recent_trades" /* GetPerpRecentTrades */, request);
       return response;
     };
+    /**
+     * getSpotRecentTrades.
+     *
+     * @param request - See {@link GetSpotRecentTradesRequest}.
+     */
     this.getSpotRecentTrades = async (request) => {
       const response = await this.sendGetJson("/v1/get_spot_recent_trades" /* GetSpotRecentTrades */, request);
       return response;
     };
+    /**
+     * getUserPerpFills.
+     *
+     * @param request - See {@link GetPerpUserFillsRequest}.
+     */
     this.getUserPerpFills = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24151,6 +24273,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_perp_fills" /* GetUserPerpFills */, request);
       return response;
     };
+    /**
+     * getUserSpotFills.
+     *
+     * @param request - See {@link GetSpotUserFillsRequest}.
+     */
     this.getUserSpotFills = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24158,6 +24285,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_spot_fills" /* GetUserSpotFills */, request);
       return response;
     };
+    /**
+     * getUserPerpOrders.
+     *
+     * @param request - See {@link GetPerpUserOrdersRequest}.
+     */
     this.getUserPerpOrders = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24165,6 +24297,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_perp_orders" /* GetUserPerpOrders */, request);
       return response;
     };
+    /**
+     * getUserSpotOrders.
+     *
+     * @param request - See {@link GetSpotUserOrdersRequest}.
+     */
     this.getUserSpotOrders = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24172,6 +24309,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_spot_orders" /* GetUserSpotOrders */, request);
       return response;
     };
+    /**
+     * getUserPerpTriggerOrders.
+     *
+     * @param request - See {@link GetPerpUserTriggerOrdersRequest}.
+     */
     this.getUserPerpTriggerOrders = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24179,6 +24321,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_perp_trigger_orders" /* GetUserPerpTriggerOrders */, request);
       return response;
     };
+    /**
+     * getUserFundingHistory.
+     *
+     * @param request - See {@link GetUserFundingHistoryRequest}.
+     */
     this.getUserFundingHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24186,6 +24333,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_funding_history" /* GetUserFundingHistory */, request);
       return response;
     };
+    /**
+     * getUserHistoricalDeposits.
+     *
+     * @param request - See {@link GetUserDepositsRequest}.
+     */
     this.getUserHistoricalDeposits = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24193,6 +24345,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_deposits" /* GetUserDeposits */, request);
       return response;
     };
+    /**
+     * getUserWithdrawalsHistory.
+     *
+     * @param request - See {@link GetUserWithdrawalsRequest}.
+     */
     this.getUserWithdrawalsHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24200,6 +24357,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_withdrawals" /* GetUserWithdrawals */, request);
       return response;
     };
+    /**
+     * getUserPortfolioValueHistory.
+     *
+     * @param request - See {@link GetUserPortfolioValueRequest}.
+     */
     this.getUserPortfolioValueHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24207,6 +24369,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_portfolio_value" /* GetUserPortfolioValue */, request);
       return response;
     };
+    /**
+     * getUserRewardsValueHistory.
+     *
+     * @param request - See {@link GetUserRewardsValueRequest}.
+     */
     this.getUserRewardsValueHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24214,6 +24381,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_rewards_value" /* GetUserRewardsValue */, request);
       return response;
     };
+    /**
+     * getUserTradeStatsHistory.
+     *
+     * @param request - See {@link GetUserTradeStatsHistoryRequest}.
+     */
     this.getUserTradeStatsHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24221,10 +24393,20 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_trade_stats" /* GetUserTradeStats */, request);
       return response;
     };
+    /**
+     * getUserAggregatedStats.
+     *
+     * @param request - See {@link GetUserAggregatedStatsRequest}.
+     */
     this.getUserAggregatedStats = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_aggregated_stats" /* GetUserAggregatedStats */, request);
       return response;
     };
+    /**
+     * getUserBoxRewardsStatsHistory.
+     *
+     * @param request - See {@link GetUserBoxRewardsStatsHistoryRequest}.
+     */
     this.getUserBoxRewardsStatsHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24232,6 +24414,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_box_rewards_stats" /* GetUserBoxRewardsStats */, request);
       return response;
     };
+    /**
+     * getUserAggregatedBoxRewardsStats.
+     *
+     * @param request - See {@link GetUserAggregatedBoxRewardsStatsRequest}.
+     */
     this.getUserAggregatedBoxRewardsStats = async (request) => {
       const response = await this.sendGetJson(
         "/v1/get_user_aggregated_box_rewards_stats" /* GetUserAggregatedBoxRewardsStats */,
@@ -24239,6 +24426,11 @@ var Client = class _Client {
       );
       return response;
     };
+    /**
+     * getUserReferralStatsHistory.
+     *
+     * @param request - See {@link GetUserReferralStatsHistoryRequest}.
+     */
     this.getUserReferralStatsHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24246,10 +24438,20 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_referral_stats" /* GetUserReferralStats */, request);
       return response;
     };
+    /**
+     * getUserAggregatedReferralStats.
+     *
+     * @param request - See {@link GetUserAggregatedReferralStatsRequest}.
+     */
     this.getUserAggregatedReferralStats = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_aggregated_referral" /* GetUserAggregatedReferral */, request);
       return response;
     };
+    /**
+     * getUserClaimedKickbackHistory.
+     *
+     * @param request - See {@link GetUserClaimedKickbackHistoryRequest}.
+     */
     this.getUserClaimedKickbackHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24257,6 +24459,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_claimed_kickback" /* GetUserClaimedKickback */, request);
       return response;
     };
+    /**
+     * getUserClaimedReferralKickbackHistory.
+     *
+     * @param request - See {@link GetUserClaimedReferralKickbackHistoryRequest}.
+     */
     this.getUserClaimedReferralKickbackHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24264,6 +24471,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_claimed_referral" /* GetUserClaimedReferral */, request);
       return response;
     };
+    /**
+     * getUserTransfersHistory.
+     *
+     * @param request - See {@link GetUserTransferHistoryRequest}.
+     */
     this.getUserTransfersHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24271,6 +24483,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_transfers" /* GetUserTransfers */, request);
       return response;
     };
+    /**
+     * getUserLiquidations.
+     *
+     * @param request - See {@link GetUserFullLiquidationsHistoryRequest}.
+     */
     this.getUserLiquidations = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24278,6 +24495,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_full_liquidations" /* GetUserFullLiquidations */, request);
       return response;
     };
+    /**
+     * getUserPartialLiquidations.
+     *
+     * @param request - See {@link GetUserPartialLiquidationsHistoryRequest}.
+     */
     this.getUserPartialLiquidations = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24285,6 +24507,11 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_partial_liquidations" /* GetUserPartialLiquidations */, request);
       return response;
     };
+    /**
+     * getBorrowLendHistoricalState.
+     *
+     * @param request - See {@link GetBorrowLendingHistoricalDataRequest}.
+     */
     this.getBorrowLendHistoricalState = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24292,10 +24519,22 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_borrow_lend_historical_data" /* GetBorrowLendHistoricalData */, request);
       return response;
     };
+    /**
+     * getBorrowLendAggregatedStats.
+     *
+     * @param request - See {@link GetBorrowLendingAggregatedStatsRequest}.
+     */
     this.getBorrowLendAggregatedStats = async (request) => {
       const response = await this.sendGetJson("/v1/get_borrow_lend_aggregated_data" /* GetBorrowLendAggregatedData */, request);
       return response;
     };
+    /**
+     * getTokenStats.
+     *
+     * @param request - See {@link GetTokenStatsHistoryRequest}.
+     *
+     * @returns A promise that resolves to {@link GetTokenStatsHistoryResponse}.
+     */
     this.getTokenStats = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24303,28 +24542,64 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_tokens_stats" /* GetTokensStats */, request);
       return response;
     };
+    /**
+     * getTokenAggregatedStats.
+     *
+     * @param request - See {@link GetTokenAggregatedStatsRequest}.
+     *
+     * @returns A promise that resolves to {@link GetTokenAggregatedStatsResponse}.
+     */
     this.getTokenAggregatedStats = async (request) => {
       const response = await this.sendGetJson("/v1/get_tokens_aggregated_stats" /* GetTokensAggregatedStats */, request);
       return response;
     };
+    /**
+     * checkReferralCode.
+     *
+     * @param request - See {@link CheckReferralCodeRequest}.
+     *
+     * @returns A promise that resolves to {@link CheckReferralCodeResponse}.
+     */
     this.checkReferralCode = async (request) => {
       const response = await this.sendGetJson("/v1/check_referral_code" /* CheckReferralCode */, request);
       return response;
     };
+    /**
+     * getServicesStatus.
+     *
+     * @returns Service health status data. See {@link GetServicesStatusResponse}.
+     */
     this.getServicesStatus = async () => {
       const response = await this.sendGetJson(
         "/v1/services_status" /* ServicesStatus */
       );
       return response;
     };
+    /**
+     * getUserVaultDeposits.
+     *
+     * @param request - See {@link GetUserDepositsRequest}.
+     */
     this.getUserVaultDeposits = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_vault_deposits" /* GetUserVaultDeposits */, request);
       return response;
     };
+    /**
+     * getUserVaultWithdraws.
+     *
+     * @param request - See {@link GetUserWithdrawalsRequest}.
+     */
     this.getUserVaultWithdraws = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_vault_withdrawals" /* GetUserVaultWithdrawals */, request);
       return response;
     };
+    /**
+     * getVaultHistoricalData.
+     *
+     * @param request - See {@link GetVaultHistoricalDataRequest}.
+     *
+     * @returns A promise that resolves to {@link GetVaultHistoricalDataResponse}.
+     */
     this.getVaultHistoricalData = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24332,6 +24607,13 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_vault_historical_data" /* GetVaultHistoricalData */, request);
       return response;
     };
+    /**
+     * getHistoricalIndexPrices.
+     *
+     * @param request - See {@link GetIndexPriceHistoryRequest}.
+     *
+     * @returns A promise that resolves to {@link GetIndexPriceHistoryResponse}.
+     */
     this.getHistoricalIndexPrices = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24339,16 +24621,35 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_index_price_history" /* GetIndexPriceHistory */, request);
       return response;
     };
+    /**
+     * getUserAggregatedVaultStats.
+     *
+     * @param request - See {@link GetUserAggregatedVaultStatsRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserAggregatedVaultStatsResponse}.
+     */
     this.getUserAggregatedVaultStats = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_aggregated_vault_stats" /* GetUserAggregatedVaultStats */, request);
       return response;
     };
+    /**
+     * getIndexerStatus.
+     *
+     * @returns Indexer status payload. See {@link GetIndexerStatusResponse}.
+     */
     this.getIndexerStatus = async () => {
       const response = await this.sendGetJson(
         "/v1/get_indexer_status" /* GetIndexerStatus */
       );
       return response;
     };
+    /**
+     * getVaultHistoricalDeposits.
+     *
+     * @param request - See {@link GetVaultDepositsRequest}.
+     *
+     * @returns A promise that resolves to {@link GetVaultDepositsResponse}.
+     */
     this.getVaultHistoricalDeposits = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24356,6 +24657,13 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_vault_deposits" /* GetVaultDeposits */, request);
       return response;
     };
+    /**
+     * getVaultWithdrawals.
+     *
+     * @param request - See {@link GetVaultWithdrawalsRequest}.
+     *
+     * @returns A promise that resolves to {@link GetVaultWithdrawalsResponse}.
+     */
     this.getVaultWithdrawals = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24363,6 +24671,13 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_vault_withdrawals" /* GetVaultWithdrawals */, request);
       return response;
     };
+    /**
+     * getUserBoxesHistory.
+     *
+     * @param request - See {@link GetUserBoxesHistoryRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserBoxesHistoryResponse}.
+     */
     this.getUserBoxesHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24370,10 +24685,24 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_boxes_history" /* GetUserBoxesHistory */, request);
       return response;
     };
+    /**
+     * getUserRequiredVolumeForReferral.
+     *
+     * @param request - See {@link GetUserVolumeForReferralRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserVolumeForReferralResponse}.
+     */
     this.getUserRequiredVolumeForReferral = async (request) => {
       const response = await this.sendGetJson("/v1/get_required_volume_for_referral" /* GetUserVolumeForReferral */, request);
       return response;
     };
+    /**
+     * getUserPointsHistory.
+     *
+     * @param request - See {@link GetUserPointsHistoryRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserPointsHistoryResponse}.
+     */
     this.getUserPointsHistory = async (request) => {
       if (request.olderTimestampMs && request.newerTimestampMs && request.olderTimestampMs > request.newerTimestampMs) {
         throw new Error("olderTimestampMs must be lower than newerTimestampMs");
@@ -24381,29 +24710,65 @@ var Client = class _Client {
       const response = await this.sendGetJson("/v1/get_user_points_history" /* GetUserPointsHistory */, request);
       return response;
     };
+    /**
+     * getAllVaultsIds.
+     *
+     * @returns All vault identifiers available from the API. See {@link GetAllVaultsIdsResponse}.
+     */
     this.getAllVaultsIds = async () => {
       const response = await this.sendGetJson(
         "/v1/get_all_vaults_ids" /* GetAllVaultsIds */
       );
       return response;
     };
+    /**
+     * getUserPersonalPointsRanking.
+     *
+     * @param request - See {@link GetUserPersonalPointsRankingRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserPersonalPointsRankingResponse}.
+     */
     this.getUserPersonalPointsRanking = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_personal_points_ranking" /* GetUserPersonalPointsRanking */, request);
       return response;
     };
+    /**
+     * getTopPointsRanking.
+     *
+     * @returns Leaderboard data ordered by points. See {@link GetTopPointsRankingResponse}.
+     */
     this.getTopPointsRanking = async () => {
       const response = await this.sendGetJson("/v1/get_top_points_ranking" /* GetTopPointsRanking */);
       return response;
     };
+    /**
+     * getAccountValueRanking.
+     *
+     * @param request - See {@link GetAccountValueRankingRequest}.
+     *
+     * @returns A promise that resolves to {@link GetAccountValueRankingResponse}.
+     */
     this.getAccountValueRanking = async (request) => {
       const response = await this.sendGetJson("/v1/get_account_value_ranking" /* GetAccountValueRanking */, request);
       return response;
     };
+    /**
+     * getUserAccountValueRanking.
+     *
+     * @param request - See {@link GetUserAccountValueRankingRequest}.
+     *
+     * @returns A promise that resolves to {@link GetUserAccountValueRankingResponse}.
+     */
     this.getUserAccountValueRanking = async (request) => {
       const response = await this.sendGetJson("/v1/get_user_account_value_ranking" /* GetUserAccountValueRanking */, request);
       return response;
     };
     // Meta
+    /**
+     * getTime.
+     *
+     * @returns Current server time string.
+     */
     this.getTime = async () => {
       const response = await this.sendGetJson("/time" /* Time */);
       return response.time;
@@ -24425,6 +24790,14 @@ var Client = class _Client {
     this.timeout = config.timeout || 5e3;
     this._pingIntervalMs = config.pingIntervalMs || 3e4;
   }
+  /**
+       * init.
+       *
+       * @param connection - Aptos connection instance. See {@link Aptos}.
+       * @param config - Client configuration options. See {@link ClientConfig}.
+  
+      * @returns A promise that resolves to {@link Client}.
+       */
   static async init(connection, config = {}) {
     const id = config.chainId || await connection.getChainId();
     const client = new _Client(connection, { ...config, chainId: id });
@@ -24436,9 +24809,10 @@ var Client = class _Client {
   /**
    * Create a new Client instance
    *
-   * @param connection - Aptos connection instance
-   * @param config - Client configuration options
-   * @returns Promise<Client>
+   * @param connection - Aptos connection instance. See {@link Aptos}.
+   * @param config - Optional client config object. See {@link ClientConfig}.
+   *
+   * @returns A promise that resolves to {@link Client}.
    *
    * @example
    * // Create a testnet client (default)
@@ -24465,36 +24839,76 @@ var Client = class _Client {
   static async create(connection, config = {}) {
     return _Client.init(connection, config);
   }
+  /**
+   * setApiKey.
+   *
+   * @param apiKey - See {@link Account}.
+   */
   async setApiKey(apiKey) {
     this._apiKey = apiKey;
     this._apiKeySequenceNumber = await this.fetchApiKeySequenceNumber();
     this._sequenceNumberManager = new AccountSequenceNumber(this._aptos, this._apiKey);
     await this._sequenceNumberManager.initialize();
   }
+  /**
+   * getContractAddress.
+   *
+   * @returns The configured contract address.
+   */
   getContractAddress() {
     return this._contractAddress;
   }
+  /**
+   * getApiKeySequenceNumber.
+   *
+   * @returns The next API key sequence number or null when unavailable.
+   */
   getApiKeySequenceNumber() {
     return this._sequenceNumberManager.nextSequenceNumber();
   }
+  /**
+   * fetchApiKeySequenceNumber.
+   *
+   * @returns The on-chain API key sequence number.
+   */
   async fetchApiKeySequenceNumber() {
     const accInfo = await this._aptos.getAccountInfo({
       accountAddress: this._apiKey.accountAddress
     });
-    return Number(await accInfo.sequence_number);
+    return BigInt(accInfo.sequence_number);
   }
+  /**
+   * setTxParams.
+   *
+   * @param params - See {@link TxParams}.
+   */
   setTxParams(params) {
     this._maxGas = params.maxGas;
     this._gasUnitPrice = params.gasUnitPrice;
     this._expirationTimestampDelay = params.expirationTimestampSecs;
   }
   //////////////////////////////////////// Websocket functions
+  /**
+   * _wsLog.
+   *
+   * @param args - 
+   */
   _wsLog(...args) {
     if (this.wsDebug) console.log("[WS]", ...args);
   }
+  /**
+   * setWsDebugActive.
+   *
+   * @param active - See boolean.
+   */
   setWsDebugActive(active) {
     this.wsDebug = active;
   }
+  /**
+   * connectWebSocket.
+   *
+   * @returns A promise that resolves when WebSocket initialization is complete.
+   */
   async connectWebSocket() {
     if (this._ws) {
       console.warn("WebSocket is already connected");
@@ -24510,6 +24924,12 @@ var Client = class _Client {
       throw new Error(`Failed to connect WebSocket: ${error}`);
     }
   }
+  /**
+   * _initWebSocket.
+   *
+   * @param url - 
+   * @param timeout - 
+   */
   _initWebSocket(url, timeout) {
     return new Promise((resolve, reject) => {
       const wsUrl = `${url.replace("http", "ws").replace("https", "wss")}` + "/v1/ws" /* Ws */;
@@ -24578,6 +24998,11 @@ var Client = class _Client {
       this._wsLog("Error:", error);
     };
   }
+  /**
+   * disconnectWebSocket.
+   *
+   * @returns A promise that resolves when cleanup and close actions are finished.
+   */
   async disconnectWebSocket() {
     if (!this._ws) {
       console.warn("WebSocket is not connected");
@@ -24603,6 +25028,13 @@ var Client = class _Client {
     this._wsLog("isWebSocketConnected:", alive, "lastPong:", Date.now() - this._lastPongAt, "ms ago");
     return alive;
   }
+  /**
+       * sendWsMessage.
+       *
+       * @param message - See {@link WsCommand}.
+  
+      * @returns A promise that resolves to {@link WsMessage}.
+       */
   sendWsMessage(message) {
     if (!this._ws) throw new Error("WebSocket is not connected");
     return new Promise((resolve, reject) => {
@@ -24630,6 +25062,13 @@ var Client = class _Client {
       this._ws?.send(JSON.stringify(message));
     });
   }
+  /**
+       * subscribeIndexPricesUpdates.
+       *
+       * @param callback - Callback invoked for oracle updates. See {@link WsOracleUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeIndexPricesUpdates(callback) {
     const command = {
       type: "SubscribeOracle",
@@ -24640,6 +25079,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return this.unsubscribeIndexPricesUpdates;
   }
+  /**
+   * unsubscribeIndexPricesUpdates.
+   *
+   * @returns A promise that resolves to a completed unsubscribe flow.
+   */
   async unsubscribeIndexPricesUpdates() {
     const command = {
       type: "UnsubscribeOracle",
@@ -24649,6 +25093,13 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribeBorrowLendingUpdates.
+       *
+       * @param callback - Callback invoked for borrow-lending updates. See {@link WsBorrowLendUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeBorrowLendingUpdates(callback) {
     const command = {
       type: "SubscribeBorrowLend",
@@ -24659,6 +25110,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return this.unsubscribeIndexPricesUpdates;
   }
+  /**
+   * unsubscribeBorrowLendingUpdates.
+   *
+   * @returns A promise that resolves to a completed unsubscribe flow.
+   */
   async unsubscribeBorrowLendingUpdates() {
     const command = {
       type: "UnsubscribeBorrowLend",
@@ -24668,6 +25124,13 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribeBoxOpeningUpdates.
+       *
+       * @param callback - Callback invoked for box-opening updates. See {@link WsBoxOpeningUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeBoxOpeningUpdates(callback) {
     const command = {
       type: "SubscribeBoxes",
@@ -24678,6 +25141,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return this.unsubscribeBoxOpeningUpdates;
   }
+  /**
+   * unsubscribeBoxOpeningUpdates.
+   *
+   * @returns A promise that resolves to a completed unsubscribe flow.
+   */
   async unsubscribeBoxOpeningUpdates() {
     const command = {
       type: "UnsubscribeBoxes",
@@ -24687,6 +25155,13 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribeLiquidationUpdates.
+       *
+       * @param callback - Callback invoked for liquidation updates. See {@link WsLiquidationUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeLiquidationUpdates(callback) {
     const command = {
       type: "SubscribeLiquidations",
@@ -24697,6 +25172,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return this.unsubscribeLiquidationUpdates;
   }
+  /**
+   * unsubscribeLiquidationUpdates.
+   *
+   * @returns A promise that resolves to a completed unsubscribe flow.
+   */
   async unsubscribeLiquidationUpdates() {
     const command = {
       type: "UnsubscribeLiquidations",
@@ -24706,6 +25186,14 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribeUserUpdates.
+       *
+       * @param userId - See string.
+       * @param callback - Callback invoked for user updates. See {@link WsUserUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeUserUpdates(userId, callback) {
     const command = {
       type: "SubscribeUser",
@@ -24716,6 +25204,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return () => this.unsubscribeUserUpdates(userId);
   }
+  /**
+   * unsubscribeUserUpdates.
+   *
+   * @param userId - See string.
+   */
   async unsubscribeUserUpdates(userId) {
     const command = {
       type: "UnsubscribeUser",
@@ -24725,6 +25218,14 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribePerpMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for perpetual market updates. See {@link WsPerpMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribePerpMarketUpdates(market, callback) {
     const command = {
       type: "SubscribePerpMarket",
@@ -24735,6 +25236,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return () => this.unsubscribePerpMarketUpdates(market);
   }
+  /**
+   * unsubscribePerpMarketUpdates.
+   *
+   * @param market - See string.
+   */
   async unsubscribePerpMarketUpdates(market) {
     const command = {
       type: "UnsubscribePerpMarket",
@@ -24744,6 +25250,14 @@ var Client = class _Client {
     const topic = getTopicFromCommand(command);
     this._subscriptions.delete(topic);
   }
+  /**
+       * subscribeSpotMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for spot market updates. See {@link WsSpotMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
   async subscribeSpotMarketUpdates(market, callback) {
     const command = {
       type: "SubscribeSpotMarket",
@@ -24754,6 +25268,11 @@ var Client = class _Client {
     await this.sendWsMessage(command);
     return () => this.unsubscribeSpotMarketUpdates(market);
   }
+  /**
+   * unsubscribeSpotMarketUpdates.
+   *
+   * @param market - See string.
+   */
   async unsubscribeSpotMarketUpdates(market) {
     const command = {
       type: "UnsubscribeSpotMarket",
@@ -24764,6 +25283,12 @@ var Client = class _Client {
     this._subscriptions.delete(topic);
   }
   /////////////////////////////////// Functions which needs to be signed by user and sent to blockchain
+  /**
+   * createUser.
+   *
+   * @param params - See {@link CreateUserParams}.
+   * @returns A promise that resolves to the user creation payload bundle.
+   */
   async createUser(params) {
     const apiKey = generateApiKey();
     const abi = this._abis.CreateUserABI;
@@ -24797,6 +25322,12 @@ var Client = class _Client {
       apiKey
     };
   }
+  /**
+   * createUserPayload.
+   *
+   * @param params - See {@link CreateUserParams}.
+   * @returns A promise that resolves to an object with the unsigned payload and generated API key. See {@link AnyTransactionPayloadInstance}.
+   */
   async createUserPayload(params) {
     const apiKey = generateApiKey();
     const abi = this._abis.CreateUserABI;
@@ -24817,6 +25348,11 @@ var Client = class _Client {
       apiKey
     };
   }
+  /**
+   * addApiKey.
+   *
+   * @param params - See {@link AddApiKeyParams}.
+   */
   async addApiKey(params) {
     const abi = this._abis.AddApiKeyABI;
     return await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24832,6 +25368,11 @@ var Client = class _Client {
       functionArguments: [params.userId, params.expiration]
     });
   }
+  /**
+   * depositTokenPayload.
+   *
+   * @param params - See {@link DepositTokenParams}.
+   */
   async depositTokenPayload(params) {
     const abi = this._abis.DepositTokenABI;
     return await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24847,6 +25388,14 @@ var Client = class _Client {
       functionArguments: [params.userId, params.amount, params.tokenAddress]
     });
   }
+  /**
+   * Creates the transaction payload for withdrawing a token.
+   *
+   * @param params - Withdraw request parameters.
+   *   See {@link WithdrawTokenParams}.
+   * @returns The generated transaction payload. See
+   *   {@link AnyTransactionPayloadInstance}.
+   */
   async withdrawTokenPayload(params) {
     const abi = this._abis.WithdrawTokenABI;
     return await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24869,6 +25418,11 @@ var Client = class _Client {
       ]
     });
   }
+  /**
+   * removeApiKeySigner.
+   *
+   * @param params - See {@link RemoveApiKeySignerParams}.
+   */
   async removeApiKeySigner(params) {
     const abi = this._abis.RemoveApiKeySignerABI;
     return await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24884,6 +25438,11 @@ var Client = class _Client {
       functionArguments: [params.apiKeys, params.userId]
     });
   }
+  /**
+   * addApiCredits.
+   *
+   * @param params - See {@link AddApiCreditsParams}.
+   */
   async addApiCredits(params) {
     const abi = this._abis.AddCreditsABI;
     return await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24900,8 +25459,18 @@ var Client = class _Client {
     });
   }
   // Helper function to submit sponsored transaction
+  /**
+       * createAndSubmitTransaction.
+       *
+       * @param aptosPayload - See {@link AnyTransactionPayloadInstance}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
   async createAndSubmitTransaction(aptosPayload) {
     const sequenceNumber = await this.getApiKeySequenceNumber();
+    if (sequenceNumber === null) {
+      throw new Error("Unable to determine a valid API key sequence number");
+    }
     const rawTx = new import_ts_sdk3.RawTransaction(
       import_ts_sdk3.AccountAddress.from(this._apiKey.accountAddress),
       BigInt(sequenceNumber),
@@ -24921,13 +25490,37 @@ var Client = class _Client {
     });
     return await this.submitSponsoredTransaction(tx, signature);
   }
+  /**
+       * createOpenBoxesMessage.
+       *
+       * @param boxId - See string.
+       * @param amount - See string.
+       * @param userId - See string.
+       * @param apiKey - See string.
+  
+      * @returns The generated box-open message.
+       */
   createOpenBoxesMessage(boxId, amount, userId, apiKey) {
     return `[Neony Exchange]: Open box, id:${boxId}, amount:${amount}, user_id:${userId}, api_key:${apiKey}`;
   }
+  /**
+       * openBoxes.
+       *
+       * @param params - See {@link OpenBoxesRequest}.
+  
+      * @returns A promise that resolves to {@link OpenBoxesResponse}.
+       */
   async openBoxes(params) {
     const response = await this.sendPostJson(params, "/v1/open_boxes" /* OpenBoxes */);
     return response;
   }
+  /**
+       * removeApiKey.
+       *
+       * @param params - See {@link RemoveApiKeyParams}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
   async removeApiKey(params) {
     const abi = this._abis.RemoveApiKeyABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24944,6 +25537,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * setAliasName.
+   *
+   * @param params - See {@link SetAliasNameParams}.
+   */
   async setAliasName(params) {
     const abi = this._abis.SetAliasNameABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24960,6 +25558,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placePerpLimitOrder.
+   *
+   * @param params - See {@link PlacePerpOrderParams}.
+   */
   async placePerpLimitOrder(params) {
     const abi = this._abis.PlacePerpLimitOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -24984,6 +25587,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placePerpMarketOrder.
+   *
+   * @param params - See {@link PlacePerpOrderParams}.
+   */
   async placePerpMarketOrder(params) {
     const abi = this._abis.PlacePerpMarketOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25008,6 +25616,11 @@ var Client = class _Client {
     return await this.createAndSubmitTransaction(aptosPayload);
   }
   ////////// Spot orders (ABI-based)
+  /**
+   * placeSpotLimitOrder.
+   *
+   * @param params - See {@link PlaceSpotOrderParams}.
+   */
   async placeSpotLimitOrder(params) {
     const abi = this._abis.PlaceSpotLimitOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25031,6 +25644,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placeSpotMarketOrder.
+   *
+   * @param params - See {@link PlaceSpotOrderParams}.
+   */
   async placeSpotMarketOrder(params) {
     const abi = this._abis.PlaceSpotMarketOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25054,6 +25672,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * changeSpotOrderPrice.
+   *
+   * @param params - See {@link ChangeSpotOrderParams}.
+   */
   async changeSpotOrderPrice(params) {
     const abi = this._abis.ChangeSpotOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25077,6 +25700,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * cancelSpotOrders.
+   *
+   * @param params - See {@link CancelSpotOrdersParams}.
+   */
   async cancelSpotOrders(params) {
     const abi = this._abis.CancelSpotOrdersABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25093,6 +25721,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placeTriggerOrder.
+   *
+   * @param params - See {@link PlacePerpTriggerOrderParams}.
+   */
   async placeTriggerOrder(params) {
     const abi = this._abis.PlacePerpTriggerOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25121,6 +25754,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * changePerpOrderPrice.
+   *
+   * @param params - See {@link ChangePerpOrderParams}.
+   */
   async changePerpOrderPrice(params) {
     const abi = this._abis.ChangePerpOrderABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25145,6 +25783,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * cancelPerpOrders.
+   *
+   * @param params - See {@link CancelPerpOrdersParams}.
+   */
   async cancelPerpOrders(params) {
     const abi = this._abis.CancelPerpOrdersABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25161,6 +25804,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * cancelAllPerpOrders.
+   *
+   * @param params - See {@link CancelAllPerpOrdersParams}.
+   */
   async cancelAllPerpOrders(params) {
     const abi = this._abis.CancelAllPerpOrdersABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25177,6 +25825,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * cancelAllSpotOrders.
+   *
+   * @param params - See {@link CancelAllSpotOrdersParams}.
+   */
   async cancelAllSpotOrders(params) {
     const abi = this._abis.CancelAllSpotOrdersABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25193,6 +25846,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * setAutolend.
+   *
+   * @param params - See {@link SetAutolendParams}.
+   */
   async setAutolend(params) {
     const abi = this._abis.SetAutolendABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25209,6 +25867,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * depositToVault.
+   *
+   * @param params - See {@link DepositToVaultParams}.
+   */
   async depositToVault(params) {
     const abi = this._abis.DepositToVaultABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25225,6 +25888,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * withdrawFromVault.
+   *
+   * @param params - See {@link WithdrawFromVaultParams}.
+   */
   async withdrawFromVault(params) {
     const abi = this._abis.WithdrawFromVaultABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25246,6 +25914,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * redeemToken.
+   *
+   * @param params - See {@link RedeemTokenParams}.
+   */
   async redeemToken(params) {
     const abi = this._abis.RedeemTokenABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25267,6 +25940,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * lendToken.
+   *
+   * @param params - See {@link LendTokenParams}.
+   */
   async lendToken(params) {
     const abi = this._abis.LendTokenABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25288,6 +25966,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * claimReferralFees.
+   *
+   * @param params - See {@link ClaimReferralFeesParams}.
+   */
   async claimReferralFees(params) {
     const abi = this._abis.ClaimReferralFeesABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25304,6 +25987,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * claimKickbackFee.
+   *
+   * @param params - See {@link ClaimKickbackFeeParams}.
+   */
   async claimKickbackFee(params) {
     const abi = this._abis.ClaimKickbackFeeABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25320,6 +26008,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * transferToUser.
+   *
+   * @param params - See {@link TransferToUserParams}.
+   */
   async transferToUser(params) {
     const abi = this._abis.TransferToUserABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25343,6 +26036,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * withdrawToken.
+   *
+   * @param params - See {@link WithdrawTokenParams}.
+   */
   async withdrawToken(params) {
     const abi = this._abis.WithdrawTokenABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25366,6 +26064,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * replaceMultipleOrders.
+   *
+   * @param params - See {@link ReplaceMultipleOrdersParams}.
+   */
   async replaceMultipleOrders(params) {
     const isBids = params.orders.map((order) => order.isBid);
     const prices = params.orders.map((order) => order.price);
@@ -25386,6 +26089,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * replaceMultipleSpotOrders.
+   *
+   * @param params - See {@link ReplaceMultipleSpotOrdersParams}.
+   */
   async replaceMultipleSpotOrders(params) {
     const isBids = params.orders.map((order) => order.isBid);
     const prices = params.orders.map((order) => order.price);
@@ -25406,6 +26114,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placeMultiplePerpOrders.
+   *
+   * @param params - See {@link PlaceMultiplePerpOrdersParams}.
+   */
   async placeMultiplePerpOrders(params) {
     const markets = params.perpOrders.map((order) => order.market);
     const isBids = params.perpOrders.map((order) => order.isBid);
@@ -25436,6 +26149,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * placeMultipleSpotOrders.
+   *
+   * @param params - See {@link PlaceMultipleSpotOrdersParams}.
+   */
   async placeMultipleSpotOrders(params) {
     const markets = params.spotOrders.map((order) => order.marketName);
     const uniqueMarkets = new Set(markets);
@@ -25462,6 +26180,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * claimDeposit.
+   *
+   * @param params - See {@link ClaimDepositParams}.
+   */
   async claimDeposit(params) {
     const abi = this._abis.ClaimDepositABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25478,6 +26201,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * setReferralCode.
+   *
+   * @param params - See {@link SetReferralCodeParams}.
+   */
   async setReferralCode(params) {
     const abi = this._abis.SetReferralCodeABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25494,6 +26222,11 @@ var Client = class _Client {
     });
     return await this.createAndSubmitTransaction(aptosPayload);
   }
+  /**
+   * tokenizeUserVaultInvestment.
+   *
+   * @param params - See {@link TokenizeUserVaultInvestmentParams}.
+   */
   async tokenizeUserVaultInvestment(params) {
     const abi = this._abis.TokenizeUserVaultInvestmentABI;
     const aptosPayload = await (0, import_ts_sdk3.generateTransactionPayload)({
@@ -25540,12 +26273,26 @@ function parseEntryFunctionAbi(args) {
 // src/testFaucet.ts
 var import_ts_sdk4 = require("@aptos-labs/ts-sdk");
 var TestFaucet = class _TestFaucet extends client_default {
+  /** Creates a `TestFaucet` instance. 
+   * @param connection -
+   * @param config -
+   */
   constructor(connection, config = {}) {
     super(connection, config);
   }
+  /**
+   * Creates and initializes a faucet helper with websocket disabled by default.
+   *
+   * @param connection - Aptos client connected to the target network.
+   * @param config - Optional client config.
+   
+   * @param configOrNetworkMode -
+   * @param enableWs -
+   */
   static async create(connection, config = {}) {
-    return new _TestFaucet(connection, { enableWs: false, ...config });
+    return new _TestFaucet(connection, { ...config, enableWs: false });
   }
+  /** Builds the initialize-faucet payload (testnet only). */
   async initFaucetPayload() {
     const abi = this._abis.FaucetEntrypointsABI;
     if (!abi) {
@@ -25564,6 +26311,7 @@ var TestFaucet = class _TestFaucet extends client_default {
       functionArguments: []
     });
   }
+  /** Submits the faucet initialization transaction. */
   async initFaucet() {
     const payload = await this.initFaucetPayload();
     const tx = new import_ts_sdk4.SimpleTransaction(
@@ -25579,6 +26327,11 @@ var TestFaucet = class _TestFaucet extends client_default {
     });
     return await this.submitSponsoredTransaction(tx, signature);
   }
+  /** Builds the mint payload for test tokens (testnet only). 
+   * @param receiver -
+   * @param token -
+   * @param amount -
+   */
   async mintTokenPayload(receiver, token, amount) {
     const abi = this._abis.FaucetEntrypointsABI;
     if (!abi) {
@@ -25597,6 +26350,13 @@ var TestFaucet = class _TestFaucet extends client_default {
       functionArguments: [receiver, token, amount]
     });
   }
+  /**
+   * Mints testnet tokens to an on-chain recipient.
+   *
+   * @param receiver - Recipient address.
+   * @param token - Token symbol.
+   * @param amount - Mint amount.
+   */
   async mintToken(receiver, token, amount) {
     const payload = await this.mintTokenPayload(receiver, token, amount);
     const tx = new import_ts_sdk4.SimpleTransaction(
@@ -25627,11 +26387,9 @@ var TestFaucet = class _TestFaucet extends client_default {
   ExchangeProxies,
   GLOBAL_DENOMINATOR,
   MAINNET_CONFIG,
-  Network,
   OrderSide,
   OrderStatus,
   OrderType,
-  Status,
   TESTNET_CONFIG,
   TestFaucet,
   TradeRole,
@@ -25647,6 +26405,7 @@ var TestFaucet = class _TestFaucet extends client_default {
   getTopicFromCommand,
   getTopicFromMessage,
   nowInMiliseconds,
+  nowInMilliseconds,
   parseEntryFunctionAbi,
   sleep,
   toSystemValue