@reyaxyz/api-sdk 0.26.0 → 0.28.0

package/src/clients/api-client.ts

@@ -8,6 +8,7 @@ import MarketsClient from './modules/markets';
 import AccountClient from './modules/account';
 import TradeSimulationClient from './modules/trade.simulation';
 import LpClient from './modules/lp';
+import TokensClient from './modules/tokens';
 
 /**
  * @description Client for API
@@ -23,6 +24,7 @@ export class ApiClient {
   private readonly _account: AccountClient;
   private readonly _lp: LpClient;
   private readonly _trade_simulation: TradeSimulationClient;
+  private readonly _tokens: TokensClient;
 
   private constructor(config: ServiceConfig) {
     this.apiEndpoint = config.production ? API_PRODUCTION : API_TESTNET;
@@ -31,6 +33,7 @@ export class ApiClient {
     this._account = new AccountClient(this.apiEndpoint);
     this._lp = new LpClient(this.apiEndpoint);
     this._trade_simulation = new TradeSimulationClient(this._account);
+    this._tokens = new TokensClient(this.apiEndpoint);
   }
 
   public static configure(config: ServiceConfig): void {
@@ -100,4 +103,18 @@ export class ApiClient {
   public static get lp(): LpClient {
     return ApiClient.getInstance()._lp;
   }
+
+  /**
+   * Gets the current instance of the TokensClient from the ApiClient.
+   *
+   * This static getter allows access to the Tokensclient instance managed within the ApiClient's singleton instance. It is a convenience method for retrieving the TokensClient directly, bypassing the need to manually access the internal `_tokens` property of the ApiClient instance.
+   *
+   * @returns {TokensClient} The TokensClient instance currently held by the ApiClient.
+   * @example
+   * // Assuming ApiClient and TokensClient are properly set up
+   * const tokensClient = ApiClient.tokens;
+   */
+  public static get tokens(): TokensClient {
+    return ApiClient.getInstance()._tokens;
+  }
 }

package/src/clients/modules/{account.ts → account/index.ts}

