@bgd-labs/toolbox 0.0.8 → 0.0.9

package/dist/index.d.mts

@@ -173,6 +173,10 @@ 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 getPayloadStorageOverrides(client: TestClient, payloadsController: Address, payloadId: number): Promise<{
+    slot: `0x${string}`;
+    value: `0x${string}`;
+}[]>;
 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[]>;
@@ -312,6 +316,49 @@ declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChain
     simulate: (body: object) => Promise<any>;
     delete: () => Promise<Response>;
 }>;
+type StateObject = {
+    balance?: string;
+    code?: string;
+    storage?: Record<Hex, Hex>;
+};
+type ContractObject = {
+    contractName: string;
+    source: string;
+    sourcePath: string;
+    compiler: {
+        name: "solc";
+        version: string;
+    };
+    networks: Record<string, {
+        events?: Record<string, string>;
+        links?: Record<string, string>;
+        address: string;
+        transactionHash?: string;
+    }>;
+};
+type TenderlySimRequest = {
+    network_id: string;
+    block_number?: number;
+    transaction_index?: number;
+    from: Hex;
+    to: Hex;
+    input: Hex;
+    gas?: number;
+    gas_price?: string;
+    value?: string;
+    simulation_type?: "full" | "quick";
+    save?: boolean;
+    save_if_fails?: boolean;
+    state_objects?: Record<Hex, StateObject>;
+    contracts?: ContractObject[];
+    block_header?: {
+        number?: Hex;
+        timestamp?: Hex;
+    };
+    generate_access_list?: boolean;
+    root?: string;
+};
+declare function tenderly_sim({ accountSlug, projectSlug, accessToken }: TenderlyConfig, body: TenderlySimRequest): Promise<any>;
 
 /**
  * Returns the standardJsonInput format as consumed by most explorers
@@ -4945,4 +4992,4 @@ declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportPara
     emitter: viem.Address;
 }[]>;
 
-export { ChainId, ChainList, 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, alchemyNetworkMap, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, etherscanExplorers, 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, quicknodeNetworkMap, rayDiv, rayMul, rayToWad, renderTenderlyReport, routescanExplorers, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };
+export { ChainId, ChainList, type ContractObject, 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 StateObject, type Storage, type StorageType, type TenderlySimRequest, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, alchemyNetworkMap, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, etherscanExplorers, foundry_getStandardJsonInput, foundry_getStorageLayout, getAlchemyRPC, getBits, getClient, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplicitRPC, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNetworkEnv, getNonFinalizedPayloads, getNonFinalizedProposals, getNormalizedDebt, getNormalizedIncome, getPayloadStorageOverrides, getPayloadsController, getPublicRpc, getQuicknodeRpc, getRPCUrl, getSourceCode, isPayloadFinal, isProposalFinal, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, publicRPCs, quicknodeNetworkMap, rayDiv, rayMul, rayToWad, renderTenderlyReport, routescanExplorers, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_sim, tenderly_simVnet, wadDiv, wadToRay };

package/dist/index.d.ts

@@ -173,6 +173,10 @@ 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 getPayloadStorageOverrides(client: TestClient, payloadsController: Address, payloadId: number): Promise<{
+    slot: `0x${string}`;
+    value: `0x${string}`;
+}[]>;
 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[]>;
@@ -312,6 +316,49 @@ declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChain
     simulate: (body: object) => Promise<any>;
     delete: () => Promise<Response>;
 }>;
+type StateObject = {
+    balance?: string;
+    code?: string;
+    storage?: Record<Hex, Hex>;
+};
+type ContractObject = {
+    contractName: string;
+    source: string;
+    sourcePath: string;
+    compiler: {
+        name: "solc";
+        version: string;
+    };
+    networks: Record<string, {
+        events?: Record<string, string>;
+        links?: Record<string, string>;
+        address: string;
+        transactionHash?: string;
+    }>;
+};
+type TenderlySimRequest = {
+    network_id: string;
+    block_number?: number;
+    transaction_index?: number;
+    from: Hex;
+    to: Hex;
+    input: Hex;
+    gas?: number;
+    gas_price?: string;
+    value?: string;
+    simulation_type?: "full" | "quick";
+    save?: boolean;
+    save_if_fails?: boolean;
+    state_objects?: Record<Hex, StateObject>;
+    contracts?: ContractObject[];
+    block_header?: {
+        number?: Hex;
+        timestamp?: Hex;
+    };
+    generate_access_list?: boolean;
+    root?: string;
+};
+declare function tenderly_sim({ accountSlug, projectSlug, accessToken }: TenderlyConfig, body: TenderlySimRequest): Promise<any>;
 
 /**
  * Returns the standardJsonInput format as consumed by most explorers
@@ -4945,4 +4992,4 @@ declare function renderTenderlyReport({ client, sim, }: RenderTenderlyReportPara
     emitter: viem.Address;
 }[]>;
 
-export { ChainId, ChainList, 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, alchemyNetworkMap, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, etherscanExplorers, 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, quicknodeNetworkMap, rayDiv, rayMul, rayToWad, renderTenderlyReport, routescanExplorers, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_simVnet, wadDiv, wadToRay };
+export { ChainId, ChainList, type ContractObject, 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 StateObject, type Storage, type StorageType, type TenderlySimRequest, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, alchemyNetworkMap, alchemySupportedChainIds, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, checkForSelfdestruct, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, diffFoundryStorageLayout, erc1967_AdminSlot, erc1967_ImplementationSlot, etherscanExplorers, foundry_getStandardJsonInput, foundry_getStorageLayout, getAlchemyRPC, getBits, getClient, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplicitRPC, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNetworkEnv, getNonFinalizedPayloads, getNonFinalizedProposals, getNormalizedDebt, getNormalizedIncome, getPayloadStorageOverrides, getPayloadsController, getPublicRpc, getQuicknodeRpc, getRPCUrl, getSourceCode, isPayloadFinal, isProposalFinal, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseEtherscanStyleSourceCode, parseLogs, publicRPCs, quicknodeNetworkMap, rayDiv, rayMul, rayToWad, renderTenderlyReport, routescanExplorers, setBits, tenderly_createVnet, tenderly_deleteVnet, tenderly_getVnet, tenderly_sim, tenderly_simVnet, wadDiv, wadToRay };

package/dist/index.js

@@ -77,6 +77,7 @@ __export(index_exports, {
   getNonFinalizedProposals: () => getNonFinalizedProposals,
   getNormalizedDebt: () => getNormalizedDebt,
   getNormalizedIncome: () => getNormalizedIncome,
+  getPayloadStorageOverrides: () => getPayloadStorageOverrides,
   getPayloadsController: () => getPayloadsController,
   getPublicRpc: () => getPublicRpc,
   getQuicknodeRpc: () => getQuicknodeRpc,
@@ -99,6 +100,7 @@ __export(index_exports, {
   tenderly_createVnet: () => tenderly_createVnet,
   tenderly_deleteVnet: () => tenderly_deleteVnet,
   tenderly_getVnet: () => tenderly_getVnet,
+  tenderly_sim: () => tenderly_sim,
   tenderly_simVnet: () => tenderly_simVnet,
   wadDiv: () => wadDiv,
   wadToRay: () => wadToRay
@@ -1961,28 +1963,43 @@ function getPayloadsController(client, address) {
     address
   });
 }
-async function makePayloadExecutableOnTestClient(client, payloadsController, payloadId) {
+async function getPayloadStorageOverrides(client, payloadsController, payloadId) {
   const controllerContract = getPayloadsController(client, payloadsController);
   const payload = await controllerContract.read.getPayloadById([payloadId]);
   const currentBlock = await (0, import_actions.getBlock)(client);
-  return client.setStorageAt({
-    address: payloadsController,
-    // 3 is the slot of the payloads mapping
-    index: getSolidityStorageSlotUint(3n, BigInt(payloadId)),
-    value: (0, import_viem2.encodePacked)(
-      ["uint40", "uint40", "uint8", "uint8", "address"],
-      [
-        // we subtract 240n(4min), as tenderly might have been fallen behind
-        // therefore using block_number -1 (latest on tenderly) and a 4min margin should give a save margin
-        Number(currentBlock.timestamp - BigInt(payload.delay) - 1n - 240n),
-        // altering queued time so can be executed in current block
-        payload.createdAt,
-        2 /* Queued */,
-        payload.maximumAccessLevelRequired,
-        payload.creator
-      ]
-    )
-  });
+  return [
+    {
+      slot: getSolidityStorageSlotUint(3n, BigInt(payloadId)),
+      value: (0, import_viem2.encodePacked)(
+        ["uint40", "uint40", "uint8", "uint8", "address"],
+        [
+          // we subtract 240n(4min), as tenderly might have been fallen behind
+          // therefore using block_number -1 (latest on tenderly) and a 4min margin should give a save margin
+          Number(currentBlock.timestamp - BigInt(payload.delay) - 1n - 240n),
+          // altering queued time so can be executed in current block
+          payload.createdAt,
+          2 /* Queued */,
+          payload.maximumAccessLevelRequired,
+          payload.creator
+        ]
+      )
+    }
+  ];
+}
+async function makePayloadExecutableOnTestClient(client, payloadsController, payloadId) {
+  const overrides = await getPayloadStorageOverrides(
+    client,
+    payloadsController,
+    payloadId
+  );
+  for (const { slot, value } of overrides) {
+    await client.setStorageAt({
+      address: payloadsController,
+      // 3 is the slot of the payloads mapping
+      index: slot,
+      value
+    });
+  }
 }
 function isPayloadFinal(state) {
   return ![2 /* Queued */, 1 /* Created */].includes(state);
@@ -3098,6 +3115,28 @@ async function tenderly_createVnet({
     })
   };
 }
