@morpho-org/blue-sdk 6.0.1 → 6.1.0

package/lib/esm/vault/VaultUtils.js

@@ -1,11 +1,43 @@
 import { MathLib } from "../math/index.js";
+/** ERC-4626 virtual share and asset conversion helpers for MetaMorpho vaults. */
 export var VaultUtils;
 (function (VaultUtils) {
+    /** Virtual assets added to ERC-4626 total assets in conversion formulas. */
     VaultUtils.VIRTUAL_ASSETS = 1n;
+    /**
+     * Returns the decimals offset between 18-decimal vault shares and an asset.
+     *
+     * @param decimals - The asset decimals.
+     * @returns The non-negative decimals offset.
+     * @example
+     * ```ts
+     * import { VaultUtils } from "@morpho-org/blue-sdk";
+     *
+     * const offset = VaultUtils.decimalsOffset(6n);
+     * // offset === 12n
+     * ```
+     */
     function decimalsOffset(decimals) {
         return MathLib.zeroFloorSub(18n, decimals);
     }
     VaultUtils.decimalsOffset = decimalsOffset;
+    /**
+     * Converts vault shares to underlying assets.
+     *
+     * @param shares - The amount of vault shares.
+     * @param vault.totalAssets - The vault's total assets.
+     * @param vault.totalSupply - The vault's total share supply.
+     * @param vault.decimalsOffset - The vault's decimals offset.
+     * @param rounding - Optional rounding direction. Defaults to `"Down"`.
+     * @returns The equivalent amount of underlying assets.
+     * @example
+     * ```ts
+     * import { VaultUtils } from "@morpho-org/blue-sdk";
+     *
+     * const assets = VaultUtils.toAssets(100n, { totalAssets: 1_000n, totalSupply: 100n, decimalsOffset: 0n });
+     * // assets satisfies bigint
+     * ```
+     */
     // biome-ignore lint/complexity/useMaxParams: TODO refactor to ≤2 params
     function toAssets(shares, { totalAssets, totalSupply, 
     // biome-ignore lint/nursery/noShadow: TODO rename to avoid shadowing
@@ -13,6 +45,23 @@ export var VaultUtils;
         return MathLib.mulDiv(shares, BigInt(totalAssets) + VaultUtils.VIRTUAL_ASSETS, BigInt(totalSupply) + 10n ** BigInt(decimalsOffset), rounding);
     }
     VaultUtils.toAssets = toAssets;
+    /**
+     * Converts underlying assets to vault shares.
+     *
+     * @param assets - The amount of underlying assets.
+     * @param vault.totalAssets - The vault's total assets.
+     * @param vault.totalSupply - The vault's total share supply.
+     * @param vault.decimalsOffset - The vault's decimals offset.
+     * @param rounding - Optional rounding direction. Defaults to `"Up"`.
+     * @returns The equivalent amount of vault shares.
+     * @example
+     * ```ts
+     * import { VaultUtils } from "@morpho-org/blue-sdk";
+     *
+     * const shares = VaultUtils.toShares(100n, { totalAssets: 1_000n, totalSupply: 100n, decimalsOffset: 0n });
+     * // shares satisfies bigint
+     * ```
+     */
     // biome-ignore lint/complexity/useMaxParams: TODO refactor to ≤2 params
     function toShares(assets, { totalAssets, totalSupply, 
     // biome-ignore lint/nursery/noShadow: TODO rename to avoid shadowing

package/lib/esm/vault/v2/VaultV2.d.ts

@@ -4,12 +4,14 @@ import { type IToken, WrappedToken } from "../../token/index.js";
 import type { BigIntish } from "../../types.js";
 import { type CapacityLimit } from "../../utils.js";
 import type { IAccrualVaultV2Adapter } from "./VaultV2Adapter.js";
+/** Plain input shape for one Vault V2 liquidity allocation. */
 export interface IVaultV2Allocation {
     id: Hash;
     absoluteCap: bigint;
     relativeCap: bigint;
     allocation: bigint;
 }
+/** Plain input shape for a Morpho Vault V2. */
 export interface IVaultV2 extends IToken {
     asset: Address;
     /**
@@ -32,6 +34,7 @@ export interface IVaultV2 extends IToken {
     performanceFeeRecipient: Address;
     managementFeeRecipient: Address;
 }
+/** Represents a Morpho Vault V2 and its fee, adapter, and accounting state. */
 export declare class VaultV2 extends WrappedToken implements IVaultV2 {
     readonly asset: Address;
     _totalAssets: bigint;
@@ -53,8 +56,10 @@ export declare class VaultV2 extends WrappedToken implements IVaultV2 {
     protected _wrap(amount: BigIntish, rounding: RoundingDirection): bigint;
     protected _unwrap(amount: BigIntish, rounding: RoundingDirection): bigint;
 }
+/** Plain input shape for a Morpho Vault V2 paired with accrued adapter state. */
 export interface IAccrualVaultV2 extends Omit<IVaultV2, "adapters"> {
 }
+/** Represents a Morpho Vault V2 with accrued adapter and liquidity state. */
 export declare class AccrualVaultV2 extends VaultV2 implements IAccrualVaultV2 {
     accrualLiquidityAdapter: IAccrualVaultV2Adapter | undefined;
     accrualAdapters: IAccrualVaultV2Adapter[];

package/lib/esm/vault/v2/VaultV2.js

@@ -3,6 +3,7 @@ import { VaultV2Errors } from "../../errors.js";
 import { MathLib } from "../../math/index.js";
 import { WrappedToken } from "../../token/index.js";
 import { CapacityLimitReason } from "../../utils.js";
+/** Represents a Morpho Vault V2 and its fee, adapter, and accounting state. */
 export class VaultV2 extends WrappedToken {
     asset;
     _totalAssets;
@@ -49,6 +50,7 @@ export class VaultV2 extends WrappedToken {
         return MathLib.mulDiv(amount, this._totalAssets + 1n, this.totalSupply + this.virtualShares, rounding);
     }
 }
+/** Represents a Morpho Vault V2 with accrued adapter and liquidity state. */
 export class AccrualVaultV2 extends VaultV2 {
     accrualLiquidityAdapter;
     accrualAdapters;

package/lib/esm/vault/v2/VaultV2Adapter.d.ts

@@ -1,6 +1,7 @@
 import type { Address, Hash, Hex } from "viem";
 import type { BigIntish } from "../../types.js";
 import type { CapacityLimit } from "../../utils.js";
+/** Plain input shape for a Morpho Vault V2 adapter. */
 export interface IVaultV2Adapter {
     type: string;
     address: Address;
@@ -8,6 +9,7 @@ export interface IVaultV2Adapter {
     adapterId: Hash;
     skimRecipient: Address;
 }
+/** Base class for Morpho Vault V2 adapters. */
 export declare abstract class VaultV2Adapter implements IVaultV2Adapter {
     readonly type: string;
     readonly address: Address;
@@ -16,6 +18,7 @@ export declare abstract class VaultV2Adapter implements IVaultV2Adapter {
     skimRecipient: Address;
     constructor({ type, address, parentVault, adapterId, skimRecipient, }: IVaultV2Adapter);
 }
+/** Adapter interface with accrued asset and capacity methods. */
 export interface IAccrualVaultV2Adapter extends IVaultV2Adapter {
     realAssets(timestamp: BigIntish): bigint;
     /**

package/lib/esm/vault/v2/VaultV2Adapter.js

@@ -1,3 +1,4 @@
+/** Base class for Morpho Vault V2 adapters. */
 export class VaultV2Adapter {
     type;
     address;

package/lib/esm/vault/v2/VaultV2MorphoMarketV1Adapter.d.ts

@@ -5,10 +5,12 @@ import type { BigIntish } from "../../types.js";
 import { CapacityLimitReason } from "../../utils.js";
 import type { IAccrualVaultV2Adapter, IVaultV2Adapter } from "./VaultV2Adapter.js";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Plain input shape for a Vault V2 adapter investing in Morpho Blue markets. */
 export interface IVaultV2MorphoMarketV1Adapter extends Omit<IVaultV2Adapter, "adapterId" | "type"> {
     type?: "VaultV2MorphoMarketV1Adapter";
     marketParamsList: IMarketParams[];
 }
+/** Represents a Vault V2 adapter investing in Morpho Blue markets. */
 export declare class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter implements IVaultV2MorphoMarketV1Adapter {
     readonly type: "VaultV2MorphoMarketV1Adapter";
     static adapterId(address: Address): `0x${string}`;
@@ -18,8 +20,10 @@ export declare class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter impleme
     constructor({ marketParamsList, ...vaultV2Adapter }: IVaultV2MorphoMarketV1Adapter);
     ids(params: MarketParams): `0x${string}`[];
 }
+/** Plain input shape for an accrued Morpho Blue market Vault V2 adapter. */
 export interface IAccrualVaultV2MorphoMarketV1Adapter extends IVaultV2MorphoMarketV1Adapter {
 }
+/** Represents an accrued Morpho Blue market Vault V2 adapter. */
 export declare class AccrualVaultV2MorphoMarketV1Adapter extends VaultV2MorphoMarketV1Adapter implements IAccrualVaultV2MorphoMarketV1Adapter, IAccrualVaultV2Adapter {
     positions: AccrualPosition[];
     constructor(adapter: IAccrualVaultV2MorphoMarketV1Adapter, positions: AccrualPosition[]);

package/lib/esm/vault/v2/VaultV2MorphoMarketV1Adapter.js

@@ -2,6 +2,7 @@ import { encodeAbiParameters, keccak256 } from "viem";
 import { MarketParams, marketParamsAbi, } from "../../market/index.js";
 import { CapacityLimitReason } from "../../utils.js";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Represents a Vault V2 adapter investing in Morpho Blue markets. */
 export class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter {
     static adapterId(address) {
         return keccak256(encodeAbiParameters([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -29,6 +30,7 @@ export class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter {
         ];
     }
 }
+/** Represents an accrued Morpho Blue market Vault V2 adapter. */
 export class AccrualVaultV2MorphoMarketV1Adapter extends VaultV2MorphoMarketV1Adapter {
     positions;
     constructor(adapter, positions) {

package/lib/esm/vault/v2/VaultV2MorphoMarketV1AdapterV2.d.ts

@@ -4,12 +4,14 @@ import type { BigIntish, MarketId } from "../../types.js";
 import { CapacityLimitReason } from "../../utils.js";
 import type { IAccrualVaultV2Adapter, IVaultV2Adapter } from "./VaultV2Adapter.js";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Plain input shape for a Vault V2 Morpho Blue market adapter using market ids. */
 export interface IVaultV2MorphoMarketV1AdapterV2 extends Omit<IVaultV2Adapter, "adapterId" | "type"> {
     type?: "VaultV2MorphoMarketV1AdapterV2";
     marketIds: MarketId[];
     adaptiveCurveIrm: Address;
     supplyShares: Record<MarketId, bigint>;
 }
+/** Represents a Vault V2 Morpho Blue market adapter using market ids. */
 export declare class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter implements IVaultV2MorphoMarketV1AdapterV2 {
     readonly type: "VaultV2MorphoMarketV1AdapterV2";
     static adapterId(address: Address): `0x${string}`;
@@ -21,8 +23,10 @@ export declare class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter imple
     constructor({ marketIds, adaptiveCurveIrm, supplyShares, ...vaultV2Adapter }: IVaultV2MorphoMarketV1AdapterV2);
     ids(params: MarketParams): `0x${string}`[];
 }
+/** Plain input shape for an accrued Vault V2 Morpho Blue market-id adapter. */
 export interface IAccrualVaultV2MorphoMarketV1AdapterV2 extends IVaultV2MorphoMarketV1AdapterV2 {
 }
+/** Represents an accrued Vault V2 Morpho Blue market-id adapter. */
 export declare class AccrualVaultV2MorphoMarketV1AdapterV2 extends VaultV2MorphoMarketV1AdapterV2 implements IAccrualVaultV2MorphoMarketV1AdapterV2, IAccrualVaultV2Adapter {
     markets: Market[];
     constructor(adapter: IAccrualVaultV2MorphoMarketV1AdapterV2, markets: Market[]);

package/lib/esm/vault/v2/VaultV2MorphoMarketV1AdapterV2.js

@@ -2,6 +2,7 @@ import { encodeAbiParameters, keccak256 } from "viem";
 import { MarketParams, marketParamsAbi, } from "../../market/index.js";
 import { CapacityLimitReason } from "../../utils.js";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Represents a Vault V2 Morpho Blue market adapter using market ids. */
 export class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter {
     static adapterId(address) {
         return keccak256(encodeAbiParameters([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -33,6 +34,7 @@ export class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter {
         ];
     }
 }
+/** Represents an accrued Vault V2 Morpho Blue market-id adapter. */
 export class AccrualVaultV2MorphoMarketV1AdapterV2 extends VaultV2MorphoMarketV1AdapterV2 {
     markets;
     constructor(adapter, markets) {

package/lib/esm/vault/v2/VaultV2MorphoVaultV1Adapter.d.ts

@@ -1,5 +1,6 @@
 import { type Address, type Hex } from "viem";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Plain input shape for a Vault V2 adapter investing in a MetaMorpho V1 vault. */
 export interface IVaultV2MorphoVaultV1Adapter extends Omit<IVaultV2Adapter, "adapterId" | "type"> {
     type?: "VaultV2MorphoVaultV1Adapter";
     morphoVaultV1: Address;
@@ -7,6 +8,7 @@ export interface IVaultV2MorphoVaultV1Adapter extends Omit<IVaultV2Adapter, "ada
 import type { BigIntish } from "../../types.js";
 import type { AccrualVault } from "../Vault.js";
 import type { IAccrualVaultV2Adapter, IVaultV2Adapter } from "./VaultV2Adapter.js";
+/** Represents a Vault V2 adapter investing in a MetaMorpho V1 vault. */
 export declare class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter implements IVaultV2MorphoVaultV1Adapter {
     readonly type: "VaultV2MorphoVaultV1Adapter";
     static adapterId(address: Address): `0x${string}`;
@@ -14,8 +16,10 @@ export declare class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter implemen
     constructor({ morphoVaultV1, ...vaultV2Adapter }: IVaultV2MorphoVaultV1Adapter);
     ids(): `0x${string}`[];
 }
+/** Plain input shape for an accrued Vault V2 MetaMorpho V1 adapter. */
 export interface IAccrualVaultV2MorphoVaultV1Adapter extends IVaultV2MorphoVaultV1Adapter {
 }
+/** Represents an accrued Vault V2 MetaMorpho V1 adapter. */
 export declare class AccrualVaultV2MorphoVaultV1Adapter extends VaultV2MorphoVaultV1Adapter implements IAccrualVaultV2MorphoVaultV1Adapter, IAccrualVaultV2Adapter {
     accrualVaultV1: AccrualVault;
     shares: bigint;

package/lib/esm/vault/v2/VaultV2MorphoVaultV1Adapter.js

@@ -1,5 +1,6 @@
 import { encodeAbiParameters, keccak256 } from "viem";
 import { VaultV2Adapter } from "./VaultV2Adapter.js";
+/** Represents a Vault V2 adapter investing in a MetaMorpho V1 vault. */
 export class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter {
     static adapterId(address) {
         return keccak256(encodeAbiParameters([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -17,6 +18,7 @@ export class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter {
         return [this.adapterId];
     }
 }
+/** Represents an accrued Vault V2 MetaMorpho V1 adapter. */
 export class AccrualVaultV2MorphoVaultV1Adapter extends VaultV2MorphoVaultV1Adapter {
     accrualVaultV1;
     shares;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/blue-sdk",
   "description": "Framework-agnostic package that defines Morpho-related entity classes (such as `Market`, `Token`, `Vault`).",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"
@@ -36,7 +36,7 @@
     "typescript": "^6.0.3",
     "viem": "^2.50.4",
     "vitest": "^4.1.7",
-    "@morpho-org/morpho-ts": "^2.5.3",
+    "@morpho-org/morpho-ts": "^2.6.0",
     "@morpho-org/test": "^2.8.1"
   },
   "scripts": {