@ember-finance/sdk 1.0.28 → 1.1.0

package/dist/src/evm-vaults/on-chain-calls/vault-reader.d.ts

@@ -0,0 +1,431 @@
+import { Provider } from "ethers";
+import { EVMDeploymentParser } from "../utils/deployment-parser";
+import { IEvmDeployment } from "../interfaces";
+import { NumStr } from "../../common/types";
+/**
+ * Vault state returned by getVaultState
+ */
+export interface IVaultState {
+    /** Vault name from vaultName() */
+    vaultName: string;
+    /** Share token name from name() */
+    tokenName: string;
+    /** Share token symbol from symbol() */
+    tokenSymbol: string;
+    /** Share token decimals */
+    decimals: number;
+    /** Underlying asset address */
+    asset: string;
+    /** Total assets under management */
+    totalAssets: bigint;
+    /** Total shares supply */
+    totalSupply: bigint;
+    /** Maximum TVL allowed */
+    maxTVL: bigint;
+    /** Minimum withdrawable shares */
+    minWithdrawableShares: bigint;
+    /** Protocol config address */
+    protocolConfig: string;
+    /** Owner address */
+    owner: string;
+    /** Current sequence number for events */
+    sequenceNumber: bigint;
+}
+/**
+ * Vault rate information
+ */
+export interface IVaultRate {
+    /** Current rate value (18 decimals) */
+    value: bigint;
+    /** Maximum rate change allowed per update */
+    maxRateChangePerUpdate: bigint;
+    /** Minimum interval between rate updates (in ms) */
+    rateUpdateInterval: bigint;
+    /** Timestamp of last rate update (in ms) */
+    lastUpdatedAt: bigint;
+}
+/**
+ * Vault roles information
+ */
+export interface IVaultRoles {
+    /** Admin address */
+    admin: string;
+    /** Operator address */
+    operator: string;
+    /** Rate manager address */
+    rateManager: string;
+}
+/**
+ * Vault pause status
+ */
+export interface IVaultPauseStatus {
+    /** Whether deposits are paused */
+    deposits: boolean;
+    /** Whether withdrawals are paused */
+    withdrawals: boolean;
+    /** Whether privileged operations are paused */
+    privilegedOperations: boolean;
+}
+/**
+ * Vault platform fee information
+ */
+export interface IVaultPlatformFee {
+    /** Accrued fee amount */
+    accrued: bigint;
+    /** Timestamp when fee was last charged */
+    lastChargedAt: bigint;
+    /** Fee percentage (in basis points or similar) */
+    platformFeePercentage: bigint;
+    /** Address that receives platform fees */
+    platformFeeRecipient: string;
+}
+/**
+ * Account state in a vault
+ */
+export interface IAccountState {
+    /** Total shares pending withdrawal */
+    totalPendingWithdrawalShares: bigint;
+    /** Sequence numbers of pending withdrawal requests */
+    pendingWithdrawalRequestSequenceNumbers: bigint[];
+    /** Sequence numbers of cancelled withdrawal requests */
+    cancelWithdrawRequestSequenceNumbers: bigint[];
+}
+/**
+ * Withdrawal request information
+ */
+export interface IWithdrawalRequest {
+    /** Owner of the shares */
+    owner: string;
+    /** Receiver of the withdrawn assets */
+    receiver: string;
+    /** Number of shares to redeem */
+    shares: bigint;
+    /** Estimated asset amount at time of request */
+    estimatedWithdrawAmount: bigint;
+    /** Timestamp when request was created */
+    timestamp: bigint;
+    /** Unique sequence number for this request */
+    sequenceNumber: bigint;
+}
+/**
+ * Complete vault information combining all queries
+ */
+export interface ICompleteVaultInfo {
+    address: string;
+    state: IVaultState;
+    rate: IVaultRate;
+    roles: IVaultRoles;
+    pauseStatus: IVaultPauseStatus;
+    platformFee: IVaultPlatformFee;
+    pendingWithdrawalsCount: bigint;
+}
+/**
+ * User's position in a vault
+ */
+export interface IUserPosition {
+    /** Share balance */
+    shareBalance: bigint;
+    /** Equivalent asset value (based on current rate) */
+    assetValue: bigint;
+    /** Account state including pending withdrawals */
+    accountState: IAccountState;
+    /** Max deposit allowed for this user */
+    maxDeposit: bigint;
+    /** Max mint allowed for this user */
+    maxMint: bigint;
+    /** Max redeem allowed for this user */
+    maxRedeem: bigint;
+    /** Max withdraw allowed for this user */
+    maxWithdraw: bigint;
+}
+/**
+ * EVM Vault Reader - Read-only operations for Ember Vaults
+ *
+ * This class provides methods to query vault state, user positions,
+ * and other read-only data from Ember vaults on EVM chains.
+ *
+ * @example
+ * ```typescript
+ * import { EVMVaultReader } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const reader = new EVMVaultReader(deployment, provider);
+ *
+ * // Get complete vault information
+ * const vaultInfo = await reader.getCompleteVaultInfo(vaultAddress);
+ * console.log("Total Assets:", vaultInfo.state.totalAssets);
+ *
+ * // Get user's position
+ * const position = await reader.getUserPosition(vaultAddress, userAddress);
+ * console.log("Share Balance:", position.shareBalance);
+ * ```
+ */
+export declare class EVMVaultReader {
+    parser: EVMDeploymentParser;
+    provider: Provider;
+    constructor(_deployment: IEvmDeployment, _provider: Provider);
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration
+     */
+    updateDeployment(newDeployment: IEvmDeployment): void;
+    /**
+     * Creates an ethers Contract instance for a vault
+     */
+    private getVaultContract;
+    /**
+     * Creates an ethers Contract instance for protocol config
+     */
+    private getProtocolConfigContract;
+    /**
+     * Creates an ethers Contract instance for an ERC20 token
+     */
+    private getERC20Contract;
+    /**
+     * Gets the basic vault state
+     * @param vaultAddress The vault address
+     * @returns Vault state information
+     */
+    getVaultState(vaultAddress: string): Promise<IVaultState>;
+    /**
+     * Gets the vault rate information
+     * @param vaultAddress The vault address
+     * @returns Rate information
+     */
+    getVaultRate(vaultAddress: string): Promise<IVaultRate>;
+    /**
+     * Gets the vault roles (admin, operator, rate manager)
+     * @param vaultAddress The vault address
+     * @returns Vault roles
+     */
+    getVaultRoles(vaultAddress: string): Promise<IVaultRoles>;
+    /**
+     * Gets the vault pause status
+     * @param vaultAddress The vault address
+     * @returns Pause status for different operations
+     */
+    getVaultPauseStatus(vaultAddress: string): Promise<IVaultPauseStatus>;
+    /**
+     * Gets the platform fee information
+     * @param vaultAddress The vault address
+     * @returns Platform fee information
+     */
+    getVaultPlatformFee(vaultAddress: string): Promise<IVaultPlatformFee>;
+    /**
+     * Gets complete vault information in a single call
+     * @param vaultAddress The vault address
+     * @returns Complete vault information
+     */
+    getCompleteVaultInfo(vaultAddress: string): Promise<ICompleteVaultInfo>;
+    /**
+     * Gets the underlying asset address
+     * @param vaultAddress The vault address
+     * @returns Asset address
+     */
+    getAsset(vaultAddress: string): Promise<string>;
+    /**
+     * Gets total assets under management
+     * @param vaultAddress The vault address
+     * @returns Total assets
+     */
+    getTotalAssets(vaultAddress: string): Promise<bigint>;
+    /**
+     * Gets total shares supply
+     * @param vaultAddress The vault address
+     * @returns Total supply
+     */
+    getTotalSupply(vaultAddress: string): Promise<bigint>;
+    /**
+     * Converts assets to shares
+     * @param vaultAddress The vault address
+     * @param assets Amount of assets
+     * @returns Equivalent shares
+     */
+    convertToShares(vaultAddress: string, assets: NumStr): Promise<bigint>;
+    /**
+     * Converts shares to assets
+     * @param vaultAddress The vault address
+     * @param shares Amount of shares
+     * @returns Equivalent assets
+     */
+    convertToAssets(vaultAddress: string, shares: NumStr): Promise<bigint>;
+    /**
+     * Preview deposit - returns shares that would be minted
+     * @param vaultAddress The vault address
+     * @param assets Amount of assets to deposit
+     * @returns Shares that would be minted
+     */
+    previewDeposit(vaultAddress: string, assets: NumStr): Promise<bigint>;
+    /**
+     * Preview mint - returns assets required for shares
+     * @param vaultAddress The vault address
+     * @param shares Amount of shares to mint
+     * @returns Assets required
+     */
+    previewMint(vaultAddress: string, shares: NumStr): Promise<bigint>;
+    /**
+     * Preview redeem - returns assets that would be received
+     * @param vaultAddress The vault address
+     * @param shares Amount of shares to redeem
+     * @returns Assets that would be received
+     */
+    previewRedeem(vaultAddress: string, shares: NumStr): Promise<bigint>;
+    /**
+     * Preview withdraw - returns shares that would be burned
+     * @param vaultAddress The vault address
+     * @param assets Amount of assets to withdraw
+     * @returns Shares that would be burned
+     */
+    previewWithdraw(vaultAddress: string, assets: NumStr): Promise<bigint>;
+    /**
+     * Gets max deposit for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum deposit amount
+     */
+    maxDeposit(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets max mint for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum mint amount
+     */
+    maxMint(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets max redeem for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum redeem amount
+     */
+    maxRedeem(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets max withdraw for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum withdraw amount
+     */
+    maxWithdraw(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets the share balance for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Share balance
+     */
+    balanceOf(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets the allowance for a spender
+     * @param vaultAddress The vault address
+     * @param owner The owner address
+     * @param spender The spender address
+     * @returns Allowance amount
+     */
+    allowance(vaultAddress: string, owner: string, spender: string): Promise<bigint>;
+    /**
+     * Gets the account state including pending withdrawals
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Account state
+     */
+    getAccountState(vaultAddress: string, account: string): Promise<IAccountState>;
+    /**
+     * Gets complete user position in a vault
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Complete user position
+     */
+    getUserPosition(vaultAddress: string, account: string): Promise<IUserPosition>;
+    /**
+     * Gets the number of pending withdrawal requests
+     * @param vaultAddress The vault address
+     * @returns Count of pending withdrawals
+     */
+    getPendingWithdrawalsCount(vaultAddress: string): Promise<bigint>;
+    /**
+     * Gets a pending withdrawal request by index
+     * @param vaultAddress The vault address
+     * @param index The index in the pending withdrawals queue
+     * @returns Withdrawal request details
+     */
+    getPendingWithdrawal(vaultAddress: string, index: NumStr): Promise<IWithdrawalRequest>;
+    /**
+     * Gets all pending withdrawal requests for a vault
+     * @param vaultAddress The vault address
+     * @returns Array of withdrawal requests
+     */
+    getAllPendingWithdrawals(vaultAddress: string): Promise<IWithdrawalRequest[]>;
+    /**
+     * Checks if an address is a sub-account
+     * @param vaultAddress The vault address
+     * @param account The account to check
+     * @returns True if the account is a sub-account
+     */
+    isSubAccount(vaultAddress: string, account: string): Promise<boolean>;
+    /**
+     * Gets the underlying token balance for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Token balance
+     */
+    getUnderlyingTokenBalance(vaultAddress: string, account: string): Promise<bigint>;
+    /**
+     * Gets the underlying token allowance for the vault
+     * @param vaultAddress The vault address
+     * @param owner The token owner
+     * @returns Allowance for the vault
+     */
+    getUnderlyingTokenAllowance(vaultAddress: string, owner: string): Promise<bigint>;
+    /**
+     * Gets the protocol pause status
+     * @returns True if protocol is paused
+     */
+    isProtocolPaused(): Promise<boolean>;
+    /**
+     * Gets the platform fee recipient
+     * @returns Fee recipient address
+     */
+    getPlatformFeeRecipient(): Promise<string>;
+    /**
+     * Gets the max fee percentage
+     * @returns Max fee percentage
+     */
+    getMaxFeePercentage(): Promise<bigint>;
+    /**
+     * Checks if an account is blacklisted
+     * @param account The account to check
+     * @returns True if blacklisted
+     */
+    isBlacklisted(account: string): Promise<boolean>;
+    /**
+     * Gets the chain timestamp in milliseconds
+     * @param vaultAddress The vault address
+     * @returns Chain timestamp in ms
+     */
+    getChainTimestampMs(vaultAddress: string): Promise<bigint>;
+    /**
+     * Gets information for multiple vaults
+     * @param vaultAddresses Array of vault addresses
+     * @returns Array of complete vault info
+     */
+    getMultipleVaultsInfo(vaultAddresses: string[]): Promise<ICompleteVaultInfo[]>;
+    /**
+     * Gets user positions across multiple vaults
+     * @param vaultAddresses Array of vault addresses
+     * @param account The account address
+     * @returns Array of user positions
+     */
+    getUserPositionsMultipleVaults(vaultAddresses: string[], account: string): Promise<{
+        vault: string;
+        position: IUserPosition;
+    }[]>;
+    /**
+     * Gets all vault addresses from deployment
+     * @returns Array of vault addresses
+     */
+    getAllVaultAddresses(): string[];
+    /**
+     * Gets complete info for all vaults in deployment
+     * @returns Array of complete vault info for all vaults
+     */
+    getAllVaultsInfo(): Promise<ICompleteVaultInfo[]>;
+}