@bgd-labs/toolbox 0.0.4 → 0.0.5

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
 import * as viem from 'viem';
-import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, Abi } from 'viem';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, HttpTransportConfig, ClientConfig, Abi } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -348,6 +348,93 @@ declare function diffFoundryStorageLayout(layoutBefore: FoundryStorage, layoutAf
 
 declare const EVENT_DB: readonly [];
 
+declare const ChainId: {
+    readonly celo: 42220;
+    readonly mainnet: 1;
+    readonly polygon: 137;
+    readonly polygon_amoy: 80002;
+    readonly avalanche: 43114;
+    readonly avalanche_fuji: 43113;
+    readonly arbitrum: 42161;
+    readonly arbitrum_sepolia: 421614;
+    readonly fantom: 250;
+    readonly fantom_testnet: 4002;
+    readonly optimism: 10;
+    readonly optimism_sepolia: 11155420;
+    readonly harmony: 1666600000;
+    readonly sepolia: 11155111;
+    readonly scroll: 534352;
+    readonly scroll_sepolia: 534351;
+    readonly sonic: 146;
+    readonly mantle: 5000;
+    readonly metis: 1088;
+    readonly base: 8453;
+    readonly base_sepolia: 84532;
+    readonly bnb: 56;
+    readonly gnosis: 100;
+    readonly zkEVM: 1101;
+    readonly zksync: 324;
+    readonly linea: 59144;
+};
+
+type SupportedChainIds = (typeof ChainId)[keyof typeof ChainId];
+/**
+ * A manually maintained list of public rpcs.
+ * These should only be used for prs coming from forks, which should not access secrets like the alchemy api key.
+ */
+declare const publicRPCs: {
+    readonly 1: "https://eth.llamarpc.com";
+    readonly 137: "https://polygon.llamarpc.com";
+    readonly 42161: "https://polygon.llamarpc.com";
+    readonly 8453: "https://base.llamarpc.com";
+    readonly 56: "https://binance.llamarpc.com";
+    readonly 1088: "https://andromeda.metis.io/?owner=1088";
+    readonly 100: "https://rpc.ankr.com/gnosis";
+    readonly 534352: "https://rpc.scroll.io";
+    readonly 324: "https://mainnet.era.zksync.io";
+    readonly 250: "https://rpc.ftm.tools";
+    readonly 43114: "https://api.avax.network/ext/bc/C/rpc";
+    readonly 59144: "https://rpc.linea.build";
+};
+declare const alchemySupportedChainIds: (1 | 10 | 56 | 100 | 137 | 146 | 250 | 324 | 1101 | 4002 | 5000 | 8453 | 42161 | 42220 | 43113 | 43114 | 59144 | 80002 | 84532 | 421614 | 534351 | 534352 | 11155111 | 11155420 | 1088 | 1666600000)[];
+declare const getNetworkEnv: (chainId: SupportedChainIds) => "RPC_MAINNET" | "RPC_OPTIMISM" | "RPC_FANTOM" | "RPC_CELO" | "RPC_POLYGON" | "RPC_POLYGON_AMOY" | "RPC_AVALANCHE" | "RPC_AVALANCHE_FUJI" | "RPC_ARBITRUM" | "RPC_ARBITRUM_SEPOLIA" | "RPC_FANTOM_TESTNET" | "RPC_OPTIMISM_SEPOLIA" | "RPC_HARMONY" | "RPC_SEPOLIA" | "RPC_SCROLL" | "RPC_SCROLL_SEPOLIA" | "RPC_SONIC" | "RPC_MANTLE" | "RPC_METIS" | "RPC_BASE" | "RPC_BASE_SEPOLIA" | "RPC_BNB" | "RPC_GNOSIS" | "RPC_ZKEVM" | "RPC_ZKSYNC" | "RPC_LINEA";
+declare function getExplicitRPC(chainId: SupportedChainIds): string;
+declare function getAlchemyRPC(chainId: SupportedChainIds, alchemyKey: string): string;
+declare function getPublicRpc(chainId: SupportedChainIds): "https://eth.llamarpc.com" | "https://polygon.llamarpc.com" | "https://base.llamarpc.com" | "https://binance.llamarpc.com" | "https://andromeda.metis.io/?owner=1088" | "https://rpc.ankr.com/gnosis" | "https://rpc.scroll.io" | "https://mainnet.era.zksync.io" | "https://rpc.ftm.tools" | "https://api.avax.network/ext/bc/C/rpc" | "https://rpc.linea.build";
+declare function getQuickNodeRpc(chainId: SupportedChainIds, options: {
+    quicknodeEndpointName: string;
+    quicknodeToken: string;
+}): string;
+type GetRPCUrlOptions = {
+    alchemyKey?: string;
+    quicknodeEndpointName?: string;
+    quicknodeToken?: string;
+};
+/**
+ * Return a RPC_URL for supported chains.
+ * If the RPC_URL environment variable is set, it will be used.
+ * Otherwise will construct the URL based on the chain ID and Alchemy API key.
+ *
+ * @notice This method acts as fall-through and will only revert if the ChainId is strictly not supported.
+ * If no RPC_URL is set, and non of the private rpc providers supports the chain, it will return undefined.
+ * @param chainId
+ * @param alchemyKey
+ * @returns the RPC_URL for the given chain ID
+ */
+declare const getRPCUrl: (chainId: SupportedChainIds, options?: GetRPCUrlOptions) => string | undefined;
+/**
+ * Returns a viem client for the given chain with the supplied config.
+ * @param chainId
+ * @param param1
+ * @returns A viem Client
+ */
+declare function getClient(chainId: number, { httpConfig, clientConfig, providerConfig, forceRebuildClient, }: {
+    httpConfig?: Partial<HttpTransportConfig>;
+    clientConfig?: Partial<ClientConfig>;
+    providerConfig: GetRPCUrlOptions;
+    forceRebuildClient?: boolean;
+}): Client;
+
 declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
 
@@ -387,4 +474,4 @@ declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportPara
     emitter: viem.Address;
 }[]>;
 
