@morpho-org/consumer-sdk 0.1.7 → 0.2.0

package/lib/actions/requirements/encode/encodeErc20Permit.d.ts

@@ -7,6 +7,7 @@ interface EncodeErc20PermitParams {
     amount: bigint;
     chainId: number;
     nonce: bigint;
+    supportDeployless?: boolean;
 }
 export declare const encodeErc20Permit: (viemClient: Client, params: EncodeErc20PermitParams) => Promise<Requirement>;
 export {};

package/lib/actions/requirements/encode/encodeErc20Permit.js

@@ -7,13 +7,15 @@ const viem_1 = require("viem");
 const actions_1 = require("viem/actions");
 const types_1 = require("../../../types");
 const encodeErc20Permit = async (viemClient, params) => {
-    const { token, spender, amount, chainId, nonce } = params;
+    const { token, spender, amount, chainId, nonce, supportDeployless } = params;
     if (viemClient.chain?.id !== chainId) {
         throw new types_1.ChainIdMismatchError(viemClient.chain?.id, chainId);
     }
     const now = morpho_ts_1.Time.timestamp();
     const deadline = now + morpho_ts_1.Time.s.from.h(2n);
-    const tokenData = await (0, blue_sdk_viem_1.fetchToken)(token, viemClient);
+    const tokenData = await (0, blue_sdk_viem_1.fetchToken)(token, viemClient, {
+        deployless: supportDeployless,
+    });
     const action = {
         type: "permit",
         args: {

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

@@ -4,6 +4,7 @@ import { type ERC20ApprovalAction, type Requirement, type Transaction } from "..
 type GetRequirementsBaseParams = {
     address: Address;
     chainId: number;
+    supportDeployless?: boolean;
     args: {
         amount: bigint;
         from: Address;
@@ -33,6 +34,7 @@ type GetRequirementsParams = (GetRequirementsBaseParams & {
  * @param params.args.amount - Required token amount.
  * @param params.args.from - The account that will grant approval.
  * @param params.supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.supportDeployless - Whether to use deployless mode.
  * @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.
  */

package/lib/actions/requirements/getRequirements.js

@@ -23,6 +23,7 @@ const getRequirementsPermit2_1 = require("./getRequirementsPermit2");
  * @param params.args.amount - Required token amount.
  * @param params.args.from - The account that will grant approval.
  * @param params.supportSignature - Whether signature-based approvals are supported. If true, will try to use permit or permit2.
+ * @param params.supportDeployless - Whether to use deployless mode.
  * @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.
  */
@@ -32,7 +33,9 @@ const getRequirements = async (viemClient, params) => {
         throw new types_1.ChainIdMismatchError(viemClient.chain?.id, chainId);
     }
     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);
+    const { erc20Allowances, erc2612Nonce, permit2BundlerAllowance } = await (0, blue_sdk_viem_1.fetchHolding)(from, address, viemClient, {
+        deployless: params.supportDeployless,
+    });
     if (supportSignature) {
         const { useSimplePermit } = params;
         const supportSimplePermit = (0, morpho_ts_1.isDefined)(erc2612Nonce) && address !== dai;
@@ -43,6 +46,7 @@ const getRequirements = async (viemClient, params) => {
                 args: { amount },
                 allowancesGeneralAdapter: erc20Allowances["bundler3.generalAdapter1"],
                 nonce: erc2612Nonce,
+                supportDeployless: params.supportDeployless,
             });
         }
         if (permit2) {

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

@@ -1,7 +1,10 @@
 import type { Action } from "@morpho-org/bundler-sdk-viem";
-import type { Permit2Action, PermitAction, PermitArgs } from "../../types";
+import { type Address } from "viem";
+import { type Permit2Action, type PermitAction, type PermitArgs } from "../../types";
 interface GetRequirementsActionParams {
     chainId: number;
+    asset: Address;
+    assets: bigint;
     requirementSignature: {
         args: PermitArgs;
         action: PermitAction | Permit2Action;
@@ -10,5 +13,5 @@ interface GetRequirementsActionParams {
 /**
  * Get the actions required to transfer the asset based on the requirement signature.
  */
-export declare const getRequirementsAction: ({ chainId, requirementSignature, }: GetRequirementsActionParams) => Action[];
+export declare const getRequirementsAction: ({ chainId, asset, assets, requirementSignature, }: GetRequirementsActionParams) => Action[];
 export {};

package/lib/actions/requirements/getRequirementsAction.js

@@ -2,10 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRequirementsAction = void 0;
 const blue_sdk_1 = require("@morpho-org/blue-sdk");
+const viem_1 = require("viem");
+const types_1 = require("../../types");
 /**
  * Get the actions required to transfer the asset based on the requirement signature.
  */
-const getRequirementsAction = ({ chainId, requirementSignature, }) => {
+const getRequirementsAction = ({ chainId, asset, assets, requirementSignature, }) => {
+    if (!(0, viem_1.isAddressEqual)(requirementSignature.args.asset, asset)) {
+        throw new types_1.DepositAssetMismatchError(asset, requirementSignature.args.asset);
+    }
+    if (requirementSignature.args.amount !== assets) {
+        throw new types_1.DepositAmountMismatchError(assets, requirementSignature.args.amount);
+    }
     const { bundler3: { generalAdapter1 }, } = (0, blue_sdk_1.getChainAddresses)(chainId);
     if (requirementSignature.action.type === "permit2") {
         if (!("expiration" in requirementSignature.args)) {
@@ -31,12 +39,7 @@ const getRequirementsAction = ({ chainId, requirementSignature, }) => {
             },
             {
                 type: "transferFrom2",
-                args: [
-                    requirementSignature.args.asset,
-                    requirementSignature.args.amount,
-                    generalAdapter1,
-                    false,
-                ],
+                args: [asset, assets, generalAdapter1, false],
             },
         ];
     }
@@ -54,12 +57,7 @@ const getRequirementsAction = ({ chainId, requirementSignature, }) => {
         },
         {
             type: "erc20TransferFrom",
-            args: [
-                requirementSignature.args.asset,
-                requirementSignature.args.amount,
-                generalAdapter1,
-                false,
-            ],
+            args: [asset, assets, generalAdapter1, false],
         },
     ];
 };

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

@@ -13,6 +13,7 @@ import type { Address, Client } from "viem";
  * @param params.args.amount - Required token amount.
  * @param params.allowancesGeneralAdapter - Allowance for general adapter from permit contract.
  * @param params.nonce - Nonce for permit (EIP-2612).
+ * @param params.supportDeployless - Whether to use deployless mode.
  * @returns An array of requirement signature object.
  */
 export declare const getRequirementsPermit: (viemClient: Client, params: {
@@ -23,4 +24,5 @@ export declare const getRequirementsPermit: (viemClient: Client, params: {
     };
     allowancesGeneralAdapter: bigint;
     nonce: bigint;
+    supportDeployless?: boolean;
 }) => Promise<import("../..").Requirement[]>;

package/lib/actions/requirements/getRequirementsPermit.js

@@ -17,10 +17,11 @@ const encode_1 = require("./encode");
  * @param params.args.amount - Required token amount.
  * @param params.allowancesGeneralAdapter - Allowance for general adapter from permit contract.
  * @param params.nonce - Nonce for permit (EIP-2612).
+ * @param params.supportDeployless - Whether to use deployless mode.
  * @returns An array of requirement signature object.
  */
 const getRequirementsPermit = async (viemClient, params) => {
-    const { token, chainId, args: { amount }, allowancesGeneralAdapter, nonce, } = params;
+    const { token, chainId, args: { amount }, allowancesGeneralAdapter, nonce, supportDeployless, } = params;
     const { bundler3: { generalAdapter1 }, } = (0, blue_sdk_1.getChainAddresses)(chainId);
     if (allowancesGeneralAdapter < amount) {
         return [
@@ -30,6 +31,7 @@ const getRequirementsPermit = async (viemClient, params) => {
                 amount,
                 chainId,
                 nonce,
+                supportDeployless,
             }),
         ];
     }

package/lib/actions/vaultV2/deposit.js

@@ -45,7 +45,12 @@ const vaultV2Deposit = ({ vault: { chainId, address: vaultAddress, asset }, args
     }
     const actions = [];
     if (requirementSignature) {
-        actions.push(...(0, getRequirementsAction_1.getRequirementsAction)({ chainId, requirementSignature }));
+        actions.push(...(0, getRequirementsAction_1.getRequirementsAction)({
+            chainId,
+            asset,
+            assets,
+            requirementSignature,
+        }));
     }
     else {
         const { bundler3: { generalAdapter1 }, } = (0, blue_sdk_1.getChainAddresses)(chainId);

package/lib/client/morphoClient.d.ts

@@ -5,14 +5,17 @@ export declare class MorphoClient implements MorphoClientType {
     readonly viemClient: Client;
     readonly _options?: {
         readonly supportSignature?: boolean;
+        readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     } | undefined;
     readonly options: {
         readonly supportSignature: boolean;
+        readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     };
     constructor(viemClient: Client, _options?: {
         readonly supportSignature?: boolean;
+        readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     } | undefined);
     vaultV2(vault: Address, chainId: number): MorphoVaultV2;

package/lib/client/morphoClient.js

@@ -12,6 +12,7 @@ class MorphoClient {
         this.options = {
             ..._options,
             supportSignature: _options?.supportSignature ?? false,
+            supportDeployless: _options?.supportDeployless,
         };
     }
     vaultV2(vault, chainId) {

package/lib/client/morphoViemExtension.d.ts

@@ -6,6 +6,8 @@ import { MorphoClient } from "./morphoClient";
  * Adds `morpho` namespace to viem clients with vaultV2 actions.
  *
  * @param metadata - (Optional) Metadata object that will be passed to all morpho actions. If provided, this metadata can be used for analytics, logging, or to carry additional information with each action.
+ * @param supportSignature - (Optional) Whether to support off-chain signature requirements. If true, the SDK will try to use permit or permit2 if the token supports it.
+ * @param supportDeployless - (Optional) Whether to support deployless mode. If true, the SDK will use the deployless mode to fetch data.
  * @returns Extension function that adds morpho namespace to viem clients
  *
  * @example
@@ -26,8 +28,9 @@ import { MorphoClient } from "./morphoClient";
  * ```
  */
 export declare function morphoViemExtension(_options?: {
-    metadata?: Metadata;
-    supportSignature?: boolean;
+    readonly metadata?: Metadata;
+    readonly supportSignature?: boolean;
+    readonly supportDeployless?: boolean;
 }): <TClient extends Client>(client: TClient) => {
     morpho: MorphoClient;
 };

package/lib/client/morphoViemExtension.js

@@ -7,6 +7,8 @@ const morphoClient_1 = require("./morphoClient");
  * Adds `morpho` namespace to viem clients with vaultV2 actions.
  *
  * @param metadata - (Optional) Metadata object that will be passed to all morpho actions. If provided, this metadata can be used for analytics, logging, or to carry additional information with each action.
+ * @param supportSignature - (Optional) Whether to support off-chain signature requirements. If true, the SDK will try to use permit or permit2 if the token supports it.
+ * @param supportDeployless - (Optional) Whether to support deployless mode. If true, the SDK will use the deployless mode to fetch data.
  * @returns Extension function that adds morpho namespace to viem clients
  *
  * @example

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

@@ -1,15 +1,17 @@
 import { fetchAccrualVaultV2 } from "@morpho-org/blue-sdk-viem";
 import type { Address } from "viem";
 import { type ERC20ApprovalAction, type MorphoClientType, type Requirement, type RequirementSignature, type Transaction, type VaultV2DepositAction, type VaultV2RedeemAction, type VaultV2WithdrawAction } from "../../types";
+import type { FetchParameters } from "../../types/data";
 export interface VaultV2Actions {
     /**
      * Fetches the latest vault data.
      *
      * This function fetches the latest vault data from the blockchain.
+     * @param {FetchParameters} [parameters] - The parameters for the fetch operation.
      *
      * @returns {Promise<Awaited<ReturnType<typeof fetchAccrualVaultV2>>>} The latest vault data.
      */
-    getData: () => Promise<Awaited<ReturnType<typeof fetchAccrualVaultV2>>>;
+    getData: (parameters?: FetchParameters) => Promise<Awaited<ReturnType<typeof fetchAccrualVaultV2>>>;
     /**
      * Prepares a deposit transaction for the VaultV2 contract.
      *
@@ -21,7 +23,7 @@ export interface VaultV2Actions {
      * @param {Object} params - The deposit parameters.
      * @param {bigint} params.assets - The amount of assets to deposit.
      * @param {Address} [params.userAddress] - Optional user address initiating the deposit. Default is the client's user address is used.
-     * @param {bigint} [params.slippageTolerance=DEFAULT_SLIPPAGE_TOLERANCE] - Optional slippage tolerance value. Default is 0.03%.
+     * @param {bigint} [params.slippageTolerance=DEFAULT_SLIPPAGE_TOLERANCE] - Optional slippage tolerance value. Default is 0.03%. Slippage tolerance must be less than 10%.
      * @returns {Object} The result object.
      * @returns {Readonly<Transaction<VaultV2DepositAction>>} returns.tx The prepared deposit transaction.
      * @returns {Promise<Readonly<Transaction<ERC20ApprovalAction>[]>>} returns.getRequirements The function for retrieving all required approval transactions.
@@ -43,7 +45,7 @@ export interface VaultV2Actions {
      *
      * @param {Object} params - The withdraw parameters.
      * @param {bigint} params.assets - The amount of assets to withdraw.
-     * @param {Address} [params.userAddress] - Optional user address initiating the withdraw.
+     * @param {Address} params.userAddress - User address initiating the withdraw.
      * @returns {Object} The result object.
      * @returns {Readonly<Transaction<VaultV2WithdrawAction>>} returns.tx The prepared withdraw transaction.
      */
@@ -60,7 +62,7 @@ export interface VaultV2Actions {
      *
      * @param {Object} params - The redeem parameters.
      * @param {bigint} params.shares - The amount of shares to redeem.
-     * @param {Address} [params.userAddress] - Optional user address initiating the redeem.
+     * @param {Address} params.userAddress - User address initiating the redeem.
      * @returns {Object} The result object.
      * @returns {Readonly<Transaction<VaultV2RedeemAction>>} returns.tx The prepared redeem transaction.
      */
@@ -76,7 +78,7 @@ export declare class MorphoVaultV2 implements VaultV2Actions {
     private readonly vault;
     private readonly chainId;
     constructor(client: MorphoClientType, vault: Address, chainId: number);
-    getData(): Promise<import("@morpho-org/blue-sdk").AccrualVaultV2>;
+    getData(parameters?: FetchParameters): Promise<import("@morpho-org/blue-sdk").AccrualVaultV2>;
     deposit({ assets, userAddress, slippageTolerance, }: {
         assets: bigint;
         userAddress: Address;

package/lib/entities/vaultV2/vaultV2.js

@@ -4,6 +4,7 @@ exports.MorphoVaultV2 = void 0;
 const blue_sdk_1 = require("@morpho-org/blue-sdk");
 const blue_sdk_viem_1 = require("@morpho-org/blue-sdk-viem");
 const actions_1 = require("../../actions");
+const constant_1 = require("../../helpers/constant");
 const types_1 = require("../../types");
 class MorphoVaultV2 {
     client;
@@ -14,9 +15,11 @@ class MorphoVaultV2 {
         this.vault = vault;
         this.chainId = chainId;
     }
-    async getData() {
+    async getData(parameters) {
         return (0, blue_sdk_viem_1.fetchAccrualVaultV2)(this.vault, this.client.viemClient, {
+            ...parameters,
             chainId: this.chainId,
+            deployless: this.client.options.supportDeployless,
         });
     }
     async deposit({ assets, userAddress, slippageTolerance = blue_sdk_1.DEFAULT_SLIPPAGE_TOLERANCE, }) {
@@ -25,13 +28,22 @@ class MorphoVaultV2 {
         }
         const vaultData = await (0, blue_sdk_viem_1.fetchVaultV2)(this.vault, this.client.viemClient, {
             chainId: this.chainId,
+            deployless: this.client.options.supportDeployless,
         });
-        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);
+        if (slippageTolerance > constant_1.MAX_SLIPPAGE_TOLERANCE) {
+            throw new types_1.ExcessiveSlippageToleranceError(slippageTolerance);
+        }
+        const shares = vaultData.toShares(assets);
+        if (shares === 0n) {
+            throw new types_1.ZeroSharesAmountError(this.vault);
+        }
+        const maxSharePrice = blue_sdk_1.MathLib.min(blue_sdk_1.MathLib.mulDivUp(assets, blue_sdk_1.MathLib.wToRay(blue_sdk_1.MathLib.WAD + slippageTolerance), shares), blue_sdk_1.MathLib.RAY * 100n);
         return {
             getRequirements: async (params) => await (0, actions_1.getRequirements)(this.client.viemClient, {
                 address: vaultData.asset,
                 chainId: this.chainId,
                 supportSignature: this.client.options.supportSignature,
+                supportDeployless: this.client.options.supportDeployless,
                 useSimplePermit: params?.useSimplePermit,
                 args: {
                     amount: assets,
@@ -55,6 +67,9 @@ class MorphoVaultV2 {
         };
     }
     withdraw({ assets, userAddress }) {
+        if (this.client.viemClient.chain?.id !== this.chainId) {
+            throw new types_1.ChainIdMismatchError(this.client.viemClient.chain?.id, this.chainId);
+        }
         return {
             buildTx: () => (0, actions_1.vaultV2Withdraw)({
                 vault: { address: this.vault },
@@ -68,6 +83,9 @@ class MorphoVaultV2 {
         };
     }
     redeem({ shares, userAddress }) {
+        if (this.client.viemClient.chain?.id !== this.chainId) {
+            throw new types_1.ChainIdMismatchError(this.client.viemClient.chain?.id, this.chainId);
+        }
         return {
             buildTx: () => (0, actions_1.vaultV2Redeem)({
                 vault: { address: this.vault },

package/lib/helpers/constant.d.ts

@@ -0,0 +1 @@
+export declare const MAX_SLIPPAGE_TOLERANCE: bigint;

package/lib/helpers/constant.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_SLIPPAGE_TOLERANCE = void 0;
+const blue_sdk_1 = require("@morpho-org/blue-sdk");
+exports.MAX_SLIPPAGE_TOLERANCE = blue_sdk_1.MathLib.WAD / 10n;

package/lib/types/client.d.ts

@@ -5,6 +5,7 @@ export interface MorphoClientType {
     readonly viemClient: Client;
     readonly options: {
         readonly supportSignature: boolean;
+        readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     };
     vaultV2: (vault: Address, chainId: number) => VaultV2Actions;

package/lib/types/data.d.ts

@@ -0,0 +1,2 @@
+import type { CallParameters, UnionPick } from "viem";
+export type FetchParameters = UnionPick<CallParameters, "account" | "blockNumber" | "blockTag" | "stateOverride">;

package/lib/types/data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/error.d.ts

@@ -20,3 +20,12 @@ export declare class MissingClientPropertyError extends Error {
 export declare class ApprovalAmountLessThanSpendAmountError extends Error {
     constructor();
 }
+export declare class ExcessiveSlippageToleranceError extends Error {
+    constructor(slippageTolerance: bigint);
+}
+export declare class DepositAmountMismatchError extends Error {
+    constructor(depositAmount: bigint, signatureAmount: bigint);
+}
+export declare class DepositAssetMismatchError extends Error {
+    constructor(depositAsset: Address, signatureAsset: Address);
+}

package/lib/types/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApprovalAmountLessThanSpendAmountError = exports.MissingClientPropertyError = exports.ChainIdMismatchError = exports.AddressMismatchError = exports.ZeroMaxSharePriceError = exports.ZeroSharesAmountError = exports.ZeroAssetAmountError = void 0;
+exports.DepositAssetMismatchError = exports.DepositAmountMismatchError = exports.ExcessiveSlippageToleranceError = exports.ApprovalAmountLessThanSpendAmountError = exports.MissingClientPropertyError = exports.ChainIdMismatchError = exports.AddressMismatchError = exports.ZeroMaxSharePriceError = exports.ZeroSharesAmountError = exports.ZeroAssetAmountError = void 0;
 class ZeroAssetAmountError extends Error {
     constructor(asset) {
         super(`Asset amount cannot be zero for address: ${asset}`);
@@ -43,3 +43,21 @@ class ApprovalAmountLessThanSpendAmountError extends Error {
     }
 }
 exports.ApprovalAmountLessThanSpendAmountError = ApprovalAmountLessThanSpendAmountError;
+class ExcessiveSlippageToleranceError extends Error {
+    constructor(slippageTolerance) {
+        super(`Slippage tolerance ${slippageTolerance} exceeds maximum allowed (10%)`);
+    }
+}
+exports.ExcessiveSlippageToleranceError = ExcessiveSlippageToleranceError;
+class DepositAmountMismatchError extends Error {
+    constructor(depositAmount, signatureAmount) {
+        super(`Deposit amount ${depositAmount} does not match requirement signature amount ${signatureAmount}`);
+    }
+}
+exports.DepositAmountMismatchError = DepositAmountMismatchError;
+class DepositAssetMismatchError extends Error {
+    constructor(depositAsset, signatureAsset) {
+        super(`Deposit asset ${depositAsset} does not match requirement signature asset ${signatureAsset}`);
+    }
+}
+exports.DepositAssetMismatchError = DepositAssetMismatchError;

package/package.json

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