@morpho-org/blue-sdk 6.0.1 → 6.1.0

package/lib/cjs/errors.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownOfFactory = exports.UnknownFactory = exports.VaultV2Errors = exports.BlueErrors = exports.UnsupportedVaultV2AdapterError = exports.UnsupportedPreLiquidationParamsError = exports.UnsupportedChainIdError = exports.UnknownVaultConfigError = exports.UnknownMarketParamsError = exports.UnknownTokenPriceError = exports.UnknownTokenError = exports.UnknownDataError = exports.InvalidMarketParamsError = void 0;
 exports._try = _try;
 const viem_1 = require("viem");
+/** Error thrown when bytes cannot be decoded into valid Morpho Blue market params. */
 class InvalidMarketParamsError extends Error {
     data;
     constructor(data) {
@@ -11,9 +12,11 @@ class InvalidMarketParamsError extends Error {
     }
 }
 exports.InvalidMarketParamsError = InvalidMarketParamsError;
+/** Base error for optional data lookups that were not available. */
 class UnknownDataError extends Error {
 }
 exports.UnknownDataError = UnknownDataError;
+/** Error thrown when token metadata is unavailable for an address. */
 class UnknownTokenError extends UnknownDataError {
     address;
     constructor(address) {
@@ -22,6 +25,7 @@ class UnknownTokenError extends UnknownDataError {
     }
 }
 exports.UnknownTokenError = UnknownTokenError;
+/** Error thrown when a token price is unavailable for an address. */
 class UnknownTokenPriceError extends UnknownDataError {
     address;
     constructor(address) {
@@ -30,6 +34,7 @@ class UnknownTokenPriceError extends UnknownDataError {
     }
 }
 exports.UnknownTokenPriceError = UnknownTokenPriceError;
+/** Error thrown when market params are unavailable for a market id. */
 class UnknownMarketParamsError extends UnknownDataError {
     marketId;
     constructor(marketId) {
@@ -38,6 +43,7 @@ class UnknownMarketParamsError extends UnknownDataError {
     }
 }
 exports.UnknownMarketParamsError = UnknownMarketParamsError;
+/** Error thrown when vault config is unavailable for a vault address. */
 class UnknownVaultConfigError extends UnknownDataError {
     vault;
     constructor(vault) {
@@ -46,6 +52,7 @@ class UnknownVaultConfigError extends UnknownDataError {
     }
 }
 exports.UnknownVaultConfigError = UnknownVaultConfigError;
+/** Error thrown when a chain id has no configured SDK registry entry. */
 class UnsupportedChainIdError extends Error {
     chainId;
     constructor(chainId) {
@@ -54,6 +61,7 @@ class UnsupportedChainIdError extends Error {
     }
 }
 exports.UnsupportedChainIdError = UnsupportedChainIdError;
+/** Error thrown when no default pre-liquidation params exist for an LLTV. */
 class UnsupportedPreLiquidationParamsError extends Error {
     lltv;
     constructor(lltv) {
@@ -62,6 +70,7 @@ class UnsupportedPreLiquidationParamsError extends Error {
     }
 }
 exports.UnsupportedPreLiquidationParamsError = UnsupportedPreLiquidationParamsError;
+/** Error thrown when a Vault V2 adapter address is not supported by the SDK. */
 class UnsupportedVaultV2AdapterError extends Error {
     address;
     constructor(address) {
@@ -70,8 +79,10 @@ class UnsupportedVaultV2AdapterError extends Error {
     }
 }
 exports.UnsupportedVaultV2AdapterError = UnsupportedVaultV2AdapterError;
+/** Morpho Blue protocol simulation errors. */
 var BlueErrors;
 (function (BlueErrors) {
+    /** Error thrown when a value that must be set once is already set. */
     class AlreadySet extends Error {
         name;
         value;
@@ -82,6 +93,7 @@ var BlueErrors;
         }
     }
     BlueErrors.AlreadySet = AlreadySet;
+    /** Error thrown when market interest accrual is requested before `lastUpdate`. */
     class InvalidInterestAccrual extends Error {
         marketId;
         timestamp;
@@ -95,6 +107,7 @@ var BlueErrors;
         }
     }
     BlueErrors.InvalidInterestAccrual = InvalidInterestAccrual;
+    /** Error thrown when asset and share inputs describe inconsistent values. */
     class InconsistentInput extends Error {
         assets;
         shares;
@@ -105,6 +118,7 @@ var BlueErrors;
         }
     }
     BlueErrors.InconsistentInput = InconsistentInput;
+    /** Error thrown when a market has insufficient liquidity for an operation. */
     class InsufficientLiquidity extends Error {
         marketId;
         constructor(marketId) {
@@ -113,6 +127,7 @@ var BlueErrors;
         }
     }
     BlueErrors.InsufficientLiquidity = InsufficientLiquidity;
+    /** Error thrown when a market oracle price is unavailable. */
     class UnknownOraclePrice extends Error {
         marketId;
         constructor(marketId) {
@@ -121,6 +136,7 @@ var BlueErrors;
         }
     }
     BlueErrors.UnknownOraclePrice = UnknownOraclePrice;
+    /** Error thrown when a user position is too small for an operation. */
     class InsufficientPosition extends Error {
         user;
         marketId;
@@ -131,6 +147,7 @@ var BlueErrors;
         }
     }
     BlueErrors.InsufficientPosition = InsufficientPosition;
+    /** Error thrown when a user position lacks required collateral. */
     class InsufficientCollateral extends Error {
         user;
         marketId;
@@ -141,6 +158,7 @@ var BlueErrors;
         }
     }
     BlueErrors.InsufficientCollateral = InsufficientCollateral;
+    /** Error thrown when a signature deadline has expired. */
     class ExpiredSignature extends Error {
         deadline;
         constructor(deadline) {
@@ -150,8 +168,10 @@ var BlueErrors;
     }
     BlueErrors.ExpiredSignature = ExpiredSignature;
 })(BlueErrors || (exports.BlueErrors = BlueErrors = {}));
+/** Morpho Vault V2 simulation errors. */
 var VaultV2Errors;
 (function (VaultV2Errors) {
+    /** Error thrown when vault interest accrual is requested before `lastUpdate`. */
     class InvalidInterestAccrual extends Error {
         vault;
         timestamp;
@@ -165,6 +185,7 @@ 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) {
@@ -174,12 +195,14 @@ var VaultV2Errors;
     }
     VaultV2Errors.UnsupportedLiquidityAdapter = UnsupportedLiquidityAdapter;
 })(VaultV2Errors || (exports.VaultV2Errors = VaultV2Errors = {}));
+/** Error thrown when a factory address is unavailable. */
 class UnknownFactory extends Error {
     constructor() {
         super(`unknown factory`);
     }
 }
 exports.UnknownFactory = UnknownFactory;
+/** Error thrown when an address is not deployed by the expected factory. */
 class UnknownOfFactory extends Error {
     factory;
     address;
@@ -190,6 +213,11 @@ class UnknownOfFactory extends Error {
     }
 }
 exports.UnknownOfFactory = UnknownOfFactory;
+/**
+ * Runs an accessor and returns `undefined` for expected lookup errors.
+ *
+ * @internal
+ */
 function _try(accessor, ...errorClasses) {
     const maybeCatchError = (error) => {
         if (errorClasses.length === 0 ||

package/lib/cjs/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/cjs/holding/AssetBalances.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetBalances = void 0;
+/** Aggregates balances across a requested token and related peripheral tokens. */
 class AssetBalances {
     /**
      * The total balance of all types of related tokens.

package/lib/cjs/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/cjs/holding/Holding.js

@@ -2,11 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Holding = exports.ERC20_ALLOWANCE_RECIPIENTS = void 0;
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
+/** Address registry labels that may receive ERC-20 allowances from a user. */
 exports.ERC20_ALLOWANCE_RECIPIENTS = [
     "morpho",
     "permit2",
     "bundler3.generalAdapter1",
 ];
+/** Represents a user's balance and allowance state for one token. */
 class Holding {
     /**
      * The user of this holding.

package/lib/cjs/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/cjs/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/cjs/market/MarketParams.js

@@ -5,6 +5,7 @@ const morpho_ts_1 = require("@morpho-org/morpho-ts");
 const viem_1 = require("viem");
 const errors_js_1 = require("../errors.js");
 const MarketUtils_js_1 = require("./MarketUtils.js");
+/** ABI tuple definition for Morpho Blue market params. */
 exports.marketParamsAbi = {
     type: "tuple",
     components: [