lending-apy-fetcher-ts
Version:
TypeScript library for fetching APYs from DeFi lending protocols
33 lines • 2.14 kB
TypeScript
export declare function initializeEnvironment(): void;
export { ApyFetcher } from './fetcher';
export type { ApyData, Protocol, ApyResult, GroupedApys, BestApyResult, TokenMapping, NetworkTokenMappings, } from './types';
export { ApyFetcherError, NetworkError, ValidationError, AuthenticationError, } from './types';
export { ETHEREUM, POLYGON, ARBITRUM, OPTIMISM } from './protocols';
export { AaveEthProtocol } from './protocols/aave-eth';
export { AavePolygonProtocol } from './protocols/aave-polygon';
export { AaveArbitrumProtocol } from './protocols/aave-arbitrum';
export { AaveOptimismProtocol } from './protocols/aave-optimism';
import { ApyData, ApyResult, Protocol } from './types';
/**
* Simple convenience function to fetch APYs from all protocols
* @param config Optional configuration, defaults to environment-based config
* @param gracefulDegradation Continue with other protocols if one fails (default: true)
* @returns Promise<ApyData[]> Array of APY data from all protocols
*/
export declare function getApys(protocols?: Protocol[], gracefulDegradation?: boolean): Promise<ApyData[]>;
/**
* Get APYs with detailed results per protocol
* @param config Optional configuration, defaults to environment-based config
* @param gracefulDegradation Continue with other protocols if one fails (default: true)
* @returns Promise<ApyResult[]> Array of results with success/error status per protocol
*/
export declare function getApysWithResults(protocols?: Protocol[], gracefulDegradation?: boolean): Promise<ApyResult[]>;
/**
* Get the best APY for a specific token across all protocols
* @param tokenSymbol Token symbol to search for (e.g., 'USDC', 'WETH')
* @param config Optional configuration, defaults to environment-based config
* @param gracefulDegradation Continue with other protocols if one fails (default: true)
* @returns Promise<BestApyResult | null> Best APY result or null if token not found
*/
export declare function getBestApyForToken(protocols: Protocol[], tokenSymbol: string, gracefulDegradation?: boolean): Promise<import('./types').BestApyResult | null>;
//# sourceMappingURL=index.d.ts.map