@andy-liquid-labs/lighter-ts-sdk 1.0.0

package/src/api/info/fastbridge-info.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+
+export interface FastBridgeInfoResponse {
+  code: number;
+  message?: string;
+  fast_bridge_limit: string;
+}
+
+export async function getFastBridgeInfo(
+  client: AxiosInstance,
+): Promise<FastBridgeInfoResponse> {
+  return client
+    .get<FastBridgeInfoResponse>("/api/v1/fastbridge/info")
+    .then((response) => response.data);
+}

package/src/api/info/funding-rates.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from "axios";
+
+export interface FundingRate {
+  market_id: number;
+  exchange: "binance" | "bybit" | "hyperliquid" | "lighter";
+  symbol: string;
+  rate: number;
+}
+
+export interface FundingRatesResponse {
+  code: number;
+  message?: string;
+  funding_rates: FundingRate[];
+}
+
+export async function getFundingRates(
+  client: AxiosInstance,
+): Promise<FundingRatesResponse> {
+  return client
+    .get<FundingRatesResponse>("/api/v1/funding-rates")
+    .then((response) => response.data);
+}

package/src/api/info/fundings.ts

@@ -0,0 +1,29 @@
+import { AxiosInstance } from "axios";
+
+export interface Funding {
+  timestamp: number;
+  market_id: number;
+  funding_id: number;
+  rate: string;
+}
+
+export interface FundingsRequest {
+  market_id: number;
+  resolution: string;
+  start_timestamp?: number;
+  end_timestamp?: number;
+  count_back?: number;
+}
+
+export interface FundingsResponse {
+  fundings: Funding[];
+}
+
+export async function getFundings(
+  client: AxiosInstance,
+  params: FundingsRequest,
+): Promise<FundingsResponse> {
+  return client
+    .get<FundingsResponse>("/api/v1/fundings", { params })
+    .then((response) => response.data);
+}

package/src/api/info/index.ts

@@ -0,0 +1,20 @@
+export * from "./account";
+export * from "./account-by-l1-address";
+export * from "./announcement";
+export * from "./api-keys";
+export * from "./asset-details";
+export * from "./candles";
+export * from "./exchange-stats";
+export * from "./fastbridge-info";
+export * from "./funding-rates";
+export * from "./fundings";
+export * from "./next-nonce";
+export * from "./order-book-details";
+export * from "./order-books";
+export * from "./recent-trades";
+export * from "./root-info";
+export * from "./root-status";
+export * from "./tx";
+export * from "./tx-from-l1-hash";
+export * from "./txs";
+export * from "./withdrawal-delay";

package/src/api/info/next-nonce.ts

@@ -0,0 +1,26 @@
+import { AxiosInstance } from "axios";
+
+export interface NextNonceRequest {
+  account_index: number;
+  api_key_index: number;
+}
+
+export interface NextNonceResponse {
+  account_index: number;
+  api_key_index: number;
+  nonce: number;
+}
+
+export async function getNextNonce(
+  client: AxiosInstance,
+  params: NextNonceRequest,
+): Promise<NextNonceResponse> {
+  return client
+    .get<NextNonceResponse>("/api/v1/nextNonce", {
+      params: {
+        account_index: params.account_index,
+        api_key_index: params.api_key_index,
+      },
+    })
+    .then((response) => response.data);
+}

package/src/api/info/order-book-details.ts

