@morpho-org/consumer-sdk 0.2.0 → 0.4.0

package/lib/helpers/encodeDeallocation.d.ts

@@ -0,0 +1,10 @@
+import { type Address, type Hex } from "viem";
+import { type Deallocation } from "../types";
+/**
+ * Encodes a single `forceDeallocate` call as ABI-encoded calldata.
+ *
+ * @param deallocation - A deallocation entry.
+ * @param onBehalf - The address from which the penalty is taken (share owner).
+ * @returns The ABI-encoded calldata for `VaultV2.forceDeallocate`.
+ */
+export declare function encodeForceDeallocateCall(deallocation: Deallocation, onBehalf: Address): Hex;

package/lib/helpers/encodeDeallocation.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeForceDeallocateCall = encodeForceDeallocateCall;
+const blue_sdk_1 = require("@morpho-org/blue-sdk");
+const blue_sdk_viem_1 = require("@morpho-org/blue-sdk-viem");
+const viem_1 = require("viem");
+const types_1 = require("../types");
+/**
+ * Encodes the adapter-specific `data` bytes for a `forceDeallocate` call.
+ *
+ * @param deallocation - A deallocation entry.
+ * @returns The ABI-encoded bytes to pass as `data` to VaultV2.forceDeallocate.
+ */
+function encodeDeallocateData(deallocation) {
+    if (deallocation.marketParams) {
+        return (0, viem_1.encodeAbiParameters)([blue_sdk_1.marketParamsAbi], [deallocation.marketParams]);
+    }
+    return "0x";
+}
+/**
+ * Encodes a single `forceDeallocate` call as ABI-encoded calldata.
+ *
+ * @param deallocation - A deallocation entry.
+ * @param onBehalf - The address from which the penalty is taken (share owner).
+ * @returns The ABI-encoded calldata for `VaultV2.forceDeallocate`.
+ */
+function encodeForceDeallocateCall(deallocation, onBehalf) {
+    if (deallocation.amount <= 0n) {
+        throw new types_1.NonPositiveAssetAmountError(deallocation.adapter);
+    }
+    const data = encodeDeallocateData(deallocation);
+    return (0, viem_1.encodeFunctionData)({
+        abi: blue_sdk_viem_1.vaultV2Abi,
+        functionName: "forceDeallocate",
+        args: [deallocation.adapter, data, deallocation.amount, onBehalf],
+    });
+}

package/lib/types/action.d.ts

@@ -1,4 +1,5 @@
 import type { Address, Client, Hex } from "viem";
