levr-sdk 0.0.1 → 0.1.0

package/dist/esm/pool-key.js

@@ -0,0 +1,152 @@
+import { encodeAbiParameters, keccak256, zeroAddress } from "viem";
+import { StateView } from "./abis/index.js";
+import { UNISWAP_V4_STATE_VIEW } from "./constants.js";
+/**
+ * @description Sort two token addresses for pool key (currency0 < currency1)
+ */
+export const sortTokens = (tokenA, tokenB) => {
+    return tokenA.toLowerCase() < tokenB.toLowerCase() ? [tokenA, tokenB] : [tokenB, tokenA];
+};
+/**
+ * @description Default pool configuration
+ * 0.3% fee tier is the most common on Uniswap
+ */
+export const DEFAULT_POOL_CONFIG = {
+    fee: 3000, // 0.3% fee tier (most common)
+    tickSpacing: 60, // Corresponds to 0.3% fee tier
+    hooks: zeroAddress, // No hooks by default
+};
+/**
+ * @description Create a pool key for two tokens
+ * @param token0 First token address
+ * @param token1 Second token address
+ * @param fee Fee tier (in hundredths of a bip, e.g. 3000 = 0.3%). Defaults to 3000 (0.3%)
+ * @param tickSpacing Tick spacing. Defaults to 60 (for 0.3% fee tier)
+ * @param hooks Hooks address. Defaults to zero address (no hooks)
+ * @returns Properly sorted PoolKey
+ */
+export const createPoolKey = (token0, token1, fee = DEFAULT_POOL_CONFIG.fee, tickSpacing = DEFAULT_POOL_CONFIG.tickSpacing, hooks = DEFAULT_POOL_CONFIG.hooks) => {
+    const [currency0, currency1] = sortTokens(token0, token1);
+    return {
+        currency0,
+        currency1,
+        fee,
+        tickSpacing,
+        hooks,
+    };
+};
+/**
+ * @description Calculate pool ID from pool key (keccak256 of abi.encode(PoolKey))
+ * @param poolKey Pool key
+ * @returns Pool ID as bytes32
+ */
+export const getPoolId = (poolKey) => {
+    return keccak256(encodeAbiParameters([
+        {
+            type: "tuple",
+            components: [
+                { name: "currency0", type: "address" },
+                { name: "currency1", type: "address" },
+                { name: "fee", type: "uint24" },
+                { name: "tickSpacing", type: "int24" },
+                { name: "hooks", type: "address" },
+            ],
+        },
+    ], [poolKey]));
+};
+/**
+ * @description Common fee tiers and their corresponding tick spacings
+ * Ordered by preference: 0.3% is most common for major pairs, then 0.05%, then 1%
+ * From Uniswap V4 documentation
+ */
+export const COMMON_FEE_TIERS = [
+    { fee: 3000, tickSpacing: 60 }, // 0.3% - Most common for major pairs like WETH/USDC
+    { fee: 500, tickSpacing: 10 }, // 0.05%
+    { fee: 10000, tickSpacing: 200 }, // 1%
+];
+/**
+ * @description Discover an existing pool by trying common fee tiers
+ * @param params Discovery parameters
+ * @returns Pool data if found, null otherwise
+ *
+ * @remarks
+ * This function tries to find an initialized pool by:
+ * 1. Trying common fee tiers (0.05%, 0.3%, 1%)
+ * 2. Querying StateView contract to check if pool exists and has liquidity
+ * 3. Returning the first valid pool found
+ *
+ * Uses Uniswap V4's StateView contract to fetch pool state:
+ * - getSlot0(): sqrtPriceX96, tick, protocol/LP fees
+ * - getLiquidity(): pool liquidity
+ *
+ * @example
+ * ```typescript
+ * const pool = await discoverPool({
+ *   publicClient,
+ *   token0: WETH_ADDRESS,
+ *   token1: USDC_ADDRESS,
+ * })
+ * if (pool) {
+ *   console.log('Found pool:', pool.poolKey)
+ *   console.log('Liquidity:', pool.liquidity)
+ * }
+ * ```
+ */
+export const discoverPool = async ({ publicClient, token0, token1, hooks = zeroAddress, feeTiers = COMMON_FEE_TIERS, }) => {
+    const chainId = publicClient.chain?.id;
+    if (!chainId)
+        throw new Error("Chain ID not found on public client");
+    const stateViewAddress = UNISWAP_V4_STATE_VIEW(chainId);
+    if (!stateViewAddress) {
+        throw new Error(`StateView address not found for chain ID ${chainId}`);
+    }
+    // Check ALL fee tiers and select the most liquid pool
+    let bestPool = null;
+    let maxLiquidity = 0n;
+    for (const { fee, tickSpacing } of feeTiers) {
+        try {
+            const poolKey = createPoolKey(token0, token1, fee, tickSpacing, hooks);
+            const poolId = getPoolId(poolKey);
+            // Query pool state from StateView contract
+            const [slot0Result, liquidityResult] = await Promise.all([
+                publicClient.readContract({
+                    address: stateViewAddress,
+                    abi: StateView,
+                    functionName: "getSlot0",
+                    args: [poolId],
+                }),
+                publicClient.readContract({
+                    address: stateViewAddress,
+                    abi: StateView,
+                    functionName: "getLiquidity",
+                    args: [poolId],
+                }),
+            ]);
+            const [sqrtPriceX96, tick] = slot0Result;
+            const liquidity = liquidityResult;
+            // In V4, getLiquidity() returns current tick liquidity which can be 0
+            // even if pool has liquidity in other ticks. Check if pool is initialized by sqrtPrice
+            const poolInitialized = sqrtPriceX96 > 0n;
+            // Select pool with most liquidity
+            if (poolInitialized && liquidity > maxLiquidity) {
+                maxLiquidity = liquidity;
+                bestPool = {
+                    poolKey,
+                    sqrtPriceX96,
+                    liquidity,
+                    tick: Number(tick),
+                };
+            }
+        }
+        catch (error) {
+            // Pool doesn't exist or error querying, try next fee tier
+            continue;
+        }
+    }
+    return bestPool;
+};
+export const findLiquidPool = async (params) => {
+    const pool = await discoverPool(params);
+    return pool?.poolKey ?? null;
+};
+//# sourceMappingURL=pool-key.js.map

