levr-sdk 0.3.1 → 0.5.0-alpha.2

package/dist/types/usd-price.d.ts

@@ -1,146 +0,0 @@
-import type { PublicClient } from 'viem';
-/**
- * @description Parameters for getting WETH/USD price
- */
-export type GetWethUsdPriceParams = {
-    /**
-     * Public client for WETH/USDC oracle queries
-     * This should connect to a chain with reliable USDC liquidity (e.g., Base mainnet)
-     */
-    publicClient: PublicClient;
-};
-/**
- * @description Return type for WETH/USD price function
- */
-export type GetWethUsdPriceReturnType = {
-    /**
-     * WETH price in USD as a formatted string (e.g. "2543.21")
-     */
-    priceUsd: string;
-    /**
-     * Raw amount of USDC received for 1 WETH (in USDC's 6 decimals)
-     */
-    wethPerUsdc: bigint;
-    /**
-     * Fee tier of the V3 pool used (500 = 0.05%, 3000 = 0.3%, 10000 = 1%)
-     */
-    fee: number;
-};
-/**
- * @description Get the USD price of WETH from a WETH/USDC pool using Uniswap V3
- *
- * @param params Parameters for WETH/USD price oracle
- * @returns WETH price in USD and raw quote data
- *
- * @remarks
- * This function queries Uniswap V3 WETH/USDC pools for accurate pricing.
- * V3 is used instead of V4 because V3 has much deeper liquidity on most chains.
- *
- * The function:
- * 1. Tries common V3 fee tiers (0.3%, 0.05%, 1%) in order of preference
- * 2. Quotes 1 WETH to get USDC output
- * 3. Returns the first successful quote
- *
- * This is commonly used as a price oracle for other token pricing calculations.
- *
- * @example
- * ```typescript
- * // Get current WETH price on Base mainnet
- * const { priceUsd, fee } = await getWethUsdPrice({
- *   publicClient: baseMainnetClient,
- * })
- * console.log(`WETH price: $${priceUsd} (from ${fee/10000}% pool)`)
- * ```
- */
-export declare const getWethUsdPrice: ({ publicClient, }: GetWethUsdPriceParams) => Promise<GetWethUsdPriceReturnType>;
-/**
- * @description Parameters for getting USD price of a token
- */
-export type GetUsdPriceParams = {
-    /**
-     * Public client for price oracle queries (WETH/USDC)
-     * This should connect to a chain with reliable USDC liquidity (e.g., Base mainnet)
-     */
-    oraclePublicClient: PublicClient;
-    /**
-     * Public client for token quote queries (Token/WETH)
-     * This should connect to the chain where the token is deployed
-     */
-    quotePublicClient: PublicClient;
-    /**
-     * Token address to get price for
-     */
-    tokenAddress: `0x${string}`;
-    /**
-     * Token decimals (required for accurate pricing)
-     */
-    tokenDecimals: number;
-    /**
-     * Optional fee tier for the token/WETH pool (in hundredths of a bip, e.g. 3000 = 0.3%)
-     * If not provided, uses defaults from pool-key module (3000 = 0.3%)
-     * Note: WETH/USDC pool is automatically discovered
-     */
-    quoteFee?: number;
-    /**
-     * Optional tick spacing for the token/WETH pool
-     * If not provided, uses defaults from pool-key module (60 for 0.3% fee tier)
-     * Note: WETH/USDC pool is automatically discovered
-     */
-    quoteTickSpacing?: number;
-    /**
-     * Optional hooks address for the token/WETH pool
-     * If not provided, uses defaults from pool-key module (zero address = no hooks)
-     * Note: WETH/USDC pool is automatically discovered
-     */
-    quoteHooks?: `0x${string}`;
-};
-/**
- * @description Return type for USD price function
- */
-export type GetUsdPriceReturnType = {
-    /**
-     * USD price of the token as a formatted string (e.g. "1234.56")
-     */
-    priceUsd: string;
-    /**
-     * Raw price ratio of token to WETH
-     */
-    tokenPerWeth: bigint;
-    /**
-     * Raw price ratio of WETH to USDC
-     */
-    wethPerUsdc: bigint;
-};
-/**
- * @description Get the USD price of a token paired with WETH
- *
- * @param params Parameters including token addresses and chain config
- * @returns USD price and intermediate price ratios
- *
- * @remarks
- * This function calculates the USD price of a token by:
- * 1. Auto-discovering and querying a liquid WETH/USDC pool (oracle chain)
- * 2. Getting the price of the token in WETH (quote chain)
- * 3. Multiplying them together to get token price in USD
- *
- * The paired token must be WETH, otherwise an error is thrown.
- * USD pricing always uses USDC as the stable reference.
- *
- * This design allows you to:
- * - Use mainnet for accurate WETH/USDC prices (oracle auto-discovers pool)
- * - Quote tokens from any chain (testnet, L2, etc.)
- *
- * @example
- * ```typescript
- * // Get testnet token price using mainnet oracle
- * const { priceUsd } = await getUsdPrice({
- *   oraclePublicClient: mainnetClient,
- *   quotePublicClient: testnetClient,
- *   tokenAddress: '0x123...',
- *   tokenDecimals: 18,
- * })
- * console.log(`Token price: $${priceUsd}`)
- * ```
- */
-export declare const getUsdPrice: ({ oraclePublicClient, quotePublicClient, tokenAddress, tokenDecimals, quoteFee, quoteTickSpacing, quoteHooks, }: GetUsdPriceParams) => Promise<GetUsdPriceReturnType>;
-//# sourceMappingURL=usd-price.d.ts.map