+import type { Deallocation } from "./deallocation";
 export interface BaseAction<TType extends string = string, TArgs extends Record<string, unknown> = Record<string, unknown>> {
     readonly type: TType;
     readonly args: TArgs;
@@ -13,14 +14,15 @@ export interface ERC20PermitAction {
 }
 export interface VaultV2DepositAction extends BaseAction<"vaultV2Deposit", {
     vault: Address;
-    assets: bigint;
+    amount: bigint;
     maxSharePrice: bigint;
     recipient: Address;
+    nativeAmount?: bigint;
 }> {
 }
 export interface VaultV2WithdrawAction extends BaseAction<"vaultV2Withdraw", {
     vault: Address;
-    assets: bigint;
+    amount: bigint;
     recipient: Address;
 }> {
 }
@@ -30,13 +32,67 @@ export interface VaultV2RedeemAction extends BaseAction<"vaultV2Redeem", {
     recipient: Address;
 }> {
 }
-export type TransactionAction = ERC20ApprovalAction | VaultV2DepositAction | VaultV2WithdrawAction | VaultV2RedeemAction;
+export interface VaultV2ForceWithdrawAction extends BaseAction<"vaultV2ForceWithdraw", {
+    vault: Address;
+    deallocations: readonly Deallocation[];
+    withdraw: {
+        amount: bigint;
+        recipient: Address;
+    };
+    onBehalf: Address;
+}> {
+}
+export interface VaultV2ForceRedeemAction extends BaseAction<"vaultV2ForceRedeem", {
+    vault: Address;
+    deallocations: readonly Deallocation[];
+    redeem: {
+        shares: bigint;
+        recipient: Address;
+    };
+    onBehalf: Address;
+}> {
+}
+export interface VaultV1DepositAction extends BaseAction<"vaultV1Deposit", {
+    vault: Address;
+    amount: bigint;
+    maxSharePrice: bigint;
+    recipient: Address;
+    nativeAmount?: bigint;
+}> {
+}
+export interface VaultV1WithdrawAction extends BaseAction<"vaultV1Withdraw", {
+    vault: Address;
+    amount: bigint;
+    recipient: Address;
+}> {
+}
+export interface VaultV1RedeemAction extends BaseAction<"vaultV1Redeem", {
+    vault: Address;
+    shares: bigint;
+    recipient: Address;
+}> {
+}
+export type TransactionAction = ERC20ApprovalAction | VaultV2DepositAction | VaultV2WithdrawAction | VaultV2RedeemAction | VaultV2ForceWithdrawAction | VaultV2ForceRedeemAction | VaultV1DepositAction | VaultV1WithdrawAction | VaultV1RedeemAction;
 export interface Transaction<TAction extends BaseAction = TransactionAction> {
     readonly to: Address;
     readonly value: bigint;
     readonly data: Hex;
     readonly action: TAction;
 }
+/**
+ * Enforces that at least one deposit amount source is provided.
+ *
+ * - `amount` alone: standard ERC20 deposit.
+ * - `nativeAmount` alone: pure native-wrap deposit (vault asset must be wNative).
+ * - Both: mixed deposit (ERC20 transfer + native wrap).
+ */
+export type DepositAmountArgs = {
+    amount: bigint;
+    nativeAmount?: bigint;
+} | {
+    nativeAmount: bigint;
+    amount?: bigint;
+};
 export interface PermitArgs {
     owner: Address;
     nonce: bigint;

package/lib/types/client.d.ts

@@ -1,5 +1,5 @@
 import type { Address, Client } from "viem";
-import type { VaultV2Actions } from "../entities";
+import type { VaultV1Actions, VaultV2Actions } from "../entities";
 import type { Metadata } from "./index";
 export interface MorphoClientType {
     readonly viemClient: Client;
@@ -8,5 +8,6 @@ export interface MorphoClientType {
         readonly supportDeployless?: boolean;
         readonly metadata?: Metadata;
     };
+    vaultV1: (vault: Address, chainId: number) => VaultV1Actions;
     vaultV2: (vault: Address, chainId: number) => VaultV2Actions;
 }

package/lib/types/deallocation.d.ts

@@ -0,0 +1,15 @@
+import type { MarketParams } from "@morpho-org/blue-sdk";
+import type { Address } from "viem";
+/**
+ * A single deallocation entry for a `forceDeallocate` call.
+ *
+ * - When `marketParams` is provided, the adapter is treated as a Morpho Market V1 adapter
+ *   and `data` is ABI-encoded from the given `MarketParams`.
+ * - When `marketParams` is omitted, empty bytes are passed as `data` (suitable for adapters
+ *   such as Vault V1 that do not require market identification).
+ */
+export interface Deallocation {
+    readonly adapter: Address;
+    readonly marketParams?: MarketParams;
+    readonly amount: bigint;
+}

package/lib/types/deallocation.js

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

package/lib/types/error.d.ts

@@ -1,11 +1,11 @@
 import type { Address } from "viem";
-export declare class ZeroAssetAmountError extends Error {
-    constructor(asset: Address);
+export declare class NonPositiveAssetAmountError extends Error {
+    constructor(origin: Address);
 }
-export declare class ZeroSharesAmountError extends Error {
+export declare class NonPositiveSharesAmountError extends Error {
     constructor(vault: Address);
 }
-export declare class ZeroMaxSharePriceError extends Error {
+export declare class NonPositiveMaxSharePriceError extends Error {
     constructor(vault: Address);
 }
 export declare class AddressMismatchError extends Error {
@@ -20,12 +20,36 @@ export declare class MissingClientPropertyError extends Error {
 export declare class ApprovalAmountLessThanSpendAmountError extends Error {
     constructor();
 }
+export declare class NegativeSlippageToleranceError extends Error {
+    constructor(slippageTolerance: bigint);
+}
 export declare class ExcessiveSlippageToleranceError extends Error {
     constructor(slippageTolerance: bigint);
 }
+export declare class EmptyDeallocationsError extends Error {
+    constructor(vault: Address);
+}
 export declare class DepositAmountMismatchError extends Error {
     constructor(depositAmount: bigint, signatureAmount: bigint);
 }
 export declare class DepositAssetMismatchError extends Error {
     constructor(depositAsset: Address, signatureAsset: Address);
 }
+export declare class DeallocationsExceedWithdrawError extends Error {
+    constructor(vault: Address, withdrawAmount: bigint, totalDeallocated: bigint);
+}
+export declare class NativeAmountOnNonWNativeVaultError extends Error {
+    constructor(vaultAsset: Address, wNative: Address);
+}
+export declare class ChainWNativeMissingError extends Error {
+    constructor(chainId: number);
+}
+export declare class NegativeNativeAmountError extends Error {
+    constructor(nativeAmount: bigint);
+}
+export declare class ZeroDepositAmountError extends Error {
+    constructor(vault: Address);
+}
+export declare class VaultAddressMismatchError extends Error {
+    constructor(vaultAddress: Address, argsVaultAddress: Address);
+}

package/lib/types/error.js

@@ -1,24 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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}`);
+exports.VaultAddressMismatchError = exports.ZeroDepositAmountError = exports.NegativeNativeAmountError = exports.ChainWNativeMissingError = exports.NativeAmountOnNonWNativeVaultError = exports.DeallocationsExceedWithdrawError = exports.DepositAssetMismatchError = exports.DepositAmountMismatchError = exports.EmptyDeallocationsError = exports.ExcessiveSlippageToleranceError = exports.NegativeSlippageToleranceError = exports.ApprovalAmountLessThanSpendAmountError = exports.MissingClientPropertyError = exports.ChainIdMismatchError = exports.AddressMismatchError = exports.NonPositiveMaxSharePriceError = exports.NonPositiveSharesAmountError = exports.NonPositiveAssetAmountError = void 0;
+class NonPositiveAssetAmountError extends Error {
+    constructor(origin) {
+        super(`Asset amount must be positive for address ${origin}`);
     }
 }
-exports.ZeroAssetAmountError = ZeroAssetAmountError;
-class ZeroSharesAmountError extends Error {
+exports.NonPositiveAssetAmountError = NonPositiveAssetAmountError;
+class NonPositiveSharesAmountError extends Error {
     constructor(vault) {
-        super(`Shares amount cannot be zero for address: ${vault}`);
+        super(`Shares amount must be positive for address: ${vault}`);
     }
 }
-exports.ZeroSharesAmountError = ZeroSharesAmountError;
-class ZeroMaxSharePriceError extends Error {
+exports.NonPositiveSharesAmountError = NonPositiveSharesAmountError;
+class NonPositiveMaxSharePriceError extends Error {
     constructor(vault) {
-        super(`Max share price cannot be zero for vault: ${vault}`);
+        super(`Max share price must be positive for vault: ${vault}`);
     }
 }
-exports.ZeroMaxSharePriceError = ZeroMaxSharePriceError;
+exports.NonPositiveMaxSharePriceError = NonPositiveMaxSharePriceError;
 class AddressMismatchError extends Error {
     constructor(clientAddress, argsAddress) {
         super(`Address mismatch between client: ${clientAddress} and args: ${argsAddress}`);
@@ -43,12 +43,24 @@ class ApprovalAmountLessThanSpendAmountError extends Error {
     }
 }
 exports.ApprovalAmountLessThanSpendAmountError = ApprovalAmountLessThanSpendAmountError;
+class NegativeSlippageToleranceError extends Error {
+    constructor(slippageTolerance) {
+        super(`Slippage tolerance ${slippageTolerance} must not be negative`);
+    }
+}
+exports.NegativeSlippageToleranceError = NegativeSlippageToleranceError;
 class ExcessiveSlippageToleranceError extends Error {
     constructor(slippageTolerance) {
         super(`Slippage tolerance ${slippageTolerance} exceeds maximum allowed (10%)`);
     }
 }
 exports.ExcessiveSlippageToleranceError = ExcessiveSlippageToleranceError;
+class EmptyDeallocationsError extends Error {
+    constructor(vault) {
+        super(`Deallocations list cannot be empty for vault: ${vault}`);
+    }
+}
+exports.EmptyDeallocationsError = EmptyDeallocationsError;
 class DepositAmountMismatchError extends Error {
     constructor(depositAmount, signatureAmount) {
         super(`Deposit amount ${depositAmount} does not match requirement signature amount ${signatureAmount}`);
@@ -61,3 +73,39 @@ class DepositAssetMismatchError extends Error {
     }
 }
 exports.DepositAssetMismatchError = DepositAssetMismatchError;
+class DeallocationsExceedWithdrawError extends Error {
+    constructor(vault, withdrawAmount, totalDeallocated) {
+        super(`Total deallocated amount (${totalDeallocated}) exceed withdraw amount (${withdrawAmount}) for vault: ${vault}`);
+    }
+}
+exports.DeallocationsExceedWithdrawError = DeallocationsExceedWithdrawError;
+class NativeAmountOnNonWNativeVaultError extends Error {
+    constructor(vaultAsset, wNative) {
+        super(`Cannot use nativeAmount: vault asset ${vaultAsset} is not the wrapped native token ${wNative}`);
+    }
+}
+exports.NativeAmountOnNonWNativeVaultError = NativeAmountOnNonWNativeVaultError;
+class ChainWNativeMissingError extends Error {
+    constructor(chainId) {
+        super(`Chain ${chainId} does not have a configured wrapped native token (wNative)`);
+    }
+}
+exports.ChainWNativeMissingError = ChainWNativeMissingError;
+class NegativeNativeAmountError extends Error {
+    constructor(nativeAmount) {
+        super(`Native amount must not be negative, got ${nativeAmount}`);
+    }
+}
+exports.NegativeNativeAmountError = NegativeNativeAmountError;
+class ZeroDepositAmountError extends Error {
+    constructor(vault) {
+        super(`Total deposit amount must be positive for vault: ${vault}. Both amount and nativeAmount are zero.`);
+    }
+}
+exports.ZeroDepositAmountError = ZeroDepositAmountError;
+class VaultAddressMismatchError extends Error {
+    constructor(vaultAddress, argsVaultAddress) {
+        super(`Vault address mismatch between vault: ${vaultAddress} and args: ${argsVaultAddress}`);
+    }
+}
+exports.VaultAddressMismatchError = VaultAddressMismatchError;

package/lib/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./action";
 export * from "./client";
+export * from "./deallocation";
 export * from "./entity";
 export * from "./error";
 export * from "./metadata";

package/lib/types/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./action"), exports);
 __exportStar(require("./client"), exports);
+__exportStar(require("./deallocation"), exports);
 __exportStar(require("./entity"), exports);
 __exportStar(require("./error"), exports);
 __exportStar(require("./metadata"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/consumer-sdk",
   "description": "Abstraction layer for Morpho's complexity.",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Foulks-Plb <https://x.com/FoulkPlb>"
@@ -20,7 +20,7 @@
   "devDependencies": {
     "@biomejs/biome": "2.3.3",
     "@changesets/cli": "^2.29.8",
-    "@morpho-org/test": "2.6.7",
+    "@morpho-org/test": "2.7.0",
     "@types/node": "^24.9.1",
     "@vitest/coverage-v8": "3.2.4",
     "@vitest/ui": "3.2.4",