lighter-sdk-client 0.2.22

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

@@ -0,0 +1,409 @@
+import { ChangeAccountTierRequest, ChangeAccountTierResponse } from '../api/exchange/change-account-tier.cjs';
+import { FastWithdrawRequest, FastWithdrawResponse } from '../api/exchange/fastwithdraw.cjs';
+import { NotificationAckRequest, NotificationAckResponse } from '../api/exchange/notification-ack.cjs';
+import { SendTransactionRequest, TxHashResponse, SendTxFormRequest, SendTxWithIndicesRequest } from '../api/exchange/send-tx.cjs';
+import { SendTransactionBatchRequest, TxHashesResponse } from '../api/exchange/send-tx-batch.cjs';
+import { TokensCreateRequest, TokensCreateResponse } from '../api/exchange/tokens-create.cjs';
+import { TokensRevokeRequest, TokensRevokeResponse } from '../api/exchange/tokens-revoke.cjs';
+import { WasmSigner } from '../signing/wasm-signer.cjs';
+import 'axios';
+
+interface ExchangeClientConfig {
+    baseURL?: string;
+    wasmSigner: WasmSigner;
+}
+/**
+ * ExchangeClient - Client for exchange/transaction endpoints
+ *
+ * Provides access to transaction sending and notification endpoints.
+ *
+ * @example
+ * ```typescript
+ * const client = new ExchangeClient({
+ *   baseURL: "https://mainnet.zklighter.elliot.ai"
+ * });
+ *
+ * const result = await client.sendTransaction({
+ *   account_index: 0,
+ *   api_key_index: 0,
+ *   transaction: "0x..."
+ * });
+ * ```
+ */
+declare class ExchangeClient {
+    private readonly baseURL;
+    private readonly axiosInstance;
+    private readonly wasmSigning?;
+    constructor(config: ExchangeClientConfig);
+    private createAxiosInstance;
+    /**
+     * Send a transaction
+     * @param params - Transaction parameters
+     * @returns Promise<TxHashResponse>
+     */
+    sendTransaction(params: SendTransactionRequest): Promise<TxHashResponse>;
+    /**
+     * Send a transaction with form data
+     * @param params - Transaction form parameters
+     * @returns Promise<TxHashResponse>
+     */
+    sendTx(params: SendTxFormRequest): Promise<TxHashResponse>;
+    /**
+     * Send a transaction with account and API key indices
+     * @param params - Transaction parameters with indices
+     * @returns Promise<TxHashResponse>
+     */
+    sendTxWithIndices(params: SendTxWithIndicesRequest): Promise<TxHashResponse>;
+    /**
+     * Send a transaction with JSON payload
+     * @param params - Transaction parameters
+     * @returns Promise<TxHashResponse>
+     */
+    sendTxJson(params: SendTxWithIndicesRequest): Promise<TxHashResponse>;
+    /**
+     * Send a batch of transactions
+     * @param params - Batch transaction parameters
+     * @returns Promise<TxHashesResponse>
+     */
+    sendTransactionBatch(params: SendTransactionBatchRequest): Promise<TxHashesResponse>;
+    /**
+     * Create and send an order using WASM signing
+     * @param params - Order parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    createOrder(params: {
+        marketIndex: number;
+        clientOrderIndex: number;
+        baseAmount: number;
+        price: number;
+        isAsk: number;
+        orderType: number;
+        timeInForce: number;
+        reduceOnly: number;
+        triggerPrice: number;
+        orderExpiry: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Cancel an order using WASM signing
+     * @param params - Cancel order parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    cancelOrder(params: {
+        marketIndex: number;
+        orderIndex: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Cancel all orders using WASM signing
+     * @param params - Cancel all orders parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    cancelAllOrders(params: {
+        timeInForce: number;
+        time: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Transfer funds using WASM signing
+     * @param params - Transfer parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    transfer(params: {
+        toAccountIndex: number;
+        assetIndex: number;
+        fromRouterType: number;
+        toRouterType: number;
+        amount: number;
+        usdcFee: number;
+        memo: string;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Withdraw funds using WASM signing
+     * @param params - Withdraw parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    withdraw(params: {
+        usdcAmount: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Update leverage using WASM signing
+     * @param params - Update leverage parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    updateLeverage(params: {
+        marketIndex: number;
+        fraction: number;
+        marginMode: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Modify an order using WASM signing
+     * @param params - Modify order parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    modifyOrder(params: {
+        marketIndex: number;
+        index: number;
+        baseAmount: number;
+        price: number;
+        triggerPrice: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Create a subaccount using WASM signing
+     * @param params - Create subaccount parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    createSubAccount(params: {
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Create a public pool using WASM signing
+     * @param params - Create public pool parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    createPublicPool(params: {
+        operatorFee: number;
+        initialTotalShares: number;
+        minOperatorShareRate: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Update a public pool using WASM signing
+     * @param params - Update public pool parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    updatePublicPool(params: {
+        publicPoolIndex: number;
+        status: number;
+        operatorFee: number;
+        minOperatorShareRate: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Mint shares using WASM signing
+     * @param params - Mint shares parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    mintShares(params: {
+        publicPoolIndex: number;
+        shareAmount: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Burn shares using WASM signing
+     * @param params - Burn shares parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    burnShares(params: {
+        publicPoolIndex: number;
+        shareAmount: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Update margin using WASM signing
+     * @param params - Update margin parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    updateMargin(params: {
+        marketIndex: number;
+        usdcAmount: number;
+        direction: number;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Create grouped orders using WASM signing
+     * @param params - Create grouped orders parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    createGroupedOrders(params: {
+        groupingType: number;
+        orders: Array<{
+            MarketIndex: number;
+            ClientOrderIndex: number;
+            BaseAmount: number;
+            Price: number;
+            IsAsk: number;
+            Type: number;
+            TimeInForce: number;
+            ReduceOnly: number;
+            TriggerPrice: number;
+            OrderExpiry: number;
+        }>;
+        nonce: number;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Create multiple orders in a batch using WASM signing
+     * @param params - Batch orders parameters
+     * @returns Promise<TxHashesResponse>
+     * @throws Error if WasmSigning is not configured
+     * @example
+     * ```typescript
+     * const result = await client.createBatchOrders({
+     *   orders: [
+     *     {
+     *       marketIndex: 0,
+     *       clientOrderIndex: 1,
+     *       baseAmount: 1000000,
+     *       price: 50000,
+     *       isAsk: 0,
+     *       orderType: 0,
+     *       timeInForce: 1,
+     *       reduceOnly: 0,
+     *       triggerPrice: 0,
+     *       orderExpiry: 0,
+     *       nonce: 1
+     *     },
+     *     {
+     *       marketIndex: 1,
+     *       clientOrderIndex: 2,
+     *       baseAmount: 2000000,
+     *       price: 3000,
+     *       isAsk: 1,
+     *       orderType: 0,
+     *       timeInForce: 1,
+     *       reduceOnly: 0,
+     *       triggerPrice: 0,
+     *       orderExpiry: 0,
+     *       nonce: 2
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    createBatchOrders(params: {
+        orders: Array<{
+            marketIndex: number;
+            clientOrderIndex: number;
+            baseAmount: number;
+            price: number;
+            isAsk: number;
+            orderType: number;
+            timeInForce: number;
+            reduceOnly: number;
+            triggerPrice: number;
+            orderExpiry: number;
+            nonce: number;
+        }>;
+    }): Promise<TxHashesResponse>;
+    /**
+     * Generate change public key L1 sign message
+     * @param pubKeyHex - New public key in hex format
+     * @param nonce - Account nonce
+     * @param accountIndex - Account index
+     * @param newApiKeyIndex - New API key index
+     * @returns Promise<string> - Sign message
+     */
+    generateChangePubKeyL1SignMessage(pubKeyHex: string, nonce: number, accountIndex: number, newApiKeyIndex: number): Promise<string>;
+    /**
+     * Change public key using WASM signing
+     * @param params - Change public key parameters
+     * @returns Promise<TxHashResponse>
+     * @throws Error if WasmSigning is not configured
+     */
+    changePubKey(params: {
+        pubKeyHex: string;
+        nonce: number;
+        l1Sig: string;
+        priceProtection?: boolean;
+    }): Promise<TxHashResponse>;
+    /**
+     * Acknowledge a notification
+     * @param params - Notification acknowledgment parameters
+     * @param authorization - Optional authorization token
+     * @returns Promise<NotificationAckResponse>
+     */
+    acknowledgeNotification(params: NotificationAckRequest, authorization?: string): Promise<NotificationAckResponse>;
+    /**
+     * Change account tier
+     * @param params - Account tier change parameters including account_index and new_tier
+     * @param authorization - Optional authorization token
+     * @returns Promise<ChangeAccountTierResponse>
+     * @example
+     * ```typescript
+     * const result = await client.changeAccountTier({
+     *   account_index: 0,
+     *   new_tier: "premium"
+     * });
+     * ```
+     */
+    changeAccountTier(params: ChangeAccountTierRequest, authorization?: string): Promise<ChangeAccountTierResponse>;
+    /**
+     * Fast withdraw funds
+     * @param params - Fast withdraw parameters including tx_info and to_address
+     * @param authorization - Optional authorization token
+     * @returns Promise<FastWithdrawResponse>
+     * @example
+     * ```typescript
+     * const result = await client.fastWithdraw({
+     *   tx_info: "0x...",
+     *   to_address: "0x..."
+     * });
+     * ```
+     */
+    fastWithdraw(params: FastWithdrawRequest, authorization?: string): Promise<FastWithdrawResponse>;
+    /**
+     * Create API token
+     * @param params - Token creation parameters including name, account_index, expiry, and permissions
+     * @param authorization - Optional authorization token
+     * @returns Promise<TokensCreateResponse>
+     * @example
+     * ```typescript
+     * const token = await client.createToken({
+     *   name: "My API Token",
+     *   account_index: 0,
+     *   expiry: Math.floor(Date.now() / 1000) + 86400 * 30, // 30 days
+     *   sub_account_access: true,
+     *   scopes: "read.*"
+     * });
+     * ```
+     */
+    createToken(params: TokensCreateRequest, authorization?: string): Promise<TokensCreateResponse>;
+    /**
+     * Revoke API token
+     * @param params - Token revocation parameters including token_id and account_index
+     * @param authorization - Optional authorization token
+     * @returns Promise<TokensRevokeResponse>
+     * @example
+     * ```typescript
+     * const result = await client.revokeToken({
+     *   token_id: 123,
+     *   account_index: 0
+     * });
+     * ```
+     */
+    revokeToken(params: TokensRevokeRequest, authorization?: string): Promise<TokensRevokeResponse>;
+}
+
+export { ExchangeClient, type ExchangeClientConfig };