@limitless-exchange/sdk 0.0.1 → 0.0.3

package/README.md

@@ -54,6 +54,12 @@ import { HttpClient, MarketFetcher } from '@limitless-exchange/sdk';
 // Create HTTP client (no authentication needed)
 const httpClient = new HttpClient({
   baseURL: 'https://api.limitless.exchange',
+
+  // Optional: Add custom headers to all requests
+  additionalHeaders: {
+    'X-Custom-Header': 'my-value',
+    'X-API-Version': 'v1',
+  },
 });
 
 const marketFetcher = new MarketFetcher(httpClient);
@@ -111,15 +117,75 @@ const result = await authenticator.authenticate({
 });
 ```
 
+### Token Approvals
+
+**Important**: Before placing orders, you must approve tokens for the exchange contracts. This is a **one-time setup** per wallet.
+
+#### Required Approvals
+
+**CLOB Markets:**
+- **BUY orders**: Approve USDC → `market.venue.exchange`
+- **SELL orders**: Approve Conditional Tokens → `market.venue.exchange`
+
+**NegRisk Markets:**
+- **BUY orders**: Approve USDC → `market.venue.exchange`
+- **SELL orders**: Approve Conditional Tokens → **both** `market.venue.exchange` AND `market.venue.adapter`
+
+#### Quick Setup
+
+Run the approval setup script:
+
+```bash
+# Copy .env.example and configure your wallet
+cp docs/code-samples/.env.example docs/code-samples/.env
+
+# Edit .env and set your PRIVATE_KEY and market slug
+# Then run the approval script
+npx tsx docs/code-samples/setup-approvals.ts
+```
+
+#### Manual Approval Example
+
+```typescript
+import { ethers } from 'ethers';
+import { MarketFetcher, getContractAddress } from '@limitless-exchange/sdk';
+
+// 1. Fetch market to get venue addresses
+const market = await marketFetcher.getMarket('market-slug');
+
+// 2. Create contract instances
+const usdc = new ethers.Contract(
+  getContractAddress('USDC'),
+  ['function approve(address spender, uint256 amount) returns (bool)'],
+  wallet
+);
+
+const ctf = new ethers.Contract(
+  getContractAddress('CTF'),
+  ['function setApprovalForAll(address operator, bool approved)'],
+  wallet
+);
+
+// 3. Approve USDC for BUY orders
+await usdc.approve(market.venue.exchange, ethers.MaxUint256);
+
+// 4. Approve CT for SELL orders
+await ctf.setApprovalForAll(market.venue.exchange, true);
+
+// 5. For NegRisk SELL orders, also approve adapter
+if (market.negRiskRequestId) {
+  await ctf.setApprovalForAll(market.venue.adapter, true);
+}
+```
+
+For complete examples, see [docs/code-samples/setup-approvals.ts](./docs/code-samples/setup-approvals.ts).
+
 ### Trading on NegRisk Markets
 
 NegRisk markets are group markets with multiple related outcomes. Here's a quick example:
 
 ```typescript
-import { OrderClient, MarketFetcher, MarketType, Side, OrderType } from '@limitless-exchange/sdk';
-
-// Set the NegRisk contract address
-process.env.NEGRISK_CONTRACT_ADDRESS = '0x5a38afc17F7E97ad8d6C547ddb837E40B4aEDfC6';
+import { OrderClient, MarketFetcher, Side, OrderType } from '@limitless-exchange/sdk';
 
 // 1. Fetch NegRisk group market
 const marketFetcher = new MarketFetcher(httpClient);
@@ -129,7 +195,7 @@ const groupMarket = await marketFetcher.getMarket('largest-company-end-of-2025-1
 const appleMarket = groupMarket.markets[0];
 const marketDetails = await marketFetcher.getMarket(appleMarket.slug);
 
-// 3. Create order client for NegRisk
+// 3. Create order client (contract address from venue)
 const orderClient = new OrderClient({
   httpClient,
   wallet,
@@ -137,7 +203,6 @@ const orderClient = new OrderClient({
     userId: (authResult.profile as any).id,
     feeRateBps: (authResult.profile as any).rank?.feeRateBps || 300,
   },
-  marketType: MarketType.NEGRISK, // Important: Use NEGRISK
 });
 
 // 4. Place order on submarket (not group!)