@reyaxyz/common 0.261.0 → 0.262.0

package/src/trading-api-types.ts

@@ -51,13 +51,186 @@ type Order = {
   created_at: Date;
 };
 
+type Position = {
+  market_id: Decimal;
+  account_id: Decimal;
+  base: Decimal | null;
+  realized_pnl: Decimal | null;
+  realized_pnl_latest_snapshot: Decimal | null;
+  average_entry_price_off_chain_tracker: Decimal | null;
+  funding_value_off_chain_tracker: Decimal | null;
+  last_price: Decimal | null;
+  position_data_last_price_data_timestamp: Decimal | null;
+  funding_value: Decimal | null;
+  base_multiplier: Decimal | null;
+  adl_unwind_price: Decimal | null;
+  transaction_hash: string;
+  block_timestamp: Decimal | null;
+  block_number: Decimal;
+  unique_id: bigint | null;
+};
+
+type ConditionalOrder = {
+  id: string;
+  account_id: Decimal;
+  market_id: Decimal;
+  order_type: string;
+  is_long: boolean;
+  trigger_price: number;
+  order_base: Decimal;
+  exchange_id: bigint;
+  inputs: string;
+  counterparty_account_id: bigint;
+  reya_chain_id: bigint;
+  deadline: bigint;
+  signer_address: string;
+  nonce: Decimal;
+  signature: string;
+  status: string;
+  creation_timestamp_ms: bigint;
+  last_update_timestamp_ms: bigint;
+  transaction_hash: string | null;
+};
+
+type Swap = {
+  id: string;
+  account_id: Decimal;
+  token_in: string;
+  token_out: string;
+  amount_in: Decimal;
+  amount_out: Decimal;
+  executed_amount_out: Decimal;
+  transaction_hash: string;
+  block_timestamp: Decimal;
+  block_number: Decimal;
+  unique_id: bigint | null;
+};
+
+type Market = {
+  id: Decimal;
+  ticker: string;
+  markPrice: number;
+  isActive: boolean;
+  maxLeverage: number;
+  volume24H: number;
+  priceChange24H: number;
+  longOI: number;
+  shortOI: number;
+  availableLong: number;
+  availableShort: number;
+  marketPriceDeviation: number;
+  riskBlockId: number;
+  rootCollateralPoolId: number;
+  description: string;
+  name: string;
+  quoteTokenId: string;
+  tickSizeDecimals: number;
+  underlyingAssetId: string;
+  priceChange24HPercentage: number;
+  openInterest: number;
+  fundingRate: number;
+  priority: number;
+};
+
+type Account = {
+  account_id: Decimal;
+  name: string;
+  status: AccountStatus;
+  updated_timestamp_ms: Decimal;
+  source: string | null;
+};
+
+type Price = {
+  block_number: Decimal;
+  unique_id: bigint | null;
+  contract_id: string;
+  price: Decimal | null;
+  round_id: Decimal | null;
+  timestamp: Decimal;
+};
+
+type AccountBalance = {
+  account_id: number | null;
+  collateral: string | null;
+  balance?: string | null;
+  delta?: string | null;
+};
+
+type AutoExchange = {
+  id: string;
+  liquidated_account_id: Decimal | null;
+  liquidator_account_id: Decimal | null;
+  requested_quote_amount: Decimal | null;
+  collateral_out_address: string | null;
+  collateral_in_address: string | null;
+  collateral_amount_to_liquidator: Decimal | null;
+  quote_amount_to_insurance_fund: Decimal | null;
+  quote_amount_to_account: Decimal | null;
+  block_timestamp: Decimal | null;
+  block_number: Decimal;
+  transaction_hash: string;
+  unique_id: bigint | null;
+};
+
+type Leverage = {
+  accountId: Decimal;
+  marketId: Decimal;
+  leverage: number;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+export type TradingApiEndpoint<
+  Response,
+  Params,
+  ReplicationTable extends ReplicationModel = never,
+  Replication = Response,
+  Query = never,
+> = {
+  params: Params;
+  query: Query;
+  response: Response;
+  replication: GenericReplicationMessage<Replication, ReplicationTable>;
+};
+
+export type TradingApiListEndpoint<
+  Response,
+  Params = never,
+  ReplicationTable extends ReplicationModel = never,
+  Replication = Response,
+  Query = never,
+> = {
+  params: Params;
+  query: Query;
+  response: Response[];
+  replication: GenericReplicationMessage<Replication, ReplicationTable>;
+};
+
+export type TradingApiInfiniteListEndpointResponse<Response> = {
+  data: Response[];
+  meta: PaginatedQueryMeta;
+};
+
+export type TradingApiInfiniteListEndpoint<
+  Response,
+  Params = never,
+  ReplicationTable extends ReplicationModel = never,
+  Replication = Response,
+  Query = PaginatedQueryParams,
+> = {
+  params: Params;
+  query: Query;
+  response: TradingApiInfiniteListEndpointResponse<Response>;
+  replication: GenericReplicationMessage<Replication, ReplicationTable>;
+};
+
+type AddressParam = {
+  address: string;
+};
+
 export type TradingApiSource = {
-  PoolBalance: {
-    params: {
-      poolId?: string;
-    };
-    query: never;
-    response: {
+  'poolBalance/:poolId?': TradingApiEndpoint<
+    {
       id: number;
       timestamp: bigint;
       pool_id: number;
@@ -65,353 +238,198 @@ export type TradingApiSource = {
       apy: Decimal;
       share_price: Decimal;
       share_price_index: Decimal;
-    } | null;
-  };
-  Leverages: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
-      accountId: Decimal;
-      marketId: Decimal;
-      leverage: number;
-      createdAt: Date;
-      updatedAt: Date;
-    }[];
-  };
-  MarketsConfiguration: {
-    params: never;
-    query: never;
-    response: {
-      market_id: Decimal;
-      risk_matrix_index: Decimal | null;
-      max_open_base: Decimal | null;
-      velocity_multiplier: Decimal | null;
-      minimum_order_base: Decimal | null;
-      base_spacing: Decimal | null;
-      price_spacing: Decimal | null;
-      oracle_node_id: string | null;
-      mtm_window: Decimal | null;
-      dutch_config_lambda: Decimal | null;
-      dutch_config_min_base: Decimal | null;
-      slippage_params_phi: Decimal | null;
-      slippage_params_beta: Decimal | null;
-      depth_factor: Decimal | null;
-      max_exposure_factor: Decimal | null;
-      max_p_slippage: Decimal | null;
-      price_spread: Decimal | null;
-      volatility_index_multiplier: Decimal | null;
-      block_timestamp: Decimal | null;
-      block_number: Decimal;
-      unique_id: bigint | null;
-    }[];
-  };
-  MarketsStorage: {
-    params: never;
-    query: never;
-    response: {
-      market_id: Decimal;
-      quote_collateral: string | null;
-      instrument_address: string | null;
-      name: string | null;
-      risk_block_id: Decimal | null;
-      collateral_pool_id: Decimal | null;
-      block_timestamp: Decimal | null;
-      block_number: Decimal;
-      unique_id: bigint | null;
-    }[];
-  };
-  MarketsTracker: {
-    params: never;
-    query: never;
-    response: {
-      market_data_id: Decimal;
-      passive_pool_id: Decimal | null;
-      pool_account_id: Decimal | null;
-      quote_token: string | null;
-      quote_token_decimals: Decimal | null;
-      last_funding_velocity: Decimal | null;
-      last_funding_timestamp: Decimal | null;
-      last_mtm_price: Decimal | null;
-      last_mtm_timestamp: Decimal | null;
-      long_trackers_funding_value: Decimal | null;
-      last_funding_rate: Decimal | null;
-      long_trackers_base_multiplier: Decimal | null;
-      long_trackers_adl_unwind_price: Decimal | null;
-      short_trackers_funding_value: Decimal | null;
-      short_trackers_base_multiplier: Decimal | null;
-      short_trackers_adl_unwind_price: Decimal | null;
-      open_interest: Decimal | null;
-      block_timestamp: Decimal | null;
-      block_number: Decimal;
-      unique_id: bigint | null;
-    }[];
-  };
-  Positions: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
+    } | null,
+    {
+      poolId?: string;
+    }
+  >;
+  'wallet/:address/leverages': TradingApiListEndpoint<
+    Leverage,
+    { address: string },
+    'accountLeveragePerMarket'
+  >;
+  'markets/configuration': TradingApiListEndpoint<{
+    market_id: Decimal;
+    risk_matrix_index: Decimal | null;
+    max_open_base: Decimal | null;
+    velocity_multiplier: Decimal | null;
+    minimum_order_base: Decimal | null;
+    base_spacing: Decimal | null;
+    price_spacing: Decimal | null;
+    oracle_node_id: string | null;
+    mtm_window: Decimal | null;
+    dutch_config_lambda: Decimal | null;
+    dutch_config_min_base: Decimal | null;
+    slippage_params_phi: Decimal | null;
+    slippage_params_beta: Decimal | null;
+    depth_factor: Decimal | null;
+    max_exposure_factor: Decimal | null;
+    max_p_slippage: Decimal | null;
+    price_spread: Decimal | null;
+    volatility_index_multiplier: Decimal | null;
+    block_timestamp: Decimal | null;
+    block_number: Decimal;
+    unique_id: bigint | null;
+  }>;
+  'markets/storage': TradingApiListEndpoint<{
+    market_id: Decimal;
+    quote_collateral: string | null;
+    instrument_address: string | null;
+    name: string | null;
+    risk_block_id: Decimal | null;
+    collateral_pool_id: Decimal | null;
+    block_timestamp: Decimal | null;
+    block_number: Decimal;
+    unique_id: bigint | null;
+  }>;
+  'markets/trackers': TradingApiListEndpoint<{
+    market_data_id: Decimal;
+    passive_pool_id: Decimal | null;
+    pool_account_id: Decimal | null;
+    quote_token: string | null;
+    quote_token_decimals: Decimal | null;
+    last_funding_velocity: Decimal | null;
+    last_funding_timestamp: Decimal | null;
+    last_mtm_price: Decimal | null;
+    last_mtm_timestamp: Decimal | null;
+    long_trackers_funding_value: Decimal | null;
+    last_funding_rate: Decimal | null;
+    long_trackers_base_multiplier: Decimal | null;
+    long_trackers_adl_unwind_price: Decimal | null;
+    short_trackers_funding_value: Decimal | null;
+    short_trackers_base_multiplier: Decimal | null;
+    short_trackers_adl_unwind_price: Decimal | null;
+    open_interest: Decimal | null;
+    block_timestamp: Decimal | null;
+    block_number: Decimal;
+    unique_id: bigint | null;
+  }>;
+  'wallet/:address/positions': TradingApiListEndpoint<
+    Position,
+    AddressParam,
+    'position_raw'
+  >;
+  'wallet/:address/conditionalOrders': TradingApiListEndpoint<
+    ConditionalOrder,
+    AddressParam,
+    'ConditionalOrders'
+  >;
+  assets: TradingApiListEndpoint<{
+    address: string;
+    name: string;
+    short: string;
+    createdAt: Date;
+    updatedAt: Date;
+    asset_price_contract_id: string | null;
+    asset_price_usdc_contract_id: string | null;
+    decimals: number;
+  }>;
+  prices: TradingApiListEndpoint<Price>;
+  'wallet/:address/accounts': TradingApiListEndpoint<
+    Account,
+    AddressParam,
+    'accountProfile'
+  >;
+  'wallet/:address/accounts/tiers': TradingApiListEndpoint<
+    {
       market_id: Decimal;
       account_id: Decimal;
-      base: Decimal | null;
-      realized_pnl: Decimal | null;
-      realized_pnl_latest_snapshot: Decimal | null;
-      average_entry_price_off_chain_tracker: Decimal | null;
-      funding_value_off_chain_tracker: Decimal | null;
-      last_price: Decimal | null;
-      position_data_last_price_data_timestamp: Decimal | null;
-      funding_value: Decimal | null;
-      base_multiplier: Decimal | null;
-      adl_unwind_price: Decimal | null;
-      transaction_hash: string;
-      block_timestamp: Decimal | null;
-      block_number: Decimal;
-      unique_id: bigint | null;
-    }[];
-  };
-  ConditionalOrders: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
-      id: string;
-      account_id: Decimal;
-      market_id: Decimal;
-      order_type: string;
-      is_long: boolean;
-      trigger_price: number;
-      order_base: Decimal;
-      exchange_id: bigint;
-      inputs: string;
-      counterparty_account_id: bigint;
-      reya_chain_id: bigint;
-      deadline: bigint;
-      signer_address: string;
-      nonce: Decimal;
-      signature: string;
-      status: string;
-      creation_timestamp_ms: bigint;
-      last_update_timestamp_ms: bigint;
-      transaction_hash: string | null;
-    }[];
-  };
-  Assets: {
-    params: never;
-    query: never;
-    response: {
-      address: string;
-      name: string;
-      short: string;
-      createdAt: Date;
-      updatedAt: Date;
-      asset_price_contract_id: string | null;
-      asset_price_usdc_contract_id: string | null;
-      decimals: number;
-    }[];
-  };
-  Prices: {
-    params: never;
-    query: never;
-    response: {
-      block_number: Decimal;
-      unique_id: bigint | null;
-      contract_id: string;
-      price: Decimal | null;
-      round_id: Decimal | null;
-      timestamp: Decimal;
-    }[];
-  };
-  Accounts: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
-      account_id: Decimal;
-      name: string;
-      status: AccountStatus;
-      updated_timestamp_ms: Decimal;
-      source: string | null;
-    }[];
-  };
-  AccountsBalances: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
-      account_id: number;
-      collateral: string;
-      balance: string;
-    }[];
-  };
-  AutoExchange: {
-    params: {
-      address: string;
-    };
-    query: PaginatedQueryParams;
-    response: {
-      data: {
-        id: string;
-        liquidated_account_id: Decimal | null;
-        liquidator_account_id: Decimal | null;
-        requested_quote_amount: Decimal | null;
-        collateral_out_address: string | null;
-        collateral_in_address: string | null;
-        collateral_amount_to_liquidator: Decimal | null;
-        quote_amount_to_insurance_fund: Decimal | null;
-        quote_amount_to_account: Decimal | null;
-        block_timestamp: Decimal | null;
-        block_number: Decimal;
-        transaction_hash: string;
-        unique_id: bigint | null;
-      }[];
-      meta: PaginatedQueryMeta;
-    };
-  };
-  Swaps: {
-    params: {
-      address: string;
-    };
-    query: PaginatedQueryParams;
-    response: {
-      data: {
-        id: string;
-        account_id: Decimal;
-        token_in: string;
-        token_out: string;
-        amount_in: Decimal;
-        amount_out: Decimal;
-        executed_amount_out: Decimal;
-        transaction_hash: string;
-        block_timestamp: Decimal;
-        block_number: Decimal;
-        unique_id: bigint | null;
-      }[];
-      meta: PaginatedQueryMeta;
-    };
-  };
-  MarketOrders: {
-    params: {
+      tier_id: Decimal;
+    },
+    AddressParam
+  >;
+  'wallet/:address/accounts/balances': TradingApiListEndpoint<
+    AccountBalance,
+    AddressParam,
+    'account_balances'
+  >;
+  'wallet/:address/autoExchange': TradingApiInfiniteListEndpoint<
+    AutoExchange,
+    AddressParam,
+    'auto_exchange'
+  >;
+  'wallet/:address/swaps': TradingApiInfiniteListEndpoint<
+    Swap,
+    AddressParam,
+    'swaps'
+  >;
+  'market/:marketId/orders': TradingApiInfiniteListEndpoint<
+    Order,
+    {
       marketId: string;
       type?: string;
-    };
-    query: PaginatedQueryParams;
-    response: {
-      data: Order[];
-      meta: PaginatedQueryMeta;
-    };
-  };
-  AccountOrders: {
-    params: {
+    },
+    'order_history'
+  >;
+  'account/:accountId/orders': TradingApiInfiniteListEndpoint<
+    Order,
+    {
       accountId: string;
       type?: string;
-    };
-    query: PaginatedQueryParams;
-    response: {
-      data: Order[];
-      meta: PaginatedQueryMeta;
-    };
-  };
-  WalletBalanceHistory: {
-    params: {
-      address: string;
-      timestamp?: string;
-    };
-    query: never;
-    response: {
+    },
+    'order_history'
+  >;
+  'wallet/:address/balanceHistory/:timestamp?': TradingApiListEndpoint<
+    {
       timestamp: number;
       balance: number;
-    }[];
-  };
-  WalletOrders: {
-    params: {
+    },
+    {
+      address: string;
+      timestamp?: string;
+    }
+  >;
+  'wallet/:address/orders/:type?': TradingApiInfiniteListEndpoint<
+    Order,
+    {
       address: string;
       type?: string;
-    };
-    query: PaginatedQueryParams;
-    response: {
-      data: Order[];
-      meta: PaginatedQueryMeta;
-    };
-  };
-  RiskMatrices: {
-    params: {
-      poolId: string;
-    };
-    query: never;
-    response: {
+    },
+    'order_history'
+  >;
+  'riskMatrices/:poolId?': TradingApiListEndpoint<
+    {
       blockId: Decimal;
       matrix: string[][];
-    }[];
-  };
-  Markets: {
-    params: never;
-    query: never;
-    response: {
-      id: Decimal;
-      ticker: string;
-      markPrice: number;
-      isActive: boolean;
-      maxLeverage: number;
-      volume24H: number;
-      priceChange24H: number;
-      longOI: number;
-      shortOI: number;
-      availableLong: number;
-      availableShort: number;
-      marketPriceDeviation: number;
-      riskBlockId: number;
-      rootCollateralPoolId: number;
-      description: string;
-      name: string;
-      quoteTokenId: string;
-      tickSizeDecimals: number;
-      underlyingAssetId: string;
-      priceChange24HPercentage: number;
-      openInterest: number;
-      fundingRate: number;
-      priority: number;
-    }[];
-  };
-  TierFees: {
-    params: never;
-    query: never;
-    response: {
-      market_id: Decimal;
-      tier_id: Decimal;
-      fee_parameter: Decimal | null;
-    }[];
-  };
-  AccountsTiers: {
-    params: {
-      address: string;
-    };
-    query: never;
-    response: {
-      market_id: Decimal;
-      account_id: Decimal;
-      tier_id: Decimal;
-    }[];
-  };
-  CollateralConfiguration: {
-    params: never;
-    query: never;
-    response: {
-      collateral_pool_id: Decimal;
-      collateral_address: string;
-      price_haircut: Decimal | null;
-      auto_exchange_discount: Decimal | null;
-      oracle_node_id: string | null;
-      block_timestamp: Decimal | null;
-      block_number: Decimal;
-      unique_id: bigint | null;
-    }[];
-  };
+    },
+    {
+      poolId: string;
+    }
+  >;
+  markets: TradingApiListEndpoint<Market>;
+  tierFees: TradingApiListEndpoint<{
+    market_id: Decimal;
+    tier_id: Decimal;
+    fee_parameter: Decimal | null;
+  }>;
+  collateralConfiguration: TradingApiListEndpoint<{
+    collateral_pool_id: Decimal;
+    collateral_address: string;
+    price_haircut: Decimal | null;
+    auto_exchange_discount: Decimal | null;
+    oracle_node_id: string | null;
+    block_timestamp: Decimal | null;
+    block_number: Decimal;
+    unique_id: bigint | null;
+  }>;
+  candles: TradingApiEndpoint<
+    {
+      t: number[];
+      o: number[];
+      h: number[];
+      l: number[];
+      c: number[];
+    },
+    never,
+    never,
+    never,
+    {
+      from: number;
+      to: number;
+      resolution: 1 | 5 | 15 | 30 | 60 | 240 | '1D';
+      symbol: string;
+    }
+  >;
 };
 
 export type Stringified<T, D = Decimal> = T extends D | bigint | Date
