@morpho-org/blue-sdk 2.0.0-next.1 → 2.0.0-next.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Morpho Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -6,7 +6,7 @@
         <img src="https://img.shields.io/npm/v/@morpho-org/blue-sdk?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
     </picture>
 </a>
-<a href="https://github.com/wevm/@morpho-org/blue-sdk/blob/main/LICENSE">
+<a href="https://github.com/morpho-org/blue-sdk/blob/main/LICENSE">
     <picture>
         <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/@morpho-org/blue-sdk?colorA=21262d&colorB=21262d&style=flat">
         <img src="https://img.shields.io/npm/l/@morpho-org/blue-sdk?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
@@ -22,7 +22,8 @@
 <br />
 
 Framework-agnostic package that defines Morpho-related entity classes:
-- [**`MarketConfig`**](./src/market/MarketConfig.ts): represents the immutable configuration of a market on Morpho
+
+- [**`MarketParams`**](./src/market/MarketParams.ts): represents the immutable configuration of a market on Morpho
 - [**`Market`**](./src/market/Market.ts): represents the state of a market on Morpho
 - [**`Token`**](./src/token/Token.ts): represents a ERC20 token
 - [**`User`**](./src/user/User.ts): represents a user of Morpho
@@ -45,17 +46,17 @@ yarn add @morpho-org/blue-sdk
 
 ### Instance of the immutable configuration of a specific market
 
-Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to manipulate a given market's immutable configuration:
+Leverage the [`MarketParams`](./src/market/MarketParams.ts) class to manipulate a given market's immutable configuration:
 
 ```typescript
-import { MarketConfig } from "@morpho-org/blue-sdk";
+import { MarketParams } from "@morpho-org/blue-sdk";
 
-const config = new MarketConfig({
-  loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",       // WETH
+const config = new MarketParams({
+  loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
   collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
   oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",
-  irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC",             // AdaptiveCurveIrm
-  lltv: 94_5000000000000000n,                                    // 94.5%
+  irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC", // AdaptiveCurveIrm
+  lltv: 94_5000000000000000n, // 94.5%
 });
 
 config.liquidationIncentiveFactor; // e.g. 1_090000000000000000n (109%).
@@ -66,16 +67,16 @@ config.liquidationIncentiveFactor; // e.g. 1_090000000000000000n (109%).
 Leverage the [`Market`](./src/market/Market.ts) class to manipulate a specific market:
 
 ```typescript
