@ember-finance/sdk 1.0.28 → 1.1.0

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

@@ -0,0 +1,542 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMVaultReader = void 0;
+const ethers_1 = require("ethers");
+const deployment_parser_1 = require("../utils/deployment-parser");
+const EmberVault_json_1 = __importDefault(require("../../abis/EmberVault.json"));
+const EmberProtocolConfig_json_1 = __importDefault(require("../../abis/EmberProtocolConfig.json"));
+const ERC20Token_json_1 = __importDefault(require("../../abis/ERC20Token.json"));
+/**
+ * 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);
+ * ```
+ */
+class EVMVaultReader {
+    constructor(_deployment, _provider) {
+        this.parser = new deployment_parser_1.EVMDeploymentParser(_deployment);
+        this.provider = _provider;
+    }
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration
+     */
+    updateDeployment(newDeployment) {
+        this.parser.updateDeployment(newDeployment);
+    }
+    /**
+     * Creates an ethers Contract instance for a vault
+     */
+    getVaultContract(vaultAddress) {
+        return new ethers_1.Contract(vaultAddress, EmberVault_json_1.default.abi, this.provider);
+    }
+    /**
+     * Creates an ethers Contract instance for protocol config
+     */
+    getProtocolConfigContract() {
+        const configAddress = this.parser.getProtocolConfigAddress();
+        return new ethers_1.Contract(configAddress, EmberProtocolConfig_json_1.default.abi, this.provider);
+    }
+    /**
+     * Creates an ethers Contract instance for an ERC20 token
+     */
+    getERC20Contract(tokenAddress) {
+        return new ethers_1.Contract(tokenAddress, ERC20Token_json_1.default.abi, this.provider);
+    }
+    // ========== Vault State Methods ==========
+    /**
+     * Gets the basic vault state
+     * @param vaultAddress The vault address
+     * @returns Vault state information
+     */
+    async getVaultState(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        const [vaultName, tokenName, tokenSymbol, decimals, asset, totalAssets, totalSupply, maxTVL, minWithdrawableShares, protocolConfig, owner, sequenceNumber] = await Promise.all([
+            vault.vaultName(),
+            vault.name(),
+            vault.symbol(),
+            vault.decimals(),
+            vault.asset(),
+            vault.totalAssets(),
+            vault.totalSupply(),
+            vault.maxTVL(),
+            vault.minWithdrawableShares(),
+            vault.protocolConfig(),
+            vault.owner(),
+            vault.sequenceNumber()
+        ]);
+        return {
+            vaultName,
+            tokenName,
+            tokenSymbol,
+            decimals: Number(decimals),
+            asset,
+            totalAssets,
+            totalSupply,
+            maxTVL,
+            minWithdrawableShares,
+            protocolConfig,
+            owner,
+            sequenceNumber
+        };
+    }
+    /**
+     * Gets the vault rate information
+     * @param vaultAddress The vault address
+     * @returns Rate information
+     */
+    async getVaultRate(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        const rate = await vault.rate();
+        return {
+            value: rate.value,
+            maxRateChangePerUpdate: rate.maxRateChangePerUpdate,
+            rateUpdateInterval: rate.rateUpdateInterval,
+            lastUpdatedAt: rate.lastUpdatedAt
+        };
+    }
+    /**
+     * Gets the vault roles (admin, operator, rate manager)
+     * @param vaultAddress The vault address
+     * @returns Vault roles
+     */
+    async getVaultRoles(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        const roles = await vault.roles();
+        return {
+            admin: roles.admin,
+            operator: roles.operator,
+            rateManager: roles.rateManager
+        };
+    }
+    /**
+     * Gets the vault pause status
+     * @param vaultAddress The vault address
+     * @returns Pause status for different operations
+     */
+    async getVaultPauseStatus(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        const status = await vault.pauseStatus();
+        return {
+            deposits: status.deposits,
+            withdrawals: status.withdrawals,
+            privilegedOperations: status.privilegedOperations
+        };
+    }
+    /**
+     * Gets the platform fee information
+     * @param vaultAddress The vault address
+     * @returns Platform fee information
+     */
+    async getVaultPlatformFee(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        const fee = await vault.platformFee();
+        return {
+            accrued: fee.accrued,
+            lastChargedAt: fee.lastChargedAt,
+            platformFeePercentage: fee.platformFeePercentage,
+            platformFeeRecipient: fee.platformFeeRecipient
+        };
+    }
+    /**
+     * Gets complete vault information in a single call
+     * @param vaultAddress The vault address
+     * @returns Complete vault information
+     */
+    async getCompleteVaultInfo(vaultAddress) {
+        const [state, rate, roles, pauseStatus, platformFee, pendingWithdrawalsCount] = await Promise.all([
+            this.getVaultState(vaultAddress),
+            this.getVaultRate(vaultAddress),
+            this.getVaultRoles(vaultAddress),
+            this.getVaultPauseStatus(vaultAddress),
+            this.getVaultPlatformFee(vaultAddress),
+            this.getPendingWithdrawalsCount(vaultAddress)
+        ]);
+        return {
+            address: vaultAddress,
+            state,
+            rate,
+            roles,
+            pauseStatus,
+            platformFee,
+            pendingWithdrawalsCount
+        };
+    }
+    // ========== ERC-4626 Methods ==========
+    /**
+     * Gets the underlying asset address
+     * @param vaultAddress The vault address
+     * @returns Asset address
+     */
+    async getAsset(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.asset();
+    }
+    /**
+     * Gets total assets under management
+     * @param vaultAddress The vault address
+     * @returns Total assets
+     */
+    async getTotalAssets(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.totalAssets();
+    }
+    /**
+     * Gets total shares supply
+     * @param vaultAddress The vault address
+     * @returns Total supply
+     */
+    async getTotalSupply(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.totalSupply();
+    }
+    /**
+     * Converts assets to shares
+     * @param vaultAddress The vault address
+     * @param assets Amount of assets
+     * @returns Equivalent shares
+     */
+    async convertToShares(vaultAddress, assets) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.convertToShares(assets);
+    }
+    /**
+     * Converts shares to assets
+     * @param vaultAddress The vault address
+     * @param shares Amount of shares
+     * @returns Equivalent assets
+     */
+    async convertToAssets(vaultAddress, shares) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.convertToAssets(shares);
+    }
+    /**
+     * 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
+     */
+    async previewDeposit(vaultAddress, assets) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.previewDeposit(assets);
+    }
+    /**
+     * Preview mint - returns assets required for shares
+     * @param vaultAddress The vault address
+     * @param shares Amount of shares to mint
+     * @returns Assets required
+     */
+    async previewMint(vaultAddress, shares) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.previewMint(shares);
+    }
+    /**
+     * 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
+     */
+    async previewRedeem(vaultAddress, shares) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.previewRedeem(shares);
+    }
+    /**
+     * 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
+     */
+    async previewWithdraw(vaultAddress, assets) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.previewWithdraw(assets);
+    }
+    /**
+     * Gets max deposit for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum deposit amount
+     */
+    async maxDeposit(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.maxDeposit(account);
+    }
+    /**
+     * Gets max mint for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum mint amount
+     */
+    async maxMint(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.maxMint(account);
+    }
+    /**
+     * Gets max redeem for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum redeem amount
+     */
+    async maxRedeem(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.maxRedeem(account);
+    }
+    /**
+     * Gets max withdraw for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Maximum withdraw amount
+     */
+    async maxWithdraw(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.maxWithdraw(account);
+    }
+    // ========== User Position Methods ==========
+    /**
+     * Gets the share balance for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Share balance
+     */
+    async balanceOf(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.balanceOf(account);
+    }
+    /**
+     * Gets the allowance for a spender
+     * @param vaultAddress The vault address
+     * @param owner The owner address
+     * @param spender The spender address
+     * @returns Allowance amount
+     */
+    async allowance(vaultAddress, owner, spender) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.allowance(owner, spender);
+    }
+    /**
+     * Gets the account state including pending withdrawals
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Account state
+     */
+    async getAccountState(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        const state = await vault.getAccountState(account);
+        return {
+            totalPendingWithdrawalShares: state.totalPendingWithdrawalShares,
+            pendingWithdrawalRequestSequenceNumbers: [
+                ...state.pendingWithdrawalRequestSequenceNumbers
+            ],
+            cancelWithdrawRequestSequenceNumbers: [
+                ...state.cancelWithdrawRequestSequenceNumbers
+            ]
+        };
+    }
+    /**
+     * Gets complete user position in a vault
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Complete user position
+     */
+    async getUserPosition(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        const [shareBalance, accountState, maxDepositVal, maxMintVal, maxRedeemVal, maxWithdrawVal] = await Promise.all([
+            vault.balanceOf(account),
+            this.getAccountState(vaultAddress, account),
+            vault.maxDeposit(account),
+            vault.maxMint(account),
+            vault.maxRedeem(account),
+            vault.maxWithdraw(account)
+        ]);
+        // Convert shares to assets
+        const assetValue = shareBalance > 0n ? await vault.convertToAssets(shareBalance) : 0n;
+        return {
+            shareBalance,
+            assetValue,
+            accountState,
+            maxDeposit: maxDepositVal,
+            maxMint: maxMintVal,
+            maxRedeem: maxRedeemVal,
+            maxWithdraw: maxWithdrawVal
+        };
+    }
+    // ========== Withdrawal Request Methods ==========
+    /**
+     * Gets the number of pending withdrawal requests
+     * @param vaultAddress The vault address
+     * @returns Count of pending withdrawals
+     */
+    async getPendingWithdrawalsCount(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.getPendingWithdrawalsLength();
+    }
+    /**
+     * 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
+     */
+    async getPendingWithdrawal(vaultAddress, index) {
+        const vault = this.getVaultContract(vaultAddress);
+        const request = await vault.getPendingWithdrawal(index);
+        return {
+            owner: request.owner,
+            receiver: request.receiver,
+            shares: request.shares,
+            estimatedWithdrawAmount: request.estimatedWithdrawAmount,
+            timestamp: request.timestamp,
+            sequenceNumber: request.sequenceNumber
+        };
+    }
+    /**
+     * Gets all pending withdrawal requests for a vault
+     * @param vaultAddress The vault address
+     * @returns Array of withdrawal requests
+     */
+    async getAllPendingWithdrawals(vaultAddress) {
+        const count = await this.getPendingWithdrawalsCount(vaultAddress);
+        const requests = [];
+        const promises = [];
+        for (let i = 0n; i < count; i++) {
+            promises.push(this.getPendingWithdrawal(vaultAddress, i));
+        }
+        const results = await Promise.all(promises);
+        requests.push(...results);
+        return requests;
+    }
+    // ========== Sub-Account Methods ==========
+    /**
+     * 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
+     */
+    async isSubAccount(vaultAddress, account) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.subAccounts(account);
+    }
+    // ========== Token Balance Methods ==========
+    /**
+     * Gets the underlying token balance for an account
+     * @param vaultAddress The vault address
+     * @param account The account address
+     * @returns Token balance
+     */
+    async getUnderlyingTokenBalance(vaultAddress, account) {
+        const assetAddress = await this.getAsset(vaultAddress);
+        const token = this.getERC20Contract(assetAddress);
+        return token.balanceOf(account);
+    }
+    /**
+     * Gets the underlying token allowance for the vault
+     * @param vaultAddress The vault address
+     * @param owner The token owner
+     * @returns Allowance for the vault
+     */
+    async getUnderlyingTokenAllowance(vaultAddress, owner) {
+        const assetAddress = await this.getAsset(vaultAddress);
+        const token = this.getERC20Contract(assetAddress);
+        return token.allowance(owner, vaultAddress);
+    }
+    // ========== Protocol Config Methods ==========
+    /**
+     * Gets the protocol pause status
+     * @returns True if protocol is paused
+     */
+    async isProtocolPaused() {
+        const config = this.getProtocolConfigContract();
+        return config.isPaused();
+    }
+    /**
+     * Gets the platform fee recipient
+     * @returns Fee recipient address
+     */
+    async getPlatformFeeRecipient() {
+        const config = this.getProtocolConfigContract();
+        return config.platformFeeRecipient();
+    }
+    /**
+     * Gets the max fee percentage
+     * @returns Max fee percentage
+     */
+    async getMaxFeePercentage() {
+        const config = this.getProtocolConfigContract();
+        return config.maxFeePercentage();
+    }
+    /**
+     * Checks if an account is blacklisted
+     * @param account The account to check
+     * @returns True if blacklisted
+     */
+    async isBlacklisted(account) {
+        const config = this.getProtocolConfigContract();
+        return config.blacklistedAccounts(account);
+    }
+    /**
+     * Gets the chain timestamp in milliseconds
+     * @param vaultAddress The vault address
+     * @returns Chain timestamp in ms
+     */
+    async getChainTimestampMs(vaultAddress) {
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.getChainTimestampMs();
+    }
+    // ========== Batch Query Methods ==========
+    /**
+     * Gets information for multiple vaults
+     * @param vaultAddresses Array of vault addresses
+     * @returns Array of complete vault info
+     */
+    async getMultipleVaultsInfo(vaultAddresses) {
+        const promises = vaultAddresses.map(addr => this.getCompleteVaultInfo(addr));
+        return Promise.all(promises);
+    }
+    /**
+     * Gets user positions across multiple vaults
+     * @param vaultAddresses Array of vault addresses
+     * @param account The account address
+     * @returns Array of user positions
+     */
+    async getUserPositionsMultipleVaults(vaultAddresses, account) {
+        const promises = vaultAddresses.map(async (addr) => ({
+            vault: addr,
+            position: await this.getUserPosition(addr, account)
+        }));
+        return Promise.all(promises);
+    }
+    /**
+     * Gets all vault addresses from deployment
+     * @returns Array of vault addresses
+     */
+    getAllVaultAddresses() {
+        return this.parser.getVaultAddresses();
+    }
+    /**
+     * Gets complete info for all vaults in deployment
+     * @returns Array of complete vault info for all vaults
+     */
+    async getAllVaultsInfo() {
+        const addresses = this.getAllVaultAddresses();
+        return this.getMultipleVaultsInfo(addresses);
+    }
+}
+exports.EVMVaultReader = EVMVaultReader;

