@ember-finance/sdk 1.1.3 → 1.2.0

package/dist/src/ember-vaults.js

@@ -13,8 +13,10 @@ const operator_2 = require("./evm-vaults/on-chain-calls/operator");
 const user_2 = require("./evm-vaults/on-chain-calls/user");
 const vault_admin_2 = require("./evm-vaults/on-chain-calls/vault-admin");
 const deployment_parser_2 = require("./evm-vaults/utils/deployment-parser");
+const vault_reader_1 = require("./evm-vaults/on-chain-calls/vault-reader");
 // API imports
 const api_1 = require("./api");
+const v2_1 = require("./api/v2");
 const environmentConfig = {
     prod: {
         apiHost: "https://vaults.api.sui-prod.bluefin.io"
@@ -54,11 +56,14 @@ const environmentConfig = {
 class EmberVaults {
     constructor(options) {
         this.chainType = options.chainType;
+        this._chainIdentifier = options.chainIdentifier;
         this._walletAddress = options.walletAddress;
         const environment = options.environment ?? "prod";
         this.apiHost = options.basePath || environmentConfig[environment].apiHost;
         this.api = new api_1.AccountsApi(new api_1.Configuration({ basePath: this.apiHost }));
         this.vaultsApi = new api_1.VaultsApi(new api_1.Configuration({ basePath: this.apiHost }));
+        this.accountsV2Api = new v2_1.AccountsApi(new v2_1.Configuration({ basePath: this.apiHost }));
+        this.vaultsV2Api = new v2_1.VaultsApi(new v2_1.Configuration({ basePath: this.apiHost }));
         if (options.chainType === "sui") {
             this._initSui(options);
         }
@@ -89,18 +94,31 @@ class EmberVaults {
         this._evmOperator = new operator_2.EVMOperatorCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
         this._evmVaultAdmin = new vault_admin_2.EVMVaultAdminCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
         this._evmUser = new user_2.EVMUserCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
+        this._evmVaultReader = new vault_reader_1.EVMVaultReader(this._evmDeployment, options.provider);
     }
     /**
      * Initialize by fetching deployment from API (SUI only currently)
      */
     async init() {
-        // Assuming that the vaults Api will return the correct deployment for the requested chain
-        // TODO: We might need to provide an input to the vaults Api
-        // so it knows for which chain the deployment is requested ??
-        // Confirm above with Burhan/Shahzaib
-        const deployment = await this.vaultsApi.getVaultsProtocolInfo();
-        const deploymentData = deployment.data;
-        this.updateDeployment(deploymentData);
+        const deployment = await this.vaultsV2Api.getVaultsProtocolInfo();
+        if (this.chainType === "sui") {
+            const deploymentData = deployment.data.find(d => d.chainType === "sui");
+            if (deploymentData) {
+                this.updateDeployment(deploymentData.config);
+            }
+            else {
+                throw new Error(`Deployment data not found for chain ${this._chainIdentifier}`);
+            }
+        }
+        else {
+            const deploymentData = deployment.data.find(d => d.chainType === "evm" && d.chain === this._chainIdentifier);
+            if (deploymentData) {
+                this.updateDeployment(deploymentData.config);
+            }
+            else {
+                throw new Error(`Deployment data not found for chain ${this._chainIdentifier}`);
+            }
+        }
     }
     /**
      * Updates the deployment configuration
@@ -126,6 +144,7 @@ class EmberVaults {
             this._evmOperator?.updateDeployment(evmDeployment);
             this._evmVaultAdmin?.updateDeployment(evmDeployment);
             this._evmUser?.updateDeployment(evmDeployment);
+            this._evmVaultReader?.updateDeployment(evmDeployment);
         }
     }
     // ============================================
@@ -232,7 +251,8 @@ class EmberVaults {
             operator: this._evmOperator,
             vaultAdmin: this._evmVaultAdmin,
             user: this._evmUser,
-            deployment: this._evmDeployment
+            deployment: this._evmDeployment,
+            reader: this._evmVaultReader
         };
     }
 }

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

@@ -124,6 +124,19 @@ export interface IUserCallOptions extends IEvmCallOptions {
     /** Receiver address for shares/funds. Defaults to the caller's address if not provided */
     receiver?: string;
 }
+/**
+ * EIP-2612 Permit signature components
+ */
+export interface IPermitSignature {
+    /** Deadline timestamp for the permit (in seconds) */
+    deadline: bigint;
+    /** v component of the signature */
+    v: number;
+    /** r component of the signature */
+    r: string;
+    /** s component of the signature */
+    s: string;
+}
 /**
  * Parsed event from a transaction
  */

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

@@ -1,5 +1,5 @@
 import { EVMDeploymentParser } from "../utils";
-import { IEvmDeployment, VaultPauseOperation, ITransactionCall } from "../interfaces";
+import { IEvmDeployment, VaultPauseOperation, ITransactionCall, IPermitSignature } from "../interfaces";
 import { NumStr } from "../../common/types";
 /**
  * EVM Transaction Builder for Ember Protocol (ERC-4626 Compatible)
@@ -204,6 +204,15 @@ export declare class EVMTxBuilder {
      * @returns Transaction call object
      */
     deposit(vaultAddress: string, assets: NumStr, receiver: string): ITransactionCall;
+    /**
+     * Deposits assets to a vault using EIP-2612 permit (no separate approval needed)
+     * @param vaultAddress Address of the vault
+     * @param assets Amount of assets to deposit
+     * @param receiver Address to receive the shares
+     * @param permitSignature The EIP-2612 permit signature
+     * @returns Transaction call object
+     */
+    depositWithPermit(vaultAddress: string, assets: NumStr, receiver: string, permitSignature: IPermitSignature): ITransactionCall;
     /**
      * Mints a specific number of shares by depositing assets (ERC-4626 standard)
      * @param vaultAddress Address of the vault
@@ -212,6 +221,15 @@ export declare class EVMTxBuilder {
      * @returns Transaction call object
      */
     mint(vaultAddress: string, shares: NumStr, receiver: string): ITransactionCall;
+    /**
+     * Mints a specific number of shares using EIP-2612 permit (no separate approval needed)
+     * @param vaultAddress Address of the vault
+     * @param shares Amount of shares to mint
+     * @param receiver Address to receive the shares
+     * @param permitSignature The EIP-2612 permit signature
+     * @returns Transaction call object
+     */
+    mintWithPermit(vaultAddress: string, shares: NumStr, receiver: string, permitSignature: IPermitSignature): ITransactionCall;
     /**
      * Redeems shares to initiate a withdrawal request
      * @param vaultAddress Address of the vault

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

@@ -447,6 +447,31 @@ class EVMTxBuilder {
             chainId: this.getChainId()
         };
     }
+    /**
+     * Deposits assets to a vault using EIP-2612 permit (no separate approval needed)
+     * @param vaultAddress Address of the vault
+     * @param assets Amount of assets to deposit
+     * @param receiver Address to receive the shares
+     * @param permitSignature The EIP-2612 permit signature
+     * @returns Transaction call object
+     */
+    depositWithPermit(vaultAddress, assets, receiver, permitSignature) {
+        return {
+            to: vaultAddress,
+            functionName: "depositWithPermit",
+            args: [
+                BigInt(assets),
+                receiver,
+                BigInt(permitSignature.deadline),
+                permitSignature.v,
+                permitSignature.r,
+                permitSignature.s
+            ],
+            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
@@ -464,6 +489,31 @@ class EVMTxBuilder {
             chainId: this.getChainId()
         };
     }
+    /**
+     * Mints a specific number of shares using EIP-2612 permit (no separate approval needed)
+     * @param vaultAddress Address of the vault
+     * @param shares Amount of shares to mint
+     * @param receiver Address to receive the shares
+     * @param permitSignature The EIP-2612 permit signature
+     * @returns Transaction call object
+     */
+    mintWithPermit(vaultAddress, shares, receiver, permitSignature) {
+        return {
+            to: vaultAddress,
+            functionName: "mintWithPermit",
+            args: [
+                BigInt(shares),
+                receiver,
+                BigInt(permitSignature.deadline),
+                permitSignature.v,
+                permitSignature.r,
+                permitSignature.s
+            ],
+            abi: EmberVault_json_1.default.abi,
+            value: 0n,
+            chainId: this.getChainId()
+        };
+    }
     /**
      * Redeems shares to initiate a withdrawal request
      * @param vaultAddress Address of the vault

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

@@ -1,6 +1,6 @@
 import { Signer, Provider } from "ethers";
 import { EVMOnChainCalls } from "./onchain-calls";
-import { IEvmDeployment, IUserCallOptions, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces";
+import { IEvmDeployment, IUserCallOptions, IEvmCallOptions, EvmOnChainCallResponse, IPermitSignature } from "../interfaces";
 import { NumStr } from "../../common/types";
 /**
  * User Calls for Ember Protocol on EVM (ERC-4626 Compatible)
@@ -10,7 +10,9 @@ import { NumStr } from "../../common/types";
  *
  * Users can:
  * - deposit: Deposit assets and receive shares (ERC-4626)
+ * - depositWithPermit: Deposit assets using EIP-2612 permit (no separate approval needed)
  * - mint: Mint a specific number of shares by depositing assets (ERC-4626)
+ * - mintWithPermit: Mint shares using EIP-2612 permit (no separate approval needed)
  * - redeemShares: Initiate a withdrawal request by redeeming shares
  * - cancelPendingWithdrawalRequest: Cancel a pending withdrawal
  *
@@ -28,12 +30,14 @@ import { NumStr } from "../../common/types";
  *
  * const userCalls = new EVMUserCalls(deployment, signer, provider);
  *
- * // Approve token spending first
+ * // Traditional approach: Approve token spending first, then deposit
  * await userCalls.approveToken(underlyingAsset, vaultAddress, amount);
- *
- * // Deposit assets (receiver defaults to caller)
  * await userCalls.deposit(vaultAddress, amount);
  *
+ * // New approach: Use permit to deposit in single transaction (no approval needed)
+ * const permitSig = await signPermit(signer, tokenAddress, vaultAddress, amount, deadline);
+ * await userCalls.depositWithPermit(vaultAddress, amount, permitSig);
+ *
  * // Deposit assets to a different receiver
  * await userCalls.deposit(vaultAddress, amount, { receiver: otherAddress });
  *
@@ -58,6 +62,39 @@ export declare class EVMUserCalls extends EVMOnChainCalls {
      * @returns EvmOnChainCallResponse
      */
     deposit(vaultAddress: string, assets: NumStr, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Deposit assets into a vault using EIP-2612 permit (no separate approval needed)
+     *
+     * This method allows depositing in a single transaction by including a permit signature.
+     * The permit signature authorizes the vault to spend the underlying asset without requiring
+     * a separate approve transaction.
+     *
+     * @param vaultAddress The address of the vault
+     * @param assets The amount of assets to deposit
+     * @param permitSignature The EIP-2612 permit signature components
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     *
+     * @example
+     * ```typescript
+     * // Generate permit signature (see signPermit utility)
+     * const permitSig = await signPermit(
+     *   signer,
+     *   tokenAddress,
+     *   vaultAddress,
+     *   amount,
+     *   deadline
+     * );
+     *
+     * // Deposit with permit in single transaction
+     * await userCalls.depositWithPermit(
+     *   vaultAddress,
+     *   amount,
+     *   permitSig
+     * );
+     * ```
+     */
+    depositWithPermit(vaultAddress: string, assets: NumStr, permitSignature: IPermitSignature, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
     /**
      * Mint a specific number of shares by depositing assets (ERC-4626 standard)
      *
@@ -70,6 +107,39 @@ export declare class EVMUserCalls extends EVMOnChainCalls {
      * @returns EvmOnChainCallResponse
      */
     mint(vaultAddress: string, shares: NumStr, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
+    /**
+     * Mint a specific number of shares using EIP-2612 permit (no separate approval needed)
+     *
+     * This method allows minting shares in a single transaction by including a permit signature.
+     * The permit signature authorizes the vault to spend the required underlying assets without
+     * requiring a separate approve transaction.
+     *
+     * @param vaultAddress The address of the vault
+     * @param shares The number of shares to mint
+     * @param permitSignature The EIP-2612 permit signature components
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     *
+     * @example
+     * ```typescript
+     * // Generate permit signature (see signPermit utility)
+     * const permitSig = await signPermit(
+     *   signer,
+     *   tokenAddress,
+     *   vaultAddress,
+     *   maxAmount, // Use high amount or max for mint since exact amount is calculated by vault
+     *   deadline
+     * );
+     *
+     * // Mint shares with permit in single transaction
+     * await userCalls.mintWithPermit(
+     *   vaultAddress,
+     *   shares,
+     *   permitSig
+     * );
+     * ```
+     */
+    mintWithPermit(vaultAddress: string, shares: NumStr, permitSignature: IPermitSignature, options?: IUserCallOptions): Promise<EvmOnChainCallResponse>;
     /**
      * Redeem shares to initiate a withdrawal request
      *

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

@@ -15,7 +15,9 @@ const EmberVault_json_1 = __importDefault(require("../../abis/EmberVault.json"))
  *
  * Users can:
  * - deposit: Deposit assets and receive shares (ERC-4626)
+ * - depositWithPermit: Deposit assets using EIP-2612 permit (no separate approval needed)
  * - mint: Mint a specific number of shares by depositing assets (ERC-4626)
+ * - mintWithPermit: Mint shares using EIP-2612 permit (no separate approval needed)
  * - redeemShares: Initiate a withdrawal request by redeeming shares
  * - cancelPendingWithdrawalRequest: Cancel a pending withdrawal
  *
@@ -33,12 +35,14 @@ const EmberVault_json_1 = __importDefault(require("../../abis/EmberVault.json"))
  *
  * const userCalls = new EVMUserCalls(deployment, signer, provider);
  *
- * // Approve token spending first
+ * // Traditional approach: Approve token spending first, then deposit
  * await userCalls.approveToken(underlyingAsset, vaultAddress, amount);
- *
- * // Deposit assets (receiver defaults to caller)
  * await userCalls.deposit(vaultAddress, amount);
  *
+ * // New approach: Use permit to deposit in single transaction (no approval needed)
+ * const permitSig = await signPermit(signer, tokenAddress, vaultAddress, amount, deadline);
+ * await userCalls.depositWithPermit(vaultAddress, amount, permitSig);
+ *
  * // Deposit assets to a different receiver
  * await userCalls.deposit(vaultAddress, amount, { receiver: otherAddress });
  *
@@ -72,6 +76,43 @@ class EVMUserCalls extends onchain_calls_1.EVMOnChainCalls {
         const txCall = this.txBuilder.deposit(vaultAddress, assets, receiver);
         return this.execCall(txCall, options);
     }
+    /**
+     * Deposit assets into a vault using EIP-2612 permit (no separate approval needed)
+     *
+     * This method allows depositing in a single transaction by including a permit signature.
+     * The permit signature authorizes the vault to spend the underlying asset without requiring
+     * a separate approve transaction.
+     *
+     * @param vaultAddress The address of the vault
+     * @param assets The amount of assets to deposit
+     * @param permitSignature The EIP-2612 permit signature components
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     *
+     * @example
+     * ```typescript
+     * // Generate permit signature (see signPermit utility)
+     * const permitSig = await signPermit(
+     *   signer,
+     *   tokenAddress,
+     *   vaultAddress,
+     *   amount,
+     *   deadline
+     * );
+     *
+     * // Deposit with permit in single transaction
+     * await userCalls.depositWithPermit(
+     *   vaultAddress,
+     *   amount,
+     *   permitSig
+     * );
+     * ```
+     */
+    async depositWithPermit(vaultAddress, assets, permitSignature, options) {
+        const receiver = options?.receiver ?? (await this.getWalletAddress());
+        const txCall = this.txBuilder.depositWithPermit(vaultAddress, assets, receiver, permitSignature);
+        return this.execCall(txCall, options);
+    }
     // ============================================
     // Mint Methods (ERC-4626)
     // ============================================
@@ -91,6 +132,43 @@ class EVMUserCalls extends onchain_calls_1.EVMOnChainCalls {
         const txCall = this.txBuilder.mint(vaultAddress, shares, receiver);
         return this.execCall(txCall, options);
     }
+    /**
+     * Mint a specific number of shares using EIP-2612 permit (no separate approval needed)
+     *
+     * This method allows minting shares in a single transaction by including a permit signature.
+     * The permit signature authorizes the vault to spend the required underlying assets without
+     * requiring a separate approve transaction.
+     *
+     * @param vaultAddress The address of the vault
+     * @param shares The number of shares to mint
+     * @param permitSignature The EIP-2612 permit signature components
+     * @param options Optional tx execution params (includes optional receiver, defaults to caller)
+     * @returns EvmOnChainCallResponse
+     *
+     * @example
+     * ```typescript
+     * // Generate permit signature (see signPermit utility)
+     * const permitSig = await signPermit(
+     *   signer,
+     *   tokenAddress,
+     *   vaultAddress,
+     *   maxAmount, // Use high amount or max for mint since exact amount is calculated by vault
+     *   deadline
+     * );
+     *
+     * // Mint shares with permit in single transaction
+     * await userCalls.mintWithPermit(
+     *   vaultAddress,
+     *   shares,
+     *   permitSig
+     * );
+     * ```
+     */
+    async mintWithPermit(vaultAddress, shares, permitSignature, options) {
+        const receiver = options?.receiver ?? (await this.getWalletAddress());
+        const txCall = this.txBuilder.mintWithPermit(vaultAddress, shares, receiver, permitSignature);
+        return this.execCall(txCall, options);
+    }
     // ============================================
     // Redemption Methods
     // ============================================

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

@@ -1 +1,2 @@
 export * from "./deployment-parser";
+export * from "./permit-utils";

package/dist/src/evm-vaults/utils/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./deployment-parser"), exports);
+__exportStar(require("./permit-utils"), exports);

package/dist/src/evm-vaults/utils/permit-utils.d.ts

@@ -0,0 +1,112 @@
+import { Signer } from "ethers";
+import { IPermitSignature } from "../interfaces";
+import { NumStr } from "../../common/types";
+/**
+ * Signs an EIP-2612 permit message
+ *
+ * This creates an off-chain signature that authorizes a spender (vault) to spend
+ * tokens on behalf of the owner without requiring a separate approval transaction.
+ *
+ * @param signer The ethers.js signer
+ * @param tokenAddress The address of the ERC20 token (must support EIP-2612)
+ * @param tokenName The name of the token (for domain separator)
+ * @param spender The address authorized to spend (usually the vault address)
+ * @param value The amount of tokens to approve
+ * @param deadline The deadline timestamp (in seconds) for the permit
+ * @param nonce The current permit nonce for the owner (fetch from token.nonces(owner))
+ * @param chainId The chain ID
+ * @param version Optional version string for the domain separator (fetched from token if not provided)
+ * @returns The permit signature components
+ *
+ * @example
+ * ```typescript
+ * import { signPermit } from "@ember-finance/sdk";
+ *
+ * const deadline = Math.floor(Date.now() / 1000) + 3600; // 1 hour from now
+ * const tokenContract = new ethers.Contract(tokenAddress, erc20Abi, provider);
+ * const nonce = await tokenContract.nonces(await signer.getAddress());
+ *
+ * const permitSig = await signPermit(
+ *   signer,
+ *   tokenAddress,
+ *   "USD Coin", // token name
+ *   vaultAddress,
+ *   amount,
+ *   BigInt(deadline),
+ *   nonce,
+ *   BigInt(1) // Ethereum mainnet
+ * );
+ *
+ * // Use with depositWithPermit
+ * await userCalls.depositWithPermit(vaultAddress, amount, permitSig);
+ * ```
+ */
+export declare function signPermit(signer: Signer, tokenAddress: string, tokenName: string, spender: string, value: NumStr, deadline: bigint, nonce: bigint, chainId: bigint, version?: string): Promise<IPermitSignature>;
+/**
+ * Helper function to get the permit version from an EIP-2612 token
+ *
+ * @param tokenAddress The address of the ERC20 token
+ * @param provider An ethers.js provider
+ * @returns The version string (e.g., "1", "2"), defaults to "1" if version() not implemented
+ *
+ * @example
+ * ```typescript
+ * import { getPermitVersion } from "@ember-finance/sdk";
+ *
+ * const version = await getPermitVersion(tokenAddress, provider);
+ * ```
+ */
+export declare function getPermitVersion(tokenAddress: string, provider: import("ethers").Provider): Promise<string>;
+/**
+ * Helper function to get the current nonce for a user from an EIP-2612 token
+ *
+ * @param tokenAddress The address of the ERC20 token
+ * @param ownerAddress The address of the token owner
+ * @param provider An ethers.js provider
+ * @returns The current nonce
+ *
+ * @example
+ * ```typescript
+ * import { getPermitNonce } from "@ember-finance/sdk";
+ *
+ * const nonce = await getPermitNonce(
+ *   tokenAddress,
+ *   await signer.getAddress(),
+ *   provider
+ * );
+ * ```
+ */
+export declare function getPermitNonce(tokenAddress: string, ownerAddress: string, provider: import("ethers").Provider): Promise<bigint>;
+/**
+ * Helper function to create a permit signature with sensible defaults
+ *
+ * This is a convenience function that:
+ * - Fetches the current nonce automatically
+ * - Fetches the version from the token contract
+ * - Sets a deadline of 1 hour from now
+ * - Gets the chain ID from the signer
+ *
+ * @param signer The ethers.js signer (must be connected to a provider)
+ * @param tokenAddress The address of the ERC20 token (must support EIP-2612)
+ * @param tokenName The name of the token (for domain separator)
+ * @param spender The address authorized to spend (usually the vault address)
+ * @param value The amount of tokens to approve
+ * @returns The permit signature components
+ *
+ * @example
+ * ```typescript
+ * import { signPermitSimple } from "@ember-finance/sdk";
+ *
+ * // Simplified permit signing (fetches nonce, version, sets 1 hour deadline automatically)
+ * const permitSig = await signPermitSimple(
+ *   signer,
+ *   tokenAddress,
+ *   "USD Coin",
+ *   vaultAddress,
+ *   amount
+ * );
+ *
+ * await userCalls.depositWithPermit(vaultAddress, amount, permitSig);
+ * ```
+ */
+export declare function signPermitSimple(signer: Signer, tokenAddress: string, tokenName: string, spender: string, value: NumStr): Promise<IPermitSignature>;