@reyaxyz/api-sdk 0.27.0 → 0.29.0

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.ts → tokens/index.ts}

@@ -1,5 +1,5 @@
-import { GetAllowedTokensParams, GetAllowedTokenResult } from '../types';
-import RestClient from './rest';
+import { GetAllowedTokensParams, GetAllowedTokenResult } from './types';
+import RestClient from '../rest';
 
 export default class TokensClient extends RestClient {
   async getAllowedTokens(

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'];
+};

package/src/clients/types.ts

@@ -1,400 +1,16 @@
-export enum CandlesResolution {
-  ONE_MINUTE = '1MIN',
-  FIVE_MINUTES = '5MINS',
-  FIFTEEN_MINUTES = '15MINS',
-  THIRTY_MINUTES = '30MINS',
-  ONE_HOUR = '1HOUR',
-  FOUR_HOURS = '4HOURS',
-  ONE_DAY = '1DAY',
-}
-
-// -- Candles --
-export interface Candle {
-  id: string;
-  startedAt: string;
-  ticker: string;
-  resolution: CandlesResolution;
-  low: string;
-  high: string;
-  open: string;
-  close: string;
-  baseTokenVolume: string;
-  usdVolume: string;
-  trades: number;
-  startingOpenInterest: string;
-}
-
-export interface MarketCandlesResponse {
-  candles: Candle[];
-}
-
-// -- Markets --
-
-export type MarketOrderInfo = {
-  counterpartyAccountIds: number[];
-  exchangeId: number;
-};
-
-export type MarketEntity = {
-  id: number;
-  ticker: string;
-  underlyingAsset: string;
-  quoteToken: string;
-  markPrice: number;
-  isActive: boolean;
-  maxLeverage: number;
-  volume24H: number;
-  priceChange24H: number;
-  priceChange24HPercentage: number;
-  openInterest: number;
-  fundingRate: number;
-  description: string;
-  orderInfo: MarketOrderInfo;
-  tickSizeDecimals: number;
-  chainId: SupportedChainId;
-};
-
-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;
-};
-
-// -- Account --
-
-export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
-export type Side = 'long' | 'short';
-
-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 MarginAccountEntity = {
-  id: number;
-  name: string;
-  marginRatioHealth: 'danger' | 'healthy' | 'warning';
-  marginRatioPercentage: number;
-  totalBalance: number;
-  totalBalanceUnderlyingAsset: string;
-  collaterals: {
-    token: string;
-    percentage: number;
-    balance: number;
-    balanceRUSD: number;
-  }[];
-};
-
-export type GetMarginAccountsResult = MarginAccountEntity[];
-export type GetMarginAccountResult = MarginAccountEntity;
-
-export type PositionEntity = {
-  id: number;
-  side: Side;
-  size: number;
-  base: number;
-  price: number;
-  markPrice: number;
-  orderStatus: Status;
-  realisedPnl?: number | null;
-  unrealisedPnl?: number | null;
-  liquidationPrice: number;
-  fundingRate: number;
-  market: MarketEntity;
-  date: Date;
-};
-
-export type GetPositionsForMarginAccountResult = {
-  positions: PositionEntity[];
-  totalUnrealizedPNL: number;
-};
-
-// --- Trading History ----
-
-export type GetMarketTradingHistoryParams = {
-  marketId: number;
-  limit?: number;
-  fromTimestampMillisecondsUTC?: number;
-};
-
-export type TradingHistoryEntity = {
-  id: number;
-  price: number;
-  priceUnderlyingToken: string;
-  size: number;
-  sizeUnderlyingToken: string;
-  timestampMillisecondsUTC: number;
-};
-
-export type GetTradingHistoryResult = TradingHistoryEntity[];
-
-// --- Position History ---
-
-export type GetPositionsHistoryForMarginAccountParams = {
-  address: string;
-  marginAccountId: MarginAccountEntity['id'];
-  limit?: number;
-};
-
-export type OrderType = 'market';
-
-export type PositionHistoryType =
-  | 'long-trade'
-  | 'short-trade'
-  | 'long-liquidation'
-  | 'short-liquidation';
-
-export type PositionHistoryEntity = {
-  id: number;
-  action: PositionHistoryType;
-  orderType: OrderType;
-  size: number;
-  executionPrice: number;
-  realisedPnl?: number | null;
-  fees: number;
-  timestamp: number;
-  market: MarketEntity;
-};
-
-export type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];
-
-// -- Max Order Size --
-
-export type GetMaxOrderSizeAvailableParams = {
-  marketId: MarketEntity['id'];
-  marginAccountId: MarginAccountEntity['id'];
-  direction: 'long' | 'short';
-};
-
-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 = {
-  marketId: MarketEntity['id'];
-  marginAccountId: MarginAccountEntity['id'];
-};
-
-export type TradeSimulationSimulateParams = {
-  amount: number; // position size, + for long | - for short
-};
-
-// ---- LP ----
-
-export enum SupportedChainId {
-  polygonMumbai = 80001,
-  reyaCronos = 1729,
-}
-
-export type LpPoolEntity = {
-  id: number;
-  name: string;
-  description: string;
-  longDescription: string;
-  readMoreLink: string;
-  currentAPY: number;
-  balanceSupplied?: number | null;
-  apyChange24H: number;
-  tokenAddress: string;
-  token: string;
-  allowedChainsForLiquidity: number[];
-  chainId: SupportedChainId;
-};
-
-export type GetLpPoolsResult = LpPoolEntity[];
-
-export type GetLpPoolResult = LpPoolEntity;
-
-export type GetLpPoolParams = {
-  id: LpPoolEntity['id'];
-};
-
-export type TransactionHistoryType = 'deposit' | 'withdrawal';
-
-export type LpTransactionHistoryEntity = {
-  id: number;
-  type: TransactionHistoryType;
-  token: string;
-  amount: number;
-  transactionHash: string;
-  timestamp: number;
-};
-
-export type GetLpPoolTransactionHistoryParams = {
-  id: LpPoolEntity['id'];
-  address: string; // wallet address
-  limit?: number;
-};
-
-export type GetLpPoolTransactionHistoryResult = LpTransactionHistoryEntity[];
-
-export type GetLpPositionsParams = {
-  id: LpPoolEntity['id'];
-  address: string; // wallet address
-};
-
-export type LpPositionEntity = {
-  id: number;
-  deposited: number;
-  currentBalance: number;
-  pnl: number;
-  fundingRate: number;
-  lpPool: LpPoolEntity;
-};
-
-export type GetLpPositionsResult = LpPositionEntity[];
-
-export type GetLpPoolWithdrawBalanceParams = {
-  id: LpPoolEntity['id'];
-  address: string; // wallet address
-};
-
-export type GetLpPoolWithdrawBalanceResult = number;
-
-// ---- Transaction Simulation ----
-
-export type GetTransactionSimulationInitialDataParams = {
-  marketId: MarketEntity['id'];
-  marginAccountId: MarginAccountEntity['id'];
-};
-
-// ---- Transaction History
-
-export type GetMarginAccountTransactionHistoryParams = {
-  marginAccountId: MarginAccountEntity['id'];
-  limit?: number;
-};
-
-export type MarginAccountTransactionHistoryType =
-  | 'deposit'
-  | 'withdrawal'
-  | 'transfer'
-  | 'auto_exchange';
-
-export type MarginAccountTransactionHistoryEntity = {
-  id: number;
-  type: MarginAccountTransactionHistoryType;
-  token: string;
-  amount: number;
-  transactionHash: string;
-  timestamp: number;
-};
-
-export type GetMarginAccountTransactionHistoryResult =
-  MarginAccountTransactionHistoryEntity[];
-
-// --- Lp Pool Balance ---
-
-export enum BalanceGranularity {
-  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 GetLpPoolBalanceChartDataParams = {
-  poolId: LpPoolEntity['id'];
-  filters: {
-    timeframeMs: number;
-    granularity: BalanceGranularity;
-  };
-};
-
-export type GetLpPoolBalanceChartDataResult = {
-  data: {
-    timestampInMs: number;
-    value: number;
-  }[];
-  tvl: number;
-  tvlChangePercentage: number;
-  apy: number;
-  apyChangePercentage: number;
-};
-
-// - LP Account Performance -
-export type GetLpPoolPerformanceChartDataResult = {
-  capitalInvestedData: {
-    timestampInMs: number;
-    value: number;
-  }[];
-  balanceData: {
-    timestampInMs: number;
-    value: number;
-  }[];
-  balance: number;
-  balanceChangePercentage: number;
-  capitalInvested: number;
-  capitalInvestedChangePercentage: number;
-};
-
-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;
-  };
-};
-
-// --- Max Withdraw Balance for Margin Account ---
-export type GetMaxWithdrawBalanceForAccountParams = {
-  marginAccountId: MarginAccountEntity['id'];
-  tokenAddress: string; // address of usdc/eth/btc
-};
-
-export type GetMaxWithdrawBalanceForAccountResult = number;
-
-// -- Tokens --
-export type GetAllowedTokensParams = {
-  chainId: number;
-};
-
-export type GetAllowedTokenResult = {
-  tokens: {
-    id: string;
-    address: string;
-  }[];
-};
+// reexporting what we want to share with integrators
+export {
+  Candle,
+  CandlesResolution,
+  MarketEntity,
+  LpTransactionHistoryEntity,
+  TradingHistoryEntity,
+  PositionHistoryEntity,
+  PositionEntity,
+  TransactionHistoryType,
+  MarginAccountTransactionHistoryType,
+  MarginAccountTransactionHistoryEntity,
+  MarginAccountEntity,
+  LpPositionEntity,
+  LpPoolEntity,
+} from '@reyaxyz/common';

package/src/index.ts

@@ -1,4 +1,2 @@
 export { ApiClient } from './clients/api-client';
 export * from './clients/types';
-export * from './clients/helpers/exposure.calculator';
-export * from './clients/helpers/trade.simulation.types';