package/dist/src/evm-vaults/utils/deployment-parser.d.ts

@@ -0,0 +1,97 @@
+import { IEvmDeployment } from "../interfaces";
+export declare class EVMDeploymentParser {
+    deployment: IEvmDeployment;
+    constructor(_deployment: IEvmDeployment);
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration
+     */
+    updateDeployment(newDeployment: IEvmDeployment): void;
+    /**
+     * Gets the network name (e.g., "sepolia", "mainnet")
+     */
+    getNetwork(): string;
+    /**
+     * Gets the chain ID
+     */
+    getChainId(): string;
+    /**
+     * Gets the protocol config proxy address
+     */
+    getProtocolConfigAddress(): string;
+    /**
+     * Gets the protocol config implementation address
+     */
+    getProtocolConfigImplementationAddress(): string;
+    /**
+     * Gets the protocol config owner address
+     */
+    getProtocolConfigOwner(): string;
+    /**
+     * Gets a receipt token address by its symbol
+     * @param symbol The receipt token symbol (e.g., "eUSDC")
+     */
+    getReceiptTokenAddress(symbol: string): string;
+    /**
+     * Gets receipt token decimals by its symbol
+     * @param symbol The receipt token symbol (e.g., "eUSDC")
+     */
+    getReceiptTokenDecimals(symbol: string): number;
+    /**
+     * Gets a vault's proxy address by its key
+     * @param vaultKey The vault key (e.g., "emberUsdcVault")
+     */
+    getVaultAddress(vaultKey: string): string;
+    /**
+     * Gets vault info by its proxy address
+     * @param vaultAddress The vault's proxy address
+     */
+    getVaultByAddress(vaultAddress: string): IEvmDeployment["contracts"]["vaults"][string];
+    /**
+     * Gets the base token address for a vault
+     * @param vaultAddress The vault's proxy address
+     */
+    getBaseTokenAddress(vaultAddress: string): string;
+    /**
+     * Gets the receipt token address for a vault
+     * @param vaultAddress The vault's proxy address
+     */
+    getReceiptTokenAddressForVault(vaultAddress: string): string;
+    /**
+     * Gets the base token name for a vault
+     * @param vaultAddress The vault's proxy address
+     */
+    getBaseTokenName(vaultAddress: string): string;
+    /**
+     * Gets the vault admin address
+     * @param vaultAddress The vault's proxy address
+     */
+    getVaultAdmin(vaultAddress: string): string;
+    /**
+     * Gets the vault operator address
+     * @param vaultAddress The vault's proxy address
+     */
+    getVaultOperator(vaultAddress: string): string;
+    /**
+     * Gets the vault rate manager address
+     * @param vaultAddress The vault's proxy address
+     */
+    getVaultRateManager(vaultAddress: string): string;
+    /**
+     * Gets the vault's max TVL
+     * @param vaultAddress The vault's proxy address
+     */
+    getVaultMaxTVL(vaultAddress: string): string;
+    /**
+     * Gets all vault keys
+     */
+    getVaultKeys(): string[];
+    /**
+     * Gets all vault addresses
+     */
+    getVaultAddresses(): string[];
+    /**
+     * Gets all receipt token symbols
+     */
+    getReceiptTokenSymbols(): string[];
+}