@ember-finance/sdk 1.1.4 → 1.2.0

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>;

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

@@ -0,0 +1,226 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signPermit = signPermit;
+exports.getPermitVersion = getPermitVersion;
+exports.getPermitNonce = getPermitNonce;
+exports.signPermitSimple = signPermitSimple;
+/**
+ * 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);
+ * ```
+ */
+async function signPermit(signer, tokenAddress, tokenName, spender, value, deadline, nonce, chainId, version) {
+    const owner = await signer.getAddress();
+    // If version not provided, fetch it from the token contract
+    let permitVersion = version;
+    if (!permitVersion) {
+        const provider = signer.provider;
+        if (!provider) {
+            throw new Error("Signer must be connected to a provider to fetch version");
+        }
+        permitVersion = await getPermitVersion(tokenAddress, provider);
+    }
+    // EIP-2612 domain
+    const domain = {
+        name: tokenName,
+        version: permitVersion,
+        chainId: chainId,
+        verifyingContract: tokenAddress
+    };
+    // EIP-2612 Permit type
+    const types = {
+        Permit: [
+            { name: "owner", type: "address" },
+            { name: "spender", type: "address" },
+            { name: "value", type: "uint256" },
+            { name: "nonce", type: "uint256" },
+            { name: "deadline", type: "uint256" }
+        ]
+    };
+    // Permit message
+    const message = {
+        owner,
+        spender,
+        value: BigInt(value),
+        nonce,
+        deadline
+    };
+    // Sign the typed data
+    const signature = await signer.signTypedData(domain, types, message);
+    // Split signature into v, r, s components
+    const r = signature.slice(0, 66);
+    const s = "0x" + signature.slice(66, 130);
+    const v = parseInt(signature.slice(130, 132), 16);
+    return {
+        deadline,
+        v,
+        r,
+        s
+    };
+}
+/**
+ * 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);
+ * ```
+ */
+async function getPermitVersion(tokenAddress, provider) {
+    try {
+        const { Contract } = await Promise.resolve().then(() => __importStar(require("ethers")));
+        const tokenContract = new Contract(tokenAddress, ["function version() view returns (string)"], provider);
+        return await tokenContract.version();
+    }
+    catch (error) {
+        // TODO: change this to "1" when we have a token that supports version "1"
+        // If version() is not implemented, default to "2"
+        // Most EIP-2612 tokens use version "2" unless specified otherwise
+        return "2";
+    }
+}
+/**
+ * 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
+ * );
+ * ```
+ */
+async function getPermitNonce(tokenAddress, ownerAddress, provider) {
+    const { Contract } = await Promise.resolve().then(() => __importStar(require("ethers")));
+    const tokenContract = new Contract(tokenAddress, ["function nonces(address owner) view returns (uint256)"], provider);
+    return await tokenContract.nonces(ownerAddress);
+}
+/**
+ * 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);
+ * ```
+ */
+async function signPermitSimple(signer, tokenAddress, tokenName, spender, value) {
+    const provider = signer.provider;
+    if (!provider) {
+        throw new Error("Signer must be connected to a provider");
+    }
+    const ownerAddress = await signer.getAddress();
+    const network = await provider.getNetwork();
+    const chainId = network.chainId;
+    // Get current nonce and version from token contract
+    const nonce = await getPermitNonce(tokenAddress, ownerAddress, provider);
+    const version = await getPermitVersion(tokenAddress, provider);
+    // Set deadline to 1 hour from now
+    const deadline = BigInt(Math.floor(Date.now() / 1000) + 3600);
+    return signPermit(signer, tokenAddress, tokenName, spender, value, deadline, nonce, chainId, version);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "1.1.4",
+    "version": "1.2.0",
     "module": "./dist/index.js",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",