@ember-finance/sdk 1.0.28 → 1.1.0

package/dist/src/evm-vaults/interfaces/index.d.ts

@@ -0,0 +1,168 @@
+import { Signer, Provider, TransactionResponse, TransactionReceipt, Log, LogDescription } from "ethers";
+/**
+ * Represents the deployment configuration for the Ember Protocol on EVM-compatible chains
+ */
+export interface IEvmDeployment {
+    network: string;
+    chainId: string;
+    contracts: {
+        protocolConfig: {
+            proxyAddress: string;
+            implementationAddress: string;
+            ownerAddress: string;
+            version: string;
+            deployedAt: string;
+            deploymentBlockNumber: number;
+        };
+        receiptTokens: {
+            [key: string]: {
+                proxyAddress: string;
+                implementationAddress: string;
+                ownerAddress: string;
+                name: string;
+                symbol: string;
+                decimals: number;
+                version: string;
+                deployedAt: string;
+                deploymentBlockNumber: number;
+            };
+        };
+        vaults: {
+            [key: string]: {
+                proxyAddress: string;
+                implementationAddress: string;
+                ownerAddress: string;
+                name: string;
+                baseToken: string;
+                receiptToken: string;
+                baseTokenPriceFeed: string;
+                baseTokenName: string;
+                admin: string;
+                operator: string;
+                rateManager: string;
+                protocolConfig: string;
+                maxTVL: string;
+                version: string;
+                deployedAt: string;
+                deploymentBlockNumber: number;
+            };
+        };
+    };
+}
+/**
+ * Optional parameters for EVM transaction building
+ */
+export interface IEvmTxBuilderParams {
+    /** Gas limit for the transaction */
+    gasLimit?: bigint;
+    /** Max fee per gas (EIP-1559) */
+    maxFeePerGas?: bigint;
+    /** Max priority fee per gas (EIP-1559) */
+    maxPriorityFeePerGas?: bigint;
+    /** Gas price (legacy transactions) */
+    gasPrice?: bigint;
+    /** Transaction value in wei */
+    value?: bigint;
+    /** Nonce for the transaction */
+    nonce?: number;
+}
+/**
+ * Represents an encoded EVM transaction ready to be sent
+ */
+export interface IEncodedTransaction {
+    /** The target contract address */
+    to: string;
+    /** The encoded function data */
+    data: string;
+    /** The value in wei (default: 0) */
+    value: bigint;
+    /** Optional gas limit */
+    gasLimit?: bigint;
+    /** Chain ID */
+    chainId: string;
+}
+/**
+ * Vault pause operation types for EVM
+ */
+export type VaultPauseOperation = "deposits" | "withdrawals" | "privilegedOperations";
+/**
+ * Represents a transaction call that can be encoded by ethers.js
+ */
+export interface ITransactionCall {
+    /** The target contract address */
+    to: string;
+    /** The function name to call */
+    functionName: string;
+    /** The arguments to pass to the function */
+    args: unknown[];
+    /** The ABI of the contract */
+    abi: unknown[];
+    /** The value in wei (default: 0n) */
+    value: bigint;
+    /** Chain ID from deployment */
+    chainId: string;
+}
+/**
+ * Optional parameters for EVM on-chain calls
+ */
+export interface IEvmCallOptions {
+    /** If true, simulates the transaction without sending */
+    dryRun?: boolean;
+    /** If true, returns the transaction call object without executing */
+    returnTxCall?: boolean;
+    /** If true, waits for the transaction to be mined and returns receipt with events */
+    waitForReceipt?: boolean;
+    /** Number of confirmations to wait for (default: 1) */
+    confirmations?: number;
+    /** Gas limit override */
+    gasLimit?: bigint;
+}
+/**
+ * Optional parameters for user deposit/mint/redeem calls
+ */
+export interface IUserCallOptions extends IEvmCallOptions {
+    /** Receiver address for shares/funds. Defaults to the caller's address if not provided */
+    receiver?: string;
+}
+/**
+ * Parsed event from a transaction
+ */
+export interface IParsedEvent {
+    /** Event name */
+    name: string;
+    /** Event signature */
+    signature: string;
+    /** Decoded event arguments */
+    args: Record<string, unknown>;
+    /** Raw log */
+    log: Log;
+}
+/**
+ * Response for dry run calls
+ */
+export interface IDryRunResponse {
+    success: boolean;
+    /** Error message if the call failed */
+    error?: string;
+    /** Decoded return value from the call (if successful) */
+    result?: unknown;
+}
+/**
+ * Response for executed transactions with receipt
+ */
+export interface ITransactionReceiptResponse {
+    /** Transaction response */
+    response: TransactionResponse;
+    /** Transaction receipt */
+    receipt: TransactionReceipt;
+    /** Parsed events from the transaction */
+    events: IParsedEvent[];
+}
+/**
+ * Response type for EVM on-chain calls
+ */
+export type EvmOnChainCallResponse = TransactionResponse | ITransactionReceiptResponse | ITransactionCall | IDryRunResponse;
+/**
+ * Re-export ethers types for convenience
+ */
+export type { Signer, Provider, TransactionResponse, TransactionReceipt, Log, LogDescription };

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

