@steerprotocol/sdk 1.18.4 → 1.19.1

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.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PoolQueryAdapter.js","sourceRoot":"","sources":["../../../src/utils/PoolQueryAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,oCAAsD;AAEtD;;;;GAIG;AACH,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;CAwB9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,uBAAuB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;CAwB/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;CAyBhC,CAAC;AAEF;;;;GAIG;AACH,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuBjC,CAAC;AAEF;;;;GAIG;AACH,MAAM,uBAAuB,GAAG;;;;;;;;;;;;;;;;;;;;;CAqB/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;CAqB9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;CAwB3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBhC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAAE,aAAsB,EAAU,EAAE;IACrF,IAAI,QAAQ,KAAK,gBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,gBAAQ,CAAC,OAAO,EAAE,CAAC;QACpE,OAAO,wBAAwB,CAAC;IAClC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,QAAQ,EAAE,CAAC;QAC1C,OAAO,wBAAwB,CAAC;IAClC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,OAAO,sBAAsB,CAAC;IAChC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,SAAS,EAAE,CAAC;QAC3C,OAAO,yBAAyB,CAAC;IACnC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,mBAAmB,CAAC;IAC7B,CAAC;SAAM,IAAI,IAAA,wBAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,OAAO,sBAAsB,CAAC;IAChC,CAAC;SAAM,IAAI,aAAa,EAAE,CAAC;QACzB,OAAO,uBAAuB,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,OAAO,uBAAuB,CAAC;IACjC,CAAC;AACH,CAAC,CAAC;AAlBW,QAAA,gBAAgB,oBAkB3B;AAEF,qDAAqD;AAErD;;;;GAIG;AACU,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BxC,CAAC;AAEF;;;;GAIG;AACU,QAAA,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BvC,CAAC;AAEF;;;;GAIG;AACU,QAAA,0BAA0B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BzC,CAAC;AAEF;;;;GAIG;AACU,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCxC,CAAC;AAEF;;;;GAIG;AACU,QAAA,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCvC,CAAC;AAEF;;;;GAIG;AACU,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC1C,CAAC;AAEF;;;;GAIG;AACU,QAAA,8BAA8B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuB7C,CAAC;AAEF;;;;GAIG;AACU,QAAA,8BAA8B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuB7C,CAAC;AAEF;;;;GAIG;AACU,QAAA,iCAAiC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BhD,CAAC;AAEF;;;;GAIG;AACU,QAAA,iCAAiC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BhD,CAAC;AAEF;;;;GAIG;AACU,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCpC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,2BAA2B,GAAG,CAAC,aAAsB,EAAE,QAAkB,EAAE,EAAE;IACxF,IAAI,aAAa,EAAE,CAAC;QAClB,IAAI,QAAQ,KAAK,gBAAQ,CAAC,MAAM,EAAE,CAAC;YACjC,OAAO,gCAAwB,CAAC;QAClC,CAAC;QACD,OAAO,iCAAyB,CAAC;IACnC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,gBAAQ,CAAC,OAAO,EAAE,CAAC;QAC3E,OAAO,kCAA0B,CAAC;IACpC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,SAAS,EAAE,CAAC;QAC3C,OAAO,mCAA2B,CAAC;IACrC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,6BAAqB,CAAC;IAC/B,CAAC;SAAM,IAAI,IAAA,wBAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,OAAO,gCAAwB,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,iCAAyB,CAAC;IACnC,CAAC;AACH,CAAC,CAAC;AAjBW,QAAA,2BAA2B,+BAiBtC;AAEF;;;;GAIG;AACH,MAAM,0BAA0B,GAAG;;;;;;;;;;;;;;;;;;;CAmBlC,CAAA;AAED;;;;GAIG;AACH,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;CAmBjC,CAAA;AAED;;;;GAIG;AACH,MAAM,0BAA0B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuBlC,CAAA;AAED;;;;GAIG;AACH,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBjC,CAAA;AAED;;;;GAIG;AACH,MAAM,4BAA4B,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBpC,CAAA;AAED;;;;GAIG;AACH,MAAM,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;CAoBnC,CAAA;AAED;;;;GAIG;AACH,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;CAwB9B,CAAA;AAED;;;;;;;;;;;;GAYG;AACI,MAAM,mBAAmB,GAAG,CAAC,aAAsB,EAAE,QAAmB,EAAE,EAAE;IAC/E,IAAI,QAAQ,KAAK,gBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,gBAAQ,CAAC,OAAO,EAAE,CAAC;QACpE,OAAO,2BAA2B,CAAA;IACpC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,OAAO,yBAAyB,CAAA;IAClC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,SAAS,EAAE,CAAC;QAC3C,OAAO,4BAA4B,CAAA;IACrC,CAAC;SAAM,IAAI,QAAQ,KAAK,gBAAQ,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,sBAAsB,CAAC;IAChC,CAAC;SAAM,IAAI,QAAQ,IAAI,IAAA,wBAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAClD,OAAO,yBAAyB,CAAC;IACnC,CAAC;SAAM,IAAI,aAAa,EAAE,CAAC;QACzB,OAAO,0BAA0B,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,OAAO,0BAA0B,CAAA;IACnC,CAAC;AACH,CAAC,CAAA;AAhBU,QAAA,mBAAmB,uBAgB7B"}
@@ -0,0 +1,451 @@
1
+ import { SubgraphClient } from './SubgraphClient';
2
+ import { chainIdToName, getProtocolSubgraphURL } from '../const';
3
+ import { isAlgebraProtocol } from '../const/protocol';
4
+ import { getTopPoolsQuery, getTokenPoolsQueryByAddress, getPoolDetailsQuery } from '../utils/PoolQueryAdapter';
5
+ /**
6
+ * Client for fetching pool data from various DEX protocol subgraphs
7
+ *
8
+ * @example
9
+ * ```typescript
10
+ * import { createPublicClient, createWalletClient, http } from 'viem';
11
+ * import { mainnet } from 'viem/chains';
12
+ * import { PoolClient } from '@steerprotocol/sdk';
13
+ *
14
+ * const client = createPublicClient({
15
+ * chain: mainnet,
16
+ * transport: http()
17
+ * }) as PublicClient & WalletClient;
18
+ *
19
+ * const poolClient = new PoolClient(client, 'your-subgraph-studio-key');
20
+ *
21
+ * // Fetch top pools
22
+ * const topPools = await poolClient.getTopPools(100, Protocol.UniswapV3, 1);
23
+ * ```
24
+ *
25
+ * @extends SubgraphClient
26
+ * @group Pool
27
+ */
28
+ export class PoolClient extends SubgraphClient {
29
+ /**
30
+ * Creates a new PoolClient instance
31
+ *
32
+ * @param client - Combined public and wallet client for blockchain interactions
33
+ * @param subgraphStudioKey - Optional Subgraph Studio API key for higher rate limits
34
+ *
35
+ * @example
36
+ * ```typescript
37
+ * const poolClient = new PoolClient(client, 'your-api-key');
38
+ * ```
39
+ */
40
+ constructor(client, subgraphStudioKey = '') {
41
+ super(client);
42
+ /** Default timeout for GraphQL queries in milliseconds */
43
+ this.defaultTimeout = 60000;
44
+ /** Counter for tracking API call metrics */
45
+ this.apiCallCount = 0;
46
+ this.publicClient = client;
47
+ this.subgraphStudioKey = subgraphStudioKey;
48
+ }
49
+ /**
50
+ * Resets the API call counter for metrics tracking
51
+ *
52
+ * @example
53
+ * ```typescript
54
+ * poolClient.resetMetrics();
55
+ * ```
56
+ */
57
+ resetMetrics() {
58
+ this.apiCallCount = 0;
59
+ }
60
+ /**
61
+ * Gets current metrics for monitoring API usage
62
+ *
63
+ * @returns Object containing current metrics
64
+ *
65
+ * @example
66
+ * ```typescript
67
+ * const metrics = poolClient.getMetrics();
68
+ * console.log(`API calls made: ${metrics.apiCallCount}`);
69
+ * ```
70
+ */
71
+ getMetrics() {
72
+ return {
73
+ apiCallCount: this.apiCallCount,
74
+ };
75
+ }
76
+ /**
77
+ * Fetches data from GraphQL endpoint with retry logic for rate limits
78
+ *
79
+ * @param query - GraphQL query string
80
+ * @param variables - Variables for the GraphQL query
81
+ * @param protocol - Protocol to query
82
+ * @param chainId - Chain ID to query
83
+ * @returns Promise containing the response data
84
+ *
85
+ * @throws {Error} When subgraph endpoint is not available
86
+ * @throws {Error} When rate limit is exceeded after max retries
87
+ * @throws {Error} When GraphQL query times out
88
+ *
89
+ * @internal
90
+ */
91
+ async fetchFromGraph(query, variables, protocol, chainId) {
92
+ try {
93
+ const chainName = chainIdToName(chainId);
94
+ const endpoint = getProtocolSubgraphURL(protocol, chainName, this.subgraphStudioKey);
95
+ if (!endpoint) {
96
+ throw new Error(`No subgraph endpoint available for protocol ${protocol} on chain ${chainName}`);
97
+ }
98
+ const MAX_RETRIES = 3;
99
+ const RETRY_DELAY_MS = 11000;
100
+ const fetchWithRetry = async (retries = 0) => {
101
+ const response = await fetch(endpoint, {
102
+ method: "POST",
103
+ headers: {
104
+ "Content-Type": "application/json",
105
+ },
106
+ body: JSON.stringify({ query, variables }),
107
+ });
108
+ const data = await response.json();
109
+ if (data.error && typeof data.error === "string" && data.error.includes("surpassed your query allowance")) {
110
+ if (retries < MAX_RETRIES) {
111
+ console.warn(`Rate limit hit for ${endpoint}, retrying in ${RETRY_DELAY_MS / 1000}s (attempt ${retries + 1})`);
112
+ await new Promise(res => setTimeout(res, RETRY_DELAY_MS));
113
+ return fetchWithRetry(retries + 1);
114
+ }
115
+ else {
116
+ throw new Error(`Rate limit exceeded after ${MAX_RETRIES} retries: ${data.error}`);
117
+ }
118
+ }
119
+ if (data.error) {
120
+ throw new Error(`GraphQL endpoint error: ${data.error}`);
121
+ }
122
+ if (data.errors) {
123
+ throw new Error(`GraphQL errors: ${JSON.stringify(data.errors)}`);
124
+ }
125
+ return data.data;
126
+ };
127
+ this.apiCallCount++;
128
+ console.log("Total API calls:", this.apiCallCount);
129
+ const timeoutPromise = new Promise((_, reject) => {
130
+ setTimeout(() => reject(new Error("GraphQL query timeout")), this.defaultTimeout);
131
+ });
132
+ const data = await Promise.race([fetchWithRetry(), timeoutPromise]);
133
+ return {
134
+ data: data,
135
+ status: 200,
136
+ success: true,
137
+ };
138
+ }
139
+ catch (error) {
140
+ return {
141
+ data: null,
142
+ status: 500,
143
+ success: false,
144
+ error: error instanceof Error ? error.message : 'Unknown error occurred',
145
+ };
146
+ }
147
+ }
148
+ /**
149
+ * Fetches the top pools for a specific protocol by trading volume
150
+ *
151
+ * @param count - Number of pools to fetch (default: 500)
152
+ * @param protocol - Protocol to fetch pools from
153
+ * @param chainId - Chain ID to fetch pools from
154
+ * @returns Promise containing an array of top pools
155
+ *
156
+ * @example
157
+ * ```typescript
158
+ * // Get top 100 Uniswap V3 pools on Ethereum
159
+ * const topPools = await poolClient.getTopPools(100, Protocol.UniswapV3, 1);
160
+ * if (topPools.success) {
161
+ * console.log(`Found ${topPools.data.length} pools`);
162
+ * }
163
+ * ```
164
+ *
165
+ * @throws {Error} When failed to fetch pools from subgraph
166
+ */
167
+ async getTopPools(count = 500, protocol, chainId) {
168
+ try {
169
+ const isAlgebraPool = isAlgebraProtocol(protocol);
170
+ const query = getTopPoolsQuery(protocol, isAlgebraPool);
171
+ console.log(`[Chain ${chainId}] [Protocol ${protocol}] 📊 Fetching top ${count} pools from the subgraph...`);
172
+ const response = await this.fetchFromGraph(query, { limit: count }, protocol, chainId);
173
+ if (!response.success || !response.data) {
174
+ throw new Error(response.error || 'Failed to fetch pools');
175
+ }
176
+ const pools = response.data.pools || response.data.limitPools || response.data.clPools || [];
177
+ console.log(`[Chain ${chainId}] [Protocol ${protocol}] ✅ Received ${pools.length} pools from the subgraph`);
178
+ // Filter out pools with invalid volumeUSD
179
+ const validPools = pools.filter(pool => {
180
+ const volumeUSD = parseFloat(pool.volumeUSD || pool.volumeUsd || "0");
181
+ return !isNaN(volumeUSD) && volumeUSD > 0;
182
+ });
183
+ console.log(`[Chain ${chainId}] [Protocol ${protocol}] ✅ Found ${validPools.length} valid pools with positive volumeUSD`);
184
+ return {
185
+ data: validPools,
186
+ status: 200,
187
+ success: true,
188
+ };
189
+ }
190
+ catch (error) {
191
+ console.error(`[Chain ${chainId}] [Protocol ${protocol}] Error in getTopPools:`, error);
192
+ return {
193
+ data: null,
194
+ status: 500,
195
+ success: false,
196
+ error: error instanceof Error ? error.message : 'Unknown error occurred',
197
+ };
198
+ }
199
+ }
200
+ /**
201
+ * Fetches detailed information for a specific pool by its ID
202
+ *
203
+ * @param poolId - Pool contract address to fetch
204
+ * @param protocol - Protocol the pool belongs to
205
+ * @param chainId - Chain ID where the pool exists
206
+ * @returns Promise containing pool details or null if not found
207
+ *
208
+ * @example
209
+ * ```typescript
210
+ * // Get specific pool details
211
+ * const poolDetails = await poolClient.getPoolById(
212
+ * '0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640',
213
+ * Protocol.UniswapV3,
214
+ * 1
215
+ * );
216
+ * if (poolDetails.success && poolDetails.data) {
217
+ * console.log(`Pool: ${poolDetails.data.token0.symbol}/${poolDetails.data.token1.symbol}`);
218
+ * }
219
+ * ```
220
+ *
221
+ * @throws {Error} When failed to fetch pool from subgraph
222
+ */
223
+ async getPoolById(poolId, protocol, chainId) {
224
+ try {
225
+ const isAlgebraPool = isAlgebraProtocol(protocol);
226
+ const query = getPoolDetailsQuery(isAlgebraPool, protocol);
227
+ const response = await this.fetchFromGraph(query, { pool: poolId }, protocol, chainId);
228
+ if (!response.success || !response.data) {
229
+ throw new Error(response.error || 'Failed to fetch pool');
230
+ }
231
+ const pool = response.data.pool || response.data.clPool || response.data.limitPool || null;
232
+ return {
233
+ data: pool,
234
+ status: 200,
235
+ success: true,
236
+ };
237
+ }
238
+ catch (error) {
239
+ console.error(`Error fetching pool ${poolId}:`, error);
240
+ return {
241
+ data: null,
242
+ status: 500,
243
+ success: false,
244
+ error: error instanceof Error ? error.message : 'Unknown error occurred',
245
+ };
246
+ }
247
+ }
248
+ /**
249
+ * Fetches pools containing multiple tokens in batches for better performance
250
+ *
251
+ * @param tokenAddresses - Array of token contract addresses
252
+ * @param protocol - Protocol to fetch pools from
253
+ * @param chainId - Chain ID to fetch pools from
254
+ * @param batchSize - Number of tokens to process in each batch (default: 10)
255
+ * @returns Promise containing all pools found for the tokens
256
+ *
257
+ * @example
258
+ * ```typescript
259
+ * // Get pools for multiple tokens
260
+ * const tokenAddresses = [
261
+ * '0xa0b86a33e6f8b07b71c3a39ef77a6b6e8f1b7b7e', // USDC
262
+ * '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2' // WETH
263
+ * ];
264
+ * const pools = await poolClient.fetchPoolsForTokensBatch(
265
+ * tokenAddresses,
266
+ * Protocol.UniswapV3,
267
+ * 1,
268
+ * 5
269
+ * );
270
+ * ```
271
+ *
272
+ * @throws {Error} When batch processing fails
273
+ */
274
+ async fetchPoolsForTokensBatch(tokenAddresses, protocol, chainId, batchSize = 10) {
275
+ try {
276
+ if (tokenAddresses.length === 0) {
277
+ return {
278
+ data: [],
279
+ status: 200,
280
+ success: true,
281
+ };
282
+ }
283
+ console.log(`\n🔍 Batch Pool Fetch Summary:`);
284
+ console.log(`📥 Total tokens to process: ${tokenAddresses.length}`);
285
+ const isAlgebraPool = isAlgebraProtocol(protocol);
286
+ const normalizedAddresses = tokenAddresses.map(addr => addr.toLowerCase());
287
+ // Split into chunks
288
+ const chunkSize = batchSize;
289
+ const addressChunks = [];
290
+ for (let i = 0; i < normalizedAddresses.length; i += chunkSize) {
291
+ addressChunks.push(normalizedAddresses.slice(i, i + chunkSize));
292
+ }
293
+ console.log(`📦 Processing ${addressChunks.length} chunks of max ${chunkSize} tokens each`);
294
+ const allPools = [];
295
+ // Process chunks in parallel
296
+ const results = await Promise.all(addressChunks.map(async (chunk, chunkIndex) => {
297
+ console.log(`\n🔄 Processing chunk ${chunkIndex + 1}/${addressChunks.length} with ${chunk.length} tokens`);
298
+ const chunkResults = await Promise.all(chunk.map(async (token) => {
299
+ try {
300
+ const query = getTokenPoolsQueryByAddress(isAlgebraPool, protocol);
301
+ const queryStartTime = performance.now();
302
+ const response = await this.fetchFromGraph(query, { token }, protocol, chainId);
303
+ const queryTime = performance.now() - queryStartTime;
304
+ console.log(`⏱️ GraphQL query for token ${token.slice(0, 6)}... completed in ${queryTime.toFixed(2)}ms`);
305
+ if (!response.success || !response.data) {
306
+ console.error(`❌ No pools found for token: ${token} on chainId: ${chainId}`);
307
+ return [];
308
+ }
309
+ // Extract pools from different possible response structures
310
+ let pools = [];
311
+ if (response.data.pools) {
312
+ pools = response.data.pools;
313
+ }
314
+ else if (response.data.clPools) {
315
+ pools = response.data.clPools;
316
+ }
317
+ else if (response.data.limitPools) {
318
+ pools = response.data.limitPools;
319
+ }
320
+ else if (response.data.tokenPools) {
321
+ pools = response.data.tokenPools;
322
+ }
323
+ if (pools.length === 0) {
324
+ console.error(`❌ No pools found for token: ${token} on chainId: ${chainId}`);
325
+ return [];
326
+ }
327
+ return pools;
328
+ }
329
+ catch (error) {
330
+ console.error(`❌ Error fetching pools for token: ${token} on chainId: ${chainId}`, error);
331
+ return [];
332
+ }
333
+ }));
334
+ return chunkResults.flat();
335
+ }));
336
+ // Flatten all results
337
+ allPools.push(...results.flat());
338
+ return {
339
+ data: allPools,
340
+ status: 200,
341
+ success: true,
342
+ };
343
+ }
344
+ catch (error) {
345
+ console.error("Error in fetchPoolsForTokensBatch:", error);
346
+ return {
347
+ data: null,
348
+ status: 500,
349
+ success: false,
350
+ error: error instanceof Error ? error.message : 'Unknown error occurred',
351
+ };
352
+ }
353
+ }
354
+ /**
355
+ * Fetches all pools containing a specific token
356
+ *
357
+ * @param tokenAddress - Token contract address
358
+ * @param protocol - Protocol to fetch pools from
359
+ * @param chainId - Chain ID to fetch pools from
360
+ * @returns Promise containing pools that include the specified token
361
+ *
362
+ * @example
363
+ * ```typescript
364
+ * // Get all USDC pools on Uniswap V3
365
+ * const usdcPools = await poolClient.fetchPoolsForToken(
366
+ * '0xa0b86a33e6f8b07b71c3a39ef77a6b6e8f1b7b7e',
367
+ * Protocol.UniswapV3,
368
+ * 1
369
+ * );
370
+ * if (usdcPools.success) {
371
+ * console.log(`Found ${usdcPools.data.length} USDC pools`);
372
+ * }
373
+ * ```
374
+ *
375
+ * @throws {Error} When failed to fetch pools for token
376
+ */
377
+ async fetchPoolsForToken(tokenAddress, protocol, chainId) {
378
+ try {
379
+ const isAlgebraPool = isAlgebraProtocol(protocol);
380
+ const query = getTokenPoolsQueryByAddress(isAlgebraPool, protocol);
381
+ const response = await this.fetchFromGraph(query, { token: tokenAddress.toLowerCase() }, protocol, chainId);
382
+ if (!response.success || !response.data) {
383
+ throw new Error(response.error || 'Failed to fetch pools for token');
384
+ }
385
+ // Extract pools from different possible response structures
386
+ let pools = [];
387
+ if (response.data.pools) {
388
+ pools = response.data.pools;
389
+ }
390
+ else if (response.data.limitPools) {
391
+ pools = response.data.limitPools;
392
+ }
393
+ else if (response.data.tokenPools) {
394
+ pools = response.data.tokenPools;
395
+ }
396
+ else if (response.data.clPools) {
397
+ pools = response.data.clPools;
398
+ }
399
+ return {
400
+ data: pools,
401
+ status: 200,
402
+ success: true,
403
+ };
404
+ }
405
+ catch (error) {
406
+ console.error(`Error fetching pools for token ${tokenAddress}:`, error);
407
+ return {
408
+ data: null,
409
+ status: 500,
410
+ success: false,
411
+ error: error instanceof Error ? error.message : 'Unknown error occurred',
412
+ };
413
+ }
414
+ }
415
+ /**
416
+ * Filters pools based on validity criteria such as tick range and liquidity
417
+ *
418
+ * @param pools - Array of pools to filter
419
+ * @returns Array of valid pools that meet the criteria
420
+ *
421
+ * @example
422
+ * ```typescript
423
+ * const validPools = poolClient.filterValidPools(allPools);
424
+ * console.log(`Filtered down to ${validPools.length} valid pools`);
425
+ * ```
426
+ */
427
+ filterValidPools(pools) {
428
+ return pools.filter(pool => {
429
+ // Check for required fields
430
+ if (!pool.id || !pool.tick || !pool.liquidity) {
431
+ return false;
432
+ }
433
+ // Parse values
434
+ const tick = parseInt(pool.tick);
435
+ const liquidity = parseFloat(pool.liquidity);
436
+ // Check for valid tick range and liquidity
437
+ const TICK_MIN = -887272;
438
+ const TICK_MAX = 887272;
439
+ const TICK_EDGE_THRESHOLD = 1;
440
+ if (isNaN(tick) ||
441
+ isNaN(liquidity) ||
442
+ liquidity <= 0 ||
443
+ tick <= TICK_MIN + TICK_EDGE_THRESHOLD ||
444
+ tick >= TICK_MAX - TICK_EDGE_THRESHOLD) {
445
+ return false;
446
+ }
447
+ return true;
448
+ });
449
+ }
450
+ }
451
+ //# sourceMappingURL=PoolClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PoolClient.js","sourceRoot":"","sources":["../../../src/base/PoolClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EACL,aAAa,EACb,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAmH/G;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,UAAW,SAAQ,cAAc;IAU5C;;;;;;;;;;OAUG;IACH,YACE,MAAmC,EACnC,oBAA4B,EAAE;QAE9B,KAAK,CAAC,MAAM,CAAC,CAAC;QAtBhB,0DAA0D;QACzC,mBAAc,GAAW,KAAK,CAAC;QAChD,4CAA4C;QACpC,iBAAY,GAAW,CAAC,CAAC;QAoB/B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;QAC3B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACI,YAAY;QACjB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACI,UAAU;QACf,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACK,KAAK,CAAC,cAAc,CAC1B,KAAa,EACb,SAAkC,EAClC,QAAkB,EAClB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACzC,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,EAAE,SAAkB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAE9F,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,+CAA+C,QAAQ,aAAa,SAAS,EAAE,CAAC,CAAC;YACnG,CAAC;YAED,MAAM,WAAW,GAAG,CAAC,CAAC;YACtB,MAAM,cAAc,GAAG,KAAK,CAAC;YAE7B,MAAM,cAAc,GAAG,KAAK,EAAE,OAAO,GAAG,CAAC,EAAc,EAAE;gBACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;oBACrC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP,cAAc,EAAE,kBAAkB;qBACnC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;iBAC3C,CAAC,CAAC;gBAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAsE,CAAC;gBAEvG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,gCAAgC,CAAC,EAAE,CAAC;oBAC1G,IAAI,OAAO,GAAG,WAAW,EAAE,CAAC;wBAC1B,OAAO,CAAC,IAAI,CAAC,sBAAsB,QAAQ,iBAAiB,cAAc,GAAG,IAAI,cAAc,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;wBAC/G,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;wBAC1D,OAAO,cAAc,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;oBACrC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,aAAa,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACrF,CAAC;gBACH,CAAC;gBAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC3D,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACpE,CAAC;gBAED,OAAO,IAAI,CAAC,IAAI,CAAC;YACnB,CAAC,CAAC;YAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAEnD,MAAM,cAAc,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;gBACtD,UAAU,CACR,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,EAChD,IAAI,CAAC,cAAc,CACpB,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;YAEpE,OAAO;gBACL,IAAI,EAAE,IAAS;gBACf,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,GAAG,EACnB,QAAkB,EAClB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAExD,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,eAAe,QAAQ,qBAAqB,KAAK,6BAA6B,CAAC,CAAC;YAE7G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CACxC,KAAK,EACL,EAAE,KAAK,EAAE,KAAK,EAAE,EAChB,QAAQ,EACR,OAAO,CACR,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,uBAAuB,CAAC,CAAC;YAC7D,CAAC;YAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;YAE7F,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,eAAe,QAAQ,gBAAgB,KAAK,CAAC,MAAM,0BAA0B,CAAC,CAAC;YAE5G,0CAA0C;YAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACrC,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC;gBACtE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,eAAe,QAAQ,aAAa,UAAU,CAAC,MAAM,sCAAsC,CAAC,CAAC;YAE1H,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,UAAU,OAAO,eAAe,QAAQ,yBAAyB,EAAE,KAAK,CAAC,CAAC;YACxF,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,WAAW,CACtB,MAAc,EACd,QAAkB,EAClB,OAAe;QAEf,IAAI,CAAC;YAEH,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAG3D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CACxC,KAAK,EACL,EAAE,IAAI,EAAE,MAAM,EAAE,EAChB,QAAQ,EACR,OAAO,CACR,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,sBAAsB,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;YAG3F,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,uBAAuB,MAAM,GAAG,EAAE,KAAK,CAAC,CAAC;YACvD,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,wBAAwB,CACnC,cAAwB,EACxB,QAAkB,EAClB,OAAe,EACf,YAAoB,EAAE;QAEtB,IAAI,CAAC;YACH,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,+BAA+B,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;YAEpE,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,mBAAmB,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAE3E,oBAAoB;YACpB,MAAM,SAAS,GAAG,SAAS,CAAC;YAC5B,MAAM,aAAa,GAAG,EAAE,CAAC;YACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;gBAC/D,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;YAClE,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,iBAAiB,aAAa,CAAC,MAAM,kBAAkB,SAAS,cAAc,CAAC,CAAC;YAE5F,MAAM,QAAQ,GAAsB,EAAE,CAAC;YAEvC,6BAA6B;YAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC5C,OAAO,CAAC,GAAG,CAAC,yBAAyB,UAAU,GAAG,CAAC,IAAI,aAAa,CAAC,MAAM,SAAS,KAAK,CAAC,MAAM,SAAS,CAAC,CAAC;gBAE3G,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACxB,IAAI,CAAC;wBACH,MAAM,KAAK,GAAG,2BAA2B,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBACnE,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;wBAEzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CACxC,KAAK,EACL,EAAE,KAAK,EAAE,EACT,QAAQ,EACR,OAAO,CACR,CAAC;wBAEF,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,cAAc,CAAC;wBACrD,OAAO,CAAC,GAAG,CAAC,8BAA8B,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,oBAAoB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;wBAEzG,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;4BACxC,OAAO,CAAC,KAAK,CAAC,+BAA+B,KAAK,gBAAgB,OAAO,EAAE,CAAC,CAAC;4BAC7E,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAED,4DAA4D;wBAC5D,IAAI,KAAK,GAAsB,EAAE,CAAC;wBAClC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;4BACxB,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;wBAC9B,CAAC;6BAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;4BACjC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;wBAChC,CAAC;6BAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;wBACnC,CAAC;6BAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;wBACnC,CAAC;wBAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACvB,OAAO,CAAC,KAAK,CAAC,+BAA+B,KAAK,gBAAgB,OAAO,EAAE,CAAC,CAAC;4BAC7E,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAED,OAAO,KAAK,CAAC;oBACf,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,OAAO,CAAC,KAAK,CAAC,qCAAqC,KAAK,gBAAgB,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;wBAC1F,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC,CAAC,CACH,CAAC;gBAEF,OAAO,YAAY,CAAC,IAAI,EAAE,CAAC;YAC7B,CAAC,CAAC,CACH,CAAC;YAEF,sBAAsB;YACtB,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAEjC,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YAC3D,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,kBAAkB,CAC7B,YAAoB,EACpB,QAAkB,EAClB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,2BAA2B,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAEnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CACxC,KAAK,EACL,EAAE,KAAK,EAAE,YAAY,CAAC,WAAW,EAAE,EAAE,EACrC,QAAQ,EACR,OAAO,CACR,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,iCAAiC,CAAC,CAAC;YACvE,CAAC;YAED,4DAA4D;YAC5D,IAAI,KAAK,GAAsB,EAAE,CAAC;YAClC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACxB,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;YAC9B,CAAC;iBAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YACnC,CAAC;iBAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YACnC,CAAC;iBAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;YAChC,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,kCAAkC,YAAY,GAAG,EAAE,KAAK,CAAC,CAAC;YACxE,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,gBAAgB,CAAC,KAAiB;QACvC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACzB,4BAA4B;YAC5B,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC9C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,eAAe;YACf,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE7C,2CAA2C;YAC3C,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC;YACzB,MAAM,QAAQ,GAAG,MAAM,CAAC;YACxB,MAAM,mBAAmB,GAAG,CAAC,CAAC;YAE9B,IACE,KAAK,CAAC,IAAI,CAAC;gBACX,KAAK,CAAC,SAAS,CAAC;gBAChB,SAAS,IAAI,CAAC;gBACd,IAAI,IAAI,QAAQ,GAAG,mBAAmB;gBACtC,IAAI,IAAI,QAAQ,GAAG,mBAAmB,EACtC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -1,16 +1,17 @@
1
1
  import { SubgraphClient } from './base/SubgraphClient';
