levr-sdk 0.0.1 → 0.1.0

package/dist/types/pool.d.ts

@@ -0,0 +1,590 @@
+import type { Project } from './project';
+import type { BalanceResult, PoolKey, PopPublicClient } from './types';
+export type PoolParams = {
+    publicClient: PopPublicClient;
+    project: Project;
+};
+export type PoolData = {
+    poolKey: PoolKey;
+    sqrtPriceX96: bigint;
+    tick: number;
+    liquidity: BalanceResult;
+    protocolFee: number;
+    lpFee: number;
+    feeDisplay: string;
+};
+/**
+ * Helper: Get pool state contracts for multicall composition
+ */
+export declare function poolStateContracts(params: {
+    stateViewAddress: `0x${string}`;
+    poolId: `0x${string}`;
+}): ({
+    address: `0x${string}`;
+    abi: readonly [{
+        readonly inputs: readonly [{
+            readonly internalType: "contract IPoolManager";
+            readonly name: "_poolManager";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+        readonly type: "constructor";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getFeeGrowthGlobals";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthGlobal0";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthGlobal1";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickLower";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickUpper";
+            readonly type: "int24";
+        }];
+        readonly name: "getFeeGrowthInside";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "positionId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0LastX128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1LastX128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "address";
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickLower";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickUpper";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "salt";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0LastX128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1LastX128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "positionId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getSlot0";
+        readonly outputs: readonly [{
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceX96";
+            readonly type: "uint160";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "protocolFee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "lpFee";
+            readonly type: "uint24";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int16";
+            readonly name: "tick";
+            readonly type: "int16";
+        }];
+        readonly name: "getTickBitmap";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "tickBitmap";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickFeeGrowthOutside";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidityGross";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "int128";
+            readonly name: "liquidityNet";
+            readonly type: "int128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidityGross";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "int128";
+            readonly name: "liquidityNet";
+            readonly type: "int128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "poolManager";
+        readonly outputs: readonly [{
+            readonly internalType: "contract IPoolManager";
+            readonly name: "";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }];
+    functionName: "getSlot0";
+    args: `0x${string}`[];
+} | {
+    address: `0x${string}`;
+    abi: readonly [{
+        readonly inputs: readonly [{
+            readonly internalType: "contract IPoolManager";
+            readonly name: "_poolManager";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+        readonly type: "constructor";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getFeeGrowthGlobals";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthGlobal0";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthGlobal1";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickLower";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickUpper";
+            readonly type: "int24";
+        }];
+        readonly name: "getFeeGrowthInside";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "positionId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0LastX128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1LastX128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "address";
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickLower";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tickUpper";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "salt";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside0LastX128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthInside1LastX128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "bytes32";
+            readonly name: "positionId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getPositionLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidity";
+            readonly type: "uint128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getSlot0";
+        readonly outputs: readonly [{
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceX96";
+            readonly type: "uint160";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "protocolFee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "lpFee";
+            readonly type: "uint24";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int16";
+            readonly name: "tick";
+            readonly type: "int16";
+        }];
+        readonly name: "getTickBitmap";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "tickBitmap";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickFeeGrowthOutside";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickInfo";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidityGross";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "int128";
+            readonly name: "liquidityNet";
+            readonly type: "int128";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside0X128";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "feeGrowthOutside1X128";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "PoolId";
+            readonly name: "poolId";
+            readonly type: "bytes32";
+        }, {
+            readonly internalType: "int24";
+            readonly name: "tick";
+            readonly type: "int24";
+        }];
+        readonly name: "getTickLiquidity";
+        readonly outputs: readonly [{
+            readonly internalType: "uint128";
+            readonly name: "liquidityGross";
+            readonly type: "uint128";
+        }, {
+            readonly internalType: "int128";
+            readonly name: "liquidityNet";
+            readonly type: "int128";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "poolManager";
+        readonly outputs: readonly [{
+            readonly internalType: "contract IPoolManager";
+            readonly name: "";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+        readonly type: "function";
+    }];
+    functionName: "getLiquidity";
+    args: `0x${string}`[];
+})[];
+/**
+ * Get pool-specific data including liquidity, price, and fees
+ * Uses StateView contract for efficient state queries
+ */
+export declare function pool({ publicClient, project }: PoolParams): Promise<PoolData | null>;
+//# sourceMappingURL=pool.d.ts.map

package/dist/types/pool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool.d.ts","sourceRoot":"","sources":["../../src/pool.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAEtE,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,EAAE,eAAe,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,aAAa,CAAA;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAMD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE;IACzC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAA;IAC/B,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;CACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAeA;AAMD;;;GAGG;AACH,wBAAsB,IAAI,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CA2C1F"}

package/dist/types/project.d.ts

@@ -1,9 +1,11 @@
-import type { PoolKey, PopPublicClient } from './types';
+import type { FeeReceiverAdmin } from './fee-receivers';
+import type { AirdropStatus } from './treasury';
+import type { BalanceResult, PoolKey, PopPublicClient, PricingResult } from './types';
 export type ProjectParams = {
     publicClient: PopPublicClient;
-    factoryAddress: `0x${string}`;
-    chainId: number;
     clankerToken: `0x${string}`;
+    oraclePublicClient?: PopPublicClient;
+    userAddress?: `0x${string}`;
 };
 export type ProjectMetadata = {
     description: string;
@@ -16,22 +18,52 @@ export type PoolInfo = {
     numPositions: bigint;
 };
 export type TreasuryStats = {
-    balance: {
-        raw: bigint;
-        formatted: string;
+    balance: BalanceResult;
+    totalAllocated: BalanceResult;
+    utilization: number;
+};
+export type StakingStats = {
+    totalStaked: BalanceResult;
+    apr: {
+        token: {
+            raw: bigint;
+            percentage: number;
+        };
+        weth: {
+            raw: bigint;
+            percentage: number;
+        } | null;
     };
-    totalAllocated: {
-        raw: bigint;
-        formatted: string;
+    outstandingRewards: {
+        staking: {
+            available: BalanceResult;
+            pending: BalanceResult;
+        };
+        weth: {
+            available: BalanceResult;
+            pending: BalanceResult;
+        } | null;
+    };
+    rewardRates: {
+        token: BalanceResult;
+        weth: BalanceResult | null;
+    };
+};
+export type GovernanceStats = {
+    currentCycleId: bigint;
+    activeProposalCount: {
+        boost: bigint;
+        transfer: bigint;
     };
-    utilization: number;
 };
 export type Project = {
+    chainId: number;
     treasury: `0x${string}`;
     governor: `0x${string}`;
     staking: `0x${string}`;
     stakedToken: `0x${string}`;
     forwarder: `0x${string}`;
+    factory: `0x${string}`;
     token: {
         address: `0x${string}`;
         decimals: number;
@@ -43,9 +75,27 @@ export type Project = {
     };
     pool?: PoolInfo;
     treasuryStats?: TreasuryStats;
+    stakingStats?: StakingStats;
+    governanceStats?: GovernanceStats;
+    feeReceivers?: FeeReceiverAdmin[];
+    pricing?: PricingResult;
+    airdrop?: AirdropStatus | null;
+};
+export type ProjectsParams = {
+    publicClient: PopPublicClient;
+    offset?: number;
+    limit?: number;
 };
+export type ProjectsResult = {
+    projects: Omit<Project, 'forwarder' | 'pool' | 'pricing' | 'stakingStats' | 'governanceStats' | 'feeReceivers' | 'airdrop'>[];
+    total: number;
+};
+/**
+ * Get multiple projects data using factory's paginated getProjects()
+ */
+export declare function getProjects({ publicClient, offset, limit, }: ProjectsParams): Promise<ProjectsResult>;
 /**
  * Get project data for a clanker token
  */
-export declare function project({ publicClient, factoryAddress, chainId, clankerToken, }: ProjectParams): Promise<Project | null>;
+export declare function getProject({ publicClient, clankerToken, oraclePublicClient, userAddress, }: ProjectParams): Promise<Project | null>;
 //# sourceMappingURL=project.d.ts.map