@morpho-org/consumer-sdk 0.1.5 → 0.1.6

package/lib/actions/requirements/getRequirements.d.ts

@@ -1,6 +1,23 @@
 import { type Address } from "@morpho-org/blue-sdk";
 import type { Client } from "viem";
 import { type ERC20ApprovalAction, type Requirement, type Transaction } from "../../types";
+type GetRequirementsBaseParams = {
+    address: Address;
+    chainId: number;
+    args: {
+        amount: bigint;
+        from: Address;
+    };
+};
+type GetRequirementsParams = (GetRequirementsBaseParams & {
+    /** Signature-based approvals are not supported. Classic approval (transaction) will be used. */
+    supportSignature: false;
+}) | (GetRequirementsBaseParams & {
+    /** Signature-based approvals are supported. Will try permit (EIP-2612), else fallback to permit2. */
+    supportSignature: true;
+    /** Allow simple permit if EIP-2612 is supported. Only applicable when `supportSignature` is `true`. */
+    useSimplePermit?: boolean;
+});
 /**
  * Get token "requirement" for approval/permit before interacting with protocol.
  *
@@ -15,15 +32,9 @@ import { type ERC20ApprovalAction, type Requirement, type Transaction } from "..
  * @param params.args - Object with:
  * @param params.args.amount - Required token amount.
  * @param params.args.from - The account that will grant approval.
- * @param supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.useSimplePermit - use simple permit if EIP-2612 is supported. Only available when `supportSignature` is `true`.
  * @returns Promise of array of approval transaction or requirement objects.
  */
-export declare const getRequirements: (viemClient: Client, params: {
-    address: Address;
-    chainId: number;
-    supportSignature: boolean;
-    args: {
-        amount: bigint;
-        from: Address;
-    };
-}) => Promise<(Readonly<Transaction<ERC20ApprovalAction>> | Requirement)[]>;
+export declare const getRequirements: (viemClient: Client, params: GetRequirementsParams) => Promise<(Readonly<Transaction<ERC20ApprovalAction>> | Requirement)[]>;
+export {};

package/lib/actions/requirements/getRequirements.js

@@ -22,7 +22,8 @@ const getRequirementsPermit2_1 = require("./getRequirementsPermit2");
  * @param params.args - Object with:
  * @param params.args.amount - Required token amount.
  * @param params.args.from - The account that will grant approval.
- * @param supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.useSimplePermit - use simple permit if EIP-2612 is supported. Only available when `supportSignature` is `true`.
  * @returns Promise of array of approval transaction or requirement objects.
  */
 const getRequirements = async (viemClient, params) => {
@@ -33,8 +34,9 @@ const getRequirements = async (viemClient, params) => {
     const { permit2, dai, bundler3: { generalAdapter1 }, } = (0, blue_sdk_1.getChainAddresses)(chainId);
     const { erc20Allowances, erc2612Nonce, permit2BundlerAllowance } = await (0, blue_sdk_viem_1.fetchHolding)(from, address, viemClient);
     if (supportSignature) {
+        const { useSimplePermit } = params;
         const supportSimplePermit = (0, morpho_ts_1.isDefined)(erc2612Nonce) && address !== dai;
-        if (supportSimplePermit) {
+        if (supportSimplePermit && useSimplePermit) {
             return await (0, getRequirementsPermit_1.getRequirementsPermit)(viemClient, {
                 token: address,
                 chainId,

package/lib/entities/vaultV2/vaultV2.d.ts

@@ -32,7 +32,9 @@ export interface VaultV2Actions {
         slippageTolerance?: bigint;
     }) => Promise<{
         buildTx: (requirementSignature?: RequirementSignature) => Readonly<Transaction<VaultV2DepositAction>>;
-        getRequirements: () => Promise<(Readonly<Transaction<ERC20ApprovalAction>> | Requirement)[]>;
+        getRequirements: (params?: {
+            useSimplePermit?: boolean;
+        }) => Promise<(Readonly<Transaction<ERC20ApprovalAction>> | Requirement)[]>;
     }>;
     /**
      * Prepares a withdraw transaction for the VaultV2 contract.
@@ -80,7 +82,9 @@ export declare class MorphoVaultV2 implements VaultV2Actions {
         userAddress: Address;
         slippageTolerance?: bigint;
     }): Promise<{
-        getRequirements: () => Promise<(Requirement | Readonly<Transaction<ERC20ApprovalAction>>)[]>;
+        getRequirements: (params?: {
+            useSimplePermit?: boolean;
+        }) => Promise<(Requirement | Readonly<Transaction<ERC20ApprovalAction>>)[]>;
         buildTx: (requirementSignature?: RequirementSignature) => Readonly<Transaction<VaultV2DepositAction>>;
     }>;
     withdraw({ assets, userAddress }: {

package/lib/entities/vaultV2/vaultV2.js

@@ -28,10 +28,11 @@ class MorphoVaultV2 {
         });
         const maxSharePrice = blue_sdk_1.MathLib.min(blue_sdk_1.MathLib.mulDivUp(assets, blue_sdk_1.MathLib.wToRay(blue_sdk_1.MathLib.WAD + slippageTolerance), vaultData.toShares(assets)), blue_sdk_1.MathLib.RAY * 100n);
         return {
-            getRequirements: async () => await (0, actions_1.getRequirements)(this.client.viemClient, {
+            getRequirements: async (params) => await (0, actions_1.getRequirements)(this.client.viemClient, {
                 address: vaultData.asset,
                 chainId: this.chainId,
                 supportSignature: this.client.options.supportSignature,
+                useSimplePermit: params?.useSimplePermit,
                 args: {
                     amount: assets,
                     from: userAddress,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/consumer-sdk",
   "description": "Abstraction layer for Morpho's complexity.",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Foulks-Plb <https://x.com/FoulkPlb>"