package/dist/types/usd-price.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usd-price.d.ts","sourceRoot":"","sources":["../../src/usd-price.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAOxC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,eAAe,GAAU,mBAEnC,qBAAqB,KAAG,OAAO,CAAC,yBAAyB,CA0D3D,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,kBAAkB,EAAE,YAAY,CAAA;IAChC;;;OAGG;IACH,iBAAiB,EAAE,YAAY,CAAA;IAC/B;;OAEG;IACH,YAAY,EAAE,KAAK,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CAC3B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,WAAW,GAAU,iHAQ/B,iBAAiB,KAAG,OAAO,CAAC,qBAAqB,CAoEnD,CAAA"}

package/dist/types/user.d.ts

@@ -1,188 +0,0 @@
-import type { Project } from './project';
-import type { BalanceResult, PopPublicClient } from './types';
-export type UserParams = {
-    publicClient: PopPublicClient;
-    userAddress: `0x${string}`;
-    project: Project;
-};
-export type UserBalances = {
-    token: BalanceResult;
-    weth: BalanceResult;
-    eth: BalanceResult;
-};
-export type UserStaking = {
-    stakedBalance: BalanceResult;
-    allowance: BalanceResult;
-    claimableRewards: {
-        staking: BalanceResult;
-        weth: BalanceResult | null;
-    };
-};
-export type User = {
-    balances: UserBalances;
-    staking: UserStaking;
-    votingPower: string;
-};
-/**
- * Helper: Get balance contracts for multicall composition
- */
-export declare function balanceContracts(params: {
-    userAddress: `0x${string}`;
-    clankerToken: `0x${string}`;
-    wethAddress?: `0x${string}`;
-}): {
-    address: `0x${string}`;
-    abi: readonly [{
-        readonly type: "event";
-        readonly name: "Approval";
-        readonly inputs: readonly [{
-            readonly indexed: true;
-            readonly name: "owner";
-            readonly type: "address";
-        }, {
-            readonly indexed: true;
-            readonly name: "spender";
-            readonly type: "address";
-        }, {
-            readonly indexed: false;
-            readonly name: "value";
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly type: "event";
-        readonly name: "Transfer";
-        readonly inputs: readonly [{
-            readonly indexed: true;
-            readonly name: "from";
-            readonly type: "address";
-        }, {
-            readonly indexed: true;
-            readonly name: "to";
-            readonly type: "address";
-        }, {
-            readonly indexed: false;
-            readonly name: "value";
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "allowance";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [{
-            readonly name: "owner";
-            readonly type: "address";
-        }, {
-            readonly name: "spender";
-            readonly type: "address";
-        }];
-        readonly outputs: readonly [{
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "approve";
-        readonly stateMutability: "nonpayable";
-        readonly inputs: readonly [{
-            readonly name: "spender";
-            readonly type: "address";
-        }, {
-            readonly name: "amount";
-            readonly type: "uint256";
-        }];
-        readonly outputs: readonly [{
-            readonly type: "bool";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "balanceOf";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [{
-            readonly name: "account";
-            readonly type: "address";
-        }];
-        readonly outputs: readonly [{
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "decimals";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [];
-        readonly outputs: readonly [{
-            readonly type: "uint8";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "name";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [];
-        readonly outputs: readonly [{
-            readonly type: "string";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "symbol";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [];
-        readonly outputs: readonly [{
-            readonly type: "string";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "totalSupply";
-        readonly stateMutability: "view";
-        readonly inputs: readonly [];
-        readonly outputs: readonly [{
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "transfer";
-        readonly stateMutability: "nonpayable";
-        readonly inputs: readonly [{
-            readonly name: "recipient";
-            readonly type: "address";
-        }, {
-            readonly name: "amount";
-            readonly type: "uint256";
-        }];
-        readonly outputs: readonly [{
-            readonly type: "bool";
-        }];
-    }, {
-        readonly type: "function";
-        readonly name: "transferFrom";
-        readonly stateMutability: "nonpayable";
-        readonly inputs: readonly [{
-            readonly name: "sender";
-            readonly type: "address";
-        }, {
-            readonly name: "recipient";
-            readonly type: "address";
-        }, {
-            readonly name: "amount";
-            readonly type: "uint256";
-        }];
-        readonly outputs: readonly [{
-            readonly type: "bool";
-        }];
-    }];
-    functionName: "balanceOf";
-    args: `0x${string}`[];
-}[];
-/**
- * Helper: Get user-specific staking contracts for multicall composition
- * Pool-level stats (totalStaked, apr, outstandingRewards) now in project.ts
- */
-export declare function stakingContracts(params: {
-    userAddress: `0x${string}`;
-    stakingAddress: `0x${string}`;
-    clankerToken: `0x${string}`;
-    wethAddress?: `0x${string}`;
-}): any[];
-/**
- * Get all user-related data in a single efficient multicall
- * Composes balances, staking, and governance data with USD values
- */
-export declare function getUser({ publicClient, userAddress, project }: UserParams): Promise<User>;
-//# sourceMappingURL=user.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/user.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,EAAE,eAAe,CAAA;IAC7B,WAAW,EAAE,KAAK,MAAM,EAAE,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,aAAa,CAAA;IACpB,IAAI,EAAE,aAAa,CAAA;IACnB,GAAG,EAAE,aAAa,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,aAAa,CAAA;IAC5B,SAAS,EAAE,aAAa,CAAA;IACxB,gBAAgB,EAAE;QAChB,OAAO,EAAE,aAAa,CAAA;QACtB,IAAI,EAAE,aAAa,GAAG,IAAI,CAAA;KAC3B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,QAAQ,EAAE,YAAY,CAAA;IACtB,OAAO,EAAE,WAAW,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IACvC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAA;IAC1B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoBA;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IACvC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAA;IAC1B,cAAc,EAAE,KAAK,MAAM,EAAE,CAAA;IAC7B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CAC5B,SAsCA;AAMD;;;GAGG;AACH,wBAAsB,OAAO,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAuF/F"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAU9C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAsBjF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAC1C,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EACxC,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAiBT"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../src/vault.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAKxC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,KAAK,MAAM,EAAE,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,KAAK,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,WAAW,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AAiED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAClC,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,KAAK,MAAM,EAAE,EAC3B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC;IAAE,UAAU,EAAE,eAAe,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAczE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE;IACJ,UAAU,EAAE,eAAe,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;CAClB,EACD,cAAc,EAAE,MAAM,GACrB,eAAe,CA2CjB"}