@steerprotocol/sdk 1.31.0 → 2.0.1

package/src/utils/PoolQueryAdapter.ts

@@ -1,943 +0,0 @@
-/**
- * @fileoverview Pool Query Adapter - Provides GraphQL queries for different DEX protocols
- * @module PoolQueryAdapter
- */
-
-import { isShadowProtocol, Protocol } from '../const/index.js';
-
-/**
- * GraphQL query to fetch top pools from Shadow protocol by volume
- * Returns pools ordered by volumeUSD in descending order
- * @internal
- */
-const FETCH_TOP_POOLS_SHADOW = `
-query {
-	clPools(first: $limit, orderBy: volumeUSD, orderDirection: desc, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from Uniswap V3 protocol by volume
- * Returns pools ordered by volumeUSD in descending order
- * @internal
- */
-const FETCH_TOP_POOLS_UNISWAP = `
-query {
-	pools(first: $limit, orderBy: volumeUSD, orderDirection: desc, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from Thruster protocol by TVL
- * Returns pools ordered by totalValueLockedETH in descending order
- * @internal
- */
-const FETCH_TOP_POOLS_THRUSTER = `
-query {
-	pools(first: 500, orderBy: totalValueLockedETH, orderDirection: desc, subgraphError: allow){
-		id
-    volumeUSD
-    totalValueLockedETH
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from PoolShark protocol by volume
- * Returns limit pools ordered by volumeUsd in descending order
- * @internal
- */
-const FETCH_POOLSHARK_TOP_POOLS = `
-{
-  limitPools(first: 500, orderBy: volumeUsd, orderDirection: desc, subgraphError: allow) {
-    id
-    volumeUsd
-    totalValueLockedEth
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier {
-      id
-    }
-  }
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from Algebra-based protocols by volume
- * Returns pools ordered by volumeUSD in descending order
- * @internal
- */
-const FETCH_TOP_POOLS_ALGEBRA = `
-query {
-	pools(first: 500, orderBy: volumeUSD, orderDirection: desc, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from Ocelex protocol
- * Returns first 500 pools with basic volume and liquidity data
- * @internal
- */
-const FETCH_TOP_POOLS_OCELEX = `
-query {
-	pools(first: 500){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from Kyo protocol by volume
- * Returns pools ordered by volumeUSD in descending order with fee information
- * @internal
- */
-const FETCH_TOP_POOLS_KYO = `
-query {
-	pools(first: 500, orderBy: volumeUSD, orderDirection: desc, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    fee
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch top pools from ArthSwap protocol by volume
- * Returns pools ordered by volumeUSD_DESC with fee tier information
- * @internal
- */
-const FETCH_ARTHSWAP_TOP_POOLS = `
-{
-  pools(limit:500, orderBy: volumeUSD_DESC) {
-    id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    tick
-    liquidity
-  }
-}
-`;
-
-/**
- * Returns the appropriate GraphQL query for fetching top pools based on protocol type
- * 
- * @param protocol - The DEX protocol to fetch pools from
- * @param isAlgebraPool - Whether the protocol is based on Algebra
- * @returns GraphQL query string for fetching top pools
- * 
- * @example
- * ```typescript
- * const query = getTopPoolsQuery(Protocol.UniswapV3, false);
- * // Returns FETCH_TOP_POOLS_UNISWAP query
- * ```
- */
-export const getTopPoolsQuery = (protocol: Protocol, isAlgebraPool: boolean): string => {
-  if (protocol === Protocol.ArthSwap || protocol === Protocol.ThickV2) {
-    return FETCH_ARTHSWAP_TOP_POOLS;
-  } else if (protocol === Protocol.Thruster) {
-    return FETCH_TOP_POOLS_THRUSTER;
-  } else if (protocol === Protocol.Ocelex) {
-    return FETCH_TOP_POOLS_OCELEX;
-  } else if (protocol === Protocol.PoolShark) {
-    return FETCH_POOLSHARK_TOP_POOLS;
-  } else if (protocol === Protocol.Kyo) {
-    return FETCH_TOP_POOLS_KYO;
-  } else if (isShadowProtocol(protocol)) {
-    return FETCH_TOP_POOLS_SHADOW;
-  } else if (isAlgebraPool) {
-    return FETCH_TOP_POOLS_ALGEBRA;
-  } else {
-    return FETCH_TOP_POOLS_UNISWAP;
-  }
-};
-
-// --- Token Pool Queries for fetchPoolsForTokens ---
-
-/**
- * GraphQL query to fetch pools containing a specific token from Algebra-based protocols
- * Returns up to 50 pools ordered by volume that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_ALGEBRA = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from Ocelex protocol
- * Returns up to 50 pools that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_OCELEX = `
-query pools($token: ID!) {
-	pools(first: 50, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from ArthSwap protocol
- * Returns up to 50 pools ordered by volume that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_ARTHSWAP = `
-query pools($token: String!) {
-	pools(limit: 50, orderBy: volumeUSD_DESC, where: {
-    OR: [
-      {
-				token0Id_eq: $token
-      }
-      {
-        token1Id_eq: $token
-      }
-    ]
-  }){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from Uniswap V3 protocol
- * Returns up to 50 pools ordered by volume that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_UNISWAP = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from Shadow protocol
- * Returns up to 50 CL pools ordered by volume that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_SHADOW = `
-query pools($token: String!) {
-	clPools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from PoolShark protocol
- * Returns up to 50 limit pools ordered by TVL that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_POOLSHARK = `
-query pools($token: String!) {
-	limitPools(first: 50, orderBy: totalValueLockedEth, orderDirection: desc, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }, subgraphError: allow){
-		id
-    volumeUsd
-    totalValueLockedEth
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier {
-      id
-    }
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools where specified token is token0 from Lynex protocol
- * Returns up to 50 pools ordered by volume where token is the first token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_LYNEX_TOKEN0 = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    token0: $token
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools where specified token is token1 from Lynex protocol
- * Returns up to 50 pools ordered by volume where token is the second token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_LYNEX_TOKEN1 = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    token1: $token
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools where specified token is token0 from Thruster protocol
- * Returns up to 50 pools ordered by TVL where token is the first token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_THRUSTER_TOKEN0 = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: totalValueLockedETH, orderDirection: desc, where: {
-		token0: $token
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    totalValueLockedETH
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools where specified token is token1 from Thruster protocol
- * Returns up to 50 pools ordered by TVL where token is the second token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_THRUSTER_TOKEN1 = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: totalValueLockedETH, orderDirection: desc, where: {
-		token1: $token
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    totalValueLockedETH
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * GraphQL query to fetch pools containing a specific token from Kyo protocol
- * Returns up to 50 pools ordered by volume that contain the specified token
- * @internal
- */
-export const FETCH_TOKEN_POOLS_KYO = `
-query pools($token: String!) {
-	pools(first: 50, orderBy: volumeUSD, orderDirection: desc, where: {
-    or: [
-      {
-				token0: $token
-      }
-      {
-        token1: $token
-      }
-    ]
-  }, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    fee
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`;
-
-/**
- * Returns the appropriate GraphQL query for fetching pools containing a specific token
- * 
- * @param isAlgebraPool - Whether the protocol is based on Algebra
- * @param protocol - The DEX protocol to fetch pools from
- * @returns GraphQL query string for fetching token pools
- * 
- * @example
- * ```typescript
- * const query = getTokenPoolsQueryByAddress(false, Protocol.UniswapV3);
- * // Returns FETCH_TOKEN_POOLS_UNISWAP query
- * ```
- */
-export const getTokenPoolsQueryByAddress = (isAlgebraPool: boolean, protocol: Protocol) => {
-  if (isAlgebraPool) {
-    if (protocol === Protocol.Ocelex) {
-      return FETCH_TOKEN_POOLS_OCELEX;
-    }
-    return FETCH_TOKEN_POOLS_ALGEBRA;
-  } else if (protocol === Protocol.ArthSwap || protocol === Protocol.ThickV2) {
-    return FETCH_TOKEN_POOLS_ARTHSWAP;
-  } else if (protocol === Protocol.PoolShark) {
-    return FETCH_TOKEN_POOLS_POOLSHARK;
-  } else if (protocol === Protocol.Kyo) {
-    return FETCH_TOKEN_POOLS_KYO;
-  } else if (isShadowProtocol(protocol)) {
-    return FETCH_TOKEN_POOLS_SHADOW;
-  } else {
-    return FETCH_TOKEN_POOLS_UNISWAP;
-  }
-};
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from Algebra-based protocols
- * Returns pool details including tokens, volume, tick, and liquidity
- * @internal
- */
-const FETCH_POOL_DETAILS_ALGEBRA = `
-query pools($pool: String! ) {
-	pool(id: $pool, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from Ocelex protocol
- * Returns pool details including tokens, volume, tick, and liquidity
- * @internal
- */
-const FETCH_POOL_DETAILS_OCELEX = `
-query pools($pool: ID!) {
-	pool(id: $pool){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from Uniswap V3 protocol
- * Returns comprehensive pool details including fees, TVL, and volume data
- * @internal
- */
-const FETCH_POOL_DETAILS_UNISWAP = `
-query pools($pool: String! ) {
-	pool(id: $pool, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    feeTier
-    totalValueLockedETH
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from Shadow protocol
- * Returns CL pool details including tokens, volume, tick, and liquidity
- * @internal
- */
-const FETCH_POOL_DETAILS_SHADOW = `
-query pools($pool: String! ) {
-	clPool(id: $pool, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    feeTier
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from PoolShark protocol
- * Returns limit pool details including tokens, volume, and fee information
- * @internal
- */
-const FETCH_POOL_DETAILS_POOLSHARK = `
-query pools($pool: String! ) {
-	limitPools(where: {id: $pool}){
-		id
-    volumeUsd
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    feeTier {
-      id
-    }
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from ArthSwap protocol
- * Returns pool details including tokens, volume, fee tier, and liquidity
- * @internal
- */
-const FETCH_POOL_DETAILS_ARTHSWAP = `
-query pools($pool: String! ) {
-	pools(where: {id_eq: $pool}){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-    }
-    token1 {
-      id
-      name
-      symbol
-    }
-    feeTier
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * GraphQL query to fetch detailed information for a specific pool from Kyo protocol
- * Returns pool details including tokens, volume, fee, and liquidity with decimals
- * @internal
- */
-const FETCH_POOL_DETAILS_KYO = `
-query pools($pool: String! ) {
-	pool(id: $pool, subgraphError: allow){
-		id
-    volumeUSD
-    token0 {
-      id
-      name
-      symbol
-      decimals
-    }
-    token1 {
-      id
-      name
-      symbol
-      decimals
-    }
-    fee
-    volumeToken0
-    volumeToken1
-    tick
-    liquidity
-	}
-}
-`
-
-/**
- * Returns the appropriate GraphQL query for fetching detailed pool information
- * 
- * @param isAlgebraPool - Whether the protocol is based on Algebra
- * @param protocol - The DEX protocol to fetch pool details from (optional)
- * @returns GraphQL query string for fetching pool details
- * 
- * @example
- * ```typescript
- * const query = getPoolDetailsQuery(false, Protocol.UniswapV3);
- * // Returns FETCH_POOL_DETAILS_UNISWAP query
- * ```
- */
-export const getPoolDetailsQuery = (isAlgebraPool: boolean, protocol?: Protocol) => {
-    if (protocol === Protocol.ArthSwap || protocol === Protocol.ThickV2) {
-      return FETCH_POOL_DETAILS_ARTHSWAP
-    } else if (protocol === Protocol.Ocelex) {
-      return FETCH_POOL_DETAILS_OCELEX
-    } else if (protocol === Protocol.PoolShark) {
-      return FETCH_POOL_DETAILS_POOLSHARK
-    } else if (protocol === Protocol.Kyo) {
-      return FETCH_POOL_DETAILS_KYO;
-    } else if (protocol && isShadowProtocol(protocol)) {
-      return FETCH_POOL_DETAILS_SHADOW;
-    } else if (isAlgebraPool) {
-      return FETCH_POOL_DETAILS_ALGEBRA;
-    } else {
-      return FETCH_POOL_DETAILS_UNISWAP
-    }
-  }