lighter-ts-sdk 1.0.0

package/dist/utils/wasm-signer.js

@@ -0,0 +1,178 @@
+"use strict";
+/**
+ * WASM Signer Client for Lighter Protocol
+ *
+ * This module provides a TypeScript wrapper for the Go WASM signer,
+ * enabling cryptographic operations in the browser and Node.js environments.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWasmSignerClient = exports.WasmSignerClient = void 0;
+class WasmSignerClient {
+    constructor(config) {
+        this.wasmModule = null;
+        this.isInitialized = false;
+        this.config = config;
+    }
+    /**
+     * Initialize the WASM module
+     */
+    async initialize() {
+        if (this.isInitialized) {
+            return;
+        }
+        try {
+            // Load the Go WASM runtime
+            const wasmExecPath = this.config.wasmExecPath || this.config.wasmPath.replace('.wasm', '_exec.js');
+            await this.loadScript(wasmExecPath);
+            // Load the WASM binary
+            const wasmBytes = await this.loadWasmBinary(this.config.wasmPath);
+            // Initialize the Go runtime
+            const go = new window.Go();
+            const result = await WebAssembly.instantiate(wasmBytes, go.importObject);
+            go.run(result.instance);
+            this.wasmModule = {
+                generateAPIKey: window.generateAPIKey,
+                createClient: window.createClient,
+                signCreateOrder: window.signCreateOrder,
+                signCancelOrder: window.signCancelOrder,
+                signCancelAllOrders: window.signCancelAllOrders,
+                signTransfer: window.signTransfer,
+                signUpdateLeverage: window.signUpdateLeverage,
+                createAuthToken: window.createAuthToken,
+            };
+            this.isInitialized = true;
+        }
+        catch (error) {
+            throw new Error(`Failed to initialize WASM signer: ${error}`);
+        }
+    }
+    /**
+     * Generate a new API key pair
+     */
+    async generateAPIKey(seed) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.generateAPIKey(seed);
+        if (result.error) {
+            throw new Error(`Failed to generate API key: ${result.error}`);
+        }
+        return {
+            privateKey: result.privateKey,
+            publicKey: result.publicKey,
+        };
+    }
+    /**
+     * Create a client for signing transactions
+     */
+    async createClient(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.createClient(params.url, params.privateKey, params.chainId, params.apiKeyIndex, params.accountIndex);
+        if (result.error) {
+            throw new Error(`Failed to create client: ${result.error}`);
+        }
+    }
+    /**
+     * Sign a create order transaction
+     */
+    async signCreateOrder(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.signCreateOrder(params.marketIndex, params.clientOrderIndex, params.baseAmount, params.price, params.isAsk, params.orderType, params.timeInForce, params.reduceOnly, params.triggerPrice, params.orderExpiry, params.nonce);
+        if (result.error) {
+            throw new Error(`Failed to sign create order: ${result.error}`);
+        }
+        return result.txInfo;
+    }
+    /**
+     * Sign a cancel order transaction
+     */
+    async signCancelOrder(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.signCancelOrder(params.marketIndex, params.orderIndex, params.nonce);
+        if (result.error) {
+            throw new Error(`Failed to sign cancel order: ${result.error}`);
+        }
+        return result.txInfo;
+    }
+    /**
+     * Sign a cancel all orders transaction
+     */
+    async signCancelAllOrders(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.signCancelAllOrders(params.timeInForce, params.time, params.nonce);
+        if (result.error) {
+            return { txInfo: '', error: result.error };
+        }
+        return { txInfo: result.txInfo };
+    }
+    /**
+     * Sign a transfer transaction
+     */
+    async signTransfer(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.signTransfer(params.toAccountIndex, params.usdcAmount, params.fee, params.memo, params.nonce);
+        if (result.error) {
+            return { txInfo: '', error: result.error };
+        }
+        return { txInfo: result.txInfo };
+    }
+    /**
+     * Sign an update leverage transaction
+     */
+    async signUpdateLeverage(params) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.signUpdateLeverage(params.marketIndex, params.fraction, params.marginMode, params.nonce);
+        if (result.error) {
+            return { txInfo: '', error: result.error };
+        }
+        return { txInfo: result.txInfo };
+    }
+    /**
+     * Create an authentication token
+     */
+    async createAuthToken(deadline) {
+        await this.ensureInitialized();
+        const result = this.wasmModule.createAuthToken(deadline);
+        if (result.error) {
+            throw new Error(`Failed to create auth token: ${result.error}`);
+        }
+        return result.authToken;
+    }
+    /**
+     * Ensure the WASM module is initialized
+     */
+    async ensureInitialized() {
+        if (!this.isInitialized) {
+            await this.initialize();
+        }
+    }
+    /**
+     * Load a script dynamically
+     */
+    loadScript(src) {
+        return new Promise((resolve, reject) => {
+            const script = document.createElement('script');
+            script.src = src;
+            script.onload = () => resolve();
+            script.onerror = () => reject(new Error(`Failed to load script: ${src}`));
+            document.head.appendChild(script);
+        });
+    }
+    /**
+     * Load WASM binary
+     */
+    async loadWasmBinary(path) {
+        const response = await fetch(path);
+        if (!response.ok) {
+            throw new Error(`Failed to load WASM binary: ${response.statusText}`);
+        }
+        return response.arrayBuffer();
+    }
+}
+exports.WasmSignerClient = WasmSignerClient;
+/**
+ * Create a WASM signer client instance
+ */
+function createWasmSignerClient(config) {
+    return new WasmSignerClient(config);
+}
+exports.createWasmSignerClient = createWasmSignerClient;
+//# sourceMappingURL=wasm-signer.js.map