-import { Market } from "@morpho-org/blue-sdk";
+import { Market, MarketParams } from "@morpho-org/blue-sdk";
 import { Time } from "@morpho-org/morpho-ts";
 
 const market = new Market({
-  config: new MarketConfig({
-    loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",       // WETH
+  config: new MarketParams({
+    loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
     collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
     oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",
-    irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC",             // AdaptiveCurveIrm
-    lltv: 94_5000000000000000n,                                    // 94.5%
+    irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC", // AdaptiveCurveIrm
+    lltv: 94_5000000000000000n, // 94.5%
   }),
   totalSupplyAssets: 1000_000000000000000000n,
   totalBorrowAssets: 920_000000000000000000n,
@@ -84,7 +85,7 @@ const market = new Market({
   lastUpdate: 1721000000n,
   fee: 0n,
   price: 1_100000000000000000000000000000000000n,
-  rateAtTarget: 94850992095n
+  rateAtTarget: 94850992095n,
 });
 
 market.utilization; // e.g. 92_0000000000000000n (92%).
@@ -110,7 +111,7 @@ const position = new AccrualPosition(
     marketId: market.id,
     supplyShares: 0n,
     borrowShares: 20_000000000000000000000000n,
-    collateral: 27_000000000000000000n
+    collateral: 27_000000000000000000n,
   }),
   market
 );

package/lib/addresses.d.ts

@@ -0,0 +1,117 @@
+import { ChainId } from "./chain.js";
+import type { Address } from "./types.js";
+/** Address used to replicate an erc20-behaviour for native token.
+ *
+ * NB: data might differ from expected onchain native token data
+ */
+export declare const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+export declare const addresses: {
+    readonly 1: {
+        readonly morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler: "0x4095F064B8d3c3548A3bebfd0Bbfd04750E30077";
+        readonly aaveV3OptimizerBundler: "0x16F38d2E764E7BeBF625a8E995b34968226D2F9c";
+        readonly aaveV2Bundler: "0xb3dCc75DB379925edFd3007511A8CE0cB4aa8e76";
+        readonly aaveV3Bundler: "0x98ccB155E86bb478d514a827d16f58c6912f9BDC";
+        readonly compoundV3Bundler: "0x3a0e2E9FB9c95fBc843daF166276C90B6C479558";
+        readonly compoundV2Bundler: "0x26bf52a84360ad3d01d7cdc28fc2ddc04d8c8647";
+        readonly adaptiveCurveIrm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC";
+        readonly publicAllocator: "0xfd32fA2ca22c76dD6E550706Ad913FC6CE91c75D";
+        readonly metaMorphoFactory: "0xA9c3D3a366466Fa809d1Ae982Fb2c46E5fC41101";
+        readonly wNative: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
+        readonly morphoToken: "0x9994E35Db50125E0DF82e4c2dde62496CE330999";
+        readonly dai: "0x6B175474E89094C44Da98b954EedeAC495271d0F";
+        readonly sDai: "0x83F20F44975D03b1b09e64809B757c47f942BEeA";
+        readonly mkr: "0x9f8F72aA9304c8B593d555F12eF6589cC3A579A2";
+        readonly stEth: "0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84";
+        readonly wstEth: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0";
+        readonly osEth: "0xf1C9acDc66974dFB6dEcB12aA385b9cD01190E38";
+        readonly bIB01: "0xCA30c93B02514f86d5C86a6e375E3A330B435Fb5";
+        readonly wbIB01: "0xcA2A7068e551d5C4482eb34880b194E4b945712F";
+        readonly bC3M: "0x2F123cF3F37CE3328CC9B5b8415f9EC5109b45e7";
+        readonly wbC3M: "0x95D7337d43340E2721960Dc402D9b9117f0d81a2";
+        readonly usdc: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
+        readonly usdt: "0xdAC17F958D2ee523a2206206994597C13D831ec7";
+        readonly crvUsd: "0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E";
+        readonly "stkcvxcrvUSDTWBTCWETH-morpho": "0xb0Ce26C88e4e7DCa51968b6047f44646f5064278";
+        readonly crvUSDTWBTCWETH: "0xf5f5B97624542D72A9E06f04804Bf81baA15e2B4";
+        readonly "stkcvxcrvUSDCWBTCWETH-morpho": "0x0ea1a65A2c255f24Ee8D81eA6AaC54Decd9d269e";
+        readonly crvUSDCWBTCWETH: "0x7F86Bf177Dd4F3494b841a37e810A34dD56c829B";
+        readonly "stkcvxcrvCRVUSDTBTCWSTETH-morpho": "0x3ce8Ec9f3d89aD0A2DdbCC3FDB8991BD241Fc82E";
+        readonly crvCRVUSDTBTCWSTETH: "0x2889302a794dA87fBF1D6Db415C1492194663D13";
+        readonly "stkcvxTryLSD-morpho": "0x6BA072F0d22806F2C52e9792AF47f2D59103BEBE";
+        readonly tryLSD: "0x2570f1bD5D2735314FC102eb12Fc1aFe9e6E7193";
+        readonly "stkcvxcrvUSDETHCRV-morpho": "0xAc904BAfBb5FB04Deb2b6198FdCEedE75a78Ce5a";
+        readonly crvUSDETHCRV: "0x4eBdF703948ddCEA3B11f675B4D1Fba9d2414A14";
+        readonly "stkcvx2BTC-f-morpho": "0x385E12cf4040543Bc8C18e05C1298Be5B04f3f5e";
+        readonly "2BTC-f": "0xB7ECB2AA52AA64a717180E030241bC75Cd946726";
+    };
+    readonly 8453: {
+        readonly morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb";
+        readonly permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+        readonly bundler: "0x23055618898e202386e6c13955a58D3C68200BFB";
+        readonly compoundV2Bundler: "0x123f3167a416cA19365dE03a65e0AF3532af7223";
+        readonly aaveV3Bundler: "0xcAe2929baBc60Be34818EaA5F40bF69265677108";
+        readonly compoundV3Bundler: "0x1f8076e2EB6f10b12e6886f30D4909A91969F7dA";
+        readonly adaptiveCurveIrm: "0x46415998764C29aB2a25CbeA6254146D50D22687";
+        readonly publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467";
+        readonly metaMorphoFactory: "0xA9c3D3a366466Fa809d1Ae982Fb2c46E5fC41101";
+        readonly wNative: "0x4200000000000000000000000000000000000006";
+        readonly usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+        readonly verUsdc: "0x59aaF835D34b1E3dF2170e4872B785f11E2a964b";
+        readonly testUsdc: "0xBC77067f829979812d795d516E523C4033b66409";
+    };
+};
+export interface ChainAddresses {
+    morpho: Address;
+    permit2: Address;
+    bundler: Address;
+    aaveV3OptimizerBundler?: Address;
+    aaveV2Bundler?: Address;
+    aaveV3Bundler?: Address;
+    compoundV3Bundler?: Address;
+    compoundV2Bundler?: Address;
+    adaptiveCurveIrm: Address;
+    publicAllocator: Address;
+    metaMorphoFactory: Address;
+    wNative: Address;
+    morphoToken?: Address;
+    dai?: Address;
+    mkr?: Address;
+    usdc?: Address;
+    stEth?: Address;
+    wstEth?: Address;
+}
+export type AddressLabel = keyof (typeof addresses)[ChainId];
+declare const _default: { [n in ChainId]: ChainAddresses; };
+export default _default;
+export declare const getChainAddresses: (chainId: number) => ChainAddresses;
+/**
+ * Assumptions:
+ * - unwrapped token has same number of decimals than wrapped tokens.
+ */
+export declare const unwrappedTokensMapping: Record<ChainId, Record<Address, Address>>;
+export declare function getUnwrappedToken(wrappedToken: Address, chainId: ChainId): `0x${string}` | undefined;
+/**
+ * The registry of all known ERC20Wrapper tokens.
+ */
+export declare const erc20WrapperTokens: Record<ChainId, Set<Address>>;
+/**
+ * The registry of all known PermissionedERC20Wrapper with a `hasPermission` getter.
+ * All permissioned wrapper tokens are considered ERC20Wrapper and automatically added to the erc20WrapperTokens registry.
+ */
+export declare const permissionedWrapperTokens: Record<ChainId, Set<Address>>;
+/**
+ * The registry of all known permissioned wrapped Backed tokens.
+ * All permissioned Backed tokens are considered ERC20Wrapper and automatically added to the erc20WrapperTokens registry.
+ */
+export declare const permissionedBackedTokens: Record<ChainId, Set<Address>>;
+/**
+ * The registry of all known permissioned wrapped tokens that require a Coinbase attestation.
+ * All permissioned Coinbase tokens are considered PermissionedERC20Wrapper and automatically added to the permissionedWrapperTokens registry.
+ */
+export declare const permissionedCoinbaseTokens: Record<ChainId, Set<Address>>;
+/** /!\  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<ChainId, Set<Address>>;

package/lib/addresses.js

@@ -0,0 +1,156 @@
+import { entries } from "@morpho-org/morpho-ts";
+import { ChainId, ChainUtils } from "./chain.js";
+/** Address used to replicate an erc20-behaviour for native token.
+ *
+ * NB: data might differ from expected onchain native token data
+ */
+export const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+export const addresses = {
+    [ChainId.EthMainnet]: {
+        morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler: "0x4095F064B8d3c3548A3bebfd0Bbfd04750E30077",
+        aaveV3OptimizerBundler: "0x16F38d2E764E7BeBF625a8E995b34968226D2F9c",
+        aaveV2Bundler: "0xb3dCc75DB379925edFd3007511A8CE0cB4aa8e76",
+        aaveV3Bundler: "0x98ccB155E86bb478d514a827d16f58c6912f9BDC",
+        compoundV3Bundler: "0x3a0e2E9FB9c95fBc843daF166276C90B6C479558",
+        compoundV2Bundler: "0x26bf52a84360ad3d01d7cdc28fc2ddc04d8c8647",
+        adaptiveCurveIrm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC",
+        publicAllocator: "0xfd32fA2ca22c76dD6E550706Ad913FC6CE91c75D",
+        metaMorphoFactory: "0xA9c3D3a366466Fa809d1Ae982Fb2c46E5fC41101",
+        wNative: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+        morphoToken: "0x9994E35Db50125E0DF82e4c2dde62496CE330999",
+        dai: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
+        sDai: "0x83F20F44975D03b1b09e64809B757c47f942BEeA",
+        mkr: "0x9f8F72aA9304c8B593d555F12eF6589cC3A579A2",
+        stEth: "0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84",
+        wstEth: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0",
+        osEth: "0xf1C9acDc66974dFB6dEcB12aA385b9cD01190E38",
+        bIB01: "0xCA30c93B02514f86d5C86a6e375E3A330B435Fb5",
+        // If we want to change the wbIB01 address, we have to check if the new one has simple permit or not.
+        // Currently, wbIB01 is considered to have simple permit.
+        wbIB01: "0xcA2A7068e551d5C4482eb34880b194E4b945712F",
+        bC3M: "0x2F123cF3F37CE3328CC9B5b8415f9EC5109b45e7",
+        // If we want to change the wbC3M address, we have to check if the new one has simple permit or not.
+        // Currently, wbC3M is considered to have simple permit.
+        wbC3M: "0x95D7337d43340E2721960Dc402D9b9117f0d81a2",
+        usdc: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        usdt: "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+        crvUsd: "0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E",
+        "stkcvxcrvUSDTWBTCWETH-morpho": "0xb0Ce26C88e4e7DCa51968b6047f44646f5064278",
+        crvUSDTWBTCWETH: "0xf5f5B97624542D72A9E06f04804Bf81baA15e2B4",
+        "stkcvxcrvUSDCWBTCWETH-morpho": "0x0ea1a65A2c255f24Ee8D81eA6AaC54Decd9d269e",
+        crvUSDCWBTCWETH: "0x7F86Bf177Dd4F3494b841a37e810A34dD56c829B",
+        "stkcvxcrvCRVUSDTBTCWSTETH-morpho": "0x3ce8Ec9f3d89aD0A2DdbCC3FDB8991BD241Fc82E",
+        crvCRVUSDTBTCWSTETH: "0x2889302a794dA87fBF1D6Db415C1492194663D13",
+        "stkcvxTryLSD-morpho": "0x6BA072F0d22806F2C52e9792AF47f2D59103BEBE",
+        tryLSD: "0x2570f1bD5D2735314FC102eb12Fc1aFe9e6E7193",
+        "stkcvxcrvUSDETHCRV-morpho": "0xAc904BAfBb5FB04Deb2b6198FdCEedE75a78Ce5a",
+        crvUSDETHCRV: "0x4eBdF703948ddCEA3B11f675B4D1Fba9d2414A14",
+        "stkcvx2BTC-f-morpho": "0x385E12cf4040543Bc8C18e05C1298Be5B04f3f5e",
+        "2BTC-f": "0xB7ECB2AA52AA64a717180E030241bC75Cd946726",
+    },
+    [ChainId.BaseMainnet]: {
+        morpho: "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb",
+        permit2: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+        bundler: "0x23055618898e202386e6c13955a58D3C68200BFB",
+        compoundV2Bundler: "0x123f3167a416cA19365dE03a65e0AF3532af7223",
+        aaveV3Bundler: "0xcAe2929baBc60Be34818EaA5F40bF69265677108",
+        compoundV3Bundler: "0x1f8076e2EB6f10b12e6886f30D4909A91969F7dA",
+        adaptiveCurveIrm: "0x46415998764C29aB2a25CbeA6254146D50D22687",
+        publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467",
+        metaMorphoFactory: "0xA9c3D3a366466Fa809d1Ae982Fb2c46E5fC41101",
+        wNative: "0x4200000000000000000000000000000000000006",
+        usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+        verUsdc: "0x59aaF835D34b1E3dF2170e4872B785f11E2a964b",
+        testUsdc: "0xBC77067f829979812d795d516E523C4033b66409",
+    },
+};
+export default addresses;
+export const getChainAddresses = (chainId) => {
+    return addresses[ChainUtils.parseSupportedChainId(chainId)];
+};
+/**
+ * Assumptions:
+ * - unwrapped token has same number of decimals than wrapped tokens.
+ */
+export const unwrappedTokensMapping = {
+    [ChainId.EthMainnet]: {
+        [addresses[ChainId.EthMainnet].wbIB01]: addresses[ChainId.EthMainnet].bIB01,
+        [addresses[ChainId.EthMainnet].wbC3M]: addresses[ChainId.EthMainnet].bC3M,
+        [addresses[ChainId.EthMainnet].wNative]: NATIVE_ADDRESS,
+        [addresses[ChainId.EthMainnet].stEth]: NATIVE_ADDRESS,
+        [addresses[ChainId.EthMainnet].wstEth]: addresses[ChainId.EthMainnet].stEth,
+        [addresses[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"]]: addresses[ChainId.EthMainnet].crvUSDTWBTCWETH,
+        [addresses[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"]]: addresses[ChainId.EthMainnet].crvUSDCWBTCWETH,
+        [addresses[ChainId.EthMainnet]["stkcvxcrvCRVUSDTBTCWSTETH-morpho"]]: addresses[ChainId.EthMainnet].crvCRVUSDTBTCWSTETH,
+        [addresses[ChainId.EthMainnet]["stkcvxTryLSD-morpho"]]: addresses[ChainId.EthMainnet].tryLSD,
+        [addresses[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"]]: addresses[ChainId.EthMainnet].crvUSDETHCRV,
+        [addresses[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"]]: addresses[ChainId.EthMainnet]["2BTC-f"],
+    },
+    [ChainId.BaseMainnet]: {
+        [addresses[ChainId.BaseMainnet].wNative]: NATIVE_ADDRESS,
+        [addresses[ChainId.BaseMainnet].verUsdc]: addresses[ChainId.BaseMainnet].usdc,
+        [addresses[ChainId.BaseMainnet].testUsdc]: addresses[ChainId.BaseMainnet].usdc,
+    },
+};
+export function getUnwrappedToken(wrappedToken, chainId) {
+    return unwrappedTokensMapping[chainId][wrappedToken];
+}
+/**
+ * The registry of all known ERC20Wrapper tokens.
+ */
+export const erc20WrapperTokens = {
+    [ChainId.EthMainnet]: new Set(),
+    [ChainId.BaseMainnet]: new Set(),
+};
+/**
+ * The registry of all known PermissionedERC20Wrapper with a `hasPermission` getter.
+ * All permissioned wrapper tokens are considered ERC20Wrapper and automatically added to the erc20WrapperTokens registry.
+ */
+export const permissionedWrapperTokens = {
+    [ChainId.EthMainnet]: new Set(),
+    [ChainId.BaseMainnet]: new Set([addresses[ChainId.BaseMainnet].testUsdc]),
+};
+/**
+ * The registry of all known permissioned wrapped Backed tokens.
+ * All permissioned Backed tokens are considered ERC20Wrapper and automatically added to the erc20WrapperTokens registry.
+ */
+export const permissionedBackedTokens = {
+    [ChainId.EthMainnet]: new Set([
+        addresses[ChainId.EthMainnet].wbIB01,
+        addresses[ChainId.EthMainnet].wbC3M,
+    ]),
+    [ChainId.BaseMainnet]: new Set(),
+};
+/**
+ * The registry of all known permissioned wrapped tokens that require a Coinbase attestation.
+ * All permissioned Coinbase tokens are considered PermissionedERC20Wrapper and automatically added to the permissionedWrapperTokens registry.
+ */
+export const permissionedCoinbaseTokens = {
+    [ChainId.EthMainnet]: new Set(),
+    [ChainId.BaseMainnet]: new Set([addresses[ChainId.BaseMainnet].verUsdc]),
+};
+entries(permissionedBackedTokens).forEach(([chainId, tokens]) => {
+    tokens.forEach((token) => erc20WrapperTokens[chainId].add(token));
+});
+entries(permissionedCoinbaseTokens).forEach(([chainId, tokens]) => {
+    tokens.forEach((token) => permissionedWrapperTokens[chainId].add(token));
+});
+entries(permissionedWrapperTokens).forEach(([chainId, tokens]) => {
+    tokens.forEach((token) => erc20WrapperTokens[chainId].add(token));
+});
+/** /!\  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 const convexWrapperTokens = {
+    [ChainId.EthMainnet]: new Set([
+        addresses[ChainId.EthMainnet]["stkcvxcrvUSDTWBTCWETH-morpho"],
+        addresses[ChainId.EthMainnet]["stkcvxcrvUSDCWBTCWETH-morpho"],
+        addresses[ChainId.EthMainnet]["stkcvxcrvCRVUSDTBTCWSTETH-morpho"],
+        addresses[ChainId.EthMainnet]["stkcvxTryLSD-morpho"],
+        addresses[ChainId.EthMainnet]["stkcvxcrvUSDETHCRV-morpho"],
+        addresses[ChainId.EthMainnet]["stkcvx2BTC-f-morpho"],
+    ]),
+    [ChainId.BaseMainnet]: new Set(),
+};

package/lib/chain.d.ts

@@ -0,0 +1,29 @@
+export declare enum ChainId {
+    EthMainnet = 1,
+    BaseMainnet = 8453
+}
+export interface ChainMetadata {
+    readonly name: string;
+    readonly id: ChainId;
+    readonly defaultRpcUrl: string;
+    readonly explorerUrl: string;
+    readonly nativeCurrency: {
+        readonly name: string;
+        readonly symbol: string;
+        readonly decimals: number;
+    };
+    readonly isTestnet: boolean;
+    readonly shortName: string;
+    readonly identifier: string;
+    readonly logoSrc: string;
+}
+export declare namespace ChainUtils {
+    const toHexChainId: (chainId: ChainId) => string;
+    const getExplorerUrl: (chainId: ChainId) => string;
+    const getExplorerAddressUrl: (chainId: ChainId, address: string) => string;
+    const getExplorerTransactionUrl: (chainId: ChainId, tx: string) => string;
+    function isSupported(chainId: number): chainId is ChainId;
+    function parseSupportedChainId(candidate: unknown): ChainId;
+    const BLUE_AVAILABLE_CHAINS: [ChainId, ...ChainId[]];
+    const CHAIN_METADATA: Record<ChainId, ChainMetadata>;
+}