@@ -0,0 +1,125 @@
+import { AxiosInstance } from "axios";
+
+export interface OrderBookDetailsRequest {
+  market_id?: number;
+}
+
+export interface OrderBookDetail {
+  symbol: string;
+  market_id: number;
+  market_type: string;
+  status: string;
+  taker_fee: string;
+  maker_fee: string;
+  liquidation_fee: string;
+  min_base_amount: string;
+  min_quote_amount: string;
+  order_quote_limit: string;
+  supported_size_decimals: number;
+  supported_price_decimals: number;
+  supported_quote_decimals: number;
+  size_decimals: number;
+  price_decimals: number;
+  quote_multiplier: number;
+  default_initial_margin_fraction: number;
+  min_initial_margin_fraction: number;
+  maintenance_margin_fraction: number;
+  closeout_margin_fraction: number;
+  last_trade_price: number;
+  daily_trades_count: number;
+  daily_base_token_volume: number;
+  daily_quote_token_volume: number;
+  daily_price_low: number;
+  daily_price_high: number;
+  daily_price_change: number;
+  open_interest: number;
+  daily_chart: any;
+  market_config: {
+    market_margin_mode: number;
+    insurance_fund_account_index: number;
+  };
+}
+
+export interface SpotOrderBookDetail {
+  symbol: string;
+  market_id: number;
+  market_type: string;
+  base_asset_id: string;
+  quote_asset_id: string;
+  status: string;
+  taker_fee: string;
+  maker_fee: string;
+  liquidation_fee: string;
+  min_base_amount: string;
+  min_quote_amount: string;
+  order_quote_limit: string;
+  supported_size_decimals: number;
+  supported_price_decimals: number;
+  supported_quote_decimals: number;
+  size_decimals: number;
+  price_decimals: number;
+  last_trade_price: number;
+  daily_trades_count: number;
+  daily_base_token_volume: number;
+  daily_quote_token_volume: number;
+  daily_price_low: number;
+  daily_price_high: number;
+  daily_price_change: number;
+}
+
+export interface OrderBookDetailsResponse {
+  code: number;
+  order_book_details: OrderBookDetail[];
+  spot_order_book_details: SpotOrderBookDetail[];
+}
+
+export async function getOrderBookDetails(
+  client: AxiosInstance,
+  params?: OrderBookDetailsRequest,
+): Promise<OrderBookDetailsResponse> {
+  return client
+    .get<OrderBookDetailsResponse>("/api/v1/orderBookDetails", {
+      params:
+        params?.market_id !== undefined
+          ? { market_id: params.market_id }
+          : undefined,
+    })
+    .then((response) => response.data);
+}
+
+export interface OrderBookOrdersRequest {
+  market_id: number;
+  limit?: number;
+}
+
+export interface OrderBookOrder {
+  order_index: number;
+  order_id: string;
+  owner_account_index: number;
+  initial_base_amount: string;
+  remaining_base_amount: string;
+  price: string;
+  order_expiry: number;
+}
+
+export interface OrderBookOrdersResponse {
+  code?: number;
+  total_asks?: number;
+  total_bids?: number;
+  bids?: OrderBookOrder[];
+  asks?: OrderBookOrder[];
+}
+
+export async function getOrderBookOrders(
+  client: AxiosInstance,
+  params: OrderBookOrdersRequest,
+): Promise<OrderBookOrdersResponse> {
+  return client
+    .get<OrderBookOrdersResponse>("/api/v1/orderBookOrders", {
+      params: {
+        market_id: params.market_id,
+        ...(params.limit !== undefined ? { limit: params.limit } : {}),
+      },
+    })
+    .then((response) => response.data);
+}

package/src/api/info/order-books.ts

@@ -0,0 +1,23 @@
+import { AxiosInstance } from "axios";
+
+export interface PriceLevel {
+  price: string;
+  size: string;
+}
+
+export interface OrderBook {
+  market_id: number;
+  bids: PriceLevel[];
+  asks: PriceLevel[];
+  last_update_id: string;
+}
+
+export type OrderBooksResponse = OrderBook[];
+
+export async function getOrderBooks(
+  client: AxiosInstance,
+): Promise<OrderBooksResponse> {
+  return client
+    .get<OrderBooksResponse>("/api/v1/orderBooks")
+    .then((response) => response.data);
+}

package/src/api/info/recent-trades.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from "axios";
+
+import { Trade } from "../info-private/trades";
+
+export interface RecentTradesRequest {
+  market_id: number;
+  limit: number;
+}
+
+export type RecentTradesResponse = Trade[];
+
+export async function getRecentTrades(
+  client: AxiosInstance,
+  params: RecentTradesRequest,
+): Promise<RecentTradesResponse> {
+  return client
+    .get<RecentTradesResponse>("/api/v1/recentTrades", {
+      params: {
+        market_id: params.market_id,
+        limit: params.limit,
+      },
+    })
+    .then((response) => response.data);
+}

package/src/api/info/root-info.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+
+export interface RootInfoResponse {
+  contract_address: string;
+}
+
+export async function getRootInfo(
+  client: AxiosInstance,
+): Promise<RootInfoResponse> {
+  return client
+    .get<RootInfoResponse>("/info")
+    .then((response) => response.data);
+}

package/src/api/info/root-status.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+
+export interface RootStatusResponse {
+  status: number;
+  network_id: number;
+  timestamp: string;
+}
+
+export async function getRootStatus(
+  client: AxiosInstance,
+): Promise<RootStatusResponse> {
+  return client.get<RootStatusResponse>("/").then((response) => response.data);
+}

package/src/api/info/tx-from-l1-hash.ts