2
2
  import { VaultClient } from './base/VaultClient';
3
3
  import { SmartRewardsClient } from './base/SmartRewardClient';
4
+ import { PoolClient } from './base/PoolClient';
4
5
  import { StakingClient } from './base/StakingClient';
5
6
  /**
6
7
  * The main client for interacting with the Steer Protocol.
7
- * This client provides access to vault operations and smart rewards functionality.
8
+ * This client provides access to vault operations, smart rewards functionality, pool data, and staking.
8
9
  *
9
10
  * @example
10
11
  * ```typescript
11
12
  * import { createPublicClient, createWalletClient, http } from 'viem';
12
13
  * import { mainnet } from 'viem/chains';
13
- * import { SteerClient } from '@steerprotocol/sdk';
14
+ * import { SteerClient, Protocol } from '@steerprotocol/sdk';
14
15
  *
15
16
  * // Create viem clients
16
17
  * const publicClient = createPublicClient({
@@ -27,7 +28,8 @@ import { StakingClient } from './base/StakingClient';
27
28
  * const steerClient = new SteerClient({
28
29
  * environment: 'production',
29
30
  * client: publicClient,
30
- * walletClient: walletClient
31
+ * walletClient: walletClient,
32
+ * subgraphStudioKey: 'your-subgraph-studio-key' // Optional
31
33
  * });
32
34
  *
33
35
  * // Use vault operations
@@ -36,6 +38,13 @@ import { StakingClient } from './base/StakingClient';
36
38
  * // Use rewards functionality
37
39
  * const campaigns = await steerClient.rewards.getCampaigns(1);
38
40
  * const summary = await steerClient.rewards.getRewardSummary(userAddress, chainId);
41
+ *
42
+ * // Use pool data functionality
43
+ * const topPools = await steerClient.pools.getTopPools(100, Protocol.UniswapV3, 1);
44
+ * const poolDetails = await steerClient.pools.getPoolById(poolId, Protocol.UniswapV3, 1);
45
+ *
46
+ * // Use staking functionality
47
+ * const stakingPools = await steerClient.staking.getStakingPools(1);
39
48
  * ```
40
49
  *
41
50
  * @group Client
@@ -43,7 +52,22 @@ import { StakingClient } from './base/StakingClient';
43
52
  export class SteerClient extends SubgraphClient {
44
53
  /**
45
54
  * Creates a new instance of the SteerClient
55
+ *
46
56
  * @param config - The configuration object for the client
57
+ * @param config.environment - The environment to use ('production' or 'development')
58
+ * @param config.client - The viem client for blockchain interactions
59
+ * @param config.walletClient - Optional wallet client for write operations
60
+ * @param config.subgraphStudioKey - Optional Subgraph Studio API key for higher rate limits
61
+ *
62
+ * @example
63
+ * ```typescript
64
+ * const steerClient = new SteerClient({
65
+ * environment: 'production',
66
+ * client: publicClient,
67
+ * walletClient: walletClient,
68
+ * subgraphStudioKey: 'your-key'
69
+ * });
70
+ * ```
47
71
  */
