fix(core): set simulation transaction limit less than block gas limit

.changeset/fluffy-phones-build.md

@@ -0,0 +1,6 @@
+---
+'@sphinx-labs/plugins': patch
+'@sphinx-labs/core': patch
+---
+
+Set transaction gas limit lower than block gas limit in simulation

packages/core/src/utils.ts

@@ -168,13 +168,20 @@ export const getGasPriceOverrides = async (
   }
 
   if (!isLiveNetwork_) {
-    // Hard-code the gas limit to be the block gas limit. This is an optimization that significantly
-    // speeds up deployments on local networks because it removes the need for EthersJS to call
-    // `eth_estimateGas`, which is a very slow operation for large transactions. We don't override
-    // this on live networks because the signer is the user's wallet, which may have a limited
-    // amount of ETH. It's fine to set a very high gas limit on local networks because we use an
-    // auto-generated wallet to execute the transactions.
-    overridden.gasLimit = block.gasLimit
+    // Hard-code the gas limit to be the 3/4 of the block gas limit. This is an optimization that
+    // significantly speeds up deployments on local networks because it removes the need for
+    // EthersJS to call `eth_estimateGas`, which is a very slow operation for large transactions. We
+    // don't override this on live networks because the signer is the user's wallet, which may have
+    // a limited amount of ETH. It's fine to set a very high gas limit on local networks because we
+    // use an auto-generated wallet to execute the transactions. We set it to 3/4 of the block gas
+    // limit for two reasons:
+    // 1. This value is considerably higher than the max batch size for `EXECUTE` Merkle leaves,
+    //    which ensures that we don't accidentally underfund the transaction.
+    // 2. This value is considerably lower than the block gas limit. If, instead, we set this value
+    //    equal to the current block gas limit, a situation could occur where the block gas limit
+    //    decreases slightly after we set this value, which would cause an error due to the fact
+    //    that the transaction's gas limit exceeds the block gas limit.
+    overridden.gasLimit = (BigInt(3) * block.gasLimit) / BigInt(4)
     return overridden
   }
 

packages/plugins/src/hardhat/simulate.ts

@@ -137,7 +137,9 @@ export const simulate = async (
 
   if (code !== 0) {
     const networkName = getNetworkNameForChainId(BigInt(chainId))
-    throw new Error(`Simulation failed for ${networkName}: ${stderr}`)
+    throw new Error(
+      `Simulation failed for ${networkName} at block number ${block.number}. Reason:\n${stderr}`
+    )
   }
 
   const receipts = JSON.parse(stdout).receipts