@@ -448,5 +466,60 @@ export type TradingApi = {
     params: TradingApiSource[K]['params'];
     query: TradingApiSource[K]['query'];
     response: Stringified<TradingApiSource[K]['response']>;
+    replication: Stringified<TradingApiSource[K]['replication']>;
   };
 };
+
+type ReplicationModel = string | never;
+
+export type GenericReplicationMessage<T, model extends ReplicationModel> =
+  | {
+      model: model;
+      result: T;
+      operation: 'create' | 'update' | 'upsert' | 'delete';
+    }
+  | {
+      model: model;
+      result: T[];
+      operation: 'updateMany';
+    };
+
+type account_collateral_balance_entries = {
+  id: string;
+  account_id: Decimal | null;
+  collateral: string | null;
+  amount: Decimal | null;
+  transaction_hash: string;
+  block_timestamp: Decimal | null;
+  block_number: Decimal;
+  unique_id: bigint | null;
+};
+
+type account_owner_updated_snapshot = {
+  account_id: Decimal;
+  transaction_hash: string;
+  new_owner: string | null;
+  block_timestamp: Decimal | null;
+  block_number: Decimal;
+  unique_id: bigint | null;
+};
+
+export type ReplicationMessage =
+  | GenericReplicationMessage<Order, 'order_history'>
+  | GenericReplicationMessage<ConditionalOrder, 'ConditionalOrders'>
+  | GenericReplicationMessage<Swap, 'swaps'>
+  | GenericReplicationMessage<AutoExchange, 'auto_exchange'>
+  | GenericReplicationMessage<Position, 'position_raw'>
+  | GenericReplicationMessage<Price, 'asset_price'>
+  | GenericReplicationMessage<Account, 'accountProfile'>
+  | GenericReplicationMessage<Leverage, 'accountLeveragePerMarket'>
+  | GenericReplicationMessage<
+      account_owner_updated_snapshot,
+      'account_owner_updated_snapshot'
+    >
+  | GenericReplicationMessage<
+      account_collateral_balance_entries,
+      'account_collateral_balance_entries'
+    >
+  | GenericReplicationMessage<AccountBalance, 'account_balances'>
+  | GenericReplicationMessage<Market, 'Market'>;