@morpho-org/blue-sdk 6.0.1 → 6.2.0

package/lib/cjs/vault/VaultUtils.d.ts

@@ -1,13 +1,62 @@
 import { type RoundingDirection } from "../math/index.js";
 import type { BigIntish } from "../types.js";
+/** ERC-4626 virtual share and asset conversion helpers for MetaMorpho vaults. */
 export declare namespace VaultUtils {
+    /** Virtual assets added to ERC-4626 total assets in conversion formulas. */
     const 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: BigIntish): bigint;
+    /**
+     * 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
+     * ```
+     */
     function toAssets(shares: BigIntish, { totalAssets, totalSupply, decimalsOffset, }: {
         totalAssets: BigIntish;
         totalSupply: BigIntish;
         decimalsOffset: BigIntish;
     }, rounding?: RoundingDirection): bigint;
+    /**
+     * 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
+     * ```
+     */
     function toShares(assets: BigIntish, { totalAssets, totalSupply, decimalsOffset, }: {
         totalAssets: BigIntish;
         totalSupply: BigIntish;

package/lib/cjs/vault/VaultUtils.js

@@ -2,23 +2,72 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VaultUtils = void 0;
 const index_js_1 = require("../math/index.js");
+/** ERC-4626 virtual share and asset conversion helpers for MetaMorpho vaults. */
 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 index_js_1.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
+    // biome-ignore lint/suspicious/noShadow: TODO rename to avoid shadowing
     decimalsOffset, }, rounding = "Down") {
         return index_js_1.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
+    // biome-ignore lint/suspicious/noShadow: TODO rename to avoid shadowing
     decimalsOffset, }, rounding = "Up") {
         return index_js_1.MathLib.mulDiv(assets, BigInt(totalSupply) + 10n ** BigInt(decimalsOffset), BigInt(totalAssets) + VaultUtils.VIRTUAL_ASSETS, rounding);
     }

package/lib/cjs/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/cjs/vault/v2/VaultV2.js

@@ -6,6 +6,7 @@ const errors_js_1 = require("../../errors.js");
 const index_js_1 = require("../../math/index.js");
 const index_js_2 = require("../../token/index.js");
 const utils_js_1 = require("../../utils.js");
+/** Represents a Morpho Vault V2 and its fee, adapter, and accounting state. */
 class VaultV2 extends index_js_2.WrappedToken {
     asset;
     _totalAssets;
@@ -53,6 +54,7 @@ class VaultV2 extends index_js_2.WrappedToken {
     }
 }
 exports.VaultV2 = VaultV2;
