@catalyst-team/poly-sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/.env +0 -0
  2. package/README.md +803 -0
  3. package/dist/__tests__/clob-api.test.d.ts +5 -0
  4. package/dist/__tests__/clob-api.test.d.ts.map +1 -0
  5. package/dist/__tests__/clob-api.test.js +240 -0
  6. package/dist/__tests__/clob-api.test.js.map +1 -0
  7. package/dist/__tests__/integration/bridge-client.integration.test.d.ts +11 -0
  8. package/dist/__tests__/integration/bridge-client.integration.test.d.ts.map +1 -0
  9. package/dist/__tests__/integration/bridge-client.integration.test.js +260 -0
  10. package/dist/__tests__/integration/bridge-client.integration.test.js.map +1 -0
  11. package/dist/__tests__/integration/clob-api.integration.test.d.ts +13 -0
  12. package/dist/__tests__/integration/clob-api.integration.test.d.ts.map +1 -0
  13. package/dist/__tests__/integration/clob-api.integration.test.js +170 -0
  14. package/dist/__tests__/integration/clob-api.integration.test.js.map +1 -0
  15. package/dist/__tests__/integration/ctf-client.integration.test.d.ts +17 -0
  16. package/dist/__tests__/integration/ctf-client.integration.test.d.ts.map +1 -0
  17. package/dist/__tests__/integration/ctf-client.integration.test.js +234 -0
  18. package/dist/__tests__/integration/ctf-client.integration.test.js.map +1 -0
  19. package/dist/__tests__/integration/data-api.integration.test.d.ts +9 -0
  20. package/dist/__tests__/integration/data-api.integration.test.d.ts.map +1 -0
  21. package/dist/__tests__/integration/data-api.integration.test.js +161 -0
  22. package/dist/__tests__/integration/data-api.integration.test.js.map +1 -0
  23. package/dist/__tests__/integration/gamma-api.integration.test.d.ts +9 -0
  24. package/dist/__tests__/integration/gamma-api.integration.test.d.ts.map +1 -0
  25. package/dist/__tests__/integration/gamma-api.integration.test.js +170 -0
  26. package/dist/__tests__/integration/gamma-api.integration.test.js.map +1 -0
  27. package/dist/__tests__/test-utils.d.ts +92 -0
  28. package/dist/__tests__/test-utils.d.ts.map +1 -0
  29. package/dist/__tests__/test-utils.js +143 -0
  30. package/dist/__tests__/test-utils.js.map +1 -0
  31. package/dist/clients/bridge-client.d.ts +388 -0
  32. package/dist/clients/bridge-client.d.ts.map +1 -0
  33. package/dist/clients/bridge-client.js +587 -0
  34. package/dist/clients/bridge-client.js.map +1 -0
  35. package/dist/clients/clob-api.d.ts +318 -0
  36. package/dist/clients/clob-api.d.ts.map +1 -0
  37. package/dist/clients/clob-api.js +388 -0
  38. package/dist/clients/clob-api.js.map +1 -0
  39. package/dist/clients/ctf-client.d.ts +473 -0
  40. package/dist/clients/ctf-client.d.ts.map +1 -0
  41. package/dist/clients/ctf-client.js +915 -0
  42. package/dist/clients/ctf-client.js.map +1 -0
  43. package/dist/clients/data-api.d.ts +134 -0
  44. package/dist/clients/data-api.d.ts.map +1 -0
  45. package/dist/clients/data-api.js +265 -0
  46. package/dist/clients/data-api.js.map +1 -0
  47. package/dist/clients/gamma-api.d.ts +401 -0
  48. package/dist/clients/gamma-api.d.ts.map +1 -0
  49. package/dist/clients/gamma-api.js +352 -0
  50. package/dist/clients/gamma-api.js.map +1 -0
  51. package/dist/clients/trading-client.d.ts +252 -0
  52. package/dist/clients/trading-client.d.ts.map +1 -0
  53. package/dist/clients/trading-client.js +543 -0
  54. package/dist/clients/trading-client.js.map +1 -0
  55. package/dist/clients/websocket-manager.d.ts +100 -0
  56. package/dist/clients/websocket-manager.d.ts.map +1 -0
  57. package/dist/clients/websocket-manager.js +193 -0
  58. package/dist/clients/websocket-manager.js.map +1 -0
  59. package/dist/core/cache-adapter-bridge.d.ts +36 -0
  60. package/dist/core/cache-adapter-bridge.d.ts.map +1 -0
  61. package/dist/core/cache-adapter-bridge.js +81 -0
  62. package/dist/core/cache-adapter-bridge.js.map +1 -0
  63. package/dist/core/cache.d.ts +40 -0
  64. package/dist/core/cache.d.ts.map +1 -0
  65. package/dist/core/cache.js +71 -0
  66. package/dist/core/cache.js.map +1 -0
  67. package/dist/core/errors.d.ts +38 -0
  68. package/dist/core/errors.d.ts.map +1 -0
  69. package/dist/core/errors.js +84 -0
  70. package/dist/core/errors.js.map +1 -0
  71. package/dist/core/rate-limiter.d.ts +31 -0
  72. package/dist/core/rate-limiter.d.ts.map +1 -0
  73. package/dist/core/rate-limiter.js +70 -0
  74. package/dist/core/rate-limiter.js.map +1 -0
  75. package/dist/core/types.d.ts +314 -0
  76. package/dist/core/types.d.ts.map +1 -0
  77. package/dist/core/types.js +19 -0
  78. package/dist/core/types.js.map +1 -0
  79. package/dist/core/unified-cache.d.ts +63 -0
  80. package/dist/core/unified-cache.d.ts.map +1 -0
  81. package/dist/core/unified-cache.js +114 -0
  82. package/dist/core/unified-cache.js.map +1 -0
  83. package/dist/index.d.ts +94 -0
  84. package/dist/index.d.ts.map +1 -0
  85. package/dist/index.js +258 -0
  86. package/dist/index.js.map +1 -0
  87. package/dist/mcp/errors.d.ts +33 -0
  88. package/dist/mcp/errors.d.ts.map +1 -0
  89. package/dist/mcp/errors.js +86 -0
  90. package/dist/mcp/errors.js.map +1 -0
  91. package/dist/mcp/index.d.ts +62 -0
  92. package/dist/mcp/index.d.ts.map +1 -0
  93. package/dist/mcp/index.js +173 -0
  94. package/dist/mcp/index.js.map +1 -0
  95. package/dist/mcp/server.d.ts +17 -0
  96. package/dist/mcp/server.d.ts.map +1 -0
  97. package/dist/mcp/server.js +155 -0
  98. package/dist/mcp/server.js.map +1 -0
  99. package/dist/mcp/tools/guide.d.ts +12 -0
  100. package/dist/mcp/tools/guide.d.ts.map +1 -0
  101. package/dist/mcp/tools/guide.js +801 -0
  102. package/dist/mcp/tools/guide.js.map +1 -0
  103. package/dist/mcp/tools/index.d.ts +11 -0
  104. package/dist/mcp/tools/index.d.ts.map +1 -0
  105. package/dist/mcp/tools/index.js +27 -0
  106. package/dist/mcp/tools/index.js.map +1 -0
  107. package/dist/mcp/tools/market.d.ts +11 -0
  108. package/dist/mcp/tools/market.d.ts.map +1 -0
  109. package/dist/mcp/tools/market.js +314 -0
  110. package/dist/mcp/tools/market.js.map +1 -0
  111. package/dist/mcp/tools/order.d.ts +10 -0
  112. package/dist/mcp/tools/order.d.ts.map +1 -0
  113. package/dist/mcp/tools/order.js +258 -0
  114. package/dist/mcp/tools/order.js.map +1 -0
  115. package/dist/mcp/tools/trade.d.ts +38 -0
  116. package/dist/mcp/tools/trade.d.ts.map +1 -0
  117. package/dist/mcp/tools/trade.js +314 -0
  118. package/dist/mcp/tools/trade.js.map +1 -0
  119. package/dist/mcp/tools/trader.d.ts +11 -0
  120. package/dist/mcp/tools/trader.d.ts.map +1 -0
  121. package/dist/mcp/tools/trader.js +277 -0
  122. package/dist/mcp/tools/trader.js.map +1 -0
  123. package/dist/mcp/tools/wallet.d.ts +274 -0
  124. package/dist/mcp/tools/wallet.d.ts.map +1 -0
  125. package/dist/mcp/tools/wallet.js +579 -0
  126. package/dist/mcp/tools/wallet.js.map +1 -0
  127. package/dist/mcp/types.d.ts +413 -0
  128. package/dist/mcp/types.d.ts.map +1 -0
  129. package/dist/mcp/types.js +5 -0
  130. package/dist/mcp/types.js.map +1 -0
  131. package/dist/services/authorization-service.d.ts +97 -0
  132. package/dist/services/authorization-service.d.ts.map +1 -0
  133. package/dist/services/authorization-service.js +279 -0
  134. package/dist/services/authorization-service.js.map +1 -0
  135. package/dist/services/market-service.d.ts +108 -0
  136. package/dist/services/market-service.d.ts.map +1 -0
  137. package/dist/services/market-service.js +458 -0
  138. package/dist/services/market-service.js.map +1 -0
  139. package/dist/services/realtime-service.d.ts +82 -0
  140. package/dist/services/realtime-service.d.ts.map +1 -0
  141. package/dist/services/realtime-service.js +150 -0
  142. package/dist/services/realtime-service.js.map +1 -0
  143. package/dist/services/swap-service.d.ts +217 -0
  144. package/dist/services/swap-service.d.ts.map +1 -0
  145. package/dist/services/swap-service.js +695 -0
  146. package/dist/services/swap-service.js.map +1 -0
  147. package/dist/services/wallet-service.d.ts +94 -0
  148. package/dist/services/wallet-service.d.ts.map +1 -0
  149. package/dist/services/wallet-service.js +173 -0
  150. package/dist/services/wallet-service.js.map +1 -0
  151. package/dist/utils/price-utils.d.ts +153 -0
  152. package/dist/utils/price-utils.d.ts.map +1 -0
  153. package/dist/utils/price-utils.js +236 -0
  154. package/dist/utils/price-utils.js.map +1 -0
  155. package/docs/00-design.md +760 -0
  156. package/docs/01-mcp.md +2041 -0
  157. package/docs/02-API.md +1148 -0
  158. package/docs/e2e/01-trader-tools.md +159 -0
  159. package/docs/e2e/02-market-tools.md +180 -0
  160. package/docs/e2e/03-order-tools.md +166 -0
  161. package/docs/e2e/04-wallet-tools.md +224 -0
  162. package/docs/e2e/05-trading-tools.md +327 -0
  163. package/docs/e2e/06-integration-scenarios.md +481 -0
  164. package/docs/e2e/coordinator.md +376 -0
  165. package/examples/01-basic-usage.ts +68 -0
  166. package/examples/02-smart-money.ts +95 -0
  167. package/examples/03-market-analysis.ts +108 -0
  168. package/examples/04-kline-aggregation.ts +158 -0
  169. package/examples/05-follow-wallet-strategy.ts +156 -0
  170. package/examples/06-services-demo.ts +124 -0
  171. package/examples/07-realtime-websocket.ts +117 -0
  172. package/examples/08-trading-orders.ts +278 -0
  173. package/examples/09-rewards-tracking.ts +187 -0
  174. package/examples/10-ctf-operations.ts +336 -0
  175. package/examples/11-live-arbitrage-scan.ts +221 -0
  176. package/examples/12-trending-arb-monitor.ts +406 -0
  177. package/examples/README.md +179 -0
  178. package/package.json +62 -0
  179. package/scripts/README.md +163 -0
  180. package/scripts/approvals/approve-erc1155.ts +129 -0
  181. package/scripts/approvals/approve-neg-risk-erc1155.ts +149 -0
  182. package/scripts/approvals/approve-neg-risk.ts +102 -0
  183. package/scripts/approvals/check-all-allowances.ts +150 -0
  184. package/scripts/approvals/check-allowance.ts +129 -0
  185. package/scripts/approvals/check-ctf-approval.ts +158 -0
  186. package/scripts/datas/001-report.md +486 -0
  187. package/scripts/datas/clone-modal-screenshot.png +0 -0
  188. package/scripts/deposit/deposit-native-usdc.ts +179 -0
  189. package/scripts/deposit/deposit-usdc.ts +155 -0
  190. package/scripts/deposit/swap-usdc-to-usdce.ts +375 -0
  191. package/scripts/research/research-markets.ts +166 -0
  192. package/scripts/trading/check-orders.ts +50 -0
  193. package/scripts/trading/sell-nvidia-positions.ts +206 -0
  194. package/scripts/trading/test-order.ts +172 -0
  195. package/scripts/truth.md +440 -0
  196. package/scripts/verify/test-approve-trading.ts +98 -0
  197. package/scripts/verify/test-provider-fix.ts +43 -0
  198. package/scripts/verify/test-search-mcp.ts +113 -0
  199. package/scripts/verify/verify-all-apis.ts +160 -0
  200. package/scripts/wallet/check-wallet-balances.ts +75 -0
  201. package/scripts/wallet/test-wallet-operations.ts +191 -0
  202. package/scripts/wallet/verify-wallet-tools.ts +124 -0
  203. package/src/__tests__/clob-api.test.ts +301 -0
  204. package/src/__tests__/integration/bridge-client.integration.test.ts +314 -0
  205. package/src/__tests__/integration/clob-api.integration.test.ts +218 -0
  206. package/src/__tests__/integration/ctf-client.integration.test.ts +331 -0
  207. package/src/__tests__/integration/data-api.integration.test.ts +194 -0
  208. package/src/__tests__/integration/gamma-api.integration.test.ts +206 -0
  209. package/src/__tests__/test-utils.ts +170 -0
  210. package/src/clients/bridge-client.ts +841 -0
  211. package/src/clients/clob-api.ts +629 -0
  212. package/src/clients/ctf-client.ts +1216 -0
  213. package/src/clients/data-api.ts +469 -0
  214. package/src/clients/gamma-api.ts +597 -0
  215. package/src/clients/trading-client.ts +749 -0
  216. package/src/clients/websocket-manager.ts +267 -0
  217. package/src/core/cache-adapter-bridge.ts +94 -0
  218. package/src/core/cache.ts +85 -0
  219. package/src/core/errors.ts +117 -0
  220. package/src/core/rate-limiter.ts +74 -0
  221. package/src/core/types.ts +360 -0
  222. package/src/core/unified-cache.ts +153 -0
  223. package/src/index.ts +455 -0
  224. package/src/mcp/README.md +380 -0
  225. package/src/mcp/errors.ts +124 -0
  226. package/src/mcp/index.ts +309 -0
  227. package/src/mcp/server.ts +183 -0
  228. package/src/mcp/tools/guide.ts +821 -0
  229. package/src/mcp/tools/index.ts +73 -0
  230. package/src/mcp/tools/market.ts +363 -0
  231. package/src/mcp/tools/order.ts +326 -0
  232. package/src/mcp/tools/trade.ts +417 -0
  233. package/src/mcp/tools/trader.ts +322 -0
  234. package/src/mcp/tools/wallet.ts +683 -0
  235. package/src/mcp/types.ts +472 -0
  236. package/src/services/authorization-service.ts +357 -0
  237. package/src/services/market-service.ts +544 -0
  238. package/src/services/realtime-service.ts +196 -0
  239. package/src/services/swap-service.ts +896 -0
  240. package/src/services/wallet-service.ts +259 -0
  241. package/src/utils/price-utils.ts +307 -0
  242. package/tsconfig.json +8 -0
  243. package/vitest.config.ts +19 -0
  244. package/vitest.integration.config.ts +18 -0