@@ -0,0 +1,20 @@
+import { AxiosInstance } from "axios";
+
+import { Transaction } from "./tx";
+
+export interface TransactionFromL1TxHashRequest {
+  l1_tx_hash: string;
+}
+
+export async function getTransactionFromL1TxHash(
+  client: AxiosInstance,
+  params: TransactionFromL1TxHashRequest,
+): Promise<Transaction> {
+  return client
+    .get<Transaction>("/api/v1/txFromL1TxHash", {
+      params: {
+        l1_tx_hash: params.l1_tx_hash,
+      },
+    })
+    .then((response) => response.data);
+}

package/src/api/info/tx.ts

@@ -0,0 +1,45 @@
+import { AxiosInstance } from "axios";
+
+export interface TransactionRequest {
+  by: "hash" | "index";
+  value: string;
+}
+
+export interface Transaction {
+  hash: string;
+  block_height: number;
+  sequence_index: number;
+  account_index: number;
+  nonce: number;
+  type: string | number;
+  info?: string;
+  event_info?: string;
+  data?: any;
+  status: number | "pending" | "confirmed" | "failed";
+  transaction_index?: number;
+  l1_address?: string;
+  expire_at?: number;
+  queued_at?: number;
+  committed_at?: number;
+  verified_at?: number;
+  executed_at?: number;
+  parent_hash?: string;
+  created_at?: string;
+  updated_at?: string;
+  code?: number;
+  message?: string;
+}
+
+export async function getTransaction(
+  client: AxiosInstance,
+  params: TransactionRequest,
+): Promise<Transaction> {
+  return client
+    .get<Transaction>("/api/v1/tx", {
+      params: {
+        by: params.by,
+        value: params.value,
+      },
+    })
+    .then((response) => response.data);
+}

package/src/api/info/txs.ts

@@ -0,0 +1,19 @@
+import { AxiosInstance } from "axios";
+
+import { Transaction } from "./tx";
+
+export interface TransactionsRequest {
+  cursor?: string;
+  limit?: number;
+}
+
+export type TransactionsResponse = Transaction[];
+
+export async function getTransactions(
+  client: AxiosInstance,
+  params?: TransactionsRequest,
+): Promise<TransactionsResponse> {
+  return client
+    .get<TransactionsResponse>("/api/v1/txs", { params })
+    .then((response) => response.data);
+}

package/src/api/info/withdrawal-delay.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+
+export interface WithdrawalDelayResponse {
+  seconds: number;
+}
+
+export async function getWithdrawalDelay(
+  client: AxiosInstance,
+): Promise<WithdrawalDelayResponse> {
+  return client
+    .get<WithdrawalDelayResponse>("/api/v1/withdrawalDelay")
+    .then((response) => response.data);
+}

package/src/api/info-private/account-active-orders.ts

@@ -0,0 +1,31 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+import { Orders } from "./account-inactive-orders";
+
+export interface AccountActiveOrdersRequest {
+  account_index: number;
+  market_id: number;
+  auth?: string;
+}
+
+export async function getAccountActiveOrders(
+  client: AxiosInstance,
+  params: AccountActiveOrdersRequest,
+  authorization?: string,
+): Promise<Orders> {
+  const config: AxiosRequestConfig = {
+    params: {
+      account_index: params.account_index,
+      market_id: params.market_id,
+      ...(params.auth ? { auth: params.auth } : {}),
+    },
+  };
+
+  if (authorization) {
+    config.headers = { Authorization: authorization };
+  }
+
+  return client
+    .get<Orders>("/api/v1/accountActiveOrders", config)
+    .then((response) => response.data);
+}

package/src/api/info-private/account-inactive-orders.ts