@@ -0,0 +1,108 @@
+import { Signer, Provider } from "ethers";
+import { EVMOnChainCalls } from "./onchain-calls";
+import { IEvmDeployment, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces";
+import { NumStr } from "../../common/types";
+/**
+ * Admin Calls for Ember Protocol on EVM
+ *
+ * This class extends EVMOnChainCalls and provides admin-specific methods
+ * for managing the Ember Protocol configuration and vault administration.
+ *
+ * The protocol admin can:
+ * - Update vault admins
+ * - Configure protocol-level parameters (fees, rates, intervals)
+ * - Manage blacklisted accounts
+ * - Pause/unpause non-admin operations
+ *
+ * @example
+ * ```typescript
+ * import { EVMAdminCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const adminCalls = new EVMAdminCalls(deployment, signer, provider);
+ *
+ * // Update protocol configuration
+ * await adminCalls.updateMaxFeePercentage(newFeePercentage);
+ *
+ * // Update vault admin
+ * await adminCalls.updateVaultAdmin(vaultAddress, newAdminAddress);
+ * ```
+ */
+export declare class EVMAdminCalls extends EVMOnChainCalls {
+    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    /**
+     * Update the admin address of a vault
+     * @param vaultAddress The address of the vault
+     * @param adminAddress The new admin address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateVaultAdmin(vaultAddress: string, adminAddress: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the max fee percentage of the protocol
+     * @param maxFeePercentage The new max fee percentage
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateMaxFeePercentage(maxFeePercentage: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the default rate of the protocol
+     * @param defaultRate The new default rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateDefaultRate(defaultRate: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the max rate of the protocol
+     * @param maxRate The new max rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateMaxRate(maxRate: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the min rate of the protocol
+     * @param minRate The new min rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateMinRate(minRate: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the platform fee recipient of the protocol
+     * @param platformFeeRecipient The new platform fee recipient address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updatePlatformFeeRecipient(platformFeeRecipient: string, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Pause or unpause non-admin operations at the protocol level
+     * @param pause Whether to pause non-admin operations
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    pauseNonAdminOperations(pause: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the max rate interval of the protocol
+     * @param maxRateInterval The new max rate interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateMaxRateInterval(maxRateInterval: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Update the min rate interval of the protocol
+     * @param minRateInterval The new min rate interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    updateMinRateInterval(minRateInterval: NumStr, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Set whether an account is blacklisted at the protocol level
+     * @param account The address of the account
+     * @param isBlacklisted Whether the account should be blacklisted
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    setBlacklistedAccount(account: string, isBlacklisted: boolean, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+}

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

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVMAdminCalls = void 0;
+const onchain_calls_1 = require("./onchain-calls");
+/**
+ * Admin Calls for Ember Protocol on EVM
+ *
+ * This class extends EVMOnChainCalls and provides admin-specific methods
+ * for managing the Ember Protocol configuration and vault administration.
+ *
+ * The protocol admin can:
+ * - Update vault admins
+ * - Configure protocol-level parameters (fees, rates, intervals)
+ * - Manage blacklisted accounts
+ * - Pause/unpause non-admin operations
+ *
+ * @example
+ * ```typescript
+ * import { EVMAdminCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const adminCalls = new EVMAdminCalls(deployment, signer, provider);
+ *
+ * // Update protocol configuration
+ * await adminCalls.updateMaxFeePercentage(newFeePercentage);
+ *
+ * // Update vault admin
+ * await adminCalls.updateVaultAdmin(vaultAddress, newAdminAddress);
+ * ```
+ */
+class EVMAdminCalls extends onchain_calls_1.EVMOnChainCalls {
+    constructor(_deployment, _signer, _provider, _walletAddress) {
+        super(_deployment, _signer, _provider, _walletAddress);
+    }
+    // ============================================
+    // Vault Admin Management
+    // ============================================
+    /**
+     * Update the admin address of a vault
+     * @param vaultAddress The address of the vault
+     * @param adminAddress The new admin address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateVaultAdmin(vaultAddress, adminAddress, options) {
+        const txCall = this.txBuilder.updateVaultAdmin(vaultAddress, adminAddress);
+        return this.execCall(txCall, options);
+    }
+    // ============================================
+    // Protocol Config Admin Methods
+    // ============================================
+    /**
+     * Update the max fee percentage of the protocol
+     * @param maxFeePercentage The new max fee percentage
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateMaxFeePercentage(maxFeePercentage, options) {
+        const txCall = this.txBuilder.updateMaxFeePercentage(maxFeePercentage);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the default rate of the protocol
+     * @param defaultRate The new default rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateDefaultRate(defaultRate, options) {
+        const txCall = this.txBuilder.updateDefaultRate(defaultRate);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the max rate of the protocol
+     * @param maxRate The new max rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateMaxRate(maxRate, options) {
+        const txCall = this.txBuilder.updateMaxRate(maxRate);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the min rate of the protocol
+     * @param minRate The new min rate
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateMinRate(minRate, options) {
+        const txCall = this.txBuilder.updateMinRate(minRate);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the platform fee recipient of the protocol
+     * @param platformFeeRecipient The new platform fee recipient address
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updatePlatformFeeRecipient(platformFeeRecipient, options) {
+        const txCall = this.txBuilder.updatePlatformFeeRecipient(platformFeeRecipient);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Pause or unpause non-admin operations at the protocol level
+     * @param pause Whether to pause non-admin operations
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async pauseNonAdminOperations(pause, options) {
+        const txCall = this.txBuilder.pauseNonAdminOperations(pause);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the max rate interval of the protocol
+     * @param maxRateInterval The new max rate interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateMaxRateInterval(maxRateInterval, options) {
+        const txCall = this.txBuilder.updateMaxRateInterval(maxRateInterval);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Update the min rate interval of the protocol
+     * @param minRateInterval The new min rate interval
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async updateMinRateInterval(minRateInterval, options) {
+        const txCall = this.txBuilder.updateMinRateInterval(minRateInterval);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Set whether an account is blacklisted at the protocol level
+     * @param account The address of the account
+     * @param isBlacklisted Whether the account should be blacklisted
+     * @param options Optional tx execution params
+     * @returns EvmOnChainCallResponse
+     */
+    async setBlacklistedAccount(account, isBlacklisted, options) {
+        const txCall = this.txBuilder.setBlacklistedAccount(account, isBlacklisted);
+        return this.execCall(txCall, options);
+    }
+}
+exports.EVMAdminCalls = EVMAdminCalls;

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

@@ -0,0 +1,7 @@
+export * from "./tx-builder";
+export * from "./onchain-calls";
+export * from "./admin";
+export * from "./operator";
+export * from "./vault-admin";
+export * from "./user";
+export * from "./vault-reader";

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

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tx-builder"), exports);
+__exportStar(require("./onchain-calls"), exports);
+__exportStar(require("./admin"), exports);
+__exportStar(require("./operator"), exports);
+__exportStar(require("./vault-admin"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./vault-reader"), exports);

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

@@ -0,0 +1,79 @@
+import { Signer, Provider, Log } from "ethers";
+import { EVMDeploymentParser } from "../utils/deployment-parser";
+import { EvmOnChainCallResponse, IEvmCallOptions, IEvmDeployment, ITransactionCall, IParsedEvent } from "../interfaces";
+import { EVMTxBuilder } from "./tx-builder";
+/**
+ * EVM On-Chain Calls for Ember Protocol
+ *
+ * This class provides a higher-level interface for executing Ember Protocol
+ * transactions on EVM-compatible chains. It wraps the EVMTxBuilder and handles
+ * transaction encoding, signing, and execution using ethers.js.
+ *
+ * @example
+ * ```typescript
+ * import { EVMOnChainCalls } from "@ember-finance/sdk";
+ * import { ethers } from "ethers";
+ *
+ * const provider = new ethers.JsonRpcProvider("https://...");
+ * const signer = new ethers.Wallet(privateKey, provider);
+ *
+ * const onChainCalls = new EVMOnChainCalls(deployment, signer, provider);
+ *
+ * // Execute a transaction and wait for receipt with events
+ * const result = await onChainCalls.execCall(
+ *   onChainCalls.txBuilder.pauseDeposits(vaultAddress, true),
+ *   { waitForReceipt: true }
+ * );
+ * console.log("Events:", result.events);
+ * ```
+ */
+export declare class EVMOnChainCalls {
+    parser: EVMDeploymentParser;
+    txBuilder: EVMTxBuilder;
+    signer?: Signer;
+    provider?: Provider;
+    walletAddress?: string;
+    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration
+     */
+    updateDeployment(newDeployment: IEvmDeployment): void;
+    /**
+     * Gets the wallet address
+     * @returns The wallet address
+     */
+    getWalletAddress(): Promise<string>;
+    /**
+     * Encodes a transaction call into sendable transaction data using ethers.js
+     * @param txCall The transaction call object from TxBuilder
+     * @returns Encoded transaction ready to send
+     */
+    encodeTransaction(txCall: ITransactionCall): {
+        to: string;
+        data: string;
+        value: bigint;
+    };
+    /**
+     * Decodes function result data using ethers.js
+     * @param abi The contract ABI
+     * @param functionName The function name
+     * @param data The encoded result data
+     * @returns Decoded result
+     */
+    decodeResult(abi: unknown[], functionName: string, data: string): unknown;
+    /**
+     * Parses logs from a transaction receipt into structured events
+     * @param logs The logs from the transaction receipt
+     * @param abi The ABI to use for parsing
+     * @returns Array of parsed events
+     */
+    parseEvents(logs: readonly Log[], abi: unknown[]): IParsedEvent[];
+    /**
+     * Executes a transaction call
+     * @param txCall The transaction call object
+     * @param options Optional execution parameters
+     * @returns Transaction response based on options
+     */
+    execCall(txCall: ITransactionCall, options?: IEvmCallOptions): Promise<EvmOnChainCallResponse>;
+}