@morpho-org/blue-sdk 6.0.1 → 6.2.0

package/lib/esm/errors.js

@@ -1,4 +1,5 @@
 import { formatUnits } from "viem";
+/** Error thrown when bytes cannot be decoded into valid Morpho Blue market params. */
 export class InvalidMarketParamsError extends Error {
     data;
     constructor(data) {
@@ -6,8 +7,10 @@ export class InvalidMarketParamsError extends Error {
         this.data = data;
     }
 }
+/** Base error for optional data lookups that were not available. */
 export class UnknownDataError extends Error {
 }
+/** Error thrown when token metadata is unavailable for an address. */
 export class UnknownTokenError extends UnknownDataError {
     address;
     constructor(address) {
@@ -15,6 +18,7 @@ export class UnknownTokenError extends UnknownDataError {
         this.address = address;
     }
 }
+/** Error thrown when a token price is unavailable for an address. */
 export class UnknownTokenPriceError extends UnknownDataError {
     address;
     constructor(address) {
@@ -22,6 +26,7 @@ export class UnknownTokenPriceError extends UnknownDataError {
         this.address = address;
     }
 }
+/** Error thrown when market params are unavailable for a market id. */
 export class UnknownMarketParamsError extends UnknownDataError {
     marketId;
     constructor(marketId) {
@@ -29,6 +34,7 @@ export class UnknownMarketParamsError extends UnknownDataError {
         this.marketId = marketId;
     }
 }
+/** Error thrown when vault config is unavailable for a vault address. */
 export class UnknownVaultConfigError extends UnknownDataError {
     vault;
     constructor(vault) {
@@ -36,6 +42,15 @@ export class UnknownVaultConfigError extends UnknownDataError {
         this.vault = vault;
     }
 }
+/** Error thrown when a vault withdraw queue references a market without an allocation. */
+export class UnknownMarketAllocationError extends UnknownDataError {
+    marketId;
+    constructor(marketId) {
+        super(`unknown allocation for market ${marketId}`);
+        this.marketId = marketId;
+    }
+}
+/** Error thrown when a chain id has no configured SDK registry entry. */
 export class UnsupportedChainIdError extends Error {
     chainId;
     constructor(chainId) {
@@ -43,6 +58,7 @@ export class UnsupportedChainIdError extends Error {
         this.chainId = chainId;
     }
 }
+/** Error thrown when no default pre-liquidation params exist for an LLTV. */
 export class UnsupportedPreLiquidationParamsError extends Error {
     lltv;
     constructor(lltv) {
@@ -50,6 +66,7 @@ export class UnsupportedPreLiquidationParamsError extends Error {
         this.lltv = lltv;
     }
 }
+/** Error thrown when a Vault V2 adapter address is not supported by the SDK. */
 export class UnsupportedVaultV2AdapterError extends Error {
     address;
     constructor(address) {
@@ -57,8 +74,10 @@ export class UnsupportedVaultV2AdapterError extends Error {
         this.address = address;
     }
 }
+/** Morpho Blue protocol simulation errors. */
 export var BlueErrors;
 (function (BlueErrors) {
+    /** Error thrown when a value that must be set once is already set. */
     class AlreadySet extends Error {
         name;
         value;
@@ -69,6 +88,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.AlreadySet = AlreadySet;
+    /** Error thrown when market interest accrual is requested before `lastUpdate`. */
     class InvalidInterestAccrual extends Error {
         marketId;
         timestamp;
@@ -82,6 +102,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.InvalidInterestAccrual = InvalidInterestAccrual;
+    /** Error thrown when asset and share inputs describe inconsistent values. */
     class InconsistentInput extends Error {
         assets;
         shares;
@@ -92,6 +113,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.InconsistentInput = InconsistentInput;
+    /** Error thrown when a market has insufficient liquidity for an operation. */
     class InsufficientLiquidity extends Error {
         marketId;
         constructor(marketId) {
@@ -100,6 +122,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.InsufficientLiquidity = InsufficientLiquidity;
+    /** Error thrown when a market oracle price is unavailable. */
     class UnknownOraclePrice extends Error {
         marketId;
         constructor(marketId) {
@@ -108,6 +131,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.UnknownOraclePrice = UnknownOraclePrice;
+    /** Error thrown when a user position is too small for an operation. */
     class InsufficientPosition extends Error {
         user;
         marketId;
@@ -118,6 +142,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.InsufficientPosition = InsufficientPosition;
+    /** Error thrown when a user position lacks required collateral. */
     class InsufficientCollateral extends Error {
         user;
         marketId;
@@ -128,6 +153,7 @@ export var BlueErrors;
         }
     }
     BlueErrors.InsufficientCollateral = InsufficientCollateral;
+    /** Error thrown when a signature deadline has expired. */
     class ExpiredSignature extends Error {
         deadline;
         constructor(deadline) {
@@ -137,8 +163,10 @@ export var BlueErrors;
     }
     BlueErrors.ExpiredSignature = ExpiredSignature;
 })(BlueErrors || (BlueErrors = {}));
+/** Morpho Vault V2 simulation errors. */
 export var VaultV2Errors;
 (function (VaultV2Errors) {
+    /** Error thrown when vault interest accrual is requested before `lastUpdate`. */
     class InvalidInterestAccrual extends Error {
         vault;
         timestamp;
@@ -152,6 +180,7 @@ export var VaultV2Errors;
         }
     }
     VaultV2Errors.InvalidInterestAccrual = InvalidInterestAccrual;
+    /** Error thrown when a Vault V2 liquidity adapter is not supported by the SDK. */
     class UnsupportedLiquidityAdapter extends Error {
         address;
         constructor(address) {
@@ -161,11 +190,13 @@ export var VaultV2Errors;
     }
     VaultV2Errors.UnsupportedLiquidityAdapter = UnsupportedLiquidityAdapter;
 })(VaultV2Errors || (VaultV2Errors = {}));
+/** Error thrown when a factory address is unavailable. */
 export class UnknownFactory extends Error {
     constructor() {
         super(`unknown factory`);
     }
 }
+/** Error thrown when an address is not deployed by the expected factory. */
 export class UnknownOfFactory extends Error {
     factory;
     address;
@@ -175,6 +206,11 @@ export class UnknownOfFactory extends Error {
         this.address = address;
     }
 }
+/**
+ * Runs an accessor and returns `undefined` for expected lookup errors.
+ *
+ * @internal
+ */
 export function _try(accessor, ...errorClasses) {
     const maybeCatchError = (error) => {
         if (errorClasses.length === 0 ||

package/lib/esm/holding/AssetBalances.d.ts

@@ -1,4 +1,5 @@
 import type { Token } from "../token/Token.js";
+/** Balance conversion category for a requested token and related peripheral tokens. */
 export type PeripheralBalanceType = "base" | "wrapped" | "staked-wrapped" | "vault" | "wrapped-vault" | "unwrapped-staked-wrapped";
 /**
  * Represents the balance of a requested token and the balance quoted in the corresponding source token:
@@ -27,8 +28,10 @@ export interface PeripheralBalance {
      */
     dstAmount: bigint;
 }
+/** Constructor input for `AssetBalances`. */
 export interface IAssetBalances extends Omit<PeripheralBalance, "type"> {
 }
+/** Aggregates balances across a requested token and related peripheral tokens. */
 export declare class AssetBalances {
     /**
      * The total balance of all types of related tokens.

package/lib/esm/holding/AssetBalances.js

@@ -1,3 +1,4 @@
+/** Aggregates balances across a requested token and related peripheral tokens. */
 export class AssetBalances {
     /**
      * The total balance of all types of related tokens.

package/lib/esm/holding/Holding.d.ts

@@ -1,16 +1,21 @@
 import type { Address, BigIntish } from "../types.js";
+/** Address registry labels that may receive ERC-20 allowances from a user. */
 export declare const ERC20_ALLOWANCE_RECIPIENTS: readonly ["morpho", "permit2", "bundler3.generalAdapter1"];
+/** Address registry label that may receive an ERC-20 allowance from a user. */
 export type Erc20AllowanceRecipient = (typeof ERC20_ALLOWANCE_RECIPIENTS)[number];
+/** Normalized Permit2 allowance values. */
 export interface Permit2Allowance {
     amount: bigint;
     expiration: bigint;
     nonce: bigint;
 }
+/** Input shape for Permit2 allowance values before bigint normalization. */
 export interface IPermit2Allowance {
     amount: BigIntish;
     expiration: BigIntish;
     nonce: BigIntish;
 }
+/** Input shape for a user's token holding and allowance state. */
 export interface IHolding {
     user: Address;
     token: Address;
@@ -22,6 +27,7 @@ export interface IHolding {
     canTransfer?: boolean;
     balance: bigint;
 }
+/** Represents a user's balance and allowance state for one token. */
 export declare class Holding implements IHolding {
     /**
      * The user of this holding.

package/lib/esm/holding/Holding.js

@@ -1,9 +1,11 @@
 import { entries, fromEntries } from "@morpho-org/morpho-ts";
+/** Address registry labels that may receive ERC-20 allowances from a user. */
 export const ERC20_ALLOWANCE_RECIPIENTS = [
     "morpho",
     "permit2",
     "bundler3.generalAdapter1",
 ];
+/** Represents a user's balance and allowance state for one token. */
 export class Holding {
     /**
      * The user of this holding.

package/lib/esm/market/Market.d.ts

@@ -2,12 +2,15 @@ import { type RoundingDirection } from "../math/index.js";
 import type { BigIntish } from "../types.js";
 import { type CapacityLimit } from "../utils.js";
 import { type IMarketParams, MarketParams } from "./MarketParams.js";
+/** Options for max borrow capacity calculations. */
 export interface MaxBorrowOptions {
     maxLtv?: bigint;
 }
+/** Options for max withdraw collateral capacity calculations. */
 export interface MaxWithdrawCollateralOptions {
     maxLtv?: bigint;
 }
+/** Capacity limits for each market operation available to a position. */
 export interface MaxPositionCapacities {
     supply: CapacityLimit;
     withdraw: CapacityLimit;
@@ -16,6 +19,7 @@ export interface MaxPositionCapacities {
     supplyCollateral: CapacityLimit;
     withdrawCollateral: CapacityLimit | undefined;
 }
+/** Plain input shape for a Morpho Blue market. */
 export interface IMarket {
     params: IMarketParams;
     totalSupplyAssets: bigint;

package/lib/esm/market/MarketParams.d.ts

@@ -1,5 +1,6 @@
 import { type Hex } from "viem";
 import type { Address, BigIntish, MarketId } from "../types.js";
+/** Plain input shape for Morpho Blue market params. */
 export interface IMarketParams {
     loanToken: Address;
     collateralToken: Address;
@@ -7,7 +8,9 @@ export interface IMarketParams {
     irm: Address;
     lltv: BigIntish;
 }
+/** Minimal market params shape accepted by SDK constructors and helpers. */
 export type InputMarketParams = Pick<MarketParams, "loanToken" | "collateralToken" | "oracle" | "irm" | "lltv">;
+/** ABI tuple definition for Morpho Blue market params. */
 export declare const marketParamsAbi: {
     readonly type: "tuple";
     readonly components: readonly [{

package/lib/esm/market/MarketParams.js

@@ -2,6 +2,7 @@ import { ZERO_ADDRESS } from "@morpho-org/morpho-ts";
 import { decodeAbiParameters } from "viem";
 import { InvalidMarketParamsError, UnknownMarketParamsError, } from "../errors.js";
 import { MarketUtils } from "./MarketUtils.js";
+/** ABI tuple definition for Morpho Blue market params. */
 export const marketParamsAbi = {
     type: "tuple",
     components: [