package/dist/esm/pool-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool-key.js","sourceRoot":"","sources":["../../src/pool-key.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,MAAM,CAAA;AAElE,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAGnD;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,MAAqB,EACrB,MAAqB,EACW,EAAE;IAClC,OAAO,MAAM,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAC1F,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,GAAG,EAAE,IAAI,EAAE,8BAA8B;IACzC,WAAW,EAAE,EAAE,EAAE,+BAA+B;IAChD,KAAK,EAAE,WAAW,EAAE,sBAAsB;CAClC,CAAA;AAEV;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAqB,EACrB,MAAqB,EACrB,MAAc,mBAAmB,CAAC,GAAG,EACrC,cAAsB,mBAAmB,CAAC,WAAW,EACrD,QAAuB,mBAAmB,CAAC,KAAK,EACvC,EAAE;IACX,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzD,OAAO;QACL,SAAS;QACT,SAAS;QACT,GAAG;QACH,WAAW;QACX,KAAK;KACN,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAiB,EAAE;IAC3D,OAAO,SAAS,CACd,mBAAmB,CACjB;QACE;YACE,IAAI,EAAE,OAAO;YACb,UAAU,EAAE;gBACV,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;gBACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;gBACtC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC/B,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE;gBACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;aACnC;SACF;KACF,EACD,CAAC,OAAO,CAAC,CACV,CACF,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,oDAAoD;IACpF,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,QAAQ;IACvC,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,KAAK;CAC/B,CAAA;AAuBV;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,EACjC,YAAY,EACZ,MAAM,EACN,MAAM,EACN,KAAK,GAAG,WAAW,EACnB,QAAQ,GAAG,gBAAgB,GACR,EAAmC,EAAE;IACxD,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,CAAA;IACtC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IAEpE,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAA;IACvD,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,EAAE,CAAC,CAAA;IACxE,CAAC;IAED,sDAAsD;IACtD,IAAI,QAAQ,GAA2B,IAAI,CAAA;IAC3C,IAAI,YAAY,GAAG,EAAE,CAAA;IAErB,KAAK,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;YACtE,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;YAEjC,2CAA2C;YAC3C,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACvD,YAAY,CAAC,YAAY,CAAC;oBACxB,OAAO,EAAE,gBAAgB;oBACzB,GAAG,EAAE,SAAS;oBACd,YAAY,EAAE,UAAU;oBACxB,IAAI,EAAE,CAAC,MAAM,CAAC;iBACf,CAAC;gBACF,YAAY,CAAC,YAAY,CAAC;oBACxB,OAAO,EAAE,gBAAgB;oBACzB,GAAG,EAAE,SAAS;oBACd,YAAY,EAAE,cAAc;oBAC5B,IAAI,EAAE,CAAC,MAAM,CAAC;iBACf,CAAC;aACH,CAAC,CAAA;YAEF,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,WAAW,CAAA;YACxC,MAAM,SAAS,GAAG,eAAe,CAAA;YAEjC,sEAAsE;YACtE,uFAAuF;YACvF,MAAM,eAAe,GAAG,YAAY,GAAG,EAAE,CAAA;YAEzC,kCAAkC;YAClC,IAAI,eAAe,IAAI,SAAS,GAAG,YAAY,EAAE,CAAC;gBAChD,YAAY,GAAG,SAAS,CAAA;gBACxB,QAAQ,GAAG;oBACT,OAAO;oBACP,YAAY;oBACZ,SAAS;oBACT,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;iBACnB,CAAA;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,0DAA0D;YAC1D,SAAQ;QACV,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAyBD,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,MAA4B,EAA2B,EAAE;IAC5F,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;IACvC,OAAO,IAAI,EAAE,OAAO,IAAI,IAAI,CAAA;AAC9B,CAAC,CAAA"}