+async function tenderly_sim({ accountSlug, projectSlug, accessToken }, body) {
+  const response = await fetch(
+    // Note: this is subject to change and currently uses the internal api of tenderly
+    `${TENDERLY_BASE_URL}/account/${accountSlug}/project/${projectSlug}/simulate`,
+    {
+      method: "POST",
+      body: JSON.stringify({
+        generate_access_list: true,
+        save: true,
+        gas_price: "0",
+        gas: 3e7,
+        force_import_contracts: true,
+        ...body
+      }),
+      headers: new Headers({
+        "Content-Type": "application/json",
+        "X-Access-Key": accessToken
+      })
+    }
+  );
+  return response.json();
+}
 
 // src/ecosystem/foundry.ts
 var import_node_child_process = require("child_process");
@@ -3752,6 +3791,7 @@ async function renderTenderlyReport({
   getNonFinalizedProposals,
   getNormalizedDebt,
   getNormalizedIncome,
+  getPayloadStorageOverrides,
   getPayloadsController,
   getPublicRpc,
   getQuicknodeRpc,
@@ -3774,6 +3814,7 @@ async function renderTenderlyReport({
   tenderly_createVnet,
   tenderly_deleteVnet,
   tenderly_getVnet,
+  tenderly_sim,
   tenderly_simVnet,
   wadDiv,
   wadToRay