package/dist/utils/wasm-signer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm-signer.js","sourceRoot":"","sources":["../../src/utils/wasm-signer.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAmEH,MAAa,gBAAgB;IAK3B,YAAY,MAAwB;QAJ5B,eAAU,GAAQ,IAAI,CAAC;QACvB,kBAAa,GAAG,KAAK,CAAC;QAI5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,2BAA2B;YAC3B,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACnG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAEpC,uBAAuB;YACvB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAElE,4BAA4B;YAC5B,MAAM,EAAE,GAAG,IAAK,MAAc,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC;YACzE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAExB,IAAI,CAAC,UAAU,GAAG;gBAChB,cAAc,EAAG,MAAc,CAAC,cAAc;gBAC9C,YAAY,EAAG,MAAc,CAAC,YAAY;gBAC1C,eAAe,EAAG,MAAc,CAAC,eAAe;gBAChD,eAAe,EAAG,MAAc,CAAC,eAAe;gBAChD,mBAAmB,EAAG,MAAc,CAAC,mBAAmB;gBACxD,YAAY,EAAG,MAAc,CAAC,YAAY;gBAC1C,kBAAkB,EAAG,MAAc,CAAC,kBAAkB;gBACtD,eAAe,EAAG,MAAc,CAAC,eAAe;aACjD,CAAC;YAEF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,qCAAqC,KAAK,EAAE,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,IAAa;QAChC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjE,CAAC;QAED,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CACzC,MAAM,CAAC,GAAG,EACV,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,YAAY,CACpB,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,MAAyB;QAC7C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAC5C,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,gBAAgB,EACvB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,MAAyB;QAC7C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAC5C,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CAAC,MAA6B;QACrD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAChD,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC7C,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,MAAsB;QACvC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CACzC,MAAM,CAAC,cAAc,EACrB,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,GAAG,EACV,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC7C,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CAAC,MAA4B;QACnD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAC/C,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC7C,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,QAAiB;QACrC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAEzD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,iBAAiB;QAC7B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,UAAU,CAAC,GAAW;QAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC;YACjB,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC,CAAC;YAC1E,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,cAAc,CAAC,IAAY;QACvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;CACF;AA5OD,4CA4OC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IAC7D,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC;AAFD,wDAEC"}