package/dist/esm/pool.js

@@ -0,0 +1,70 @@
+import { StateView } from "./abis/index.js";
+import { UNISWAP_V4_STATE_VIEW } from "./constants.js";
+import { getPoolId } from "./pool-key.js";
+// ========================================
+// HELPER UTILS (for composition in larger multicalls)
+// ========================================
+/**
+ * Helper: Get pool state contracts for multicall composition
+ */
+export function poolStateContracts(params) {
+    return [
+        {
+            address: params.stateViewAddress,
+            abi: StateView,
+            functionName: "getSlot0",
+            args: [params.poolId],
+        },
+        {
+            address: params.stateViewAddress,
+            abi: StateView,
+            functionName: "getLiquidity",
+            args: [params.poolId],
+        },
+    ];
+}
+// ========================================
+// MAIN POOL DATA FUNCTION
+// ========================================
+/**
+ * Get pool-specific data including liquidity, price, and fees
+ * Uses StateView contract for efficient state queries
+ */
+export async function pool({ publicClient, project }) {
+    if (Object.values({ publicClient, project }).some((value) => !value)) {
+        throw new Error("Invalid pool params");
+    }
+    if (!project.pool?.poolKey)
+        return null;
+    const chainId = publicClient.chain?.id;
+    if (!chainId)
+        throw new Error("Chain ID not found on public client");
+    const stateViewAddress = UNISWAP_V4_STATE_VIEW(chainId);
+    if (!stateViewAddress) {
+        throw new Error(`StateView address not found for chain ID ${chainId}`);
+    }
+    const poolKey = project.pool.poolKey;
+    const poolId = getPoolId(poolKey);
+    // Use helper to get contracts and execute multicall
+    const contracts = poolStateContracts({ stateViewAddress, poolId });
+    const results = await publicClient.multicall({ contracts });
+    const slot0Result = results[0].result;
+    const liquidityResult = results[1].result;
+    const [sqrtPriceX96, tick, protocolFee, lpFee] = slot0Result;
+    const liquidity = liquidityResult;
+    // Determine fee display from project
+    const feeDisplay = project.pool.feeDisplay;
+    return {
+        poolKey,
+        sqrtPriceX96,
+        tick: Number(tick),
+        liquidity: {
+            raw: liquidity,
+            formatted: liquidity.toString(),
+        },
+        protocolFee: Number(protocolFee),
+        lpFee: Number(lpFee),
+        feeDisplay,
+    };
+}
+//# sourceMappingURL=pool.js.map

package/dist/esm/pool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool.js","sourceRoot":"","sources":["../../src/pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAmBtC,2CAA2C;AAC3C,sDAAsD;AACtD,2CAA2C;AAE3C;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAGlC;IACC,OAAO;QACL;YACE,OAAO,EAAE,MAAM,CAAC,gBAAgB;YAChC,GAAG,EAAE,SAAS;YACd,YAAY,EAAE,UAAmB;YACjC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;SACtB;QACD;YACE,OAAO,EAAE,MAAM,CAAC,gBAAgB;YAChC,GAAG,EAAE,SAAS;YACd,YAAY,EAAE,cAAuB;YACrC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;SACtB;KACF,CAAA;AACH,CAAC;AAED,2CAA2C;AAC3C,0BAA0B;AAC1B,2CAA2C;AAE3C;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,EAAE,YAAY,EAAE,OAAO,EAAc;IAC9D,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO;QAAE,OAAO,IAAI,CAAA;IAEvC,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,CAAA;IACtC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IAEpE,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAA;IACvD,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,EAAE,CAAC,CAAA;IACxE,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAA;IACpC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;IAEjC,oDAAoD;IACpD,MAAM,SAAS,GAAG,kBAAkB,CAAC,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAAA;IAClE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;IAE3D,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAA0C,CAAA;IACzE,MAAM,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAAgB,CAAA;IAEnD,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,WAAW,CAAA;IAC5D,MAAM,SAAS,GAAG,eAAe,CAAA;IAEjC,qCAAqC;IACrC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAA;IAE1C,OAAO;QACL,OAAO;QACP,YAAY;QACZ,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAClB,SAAS,EAAE;YACT,GAAG,EAAE,SAAS;YACd,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;SAChC;QACD,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;QAChC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;QACpB,UAAU;KACX,CAAA;AACH,CAAC"}