lighter-sdk-client 0.2.11

package/dist/client/info-client.d.cts

@@ -0,0 +1,255 @@
+import { AccountRequest, AccountResponse } from '../api/info/account.cjs';
+import { AccountByL1AddressRequest, AccountAccountByL1AddressResponse } from '../api/info/account-by-l1-address.cjs';
+import { AnnouncementsResponse } from '../api/info/announcement.cjs';
+import { ApiKeysRequest, ApiKeysResponse } from '../api/info/api-keys.cjs';
+import { AssetDetailsRequest, AssetDetailsResponse } from '../api/info/asset-details.cjs';
+import { CandlesRequest, CandlesResponse } from '../api/info/candles.cjs';
+import { ExchangeStatsResponse } from '../api/info/exchange-stats.cjs';
+import { FastBridgeInfoResponse } from '../api/info/fastbridge-info.cjs';
+import { FundingRatesResponse } from '../api/info/funding-rates.cjs';
+import { FundingsRequest, FundingsResponse } from '../api/info/fundings.cjs';
+import { NextNonceRequest, NextNonceResponse } from '../api/info/next-nonce.cjs';
+import { OrderBookDetailsRequest, OrderBookDetailsResponse, OrderBookOrdersRequest, OrderBookOrdersResponse } from '../api/info/order-book-details.cjs';
+import { OrderBooksResponse } from '../api/info/order-books.cjs';
+import { RecentTradesRequest, RecentTradesResponse } from '../api/info/recent-trades.cjs';
+import { RootStatusResponse } from '../api/info/root-status.cjs';
+import { TransactionRequest, Transaction } from '../api/info/tx.cjs';
+import { TransactionFromL1TxHashRequest } from '../api/info/tx-from-l1-hash.cjs';
+import { TransactionsRequest, TransactionsResponse } from '../api/info/txs.cjs';
+import { WithdrawalDelayResponse } from '../api/info/withdrawal-delay.cjs';
+import 'axios';
+import '../api/info-private/trades.cjs';
+
+interface InfoClientConfig {
+    baseURL?: string;
+}
+/**
+ * InfoClient - Client for public info endpoints
+ *
+ * Provides access to all public API endpoints that don't require authentication.
+ *
+ * @example
+ * ```typescript
+ * const client = new InfoClient({
+ *   baseURL: "https://mainnet.zklighter.elliot.ai"
+ * });
+ *
+ * const account = await client.getAccountInfo({ by: "index", value: "0" });
+ * const orderBooks = await client.getOrderBooks();
+ * ```
+ */
+declare class InfoClient {
+    private readonly config;
+    private readonly axiosInstance;
+    constructor(config?: InfoClientConfig);
+    private createAxiosInstance;
+    /**
+     * Get account information by index or L2 address
+     * @param params - Account lookup parameters (by index or L2 address)
+     * @returns Account information including balances and positions
+     * @example
+     * ```typescript
+     * const account = await client.getAccountInfo({ by: "index", value: "0" });
+     * ```
+     */
+    getAccountInfo(params: AccountRequest): Promise<AccountResponse>;
+    /**
+     * Get account information by L1 address
+     * @param params - L1 address lookup parameters
+     * @returns Account information associated with the L1 address
+     * @example
+     * ```typescript
+     * const account = await client.getAccountByL1Address({ l1_address: "0x..." });
+     * ```
+     */
+    getAccountByL1Address(params: AccountByL1AddressRequest): Promise<AccountAccountByL1AddressResponse>;
+    /**
+     * Get API keys for an account
+     * @param params - Account index to retrieve API keys for
+     * @returns List of API keys associated with the account
+     * @example
+     * ```typeScript
+     * const keys = await client.getApiKeys({ account_index: 0 });
+     * ```
+     */
+    getApiKeys(params: ApiKeysRequest): Promise<ApiKeysResponse>;
+    /**
+     * Get system announcements
+     * @returns List of active announcements
+     * @example
+     * ```typescript
+     * const announcements = await client.getAnnouncements();
+     * ```
+     */
+    getAnnouncements(): Promise<AnnouncementsResponse>;
+    /**
+     * Get asset details for a specific asset or all assets
+     * @param params - Optional asset_index to get details for a specific asset
+     * @returns Asset details including symbol, decimals, limits, and pricing information
+     * @example
+     * ```typescript
+     * // Get all assets
+     * const allAssets = await client.getAssetDetails();
+     *
+     * // Get specific asset
+     * const asset = await client.getAssetDetails({ asset_index: 0 });
+     * ```
+     */
+    getAssetDetails(params?: AssetDetailsRequest): Promise<AssetDetailsResponse>;
+    /**
+     * Get candlestick data for a market
+     * @param params - Candlestick query parameters including market_id, resolution, and time range
+     * @returns Array of candlestick data
+     * @example
+     * ```typescript
+     * const candles = await client.getCandlesticks({
+     *   market_id: 1,
+     *   resolution: "1h",
+     *   start_timestamp: 1234567890,
+     *   end_timestamp: 1234567900
+     * });
+     * ```
+     */
+    getCandlesticks(params: CandlesRequest): Promise<CandlesResponse>;
+    /**
+     * Get funding history for a market
+     * @param params - Funding query parameters including market_id and time range
+     * @returns Array of funding data
+     * @example
+     * ```typescript
+     * const fundings = await client.getFundings({
+     *   market_id: 1,
+     *   start_timestamp: 1234567890,
+     *   end_timestamp: 1234567900
+     * });
+     * ```
+     */
+    getFundings(params: FundingsRequest): Promise<FundingsResponse>;
+    /**
+     * Get exchange statistics
+     * @returns Exchange-wide statistics including volume, fees, and markets
+     * @example
+     * ```typescript
+     * const stats = await client.getExchangeStats();
+     * ```
+     */
+    getExchangeStats(): Promise<ExchangeStatsResponse>;
+    /**
+     * Get fast bridge information
+     * @returns Fast bridge configuration and status
+     * @example
+     * ```typescript
+     * const bridgeInfo = await client.getFastBridgeInfo();
+     * ```
+     */
+    getFastBridgeInfo(): Promise<FastBridgeInfoResponse>;
+    /**
+     * Get current funding rates for all markets
+     * @returns Funding rates for all markets
+     * @example
+     * ```typescript
+     * const rates = await client.getFundingRates();
+     * ```
+     */
+    getFundingRates(): Promise<FundingRatesResponse>;
+    /**
+     * Get the next nonce for an account
+     * @param params - Account index to get nonce for
+     * @returns Next nonce value
+     * @example
+     * ```typescript
+     * const nonce = await client.getNextNonce({ account_index: 0 });
+     * ```
+     */
+    getNextNonce(params: NextNonceRequest): Promise<NextNonceResponse>;
+    /**
+     * Get all order books
+     * @returns List of all order books with their configurations
+     * @example
+     * ```typescript
+     * const orderBooks = await client.getOrderBooks();
+     * ```
+     */
+    getOrderBooks(): Promise<OrderBooksResponse>;
+    /**
+     * Get detailed information about a specific order book
+     * @param params - Optional market_id to get details for a specific market
+     * @returns Order book details including market information
+     * @example
+     * ```typescript
+     * const details = await client.getOrderBookDetails({ market_id: 1 });
+     * ```
+     */
+    getOrderBookDetails(params?: OrderBookDetailsRequest): Promise<OrderBookDetailsResponse>;
+    /**
+     * Get orders in an order book
+     * @param params - Market ID and optional depth/limit parameters
+     * @returns Bids and asks in the order book
+     * @example
+     * ```typescript
+     * const orders = await client.getOrderBookOrders({ market_id: 1, limit: 50 });
+     * ```
+     */
+    getOrderBookOrders(params: OrderBookOrdersRequest): Promise<OrderBookOrdersResponse>;
+    /**
+     * Get recent trades for a market
+     * @param params - Market ID and optional limit
+     * @returns Recent trades for the market
+     * @example
+     * ```typescript
+     * const trades = await client.getRecentTrades({ market_id: 1, limit: 50 });
+     * ```
+     */
+    getRecentTrades(params: RecentTradesRequest): Promise<RecentTradesResponse>;
+    /**
+     * Get a specific transaction by hash
+     * @param params - Transaction hash to look up
+     * @returns Transaction details
+     * @example
+     * ```typescript
+     * const tx = await client.getTransaction({ tx_hash: "0x..." });
+     * ```
+     */
+    getTransaction(params: TransactionRequest): Promise<Transaction>;
+    /**
+     * Get transactions with optional filtering
+     * @param params - Optional filter parameters for transaction queries
+     * @returns List of transactions
+     * @example
+     * ```typescript
+     * const txs = await client.getTransactions({ limit: 50 });
+     * ```
+     */
+    getTransactions(params?: TransactionsRequest): Promise<TransactionsResponse>;
+    /**
+     * Get L2 transaction from L1 transaction hash
+     * @param params - L1 transaction hash
+     * @returns Corresponding L2 transaction
+     * @example
+     * ```typescript
+     * const tx = await client.getTransactionFromL1TxHash({ l1_tx_hash: "0x..." });
+     * ```
+     */
+    getTransactionFromL1TxHash(params: TransactionFromL1TxHashRequest): Promise<Transaction>;
+    /**
+     * Get withdrawal delay in seconds
+     * @returns Withdrawal delay configuration
+     * @example
+     * ```typescript
+     * const delay = await client.getWithdrawalDelay();
+     * console.log(`Withdrawal delay: ${delay.seconds} seconds`);
+     * ```
+     */
+    getWithdrawalDelay(): Promise<WithdrawalDelayResponse>;
+    /**
+     * Get root status information
+     * @returns Root status including network status, network_id, and timestamp
+     * @example
+     * ```typescript
+     * const status = await client.getRootStatus();
+     * ```
+     */
+    getRootStatus(): Promise<RootStatusResponse>;
+}
+
+export { InfoClient, type InfoClientConfig };

