@catalyst-team/poly-sdk 0.1.0

package/examples/08-trading-orders.ts

@@ -0,0 +1,278 @@
+/**
+ * Example 08: Trading Orders
+ *
+ * Demonstrates all trading functionality:
+ * - Limit orders (GTC, GTD)
+ * - Market orders (FOK, FAK)
+ * - Order management
+ * - Price utilities
+ * - Rewards tracking
+ *
+ * NOTE: This example does NOT execute real trades.
+ * Uncomment the order sections to test with real funds.
+ */
+
+import {
+  TradingClient,
+  RateLimiter,
+  PolymarketSDK,
+  roundPrice,
+  validatePrice,
+  calculateBuyAmount,
+  checkArbitrage,
+  formatUSDC,
+  type TickSize,
+} from '../src/index.js';
+
+// Test wallet private key (empty wallet for safety)
+const PRIVATE_KEY = process.env.POLYMARKET_PRIVATE_KEY || '0xYOUR_PRIVATE_KEY_HERE';
+
+async function main() {
+  console.log('=== Polymarket Trading Examples ===\n');
+
+  // Initialize SDK and TradingClient
+  const sdk = new PolymarketSDK();
+  const rateLimiter = new RateLimiter();
+  const tradingClient = new TradingClient(rateLimiter, {
+    privateKey: PRIVATE_KEY,
+  });
+
+  // ===== 1. Find an Active Market =====
+  console.log('1. Finding active markets...\n');
+
+  const markets = await sdk.gammaApi.getMarkets({
+    closed: false,
+    active: true,
+    limit: 5,
+  });
+
+  if (markets.length === 0) {
+    console.log('   No active markets found');
+    return;
+  }
+
+  const market = markets[0];
+  console.log(`   Market: ${market.question?.slice(0, 60)}...`);
+  console.log(`   Condition ID: ${market.conditionId}`);
+
+  // Get market details from CLOB
+  const clobMarket = await sdk.clobApi.getMarket(market.conditionId);
+  const yesToken = clobMarket.tokens.find((t) => t.outcome === 'Yes');
+  const noToken = clobMarket.tokens.find((t) => t.outcome === 'No');
+
+  if (!yesToken || !noToken) {
+    console.log('   Could not find tokens');
+    return;
+  }
+
+  console.log(`   YES Token: ${yesToken.tokenId.slice(0, 20)}...`);
+  console.log(`   NO Token: ${noToken.tokenId.slice(0, 20)}...`);
+  console.log(`   YES Price: $${yesToken.price}`);
+  console.log(`   NO Price: $${noToken.price}`);
+
+  // ===== 2. Price Utilities Demo =====
+  console.log('\n2. Price Utilities Demo\n');
+
+  // Get tick size for the market
+  const tickSize: TickSize = '0.01'; // Most markets use 0.01
+
+  // Round prices to tick size
+  const rawPrice = 0.523;
+  console.log(`   Raw price: ${rawPrice}`);
+  console.log(`   Rounded (floor): ${roundPrice(rawPrice, tickSize, 'floor')}`);
+  console.log(`   Rounded (ceil): ${roundPrice(rawPrice, tickSize, 'ceil')}`);
+  console.log(`   Rounded (round): ${roundPrice(rawPrice, tickSize, 'round')}`);
+
+  // Validate prices
+  const validation = validatePrice(0.525, tickSize);
+  console.log(`   Price 0.525 valid: ${validation.valid}`);
+
+  const invalidValidation = validatePrice(0.5233, tickSize);
+  console.log(`   Price 0.5233 valid: ${invalidValidation.valid}`);
+  if (!invalidValidation.valid) {
+    console.log(`   Error: ${invalidValidation.error}`);
+  }
+
+  // Calculate order amounts
+  const price = 0.52;
+  const size = 100;
+  const amount = calculateBuyAmount(price, size);
+  console.log(`\n   Order: BUY ${size} YES @ $${price}`);
+  console.log(`   Cost: ${formatUSDC(amount)}`);
+
+  // ===== 3. Arbitrage Detection =====
+  console.log('\n3. Arbitrage Detection\n');
+
+  // Get current orderbook
+  const orderbook = await sdk.clobApi.getProcessedOrderbook(market.conditionId);
+
+  console.log(`   YES: Bid $${orderbook.yes.bid} / Ask $${orderbook.yes.ask}`);
+  console.log(`   NO:  Bid $${orderbook.no.bid} / Ask $${orderbook.no.ask}`);
+
+  const arb = checkArbitrage(
+    orderbook.yes.ask,
+    orderbook.no.ask,
+    orderbook.yes.bid,
+    orderbook.no.bid
+  );
+
+  if (arb) {
+    console.log(`\n   ARBITRAGE DETECTED!`);
+    console.log(`   Type: ${arb.type}`);
+    console.log(`   Profit: ${formatUSDC(arb.profit)}`);
+  } else {
+    console.log(`   No arbitrage opportunity`);
+    console.log(`   Long cost: $${(orderbook.yes.ask + orderbook.no.ask).toFixed(4)}`);
+    console.log(`   Short revenue: $${(orderbook.yes.bid + orderbook.no.bid).toFixed(4)}`);
+  }
+
+  // ===== 4. Initialize Trading Client =====
+  console.log('\n4. Initializing Trading Client...\n');
+
+  try {
+    await tradingClient.initialize();
+    console.log(`   Wallet: ${tradingClient.getAddress()}`);
+    console.log(`   Initialized: ${tradingClient.isInitialized()}`);
+
+    const creds = tradingClient.getCredentials();
+    if (creds) {
+      console.log(`   API Key: ${creds.key.slice(0, 20)}...`);
+    }
+  } catch (error) {
+    console.log(`   Initialization skipped (no valid private key)`);
+    console.log(`   Set POLYMARKET_PRIVATE_KEY to test trading`);
+    return;
+  }
+
+  // ===== 5. Get Existing Orders and Trades =====
+  console.log('\n5. Getting existing orders and trades...\n');
+
+  const openOrders = await tradingClient.getOpenOrders();
+  console.log(`   Open orders: ${openOrders.length}`);
+
+  const trades = await tradingClient.getTrades();
+  console.log(`   Total trades: ${trades.length}`);
+
+  if (trades.length > 0) {
+    console.log('\n   Recent trades:');
+    for (const t of trades.slice(0, 3)) {
+      console.log(`   - ${t.side} ${t.size} @ $${t.price.toFixed(4)}`);
+    }
+  }
+
+  // ===== 6. Order Types Demo =====
+  console.log('\n6. Order Types (Not Executed)\n');
+
+  console.log('   --- LIMIT ORDERS ---');
+  console.log('   GTC (Good-Til-Cancelled):');
+  console.log('   - Stays on book until filled or cancelled');
+  console.log('   - Best for passive orders at your target price');
+  console.log(`
+   tradingClient.createOrder({
+     tokenId: '${yesToken.tokenId.slice(0, 20)}...',
+     side: 'BUY',
+     price: 0.45,
+     size: 10,
+     orderType: 'GTC',
+   });
+`);
+
+  console.log('   GTD (Good-Til-Date):');
+  console.log('   - Auto-expires at specified timestamp');
+  console.log('   - Good for time-sensitive strategies');
+  console.log(`
+   tradingClient.createOrder({
+     tokenId: '${yesToken.tokenId.slice(0, 20)}...',
+     side: 'BUY',
+     price: 0.45,
+     size: 10,
+     orderType: 'GTD',
+     expiration: Math.floor(Date.now() / 1000) + 3600, // 1 hour
+   });
+`);
+
+  console.log('   --- MARKET ORDERS ---');
+  console.log('   FOK (Fill-Or-Kill):');
+  console.log('   - Must fill entirely or not at all');
+  console.log('   - Best for guaranteed execution');
+  console.log(`
+   tradingClient.createMarketOrder({
+     tokenId: '${yesToken.tokenId.slice(0, 20)}...',
+     side: 'BUY',
+     amount: 10, // $10 USDC for BUY
+     orderType: 'FOK',
+   });
+`);
+
+  console.log('   FAK (Fill-And-Kill):');
+  console.log('   - Fill what you can, cancel the rest');
+  console.log('   - Good for partial fills');
+  console.log(`
+   tradingClient.createMarketOrder({
+     tokenId: '${yesToken.tokenId.slice(0, 20)}...',
+     side: 'SELL',
+     amount: 10, // 10 shares for SELL
+     orderType: 'FAK',
+   });
+`);
+
+  // ===== 7. Rewards Demo =====
+  console.log('\n7. Rewards (Market Making Incentives)\n');
+
+  try {
+    // Get current reward programs
+    const rewards = await tradingClient.getCurrentRewards();
+    console.log(`   Active reward programs: ${rewards.length}`);
+
+    if (rewards.length > 0) {
+      const reward = rewards[0];
+      console.log(`\n   Example reward market:`);
+      console.log(`   - Question: ${reward.question?.slice(0, 50)}...`);
+      console.log(`   - Max Spread: ${reward.rewardsMaxSpread}`);
+      console.log(`   - Min Size: ${reward.rewardsMinSize}`);
+
+      if (reward.rewardsConfig.length > 0) {
+        const config = reward.rewardsConfig[0];
+        console.log(`   - Rate/Day: ${config.ratePerDay}`);
+        console.log(`   - Total Pool: ${config.totalRewards}`);
+      }
+    }
+
+    // Check if orders are scoring (need actual order IDs)
+    if (openOrders.length > 0) {
+      const orderId = openOrders[0].id;
+      const isScoring = await tradingClient.isOrderScoring(orderId);
+      console.log(`\n   Order ${orderId.slice(0, 20)}... scoring: ${isScoring}`);
+    }
+
+    // Get yesterday's earnings
+    const yesterday = new Date();
+    yesterday.setDate(yesterday.getDate() - 1);
+    const dateStr = yesterday.toISOString().split('T')[0];
+
+    const earnings = await tradingClient.getTotalEarningsForDay(dateStr);
+    console.log(`\n   Earnings for ${dateStr}:`);
+    console.log(`   Total: ${formatUSDC(earnings.totalEarnings)}`);
+  } catch (error) {
+    console.log(`   Rewards data not available (requires valid trading history)`);
+  }
+
+  // ===== 8. Balance Check =====
+  console.log('\n8. Balance Check\n');
+
+  try {
+    const balance = await tradingClient.getBalanceAllowance('COLLATERAL');
+    console.log(`   USDC Balance: ${balance.balance}`);
+    console.log(`   USDC Allowance: ${balance.allowance}`);
+  } catch (error) {
+    console.log(`   Balance check failed (requires initialized wallet)`);
+  }
+
+  console.log('\n=== Example Complete ===');
+  console.log('\nTo execute real trades:');
+  console.log('1. Set POLYMARKET_PRIVATE_KEY environment variable');
+  console.log('2. Deposit USDC to your Polymarket proxy wallet');
+  console.log('3. Uncomment the order placement code in this file');
+}
+
+main().catch(console.error);

