@ember-finance/sdk 1.0.28 → 1.1.0

package/dist/src/evm-vaults/on-chain-calls/tx-builder.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.EVMTxBuilder = void 0;
+const utils_1 = require("../utils");
+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 Transaction Builder for Ember Protocol (ERC-4626 Compatible)
+ *
+ * This class provides methods to build transaction calls for the Ember Protocol
+ * on EVM-compatible chains. The vault contracts now implement ERC-4626 standard
+ * and are themselves ERC20 tokens representing shares.
+ *
+ * @example
+ * ```typescript
+ * import { EVMTxBuilder } from "@ember-finance/sdk";
+ * import { encodeFunctionData } from "viem";
+ *
+ * const txBuilder = new EVMTxBuilder(deployment);
+ * const txCall = txBuilder.deposit(vaultAddress, amount, receiver);
+ *
+ * // Encode with viem
+ * const data = encodeFunctionData({
+ *   abi: txCall.abi,
+ *   functionName: txCall.functionName,
+ *   args: txCall.args
+ * });
+ *
+ * // Or with ethers.js
+ * const contract = new ethers.Contract(txCall.to, txCall.abi, signer);
+ * await contract[txCall.functionName](...txCall.args);
+ * ```
+ */
+class EVMTxBuilder {
+    constructor(_deployment) {
+        this.parser = new utils_1.EVMDeploymentParser(_deployment);
+    }
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration
+     */
+    updateDeployment(newDeployment) {
+        this.parser.updateDeployment(newDeployment);
+    }
+    /**
+     * Gets the chain ID from the deployment
+     */
+    getChainId() {
+        return this.parser.getChainId();
+    }
+    // ============================================
+    // Protocol Config Admin Methods
+    // ============================================
+    /**
+     * Pauses or unpauses non-admin operations at the protocol level
+     * @param pause True to pause, false to unpause
+     * @returns Transaction call object
+     */
+    pauseNonAdminOperations(pause) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "pauseNonAdminOperations",
+            args: [pause],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the platform fee recipient address
+     * @param recipient New recipient address
+     * @returns Transaction call object
+     */
+    updatePlatformFeeRecipient(recipient) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updatePlatformFeeRecipient",
+            args: [recipient],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the minimum rate for the protocol
+     * @param minRate New minimum rate
+     * @returns Transaction call object
+     */
+    updateMinRate(minRate) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateMinRate",
+            args: [BigInt(minRate)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the maximum rate for the protocol
+     * @param maxRate New maximum rate
+     * @returns Transaction call object
+     */
+    updateMaxRate(maxRate) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateMaxRate",
+            args: [BigInt(maxRate)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the maximum rate interval for the protocol
+     * @param maxRateInterval New maximum rate interval
+     * @returns Transaction call object
+     */
+    updateMaxRateInterval(maxRateInterval) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateMaxRateInterval",
+            args: [BigInt(maxRateInterval)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the minimum rate interval for the protocol
+     * @param minRateInterval New minimum rate interval
+     * @returns Transaction call object
+     */
+    updateMinRateInterval(minRateInterval) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateMinRateInterval",
+            args: [BigInt(minRateInterval)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the default rate for the protocol
+     * @param defaultRate New default rate
+     * @returns Transaction call object
+     */
+    updateDefaultRate(defaultRate) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateDefaultRate",
+            args: [BigInt(defaultRate)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the maximum fee percentage for the protocol
+     * @param maxFeePercentage New maximum fee percentage
+     * @returns Transaction call object
+     */
+    updateMaxFeePercentage(maxFeePercentage) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateMaxFeePercentage",
+            args: [BigInt(maxFeePercentage)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Sets whether an account is blacklisted at the protocol level
+     * @param account Address of the account
+     * @param isBlacklisted Whether the account should be blacklisted
+     * @returns Transaction call object
+     */
+    setBlacklistedAccount(account, isBlacklisted) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "setBlacklistedAccount",
+            args: [account, isBlacklisted],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    // ============================================
+    // Vault Admin Methods (via ProtocolConfig)
+    // These methods are called on the ProtocolConfig contract
+    // and require the vault address as the first parameter
+    // ============================================
+    /**
+     * Updates the admin of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newAdmin New admin address
+     * @returns Transaction call object
+     */
+    updateVaultAdmin(vaultAddress, newAdmin) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultAdmin",
+            args: [vaultAddress, newAdmin],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the paused status of a vault operation (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param operation The operation to pause/unpause ("deposits", "withdrawals", or "privilegedOperations")
+     * @param paused Whether to pause or unpause
+     * @returns Transaction call object
+     */
+    setVaultPausedStatus(vaultAddress, operation, paused) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "setVaultPausedStatus",
+            args: [vaultAddress, operation, paused],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the operator of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newOperator New operator address
+     * @returns Transaction call object
+     */
+    updateVaultOperator(vaultAddress, newOperator) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultOperator",
+            args: [vaultAddress, newOperator],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the rate manager of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newRateManager New rate manager address
+     * @returns Transaction call object
+     */
+    updateVaultRateManager(vaultAddress, newRateManager) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultRateManager",
+            args: [vaultAddress, newRateManager],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the minimum withdrawable shares of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param minWithdrawableShares New minimum withdrawable shares
+     * @returns Transaction call object
+     */
+    updateVaultMinWithdrawableShares(vaultAddress, minWithdrawableShares) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultMinWithdrawableShares",
+            args: [vaultAddress, BigInt(minWithdrawableShares)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Sets a sub-account for the vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param account Address of the account
+     * @param isSubAccount Whether the account should be a sub-account
+     * @returns Transaction call object
+     */
+    setVaultSubAccount(vaultAddress, account, isSubAccount) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "setVaultSubAccount",
+            args: [vaultAddress, account, isSubAccount],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the maximum TVL of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param maxTVL New maximum TVL
+     * @returns Transaction call object
+     */
+    updateVaultMaxTVL(vaultAddress, maxTVL) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultMaxTVL",
+            args: [vaultAddress, BigInt(maxTVL)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the rate update interval of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newInterval New rate update interval
+     * @returns Transaction call object
+     */
+    updateVaultRateUpdateInterval(vaultAddress, newInterval) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultRateUpdateInterval",
+            args: [vaultAddress, BigInt(newInterval)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the fee percentage of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newFeePercentage New fee percentage
+     * @returns Transaction call object
+     */
+    updateVaultFeePercentage(vaultAddress, newFeePercentage) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultFeePercentage",
+            args: [vaultAddress, BigInt(newFeePercentage)],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Updates the name of a vault (called via ProtocolConfig)
+     * @param vaultAddress Address of the vault
+     * @param newName New vault name
+     * @returns Transaction call object
+     */
+    updateVaultName(vaultAddress, newName) {
+        return {
+            to: this.parser.getProtocolConfigAddress(),
+            functionName: "updateVaultName",
+            args: [vaultAddress, newName],
+            abi: EmberProtocolConfig_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    // ============================================
+    // Vault Operator/Rate Manager Methods
+    // These are called directly on the vault contract
+    // ============================================
+    /**
+     * Updates the rate of a vault (rate manager only)
+     * @param vaultAddress Address of the vault
+     * @param newRate New rate value
+     * @returns Transaction call object
+     */
+    updateVaultRate(vaultAddress, newRate) {
+        return {
+            to: vaultAddress,
+            functionName: "updateVaultRate",
+            args: [BigInt(newRate)],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Processes a specified number of withdrawal requests (operator only)
+     * @param vaultAddress Address of the vault
+     * @param numRequests Maximum number of requests to process
+     * @returns Transaction call object
+     */
+    processWithdrawalRequests(vaultAddress, numRequests) {
+        return {
+            to: vaultAddress,
+            functionName: "processWithdrawalRequests",
+            args: [BigInt(numRequests)],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Collects accrued platform fees (operator only)
+     * @param vaultAddress Address of the vault
+     * @returns Transaction call object
+     */
+    collectPlatformFee(vaultAddress) {
+        return {
+            to: vaultAddress,
+            functionName: "collectPlatformFee",
+            args: [],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Withdraws assets from the vault without redeeming shares (operator only)
+     * Used by operators to move funds to sub-accounts for strategy execution
+     * @param vaultAddress Address of the vault
+     * @param subAccount The sub-account address to withdraw to
+     * @param amount Amount to withdraw
+     * @returns Transaction call object
+     */
+    withdrawFromVaultWithoutRedeemingShares(vaultAddress, subAccount, amount) {
+        return {
+            to: vaultAddress,
+            functionName: "withdrawFromVaultWithoutRedeemingShares",
+            args: [subAccount, BigInt(amount)],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    // ============================================
+    // User Methods (ERC-4626)
+    // ============================================
+    /**
+     * Deposits assets to a vault and mints shares (ERC-4626 standard)
+     * @param vaultAddress Address of the vault
+     * @param assets Amount of assets to deposit
+     * @param receiver Address to receive the shares
+     * @returns Transaction call object
+     */
+    deposit(vaultAddress, assets, receiver) {
+        return {
+            to: vaultAddress,
+            functionName: "deposit",
+            args: [BigInt(assets), receiver],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Mints a specific number of shares by depositing assets (ERC-4626 standard)
+     * @param vaultAddress Address of the vault
+     * @param shares Amount of shares to mint
+     * @param receiver Address to receive the shares
+     * @returns Transaction call object
+     */
+    mint(vaultAddress, shares, receiver) {
+        return {
+            to: vaultAddress,
+            functionName: "mint",
+            args: [BigInt(shares), receiver],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Redeems shares to initiate a withdrawal request
+     * @param vaultAddress Address of the vault
+     * @param shares Amount of shares to redeem
+     * @param receiver Address to receive the withdrawn funds
+     * @returns Transaction call object
+     */
+    redeemShares(vaultAddress, shares, receiver) {
+        return {
+            to: vaultAddress,
+            functionName: "redeemShares",
+            args: [BigInt(shares), receiver],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    /**
+     * Cancels a pending withdrawal request
+     * @param vaultAddress Address of the vault
+     * @param requestSequenceNumber Sequence number of the withdrawal request to cancel
+     * @returns Transaction call object
+     */
+    cancelPendingWithdrawalRequest(vaultAddress, requestSequenceNumber) {
+        return {
+            to: vaultAddress,
+            functionName: "cancelPendingWithdrawalRequest",
+            args: [BigInt(requestSequenceNumber)],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    // ============================================
+    // ERC20 Helper Methods
+    // ============================================
+    /**
+     * Approves a token for spending by the vault
+     * @param tokenAddress Address of the token
+     * @param spender Address of the spender (usually the vault)
+     * @param amount Amount to approve
+     * @returns Transaction call object
+     */
+    approveToken(tokenAddress, spender, amount) {
+        return {
+            to: tokenAddress,
+            functionName: "approve",
+            args: [spender, BigInt(amount)],
+            abi: ERC20Token_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
+    // ============================================
+    // ABI Getters
+    // ============================================
+    /**
+     * Gets the EmberVault ABI
+     */
+    static getVaultABI() {
+        return EmberVault_json_1.default.abi;
+    }
+    /**
+     * Gets the EmberProtocolConfig ABI
+     */
+    static getProtocolConfigABI() {
+        return EmberProtocolConfig_json_1.default.abi;
+    }
+    /**
+     * Gets the ERC20Token ABI
+     */
+    static getERC20ABI() {
+        return ERC20Token_json_1.default.abi;
+    }
+}
+exports.EVMTxBuilder = EVMTxBuilder;

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

@@ -0,0 +1,122 @@
+import { Signer, Provider } from "ethers";
+import { EVMOnChainCalls } from "./onchain-calls";
+import { IEvmDeployment, IUserCallOptions, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces";
+import { NumStr } from "../../common/types";
+/**
+ * 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);
+ * ```
+ */
+export declare class EVMUserCalls extends EVMOnChainCalls {
+    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    /**
+     * 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
+     */
+    deposit(vaultAddress: string, assets: NumStr, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * 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
+     */
+    mint(vaultAddress: string, shares: NumStr, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * 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
+     */
+    redeemShares(vaultAddress: string, shares: NumStr, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * 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
+     */
+    cancelPendingWithdrawalRequest(vaultAddress: string, requestSequenceNumber: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * 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
+     */
+    approveToken(tokenAddress: string, spender: string, amount: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * 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
+     */
+    approveTokenMax(tokenAddress: string, spender: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Gets the vault contract instance for read operations
+     */
+    private getVaultContract;
+    /**
+     * 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
+     */
+    getVaultShares(vaultAddress: string, account?: string): Promise<bigint>;
+}