@ember-finance/sdk 1.0.29 → 1.1.0

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

@@ -0,0 +1,179 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMUserCalls = void 0;
+const ethers_1 = require("ethers");
+const onchain_calls_1 = require("./onchain-calls");
+const EmberVault_json_1 = __importDefault(require("../../abis/EmberVault.json"));
+/**
+ * User Calls for Ember Protocol on EVM (ERC-4626 Compatible)
+ *
+ * This class extends EVMOnChainCalls and provides user-specific methods
+ * for interacting with Ember vaults.
+ *
+ * Users can:
+ * - deposit: Deposit assets and receive shares (ERC-4626)
+ * - mint: Mint a specific number of shares by depositing assets (ERC-4626)
+ * - redeemShares: Initiate a withdrawal request by redeeming shares
+ * - cancelPendingWithdrawalRequest: Cancel a pending withdrawal
+ *
+ * Note: The vault is now itself an ERC20 token (the share token), so there's
+ * no separate receipt token. The token address passed to deposit/mint should
+ * be the vault's underlying asset (accessible via vault.asset()).
+ *
+ * @example
+ * ```typescript
+ * import { EVMUserCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const userCalls = new EVMUserCalls(deployment, signer, provider);
+ *
+ * // Approve token spending first
+ * await userCalls.approveToken(underlyingAsset, vaultAddress, amount);
+ *
+ * // Deposit assets (receiver defaults to caller)
+ * await userCalls.deposit(vaultAddress, amount);
+ *
+ * // Deposit assets to a different receiver
+ * await userCalls.deposit(vaultAddress, amount, { receiver: otherAddress });
+ *
+ * // Mint specific shares (receiver defaults to caller)
+ * await userCalls.mint(vaultAddress, shares);
+ *
+ * // Redeem shares (receiver defaults to caller)
+ * await userCalls.redeemShares(vaultAddress, shares);
+ * ```
+ */
+class EVMUserCalls extends onchain_calls_1.EVMOnChainCalls {
+    constructor(_deployment, _signer, _provider, _walletAddress) {
+        super(_deployment, _signer, _provider, _walletAddress);
+    }
+    // ============================================
+    // Deposit Methods (ERC-4626)
+    // ============================================
+    /**
+     * Deposit assets into a vault (ERC-4626 standard)
+     *
+     * The vault uses its configured underlying asset (accessible via vault.asset()).
+     * Make sure to approve the vault to spend the underlying asset before depositing.
+     *
+     * @param vaultAddress The address of the vault
+     * @param assets The amount of assets to deposit
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     */
+    async deposit(vaultAddress, assets, options) {
+        const receiver = options?.receiver ?? (await this.getWalletAddress());
+        const txCall = this.txBuilder.deposit(vaultAddress, assets, receiver);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Mint Methods (ERC-4626)
+    // ============================================
+    /**
+     * Mint a specific number of shares by depositing assets (ERC-4626 standard)
+     *
+     * The vault will pull the required amount of underlying assets from the caller.
+     * Make sure to approve the vault to spend the underlying asset before minting.
+     *
+     * @param vaultAddress The address of the vault
+     * @param shares The number of shares to mint
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     */
+    async mint(vaultAddress, shares, options) {
+        const receiver = options?.receiver ?? (await this.getWalletAddress());
+        const txCall = this.txBuilder.mint(vaultAddress, shares, receiver);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Redemption Methods
+    // ============================================
+    /**
+     * Redeem shares to initiate a withdrawal request
+     *
+     * Note: This doesn't immediately return assets. It creates a withdrawal request
+     * that will be processed by the vault operator. The shares are locked until
+     * the request is processed.
+     *
+     * @param vaultAddress The address of the vault
+     * @param shares The number of shares to redeem
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     */
+    async redeemShares(vaultAddress, shares, options) {
+        const receiver = options?.receiver ?? (await this.getWalletAddress());
+        const txCall = this.txBuilder.redeemShares(vaultAddress, shares, receiver);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Withdrawal Request Management
+    // ============================================
+    /**
+     * Cancel a pending withdrawal request
+     * @param vaultAddress The address of the vault
+     * @param requestSequenceNumber The sequence number of the withdrawal request to cancel
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async cancelPendingWithdrawalRequest(vaultAddress, requestSequenceNumber, options) {
+        const txCall = this.txBuilder.cancelPendingWithdrawalRequest(vaultAddress, requestSequenceNumber);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // ERC20 Token Helpers
+    // ============================================
+    /**
+     * Approve a token for spending by a spender (typically the vault)
+     * @param tokenAddress The address of the token
+     * @param spender The address of the spender (usually the vault)
+     * @param amount The amount to approve
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async approveToken(tokenAddress, spender, amount, options) {
+        const txCall = this.txBuilder.approveToken(tokenAddress, spender, amount);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Approve maximum token spending (type(uint256).max)
+     * @param tokenAddress The address of the token
+     * @param spender The address of the spender (usually the vault)
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async approveTokenMax(tokenAddress, spender, options) {
+        // Max uint256 value
+        const maxUint256 = "115792089237316195423570985008687907853269984665640564039457584007913129639935";
+        return this.approveToken(tokenAddress, spender, maxUint256, options);
+    }
+    // ============================================
+    // Read-Only Methods
+    // ============================================
+    /**
+     * Gets the vault contract instance for read operations
+     */
+    getVaultContract(vaultAddress) {
+        if (!this.provider) {
+            throw new Error("Provider required for read operations");
+        }
+        return new ethers_1.Contract(vaultAddress, EmberVault_json_1.default.abi, this.provider);
+    }
+    /**
+     * Get the user's total vault shares (share token balance)
+     * @param vaultAddress The address of the vault
+     * @param account Optional account address (defaults to caller's wallet)
+     * @returns The user's share balance as bigint
+     */
+    async getVaultShares(vaultAddress, account) {
+        const userAddress = account ?? (await this.getWalletAddress());
+        const vault = this.getVaultContract(vaultAddress);
+        return vault.balanceOf(userAddress);
+    }
+}
+exports.EVMUserCalls = EVMUserCalls;

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

@@ -0,0 +1,137 @@
+import { Signer, Provider } from "ethers";
+import { EVMOnChainCalls } from "./onchain-calls";
+import { IEvmDeployment, IEvmCallOptions, EvmOnChainCallResponse, VaultPauseOperation } from "../interfaces";
+import { NumStr } from "../../common/types";
+/**
+ * Vault Admin Calls for Ember Protocol on EVM
+ *
+ * This class extends EVMOnChainCalls and provides vault admin-specific methods.
+ * These methods are called via the ProtocolConfig contract (not directly on the vault).
+ *
+ * The vault admin can:
+ * - Manage vault operator and rate manager
+ * - Update pause status for different operations
+ * - Manage sub-accounts
+ * - Configure vault parameters (min withdrawable shares, max TVL, fees, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { EVMVaultAdminCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const vaultAdminCalls = new EVMVaultAdminCalls(deployment, signer, provider);
+ *
+ * // Update vault operator
+ * await vaultAdminCalls.updateVaultOperator(vaultAddress, newOperatorAddress);
+ *
+ * // Update vault fee percentage
+ * await vaultAdminCalls.updateVaultFeePercentage(vaultAddress, "50000"); // 5%
+ *
+ * // Pause deposits
+ * await vaultAdminCalls.setVaultPausedStatus(vaultAddress, "deposits", true);
+ * ```
+ */
+export declare class EVMVaultAdminCalls extends EVMOnChainCalls {
+    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    /**
+     * Update the operator of a vault
+     * @param vaultAddress The address of the vault
+     * @param newOperator The new operator address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultOperator(vaultAddress: string, newOperator: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the rate manager of a vault
+     * @param vaultAddress The address of the vault
+     * @param newRateManager The new rate manager address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultRateManager(vaultAddress: string, newRateManager: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Set the paused status of a vault operation
+     * @param vaultAddress The address of the vault
+     * @param operation The operation to pause/unpause ("deposits", "withdrawals", or "privilegedOperations")
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    setVaultPausedStatus(vaultAddress: string, operation: VaultPauseOperation, paused: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Pause deposits for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    pauseDeposits(vaultAddress: string, paused: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Pause withdrawals for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    pauseWithdrawals(vaultAddress: string, paused: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Pause privileged operations for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    pausePrivilegedOperations(vaultAddress: string, paused: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Set/unset a sub-account for the vault
+     * @param vaultAddress The address of the vault
+     * @param account The account address
+     * @param isSubAccount Whether the account should be a sub-account
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    setVaultSubAccount(vaultAddress: string, account: string, isSubAccount: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the minimum withdrawable shares of a vault
+     * @param vaultAddress The address of the vault
+     * @param minWithdrawableShares The new minimum withdrawable shares
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultMinWithdrawableShares(vaultAddress: string, minWithdrawableShares: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the maximum TVL of a vault
+     * @param vaultAddress The address of the vault
+     * @param maxTVL The new maximum TVL
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultMaxTVL(vaultAddress: string, maxTVL: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the rate update interval of a vault
+     * @param vaultAddress The address of the vault
+     * @param newInterval The new rate update interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultRateUpdateInterval(vaultAddress: string, newInterval: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the fee percentage of a vault
+     * @param vaultAddress The address of the vault
+     * @param newFeePercentage The new fee percentage
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultFeePercentage(vaultAddress: string, newFeePercentage: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the name of a vault
+     * @param vaultAddress The address of the vault
+     * @param newName The new vault name
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultName(vaultAddress: string, newName: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+}

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

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMVaultAdminCalls = void 0;
+const onchain_calls_1 = require("./onchain-calls");
+/**
+ * Vault Admin Calls for Ember Protocol on EVM
+ *
+ * This class extends EVMOnChainCalls and provides vault admin-specific methods.
+ * These methods are called via the ProtocolConfig contract (not directly on the vault).
+ *
+ * The vault admin can:
+ * - Manage vault operator and rate manager
+ * - Update pause status for different operations
+ * - Manage sub-accounts
+ * - Configure vault parameters (min withdrawable shares, max TVL, fees, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { EVMVaultAdminCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const vaultAdminCalls = new EVMVaultAdminCalls(deployment, signer, provider);
+ *
+ * // Update vault operator
+ * await vaultAdminCalls.updateVaultOperator(vaultAddress, newOperatorAddress);
+ *
+ * // Update vault fee percentage
+ * await vaultAdminCalls.updateVaultFeePercentage(vaultAddress, "50000"); // 5%
+ *
+ * // Pause deposits
+ * await vaultAdminCalls.setVaultPausedStatus(vaultAddress, "deposits", true);
+ * ```
+ */
+class EVMVaultAdminCalls extends onchain_calls_1.EVMOnChainCalls {
+    constructor(_deployment, _signer, _provider, _walletAddress) {
+        super(_deployment, _signer, _provider, _walletAddress);
+    }
+    // ============================================
+    // Operator & Rate Manager Management
+    // ============================================
+    /**
+     * Update the operator of a vault
+     * @param vaultAddress The address of the vault
+     * @param newOperator The new operator address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultOperator(vaultAddress, newOperator, options) {
+        const txCall = this.txBuilder.updateVaultOperator(vaultAddress, newOperator);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the rate manager of a vault
+     * @param vaultAddress The address of the vault
+     * @param newRateManager The new rate manager address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultRateManager(vaultAddress, newRateManager, options) {
+        const txCall = this.txBuilder.updateVaultRateManager(vaultAddress, newRateManager);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Pause Status Management
+    // ============================================
+    /**
+     * Set the paused status of a vault operation
+     * @param vaultAddress The address of the vault
+     * @param operation The operation to pause/unpause ("deposits", "withdrawals", or "privilegedOperations")
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async setVaultPausedStatus(vaultAddress, operation, paused, options) {
+        const txCall = this.txBuilder.setVaultPausedStatus(vaultAddress, operation, paused);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Pause deposits for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async pauseDeposits(vaultAddress, paused, options) {
+        return this.setVaultPausedStatus(vaultAddress, "deposits", paused, options);
+    }
+    /**
+     * Pause withdrawals for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async pauseWithdrawals(vaultAddress, paused, options) {
+        return this.setVaultPausedStatus(vaultAddress, "withdrawals", paused, options);
+    }
+    /**
+     * Pause privileged operations for a vault
+     * @param vaultAddress The address of the vault
+     * @param paused Whether to pause or unpause
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async pausePrivilegedOperations(vaultAddress, paused, options) {
+        return this.setVaultPausedStatus(vaultAddress, "privilegedOperations", paused, options);
+    }
+    // ============================================
+    // Sub-Account Management
+    // ============================================
+    /**
+     * Set/unset a sub-account for the vault
+     * @param vaultAddress The address of the vault
+     * @param account The account address
+     * @param isSubAccount Whether the account should be a sub-account
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async setVaultSubAccount(vaultAddress, account, isSubAccount, options) {
+        const txCall = this.txBuilder.setVaultSubAccount(vaultAddress, account, isSubAccount);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Vault Configuration
+    // ============================================
+    /**
+     * Update the minimum withdrawable shares of a vault
+     * @param vaultAddress The address of the vault
+     * @param minWithdrawableShares The new minimum withdrawable shares
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultMinWithdrawableShares(vaultAddress, minWithdrawableShares, options) {
+        const txCall = this.txBuilder.updateVaultMinWithdrawableShares(vaultAddress, minWithdrawableShares);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the maximum TVL of a vault
+     * @param vaultAddress The address of the vault
+     * @param maxTVL The new maximum TVL
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultMaxTVL(vaultAddress, maxTVL, options) {
+        const txCall = this.txBuilder.updateVaultMaxTVL(vaultAddress, maxTVL);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the rate update interval of a vault
+     * @param vaultAddress The address of the vault
+     * @param newInterval The new rate update interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultRateUpdateInterval(vaultAddress, newInterval, options) {
+        const txCall = this.txBuilder.updateVaultRateUpdateInterval(vaultAddress, newInterval);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the fee percentage of a vault
+     * @param vaultAddress The address of the vault
+     * @param newFeePercentage The new fee percentage
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultFeePercentage(vaultAddress, newFeePercentage, options) {
+        const txCall = this.txBuilder.updateVaultFeePercentage(vaultAddress, newFeePercentage);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the name of a vault
+     * @param vaultAddress The address of the vault
+     * @param newName The new vault name
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultName(vaultAddress, newName, options) {
+        const txCall = this.txBuilder.updateVaultName(vaultAddress, newName);
+        return this.execCall(txCall, options);
+    }
+}
+exports.EVMVaultAdminCalls = EVMVaultAdminCalls;