+/** Represents a Morpho Vault V2 with accrued adapter and liquidity state. */
 class AccrualVaultV2 extends VaultV2 {
     accrualLiquidityAdapter;
     accrualAdapters;

package/lib/cjs/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/cjs/vault/v2/VaultV2Adapter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VaultV2Adapter = void 0;
+/** Base class for Morpho Vault V2 adapters. */
 class VaultV2Adapter {
     type;
     address;

package/lib/cjs/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/cjs/vault/v2/VaultV2MorphoMarketV1Adapter.js

@@ -5,6 +5,7 @@ const viem_1 = require("viem");
 const index_js_1 = require("../../market/index.js");
 const utils_js_1 = require("../../utils.js");
 const VaultV2Adapter_js_1 = require("./VaultV2Adapter.js");
+/** Represents a Vault V2 adapter investing in Morpho Blue markets. */
 class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter_js_1.VaultV2Adapter {
     static adapterId(address) {
         return (0, viem_1.keccak256)((0, viem_1.encodeAbiParameters)([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -33,6 +34,7 @@ class VaultV2MorphoMarketV1Adapter extends VaultV2Adapter_js_1.VaultV2Adapter {
     }
 }
 exports.VaultV2MorphoMarketV1Adapter = VaultV2MorphoMarketV1Adapter;
+/** Represents an accrued Morpho Blue market Vault V2 adapter. */
 class AccrualVaultV2MorphoMarketV1Adapter extends VaultV2MorphoMarketV1Adapter {
     positions;
     constructor(adapter, positions) {
@@ -51,7 +53,7 @@ class AccrualVaultV2MorphoMarketV1Adapter extends VaultV2MorphoMarketV1Adapter {
     maxWithdraw(data) {
         const marketId = index_js_1.MarketParams.fromHex(data).id;
         const position = this.positions.find(
-        // biome-ignore lint/nursery/noShadow: TODO rename to avoid shadowing
+        // biome-ignore lint/suspicious/noShadow: TODO rename to avoid shadowing
         (position) => position.marketId === marketId);
         return (position?.market?.getWithdrawCapacityLimit(position) ?? {
             value: 0n,

package/lib/cjs/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/cjs/vault/v2/VaultV2MorphoMarketV1AdapterV2.js

@@ -5,6 +5,7 @@ const viem_1 = require("viem");
 const index_js_1 = require("../../market/index.js");
 const utils_js_1 = require("../../utils.js");
 const VaultV2Adapter_js_1 = require("./VaultV2Adapter.js");
+/** Represents a Vault V2 Morpho Blue market adapter using market ids. */
 class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter_js_1.VaultV2Adapter {
     static adapterId(address) {
         return (0, viem_1.keccak256)((0, viem_1.encodeAbiParameters)([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -37,6 +38,7 @@ class VaultV2MorphoMarketV1AdapterV2 extends VaultV2Adapter_js_1.VaultV2Adapter
     }
 }
 exports.VaultV2MorphoMarketV1AdapterV2 = VaultV2MorphoMarketV1AdapterV2;
+/** Represents an accrued Vault V2 Morpho Blue market-id adapter. */
 class AccrualVaultV2MorphoMarketV1AdapterV2 extends VaultV2MorphoMarketV1AdapterV2 {
     markets;
     constructor(adapter, markets) {
@@ -57,7 +59,7 @@ class AccrualVaultV2MorphoMarketV1AdapterV2 extends VaultV2MorphoMarketV1Adapter
     }
     maxWithdraw(data) {
         const marketId = index_js_1.MarketParams.fromHex(data).id;
-        // biome-ignore lint/nursery/noShadow: TODO rename to avoid shadowing
+        // biome-ignore lint/suspicious/noShadow: TODO rename to avoid shadowing
         const market = this.markets.find((market) => market.id === marketId);
         return (market?.getWithdrawCapacityLimit({
             supplyShares: this.supplyShares[marketId] ?? 0n,

package/lib/cjs/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/cjs/vault/v2/VaultV2MorphoVaultV1Adapter.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccrualVaultV2MorphoVaultV1Adapter = exports.VaultV2MorphoVaultV1Adapter = void 0;
 const viem_1 = require("viem");
 const VaultV2Adapter_js_1 = require("./VaultV2Adapter.js");
+/** Represents a Vault V2 adapter investing in a MetaMorpho V1 vault. */
 class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter_js_1.VaultV2Adapter {
     static adapterId(address) {
         return (0, viem_1.keccak256)((0, viem_1.encodeAbiParameters)([{ type: "string" }, { type: "address" }], ["this", address]));
@@ -21,6 +22,7 @@ class VaultV2MorphoVaultV1Adapter extends VaultV2Adapter_js_1.VaultV2Adapter {
     }
 }
 exports.VaultV2MorphoVaultV1Adapter = VaultV2MorphoVaultV1Adapter;
+/** Represents an accrued Vault V2 MetaMorpho V1 adapter. */
 class AccrualVaultV2MorphoVaultV1Adapter extends VaultV2MorphoVaultV1Adapter {
     accrualVaultV1;
     shares;

package/lib/esm/addresses.d.ts

@@ -6,6 +6,7 @@ import type { Address } from "./types.js";
  * NB: data might differ from expected onchain native token data
  */
 export declare const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+/** Registry entry for protocol, adapter, factory, and token addresses on one chain. */
 export interface ChainAddresses {
     morpho: Address;
     permit2?: Address;
@@ -725,7 +726,52 @@ declare const _addressesRegistry: {
         readonly preLiquidationFactory: "0xe8eCe452F04117e5Fe1Ea4403097215443225440";
         readonly wNative: "0x19Aac5f612f524B754CA7e7c41cbFa2E981A4432";
     };
+    readonly 5042: {
+        readonly morpho: "0x34CD04070dD72b14E241112F6d83812Df5Af7fCD";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0x855dbe13C409Df75CAF6a985Cf6993a4D0319Feb";
+            readonly generalAdapter1: "0x0AF5BE7BD7B615e94e1d9275414482D028952466";
+        };
+        readonly adaptiveCurveIrm: "0xF02615d094Fc02fC031C35fe705e175aA4653f20";
+        readonly vaultV2Factory: "0x3b0eefaBfa22ec7CF2c73877ac16e78D76749f12";
+        readonly morphoMarketV1AdapterV2Factory: "0x6C2FF5114E45b50bc7195c2F1f87C98cbdad62Cc";
+        readonly registryList: "0xdEBC92370Cd74d55DA144116138681dbbb528765";
+        readonly chainlinkOracleFactory: "0xbFc8D6167a02889D5EB08a023d9aB712B44f7dE8";
+        readonly preLiquidationFactory: "0x8edf6Ac769a7E7D81d571aC0FB8733aD724f6922";
+    };
+    readonly 2818: {
+        readonly morpho: "0xAd10d07901Dc3195c3cb5e78E061F4EA8D9B4905";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0xDB83A44Bf8f53966f7A4F7dCE7F8CdAaBCf83628";
+            readonly generalAdapter1: "0xcaeec65c85Fe964c8Bd814cb8E4CaF8B06bde776";
+        };
+        readonly adaptiveCurveIrm: "0xfB69467De332E03FF502B85bB2249d2f721F3319";
+        readonly vaultV2Factory: "0x7D8BF8B276f967F7539c9e91E1a85a33fefE612B";
+        readonly morphoMarketV1AdapterV2Factory: "0xa01D7c41cf419405d4DF2e5750d26438DCAC28a6";
+        readonly registryList: "0x553c013d1978CF82EF6b316f5c247B73718ba481";
+        readonly chainlinkOracleFactory: "0xE91032cE5B8D86bA4Be146c186984F49Af37fbf1";
+        readonly preLiquidationFactory: "0x41581344ba49B07EFA758a0F2a199b90f05Cc866";
+        readonly wNative: "0x5300000000000000000000000000000000000011";
+    };
+    readonly 4326: {
+        readonly morpho: "0x18120312A7cf44DcfEc6dCe5632a431579ED9100";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0xf53D4c8f0f83F697CD6bB303567400cCf411aA63";
+            readonly generalAdapter1: "0x74d3cbc721613C8461df92658d0a20dF275Ca31b";
+        };
+        readonly adaptiveCurveIrm: "0x56875764185548B0ca72A1877b3aE15E44e8A323";
+        readonly vaultV2Factory: "0xf133FA5A78C398B31Cc4a180E6Ae84111D6DCF5B";
+        readonly morphoMarketV1AdapterV2Factory: "0x00a58b7a9B3E86CB21f5F11f29F4A12346457012";
+        readonly registryList: "0x3aE18af9717C734820137726967bef4fBc5Ec95c";
+        readonly chainlinkOracleFactory: "0x02522D475E7064E1d1E966e3197db050b19b2FC2";
+        readonly preLiquidationFactory: "0xF6035B231028E61cd2283651f22ecA45f8e3ADc8";
+        readonly wNative: "0x4200000000000000000000000000000000000006";
+    };
 };
+/** Deployment block registry with the same shape as `ChainAddresses`. */
 export type ChainDeployments<Addresses = ChainAddresses> = {
     [key in keyof Addresses]: Address extends Addresses[key] ? bigint : ChainDeployments<Addresses[key]>;
 };
@@ -1324,9 +1370,82 @@ declare const _deployments: {
         readonly preLiquidationFactory: 213462907n;
         readonly wNative: 104802159n;
     };
+    readonly 5042: {
+        readonly morpho: 1208685n;
+        readonly permit2: 0n;
+        readonly bundler3: {
+            readonly bundler3: 1208685n;
+            readonly generalAdapter1: 1208685n;
+        };
+        readonly adaptiveCurveIrm: 1208685n;
+        readonly vaultV2Factory: 1208931n;
+        readonly morphoMarketV1AdapterV2Factory: 1208978n;
+        readonly registryList: 1208978n;
+        readonly chainlinkOracleFactory: 1208882n;
+        readonly preLiquidationFactory: 1208882n;
+    };
+    readonly 2818: {
+        readonly morpho: 23180020n;
+        readonly permit2: 5081244n;
+        readonly bundler3: {
+            readonly bundler3: 23180020n;
+            readonly generalAdapter1: 23180020n;
+        };
+        readonly adaptiveCurveIrm: 23180020n;
+        readonly vaultV2Factory: 23180183n;
+        readonly morphoMarketV1AdapterV2Factory: 23180228n;
+        readonly registryList: 23180228n;
+        readonly chainlinkOracleFactory: 23180111n;
+        readonly preLiquidationFactory: 23180111n;
+        readonly wNative: 0n;
+    };
+    readonly 4326: {
+        readonly morpho: 16408957n;
+        readonly permit2: 0n;
+        readonly bundler3: {
+            readonly bundler3: 16408957n;
+            readonly generalAdapter1: 16408957n;
+        };
+        readonly adaptiveCurveIrm: 16408957n;
+        readonly vaultV2Factory: 16409067n;
+        readonly morphoMarketV1AdapterV2Factory: 16409115n;
+        readonly registryList: 16409115n;
+        readonly chainlinkOracleFactory: 16409024n;
+        readonly preLiquidationFactory: 16409024n;
+        readonly wNative: 0n;
+    };
 };
+/** Dot-separated label for an address entry in the chain registry. */
 export type AddressLabel = DottedKeys<(typeof _addressesRegistry)[ChainId]>;
+/**
+ * Returns the protocol address registry for a chain.
+ *
+ * @param chainId - The EIP-155 chain id.
+ * @returns The configured protocol, adapter, factory, and token addresses for `chainId`.
+ * @throws {UnsupportedChainIdError} when no address registry exists for `chainId`.
+ * @example
+ * ```ts
+ * import { ChainId, getChainAddresses } from "@morpho-org/blue-sdk";
+ *
+ * const chainAddresses = getChainAddresses(ChainId.EthMainnet);
+ * // chainAddresses satisfies ChainAddresses
+ * ```
+ */
 export declare const getChainAddresses: (chainId: number) => ChainAddresses;
+/**
+ * Returns the unwrapped token mapped to a wrapped token on a chain.
+ *
+ * @param wrappedToken - The wrapped token address to resolve.
+ * @param chainId - The EIP-155 chain id.
+ * @returns The unwrapped token address, or `undefined` when no mapping is registered.
+ * @example
+ * ```ts
+ * import { ChainId, getUnwrappedToken, NATIVE_ADDRESS, addresses } from "@morpho-org/blue-sdk";
+ *
+ * const unwrapped = getUnwrappedToken(addresses[ChainId.EthMainnet].wNative!, ChainId.EthMainnet);
+ * // unwrapped === NATIVE_ADDRESS
+ * ```
+ */
 export declare function getUnwrappedToken(wrappedToken: Address, chainId: number): `0x${string}` | undefined;
 /**
  * The registry of all known ERC20Wrapper tokens.
@@ -1347,11 +1466,25 @@ export declare const permissionedBackedTokens: Record<number, Set<Address>>;
  * All permissioned Coinbase tokens are considered PermissionedERC20Wrapper and automatically added to the permissionedWrapperTokens registry.
  */
 export declare const permissionedCoinbaseTokens: Record<number, Set<Address>>;
+/**
+ * Returns the known Coinbase-attested wrapped tokens for a chain.
+ *
+ * @param chainId - The EIP-155 chain id.
+ * @returns A set of permissioned wrapped token addresses, or an empty set when none are registered.
+ * @example
+ * ```ts
+ * import { ChainId, getPermissionedCoinbaseTokens } from "@morpho-org/blue-sdk";
+ *
+ * const tokens = getPermissionedCoinbaseTokens(ChainId.BaseMainnet);
+ * // tokens satisfies Set<Address>
+ * ```
+ */
 export declare const getPermissionedCoinbaseTokens: (chainId: number) => Set<`0x${string}`>;
 /** /!\  These tokens can not be listed in `erc20WrapperTokens` because the following specs are different:
  * - calling `depositFor` supplies on blue instead of minting wrapped token to the user
  */
 export declare const convexWrapperTokens: Record<number, Set<Address>>;
+/** Deep-frozen registry of known chain addresses, keyed by chain id. */
 export declare let addressesRegistry: {
     readonly 1: {
         readonly morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb";
@@ -2028,8 +2161,54 @@ export declare let addressesRegistry: {
         readonly preLiquidationFactory: "0xe8eCe452F04117e5Fe1Ea4403097215443225440";
         readonly wNative: "0x19Aac5f612f524B754CA7e7c41cbFa2E981A4432";
     };
+    readonly 5042: {
+        readonly morpho: "0x34CD04070dD72b14E241112F6d83812Df5Af7fCD";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0x855dbe13C409Df75CAF6a985Cf6993a4D0319Feb";
+            readonly generalAdapter1: "0x0AF5BE7BD7B615e94e1d9275414482D028952466";
+        };
+        readonly adaptiveCurveIrm: "0xF02615d094Fc02fC031C35fe705e175aA4653f20";
+        readonly vaultV2Factory: "0x3b0eefaBfa22ec7CF2c73877ac16e78D76749f12";
+        readonly morphoMarketV1AdapterV2Factory: "0x6C2FF5114E45b50bc7195c2F1f87C98cbdad62Cc";
+        readonly registryList: "0xdEBC92370Cd74d55DA144116138681dbbb528765";
+        readonly chainlinkOracleFactory: "0xbFc8D6167a02889D5EB08a023d9aB712B44f7dE8";
+        readonly preLiquidationFactory: "0x8edf6Ac769a7E7D81d571aC0FB8733aD724f6922";
+    };
+    readonly 2818: {
+        readonly morpho: "0xAd10d07901Dc3195c3cb5e78E061F4EA8D9B4905";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0xDB83A44Bf8f53966f7A4F7dCE7F8CdAaBCf83628";
+            readonly generalAdapter1: "0xcaeec65c85Fe964c8Bd814cb8E4CaF8B06bde776";
+        };
+        readonly adaptiveCurveIrm: "0xfB69467De332E03FF502B85bB2249d2f721F3319";
+        readonly vaultV2Factory: "0x7D8BF8B276f967F7539c9e91E1a85a33fefE612B";
+        readonly morphoMarketV1AdapterV2Factory: "0xa01D7c41cf419405d4DF2e5750d26438DCAC28a6";
+        readonly registryList: "0x553c013d1978CF82EF6b316f5c247B73718ba481";
+        readonly chainlinkOracleFactory: "0xE91032cE5B8D86bA4Be146c186984F49Af37fbf1";
+        readonly preLiquidationFactory: "0x41581344ba49B07EFA758a0F2a199b90f05Cc866";
+        readonly wNative: "0x5300000000000000000000000000000000000011";
+    };
+    readonly 4326: {
+        readonly morpho: "0x18120312A7cf44DcfEc6dCe5632a431579ED9100";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler3: {
+            readonly bundler3: "0xf53D4c8f0f83F697CD6bB303567400cCf411aA63";
+            readonly generalAdapter1: "0x74d3cbc721613C8461df92658d0a20dF275Ca31b";
+        };
+        readonly adaptiveCurveIrm: "0x56875764185548B0ca72A1877b3aE15E44e8A323";
+        readonly vaultV2Factory: "0xf133FA5A78C398B31Cc4a180E6Ae84111D6DCF5B";
+        readonly morphoMarketV1AdapterV2Factory: "0x00a58b7a9B3E86CB21f5F11f29F4A12346457012";
+        readonly registryList: "0x3aE18af9717C734820137726967bef4fBc5Ec95c";
+        readonly chainlinkOracleFactory: "0x02522D475E7064E1d1E966e3197db050b19b2FC2";
+        readonly preLiquidationFactory: "0xF6035B231028E61cd2283651f22ecA45f8e3ADc8";
+        readonly wNative: "0x4200000000000000000000000000000000000006";
+    };
 };
+/** Address registry keyed by numeric chain id. */
 export declare let addresses: Record<number, ChainAddresses>;
+/** Deep-frozen registry of deployment blocks, keyed by chain id. */
 export declare let deployments: {
     readonly 1: {
         readonly morpho: 18883124n;
@@ -2625,7 +2804,52 @@ export declare let deployments: {
         readonly preLiquidationFactory: 213462907n;
         readonly wNative: 104802159n;
     };
+    readonly 5042: {
+        readonly morpho: 1208685n;
+        readonly permit2: 0n;
+        readonly bundler3: {
+            readonly bundler3: 1208685n;
+            readonly generalAdapter1: 1208685n;
+        };
+        readonly adaptiveCurveIrm: 1208685n;
+        readonly vaultV2Factory: 1208931n;
+        readonly morphoMarketV1AdapterV2Factory: 1208978n;
+        readonly registryList: 1208978n;
+        readonly chainlinkOracleFactory: 1208882n;
+        readonly preLiquidationFactory: 1208882n;
+    };
+    readonly 2818: {
+        readonly morpho: 23180020n;
+        readonly permit2: 5081244n;
+        readonly bundler3: {
+            readonly bundler3: 23180020n;
+            readonly generalAdapter1: 23180020n;
+        };
+        readonly adaptiveCurveIrm: 23180020n;
+        readonly vaultV2Factory: 23180183n;
+        readonly morphoMarketV1AdapterV2Factory: 23180228n;
+        readonly registryList: 23180228n;
+        readonly chainlinkOracleFactory: 23180111n;
+        readonly preLiquidationFactory: 23180111n;
+        readonly wNative: 0n;
+    };
+    readonly 4326: {
+        readonly morpho: 16408957n;
+        readonly permit2: 0n;
+        readonly bundler3: {
+            readonly bundler3: 16408957n;
+            readonly generalAdapter1: 16408957n;
+        };
+        readonly adaptiveCurveIrm: 16408957n;
+        readonly vaultV2Factory: 16409067n;
+        readonly morphoMarketV1AdapterV2Factory: 16409115n;
+        readonly registryList: 16409115n;
+        readonly chainlinkOracleFactory: 16409024n;
+        readonly preLiquidationFactory: 16409024n;
+        readonly wNative: 0n;
+    };
 };
+/** Deep-frozen registry of wrapped token to unwrapped token mappings. */
 export declare let unwrappedTokensMapping: Record<number, Record<`0x${string}`, `0x${string}`>>;
 /**
  * Registers custom addresses and unwrapped token mappings to extend
@@ -2642,6 +2866,7 @@ export declare let unwrappedTokensMapping: Record<number, Record<`0x${string}`,
  *                              Must provide all required deployments if chain is unknown.
  *
  * @throws {Error} If attempting to override an existing address.
+ * @returns Nothing.
  *
  * @example
  * ```ts