package/examples/09-rewards-tracking.ts

@@ -0,0 +1,187 @@
+/**
+ * Example 09: Market Maker Rewards Tracking
+ *
+ * Demonstrates how to:
+ * - Find high-reward markets
+ * - Check if orders are scoring
+ * - Track daily earnings
+ * - Optimize for maximum rewards
+ *
+ * NOTE: Requires a wallet with trading history to see earnings.
+ */
+
+import {
+  TradingClient,
+  RateLimiter,
+  PolymarketSDK,
+  formatUSDC,
+} from '../src/index.js';
+
+// Test wallet private key
+const PRIVATE_KEY = process.env.POLYMARKET_PRIVATE_KEY || '0xYOUR_PRIVATE_KEY_HERE';
+
+async function main() {
+  console.log('=== Polymarket Rewards Tracking ===\n');
+
+  const sdk = new PolymarketSDK();
+  const rateLimiter = new RateLimiter();
+  const tradingClient = new TradingClient(rateLimiter, {
+    privateKey: PRIVATE_KEY,
+  });
+
+  // ===== 1. Get Markets with Active Rewards =====
+  console.log('1. Finding markets with active rewards...\n');
+
+  try {
+    await tradingClient.initialize();
+    console.log(`   Wallet: ${tradingClient.getAddress()}\n`);
+
+    const rewards = await tradingClient.getCurrentRewards();
+    console.log(`   Found ${rewards.length} markets with active rewards\n`);
+
+    if (rewards.length > 0) {
+      console.log('   Top 5 reward markets:');
+      console.log('   ' + '─'.repeat(70));
+
+      for (const reward of rewards.slice(0, 5)) {
+        console.log(`\n   Market: ${reward.question?.slice(0, 50)}...`);
+        console.log(`   Slug: ${reward.marketSlug}`);
+        console.log(`   Max Spread: ${reward.rewardsMaxSpread}`);
+        console.log(`   Min Size: ${reward.rewardsMinSize}`);
+
+        if (reward.rewardsConfig.length > 0) {
+          const config = reward.rewardsConfig[0];
+          console.log(`   Daily Rate: ${config.ratePerDay}`);
+          console.log(`   Total Pool: ${config.totalRewards}`);
+          console.log(`   Period: ${config.startDate} to ${config.endDate}`);
+        }
+
+        // Show token prices
+        if (reward.tokens.length > 0) {
+          const yesToken = reward.tokens.find(t => t.outcome === 'Yes');
+          const noToken = reward.tokens.find(t => t.outcome === 'No');
+          if (yesToken && noToken) {
+            console.log(`   YES Price: $${yesToken.price.toFixed(2)} | NO Price: $${noToken.price.toFixed(2)}`);
+          }
+        }
+      }
+      console.log('\n   ' + '─'.repeat(70));
+    }
+
+    // ===== 2. Check Order Scoring Status =====
+    console.log('\n2. Checking if orders are scoring...\n');
+
+    const openOrders = await tradingClient.getOpenOrders();
+    console.log(`   Open orders: ${openOrders.length}`);
+
+    if (openOrders.length > 0) {
+      console.log('\n   Order scoring status:');
+
+      // Check first 5 orders
+      for (const order of openOrders.slice(0, 5)) {
+        const isScoring = await tradingClient.isOrderScoring(order.id);
+        const status = isScoring ? '✅ SCORING' : '❌ NOT SCORING';
+        console.log(`   - ${order.side} ${order.originalSize} @ $${order.price.toFixed(4)}: ${status}`);
+      }
+
+      // Batch check
+      if (openOrders.length > 1) {
+        const orderIds = openOrders.slice(0, 5).map(o => o.id);
+        const scoringStatus = await tradingClient.areOrdersScoring(orderIds);
+        const scoringCount = Object.values(scoringStatus).filter(Boolean).length;
+        console.log(`\n   Summary: ${scoringCount}/${orderIds.length} orders are scoring`);
+      }
+    } else {
+      console.log('   No open orders. Place limit orders to earn rewards.');
+    }
+
+    // ===== 3. Track Earnings =====
+    console.log('\n3. Tracking earnings...\n');
+
+    // Get last 7 days of earnings
+    const dates: string[] = [];
+    for (let i = 1; i <= 7; i++) {
+      const date = new Date();
+      date.setDate(date.getDate() - i);
+      dates.push(date.toISOString().split('T')[0]);
+    }
+
+    console.log('   Daily earnings (last 7 days):');
+    console.log('   ' + '─'.repeat(40));
+
+    let totalWeeklyEarnings = 0;
+
+    for (const date of dates) {
+      try {
+        const earnings = await tradingClient.getTotalEarningsForDay(date);
+        totalWeeklyEarnings += earnings.totalEarnings;
+
+        if (earnings.totalEarnings > 0) {
+          console.log(`   ${date}: ${formatUSDC(earnings.totalEarnings)}`);
+        } else {
+          console.log(`   ${date}: $0.00`);
+        }
+      } catch {
+        console.log(`   ${date}: (no data)`);
+      }
+    }
+
+    console.log('   ' + '─'.repeat(40));
+    console.log(`   Weekly Total: ${formatUSDC(totalWeeklyEarnings)}`);
+
+    // ===== 4. Get Reward Percentages =====
+    console.log('\n4. Market reward percentages...\n');
+
+    try {
+      const percentages = await tradingClient.getRewardPercentages();
+      const entries = Object.entries(percentages);
+
+      if (entries.length > 0) {
+        console.log('   Top markets by reward percentage:');
+
+        // Sort by percentage (descending)
+        const sorted = entries.sort((a, b) => b[1] - a[1]).slice(0, 10);
+
+        for (const [market, percentage] of sorted) {
+          console.log(`   - ${market.slice(0, 30)}...: ${(percentage * 100).toFixed(2)}%`);
+        }
+      } else {
+        console.log('   No reward percentages available');
+      }
+    } catch (error) {
+      console.log('   Reward percentages not available');
+    }
+
+    // ===== 5. Check Balance =====
+    console.log('\n5. Account balance...\n');
+
+    try {
+      const balance = await tradingClient.getBalanceAllowance('COLLATERAL');
+      console.log(`   USDC Balance: ${balance.balance}`);
+      console.log(`   USDC Allowance: ${balance.allowance}`);
+    } catch {
+      console.log('   Balance check not available');
+    }
+
+    // ===== 6. Reward Optimization Tips =====
+    console.log('\n6. Reward Optimization Tips\n');
+    console.log('   ┌─────────────────────────────────────────────────────────────┐');
+    console.log('   │ How to maximize market making rewards:                       │');
+    console.log('   ├─────────────────────────────────────────────────────────────┤');
+    console.log('   │ 1. Keep orders within max_spread of the midpoint            │');
+    console.log('   │ 2. Maintain minimum size (check rewardsMinSize)             │');
+    console.log('   │ 3. Quote both sides (YES and NO) for higher score           │');
+    console.log('   │ 4. Stay active throughout the day (rewards sample minutely) │');
+    console.log('   │ 5. Focus on markets with higher daily rates                 │');
+    console.log('   │ 6. Avoid wide spreads - tighter = higher score              │');
+    console.log('   └─────────────────────────────────────────────────────────────┘');
+
+  } catch (error) {
+    console.log(`   Initialization failed: ${error}`);
+    console.log('   Set POLYMARKET_PRIVATE_KEY to access rewards data');
+  }
+
+  console.log('\n=== Example Complete ===');
+}
+
+main().catch(console.error);