@morpho-org/consumer-sdk 0.3.0 → 0.5.0

package/lib/actions/vaultV2/deposit.js

@@ -4,66 +4,98 @@ exports.vaultV2Deposit = void 0;
 const blue_sdk_1 = require("@morpho-org/blue-sdk");
 const bundler_sdk_viem_1 = require("@morpho-org/bundler-sdk-viem");
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
+const viem_1 = require("viem");
 const helpers_1 = require("../../helpers");
 const types_1 = require("../../types");
 const getRequirementsAction_1 = require("../requirements/getRequirementsAction");
 /**
  * Prepares a deposit transaction for the VaultV2 contract.
  *
- * This function constructs the transaction data required to deposit a specified amount of assets into the vault.
- * Bundler Integration: This flow uses the bundler to atomically execute the user's asset transfer and vault deposit in a single transaction for slippage protection.
+ * Routed through the bundler to atomically execute the asset transfer and vault deposit.
+ * The general adapter enforces `maxSharePrice` on-chain to prevent inflation attacks.
+ * Never bypass the general adapter.
  *
- * IMPORTANT FOR DEVELOPERS:
- * This deposit flow is routed through the general adapter in order to enforce a strict check on `maxSharePrice`.
- * This check is critical to prevent inflation attacks, especially for vaults where there is no "dead deposit" protection.
- * Do not bypass the general adapter or remove this check, as doing so would expose the flow to potential exploits.
- * The maxSharePrice constraint ensures that the user does not receive unfavorable share pricing due to malicious or sudden vault changes.
+ * When `nativeAmount` is provided, that amount of native ETH is sent as `msg.value`
+ * to the Bundler3 multicall and wrapped into WETH via `GeneralAdapter1.wrapNative()`.
+ * The vault's underlying asset must be the chain's wrapped native token (wNative).
  *
- *
- * @param {Object} params - The vault related parameters.
- * @param {Object} params.vault - The vault related parameters.
+ * @param {Object} params - The deposit parameters.
+ * @param {Object} params.vault - The vault identifiers.
  * @param {number} params.vault.chainId - The chain ID.
  * @param {Address} params.vault.address - The vault address.
- * @param {Address} params.vault.asset - The vault asset address.
- * @param {Object} params.args - The deposit related parameters.
- * @param {bigint} params.args.assets - The amount of assets to deposit.
- * @param {bigint} params.args.maxSharePrice - The maximum share price to accept for the deposit.
- * @param {Address} params.args.recipient - The recipient address.
- * @param {Object} params.args.requirementSignature - The requirement args and signature.
- * @param {Object} params.args.requirementSignature.args - The requirement signature arguments.
- * @param {Object} params.args.requirementSignature.action - The requirement signature action.
- * @param {Metadata} [params.metadata] - Optional the metadata.
- *
+ * @param {Address} params.vault.asset - The underlying ERC20 asset address.
+ * @param {Object} params.args - The deposit arguments.
+ * @param {bigint} [params.args.amount=0n] - Amount of ERC-20 assets to deposit. At least one of amount or nativeAmount must be provided.
+ * @param {bigint} params.args.maxSharePrice - Maximum acceptable share price (slippage protection).
+ * @param {Address} params.args.recipient - Receives the vault shares.
+ * @param {RequirementSignature} [params.args.requirementSignature] - Pre-signed permit/permit2 approval.
+ * @param {bigint} [params.args.nativeAmount] - Amount of native token to wrap into wNative for the deposit.
+ * @param {Metadata} [params.metadata] - Optional analytics metadata.
  * @returns {Readonly<Transaction<VaultV2DepositAction>>} The prepared deposit transaction.
  */