@@ -14,9 +14,9 @@ import {
   GetPositionsHistoryForMarginAccountParams,
   GetPositionsHistoryForMarginAccountResult,
   GetTransactionSimulationInitialDataParams,
-} from '../types';
-import RestClient from './rest';
-import { TradeSimulationState } from '../helpers/trade.simulation.types';
+} from './types';
+import RestClient from '../rest';
+import { TradeSimulationState } from '@reyaxyz/common';
 
 export default class AccountClient extends RestClient {
   /**

package/src/clients/modules/account/types.ts

@@ -0,0 +1,74 @@
+import {
+  MarginAccountEntity,
+  MarginAccountTransactionHistoryEntity,
+  MarketEntity,
+  PositionEntity,
+  PositionHistoryEntity,
+} from '@reyaxyz/common';
+
+export type GetMarginAccountsParams = {
+  address: string;
+  limit?: number;
+};
+
+export type GetMarginAccountParams = {
+  address: string;
+  marginAccountId: MarginAccountEntity['id'];
+};
+
+export type GetPositionsForMarginAccountParams = {
+  address: string;
+  marginAccountId: MarginAccountEntity['id'];
+  limit?: number;
+};
+
+export type GetMarginAccountsResult = MarginAccountEntity[];
+
+export type GetMarginAccountResult = MarginAccountEntity;
+
+// ---- Transaction History
+export type GetMarginAccountTransactionHistoryParams = {
+  marginAccountId: MarginAccountEntity['id'];
+  limit?: number;
+};
+
+export type GetMarginAccountTransactionHistoryResult =
+  MarginAccountTransactionHistoryEntity[];
+// -- Max Order Size --
+
+export type GetMaxOrderSizeAvailableParams = {
+  marketId: MarketEntity['id'];
+  marginAccountId: MarginAccountEntity['id'];
+  direction: 'long' | 'short';
+};
+
+export type GetMaxOrderSizeAvailableResult = number;
+
+// --- Max Withdraw Balance for Margin Account ---
+export type GetMaxWithdrawBalanceForAccountParams = {
+  marginAccountId: MarginAccountEntity['id'];
+  tokenAddress: string;
+};
+
+export type GetMaxWithdrawBalanceForAccountResult = number;
+
+export type GetPositionsForMarginAccountResult = {
+  positions: PositionEntity[];
+  totalUnrealizedPNL: number;
+};
+
+// --- Position History ---
+
+export type GetPositionsHistoryForMarginAccountParams = {
+  address: string;
+  marginAccountId: MarginAccountEntity['id'];
+  limit?: number;
+};
+export type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];
+
+// ---- Transaction Simulation ----
+
+export type GetTransactionSimulationInitialDataParams = {
+  marketId: MarketEntity['id'];
+  marginAccountId: MarginAccountEntity['id'];
+};

package/src/clients/modules/{lp.ts → lp/index.ts}

@@ -9,11 +9,13 @@ import {
   GetLpPoolWithdrawBalanceParams,
   GetLpPoolWithdrawBalanceResult,
   GetLpPoolBalanceChartDataParams,
-  GetLpPoolBalanceChartDataResult,
   GetLpPoolPerformanceChartDataParams,
+} from './types';
+import {
   GetLpPoolPerformanceChartDataResult,
-} from '../types';
-import RestClient from './rest';
+  GetLpPoolBalanceChartDataResult,
+} from '@reyaxyz/common';
+import RestClient from '../rest';
 
 export default class LpClient extends RestClient {
   async getLpPools(): Promise<GetLpPoolsResult> {

package/src/clients/modules/lp/types.ts

@@ -0,0 +1,62 @@
+import {
+  LpPoolEntity,
+  LpPositionEntity,
+  LpTransactionHistoryEntity,
+  BalanceGranularity,
+} from '@reyaxyz/common';
+
+export type GetLpPoolsResult = LpPoolEntity[];
+
+export type GetLpPoolResult = LpPoolEntity;
+
+export type GetLpPoolParams = {
+  id: LpPoolEntity['id'];
+};
+
+export type GetLpPoolTransactionHistoryResult = LpTransactionHistoryEntity[];
+
+export type GetLpPositionsParams = {
+  id: LpPoolEntity['id'];
+  address: string; // wallet address
+};
+
+export type GetLpPositionsResult = LpPositionEntity[];
+
+export type GetLpPoolWithdrawBalanceParams = {
+  id: LpPoolEntity['id'];
+  address: string; // wallet address
+};
+
+export type GetLpPoolWithdrawBalanceResult = number;
+
+export type GetLpPoolTransactionHistoryParams = {
+  id: LpPoolEntity['id'];
+  address: string; // wallet address
+  limit?: number;
+};
+
+export type GetLpPoolBalanceChartDataParams = {
+  poolId: LpPoolEntity['id'];
+  filters: {
+    timeframeMs: number;
+    granularity: BalanceGranularity;
+  };
+};
+
+export enum PerformanceGranularity {
+  ONE_MINUTE = 60 * 1000,
+  ONE_HOUR = 60 * 60 * 1000,
+  ONE_DAY = 24 * 60 * 60 * 1000,
+  ONE_WEEK = 7 * 24 * 60 * 60 * 1000,
+  ONE_MONTH = 30 * 24 * 60 * 60 * 1000,
+  ONE_YEAR = 365 * 24 * 60 * 60 * 1000,
+}
+
+export type GetLpPoolPerformanceChartDataParams = {
+  poolId: LpPoolEntity['id'];
+  address: string; // wallet address
+  filters: {
+    timeframeMs: number;
+    granularity: PerformanceGranularity;
+  };
+};

package/src/clients/modules/{markets.ts → markets/index.ts}

@@ -6,8 +6,8 @@ import {
   GetMarketTradingHistoryParams,
   GetTradingHistoryResult,
   MarketCandlesResponse,
-} from '../types';
-import RestClient from './rest';
+} from './types';
+import RestClient from '../rest';
 
 export default class MarketsClient extends RestClient {
   /**

package/src/clients/modules/markets/types.ts

@@ -0,0 +1,33 @@
+import {
+  CandlesResolution,
+  MarketEntity,
+  TradingHistoryEntity,
+  Candle,
+} from '@reyaxyz/common';
+
+export type GetMarketsResult = MarketEntity[];
+
+export type GetMarketResult = MarketEntity;
+
+export type GetMarketParams = {
+  id: MarketEntity['id'];
+};
+
+export type GetCandlesParams = {
+  marketId: MarketEntity['id'];
+  resolution: CandlesResolution;
+  fromISO?: string | null;
+  toISO?: string | null;
+  limit?: number | null;
+};
+
+export type GetMarketTradingHistoryParams = {
+  marketId: number;
+  limit?: number;
+  fromTimestampMillisecondsUTC?: number;
+};
+export type GetTradingHistoryResult = TradingHistoryEntity[];
+
+export interface MarketCandlesResponse {
+  candles: Candle[];
+}

package/src/clients/modules/{rest.ts → rest/index.ts}

@@ -1,6 +1,11 @@
-import { API_TIMEOUT } from '../helpers/constants';
-import { generateQueryPath } from '../helpers/query-helper';
-import { RequestMethod, Response, request, ResponseData } from '../lib/axios';
+import { API_TIMEOUT } from '../../helpers/constants';
+import { generateQueryPath } from '../../helpers/query-helper';
+import {
+  RequestMethod,
+  Response,
+  request,
+  ResponseData,
+} from '../../lib/axios';
 export default class RestClient {
   readonly host: string;
   readonly apiTimeout: number;

package/src/clients/modules/tokens/index.ts

@@ -0,0 +1,11 @@
+import { GetAllowedTokensParams, GetAllowedTokenResult } from './types';
+import RestClient from '../rest';
+
+export default class TokensClient extends RestClient {
+  async getAllowedTokens(
+    params: GetAllowedTokensParams,
+  ): Promise<GetAllowedTokenResult> {
+    const uri = `/api/tokens/${params.chainId}`;
+    return this.get(uri);
+  }
+}

package/src/clients/modules/tokens/types.ts

@@ -0,0 +1,9 @@
+import { SupportedChainId, TokenEntity } from '@reyaxyz/common';
+
+export type GetAllowedTokensParams = {
+  chainId: SupportedChainId;
+};
+
+export type GetAllowedTokenResult = {
+  tokens: TokenEntity[];
+};

package/src/clients/modules/{trade.simulation.ts → trade.simulation/index.ts}

@@ -2,10 +2,9 @@ import {
   SimulateTradeEntity,
   TradeSimulationLoadDataParams,
   TradeSimulationSimulateParams,
-} from '../types';
-import AccountClient from './account';
-import { TradeSimulationState } from '../helpers/trade.simulation.types';
-import { ExposureCommand } from '../helpers/exposure.calculator';
+} from './types';
+import AccountClient from '../account';
+import { ExposureCommand, TradeSimulationState } from '@reyaxyz/common';
 import BigNumber from 'bignumber.js';
 
 export default class TradeSimulationClient {

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

@@ -0,0 +1,21 @@
+import { MarginAccountEntity, MarketEntity } from '@reyaxyz/common';
+
+export type TradeSimulationLoadDataParams = {
+  marketId: MarketEntity['id'];
+  marginAccountId: MarginAccountEntity['id'];
+};
+
+export type TradeSimulationSimulateParams = {
+  amount: number; // position size, + for long | - for short
+};
+
+export type SimulateTradeEntity = {
+  liquidationPrice: number;
+  fees: number;
+  estimatedPrice: number;
+  estimatedSlippage: number;
+  imr: number;
+  impliedLeverage: number;
+  marginRatio: MarginAccountEntity['marginRatioPercentage'];
+  marginRatioHealth: MarginAccountEntity['marginRatioHealth'];
+};