-export { EVENT_DB, type ExplorerConfig, type FoundryStorage, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, SelfdestuctCheckState, type Storage, type StorageType, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, foundry_getStandardJsonInput, foundry_getStorageLayout, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNonFinalizedProposals, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, isPayloadFinal, isProposalFinal, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, rayDiv, rayMul, rayToWad, renderTenderlyReport, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };
+export { EVENT_DB, type ExplorerConfig, type FoundryStorage, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, SelfdestuctCheckState, type Storage, type StorageType, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, 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, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, publicRPCs, rayDiv, rayMul, rayToWad, renderTenderlyReport, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
 import * as viem from 'viem';
-import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, Abi } from 'viem';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, HttpTransportConfig, ClientConfig, Abi } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -348,6 +348,93 @@ declare function diffFoundryStorageLayout(layoutBefore: FoundryStorage, layoutAf
 
 declare const EVENT_DB: readonly [];
 
+declare const ChainId: {
+    readonly celo: 42220;
+    readonly mainnet: 1;
+    readonly polygon: 137;
+    readonly polygon_amoy: 80002;
+    readonly avalanche: 43114;
+    readonly avalanche_fuji: 43113;
+    readonly arbitrum: 42161;
+    readonly arbitrum_sepolia: 421614;
+    readonly fantom: 250;
+    readonly fantom_testnet: 4002;
+    readonly optimism: 10;
+    readonly optimism_sepolia: 11155420;
+    readonly harmony: 1666600000;
+    readonly sepolia: 11155111;
+    readonly scroll: 534352;
+    readonly scroll_sepolia: 534351;
+    readonly sonic: 146;
+    readonly mantle: 5000;
+    readonly metis: 1088;
+    readonly base: 8453;
+    readonly base_sepolia: 84532;
+    readonly bnb: 56;
+    readonly gnosis: 100;
+    readonly zkEVM: 1101;
+    readonly zksync: 324;
+    readonly linea: 59144;
+};
+
+type SupportedChainIds = (typeof ChainId)[keyof typeof ChainId];
+/**
+ * A manually maintained list of public rpcs.
+ * These should only be used for prs coming from forks, which should not access secrets like the alchemy api key.
+ */
+declare const publicRPCs: {
+    readonly 1: "https://eth.llamarpc.com";
+    readonly 137: "https://polygon.llamarpc.com";
+    readonly 42161: "https://polygon.llamarpc.com";
+    readonly 8453: "https://base.llamarpc.com";
+    readonly 56: "https://binance.llamarpc.com";
+    readonly 1088: "https://andromeda.metis.io/?owner=1088";
+    readonly 100: "https://rpc.ankr.com/gnosis";
+    readonly 534352: "https://rpc.scroll.io";
+    readonly 324: "https://mainnet.era.zksync.io";
+    readonly 250: "https://rpc.ftm.tools";
+    readonly 43114: "https://api.avax.network/ext/bc/C/rpc";
+    readonly 59144: "https://rpc.linea.build";
+};
+declare const alchemySupportedChainIds: (1 | 10 | 56 | 100 | 137 | 146 | 250 | 324 | 1101 | 4002 | 5000 | 8453 | 42161 | 42220 | 43113 | 43114 | 59144 | 80002 | 84532 | 421614 | 534351 | 534352 | 11155111 | 11155420 | 1088 | 1666600000)[];
+declare const getNetworkEnv: (chainId: SupportedChainIds) => "RPC_MAINNET" | "RPC_OPTIMISM" | "RPC_FANTOM" | "RPC_CELO" | "RPC_POLYGON" | "RPC_POLYGON_AMOY" | "RPC_AVALANCHE" | "RPC_AVALANCHE_FUJI" | "RPC_ARBITRUM" | "RPC_ARBITRUM_SEPOLIA" | "RPC_FANTOM_TESTNET" | "RPC_OPTIMISM_SEPOLIA" | "RPC_HARMONY" | "RPC_SEPOLIA" | "RPC_SCROLL" | "RPC_SCROLL_SEPOLIA" | "RPC_SONIC" | "RPC_MANTLE" | "RPC_METIS" | "RPC_BASE" | "RPC_BASE_SEPOLIA" | "RPC_BNB" | "RPC_GNOSIS" | "RPC_ZKEVM" | "RPC_ZKSYNC" | "RPC_LINEA";
+declare function getExplicitRPC(chainId: SupportedChainIds): string;
+declare function getAlchemyRPC(chainId: SupportedChainIds, alchemyKey: string): string;
+declare function getPublicRpc(chainId: SupportedChainIds): "https://eth.llamarpc.com" | "https://polygon.llamarpc.com" | "https://base.llamarpc.com" | "https://binance.llamarpc.com" | "https://andromeda.metis.io/?owner=1088" | "https://rpc.ankr.com/gnosis" | "https://rpc.scroll.io" | "https://mainnet.era.zksync.io" | "https://rpc.ftm.tools" | "https://api.avax.network/ext/bc/C/rpc" | "https://rpc.linea.build";
+declare function getQuickNodeRpc(chainId: SupportedChainIds, options: {
+    quicknodeEndpointName: string;
+    quicknodeToken: string;
+}): string;
+type GetRPCUrlOptions = {
+    alchemyKey?: string;
+    quicknodeEndpointName?: string;
+    quicknodeToken?: string;
+};
+/**
+ * Return a RPC_URL for supported chains.
+ * If the RPC_URL environment variable is set, it will be used.
+ * Otherwise will construct the URL based on the chain ID and Alchemy API key.
+ *
+ * @notice This method acts as fall-through and will only revert if the ChainId is strictly not supported.
+ * If no RPC_URL is set, and non of the private rpc providers supports the chain, it will return undefined.
+ * @param chainId
+ * @param alchemyKey
+ * @returns the RPC_URL for the given chain ID
+ */
+declare const getRPCUrl: (chainId: SupportedChainIds, options?: GetRPCUrlOptions) => string | undefined;
+/**
+ * Returns a viem client for the given chain with the supplied config.
+ * @param chainId
+ * @param param1
+ * @returns A viem Client
+ */
+declare function getClient(chainId: number, { httpConfig, clientConfig, providerConfig, forceRebuildClient, }: {
+    httpConfig?: Partial<HttpTransportConfig>;
+    clientConfig?: Partial<ClientConfig>;
+    providerConfig: GetRPCUrlOptions;
+    forceRebuildClient?: boolean;
+}): Client;
+
 declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
 
@@ -387,4 +474,4 @@ declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportPara
     emitter: viem.Address;
 }[]>;
 
-export { EVENT_DB, type ExplorerConfig, type FoundryStorage, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, SelfdestuctCheckState, type Storage, type StorageType, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, foundry_getStandardJsonInput, foundry_getStorageLayout, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNonFinalizedProposals, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, isPayloadFinal, isProposalFinal, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, rayDiv, rayMul, rayToWad, renderTenderlyReport, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };
+export { EVENT_DB, type ExplorerConfig, type FoundryStorage, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, SelfdestuctCheckState, type Storage, type StorageType, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, 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, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, publicRPCs, rayDiv, rayMul, rayToWad, renderTenderlyReport, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };