@morpho-org/blue-sdk 6.0.1 → 6.2.0

package/lib/cjs/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

package/lib/cjs/addresses.js

@@ -718,6 +718,50 @@ const _addressesRegistry = {
         preLiquidationFactory: "0xe8eCe452F04117e5Fe1Ea4403097215443225440",
         wNative: "0x19Aac5f612f524B754CA7e7c41cbFa2E981A4432",
     },
+    [chain_js_1.ChainId.ArcMainnet]: {
+        morpho: "0x34CD04070dD72b14E241112F6d83812Df5Af7fCD",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler3: {
+            bundler3: "0x855dbe13C409Df75CAF6a985Cf6993a4D0319Feb",
+            generalAdapter1: "0x0AF5BE7BD7B615e94e1d9275414482D028952466",
+        },
+        adaptiveCurveIrm: "0xF02615d094Fc02fC031C35fe705e175aA4653f20",
+        vaultV2Factory: "0x3b0eefaBfa22ec7CF2c73877ac16e78D76749f12",
+        morphoMarketV1AdapterV2Factory: "0x6C2FF5114E45b50bc7195c2F1f87C98cbdad62Cc",
+        registryList: "0xdEBC92370Cd74d55DA144116138681dbbb528765",
+        chainlinkOracleFactory: "0xbFc8D6167a02889D5EB08a023d9aB712B44f7dE8",
+        preLiquidationFactory: "0x8edf6Ac769a7E7D81d571aC0FB8733aD724f6922",
+    },
+    [chain_js_1.ChainId.MorphMainnet]: {
+        morpho: "0xAd10d07901Dc3195c3cb5e78E061F4EA8D9B4905",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler3: {
+            bundler3: "0xDB83A44Bf8f53966f7A4F7dCE7F8CdAaBCf83628",
+            generalAdapter1: "0xcaeec65c85Fe964c8Bd814cb8E4CaF8B06bde776",
+        },
+        adaptiveCurveIrm: "0xfB69467De332E03FF502B85bB2249d2f721F3319",
+        vaultV2Factory: "0x7D8BF8B276f967F7539c9e91E1a85a33fefE612B",
+        morphoMarketV1AdapterV2Factory: "0xa01D7c41cf419405d4DF2e5750d26438DCAC28a6",
+        registryList: "0x553c013d1978CF82EF6b316f5c247B73718ba481",
+        chainlinkOracleFactory: "0xE91032cE5B8D86bA4Be146c186984F49Af37fbf1",
+        preLiquidationFactory: "0x41581344ba49B07EFA758a0F2a199b90f05Cc866",
+        wNative: "0x5300000000000000000000000000000000000011",
+    },
+    [chain_js_1.ChainId.MegaEthMainnet]: {
+        morpho: "0x18120312A7cf44DcfEc6dCe5632a431579ED9100",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler3: {
+            bundler3: "0xf53D4c8f0f83F697CD6bB303567400cCf411aA63",
+            generalAdapter1: "0x74d3cbc721613C8461df92658d0a20dF275Ca31b",
+        },
+        adaptiveCurveIrm: "0x56875764185548B0ca72A1877b3aE15E44e8A323",
+        vaultV2Factory: "0xf133FA5A78C398B31Cc4a180E6Ae84111D6DCF5B",
+        morphoMarketV1AdapterV2Factory: "0x00a58b7a9B3E86CB21f5F11f29F4A12346457012",
+        registryList: "0x3aE18af9717C734820137726967bef4fBc5Ec95c",
+        chainlinkOracleFactory: "0x02522D475E7064E1d1E966e3197db050b19b2FC2",
+        preLiquidationFactory: "0xF6035B231028E61cd2283651f22ecA45f8e3ADc8",
+        wNative: "0x4200000000000000000000000000000000000006",
+    },
 };
 const _deployments = {
     [chain_js_1.ChainId.EthMainnet]: {
@@ -1314,7 +1358,65 @@ const _deployments = {
         preLiquidationFactory: 213462907n,
         wNative: 104802159n,
     },
+    [chain_js_1.ChainId.ArcMainnet]: {
+        morpho: 1208685n,
+        permit2: 0n,
+        bundler3: {
+            bundler3: 1208685n,
+            generalAdapter1: 1208685n,
+        },
+        adaptiveCurveIrm: 1208685n,
+        vaultV2Factory: 1208931n,
+        morphoMarketV1AdapterV2Factory: 1208978n,
+        registryList: 1208978n,
+        chainlinkOracleFactory: 1208882n,
+        preLiquidationFactory: 1208882n,
+    },
+    [chain_js_1.ChainId.MorphMainnet]: {
+        morpho: 23180020n,
+        permit2: 5081244n,
+        bundler3: {
+            bundler3: 23180020n,
+            generalAdapter1: 23180020n,
+        },
+        adaptiveCurveIrm: 23180020n,
+        vaultV2Factory: 23180183n,
+        morphoMarketV1AdapterV2Factory: 23180228n,
+        registryList: 23180228n,
+        chainlinkOracleFactory: 23180111n,
+        preLiquidationFactory: 23180111n,
+        wNative: 0n,
+    },
+    [chain_js_1.ChainId.MegaEthMainnet]: {
+        morpho: 16408957n,
+        permit2: 0n,
+        bundler3: {
+            bundler3: 16408957n,
+            generalAdapter1: 16408957n,
+        },
+        adaptiveCurveIrm: 16408957n,
+        vaultV2Factory: 16409067n,
+        morphoMarketV1AdapterV2Factory: 16409115n,
+        registryList: 16409115n,
+        chainlinkOracleFactory: 16409024n,
+        preLiquidationFactory: 16409024n,
+        wNative: 0n,
+    },
 };
+/**
+ * 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
+ * ```
+ */
 const getChainAddresses = (chainId) => {
     const chainAddresses = exports.addresses[chainId];
     if (chainAddresses == null)
@@ -1444,7 +1546,27 @@ const _unwrappedTokensMapping = {
     [chain_js_1.ChainId.KaiaMainnet]: {
         [_addressesRegistry[chain_js_1.ChainId.KaiaMainnet].wNative]: exports.NATIVE_ADDRESS,
     },
+    [chain_js_1.ChainId.MorphMainnet]: {
+        [_addressesRegistry[chain_js_1.ChainId.MorphMainnet].wNative]: exports.NATIVE_ADDRESS,
+    },
+    [chain_js_1.ChainId.MegaEthMainnet]: {
+        [_addressesRegistry[chain_js_1.ChainId.MegaEthMainnet].wNative]: exports.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
+ * ```
+ */
 function getUnwrappedToken(wrappedToken, chainId) {
     return exports.unwrappedTokensMapping[chainId]?.[wrappedToken];
 }
@@ -1480,6 +1602,19 @@ exports.permissionedCoinbaseTokens = {
         _addressesRegistry[chain_js_1.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>
+ * ```
+ */
 const getPermissionedCoinbaseTokens = (chainId) => exports.permissionedCoinbaseTokens[chainId] ?? new Set();
 exports.getPermissionedCoinbaseTokens = getPermissionedCoinbaseTokens;
 (0, morpho_ts_1.entries)(exports.permissionedBackedTokens).forEach(([chainId, tokens]) => {
@@ -1504,9 +1639,13 @@ exports.convexWrapperTokens = {
         _addressesRegistry[chain_js_1.ChainId.EthMainnet]["stkcvx2BTC-f-morpho"],
     ]),
 };
+/** Deep-frozen registry of known chain addresses, keyed by chain id. */
 exports.addressesRegistry = (0, morpho_ts_1.deepFreeze)(_addressesRegistry);
+/** Address registry keyed by numeric chain id. */
 exports.addresses = exports.addressesRegistry;
+/** Deep-frozen registry of deployment blocks, keyed by chain id. */
 exports.deployments = (0, morpho_ts_1.deepFreeze)(_deployments);
+/** Deep-frozen registry of wrapped token to unwrapped token mappings. */
 exports.unwrappedTokensMapping = (0, morpho_ts_1.deepFreeze)(_unwrappedTokensMapping);
 /**
  * Registers custom addresses and unwrapped token mappings to extend
@@ -1523,6 +1662,7 @@ exports.unwrappedTokensMapping = (0, morpho_ts_1.deepFreeze)(_unwrappedTokensMap
  *                              Must provide all required deployments if chain is unknown.
  *
  * @throws {Error} If attempting to override an existing address.
+ * @returns Nothing.
  *
  * @example
  * ```ts

package/lib/cjs/chain.d.ts

@@ -1,3 +1,4 @@
+/** Supported EIP-155 chain ids with Morpho Blue deployments or registry metadata. */
 export declare enum ChainId {
     EthMainnet = 1,
     BaseMainnet = 8453,
@@ -37,8 +38,12 @@ export declare enum ChainId {
     GensynMainnet = 685689,
     FlareMainnet = 14,
     XdcMainnet = 50,
-    KaiaMainnet = 8217
+    KaiaMainnet = 8217,
+    ArcMainnet = 5042,
+    MorphMainnet = 2818,
+    MegaEthMainnet = 4326
 }
+/** Explorer, native currency, and identifier metadata for a supported chain. */
 export interface ChainMetadata {
     readonly name: string;
     readonly id: ChainId;
@@ -52,12 +57,81 @@ export interface ChainMetadata {
     /** Whether eth_getBalance returns a reliable value. Defaults to true. */
     readonly hasReliableNativeBalance?: boolean;
 }
+/** Chain metadata helpers and registries. */
 export declare namespace ChainUtils {
+    /**
+     * Returns whether native token balances are reliable on a chain.
+     *
+     * @param chainId - The EIP-155 chain id to inspect.
+     * @returns `false` only for chains whose metadata marks native balances as unreliable.
+     * @example
+     * ```ts
+     * import { ChainId, ChainUtils } from "@morpho-org/blue-sdk";
+     *
+     * const reliable = ChainUtils.hasReliableNativeBalance(ChainId.EthMainnet);
+     * // reliable === true
+     * ```
+     */
     const hasReliableNativeBalance: (chainId: number) => boolean;
+    /**
+     * Converts a supported chain id to its hexadecimal JSON-RPC form.
+     *
+     * @param chainId - The supported chain id.
+     * @returns The chain id as a `0x`-prefixed hexadecimal string.
+     * @example
+     * ```ts
+     * import { ChainId, ChainUtils } from "@morpho-org/blue-sdk";
+     *
+     * const hexChainId = ChainUtils.toHexChainId(ChainId.EthMainnet);
+     * // hexChainId === "0x1"
+     * ```
+     */
     const toHexChainId: (chainId: ChainId) => string;
+    /**
+     * Returns the block explorer base URL for a supported chain.
+     *
+     * @param chainId - The supported chain id.
+     * @returns The chain's configured block explorer base URL.
+     * @example
+     * ```ts
+     * import { ChainId, ChainUtils } from "@morpho-org/blue-sdk";
+     *
+     * const explorerUrl = ChainUtils.getExplorerUrl(ChainId.EthMainnet);
+     * // explorerUrl === "https://etherscan.io"
+     * ```
+     */
     const getExplorerUrl: (chainId: ChainId) => string;
+    /**
+     * Returns a block explorer address URL for a supported chain.
+     *
+     * @param chainId - The supported chain id.
+     * @param address - The address to link to.
+     * @returns The block explorer URL for `address`.
+     * @example
+     * ```ts
+     * import { ChainId, ChainUtils, NATIVE_ADDRESS } from "@morpho-org/blue-sdk";
+     *
+     * const url = ChainUtils.getExplorerAddressUrl(ChainId.EthMainnet, NATIVE_ADDRESS);
+     * // url satisfies string
+     * ```
+     */
     const getExplorerAddressUrl: (chainId: ChainId, address: string) => string;
+    /**
+     * Returns a block explorer transaction URL for a supported chain.
+     *
+     * @param chainId - The supported chain id.
+     * @param tx - The transaction hash to link to.
+     * @returns The block explorer URL for `tx`.
+     * @example
+     * ```ts
+     * import { ChainId, ChainUtils } from "@morpho-org/blue-sdk";
+     *
+     * const url = ChainUtils.getExplorerTransactionUrl(ChainId.EthMainnet, "0xabc");
+     * // url satisfies string
+     * ```
+     */
     const getExplorerTransactionUrl: (chainId: ChainId, tx: string) => string;
+    /** Metadata for each supported chain, keyed by `ChainId`. */
     const CHAIN_METADATA: {
         1: {
             name: string;
@@ -489,5 +563,38 @@ export declare namespace ChainUtils {
             explorerUrl: string;
             identifier: string;
         };
+        5042: {
+            name: string;
+            id: ChainId.ArcMainnet;
+            nativeCurrency: {
+                name: string;
+                symbol: string;
+                decimals: number;
+            };
+            explorerUrl: string;
+            identifier: string;
+        };
+        2818: {
+            name: string;
+            id: ChainId.MorphMainnet;
+            nativeCurrency: {
+                name: string;
+                symbol: string;
+                decimals: number;
+            };
+            explorerUrl: string;
+            identifier: string;
+        };
+        4326: {
+            name: string;
+            id: ChainId.MegaEthMainnet;
+            nativeCurrency: {
+                name: string;
+                symbol: string;
+                decimals: number;
+            };
+            explorerUrl: string;
+            identifier: string;
+        };
     };
 }