@bgd-labs/toolbox 0.0.2 → 0.0.4

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
-import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient } from 'viem';
+import * as viem from 'viem';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, Abi } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -170,6 +171,7 @@ declare const HUMAN_READABLE_PAYLOAD_STATE: {
 type PayloadsControllerContract = GetContractReturnType<typeof IPayloadsControllerCore_ABI, Client>;
 declare function getPayloadsController<T extends Client>(client: T, address: Hex): PayloadsControllerContract;
 declare function makePayloadExecutableOnTestClient(client: TestClient, payloadsController: Address, payloadId: number): Promise<void>;
+declare function isPayloadFinal(state: PayloadState): boolean;
 declare function getNonFinalizedPayloads<T extends Client>(client: T, payloadsController: Address): Promise<number[]>;
 
 declare enum ProposalState {
@@ -195,6 +197,23 @@ declare const HUMAN_READABLE_PROPOSAL_STATE: {
 type GovernanceContract = GetContractReturnType<typeof IGovernanceCore_ABI, Client>;
 declare function getGovernance<T extends Client>(client: T, address: Hex): GovernanceContract;
 declare function makeProposalExecutableOnTestClient(client: TestClient, governance: Address, proposalId: bigint): Promise<void>;
+declare function isProposalFinal(state: ProposalState): boolean;
+declare function getNonFinalizedProposals<T extends Client>(client: T, governanceAddress: Address): Promise<bigint[]>;
+
+type StandardJsonInput = {
+    language: string;
+    libraries: any;
+    settings: {
+        evmVersion: string;
+        optimizer: {
+            enabled: boolean;
+            runs: number;
+        };
+    };
+    sources: Record<string, {
+        content: string;
+    }>;
+};
 
 type ExplorerConfig = {
     api: string;
@@ -230,20 +249,7 @@ declare function getSourceCode(params: GetSourceCodeParams): Promise<{
     SimilarMatch: string;
     SourceCode: string;
 }>;
-declare function parseApiSourceCode(sourceCode: string): {
-    language: string;
-    libraries: any;
-    settings: {
-        evmVersion: string;
-        optimizer: {
-            enabled: boolean;
-            runs: number;
-        };
-    };
-    sources: Record<string, {
-        content: string;
-    }>;
-};
+declare function parseEtherscanStyleSourceCode(sourceCode: string): StandardJsonInput;
 
 /**
  * While tenderly is a fenomanal tool for testing, it is not always easy to use as there are minor bugs and small nuances to consider everywhere.
@@ -261,6 +267,7 @@ type Tenderly_createVnetParams = {
     baseChainId: number;
     forkChainId: number;
     blockNumber?: Hex;
+    force?: boolean;
 };
 type Tenderly_createVnetParamsResponse = {
     id: string;
@@ -289,17 +296,95 @@ type Tenderly_createVnetParamsResponse = {
         }
     ];
 };
-declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
+declare function tenderly_deleteVnet(vnetId: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig): Promise<Response>;
+declare function tenderly_simVnet(vnetId: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig, body: any): Promise<any>;
+declare function tenderly_getVnet(slug: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig): Promise<{
+    id: string;
+    slug: string;
+}[]>;
+declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, force, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
     vnet: Tenderly_createVnetParamsResponse;
     testClient: TestClient;
     walletClient: WalletClient;
-    simulate: (body: any) => Promise<Response>;
+    simulate: (body: any) => Promise<any>;
     delete: () => Promise<Response>;
 }>;
 
+/**
+ * Returns the standardJsonInput format as consumed by most explorers
+ * @param input Contract or path:Contract if contract is not unique.
+ */
+declare function foundry_getStandardJsonInput(input: string): StandardJsonInput;
+type Storage = {
+    astId: string;
+    contract: string;
+    label: string;
+    offset: number;
+    slot: number;
+    type: string;
+};
+type StorageType = {
+    encoding: string;
+    label: string;
+    numberOfBytes: number;
+    base?: string;
+    key?: string;
+    value?: string;
+    members?: {
+        astId: string;
+        contract: string;
+        offset: number;
+        slot: number;
+        type: string;
+        label: string;
+    }[];
+};
+type FoundryStorage = {
+    storage: Storage[];
+    types: Record<string, StorageType>;
+};
+declare function foundry_getStorageLayout(input: string): FoundryStorage;
+declare function diffFoundryStorageLayout(layoutBefore: FoundryStorage, layoutAfter: FoundryStorage): string;
+
+declare const EVENT_DB: readonly [];
+
 declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
 
-declare function diffCode(codeBefore: string, codeAfter: string): Promise<Record<string, string>>;
+declare function diffCode(before: StandardJsonInput, after: StandardJsonInput): Promise<Record<string, string>>;
+
+type LogType = {
+    topics: [Hex];
+    data: Hex;
+    emitter: Address;
+};
+interface ParseLogsArgs {
+    logs: LogType[];
+    eventDb: Abi;
+}
+declare function parseLogs({ logs, eventDb }: ParseLogsArgs): LogType[];
+
+declare enum SelfdestuctCheckState {
+    TRUSTED = 0,
+    EOA = 1,
+    EMPTY = 2,
+    DELEGATECALL = 3,
+    SAFE = 4,
+    SELF_DESTRUCT = 5
+}
+declare function checkForSelfdestruct(client: Client, addresses: Address[], trustedAddresses: Address[]): Promise<{
+    address: Address;
+    state: SelfdestuctCheckState;
+}[]>;
+
+type RenderTenderlyReportParams = {
+    client: Client;
+    sim: any;
+};
+declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportParams): Promise<{
+    topics: [viem.Hex];
+    data: viem.Hex;
+    emitter: viem.Address;
+}[]>;
 
-export { type ExplorerConfig, 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, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, erc1967_AdminSlot, erc1967_ImplementationSlot, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseApiSourceCode, rayDiv, rayMul, rayToWad, setBits, tenderly_createVnet, 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, 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 };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
-import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient } from 'viem';
+import * as viem from 'viem';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient, Abi } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -170,6 +171,7 @@ declare const HUMAN_READABLE_PAYLOAD_STATE: {
 type PayloadsControllerContract = GetContractReturnType<typeof IPayloadsControllerCore_ABI, Client>;
 declare function getPayloadsController<T extends Client>(client: T, address: Hex): PayloadsControllerContract;
 declare function makePayloadExecutableOnTestClient(client: TestClient, payloadsController: Address, payloadId: number): Promise<void>;
+declare function isPayloadFinal(state: PayloadState): boolean;
 declare function getNonFinalizedPayloads<T extends Client>(client: T, payloadsController: Address): Promise<number[]>;
 
 declare enum ProposalState {
@@ -195,6 +197,23 @@ declare const HUMAN_READABLE_PROPOSAL_STATE: {
 type GovernanceContract = GetContractReturnType<typeof IGovernanceCore_ABI, Client>;
 declare function getGovernance<T extends Client>(client: T, address: Hex): GovernanceContract;
 declare function makeProposalExecutableOnTestClient(client: TestClient, governance: Address, proposalId: bigint): Promise<void>;
+declare function isProposalFinal(state: ProposalState): boolean;
+declare function getNonFinalizedProposals<T extends Client>(client: T, governanceAddress: Address): Promise<bigint[]>;
+
+type StandardJsonInput = {
+    language: string;
+    libraries: any;
+    settings: {
+        evmVersion: string;
+        optimizer: {
+            enabled: boolean;
+            runs: number;
+        };
+    };
+    sources: Record<string, {
+        content: string;
+    }>;
+};
 
 type ExplorerConfig = {
     api: string;
@@ -230,20 +249,7 @@ declare function getSourceCode(params: GetSourceCodeParams): Promise<{
     SimilarMatch: string;
     SourceCode: string;
 }>;
-declare function parseApiSourceCode(sourceCode: string): {
-    language: string;
-    libraries: any;
-    settings: {
-        evmVersion: string;
-        optimizer: {
-            enabled: boolean;
-            runs: number;
-        };
-    };
-    sources: Record<string, {
-        content: string;
-    }>;
-};
+declare function parseEtherscanStyleSourceCode(sourceCode: string): StandardJsonInput;
 
 /**
  * While tenderly is a fenomanal tool for testing, it is not always easy to use as there are minor bugs and small nuances to consider everywhere.
@@ -261,6 +267,7 @@ type Tenderly_createVnetParams = {
     baseChainId: number;
     forkChainId: number;
     blockNumber?: Hex;
+    force?: boolean;
 };
 type Tenderly_createVnetParamsResponse = {
     id: string;
@@ -289,17 +296,95 @@ type Tenderly_createVnetParamsResponse = {
         }
     ];
 };
-declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
+declare function tenderly_deleteVnet(vnetId: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig): Promise<Response>;
+declare function tenderly_simVnet(vnetId: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig, body: any): Promise<any>;
+declare function tenderly_getVnet(slug: string, { accountSlug, projectSlug, accessToken }: TenderlyConfig): Promise<{
+    id: string;
+    slug: string;
+}[]>;
+declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, force, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
     vnet: Tenderly_createVnetParamsResponse;
     testClient: TestClient;
     walletClient: WalletClient;
-    simulate: (body: any) => Promise<Response>;
+    simulate: (body: any) => Promise<any>;
     delete: () => Promise<Response>;
 }>;
 
+/**
+ * Returns the standardJsonInput format as consumed by most explorers
+ * @param input Contract or path:Contract if contract is not unique.
+ */
+declare function foundry_getStandardJsonInput(input: string): StandardJsonInput;
+type Storage = {
+    astId: string;
+    contract: string;
+    label: string;
+    offset: number;
+    slot: number;
+    type: string;
+};
+type StorageType = {
+    encoding: string;
+    label: string;
+    numberOfBytes: number;
+    base?: string;
+    key?: string;
+    value?: string;
+    members?: {
+        astId: string;
+        contract: string;
+        offset: number;
+        slot: number;
+        type: string;
+        label: string;
+    }[];
+};
+type FoundryStorage = {
+    storage: Storage[];
+    types: Record<string, StorageType>;
+};
+declare function foundry_getStorageLayout(input: string): FoundryStorage;
+declare function diffFoundryStorageLayout(layoutBefore: FoundryStorage, layoutAfter: FoundryStorage): string;
+
+declare const EVENT_DB: readonly [];
+
 declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
 
-declare function diffCode(codeBefore: string, codeAfter: string): Promise<Record<string, string>>;
+declare function diffCode(before: StandardJsonInput, after: StandardJsonInput): Promise<Record<string, string>>;
+
+type LogType = {
+    topics: [Hex];
+    data: Hex;
+    emitter: Address;
+};
+interface ParseLogsArgs {
+    logs: LogType[];
+    eventDb: Abi;
+}
+declare function parseLogs({ logs, eventDb }: ParseLogsArgs): LogType[];
+
+declare enum SelfdestuctCheckState {
+    TRUSTED = 0,
+    EOA = 1,
+    EMPTY = 2,
+    DELEGATECALL = 3,
+    SAFE = 4,
+    SELF_DESTRUCT = 5
+}
+declare function checkForSelfdestruct(client: Client, addresses: Address[], trustedAddresses: Address[]): Promise<{
+    address: Address;
+    state: SelfdestuctCheckState;
+}[]>;
+
+type RenderTenderlyReportParams = {
+    client: Client;
+    sim: any;
+};
+declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportParams): Promise<{
+    topics: [viem.Hex];
+    data: viem.Hex;
+    emitter: viem.Address;
+}[]>;
 
-export { type ExplorerConfig, 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, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, erc1967_AdminSlot, erc1967_ImplementationSlot, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseApiSourceCode, rayDiv, rayMul, rayToWad, setBits, tenderly_createVnet, 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, 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 };