@paxoslabs/amplify-sdk 0.5.3 → 1.0.0

package/dist/chain-utils-5r2UnCDS.d.mts

@@ -1,380 +0,0 @@
-import { Chain } from 'viem/chains';
-import { Address } from 'viem';
-
-/**
- * SDK Configuration Constants
- *
- * Global constants for supported chains, yield types, tokens, and defaults.
- * Centralized configuration for address book integration and permit deposits.
- */
-
-/**
- * Yield Type identifiers
- *
- * Use as const values: YieldType.CORE, YieldType.TREASURY, YieldType.FRONTIER
- * Use as type annotation: yieldType: YieldType
- */
-declare const YieldType: {
-    readonly CORE: "CORE";
-    readonly TREASURY: "TREASURY";
-    readonly FRONTIER: "FRONTIER";
-};
-type YieldType = (typeof YieldType)[keyof typeof YieldType];
-
-/**
- * Type definitions for Amplify SDK API integration
- *
- * These types define the data structures returned by the Earn SDK backend API
- * and internal cache structures used by the SDK.
- *
- * @module types/amplify-sdk-api
- */
-
-/**
- * Vault smart contract configuration
- *
- * Contains all contract addresses required for vault operations:
- * - boringVaultAddress: Main vault contract
- * - tellerAddress: Handles deposits and withdrawals
- * - accountantAddress: Manages accounting logic
- * - managerAddress: Controls strategy execution
- * - rolesAuthorityAddress: Enforces role-based access
- * - baseTokenAddress: Primary deposit token address
- * - baseTokenStandIn: Optional stand-in token
- * - communityCodeDepositorAddress: Optional community depositor contract
- */
-interface VaultContracts {
-    boringVaultAddress: Address;
-    tellerAddress: Address;
-    accountantAddress: Address;
-    managerAddress: Address;
-    rolesAuthorityAddress: Address;
-    baseTokenAddress: Address;
-    baseTokenStandIn?: Address;
-    communityCodeDepositorAddress?: Address;
-    withdrawQueueAddress?: Address;
-    depositFeeModuleAddress?: Address;
-    withdrawFeeModuleAddress?: Address;
-}
-/**
- * Enterprise customer configuration for compliance features (e.g. KYT).
- */
-interface EnterpriseConfig {
-    predicatePolicyId: string | null;
-}
-/**
- * A single depositable/withdrawable asset supported by a vault.
- */
-interface VaultSupportedAsset {
-    /** Token contract address */
-    address: Address;
-    /** Chain ID where this asset can be deposited/withdrawn (may differ from vault chain for cross-chain vaults) */
-    chainId?: number;
-    /** Token symbol (e.g., USDC, USDT) */
-    symbol: string;
-    /** Full token name (e.g., USD Coin) */
-    name: string;
-    /** Number of decimal places (e.g., 6 for USDC, 18 for DAI) */
-    decimals: number;
-    /** CoinGecko token identifier for price lookups */
-    coinGeckoTokenId?: string;
-    /** Whether deposits are currently enabled for this vault-asset pair */
-    depositable?: boolean;
-    /** Whether withdrawals are currently enabled for this vault-asset pair */
-    withdrawable?: boolean;
-}
-/**
- * Amplify vault configuration
- *
- * Represents a single vault with contract addresses, yield type, and supported deposit assets.
- * Multiple vaults can share the same baseTokenAddress (different chains/yield types).
- * A single vault can support multiple depositable assets.
- *
- * @example
- * ```typescript
- * const vault: AmplifyVault = {
- *   id: "config-eth-core-001",
- *   chainId: 1,
- *   yieldType: "CORE",
- *   vault: {
- *     boringVaultAddress: "0x8a5Fb0Eb3E1a90AF81C5DFF9f2e5D0e7b8D4E5F6",
- *     tellerAddress: "0x7B8C9D0E1F2A3B4C5D6E7F8A9B0C1D2E3F4A5B6C",
- *     accountantAddress: "0x6A7B8C9D0E1F2A3B4C5D6E7F8A9B0C1D2E3F4A5B",
- *     managerAddress: "0x5A6B7C8D9E0F1A2B3C4D5E6F7A8B9C0D1E2F3A4B",
- *     rolesAuthorityAddress: "0x4A5B6C7D8E9F0A1B2C3D4E5F6A7B8C9D0E1F2A3B",
- *     baseTokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
- *   },
- *   supportedAssets: [
- *     {
- *       address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
- *       symbol: "USDC",
- *       name: "USD Coin",
- *       decimals: 6,
- *       coinGeckoTokenId: "usd-coin"
- *     }
- *   ]
- * };
- * ```
- */
-interface VaultSLA {
-    externalWithdrawalQueueDelaySLA: number;
-    externalAccountantRateUpdateSLA: number;
-}
-/**
- * Deposit cap data read on-chain from a CommunityCodeDepositor contract.
- * Only populated for vaults that have both `communityCodeDepositorAddress`
- * and `depositFeeModuleAddress` configured.
- */
-interface VaultDepositCap {
-    supplyCapInBase: bigint;
-    /** True when `supplyCapInBase` is neither `0` nor `maxUint256` (unlimited). */
-    hasDepositCap: boolean;
-}
-interface VaultDepositFeeEntry {
-    /** Deposit asset address, null for global/default fee that applies to all assets */
-    depositAsset: Address | null;
-    /** Fee percentage as raw bigint (denominator 1e18 for DCD contracts), 0n when no fee */
-    feePercentage: bigint;
-    /** Flat fee as raw bigint, 0n when no fee */
-    flatFee: bigint;
-}
-interface VaultDepositFees {
-    hasFees: boolean;
-    feeModuleAddress: Address | null;
-    fees: VaultDepositFeeEntry[];
-    /** ONE_HUNDRED_PERCENT constant from the fee module contract (denominator for percentage and flat fee calculations) */
-    oneHundredPercent?: bigint;
-}
-interface VaultWithdrawFees {
-    hasFees: boolean;
-    feeModuleAddress: Address | null;
-    /** Offer fee in basis points (e.g. 100n = 1%), 0n when no fee */
-    offerFeeBps: bigint;
-    /** Offer fee rate as raw bigint from indexer, 0n when no fee */
-    offerFeeRate: bigint;
-}
-interface AmplifyVault {
-    /** Unique identifier for the vault configuration */
-    id: string;
-    /** Chain ID where the vault is deployed (e.g., 1 for Ethereum) */
-    chainId: number;
-    /** Yield strategy type */
-    yieldType: YieldType;
-    /** Human-readable vault name */
-    name: string;
-    /** Whether the vault is being deprecated */
-    inDeprecation: boolean;
-    /** Vault smart contract addresses */
-    vault: VaultContracts;
-    /** Enterprise customer configuration (compliance settings, e.g. KYT) */
-    enterpriseConfig?: EnterpriseConfig;
-    /** SLA data from VaultSLAs table */
-    sla?: VaultSLA;
-    /** Whether this vault uses atomic settlement via submitOrderAndProcessAll */
-    atomicWithdrawal: boolean;
-    /** Supported deposit assets for this vault */
-    supportedAssets: VaultSupportedAsset[];
-    /**
-     * Deposit cap data — only present for vaults with both a
-     * CommunityCodeDepositor and a deposit fee module.
-     */
-    depositCap?: VaultDepositCap;
-    /** (Optional) deposits fees for this vault */
-    depositFees?: VaultDepositFees;
-    /** (Optional) withdraw queue fees for this vault */
-    withdrawFees?: VaultWithdrawFees;
-}
-/**
- * Supported asset (token) metadata
- *
- * Represents a cryptocurrency token with metadata and chain support.
- * Can be correlated with AmplifyVault via the vault's supportedAssets array.
- *
- * @example
- * ```typescript
- * const asset: SupportedAsset = {
- *   address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
- *   symbol: "USDC",
- *   name: "USD Coin",
- *   decimals: 6,
- *   coinGeckoTokenId: "usd-coin",
- *   chains: [1, 137, 8453, 42161]
- * };
- * ```
- */
-interface SupportedAsset {
-    /** Token contract address */
-    address: Address;
-    /** Token symbol (e.g., USDC, USDT) */
-    symbol: string;
-    /** Full token name (e.g., USD Coin) */
-    name: string;
-    /** Number of decimal places (e.g., 6 for USDC, 18 for DAI) */
-    decimals: number;
-    /** CoinGecko token identifier for price lookups */
-    coinGeckoTokenId?: string;
-    /** Array of chain IDs where this token is supported */
-    chains: number[];
-}
-/**
- * Filter options for vault queries
- *
- * Used to filter vaults by chain, yield type, or deposit token.
- * All filters are optional and can be combined.
- *
- * @example
- * ```typescript
- * // Get all CORE vaults on Ethereum
- * const options: VaultFilterOptions = {
- *   chainId: 1,
- *   yieldType: "CORE"
- * };
- *
- * // Get all vaults accepting USDC
- * const usdcOptions: VaultFilterOptions = {
- *   depositTokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
- * };
- * ```
- */
-interface VaultFilterOptions {
-    /** Filter by chain ID */
-    chainId?: number;
-    /** Filter by yield type */
-    yieldType?: YieldType;
-    /** Filter by deposit token address */
-    depositTokenAddress?: Address;
-    /** Filter by withdraw asset address */
-    withdrawAssetAddress?: Address;
-    /** Filter by settlement asset address */
-    settlementAssetAddress?: Address;
-}
-/**
- * Filter options for asset queries
- *
- * Used to filter supported assets by chain IDs, yield type, address, or symbol.
- * All filters are optional and can be combined.
- *
- * Note: API endpoints only support `chains` and `yieldType` parameters.
- * The `address` and `symbol` filters are only applied in cache-layer filtering.
- *
- * @example
- * ```typescript
- * // Get all assets supported on Ethereum and Base (API call)
- * const options: AssetFilterOptions = {
- *   chains: [1, 8453]
- * };
- *
- * // Get CORE yield type assets (API call)
- * const coreOptions: AssetFilterOptions = {
- *   yieldType: "CORE"
- * };
- *
- * // Filter by address (cache-only)
- * const usdcOptions: AssetFilterOptions = {
- *   address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
- * };
- *
- * // Filter by symbol (cache-only)
- * const symbolOptions: AssetFilterOptions = {
- *   symbol: "USDC"
- * };
- * ```
- */
-interface AssetFilterOptions {
-    /** Filter by chain IDs (API + cache: assets with these chains in chains array) */
-    chains?: number[];
-    /** Filter by yield type (API + cache: CORE, TREASURY, or FRONTIER) */
-    yieldType?: YieldType;
-    /** Filter by token address (cache-only: exact address match) */
-    address?: string;
-    /** Filter by token symbol (cache-only: exact symbol match) */
-    symbol?: string;
-}
-/**
- * API error with descriptive messages
- *
- * Thrown when API requests fail due to network errors, server errors,
- * or malformed responses.
- *
- * @example
- * ```typescript
- * throw new APIError("Failed to fetch vaults: Network timeout", {
- *   statusCode: 408,
- *   endpoint: "/v1/earn-sdk/vaults"
- * });
- * ```
- */
-declare class APIError extends Error {
-    /**
-     * HTTP status code (if available)
-     */
-    statusCode?: number;
-    /**
-     * API endpoint that failed
-     */
-    endpoint?: string;
-    /**
-     * Original error cause
-     */
-    cause?: unknown;
-    constructor(message: string, options?: {
-        statusCode?: number;
-        endpoint?: string;
-        cause?: unknown;
-    });
-}
-/**
- * Supported asset information for withdrawal
- *
- * Asset grouped with available vaults that support withdrawal of that asset.
- *
- * @example
- * ```typescript
- * const asset: WithdrawSupportedAsset = {
- *   address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
- *   symbol: "USDC",
- *   decimals: 6,
- *   vaults: [
- *     { id: "core-usdc-eth", yieldType: "CORE", chainId: 1, vaultId: "..." },
- *     { id: "core-usdc-boba", yieldType: "CORE", chainId: 288, vaultId: "..." },
- *   ],
- * };
- * ```
- */
-interface WithdrawSupportedAsset {
-    /** Token contract address */
-    address: Address;
-    /** Token symbol (e.g., "USDC", "ETH") */
-    symbol: string;
-    /** Number of decimal places for this token */
-    decimals: number;
-    /** Array of vaults that support withdrawals of this asset */
-    vaults: Array<{
-        id: string;
-        yieldType: YieldType;
-        chainId: number;
-        vaultId: string;
-    }>;
-}
-
-/**
- * Flexible chain ID type that accepts both number and string
- */
-type ChainId = number | `${number}`;
-/**
- * Normalizes a ChainId to a number
- */
-declare function toChainId(value: ChainId): number;
-/**
- * Gets a chain object from the vault config response
- * @param chainId The chain ID to look up
- * @param config Optional config object. If not provided, will fetch from API
- * @returns Promise<Chain>
- */
-declare function getChainFromConfig(chainId: number, config?: AmplifyVault[]): Promise<Chain>;
-/**
- * Clears the chains cache
- */
-declare function clearChainsCache(): void;
-
-export { type AmplifyVault as A, type ChainId as C, type EnterpriseConfig as E, type SupportedAsset as S, type VaultFilterOptions as V, type WithdrawSupportedAsset as W, YieldType as Y, type AssetFilterOptions as a, APIError as b, clearChainsCache as c, type VaultDepositFees as d, type VaultSLA as e, type VaultSupportedAsset as f, getChainFromConfig as g, type VaultWithdrawFees as h, toChainId as t };