@@ -0,0 +1,83 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+export interface Order {
+  order_index: number;
+  client_order_index: number;
+  order_id: string;
+  client_order_id: string;
+  market_index: number;
+  owner_account_index: number;
+  initial_base_amount: string;
+  price: string;
+  nonce: number;
+  remaining_base_amount: string;
+  is_ask: boolean;
+  base_size: number;
+  base_price: number;
+  filled_base_amount: string;
+  filled_quote_amount: string;
+  side: string;
+  type: string;
+  time_in_force: string;
+  reduce_only: boolean;
+  trigger_price: string;
+  order_expiry: number;
+  status: string;
+  trigger_status: string;
+  trigger_time: number;
+  parent_order_index: number;
+  parent_order_id: string;
+  to_trigger_order_id_0?: string;
+  to_trigger_order_id_1?: string;
+  to_cancel_order_id_0?: string;
+  to_cancel_order_id_1?: string;
+  block_height: number;
+  timestamp: number;
+}
+
+export interface Orders {
+  code: number;
+  orders: Order[];
+}
+
+export interface AccountInactiveOrdersRequest {
+  account_index: number;
+  limit: number;
+  auth?: string;
+  market_id?: number;
+  ask_filter?: number;
+  between_timestamps?: string;
+  cursor?: string;
+}
+
+export async function getAccountInactiveOrders(
+  client: AxiosInstance,
+  params: AccountInactiveOrdersRequest,
+  authorization?: string,
+): Promise<Orders> {
+  const config: AxiosRequestConfig = {
+    params: {
+      account_index: params.account_index,
+      limit: params.limit,
+      ...(params.auth ? { auth: params.auth } : {}),
+      ...(params.market_id !== undefined
+        ? { market_id: params.market_id }
+        : {}),
+      ...(params.ask_filter !== undefined
+        ? { ask_filter: params.ask_filter }
+        : {}),
+      ...(params.between_timestamps
+        ? { between_timestamps: params.between_timestamps }
+        : {}),
+      ...(params.cursor ? { cursor: params.cursor } : {}),
+    },
+  };
+
+  if (authorization) {
+    config.headers = { Authorization: authorization };
+  }
+
+  return client
+    .get<Orders>("/api/v1/accountInactiveOrders", config)
+    .then((response) => response.data);
+}

package/src/api/info-private/account-limits.ts

@@ -0,0 +1,35 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+export interface AccountLimitsRequest {
+  account_index: number;
+  auth?: string;
+}
+
+export interface AccountLimitsResponse {
+  code: number;
+  message?: string;
+  max_llp_percentage: number;
+  user_tier: string;
+  can_create_public_pool: boolean;
+}
+
+export async function getAccountLimits(
+  client: AxiosInstance,
+  params: AccountLimitsRequest,
+  authorization?: string,
+): Promise<AccountLimitsResponse> {
+  const config: AxiosRequestConfig = {
+    params: {
+      account_index: params.account_index,
+      ...(params.auth ? { auth: params.auth } : {}),
+    },
+  };
+
+  if (authorization) {
+    config.headers = { Authorization: authorization };
+  }
+
+  return client
+    .get<AccountLimitsResponse>("/api/v1/accountLimits", config)
+    .then((response) => response.data);
+}

package/src/api/info-private/account-metadata.ts

@@ -0,0 +1,43 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+export interface AccountMetadataRequest {
+  by: "index" | "l1_address";
+  value: string;
+  auth?: string;
+}
+
+export interface AccountMetadataInfo {
+  account_index: number;
+  name: string;
+  description: string;
+  can_invite: boolean;
+  referral_points_percentage: string;
+}
+
+export interface AccountMetadataResponse {
+  code: number;
+  message?: string;
+  account_metadatas: AccountMetadataInfo;
+}
+
+export async function getAccountMetadata(
+  client: AxiosInstance,
+  params: AccountMetadataRequest,
+  authorization?: string,
+): Promise<AccountMetadataResponse> {
+  const config: AxiosRequestConfig = {
+    params: {
+      by: params.by,
+      value: params.value,
+      ...(params.auth ? { auth: params.auth } : {}),
+    },
+  };
+
+  if (authorization) {
+    config.headers = { Authorization: authorization };
+  }
+
+  return client
+    .get<AccountMetadataResponse>("/api/v1/accountMetadata", config)
+    .then((response) => response.data);
+}

package/src/api/info-private/deposit-history.ts

@@ -0,0 +1,49 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+export interface DepositHistoryRequest {
+  account_index: number;
+  l1_address: string;
+  cursor?: string;
+  filter?: string;
+}
+
+export interface DepositHistoryItem {
+  id: string;
+  account_index: number;
+  l1_address: string;
+  l2_address: string;
+  amount: string;
+  l1_tx_hash: string;
+  status: string;
+  timestamp: number;
+  created_at: string;
+}
+
+export interface DepositHistoryResponse {
+  code: number;
+  deposits: DepositHistoryItem[];
+  cursor?: string;
+}
+
+export async function getDepositHistory(
+  client: AxiosInstance,
+  params: DepositHistoryRequest,
+  authorization?: string,
+): Promise<DepositHistoryResponse> {
+  const config: AxiosRequestConfig = {
+    params: {
+      account_index: params.account_index,
+      l1_address: params.l1_address,
+      ...(params.cursor ? { cursor: params.cursor } : {}),
+      ...(params.filter ? { filter: params.filter } : {}),
+    },
+  };
+
+  if (authorization) {
+    config.headers = { Authorization: authorization };
+  }
+
+  return client
+    .get<DepositHistoryResponse>("/api/v1/deposit/history", config)
+    .then((response) => response.data);
+}