@ember-finance/sdk 1.1.3 → 1.2.0

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/dist/src/sui-vaults/interfaces/bcs.d.ts

@@ -1,6 +1,6 @@
-export declare const BcsUpdateVaultStrategyRequest: import("@mysten/bcs").BcsType<{
-    vaultId: string;
-    strategies: {
+export declare const BcsUpdateVaultStrategyRequest: import("@mysten/bcs").BcsStruct<{
+    vaultId: import("@mysten/bcs").BcsType<string, string, "string">;
+    strategies: import("@mysten/bcs").BcsType<{
         platformName: string;
         strategistAddress: string;
         strategyType: string;
@@ -8,14 +8,7 @@ export declare const BcsUpdateVaultStrategyRequest: import("@mysten/bcs").BcsTyp
         apyE9: string;
         pointsApyE9: string;
         snapshotAt: string;
-    }[];
-    targetApyE9: string;
-    supplyApyE9: string;
-    reportedApyE9: string;
-    signedAt: string;
-}, {
-    vaultId: string;
-    strategies: Iterable<{
+    }[], Iterable<{
         platformName: string;
         strategistAddress: string;
         strategyType: string;
@@ -25,9 +18,9 @@ export declare const BcsUpdateVaultStrategyRequest: import("@mysten/bcs").BcsTyp
         snapshotAt: string | number | bigint;
     }> & {
         length: number;
-    };
-    targetApyE9: string;
-    supplyApyE9: string;
-    reportedApyE9: string;
-    signedAt: string | number | bigint;
-}>;
+    }, string>;
+    targetApyE9: import("@mysten/bcs").BcsType<string, string, "string">;
+    supplyApyE9: import("@mysten/bcs").BcsType<string, string, "string">;
+    reportedApyE9: import("@mysten/bcs").BcsType<string, string, "string">;
+    signedAt: import("@mysten/bcs").BcsType<string, string | number | bigint, "u64">;
+}, string>;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "1.1.3",
+    "version": "1.2.0",
     "module": "./dist/index.js",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -42,6 +42,11 @@
             "types": "./dist/src/abis/index.d.ts",
             "import": "./dist/src/abis/index.js",
             "require": "./dist/src/abis/index.js"
+        },
+        "./index": {
+            "types": "./dist/src/index.d.ts",
+            "import": "./dist/src/index.js",
+            "require": "./dist/src/index.js"
         }
     },
     "scripts": {
@@ -66,7 +71,7 @@
         "test": "tests"
     },
     "dependencies": {
-        "@firefly-exchange/library-sui": "^2.8.22",
+        "@firefly-exchange/library-sui": "^2.12.1",
         "axios": "1.12.2",
         "ethers": "^6.13.4",
         "yarn": "^1.22.19"