package/dist/client/info-client.d.ts

@@ -0,0 +1,255 @@
+import { AccountRequest, AccountResponse } from '../api/info/account.js';
+import { AccountByL1AddressRequest, AccountAccountByL1AddressResponse } from '../api/info/account-by-l1-address.js';
+import { AnnouncementsResponse } from '../api/info/announcement.js';
+import { ApiKeysRequest, ApiKeysResponse } from '../api/info/api-keys.js';
+import { AssetDetailsRequest, AssetDetailsResponse } from '../api/info/asset-details.js';
+import { CandlesRequest, CandlesResponse } from '../api/info/candles.js';
+import { ExchangeStatsResponse } from '../api/info/exchange-stats.js';
+import { FastBridgeInfoResponse } from '../api/info/fastbridge-info.js';
+import { FundingRatesResponse } from '../api/info/funding-rates.js';
+import { FundingsRequest, FundingsResponse } from '../api/info/fundings.js';
+import { NextNonceRequest, NextNonceResponse } from '../api/info/next-nonce.js';
+import { OrderBookDetailsRequest, OrderBookDetailsResponse, OrderBookOrdersRequest, OrderBookOrdersResponse } from '../api/info/order-book-details.js';
+import { OrderBooksResponse } from '../api/info/order-books.js';
+import { RecentTradesRequest, RecentTradesResponse } from '../api/info/recent-trades.js';
+import { RootStatusResponse } from '../api/info/root-status.js';
+import { TransactionRequest, Transaction } from '../api/info/tx.js';
+import { TransactionFromL1TxHashRequest } from '../api/info/tx-from-l1-hash.js';
+import { TransactionsRequest, TransactionsResponse } from '../api/info/txs.js';
+import { WithdrawalDelayResponse } from '../api/info/withdrawal-delay.js';
+import 'axios';
+import '../api/info-private/trades.js';
+
+interface InfoClientConfig {
+    baseURL?: string;
+}
+/**
+ * InfoClient - Client for public info endpoints
+ *
+ * Provides access to all public API endpoints that don't require authentication.
+ *
+ * @example
+ * ```typescript
+ * const client = new InfoClient({
+ *   baseURL: "https://mainnet.zklighter.elliot.ai"
+ * });
+ *
+ * const account = await client.getAccountInfo({ by: "index", value: "0" });
+ * const orderBooks = await client.getOrderBooks();
+ * ```
+ */
+declare class InfoClient {
+    private readonly config;
+    private readonly axiosInstance;
+    constructor(config?: InfoClientConfig);
+    private createAxiosInstance;
+    /**
+     * Get account information by index or L2 address
+     * @param params - Account lookup parameters (by index or L2 address)
+     * @returns Account information including balances and positions
+     * @example
+     * ```typescript
+     * const account = await client.getAccountInfo({ by: "index", value: "0" });
+     * ```
+     */
+    getAccountInfo(params: AccountRequest): Promise<AccountResponse>;
+    /**
+     * Get account information by L1 address
+     * @param params - L1 address lookup parameters
+     * @returns Account information associated with the L1 address
+     * @example
+     * ```typescript
+     * const account = await client.getAccountByL1Address({ l1_address: "0x..." });
+     * ```
+     */
+    getAccountByL1Address(params: AccountByL1AddressRequest): Promise<AccountAccountByL1AddressResponse>;
+    /**
+     * Get API keys for an account
+     * @param params - Account index to retrieve API keys for
+     * @returns List of API keys associated with the account
+     * @example
+     * ```typeScript
+     * const keys = await client.getApiKeys({ account_index: 0 });
+     * ```
+     */
+    getApiKeys(params: ApiKeysRequest): Promise<ApiKeysResponse>;
+    /**
+     * Get system announcements
+     * @returns List of active announcements
+     * @example
+     * ```typescript
+     * const announcements = await client.getAnnouncements();
+     * ```
+     */
+    getAnnouncements(): Promise<AnnouncementsResponse>;
+    /**
+     * Get asset details for a specific asset or all assets
+     * @param params - Optional asset_index to get details for a specific asset
+     * @returns Asset details including symbol, decimals, limits, and pricing information
+     * @example
+     * ```typescript
+     * // Get all assets
+     * const allAssets = await client.getAssetDetails();
+     *
+     * // Get specific asset
+     * const asset = await client.getAssetDetails({ asset_index: 0 });
+     * ```
+     */
+    getAssetDetails(params?: AssetDetailsRequest): Promise<AssetDetailsResponse>;
+    /**
+     * Get candlestick data for a market
+     * @param params - Candlestick query parameters including market_id, resolution, and time range
+     * @returns Array of candlestick data
+     * @example
+     * ```typescript
+     * const candles = await client.getCandlesticks({
+     *   market_id: 1,
+     *   resolution: "1h",
+     *   start_timestamp: 1234567890,
+     *   end_timestamp: 1234567900
+     * });
+     * ```
+     */
+    getCandlesticks(params: CandlesRequest): Promise<CandlesResponse>;
+    /**
+     * Get funding history for a market
+     * @param params - Funding query parameters including market_id and time range
+     * @returns Array of funding data
+     * @example
+     * ```typescript
+     * const fundings = await client.getFundings({
+     *   market_id: 1,
+     *   start_timestamp: 1234567890,
+     *   end_timestamp: 1234567900
+     * });
+     * ```
+     */
+    getFundings(params: FundingsRequest): Promise<FundingsResponse>;
+    /**
+     * Get exchange statistics
+     * @returns Exchange-wide statistics including volume, fees, and markets
+     * @example
+     * ```typescript
+     * const stats = await client.getExchangeStats();
+     * ```
+     */
+    getExchangeStats(): Promise<ExchangeStatsResponse>;
+    /**
+     * Get fast bridge information
+     * @returns Fast bridge configuration and status
+     * @example
+     * ```typescript
+     * const bridgeInfo = await client.getFastBridgeInfo();
+     * ```
+     */
+    getFastBridgeInfo(): Promise<FastBridgeInfoResponse>;
+    /**
+     * Get current funding rates for all markets
+     * @returns Funding rates for all markets
+     * @example
+     * ```typescript
+     * const rates = await client.getFundingRates();
+     * ```
+     */
+    getFundingRates(): Promise<FundingRatesResponse>;
+    /**
+     * Get the next nonce for an account
+     * @param params - Account index to get nonce for
+     * @returns Next nonce value
+     * @example
+     * ```typescript
+     * const nonce = await client.getNextNonce({ account_index: 0 });
+     * ```
+     */
+    getNextNonce(params: NextNonceRequest): Promise<NextNonceResponse>;
+    /**
+     * Get all order books
+     * @returns List of all order books with their configurations
+     * @example
+     * ```typescript
+     * const orderBooks = await client.getOrderBooks();
+     * ```
+     */
+    getOrderBooks(): Promise<OrderBooksResponse>;
+    /**
+     * Get detailed information about a specific order book
+     * @param params - Optional market_id to get details for a specific market
+     * @returns Order book details including market information
+     * @example
+     * ```typescript
+     * const details = await client.getOrderBookDetails({ market_id: 1 });
+     * ```
+     */
+    getOrderBookDetails(params?: OrderBookDetailsRequest): Promise<OrderBookDetailsResponse>;
+    /**
+     * Get orders in an order book
+     * @param params - Market ID and optional depth/limit parameters
+     * @returns Bids and asks in the order book
+     * @example
+     * ```typescript
+     * const orders = await client.getOrderBookOrders({ market_id: 1, limit: 50 });
+     * ```
+     */
+    getOrderBookOrders(params: OrderBookOrdersRequest): Promise<OrderBookOrdersResponse>;
+    /**
+     * Get recent trades for a market
+     * @param params - Market ID and optional limit
+     * @returns Recent trades for the market
+     * @example
+     * ```typescript
+     * const trades = await client.getRecentTrades({ market_id: 1, limit: 50 });
+     * ```
+     */
+    getRecentTrades(params: RecentTradesRequest): Promise<RecentTradesResponse>;
+    /**
+     * Get a specific transaction by hash
+     * @param params - Transaction hash to look up
+     * @returns Transaction details
+     * @example
+     * ```typescript
+     * const tx = await client.getTransaction({ tx_hash: "0x..." });
+     * ```
+     */
+    getTransaction(params: TransactionRequest): Promise<Transaction>;
+    /**
+     * Get transactions with optional filtering
+     * @param params - Optional filter parameters for transaction queries
+     * @returns List of transactions
+     * @example
+     * ```typescript
+     * const txs = await client.getTransactions({ limit: 50 });
+     * ```
+     */
+    getTransactions(params?: TransactionsRequest): Promise<TransactionsResponse>;
+    /**
+     * Get L2 transaction from L1 transaction hash
+     * @param params - L1 transaction hash
+     * @returns Corresponding L2 transaction
+     * @example
+     * ```typescript
+     * const tx = await client.getTransactionFromL1TxHash({ l1_tx_hash: "0x..." });
+     * ```
+     */
+    getTransactionFromL1TxHash(params: TransactionFromL1TxHashRequest): Promise<Transaction>;
+    /**
+     * Get withdrawal delay in seconds
+     * @returns Withdrawal delay configuration
+     * @example
+     * ```typescript
+     * const delay = await client.getWithdrawalDelay();
+     * console.log(`Withdrawal delay: ${delay.seconds} seconds`);
+     * ```
+     */
+    getWithdrawalDelay(): Promise<WithdrawalDelayResponse>;
+    /**
+     * Get root status information
+     * @returns Root status including network status, network_id, and timestamp
+     * @example
+     * ```typescript
+     * const status = await client.getRootStatus();
+     * ```
+     */
+    getRootStatus(): Promise<RootStatusResponse>;
+}
+
+export { InfoClient, type InfoClientConfig };

