refactor(blue-sdk)!: encapsulate addresses customization

BREAKING CHANGE: addressesRegistry can only be updated with `registerCustomAddresses`

Author: oumar-fall

packages/blue-sdk/package.json

@@ -19,7 +19,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@noble/hashes": "^1.6.1"
+    "@noble/hashes": "^1.6.1",
+    "@types/lodash": "^4.17.12",
+    "lodash": "^4.17.21"
   },
   "peerDependencies": {
     "@morpho-org/morpho-ts": "workspace:^"

packages/blue-sdk/src/addresses.ts

@@ -1,5 +1,10 @@
-import { type DottedKeys, entries } from "@morpho-org/morpho-ts";
-
+import {
+  type DeepPartial,
+  type DottedKeys,
+  entries,
+} from "@morpho-org/morpho-ts";
+import isPlainObject from "lodash/isPlainObject";
+import mergeWith from "lodash/mergeWith";
 import { ChainId } from "./chain.js";
 import { UnsupportedChainIdError } from "./errors.js";
 import type { Address } from "./types.js";
@@ -54,7 +59,7 @@ export interface ChainAddresses {
   wstEth?: Address;
 }
 
-export const addressesRegistry = {
+const _addressesRegistry = {
   [ChainId.EthMainnet]: {
     morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb",
     permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
@@ -363,9 +368,9 @@ export const addressesRegistry = {
   },
 } as const;
 
-export const addresses = addressesRegistry as Record<number, ChainAddresses>;
+export const addresses = _addressesRegistry as Record<number, ChainAddresses>;
 
-export type AddressLabel = DottedKeys<(typeof addressesRegistry)[ChainId]>;
+export type AddressLabel = DottedKeys<(typeof _addressesRegistry)[ChainId]>;
 
 export const getChainAddresses = (chainId: number): ChainAddresses => {
   const chainAddresses = addresses[chainId];
@@ -383,33 +388,34 @@ export const unwrappedTokensMapping: Record<
   Record<Address, Address>
 > = {
   [ChainId.EthMainnet]: {
-    [addressesRegistry[ChainId.EthMainnet].wbIB01]:
-      addressesRegistry[ChainId.EthMainnet].bIB01,
-    [addressesRegistry[ChainId.EthMainnet].wbC3M]:
-      addressesRegistry[ChainId.EthMainnet].bC3M,
-    [addressesRegistry[ChainId.EthMainnet].wNative]: NATIVE_ADDRESS,
-    [addressesRegistry[ChainId.EthMainnet].stEth]: NATIVE_ADDRESS,
-    [addressesRegistry[ChainId.EthMainnet].wstEth]:
-      addressesRegistry[ChainId.EthMainnet].stEth,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet].crvUSDTWBTCWETH,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet].crvUSDCWBTCWETH,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvxcrvCRVUSDTBTCWSTETH-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet].crvCRVUSDTBTCWSTETH,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvxTryLSD-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet].tryLSD,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet].crvUSDETHCRV,
-    [addressesRegistry[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"]]:
-      addressesRegistry[ChainId.EthMainnet]["2BTC-f"],
+    [_addressesRegistry[ChainId.EthMainnet].wbIB01]:
+      _addressesRegistry[ChainId.EthMainnet].bIB01,
+    [_addressesRegistry[ChainId.EthMainnet].wbC3M]:
+      _addressesRegistry[ChainId.EthMainnet].bC3M,
+    [_addressesRegistry[ChainId.EthMainnet].wNative]: NATIVE_ADDRESS,
+    [_addressesRegistry[ChainId.EthMainnet].stEth]: NATIVE_ADDRESS,
+    [_addressesRegistry[ChainId.EthMainnet].wstEth]:
+      _addressesRegistry[ChainId.EthMainnet].stEth,
+    [_addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"]]:
+      _addressesRegistry[ChainId.EthMainnet].crvUSDTWBTCWETH,
+    [_addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"]]:
+      _addressesRegistry[ChainId.EthMainnet].crvUSDCWBTCWETH,
+    [_addressesRegistry[ChainId.EthMainnet][
+      "stkcvxcrvCRVUSDTBTCWSTETH-morpho"
+    ]]: _addressesRegistry[ChainId.EthMainnet].crvCRVUSDTBTCWSTETH,
+    [_addressesRegistry[ChainId.EthMainnet]["stkcvxTryLSD-morpho"]]:
+      _addressesRegistry[ChainId.EthMainnet].tryLSD,
+    [_addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"]]:
+      _addressesRegistry[ChainId.EthMainnet].crvUSDETHCRV,
+    [_addressesRegistry[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"]]:
+      _addressesRegistry[ChainId.EthMainnet]["2BTC-f"],
   },
   [ChainId.BaseMainnet]: {
-    [addressesRegistry[ChainId.BaseMainnet].wNative]: NATIVE_ADDRESS,
-    [addressesRegistry[ChainId.BaseMainnet].verUsdc]:
-      addressesRegistry[ChainId.BaseMainnet].usdc,
-    [addressesRegistry[ChainId.BaseMainnet].testUsdc]:
-      addressesRegistry[ChainId.BaseMainnet].usdc,
+    [_addressesRegistry[ChainId.BaseMainnet].wNative]: NATIVE_ADDRESS,
+    [_addressesRegistry[ChainId.BaseMainnet].verUsdc]:
+      _addressesRegistry[ChainId.BaseMainnet].usdc,
+    [_addressesRegistry[ChainId.BaseMainnet].testUsdc]:
+      _addressesRegistry[ChainId.BaseMainnet].usdc,
   },
   [ChainId.PolygonMainnet]: {},
   [ChainId.ArbitrumMainnet]: {},
@@ -441,7 +447,7 @@ export const erc20WrapperTokens: Record<number, Set<Address>> = {};
  */
 export const permissionedWrapperTokens: Record<number, Set<Address>> = {
   [ChainId.BaseMainnet]: new Set([
-    addressesRegistry[ChainId.BaseMainnet].testUsdc,
+    _addressesRegistry[ChainId.BaseMainnet].testUsdc,
   ]),
 };
 
@@ -451,8 +457,8 @@ export const permissionedWrapperTokens: Record<number, Set<Address>> = {
  */
 export const permissionedBackedTokens: Record<number, Set<Address>> = {
   [ChainId.EthMainnet]: new Set([
-    addressesRegistry[ChainId.EthMainnet].wbIB01,
-    addressesRegistry[ChainId.EthMainnet].wbC3M,
+    _addressesRegistry[ChainId.EthMainnet].wbIB01,
+    _addressesRegistry[ChainId.EthMainnet].wbC3M,
   ]),
 };
 
@@ -462,7 +468,7 @@ export const permissionedBackedTokens: Record<number, Set<Address>> = {
  */
 export const permissionedCoinbaseTokens: Record<number, Set<Address>> = {
   [ChainId.BaseMainnet]: new Set([
-    addressesRegistry[ChainId.BaseMainnet].verUsdc,
+    _addressesRegistry[ChainId.BaseMainnet].verUsdc,
   ]),
 };
 
@@ -492,11 +498,29 @@ entries(permissionedWrapperTokens).forEach(([chainId, tokens]) => {
  */
 export const convexWrapperTokens: Record<number, Set<Address>> = {
   [ChainId.EthMainnet]: new Set([
-    addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"],
-    addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"],
-    addressesRegistry[ChainId.EthMainnet]["stkcvxcrvCRVUSDTBTCWSTETH-morpho"],
-    addressesRegistry[ChainId.EthMainnet]["stkcvxTryLSD-morpho"],
-    addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"],
-    addressesRegistry[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvxcrvCRVUSDTBTCWSTETH-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvxTryLSD-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"],
+    _addressesRegistry[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"],
   ]),
 };
+
+export let addressesRegistry = Object.freeze(_addressesRegistry);
+
+export function registerCustomAddresses(
+  customAddresses:
+    | Record<keyof typeof _addressesRegistry, DeepPartial<ChainAddresses>>
+    | Record<number, ChainAddresses>,
+) {
+  // biome-ignore lint/suspicious/noExplicitAny: type is not trivial and not important here
+  const customizer = (objValue: any, _srcValue: any, key: string) => {
+    if (objValue !== undefined && !isPlainObject(objValue))
+      throw new Error(`Cannot override existing address: ${key}`);
+  };
+
+  addressesRegistry = Object.freeze(
+    mergeWith({}, _addressesRegistry, customAddresses, customizer),
+  );
+}