48
72
  constructor(config) {
49
73
  super(config.client);
@@ -51,6 +75,7 @@ export class SteerClient extends SubgraphClient {
51
75
  // Initialize clients based on provided configuration
52
76
  const publicClient = config.client;
53
77
  const walletClient = config.walletClient;
78
+ const subgraphStudioKey = config.subgraphStudioKey || '';
54
79
  // Initialize vault client with both public and wallet clients if available
55
80
  this.vaults = new VaultClient(walletClient ?
56
81
  { ...publicClient, ...walletClient } :
@@ -59,6 +84,10 @@ export class SteerClient extends SubgraphClient {
59
84
  this.staking = new StakingClient(walletClient ?
60
85
  { ...publicClient, ...walletClient } :
61
86
  publicClient);
87
+ // Initialize pool client with both public and wallet clients if available
88
+ this.pools = new PoolClient(walletClient ?
89
+ { ...publicClient, ...walletClient } :
90
+ publicClient, subgraphStudioKey);
62
91
  // Initialize rewards client with both public and wallet clients if available
63
92
  if (walletClient) {
64
93
  this.rewards = new SmartRewardsClient(publicClient, walletClient, this.environment === 'production' ? 'production' : 'development');
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,OAAO,WAAY,SAAQ,cAAc;IAc7C;;;OAGG;IACH,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,YAAY,CAAC;QAEtD,qDAAqD;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAsB,CAAC;QACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAEzC,2EAA2E;QAC3E,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;YAC1C,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAiC,CAAC,CAAC;YACrE,YAAsD,CACvD,CAAC;QAEF,6EAA6E;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAiC,CAAC,CAAC;YACrE,YAAsD,CACvD,CAAC;QAEF,6EAA6E;QAC7E,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CACnC,YAAY,EACZ,YAAY,EACZ,IAAI,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CACjE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,0EAA0E;YAC1E,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CACnC,YAAY,EACZ,YAAuC,EAAE,qCAAqC;YAC9E,IAAI,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CACjE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;QAEhD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO;YACL,IAAI,EAAE,WAA2B;YACjC,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,OAAO,WAAY,SAAQ,cAAc;IAiB7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,YAAY,CAAC;QAEtD,qDAAqD;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAsB,CAAC;QACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC;QAEzD,2EAA2E;QAC3E,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;YAC1C,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAiC,CAAC,CAAC;YACrE,YAAsD,CACvD,CAAC;QAEF,6EAA6E;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAiC,CAAC,CAAC;YACrE,YAAsD,CACvD,CAAC;QAEF,0EAA0E;QAC1E,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC;YACxC,EAAE,GAAG,YAAY,EAAE,GAAG,YAAY,EAAiC,CAAC,CAAC;YACrE,YAAsD,EACtD,iBAAiB,CAClB,CAAC;QAEF,6EAA6E;QAC7E,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CACnC,YAAY,EACZ,YAAY,EACZ,IAAI,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CACjE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,0EAA0E;YAC1E,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CACnC,YAAY,EACZ,YAAuC,EAAE,qCAAqC;YAC9E,IAAI,CAAC,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CACjE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;QAEhD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO;YACL,IAAI,EAAE,WAA2B;YACjC,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF"}
package/dist/esm/index.js CHANGED
@@ -4,6 +4,7 @@ export * from './types';
4
4
  export * from './base/VaultClient';
5
5
  export * from './base/SubgraphClient';
6
6
  export * from './base/StakingClient';
7
+ export * from './base/PoolClient';
7
8
  export * from './const';
8
9
  /**
9
10
  * @packageDocumentation
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,SAAS,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG"}