package/dist/client/info-client.js

@@ -0,0 +1,27 @@
+import {
+  InfoClient
+} from "../chunk-VT3N7TOX.js";
+import "../chunk-MO4PMYTS.js";
+import "../chunk-K7ZQARON.js";
+import "../chunk-ZWYNOAL3.js";
+import "../chunk-3OSXAPI3.js";
+import "../chunk-BXMXWCMD.js";
+import "../chunk-IXF4QUC6.js";
+import "../chunk-NOFXPTLU.js";
+import "../chunk-PPU2VWXX.js";
+import "../chunk-TELGVFFP.js";
+import "../chunk-GYABNQWH.js";
+import "../chunk-A2APDMN3.js";
+import "../chunk-JTE4UBAX.js";
+import "../chunk-BKJGDTS3.js";
+import "../chunk-BES73YEF.js";
+import "../chunk-FODEDUT4.js";
+import "../chunk-MZCKU6FF.js";
+import "../chunk-77QSYYAW.js";
+import "../chunk-4VAZ7ZA2.js";
+import "../chunk-472ULOSN.js";
+import "../chunk-YWN57BJF.js";
+import "../chunk-S4OE3IME.js";
+export {
+  InfoClient
+};

package/dist/client/info-private-client.cjs

@@ -0,0 +1,25 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkUICTRTWBcjs = require('../chunk-UICTRTWB.cjs');
+require('../chunk-GI4WUHSL.cjs');
+require('../chunk-4TIJW7PH.cjs');
+require('../chunk-J3UZK77O.cjs');
+require('../chunk-DW6W5SX2.cjs');
+require('../chunk-J7GXRK7R.cjs');
+require('../chunk-DOZF64YC.cjs');
+require('../chunk-ON64OVOQ.cjs');
+require('../chunk-TWGXKYO2.cjs');
+require('../chunk-LBVNEQ5R.cjs');
+require('../chunk-X7E6XJVQ.cjs');
+require('../chunk-6LUEPRL7.cjs');
+require('../chunk-U2SM46CP.cjs');
+require('../chunk-XOG6T533.cjs');
+require('../chunk-BKIL4UXV.cjs');
+require('../chunk-U25GSCR7.cjs');
+require('../chunk-ZJVQD6JD.cjs');
+require('../chunk-YVJVFJ24.cjs');
+require('../chunk-IT6LK2G5.cjs');
+require('../chunk-FM4WWIRI.cjs');
+
+
+exports.InfoPrivateClient = _chunkUICTRTWBcjs.InfoPrivateClient;