@bgd-labs/toolbox 0.0.4 → 0.0.6

package/dist/index.js

@@ -30,6 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ChainId: () => ChainId,
+  ChainList: () => ChainList,
   EVENT_DB: () => EVENT_DB,
   HALF_RAY: () => HALF_RAY,
   HALF_WAD: () => HALF_WAD,
@@ -43,6 +45,7 @@ __export(index_exports, {
   SelfdestuctCheckState: () => SelfdestuctCheckState,
   WAD: () => WAD,
   WAD_RAY_RATIO: () => WAD_RAY_RATIO,
+  alchemySupportedChainIds: () => alchemySupportedChainIds,
   bitmapToIndexes: () => bitmapToIndexes,
   calculateAvailableBorrowsMarketReferenceCurrency: () => calculateAvailableBorrowsMarketReferenceCurrency,
   calculateCompoundedInterest: () => calculateCompoundedInterest,
@@ -58,17 +61,24 @@ __export(index_exports, {
   erc1967_ImplementationSlot: () => erc1967_ImplementationSlot,
   foundry_getStandardJsonInput: () => foundry_getStandardJsonInput,
   foundry_getStorageLayout: () => foundry_getStorageLayout,
+  getAlchemyRPC: () => getAlchemyRPC,
   getBits: () => getBits,
+  getClient: () => getClient,
   getCurrentDebtBalance: () => getCurrentDebtBalance,
   getCurrentLiquidityBalance: () => getCurrentLiquidityBalance,
+  getExplicitRPC: () => getExplicitRPC,
   getExplorer: () => getExplorer,
   getGovernance: () => getGovernance,
   getMarketReferenceCurrencyAndUsdBalance: () => getMarketReferenceCurrencyAndUsdBalance,
+  getNetworkEnv: () => getNetworkEnv,
   getNonFinalizedPayloads: () => getNonFinalizedPayloads,
   getNonFinalizedProposals: () => getNonFinalizedProposals,
   getNormalizedDebt: () => getNormalizedDebt,
   getNormalizedIncome: () => getNormalizedIncome,
   getPayloadsController: () => getPayloadsController,
+  getPublicRpc: () => getPublicRpc,
+  getQuickNodeRpc: () => getQuickNodeRpc,
+  getRPCUrl: () => getRPCUrl,
   getSourceCode: () => getSourceCode,
   isPayloadFinal: () => isPayloadFinal,
   isProposalFinal: () => isProposalFinal,
@@ -76,6 +86,7 @@ __export(index_exports, {
   makeProposalExecutableOnTestClient: () => makeProposalExecutableOnTestClient,
   parseEtherscanStyleSourceCode: () => parseEtherscanStyleSourceCode,
   parseLogs: () => parseLogs,
+  publicRPCs: () => publicRPCs,
   rayDiv: () => rayDiv,
   rayMul: () => rayMul,
   rayToWad: () => rayToWad,
@@ -1906,7 +1917,7 @@ var IGovernanceCore_ABI = [
   }
 ];
 
-// src/aave/governance/payloadsController.ts
+// src/aave/governance/payloads-controller.ts
 var import_viem2 = require("viem");
 
 // src/math/slot.ts
@@ -1920,7 +1931,7 @@ function getSolidityStorageSlotUint(mappingSlot, key) {
   );
 }
 
-// src/aave/governance/payloadsController.ts
+// src/aave/governance/payloads-controller.ts
 var import_actions = require("viem/actions");
 var PayloadState = /* @__PURE__ */ ((PayloadState2) => {
   PayloadState2[PayloadState2["None"] = 0] = "None";
@@ -3151,6 +3162,357 @@ function diffFoundryStorageLayout(layoutBefore, layoutAfter) {
 // src/ecosystem/event-db.ts
 var EVENT_DB = [];
 
+// src/ecosystem/chainIds.ts
+var import_chains = require("viem/chains");
+var ChainId = {
+  celo: import_chains.celo.id,
+  mainnet: import_chains.mainnet.id,
+  polygon: import_chains.polygon.id,
+  polygon_amoy: import_chains.polygonAmoy.id,
+  avalanche: import_chains.avalanche.id,
+  avalanche_fuji: import_chains.avalancheFuji.id,
+  arbitrum: import_chains.arbitrum.id,
+  arbitrum_sepolia: import_chains.arbitrumSepolia.id,
+  fantom: import_chains.fantom.id,
+  fantom_testnet: import_chains.fantomTestnet.id,
+  optimism: import_chains.optimism.id,
+  optimism_sepolia: import_chains.optimismSepolia.id,
+  harmony: import_chains.harmonyOne.id,
+  sepolia: import_chains.sepolia.id,
+  scroll: import_chains.scroll.id,
+  scroll_sepolia: import_chains.scrollSepolia.id,
+  sonic: import_chains.sonic.id,
+  mantle: import_chains.mantle.id,
+  metis: import_chains.metis.id,
+  base: import_chains.base.id,
+  base_sepolia: import_chains.baseSepolia.id,
+  bnb: import_chains.bsc.id,
+  gnosis: import_chains.gnosis.id,
+  zkEVM: import_chains.polygonZkEvm.id,
+  zksync: import_chains.zksync.id,
+  linea: import_chains.linea.id
+};
+var ChainList = {
+  [ChainId.mainnet]: import_chains.mainnet,
+  [ChainId.polygon]: import_chains.polygon,
+  [ChainId.polygon_amoy]: import_chains.polygonAmoy,
+  [ChainId.avalanche]: import_chains.avalanche,
+  [ChainId.avalanche_fuji]: import_chains.avalancheFuji,
+  [ChainId.arbitrum]: import_chains.arbitrum,
+  [ChainId.arbitrum_sepolia]: import_chains.arbitrumSepolia,
+  [ChainId.fantom]: import_chains.fantom,
+  [ChainId.fantom_testnet]: import_chains.fantomTestnet,
+  [ChainId.optimism]: import_chains.optimism,
+  [ChainId.optimism_sepolia]: import_chains.optimismSepolia,
+  [ChainId.harmony]: import_chains.harmonyOne,
+  [ChainId.sepolia]: import_chains.sepolia,
+  [ChainId.scroll]: import_chains.scroll,
+  [ChainId.scroll_sepolia]: import_chains.scrollSepolia,
+  [ChainId.sonic]: import_chains.sonic,
+  [ChainId.mantle]: import_chains.mantle,
+  [ChainId.metis]: import_chains.metis,
+  [ChainId.base]: import_chains.base,
+  [ChainId.base_sepolia]: import_chains.baseSepolia,
+  [ChainId.bnb]: import_chains.bsc,
+  [ChainId.gnosis]: import_chains.gnosis,
+  [ChainId.zkEVM]: import_chains.polygonZkEvm,
+  [ChainId.celo]: import_chains.celo,
+  [ChainId.zksync]: import_chains.zksync,
+  [ChainId.linea]: import_chains.linea
+};
+
+// src/ecosystem/rpcs.ts
+var import_viem5 = require("viem");
+
+// src/ecosystem/generated/alechmyNetworkMap.ts
+var alechmyNetworkMap = {
+  1: "eth-mainnet",
+  10: "opt-mainnet",
+  30: "rootstock-mainnet",
+  31: "rootstock-testnet",
+  56: "bnb-mainnet",
+  97: "bnb-testnet",
+  100: "gnosis-mainnet",
+  130: "unichain-mainnet",
+  137: "polygon-mainnet",
+  146: "sonic-mainnet",
+  204: "opbnb-mainnet",
+  250: "fantom-mainnet",
+  252: "frax-mainnet",
+  300: "zksync-sepolia",
+  324: "zksync-mainnet",
+  360: "shape-mainnet",
+  480: "worldchain-mainnet",
+  545: "flow-testnet",
+  592: "astar-mainnet",
+  747: "flow-mainnet",
+  1088: "metis-mainnet",
+  1101: "polygonzkevm-mainnet",
+  1301: "unichain-sepolia",
+  1328: "sei-testnet",
+  1329: "sei-mainnet",
+  1868: "soneium-mainnet",
+  1946: "soneium-minato",
+  2020: "ronin-mainnet",
+  2021: "ronin-saigon",
+  2442: "polygonzkevm-cardona",
+  2522: "frax-sepolia",
+  2741: "abstract-mainnet",
+  4002: "fantom-testnet",
+  4157: "crossfi-testnet",
+  4158: "crossfi-mainnet",
+  4801: "worldchain-sepolia",
+  5e3: "mantle-mainnet",
+  5003: "mantle-sepolia",
+  5373: "settlus-septestnet",
+  5611: "opbnb-testnet",
+  7e3: "zetachain-mainnet",
+  7001: "zetachain-testnet",
+  8008: "polynomial-mainnet",
+  8009: "polynomial-sepolia",
+  8453: "base-mainnet",
+  10143: "monad-testnet",
+  10200: "gnosis-chiado",
+  11011: "shape-sepolia",
+  11124: "abstract-testnet",
+  17e3: "eth-holesky",
+  33111: "apechain-curtis",
+  33139: "apechain-mainnet",
+  37111: "lens-sepolia",
+  42161: "arb-mainnet",
+  42170: "arbnova-mainnet",
+  43113: "avax-fuji",
+  43114: "avax-mainnet",
+  57054: "sonic-blaze",
+  57073: "ink-mainnet",
+  59141: "linea-sepolia",
+  59144: "linea-mainnet",
+  63157: "geist-mainnet",
+  80002: "polygon-amoy",
+  80094: "berachain-mainnet",
+  81457: "blast-mainnet",
+  84532: "base-sepolia",
+  421614: "arb-sepolia",
+  534351: "scroll-sepolia",
+  534352: "scroll-mainnet",
+  631571: "geist-polter",
+  763373: "ink-sepolia",
+  7777777: "zora-mainnet",
+  11155111: "eth-sepolia",
+  11155420: "opt-sepolia",
+  168587773: "blast-sepolia",
+  241320161: "xmtp-testnet",
+  666666666: "degen-mainnet",
+  994873017: "lumia-prism",
+  999999999: "zora-sepolia",
+  1952959480: "lumia-testnet"
+};
+
+// src/ecosystem/generated/quicknodeNetworkMap.ts
+var quicknodeNetworkMap = {
+  1: "mainnet",
+  10: "optimism",
+  14: "flare-mainnet",
+  56: "bsc",
+  81: "joc-mainnet",
+  97: "bsc-testnet",
+  100: "xdai",
+  114: "flare-coston2",
+  130: "unichain-mainnet",
+  137: "matic",
+  164: "omni-omega",
+  166: "omni-mainnet",
+  250: "fantom",
+  252: "fraxtal-mainnet",
+  295: "hedera-mainnet",
+  296: "hedera-testnet",
+  300: "zksync-sepolia",
+  324: "zksync-mainnet",
+  480: "worldchain-mainnet",
+  545: "flow-testnet",
+  690: "redstone-mainnet",
+  747: "flow-mainnet",
+  1001: "kaia-kairos",
+  1101: "zkevm-mainnet",
+  1135: "lisk-mainnet",
+  1301: "unichain-sepolia",
+  1315: "story-aeneid",
+  1328: "sei-atlantic",
+  1329: "sei-pacific",
+  1480: "vana-mainnet",
+  1513: "story-testnet",
+  1516: "story-odyssey",
+  1993: "b3-sepolia",
+  2442: "zkevm-cardona",
+  2741: "abstract-mainnet",
+  2810: "morph-holesky",
+  2818: "morph-mainnet",
+  3338: "peaq-mainnet",
+  4801: "worldchain-sepolia",
+  5e3: "mantle-mainnet",
+  5003: "mantle-sepolia",
+  6805: "race-mainnet",
+  6806: "race-sepolia",
+  7560: "cyber-mainnet",
+  8217: "kaia-mainnet",
+  8333: "b3-mainnet",
+  8453: "base-mainnet",
+  11124: "abstract-testnet",
+  13371: "imx-mainnet",
+  13473: "imx-testnet",
+  14800: "vana-moksha",
+  16600: "0g-newton",
+  17e3: "ethereum-holesky",
+  34443: "mode-mainnet",
+  42161: "arbitrum-mainnet",
+  42170: "nova-mainnet",
+  42220: "celo-mainnet",
+  43113: "avalanche-testnet",
+  43114: "avalanche-mainnet",
+  59144: "linea-mainnet",
+  80002: "matic-amoy",
+  80084: "bera-bartio",
+  80085: "bera-artio",
+  80094: "bera-mainnet",
+  81457: "blast-mainnet",
+  84532: "base-sepolia",
+  421613: "arbitrum-goerli",
+  421614: "arbitrum-sepolia",
+  534351: "scroll-testnet",
+  534352: "scroll-mainnet",
+  660279: "xai-mainnet",
+  763373: "ink-sepolia",
+  7777777: "zora-mainnet",
+  11155111: "ethereum-sepolia",
+  11155420: "optimism-sepolia",
+  111557560: "cyber-sepolia",
+  168587773: "blast-sepolia",
+  37714555429: "xai-testnet"
+};
+
+// src/ecosystem/rpcs.ts
+var publicRPCs = {
+  [ChainId.mainnet]: "https://eth.llamarpc.com",
+  [ChainId.polygon]: "https://polygon.llamarpc.com",
+  [ChainId.arbitrum]: "https://polygon.llamarpc.com",
+  [ChainId.base]: "https://base.llamarpc.com",
+  [ChainId.bnb]: "https://binance.llamarpc.com",
+  [ChainId.metis]: "https://andromeda.metis.io/?owner=1088",
+  [ChainId.gnosis]: "https://rpc.ankr.com/gnosis",
+  [ChainId.scroll]: "https://rpc.scroll.io",
+  [ChainId.zksync]: "https://mainnet.era.zksync.io",
+  [ChainId.fantom]: "https://rpc.ftm.tools",
+  [ChainId.avalanche]: "https://api.avax.network/ext/bc/C/rpc",
+  [ChainId.linea]: "https://rpc.linea.build"
+};
+var alchemySupportedChainIds = Object.values(ChainId).filter(
+  (id) => alechmyNetworkMap[id]
+);
+var getNetworkEnv = (chainId) => {
+  const symbol = Object.entries(ChainId).find(
+    ([, value]) => value === chainId
+  )?.[0];
+  if (!symbol) {
+    throw new Error(
+      `Didn't find a viem symbol for chainId: ${chainId}. Wire it up in 'src/chainIds.ts'!`
+    );
+  }
+  const env = `RPC_${symbol.toUpperCase()}`;
+  return env;
+};
+function getExplicitRPC(chainId) {
+  const env = getNetworkEnv(chainId);
+  if (process.env[env]) {
+    return process.env[env];
+  }
+  throw new Error(`Env '${env}' is not set. Please set it manually.`);
+}
+function getAlchemyRPC(chainId, alchemyKey) {
+  const alchemyId = alechmyNetworkMap[chainId];
+  if (!alchemyId) {
+    throw new Error(`ChainId '${chainId}' is not supported by Alchemy.`);
+  }
+  if (!alchemyKey) {
+    throw new Error(
+      `ChainId '${chainId}' is supported by Alchemy, but no 'alchemyKey' was provided.`
+    );
+  }
+  return `https://${alchemyId}.g.alchemy.com/v2/${alchemyKey}`;
+}
+function getPublicRpc(chainId) {
+  const publicRpc = publicRPCs[chainId];
+  if (!publicRpc)
+    throw new Error(`No default public rpc for '${chainId}' configured.`);
+  return publicRpc;
+}
+function getQuickNodeRpc(chainId, options) {
+  const quickNodeSlug = quicknodeNetworkMap[chainId];
+  if (!quickNodeSlug) {
+    throw new Error(`ChainId '${chainId}' is not supported by Quicknode.`);
+  }
+  if (!options.quicknodeEndpointName) {
+    throw new Error(
+      `ChainId '${chainId}' is supported by Quicknode, but no 'quicknodeEndpointName' was provided.`
+    );
+  }
+  if (!options.quicknodeToken) {
+    throw new Error(
+      `ChainId '${chainId}' is supported by Quicknode, but no 'quicknodeToken' was provided.`
+    );
+  }
+  if (chainId === ChainId.mainnet) {
+    return `https://${options.quicknodeEndpointName}.quiknode.pro/${options.quicknodeToken}`;
+  }
+  return `https://${options.quicknodeEndpointName}.${quickNodeSlug}.quiknode.pro/${options.quicknodeToken}`;
+}
+var getRPCUrl = (chainId, options) => {
+  if (!Object.values(ChainId).includes(chainId)) {
+    throw new Error(
+      `ChainId '${chainId}' is not supported by this library. Feel free to open an issue.`
+    );
+  }
+  try {
+    return getExplicitRPC(chainId);
+  } catch (e) {
+  }
+  if (options?.alchemyKey) {
+    try {
+      return getAlchemyRPC(chainId, options?.alchemyKey);
+    } catch (e) {
+    }
+  }
+  if (options?.quicknodeEndpointName && options.quicknodeToken) {
+    try {
+      return getQuickNodeRpc(chainId, {
+        quicknodeToken: options.quicknodeToken,
+        quicknodeEndpointName: options.quicknodeEndpointName
+      });
+    } catch (e) {
+    }
+  }
+  try {
+    return getPublicRpc(chainId);
+  } catch (e) {
+  }
+};
+var clientCache = {};
+function getClient(chainId, {
+  httpConfig,
+  clientConfig,
+  providerConfig,
+  forceRebuildClient
+}) {
+  if (!clientCache[chainId] || forceRebuildClient) {
+    const rpcURL = getRPCUrl(chainId, providerConfig);
+    clientCache[chainId] = (0, import_viem5.createClient)({
+      chain: ChainList[chainId],
+      transport: (0, import_viem5.http)(rpcURL, httpConfig),
+      ...clientConfig
+    });
+  }
+  return clientCache[chainId];
+}
+
 // src/ecosystem/constants.ts
 var erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 var erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
@@ -3204,11 +3566,11 @@ async function diffCode(before, after) {
 }
 
 // src/seatbelt/logs.ts
-var import_viem5 = require("viem");
+var import_viem6 = require("viem");
 function parseLogs({ logs, eventDb }) {
   const parsedLogs = logs.map((log) => {
     try {
-      const decoded = (0, import_viem5.decodeEventLog)({
+      const decoded = (0, import_viem6.decodeEventLog)({
         data: log.data,
         topics: log.topics,
         abi: eventDb
@@ -3347,6 +3709,8 @@ async function renderTenderlyReport({
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ChainId,
+  ChainList,
   EVENT_DB,
   HALF_RAY,
   HALF_WAD,
@@ -3360,6 +3724,7 @@ async function renderTenderlyReport({
   SelfdestuctCheckState,
   WAD,
   WAD_RAY_RATIO,
+  alchemySupportedChainIds,
   bitmapToIndexes,
   calculateAvailableBorrowsMarketReferenceCurrency,
   calculateCompoundedInterest,
@@ -3375,17 +3740,24 @@ async function renderTenderlyReport({
   erc1967_ImplementationSlot,
   foundry_getStandardJsonInput,
   foundry_getStorageLayout,
+  getAlchemyRPC,
   getBits,
+  getClient,
   getCurrentDebtBalance,
   getCurrentLiquidityBalance,
+  getExplicitRPC,
   getExplorer,
   getGovernance,
   getMarketReferenceCurrencyAndUsdBalance,
+  getNetworkEnv,
   getNonFinalizedPayloads,
   getNonFinalizedProposals,
   getNormalizedDebt,
   getNormalizedIncome,
   getPayloadsController,
+  getPublicRpc,
+  getQuickNodeRpc,
+  getRPCUrl,
   getSourceCode,
   isPayloadFinal,
   isProposalFinal,
@@ -3393,6 +3765,7 @@ async function renderTenderlyReport({
   makeProposalExecutableOnTestClient,
   parseEtherscanStyleSourceCode,
   parseLogs,
+  publicRPCs,
   rayDiv,
   rayMul,
   rayToWad,