package/docs/API.md

@@ -0,0 +1,195 @@
+# API Reference
+
+This section contains detailed documentation for all API classes, methods, and types in the Lighter TypeScript SDK.
+
+## Core Classes
+
+### [SignerClient](SignerClient.md)
+The main class for trading operations, order management, and account operations.
+
+**Key Methods:**
+- `createOrder()` - Create limit orders
+- `createMarketOrder()` - Create market orders
+- `cancelOrder()` - Cancel existing orders
+- `cancelAllOrders()` - Cancel all orders
+- `transfer()` - Transfer USDC between accounts
+- `updateLeverage()` - Update leverage settings
+- `generateAPIKey()` - Generate new API keys
+
+### [ApiClient](ApiClient.md)
+Base HTTP client for API communication.
+
+### [WsClient](WsClient.md)
+WebSocket client for real-time data streaming.
+
+## API Classes
+
+### [AccountApi](AccountApi.md)
+Account information and management.
+
+**Methods:**
+- `getAccount()` - Get account information
+- `getAccountsByL1Address()` - Get accounts by L1 address
+- `getApiKeys()` - Get API keys
+- `getPnL()` - Get profit/loss information
+- `getPublicPools()` - Get public pool information
+
+### [OrderApi](OrderApi.md)
+Order book and trading data.
+
+**Methods:**
+- `getExchangeStats()` - Get exchange statistics
+- `getOrderBookDetails()` - Get order book details
+- `getOrderBooks()` - Get all order books
+- `getRecentTrades()` - Get recent trades
+
+### [TransactionApi](TransactionApi.md)
+Transaction management and history.
+
+**Methods:**
+- `getTransaction()` - Get specific transaction
+- `getTransactions()` - Get transaction list
+- `getBlockTransactions()` - Get block transactions
+- `getAccountTransactions()` - Get account transactions
+- `getNextNonce()` - Get next nonce
+- `sendTx()` - Send transaction
+- `sendTxBatch()` - Send batch transactions
+
+### [BlockApi](BlockApi.md)
+Block information and data.
+
+**Methods:**
+- `getBlock()` - Get block information
+- `getBlocks()` - Get block list
+- `getCurrentHeight()` - Get current block height
+
+### [RootApi](RootApi.md)
+System information and status.
+
+**Methods:**
+- `getInfo()` - Get system information
+- `getStatus()` - Get system status
+
+## Type Definitions
+
+### Core Types
+
+#### [SignerConfig](types/SignerConfig.md)
+Configuration for SignerClient initialization.
+
+#### [WasmSignerConfig](types/WasmSignerConfig.md)
+Configuration for WASM signer setup.
+
+#### [ApiKeyPair](types/ApiKeyPair.md)
+Generated API key pair structure.
+
+### Order Types
+
+#### [CreateOrderParams](types/CreateOrderParams.md)
+Parameters for creating limit orders.
+
+#### [MarketOrderParams](types/MarketOrderParams.md)
+Parameters for creating market orders.
+
+#### [CancelOrderParams](types/CancelOrderParams.md)
+Parameters for canceling orders.
+
+#### [CancelAllOrdersParams](types/CancelAllOrdersParams.md)
+Parameters for canceling all orders.
+
+### Transaction Types
+
+#### [TransferParams](types/TransferParams.md)
+Parameters for USDC transfers.
+
+#### [UpdateLeverageParams](types/UpdateLeverageParams.md)
+Parameters for updating leverage.
+
+### Data Types
+
+#### [Account](types/Account.md)
+Account information structure.
+
+#### [Order](types/Order.md)
+Order information structure.
+
+#### [Transaction](types/Transaction.md)
+Transaction information structure.
+
+#### [OrderBook](types/OrderBook.md)
+Order book data structure.
+
+#### [Trade](types/Trade.md)
+Trade information structure.
+
+## Constants
+
+### Order Types
+- `ORDER_TYPE_LIMIT = 0` - Limit order
+- `ORDER_TYPE_MARKET = 1` - Market order
+
+### Time in Force
+- `ORDER_TIME_IN_FORCE_IMMEDIATE_OR_CANCEL = 0` - IOC
+- `ORDER_TIME_IN_FORCE_GOOD_TILL_TIME = 1` - GTT
+- `ORDER_TIME_IN_FORCE_FILL_OR_KILL = 2` - FOK
+
+### Margin Modes
+- `CROSS_MARGIN_MODE = 0` - Cross margin
+- `ISOLATED_MARGIN_MODE = 1` - Isolated margin
+
+### Transaction Types
+- `TX_TYPE_CREATE_ORDER = 1` - Create order
+- `TX_TYPE_CANCEL_ORDER = 2` - Cancel order
+- `TX_TYPE_CANCEL_ALL_ORDERS = 3` - Cancel all orders
+- `TX_TYPE_TRANSFER = 4` - Transfer
+- `TX_TYPE_UPDATE_LEVERAGE = 20` - Update leverage
+
+## Error Handling
+
+All SDK methods use consistent error handling patterns:
+
+### SignerClient Methods
+Return tuples with error information:
+```typescript
+const [result, txHash, error] = await client.createOrder(params);
+if (error) {
+  console.error('Operation failed:', error);
+  return;
+}
+```
+
+### API Methods
+Throw exceptions for errors:
+```typescript
+try {
+  const account = await accountApi.getAccount(params);
+  console.log('Account:', account);
+} catch (error) {
+  console.error('API call failed:', error.message);
+}
+```
+
+### WebSocket Methods
+Use event handlers for errors:
+```typescript
+wsClient.on('error', (error) => {
+  console.error('WebSocket error:', error);
+});
+```
+
+## Examples
+
+See the [examples directory](../examples/) for comprehensive usage examples:
+
+- [Basic Trading](examples/create_market_order.ts)
+- [Order Management](examples/create_cancel_order.ts)
+- [Account Setup](examples/system_setup.ts)
+- [Real-time Data](examples/ws.ts)
+- [Advanced Operations](examples/transfer_update_leverage.ts)
+
+## Getting Help
+
+- [Getting Started Guide](GettingStarted.md)
+- [Examples](../examples/)
+- [Discord Community](https://discord.gg/lighter)
+- [Documentation Site](https://docs.lighter.xyz)

package/docs/AccountApi.md

@@ -0,0 +1,220 @@
+# AccountApi
+
+The `AccountApi` class provides methods for retrieving account information, API keys, PnL data, and public pools.
+
+## Constructor
+
+```typescript
+new AccountApi(client: ApiClient)
+```
+
+## Methods
+
+### getAccount(params: AccountParams)
+
+Gets account information by index or L1 address.
+
+**Parameters:**
+- `by: 'index' | 'l1_address'` - Search by account index or L1 address
+- `value: string` - The account index or L1 address value
+
+**Returns:** `Promise<Account>` - Account information
+
+**Example:**
+```typescript
+const accountApi = new AccountApi(client);
+
+// Get account by index
+const account = await accountApi.getAccount({ by: 'index', value: '123' });
+
+// Get account by L1 address
+const account = await accountApi.getAccount({ 
+  by: 'l1_address', 
+  value: '0x1234567890123456789012345678901234567890' 
+});
+```
+
+### getAccountsByL1Address(l1Address: string)
+
+Gets all accounts associated with an L1 address.
+
+**Parameters:**
+- `l1Address: string` - Ethereum address
+
+**Returns:** `Promise<Account[]>` - Array of accounts
+
+**Example:**
+```typescript
+const accounts = await accountApi.getAccountsByL1Address(
+  '0x1234567890123456789012345678901234567890'
+);
+console.log(`Found ${accounts.length} accounts`);
+```
+
+### getApiKeys(accountIndex: number, limit?: number)
+
+Gets API keys for an account.
+
+**Parameters:**
+- `accountIndex: number` - Account index
+- `limit?: number` - Maximum number of API keys to return (default: 10)
+
+**Returns:** `Promise<AccountApiKeys>` - API keys information
+
+**Example:**
+```typescript
+const apiKeys = await accountApi.getApiKeys(123, 5);
+console.log('API keys:', apiKeys.api_keys);
+```
+
+### getPnL(params: PnLParams)
+
+Gets PnL (Profit and Loss) information for an account.
+
+**Parameters:**
+- `accountIndex: number` - Account index
+- `marketIndex?: number` - Optional market index filter
+- `limit?: number` - Maximum number of entries to return
+
+**Returns:** `Promise<AccountPnL>` - PnL information
+
+**Example:**
+```typescript
+const pnl = await accountApi.getPnL({
+  accountIndex: 123,
+  marketIndex: 0, // ETH/USDC
+  limit: 100
+});
+console.log('PnL entries:', pnl.entries);
+```
+
+### getPublicPools(filter?: string, limit?: number, index?: number)
+
+Gets public pool information.
+
+**Parameters:**
+- `filter?: string` - Filter type ('all', 'active', etc.)
+- `limit?: number` - Maximum number of pools to return
+- `index?: number` - Starting index for pagination
+
+**Returns:** `Promise<PublicPool[]>` - Array of public pools
+
+**Example:**
+```typescript
+const pools = await accountApi.getPublicPools('all', 10, 0);
+console.log(`Found ${pools.length} public pools`);
+```
+
+## Types
+
+### AccountParams
+
+```typescript
+interface AccountParams {
+  by: 'index' | 'l1_address';
+  value: string;
+}
+```
+
+### PnLParams
+
+```typescript
+interface PnLParams {
+  accountIndex: number;
+  marketIndex?: number;
+  limit?: number;
+}
+```
+
+### Account
+
+```typescript
+interface Account {
+  index: string;
+  l1_address: string;
+  l2_address: string;
+  // ... other account properties
+}
+```
+
+### AccountApiKeys
+
+```typescript
+interface AccountApiKeys {
+  api_keys: ApiKey[];
+}
+```
+
+### AccountPnL
+
+```typescript
+interface AccountPnL {
+  entries: PnLEntry[];
+  // ... other PnL properties
+}
+```
+
+### PublicPool
+
+```typescript
+interface PublicPool {
+  pool_id: string;
+  name: string;
+  // ... other pool properties
+}
+```
+
+## Error Handling
+
+All methods throw errors for invalid parameters or network issues:
+
+```typescript
+try {
+  const account = await accountApi.getAccount({ by: 'index', value: '123' });
+  console.log('Account:', account);
+} catch (error) {
+  console.error('Failed to get account:', error.message);
+}
+```
+
+## Complete Example
+
+```typescript
+import { ApiClient, AccountApi } from '@lighter/typescript-sdk';
+
+async function main() {
+  const client = new ApiClient({ host: 'https://mainnet.zklighter.elliot.ai' });
+  const accountApi = new AccountApi(client);
+
+  try {
+    // Get account by index
+    const account = await accountApi.getAccount({ by: 'index', value: '123' });
+    console.log('Account:', account);
+
+    // Get all accounts for an L1 address
+    const accounts = await accountApi.getAccountsByL1Address(
+      '0x1234567890123456789012345678901234567890'
+    );
+    console.log(`Found ${accounts.length} accounts`);
+
+    // Get API keys
+    const apiKeys = await accountApi.getApiKeys(123);
+    console.log('API keys:', apiKeys.api_keys);
+
+    // Get PnL
+    const pnl = await accountApi.getPnL({ accountIndex: 123 });
+    console.log('PnL entries:', pnl.entries);
+
+    // Get public pools
+    const pools = await accountApi.getPublicPools('all', 10);
+    console.log(`Found ${pools.length} public pools`);
+
+  } catch (error) {
+    console.error('Error:', error.message);
+  } finally {
+    await client.close();
+  }
+}
+
+main().catch(console.error);
+```