@morpho-org/consumer-sdk 0.3.0 → 0.5.0

package/lib/types/client.d.ts

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

package/lib/types/deallocation.d.ts

@@ -11,5 +11,5 @@ import type { Address } from "viem";
 export interface Deallocation {
     readonly adapter: Address;
     readonly marketParams?: MarketParams;
-    readonly assets: bigint;
+    readonly amount: bigint;
 }

package/lib/types/error.d.ts

@@ -1,11 +1,11 @@
 import type { Address } from "viem";
-export declare class ZeroAssetAmountError extends Error {
+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,6 +20,12 @@ 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 MissingAccrualPositionError extends Error {
+    constructor(market: string);
+}
 export declare class ExcessiveSlippageToleranceError extends Error {
     constructor(slippageTolerance: bigint);
 }
@@ -33,5 +39,122 @@ export declare class DepositAssetMismatchError extends Error {
     constructor(depositAsset: Address, signatureAsset: Address);
 }
 export declare class DeallocationsExceedWithdrawError extends Error {
-    constructor(vault: Address, withdrawAssets: bigint, totalDeallocated: bigint);
+    constructor(params: {
+        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);
+}
+export declare class NonPositiveBorrowAmountError extends Error {
+    constructor(market: string);
+}
+export declare class ZeroCollateralAmountError extends Error {
+    constructor(market: string);
+}
+export declare class NativeAmountOnNonWNativeCollateralError extends Error {
+    constructor(collateralToken: Address, wNative: Address);
+}
+export declare class BorrowExceedsSafeLtvError extends Error {
+    constructor(borrowAmount: bigint, maxSafeBorrow: bigint);
+}
+export declare class MissingMarketPriceError extends Error {
+    constructor(market: string);
+}
+export declare class MarketIdMismatchError extends Error {
+    constructor(marketId: string, expectedMarketId: string);
+}
+export declare class AccrualPositionUserMismatchError extends Error {
+    constructor(positionUser: string, expectedUser: string);
+}
+export declare class NegativeReallocationFeeError extends Error {
+    constructor(vault: string);
+}
+export declare class EmptyReallocationWithdrawalsError extends Error {
+    constructor(vault: string);
+}
+export declare class NonPositiveReallocationAmountError extends Error {
+    constructor(vault: string, market: string);
+}
+export declare class ReallocationWithdrawalOnTargetMarketError extends Error {
+    constructor(vault: string, marketId: string);
+}
+export declare class UnsortedReallocationWithdrawalsError extends Error {
+    constructor(vault: string, marketId: string);
+}
+export declare class NonPositiveTransferAmountError extends Error {
+    constructor(market: string);
+}
+export declare class TransferAmountNotEqualToAssetsError extends Error {
+    constructor(params: {
+        transferAmount: bigint;
+        assets: bigint;
+        market: string;
+    });
+}
+export declare class MutuallyExclusiveRepayAmountsError extends Error {
+    constructor(market: string);
+}
+export declare class NonPositiveRepayAmountError extends Error {
+    constructor(market: string);
+}
+export declare class NonPositiveRepayMaxSharePriceError extends Error {
+    constructor(market: string);
+}
+export declare class NonPositiveWithdrawCollateralAmountError extends Error {
+    constructor(market: string);
+}
+export declare class WithdrawExceedsCollateralError extends Error {
+    constructor(params: {
+        withdrawAmount: bigint;
+        available: bigint;
+        market: string;
+    });
+}
+export declare class WithdrawMakesPositionUnhealthyError extends Error {
+    constructor(params: {
+        withdrawAmount: bigint;
+        borrowAssets: bigint;
+        maxSafeBorrow: bigint;
+    });
+}
+export declare class ShareDivideByZeroError extends Error {
+    constructor(market: string);
+}
+export declare class RepayExceedsDebtError extends Error {
+    constructor(params: {
+        repayAmount: bigint;
+        debt: bigint;
+        market: string;
+    });
+}
+export declare class InvalidSignatureError extends Error {
+    constructor();
+}
+export declare class RepaySharesExceedDebtError extends Error {
+    constructor(params: {
+        repayShares: bigint;
+        borrowShares: bigint;
+        market: string;
+    });
+}
+export declare class MissingPublicAllocatorConfigError extends Error {
+    constructor(vault: string);
+}
+export declare class NonPositiveMinBorrowSharePriceError extends Error {
+    constructor(market: string);
 }

package/lib/types/error.js

@@ -1,24 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeallocationsExceedWithdrawError = exports.DepositAssetMismatchError = exports.DepositAmountMismatchError = exports.EmptyDeallocationsError = exports.ExcessiveSlippageToleranceError = exports.ApprovalAmountLessThanSpendAmountError = exports.MissingClientPropertyError = exports.ChainIdMismatchError = exports.AddressMismatchError = exports.ZeroMaxSharePriceError = exports.ZeroSharesAmountError = exports.ZeroAssetAmountError = void 0;
-class ZeroAssetAmountError extends Error {
+exports.NonPositiveMinBorrowSharePriceError = exports.MissingPublicAllocatorConfigError = exports.RepaySharesExceedDebtError = exports.InvalidSignatureError = exports.RepayExceedsDebtError = exports.ShareDivideByZeroError = exports.WithdrawMakesPositionUnhealthyError = exports.WithdrawExceedsCollateralError = exports.NonPositiveWithdrawCollateralAmountError = exports.NonPositiveRepayMaxSharePriceError = exports.NonPositiveRepayAmountError = exports.MutuallyExclusiveRepayAmountsError = exports.TransferAmountNotEqualToAssetsError = exports.NonPositiveTransferAmountError = exports.UnsortedReallocationWithdrawalsError = exports.ReallocationWithdrawalOnTargetMarketError = exports.NonPositiveReallocationAmountError = exports.EmptyReallocationWithdrawalsError = exports.NegativeReallocationFeeError = exports.AccrualPositionUserMismatchError = exports.MarketIdMismatchError = exports.MissingMarketPriceError = exports.BorrowExceedsSafeLtvError = exports.NativeAmountOnNonWNativeCollateralError = exports.ZeroCollateralAmountError = exports.NonPositiveBorrowAmountError = exports.VaultAddressMismatchError = exports.ZeroDepositAmountError = exports.NegativeNativeAmountError = exports.ChainWNativeMissingError = exports.NativeAmountOnNonWNativeVaultError = exports.DeallocationsExceedWithdrawError = exports.DepositAssetMismatchError = exports.DepositAmountMismatchError = exports.EmptyDeallocationsError = exports.ExcessiveSlippageToleranceError = exports.MissingAccrualPositionError = 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 cannot be zero for address ${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,6 +43,18 @@ 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 MissingAccrualPositionError extends Error {
+    constructor(market) {
+        super(`Accrual position is missing for market: ${market}`);
+    }
+}
+exports.MissingAccrualPositionError = MissingAccrualPositionError;
 class ExcessiveSlippageToleranceError extends Error {
     constructor(slippageTolerance) {
         super(`Slippage tolerance ${slippageTolerance} exceeds maximum allowed (10%)`);
@@ -68,8 +80,194 @@ class DepositAssetMismatchError extends Error {
 }
 exports.DepositAssetMismatchError = DepositAssetMismatchError;
 class DeallocationsExceedWithdrawError extends Error {
-    constructor(vault, withdrawAssets, totalDeallocated) {
-        super(`Total deallocated assets (${totalDeallocated}) exceed withdraw amount (${withdrawAssets}) for vault: ${vault}`);
+    constructor(params) {
+        super(`Total deallocated amount (${params.totalDeallocated}) exceed withdraw amount (${params.withdrawAmount}) for vault: ${params.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;
+class NonPositiveBorrowAmountError extends Error {
+    constructor(market) {
+        super(`Borrow amount must be positive for market: ${market}`);
+    }
+}
+exports.NonPositiveBorrowAmountError = NonPositiveBorrowAmountError;
+class ZeroCollateralAmountError extends Error {
+    constructor(market) {
+        super(`Total collateral amount must be positive for market: ${market}. Both amount and nativeAmount are zero.`);
+    }
+}
+exports.ZeroCollateralAmountError = ZeroCollateralAmountError;
+class NativeAmountOnNonWNativeCollateralError extends Error {
+    constructor(collateralToken, wNative) {
+        super(`Cannot use nativeAmount: collateral token ${collateralToken} is not the wrapped native token ${wNative}`);
+    }
+}
+exports.NativeAmountOnNonWNativeCollateralError = NativeAmountOnNonWNativeCollateralError;
+class BorrowExceedsSafeLtvError extends Error {
+    constructor(borrowAmount, maxSafeBorrow) {
+        super(`Borrow amount ${borrowAmount} exceeds safe maximum ${maxSafeBorrow} (LLTV minus buffer). Reduce borrow or increase collateral.`);
+    }
+}
+exports.BorrowExceedsSafeLtvError = BorrowExceedsSafeLtvError;
+class MissingMarketPriceError extends Error {
+    constructor(market) {
+        super(`Oracle price unavailable for market ${market}. Cannot validate position health.`);
+    }
+}
+exports.MissingMarketPriceError = MissingMarketPriceError;
+class MarketIdMismatchError extends Error {
+    constructor(marketId, expectedMarketId) {
+        super(`Market ${marketId} does not match expected market ${expectedMarketId}`);
+    }
+}
+exports.MarketIdMismatchError = MarketIdMismatchError;
+class AccrualPositionUserMismatchError extends Error {
+    constructor(positionUser, expectedUser) {
+        super(`Accrual position user ${positionUser} does not match expected user ${expectedUser}`);
+    }
+}
+exports.AccrualPositionUserMismatchError = AccrualPositionUserMismatchError;
+class NegativeReallocationFeeError extends Error {
+    constructor(vault) {
+        super(`Reallocation fee must not be negative for vault: ${vault}`);
+    }
+}
+exports.NegativeReallocationFeeError = NegativeReallocationFeeError;
+class EmptyReallocationWithdrawalsError extends Error {
+    constructor(vault) {
+        super(`Reallocation withdrawals list cannot be empty for vault: ${vault}`);
+    }
+}
+exports.EmptyReallocationWithdrawalsError = EmptyReallocationWithdrawalsError;
+class NonPositiveReallocationAmountError extends Error {
+    constructor(vault, market) {
+        super(`Reallocation withdrawal amount must be positive for vault ${vault} on market ${market}`);
+    }
+}
+exports.NonPositiveReallocationAmountError = NonPositiveReallocationAmountError;
+class ReallocationWithdrawalOnTargetMarketError extends Error {
+    constructor(vault, marketId) {
+        super(`Reallocation withdrawal cannot include the borrow target market ${marketId} for vault ${vault}.`);
+    }
+}
+exports.ReallocationWithdrawalOnTargetMarketError = ReallocationWithdrawalOnTargetMarketError;
+class UnsortedReallocationWithdrawalsError extends Error {
+    constructor(vault, marketId) {
+        super(`Reallocation withdrawals must be strictly sorted by market ID for vault ${vault}. Market ${marketId} is out of order.`);
+    }
+}
+exports.UnsortedReallocationWithdrawalsError = UnsortedReallocationWithdrawalsError;
+class NonPositiveTransferAmountError extends Error {
+    constructor(market) {
+        super(`Transfer amount must be positive for market: ${market}`);
+    }
+}
+exports.NonPositiveTransferAmountError = NonPositiveTransferAmountError;
+class TransferAmountNotEqualToAssetsError extends Error {
+    constructor(params) {
+        super(`Transfer amount ${params.transferAmount} is not equal to repay assets ${params.assets} for market: ${params.market}`);
+    }
+}
+exports.TransferAmountNotEqualToAssetsError = TransferAmountNotEqualToAssetsError;
+class MutuallyExclusiveRepayAmountsError extends Error {
+    constructor(market) {
+        super(`Exactly one of assets or shares must be non-zero for market: ${market}. Both were provided.`);
+    }
+}
+exports.MutuallyExclusiveRepayAmountsError = MutuallyExclusiveRepayAmountsError;
+class NonPositiveRepayAmountError extends Error {
+    constructor(market) {
+        super(`Repay amount must be positive for market: ${market}`);
+    }
+}
+exports.NonPositiveRepayAmountError = NonPositiveRepayAmountError;
+class NonPositiveRepayMaxSharePriceError extends Error {
+    constructor(market) {
+        super(`Max share price must be positive for market: ${market}`);
+    }
+}
+exports.NonPositiveRepayMaxSharePriceError = NonPositiveRepayMaxSharePriceError;
+class NonPositiveWithdrawCollateralAmountError extends Error {
+    constructor(market) {
+        super(`Withdraw collateral amount must be positive for market: ${market}`);
+    }
+}
+exports.NonPositiveWithdrawCollateralAmountError = NonPositiveWithdrawCollateralAmountError;
+class WithdrawExceedsCollateralError extends Error {
+    constructor(params) {
+        super(`Withdraw amount ${params.withdrawAmount} exceeds available collateral ${params.available} for market: ${params.market}`);
+    }
+}
+exports.WithdrawExceedsCollateralError = WithdrawExceedsCollateralError;
+class WithdrawMakesPositionUnhealthyError extends Error {
+    constructor(params) {
+        super(`Withdrawing ${params.withdrawAmount} collateral would make position unhealthy. Max safe borrow after withdrawal: ${params.maxSafeBorrow}. Actual Borrow assets: ${params.borrowAssets}.`);
+    }
+}
+exports.WithdrawMakesPositionUnhealthyError = WithdrawMakesPositionUnhealthyError;
+class ShareDivideByZeroError extends Error {
+    constructor(market) {
+        super(`Share divide by zero error for market: ${market}`);
+    }
+}
+exports.ShareDivideByZeroError = ShareDivideByZeroError;
+class RepayExceedsDebtError extends Error {
+    constructor(params) {
+        super(`Repay amount ${params.repayAmount} exceeds outstanding debt ${params.debt} for market: ${params.market}`);
+    }
+}
+exports.RepayExceedsDebtError = RepayExceedsDebtError;
+class InvalidSignatureError extends Error {
+    constructor() {
+        super("Signature verification failed: the signed data does not match the expected signer address");
+    }
+}
+exports.InvalidSignatureError = InvalidSignatureError;
+class RepaySharesExceedDebtError extends Error {
+    constructor(params) {
+        super(`Repay shares ${params.repayShares} exceed outstanding borrow shares ${params.borrowShares} for market: ${params.market}`);
+    }
+}
+exports.RepaySharesExceedDebtError = RepaySharesExceedDebtError;
+class MissingPublicAllocatorConfigError extends Error {
+    constructor(vault) {
+        super(`Vault ${vault} has no public allocator configured but was selected for reallocation`);
+    }
+}
+exports.MissingPublicAllocatorConfigError = MissingPublicAllocatorConfigError;
+class NonPositiveMinBorrowSharePriceError extends Error {
+    constructor(market) {
+        super(`Min share price must be non-negative for market: ${market}`);
+    }
+}
+exports.NonPositiveMinBorrowSharePriceError = NonPositiveMinBorrowSharePriceError;

package/lib/types/index.d.ts

@@ -4,3 +4,4 @@ export * from "./deallocation";
 export * from "./entity";
 export * from "./error";
 export * from "./metadata";
+export * from "./sharedLiquidity";

package/lib/types/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./deallocation"), exports);
 __exportStar(require("./entity"), exports);
 __exportStar(require("./error"), exports);
 __exportStar(require("./metadata"), exports);
+__exportStar(require("./sharedLiquidity"), exports);

package/lib/types/sharedLiquidity.d.ts

@@ -0,0 +1,41 @@
+import type { MarketId, MarketParams } from "@morpho-org/blue-sdk";
+import type { PublicAllocatorOptions } from "@morpho-org/simulation-sdk";
+import type { Address } from "viem";
+/** A single withdrawal from a source market within a vault reallocation. */
+export interface ReallocationWithdrawal {
+    readonly marketParams: MarketParams;
+    readonly amount: bigint;
+}
+/**
+ * A computed reallocation for a single vault.
+ *
+ * Maps 1:1 to a `PublicAllocator.reallocateTo()` call.
+ * Withdraws from source markets and supplies to the target market.
+ */
+export interface VaultReallocation {
+    readonly vault: Address;
+    /** Fee in native token (ETH) paid to the PublicAllocator for this vault. */
+    readonly fee: bigint;
+    /** Source markets to withdraw from before supplying to the target market. */
+    readonly withdrawals: readonly ReallocationWithdrawal[];
+}
+/**
+ * Options for computing vault reallocations via the public allocator.
+ *
+ * Extends {@link PublicAllocatorOptions} with supply-side utilization targets
+ * that determine when reallocation is triggered.
+ */
+export interface ReallocationComputeOptions extends PublicAllocatorOptions {
+    /**
+     * Per-market target utilization above which the shared liquidity algorithm
+     * is triggered (scaled by WAD). Overrides `defaultSupplyTargetUtilization`
+     * for the specified market.
+     */
+    readonly supplyTargetUtilization?: Record<MarketId, bigint | undefined>;
+    /**
+     * The default target utilization above which the shared liquidity algorithm
+     * is triggered (scaled by WAD).
+     * @default 90.5% (905000000000000000n)
+     */
+    readonly defaultSupplyTargetUtilization?: bigint;
+}

package/lib/types/sharedLiquidity.js

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

package/package.json

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