@morpho-org/blue-sdk 6.0.1 → 6.1.0

package/lib/cjs/vault/VaultUtils.js

@@ -2,13 +2,45 @@
 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
@@ -16,6 +48,23 @@ var VaultUtils;
         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

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) {

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) {

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,22 @@ 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";
+    };
 };
+/** 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 +1340,52 @@ 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;
+    };
 };
+/** 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 +1406,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 +2101,24 @@ 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";
+    };
 };
+/** 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 +2714,22 @@ 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;
+    };
 };
+/** 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 +2746,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

package/lib/esm/addresses.js

@@ -710,6 +710,20 @@ const _addressesRegistry = {
         preLiquidationFactory: "0xe8eCe452F04117e5Fe1Ea4403097215443225440",
         wNative: "0x19Aac5f612f524B754CA7e7c41cbFa2E981A4432",
     },
+    [ChainId.ArcMainnet]: {
+        morpho: "0x34CD04070dD72b14E241112F6d83812Df5Af7fCD",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler3: {
+            bundler3: "0x855dbe13C409Df75CAF6a985Cf6993a4D0319Feb",
+            generalAdapter1: "0x0AF5BE7BD7B615e94e1d9275414482D028952466",
+        },
+        adaptiveCurveIrm: "0xF02615d094Fc02fC031C35fe705e175aA4653f20",
+        vaultV2Factory: "0x3b0eefaBfa22ec7CF2c73877ac16e78D76749f12",
+        morphoMarketV1AdapterV2Factory: "0x6C2FF5114E45b50bc7195c2F1f87C98cbdad62Cc",
+        registryList: "0xdEBC92370Cd74d55DA144116138681dbbb528765",
+        chainlinkOracleFactory: "0xbFc8D6167a02889D5EB08a023d9aB712B44f7dE8",
+        preLiquidationFactory: "0x8edf6Ac769a7E7D81d571aC0FB8733aD724f6922",
+    },
 };
 const _deployments = {
     [ChainId.EthMainnet]: {
@@ -1306,7 +1320,35 @@ const _deployments = {
         preLiquidationFactory: 213462907n,
         wNative: 104802159n,
     },
+    [ChainId.ArcMainnet]: {
+        morpho: 1208685n,
+        permit2: 0n,
+        bundler3: {
+            bundler3: 1208685n,
+            generalAdapter1: 1208685n,
+        },
+        adaptiveCurveIrm: 1208685n,
+        vaultV2Factory: 1208931n,
+        morphoMarketV1AdapterV2Factory: 1208978n,
+        registryList: 1208978n,
+        chainlinkOracleFactory: 1208882n,
+        preLiquidationFactory: 1208882n,
+    },
 };
+/**
+ * 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 const getChainAddresses = (chainId) => {
     const chainAddresses = addresses[chainId];
     if (chainAddresses == null)
@@ -1436,6 +1478,20 @@ const _unwrappedTokensMapping = {
         [_addressesRegistry[ChainId.KaiaMainnet].wNative]: NATIVE_ADDRESS,
     },
 };
+/**
+ * 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 function getUnwrappedToken(wrappedToken, chainId) {
     return unwrappedTokensMapping[chainId]?.[wrappedToken];
 }
@@ -1471,6 +1527,19 @@ export const permissionedCoinbaseTokens = {
         _addressesRegistry[ChainId.BaseMainnet].verUsdc,
     ]),
 };
+/**
+ * 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 const getPermissionedCoinbaseTokens = (chainId) => permissionedCoinbaseTokens[chainId] ?? new Set();
 entries(permissionedBackedTokens).forEach(([chainId, tokens]) => {
     tokens.forEach((token) => (erc20WrapperTokens[chainId] ??= new Set()).add(token));
@@ -1494,9 +1563,13 @@ export const convexWrapperTokens = {
         _addressesRegistry[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"],
     ]),
 };
+/** Deep-frozen registry of known chain addresses, keyed by chain id. */
 export let addressesRegistry = deepFreeze(_addressesRegistry);
+/** Address registry keyed by numeric chain id. */
 export let addresses = addressesRegistry;
+/** Deep-frozen registry of deployment blocks, keyed by chain id. */
 export let deployments = deepFreeze(_deployments);
+/** Deep-frozen registry of wrapped token to unwrapped token mappings. */
 export let unwrappedTokensMapping = deepFreeze(_unwrappedTokensMapping);
 /**
  * Registers custom addresses and unwrapped token mappings to extend
@@ -1513,6 +1586,7 @@ export let unwrappedTokensMapping = deepFreeze(_unwrappedTokensMapping);
  *                              Must provide all required deployments if chain is unknown.
  *
  * @throws {Error} If attempting to override an existing address.
+ * @returns Nothing.
  *
  * @example
  * ```ts