@@ -0,0 +1,336 @@
1
+ /**
2
+ * Example 10: CTF (Conditional Token Framework) Operations
3
+ *
4
+ * Demonstrates on-chain CTF operations:
5
+ * - Split: USDC → YES + NO tokens
6
+ * - Merge: YES + NO → USDC (for arbitrage)
7
+ * - Redeem: Winning tokens → USDC (after resolution)
8
+ * - Balance queries and gas estimation
9
+ *
10
+ * ⚠️ CRITICAL: Polymarket CTF uses USDC.e (bridged), NOT native USDC!
11
+ *
12
+ * | Token | Address | CTF Compatible |
13
+ * |---------------|--------------------------------------------|----------------|
14
+ * | USDC.e | 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174 | ✅ Yes |
15
+ * | Native USDC | 0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359 | ❌ No |
16
+ *
17
+ * Common Mistake:
18
+ * - Your wallet shows USDC balance in block explorers/wallets
19
+ * - But CTF operations fail with "Insufficient USDC balance"
20
+ * - This is because you have native USDC, not USDC.e
21
+ *
22
+ * Solution:
23
+ * - Swap native USDC to USDC.e: SwapService.swap('USDC', 'USDC_E', amount)
24
+ * - Or use SwapService.transferUsdcE() when funding wallets
25
+ * - Use CTFClient.checkReadyForCTF() to verify before operations
26
+ *
27
+ * IMPORTANT: These are real on-chain transactions!
28
+ * - Require MATIC for gas fees
29
+ * - Require USDC.e (NOT native USDC) for split operations
30
+ * - Test on small amounts first
31
+ *
32
+ * Set environment variables:
33
+ * - POLYMARKET_PRIVATE_KEY: Your wallet private key
34
+ * - POLYGON_RPC_URL: (optional) Custom RPC URL
35
+ */
36
+
37
+ import {
38
+ CTFClient,
39
+ PolymarketSDK,
40
+ TradingClient,
41
+ RateLimiter,
42
+ CTF_CONTRACT,
43
+ USDC_CONTRACT,
44
+ formatUSDC,
45
+ checkArbitrage,
46
+ } from '../src/index.js';
47
+
48
+ // Configuration
49
+ const PRIVATE_KEY = process.env.POLYMARKET_PRIVATE_KEY || '0xYOUR_PRIVATE_KEY_HERE';
50
+ const RPC_URL = process.env.POLYGON_RPC_URL || 'https://polygon-rpc.com';
51
+
52
+ async function main() {
53
+ console.log('=== Polymarket CTF Operations ===\n');
54
+
55
+ // Check if private key is set
56
+ if (PRIVATE_KEY === '0xYOUR_PRIVATE_KEY_HERE') {
57
+ console.log('WARNING: No private key set!');
58
+ console.log('Set POLYMARKET_PRIVATE_KEY environment variable.');
59
+ console.log('\nThis example will show CTF concepts without executing transactions.\n');
60
+ await demonstrateConcepts();
61
+ return;
62
+ }
63
+
64
+ // Initialize clients
65
+ const ctf = new CTFClient({
66
+ privateKey: PRIVATE_KEY,
67
+ rpcUrl: RPC_URL,
68
+ });
69
+
70
+ const sdk = new PolymarketSDK();
71
+ const rateLimiter = new RateLimiter();
72
+
73
+ console.log(`Wallet: ${ctf.getAddress()}`);
74
+ console.log(`CTF Contract: ${CTF_CONTRACT}`);
75
+ console.log(`USDC Contract: ${USDC_CONTRACT}\n`);
76
+
77
+ // ===== 1. Check CTF Readiness =====
78
+ console.log('1. Checking CTF readiness (USDC.e + MATIC)...\n');
79
+
80
+ try {
81
+ const readiness = await ctf.checkReadyForCTF('10'); // Check for at least $10 USDC.e
82
+ console.log(` USDC.e Balance: $${readiness.usdcEBalance} (required for CTF)`);
83
+ console.log(` Native USDC: $${readiness.nativeUsdcBalance} (NOT usable for CTF)`);
84
+ console.log(` MATIC Balance: ${readiness.maticBalance} (for gas)`);
85
+ console.log(` CTF Ready: ${readiness.ready ? '✅ Yes' : '❌ No'}`);
86
+ if (readiness.suggestion) {
87
+ console.log(`\n ⚠️ ${readiness.suggestion}`);
88
+ }
89
+ } catch (error) {
90
+ console.log(` Error checking readiness: ${error}`);
91
+ }
92
+
93
+ // ===== 2. Find an Active Market =====
94
+ console.log('\n2. Finding an active market with arbitrage potential...\n');
95
+
96
+ const markets = await sdk.gammaApi.getMarkets({
97
+ closed: false,
98
+ active: true,
99
+ limit: 10,
100
+ });
101
+
102
+ if (markets.length === 0) {
103
+ console.log(' No active markets found');
104
+ return;
105
+ }
106
+
107
+ // Find market with smallest spread (potential arb)
108
+ let bestMarket = null;
109
+ let bestOrderbook = null;
110
+
111
+ for (const market of markets) {
112
+ try {
113
+ const orderbook = await sdk.clobApi.getProcessedOrderbook(market.conditionId);
114
+ const askSum = orderbook.summary.askSum;
115
+
116
+ console.log(` ${market.question?.slice(0, 40)}...`);
117
+ console.log(` Ask Sum: ${askSum.toFixed(4)} | Long Arb: ${(orderbook.summary.longArbProfit * 100).toFixed(2)}%`);
118
+
119
+ if (!bestOrderbook || askSum < bestOrderbook.summary.askSum) {
120
+ bestMarket = market;
121
+ bestOrderbook = orderbook;
122
+ }
123
+ } catch {
124
+ // Skip markets without orderbook
125
+ }
126
+ }
127
+
128
+ if (!bestMarket || !bestOrderbook) {
129
+ console.log(' No suitable markets found');
130
+ return;
131
+ }
132
+
133
+ console.log(`\n Selected: ${bestMarket.question?.slice(0, 50)}...`);
134
+ console.log(` Condition ID: ${bestMarket.conditionId}`);
135
+
136
+ // ===== 3. Check Token Balances =====
137
+ console.log('\n3. Checking token balances...\n');
138
+
139
+ try {
140
+ const balances = await ctf.getPositionBalance(bestMarket.conditionId);
141
+ console.log(` YES Balance: ${balances.yesBalance}`);
142
+ console.log(` NO Balance: ${balances.noBalance}`);
143
+ console.log(` YES Position ID: ${balances.yesPositionId.slice(0, 20)}...`);
144
+ console.log(` NO Position ID: ${balances.noPositionId.slice(0, 20)}...`);
145
+ } catch (error) {
146
+ console.log(` Error checking balances: ${error}`);
147
+ }
148
+
149
+ // ===== 4. Check Market Resolution =====
150
+ console.log('\n4. Checking market resolution status...\n');
151
+
152
+ try {
153
+ const resolution = await ctf.getMarketResolution(bestMarket.conditionId);
154
+ console.log(` Is Resolved: ${resolution.isResolved}`);
155
+ if (resolution.isResolved) {
156
+ console.log(` Winning Outcome: ${resolution.winningOutcome}`);
157
+ console.log(` Payout Numerators: [${resolution.payoutNumerators.join(', ')}]`);
158
+ console.log(` Payout Denominator: ${resolution.payoutDenominator}`);
159
+ }
160
+ } catch (error) {
161
+ console.log(` Error checking resolution: ${error}`);
162
+ }
163
+
164
+ // ===== 5. Arbitrage Analysis =====
165
+ console.log('\n5. Arbitrage Analysis...\n');
166
+
167
+ const arb = checkArbitrage(
168
+ bestOrderbook.yes.ask,
169
+ bestOrderbook.no.ask,
170
+ bestOrderbook.yes.bid,
171
+ bestOrderbook.no.bid
172
+ );
173
+
174
+ if (arb) {
175
+ console.log(` ARBITRAGE DETECTED!`);
176
+ console.log(` Type: ${arb.type.toUpperCase()}`);
177
+ console.log(` Profit: ${(arb.profit * 100).toFixed(2)}%`);
178
+
179
+ if (arb.type === 'long') {
180
+ console.log(`\n Strategy (Long Arb):`);
181
+ console.log(` 1. Buy YES @ $${bestOrderbook.yes.ask.toFixed(4)}`);
182
+ console.log(` 2. Buy NO @ $${bestOrderbook.no.ask.toFixed(4)}`);
183
+ console.log(` 3. CTF Merge → 1 USDC per pair`);
184
+ console.log(` Total cost: $${bestOrderbook.summary.askSum.toFixed(4)} per pair`);
185
+ console.log(` Profit: $${arb.profit.toFixed(4)} per pair`);
186
+ } else {
187
+ console.log(`\n Strategy (Short Arb):`);
188
+ console.log(` 1. CTF Split $1 USDC → 1 YES + 1 NO`);
189
+ console.log(` 2. Sell YES @ $${bestOrderbook.yes.bid.toFixed(4)}`);
190
+ console.log(` 3. Sell NO @ $${bestOrderbook.no.bid.toFixed(4)}`);
191
+ console.log(` Total revenue: $${bestOrderbook.summary.bidSum.toFixed(4)} per pair`);
192
+ console.log(` Profit: $${arb.profit.toFixed(4)} per pair`);
193
+ }
194
+ } else {
195
+ console.log(` No arbitrage opportunity`);
196
+ console.log(` Ask Sum: $${bestOrderbook.summary.askSum.toFixed(4)} (need < $1 for long arb)`);
197
+ console.log(` Bid Sum: $${bestOrderbook.summary.bidSum.toFixed(4)} (need > $1 for short arb)`);
198
+ }
199
+
200
+ // ===== 6. Gas Estimation =====
201
+ console.log('\n6. Gas Estimation...\n');
202
+
203
+ try {
204
+ const splitGas = await ctf.estimateSplitGas(bestMarket.conditionId, '100');
205
+ const mergeGas = await ctf.estimateMergeGas(bestMarket.conditionId, '100');
206
+ console.log(` Split 100 USDC: ~${splitGas} gas`);
207
+ console.log(` Merge 100 pairs: ~${mergeGas} gas`);
208
+ console.log(` At ~30 gwei, costs ~$${(parseInt(splitGas) * 30 / 1e9 * 0.5).toFixed(4)} per operation`);
209
+ } catch (error) {
210
+ console.log(` Error estimating gas: ${error}`);
211
+ }
212
+
213
+ // ===== 7. CTF Operation Examples (Not Executed) =====
214
+ console.log('\n7. CTF Operation Examples (Not Executed)\n');
215
+
216
+ console.log(' --- SPLIT (USDC → Tokens) ---');
217
+ console.log(`
218
+ // Split 100 USDC into 100 YES + 100 NO
219
+ const splitResult = await ctf.split(conditionId, '100');
220
+ console.log(\`TX: \${splitResult.txHash}\`);
221
+ console.log(\`Created \${splitResult.yesTokens} YES + \${splitResult.noTokens} NO\`);
222
+ `);
223
+
224
+ console.log(' --- MERGE (Tokens → USDC) ---');
225
+ console.log(`
226
+ // Merge 100 YES + 100 NO → 100 USDC
227
+ const mergeResult = await ctf.merge(conditionId, '100');
228
+ console.log(\`TX: \${mergeResult.txHash}\`);
229
+ console.log(\`Received \${mergeResult.usdcReceived} USDC\`);
230
+ `);
231
+
232
+ console.log(' --- REDEEM (After Resolution) ---');
233
+ console.log(`
234
+ // Redeem winning tokens after market resolves
235
+ const redeemResult = await ctf.redeem(conditionId);
236
+ console.log(\`TX: \${redeemResult.txHash}\`);
237
+ console.log(\`Redeemed \${redeemResult.tokensRedeemed} \${redeemResult.outcome}\`);
238
+ console.log(\`Received \${redeemResult.usdcReceived} USDC\`);
239
+ `);
240
+
241
+ // ===== 8. Full Arbitrage Flow =====
242
+ console.log('8. Full Arbitrage Flow Example\n');
243
+
244
+ console.log(`
245
+ // Assuming long arbitrage opportunity exists
246
+ // 1. Buy YES tokens via TradingClient
247
+ const yesOrder = await tradingClient.createMarketOrder({
248
+ tokenId: yesTokenId,
249
+ side: 'BUY',
250
+ amount: 100, // $100 USDC
251
+ orderType: 'FOK',
252
+ });
253
+
254
+ // 2. Buy NO tokens via TradingClient
255
+ const noOrder = await tradingClient.createMarketOrder({
256
+ tokenId: noTokenId,
257
+ side: 'BUY',
258
+ amount: 100, // $100 USDC
259
+ orderType: 'FOK',
260
+ });
261
+
262
+ // 3. Merge tokens via CTFClient
263
+ // Calculate min(yesTokens, noTokens) to merge
264
+ const tokensToMerge = Math.min(yesTokensReceived, noTokensReceived);
265
+ const mergeResult = await ctf.merge(conditionId, tokensToMerge.toString());
266
+
267
+ // 4. Profit = USDC received - total spent
268
+ console.log(\`Profit: \${mergeResult.usdcReceived - totalSpent}\`);
269
+ `);
270
+
271
+ console.log('\n=== Example Complete ===');
272
+ }
273
+
274
+ async function demonstrateConcepts() {
275
+ console.log('--- CTF Concepts Demonstration ---\n');
276
+
277
+ console.log('Polymarket uses the Gnosis Conditional Token Framework (CTF).\n');
278
+
279
+ console.log('Core Operations:');
280
+ console.log('┌─────────────────────────────────────────────────────────────┐');
281
+ console.log('│ SPLIT: $1 USDC → 1 YES token + 1 NO token │');
282
+ console.log('│ MERGE: 1 YES + 1 NO → $1 USDC │');
283
+ console.log('│ REDEEM: After resolution, winning tokens → $1 USDC each │');
284
+ console.log('└─────────────────────────────────────────────────────────────┘\n');
285
+
286
+ console.log('Arbitrage Use Cases:');
287
+ console.log('┌─────────────────────────────────────────────────────────────┐');
288
+ console.log('│ LONG ARB (askSum < $1): │');
289
+ console.log('│ 1. Buy YES @ $0.48 + NO @ $0.50 = $0.98 cost │');
290
+ console.log('│ 2. CTF Merge → $1 USDC │');
291
+ console.log('│ 3. Profit: $0.02 per pair (2%) │');
292
+ console.log('├─────────────────────────────────────────────────────────────┤');
293
+ console.log('│ SHORT ARB (bidSum > $1): │');
294
+ console.log('│ 1. CTF Split $1 → 1 YES + 1 NO │');
295
+ console.log('│ 2. Sell YES @ $0.52 + NO @ $0.50 = $1.02 revenue │');
296
+ console.log('│ 3. Profit: $0.02 per pair (2%) │');
297
+ console.log('└─────────────────────────────────────────────────────────────┘\n');
298
+
299
+ console.log('Market Making Use Case:');
300
+ console.log('┌─────────────────────────────────────────────────────────────┐');
301
+ console.log('│ If you sell too many YES tokens and need inventory: │');
302
+ console.log('│ 1. CTF Split $1000 → 1000 YES + 1000 NO │');
303
+ console.log('│ 2. Sell the NO tokens on market │');
304
+ console.log('│ 3. Use YES tokens to continue market making │');
305
+ console.log('└─────────────────────────────────────────────────────────────┘\n');
306
+
307
+ console.log('Contract Addresses (Polygon):');
308
+ console.log(` CTF: ${CTF_CONTRACT}`);
309
+ console.log(` USDC: ${USDC_CONTRACT}\n`);
310
+
311
+ console.log('Gas Costs:');
312
+ console.log(' Split/Merge/Redeem: ~200,000-300,000 gas');
313
+ console.log(' At ~30 gwei, ~$0.003-0.005 per operation\n');
314
+
315
+ console.log('⚠️ IMPORTANT: USDC.e vs Native USDC');
316
+ console.log('┌─────────────────────────────────────────────────────────────┐');
317
+ console.log('│ Polymarket CTF ONLY accepts USDC.e (bridged USDC) │');
318
+ console.log('│ │');
319
+ console.log('│ USDC.e: 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174 ✅ │');
320
+ console.log('│ Native USDC: 0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359 ❌ │');
321
+ console.log('│ │');
322
+ console.log('│ If you have native USDC, swap to USDC.e first: │');
323
+ console.log('│ SwapService.swap("USDC", "USDC_E", amount) │');
324
+ console.log('│ │');
325
+ console.log('│ When funding wallets for CTF, use: │');
326
+ console.log('│ SwapService.transferUsdcE(to, amount) │');
327
+ console.log('└─────────────────────────────────────────────────────────────┘\n');
328
+
329
+ console.log('To run actual CTF operations:');
330
+ console.log(' 1. Set POLYMARKET_PRIVATE_KEY environment variable');
331
+ console.log(' 2. Ensure wallet has USDC.e on Polygon (NOT native USDC!)');
332
+ console.log(' 3. Ensure wallet has MATIC for gas');
333
+ console.log(' 4. Run this example again\n');
334
+ }
335
+
336
+ main().catch(console.error);
@@ -0,0 +1,221 @@
1
+ /**
2
+ * Example 12: Live Arbitrage Scan
3
+ *
4
+ * This script scans real Polymarket markets for arbitrage opportunities.
5
+ * It uses only read operations (no trading) to safely test the arbitrage detection.
6
+ *
7
+ * Features demonstrated:
8
+ * - Real market data fetching
9
+ * - Arbitrage opportunity detection
10
+ * - Gas cost estimation
11
+ * - Pre-flight checks simulation
12
+ *
13
+ * Run with:
14
+ * pnpm example:live-arb
15
+ */
16
+
17
+ import { PolymarketSDK, checkArbitrage } from '../src/index.js';
18
+
19
+ async function main() {
20
+ console.log('=== Live Arbitrage Market Scan ===\n');
21
+ console.log('Scanning real Polymarket markets for arbitrage opportunities...\n');
22
+
23
+ // Initialize SDK (no credentials needed for read operations)
24
+ const sdk = new PolymarketSDK();
25
+
26
+ // ===== 1. Fetch Active Markets =====
27
+ console.log('1. Fetching active markets...\n');
28
+
29
+ const markets = await sdk.gammaApi.getMarkets({
30
+ closed: false,
31
+ active: true,
32
+ limit: 50,
33
+ });
34
+
35
+ console.log(` Found ${markets.length} active markets\n`);
36
+
37
+ // ===== 2. Analyze Each Market for Arbitrage =====
38
+ console.log('2. Analyzing markets for arbitrage opportunities...\n');
39
+
40
+ const opportunities: Array<{
41
+ question: string;
42
+ slug: string;
43
+ conditionId: string;
44
+ type: 'long' | 'short';
45
+ yesAsk: number;
46
+ noAsk: number;
47
+ yesBid: number;
48
+ noBid: number;
49
+ askSum: number;
50
+ bidSum: number;
51
+ longArbProfit: number;
52
+ shortArbProfit: number;
53
+ spread: number;
54
+ volume24h: number;
55
+ }> = [];
56
+
57
+ let analyzed = 0;
58
+ let errors = 0;
59
+
60
+ for (const market of markets) {
61
+ if (!market.conditionId) continue;
62
+
63
+ try {
64
+ const orderbook = await sdk.clobApi.getProcessedOrderbook(market.conditionId);
65
+
66
+ analyzed++;
67
+
68
+ // Check for any arbitrage
69
+ const arb = checkArbitrage(
70
+ orderbook.yes.ask,
71
+ orderbook.no.ask,
72
+ orderbook.yes.bid,
73
+ orderbook.no.bid
74
+ );
75
+
76
+ // Store all markets for analysis (even with negative arb profit)
77
+ // This helps us understand market efficiency
78
+ if (orderbook.yes.ask > 0 && orderbook.no.ask > 0) {
79
+ opportunities.push({
80
+ question: market.question?.slice(0, 60) || 'Unknown',
81
+ slug: market.slug || '',
82
+ conditionId: market.conditionId,
83
+ type: arb?.type || (orderbook.summary.longArbProfit > orderbook.summary.shortArbProfit ? 'long' : 'short'),
84
+ yesAsk: orderbook.yes.ask,
85
+ noAsk: orderbook.no.ask,
86
+ yesBid: orderbook.yes.bid,
87
+ noBid: orderbook.no.bid,
88
+ askSum: orderbook.summary.askSum,
89
+ bidSum: orderbook.summary.bidSum,
90
+ longArbProfit: orderbook.summary.longArbProfit,
91
+ shortArbProfit: orderbook.summary.shortArbProfit,
92
+ spread: orderbook.summary.spread,
93
+ volume24h: market.volume24hr || 0,
94
+ });
95
+ }
96
+
97
+ // Progress indicator
98
+ if (analyzed % 10 === 0) {
99
+ process.stdout.write(` Analyzed ${analyzed}/${markets.length} markets...\r`);
100
+ }
101
+ } catch {
102
+ errors++;
103
+ }
104
+ }
105
+
106
+ console.log(`\n Completed: ${analyzed} markets analyzed, ${errors} errors\n`);
107
+
108
+ // ===== 3. Sort and Display Results =====
109
+ console.log('3. Top Arbitrage Opportunities:\n');
110
+
111
+ // Sort by best opportunity (max of long or short profit)
112
+ opportunities.sort((a, b) => {
113
+ const aMax = Math.max(a.longArbProfit, a.shortArbProfit);
114
+ const bMax = Math.max(b.longArbProfit, b.shortArbProfit);
115
+ return bMax - aMax;
116
+ });
117
+
118
+ // Display top 10
119
+ const top10 = opportunities.slice(0, 10);
120
+
121
+ if (top10.length === 0) {
122
+ console.log(' No markets found with significant spread');
123
+ } else {
124
+ console.log(' ┌────────────────────────────────────────────────────────────────┐');
125
+ console.log(' │ Market Analysis (Top 10 by potential profit) │');
126
+ console.log(' ├────────────────────────────────────────────────────────────────┤');
127
+
128
+ for (const opp of top10) {
129
+ const maxProfit = Math.max(opp.longArbProfit, opp.shortArbProfit);
130
+ const arbType = opp.longArbProfit > opp.shortArbProfit ? 'LONG' : 'SHORT';
131
+ const isProfitable = maxProfit > 0;
132
+
133
+ console.log(` │ ${opp.question.padEnd(60)} │`);
134
+ console.log(` │ │`);
135
+ console.log(` │ YES: ask=${opp.yesAsk.toFixed(4)} bid=${opp.yesBid.toFixed(4)} │`);
136
+ console.log(` │ NO: ask=${opp.noAsk.toFixed(4)} bid=${opp.noBid.toFixed(4)} │`);
137
+ console.log(` │ Sum: askSum=${opp.askSum.toFixed(4)} bidSum=${opp.bidSum.toFixed(4)} │`);
138
+ console.log(` │ ${arbType} Profit: ${(maxProfit * 100).toFixed(2)}% ${isProfitable ? '✅' : '❌'} │`);
139
+ console.log(` │ 24h Volume: $${opp.volume24h.toLocaleString()} │`);
140
+ console.log(` ├────────────────────────────────────────────────────────────────┤`);
141
+ }
142
+
143
+ console.log(' └────────────────────────────────────────────────────────────────┘');
144
+ }
145
+
146
+ // ===== 4. Check for Actual Profitable Opportunities =====
147
+ console.log('\n4. Profitable Opportunities (> 0% profit):\n');
148
+
149
+ const profitable = opportunities.filter(
150
+ (opp) => opp.longArbProfit > 0 || opp.shortArbProfit > 0
151
+ );
152
+
153
+ if (profitable.length === 0) {
154
+ console.log(' No profitable arbitrage opportunities found.');
155
+ console.log(' This is normal - markets are usually efficient.\n');
156
+ console.log(' ┌─────────────────────────────────────────────────────────────────┐');
157
+ console.log(' │ Why no arbitrage? │');
158
+ console.log(' │ │');
159
+ console.log(' │ 1. Market makers actively close arbitrage gaps │');
160
+ console.log(' │ 2. Gas costs (~$0.01-0.05) eat into small profits │');
161
+ console.log(' │ 3. Trading fees reduce effective profit │');
162
+ console.log(' │ 4. Opportunities disappear in milliseconds │');
163
+ console.log(' │ │');
164
+ console.log(' │ Successful arbitrage requires: │');
165
+ console.log(' │ - Very fast execution │');
166
+ console.log(' │ - Optimized gas usage │');
167
+ console.log(' │ - Significant capital ($1000+) │');
168
+ console.log(' └─────────────────────────────────────────────────────────────────┘');
169
+ } else {
170
+ console.log(` Found ${profitable.length} profitable opportunities:\n`);
171
+
172
+ for (const opp of profitable) {
173
+ const arbType = opp.longArbProfit > opp.shortArbProfit ? 'LONG' : 'SHORT';
174
+ const profit = Math.max(opp.longArbProfit, opp.shortArbProfit);
175
+
176
+ console.log(` 🎯 ${arbType} ARB: ${(profit * 100).toFixed(2)}% profit`);
177
+ console.log(` Market: ${opp.question}`);
178
+ console.log(` Condition ID: ${opp.conditionId}`);
179
+
180
+ if (arbType === 'LONG') {
181
+ console.log(` Strategy: Buy YES@${opp.yesAsk.toFixed(4)} + NO@${opp.noAsk.toFixed(4)} = ${opp.askSum.toFixed(4)} → Merge for $1`);
182
+ } else {
183
+ console.log(` Strategy: Split $1 → Sell YES@${opp.yesBid.toFixed(4)} + NO@${opp.noBid.toFixed(4)} = ${opp.bidSum.toFixed(4)}`);
184
+ }
185
+ console.log('');
186
+ }
187
+ }
188
+
189
+ // ===== 5. Market Efficiency Analysis =====
190
+ console.log('\n5. Market Efficiency Summary:\n');
191
+
192
+ if (opportunities.length === 0) {
193
+ console.log(' No markets analyzed with valid orderbooks.\n');
194
+ } else {
195
+ const avgAskSum = opportunities.reduce((sum, o) => sum + o.askSum, 0) / opportunities.length;
196
+ const avgBidSum = opportunities.reduce((sum, o) => sum + o.bidSum, 0) / opportunities.length;
197
+ const avgSpread = opportunities.reduce((sum, o) => sum + o.spread, 0) / opportunities.length;
198
+
199
+ const closestToLongArb = opportunities.reduce((closest, o) =>
200
+ Math.abs(1 - o.askSum) < Math.abs(1 - closest.askSum) ? o : closest
201
+ );
202
+
203
+ const closestToShortArb = opportunities.reduce((closest, o) =>
204
+ Math.abs(1 - o.bidSum) < Math.abs(1 - closest.bidSum) ? o : closest
205
+ );
206
+
207
+ console.log(` Average Ask Sum: ${avgAskSum.toFixed(4)} (ideal for long arb: < 1.0)`);
208
+ console.log(` Average Bid Sum: ${avgBidSum.toFixed(4)} (ideal for short arb: > 1.0)`);
209
+ console.log(` Average Spread: ${(avgSpread * 100).toFixed(2)}%`);
210
+ console.log('');
211
+ console.log(` Closest to Long Arb: ${closestToLongArb.question.slice(0, 40)}...`);
212
+ console.log(` askSum = ${closestToLongArb.askSum.toFixed(4)}, profit = ${(closestToLongArb.longArbProfit * 100).toFixed(2)}%`);
213
+ console.log('');
214
+ console.log(` Closest to Short Arb: ${closestToShortArb.question.slice(0, 40)}...`);
215
+ console.log(` bidSum = ${closestToShortArb.bidSum.toFixed(4)}, profit = ${(closestToShortArb.shortArbProfit * 100).toFixed(2)}%`);
216
+ }
217
+
218
+ console.log('\n=== Scan Complete ===\n');
219
+ }
220
+
221
+ main().catch(console.error);