-const vaultV2Deposit = ({ vault: { chainId, address: vaultAddress, asset }, args: { assets, maxSharePrice, recipient, requirementSignature }, metadata, }) => {
-    if (assets === 0n) {
-        throw new types_1.ZeroAssetAmountError(asset);
+const vaultV2Deposit = ({ vault: { chainId, address: vaultAddress, asset }, args: { amount = 0n, maxSharePrice, recipient, requirementSignature, nativeAmount, }, metadata, }) => {
+    if (amount < 0n) {
+        throw new types_1.NonPositiveAssetAmountError(asset);
     }
-    if (maxSharePrice === 0n) {
-        throw new types_1.ZeroMaxSharePriceError(vaultAddress);
+    if (maxSharePrice <= 0n) {
+        throw new types_1.NonPositiveMaxSharePriceError(vaultAddress);
     }
     const actions = [];
-    if (requirementSignature) {
-        actions.push(...(0, getRequirementsAction_1.getRequirementsAction)({
-            chainId,
-            asset,
-            assets,
-            requirementSignature,
-        }));
-    }
-    else {
-        const { bundler3: { generalAdapter1 }, } = (0, blue_sdk_1.getChainAddresses)(chainId);
-        actions.push({
-            type: "erc20TransferFrom",
-            args: [asset, assets, generalAdapter1, false],
+    const { bundler3: { generalAdapter1, bundler3 }, wNative, } = (0, blue_sdk_1.getChainAddresses)(chainId);
+    if (nativeAmount) {
+        if (nativeAmount < 0n) {
+            throw new types_1.NegativeNativeAmountError(nativeAmount);
+        }
+        if (!(0, morpho_ts_1.isDefined)(wNative)) {
+            throw new types_1.ChainWNativeMissingError(chainId);
+        }
+        if (!(0, viem_1.isAddressEqual)(asset, wNative)) {
+            throw new types_1.NativeAmountOnNonWNativeVaultError(asset, wNative);
+        }
+        actions.push(
+        // Transfers native token from Bundler3 to GeneralAdapter1 for wrapping.
+        {
+            type: "nativeTransfer",
+            args: [bundler3, generalAdapter1, nativeAmount, false /* skipRevert */],
+        }, {
+            type: "wrapNative",
+            args: [nativeAmount, generalAdapter1, false /* skipRevert */],
         });
     }
+    if (amount > 0n) {
+        if (requirementSignature) {
+            actions.push(...(0, getRequirementsAction_1.getRequirementsAction)({
+                chainId,
+                asset,
+                amount,
+                requirementSignature,
+            }));
+        }
+        else {
+            actions.push({
+                type: "erc20TransferFrom",
+                args: [asset, amount, generalAdapter1, false /* skipRevert */],
+            });
+        }
+    }
+    const totalAssets = amount + (nativeAmount ?? 0n);
+    if (totalAssets === 0n) {
+        throw new types_1.ZeroDepositAmountError(vaultAddress);
+    }
     actions.push({
         type: "erc4626Deposit",
-        args: [vaultAddress, assets, maxSharePrice, recipient, false],
+        args: [
+            vaultAddress,
+            totalAssets,
+            maxSharePrice,
+            recipient,
+            false /* skipRevert */,
+        ],
     });
     let tx = bundler_sdk_viem_1.BundlerAction.encodeBundle(chainId, actions);
+    if (nativeAmount) {
+        tx = { ...tx, value: nativeAmount };
+    }
     if (metadata) {
         tx = (0, helpers_1.addTransactionMetadata)(tx, metadata);
     }
@@ -71,7 +103,13 @@ const vaultV2Deposit = ({ vault: { chainId, address: vaultAddress, asset }, args
         ...tx,
         action: {
             type: "vaultV2Deposit",
-            args: { vault: vaultAddress, assets, maxSharePrice, recipient },
+            args: {
+                vault: vaultAddress,
+                amount,
+                maxSharePrice,
+                recipient,
+                nativeAmount,
+            },
         },
     });
 };

package/lib/actions/vaultV2/forceRedeem.js

@@ -42,8 +42,8 @@ const vaultV2ForceRedeem = ({ vault: { address: vaultAddress }, args: { dealloca
     if (deallocations.length === 0) {
         throw new types_1.EmptyDeallocationsError(vaultAddress);
     }
-    if (redeem.shares === 0n) {
-        throw new types_1.ZeroSharesAmountError(vaultAddress);
+    if (redeem.shares <= 0n) {
+        throw new types_1.NonPositiveSharesAmountError(vaultAddress);
     }
     const calls = [];
     for (const deallocation of deallocations) {

package/lib/actions/vaultV2/forceWithdraw.d.ts

@@ -7,7 +7,7 @@ export interface VaultV2ForceWithdrawParams {
     args: {
         deallocations: readonly Deallocation[];
         withdraw: {
-            assets: bigint;
+            amount: bigint;
             recipient: Address;
         };
         onBehalf: Address;
@@ -31,7 +31,7 @@ export interface VaultV2ForceWithdrawParams {
  * @param {Object} params.args - The force withdraw related parameters.
  * @param {readonly Deallocation[]} params.args.deallocations - The list of deallocations to perform.
  * @param {Object} params.args.withdraw - The withdraw parameters applied after deallocations.
- * @param {bigint} params.args.withdraw.assets - The amount of assets to withdraw.
+ * @param {bigint} params.args.withdraw.amount - The amount of assets to withdraw.
  * @param {Address} params.args.withdraw.recipient - The recipient of the withdrawn assets.
  * @param {Address} params.args.onBehalf - The address from which the penalty is taken (share owner).
  * @param {Metadata} [params.metadata] - Optional analytics metadata to append.

package/lib/actions/vaultV2/forceWithdraw.js

@@ -24,7 +24,7 @@ const types_1 = require("../../types");
  * @param {Object} params.args - The force withdraw related parameters.
  * @param {readonly Deallocation[]} params.args.deallocations - The list of deallocations to perform.
  * @param {Object} params.args.withdraw - The withdraw parameters applied after deallocations.
- * @param {bigint} params.args.withdraw.assets - The amount of assets to withdraw.
+ * @param {bigint} params.args.withdraw.amount - The amount of assets to withdraw.
  * @param {Address} params.args.withdraw.recipient - The recipient of the withdrawn assets.
  * @param {Address} params.args.onBehalf - The address from which the penalty is taken (share owner).
  * @param {Metadata} [params.metadata] - Optional analytics metadata to append.
@@ -34,12 +34,16 @@ const vaultV2ForceWithdraw = ({ vault: { address: vaultAddress }, args: { deallo
     if (deallocations.length === 0) {
         throw new types_1.EmptyDeallocationsError(vaultAddress);
     }
-    if (withdraw.assets === 0n) {
-        throw new types_1.ZeroAssetAmountError(vaultAddress);
+    if (withdraw.amount <= 0n) {
+        throw new types_1.NonPositiveAssetAmountError(vaultAddress);
     }
-    const totalDeallocated = deallocations.reduce((sum, d) => sum + d.assets, 0n);
-    if (withdraw.assets < totalDeallocated) {
-        throw new types_1.DeallocationsExceedWithdrawError(vaultAddress, withdraw.assets, totalDeallocated);
+    const totalDeallocated = deallocations.reduce((sum, d) => sum + d.amount, 0n);
+    if (withdraw.amount < totalDeallocated) {
+        throw new types_1.DeallocationsExceedWithdrawError({
+            vault: vaultAddress,
+            withdrawAmount: withdraw.amount,
+            totalDeallocated,
+        });
     }
     const calls = [];
     for (const deallocation of deallocations) {
@@ -48,7 +52,7 @@ const vaultV2ForceWithdraw = ({ vault: { address: vaultAddress }, args: { deallo
     calls.push((0, viem_1.encodeFunctionData)({
         abi: blue_sdk_viem_1.vaultV2Abi,
         functionName: "withdraw",
-        args: [withdraw.assets, withdraw.recipient, onBehalf],
+        args: [withdraw.amount, withdraw.recipient, onBehalf],
     }));
     let tx = {
         to: vaultAddress,
@@ -70,7 +74,7 @@ const vaultV2ForceWithdraw = ({ vault: { address: vaultAddress }, args: { deallo
                 vault: vaultAddress,
                 deallocations: deallocations.map((d) => ({ ...d })),
                 withdraw: {
-                    assets: withdraw.assets,
+                    amount: withdraw.amount,
                     recipient: withdraw.recipient,
                 },
                 onBehalf,

package/lib/actions/vaultV2/redeem.js

@@ -25,8 +25,8 @@ const types_1 = require("../../types");
  * @returns {Readonly<Transaction<VaultV2RedeemAction>>} The prepared redeem transaction.
  */
 const vaultV2Redeem = ({ vault: { address: vaultAddress }, args: { shares, recipient, onBehalf }, metadata, }) => {
-    if (shares === 0n) {
-        throw new types_1.ZeroSharesAmountError(vaultAddress);
+    if (shares <= 0n) {
+        throw new types_1.NonPositiveSharesAmountError(vaultAddress);
     }
     let tx = {
         to: vaultAddress,

package/lib/actions/vaultV2/withdraw.d.ts

@@ -5,7 +5,7 @@ export interface VaultV2WithdrawParams {
         address: Address;
     };
     args: {
-        assets: bigint;
+        amount: bigint;
         recipient: Address;
         onBehalf: Address;
     };
@@ -23,10 +23,10 @@ export interface VaultV2WithdrawParams {
  * @param {Object} params.vault - The vault related parameters.
  * @param {Address} params.vault.address - The vault address.
  * @param {Object} params.args - The withdraw related parameters.
- * @param {bigint} params.args.assets - The amount of assets to withdraw.
+ * @param {bigint} params.args.amount - The amount of assets to withdraw.
  * @param {Address} params.args.recipient - The recipient address.
  * @param {Address} params.args.onBehalf - The address on behalf of which the withdraw is made.
  * @param {Metadata} [params.metadata] - Optional the metadata.
  * @returns {Readonly<Transaction<VaultV2WithdrawAction>>} The prepared withdraw transaction.
  */
-export declare const vaultV2Withdraw: ({ vault: { address: vaultAddress }, args: { assets, recipient, onBehalf }, metadata, }: VaultV2WithdrawParams) => Readonly<Transaction<VaultV2WithdrawAction>>;
+export declare const vaultV2Withdraw: ({ vault: { address: vaultAddress }, args: { amount, recipient, onBehalf }, metadata, }: VaultV2WithdrawParams) => Readonly<Transaction<VaultV2WithdrawAction>>;

package/lib/actions/vaultV2/withdraw.js

@@ -18,22 +18,22 @@ const types_1 = require("../../types");
  * @param {Object} params.vault - The vault related parameters.
  * @param {Address} params.vault.address - The vault address.
  * @param {Object} params.args - The withdraw related parameters.
- * @param {bigint} params.args.assets - The amount of assets to withdraw.
+ * @param {bigint} params.args.amount - The amount of assets to withdraw.
  * @param {Address} params.args.recipient - The recipient address.
  * @param {Address} params.args.onBehalf - The address on behalf of which the withdraw is made.
  * @param {Metadata} [params.metadata] - Optional the metadata.
  * @returns {Readonly<Transaction<VaultV2WithdrawAction>>} The prepared withdraw transaction.
  */
-const vaultV2Withdraw = ({ vault: { address: vaultAddress }, args: { assets, recipient, onBehalf }, metadata, }) => {
-    if (assets === 0n) {
-        throw new types_1.ZeroAssetAmountError(vaultAddress);
+const vaultV2Withdraw = ({ vault: { address: vaultAddress }, args: { amount, recipient, onBehalf }, metadata, }) => {
+    if (amount <= 0n) {
+        throw new types_1.NonPositiveAssetAmountError(vaultAddress);
     }
     let tx = {
         to: vaultAddress,
         data: (0, viem_1.encodeFunctionData)({
             abi: blue_sdk_viem_1.vaultV2Abi,
             functionName: "withdraw",
-            args: [assets, recipient, onBehalf],
+            args: [amount, recipient, onBehalf],
         }),
         value: 0n,
     };
@@ -44,7 +44,7 @@ const vaultV2Withdraw = ({ vault: { address: vaultAddress }, args: { assets, rec
         ...tx,
         action: {
             type: "vaultV2Withdraw",
-            args: { vault: vaultAddress, assets, recipient },
+            args: { vault: vaultAddress, amount, recipient },
         },
     });
 };

package/lib/client/morphoClient.d.ts

@@ -1,5 +1,6 @@
+import type { MarketParams } from "@morpho-org/blue-sdk";
 import type { Address, Client } from "viem";
-import { MorphoVaultV2 } from "../entities";
+import { MorphoMarketV1, MorphoVaultV1, MorphoVaultV2 } from "../entities";
 import type { Metadata, MorphoClientType } from "../types";
 export declare class MorphoClient implements MorphoClientType {
     readonly viemClient: Client;
@@ -18,5 +19,7 @@ export declare class MorphoClient implements MorphoClientType {
         readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     } | undefined);
+    vaultV1(vault: Address, chainId: number): MorphoVaultV1;
     vaultV2(vault: Address, chainId: number): MorphoVaultV2;
+    marketV1(marketParams: MarketParams, chainId: number): MorphoMarketV1;
 }

package/lib/client/morphoClient.js

@@ -15,8 +15,14 @@ class MorphoClient {
             supportDeployless: _options?.supportDeployless,
         };
     }
+    vaultV1(vault, chainId) {
+        return new entities_1.MorphoVaultV1(this, vault, chainId);
+    }
     vaultV2(vault, chainId) {
         return new entities_1.MorphoVaultV2(this, vault, chainId);
     }
+    marketV1(marketParams, chainId) {
+        return new entities_1.MorphoMarketV1(this, marketParams, chainId);
+    }
 }
 exports.MorphoClient = MorphoClient;

package/lib/client/morphoViemExtension.d.ts

@@ -3,18 +3,18 @@ import type { Metadata } from "../types";
 import { MorphoClient } from "./morphoClient";
 /**
  * Morpho extension for viem clients.
- * Adds `morpho` namespace to viem clients with vaultV2 actions.
+ * Adds `morpho` namespace with `vaultV1` and `vaultV2` accessors.
  *
- * @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
+ * @param metadata - (Optional) Metadata appended to all transactions for analytics.
+ * @param supportSignature - (Optional) Enable off-chain permit/permit2 approvals.
+ * @param supportDeployless - (Optional) Enable deployless reads for on-chain data fetching.
+ * @returns Extension function that adds morpho namespace to viem clients.
  *
  * @example
  * ```ts
  * import { createWalletClient, http } from 'viem';
  * import { mainnet } from 'viem/chains';
- * import { morpho } from '@morpho-org/consumer-sdk';
+ * import { morphoViemExtension } from '@morpho-org/consumer-sdk';
  *
  * const client = createWalletClient({
  *   chain: mainnet,
@@ -22,9 +22,12 @@ import { MorphoClient } from "./morphoClient";
  *   account: '0x...',
  * }).extend(morphoViemExtension());
  *
- * // Use morpho actions
- * const vault = client.morpho.vaultV2('0x...');
- * const deposit = await vault.deposit({ assets: 1000000000000000000n });
+ * // VaultV1 (MetaMorpho)
+ * const vaultV1 = client.morpho.vaultV1('0x...', 1);
+ * const depositV1 = await vaultV1.deposit({ amount: 1000000000000000000n, userAddress: '0x...' });
+ *
+ * // VaultV2
+ * const vaultV2 = client.morpho.vaultV2('0x...', 1);
  * ```
  */
 export declare function morphoViemExtension(_options?: {

package/lib/client/morphoViemExtension.js

@@ -4,18 +4,18 @@ exports.morphoViemExtension = morphoViemExtension;
 const morphoClient_1 = require("./morphoClient");
 /**
  * Morpho extension for viem clients.
- * Adds `morpho` namespace to viem clients with vaultV2 actions.
+ * Adds `morpho` namespace with `vaultV1` and `vaultV2` accessors.
  *
- * @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
+ * @param metadata - (Optional) Metadata appended to all transactions for analytics.
+ * @param supportSignature - (Optional) Enable off-chain permit/permit2 approvals.
+ * @param supportDeployless - (Optional) Enable deployless reads for on-chain data fetching.
+ * @returns Extension function that adds morpho namespace to viem clients.
  *
  * @example
  * ```ts
  * import { createWalletClient, http } from 'viem';
  * import { mainnet } from 'viem/chains';
- * import { morpho } from '@morpho-org/consumer-sdk';
+ * import { morphoViemExtension } from '@morpho-org/consumer-sdk';
  *
  * const client = createWalletClient({
  *   chain: mainnet,
@@ -23,9 +23,12 @@ const morphoClient_1 = require("./morphoClient");
  *   account: '0x...',
  * }).extend(morphoViemExtension());
  *
- * // Use morpho actions
- * const vault = client.morpho.vaultV2('0x...');
- * const deposit = await vault.deposit({ assets: 1000000000000000000n });
+ * // VaultV1 (MetaMorpho)
+ * const vaultV1 = client.morpho.vaultV1('0x...', 1);
+ * const depositV1 = await vaultV1.deposit({ amount: 1000000000000000000n, userAddress: '0x...' });
+ *
+ * // VaultV2
+ * const vaultV2 = client.morpho.vaultV2('0x...', 1);
  * ```
  */
 function morphoViemExtension(_options) {

package/lib/entities/index.d.ts

@@ -1 +1,3 @@
+export * from "./marketV1";
+export * from "./vaultV1";
 export * from "./vaultV2";

package/lib/entities/index.js

@@ -14,4 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./marketV1"), exports);
+__exportStar(require("./vaultV1"), exports);
 __exportStar(require("./vaultV2"), exports);

package/lib/entities/marketV1/index.d.ts

@@ -0,0 +1 @@
+export * from "./marketV1";

package/lib/entities/marketV1/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./marketV1"), exports);