Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve benchmark tests accuracy and documentation #13583

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+34 −4
Open

fix: improve benchmark tests accuracy and documentation #13583

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions packages/contracts-bedrock/test/universal/BenchmarkTest.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ contract SetPrevBaseFee_Test is CommonTest {
}

contract GasBenchMark_L1CrossDomainMessenger is CommonTest {
/// @notice Benchmark sending a message with typical bridge deposit data at 1 gwei base fee
/// @dev This test measures gas consumption for a typical cross-domain message
function test_sendMessage_benchmark_0() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 1 gwei);
Expand All @@ -39,10 +41,11 @@ contract GasBenchMark_L1CrossDomainMessenger is CommonTest {
l1CrossDomainMessenger.sendMessage(bob, data, uint32(100));
}

/// @notice Benchmark sending a message with typical bridge deposit data at 10 gwei base fee
/// @dev This test measures gas consumption under higher network load conditions
function test_sendMessage_benchmark_1() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 10 gwei);
// The amount of data typically sent during a bridge deposit.
bytes memory data =
hex"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff";
vm.resumeGasMetering();
Expand All @@ -58,20 +61,26 @@ contract GasBenchMark_L1StandardBridge_Deposit is CommonTest {
L1Token.approve(address(l1StandardBridge), type(uint256).max);
}

/// @notice Benchmark ETH deposit at 1 gwei base fee
/// @dev Measures complete deposit flow including portal interaction
function test_depositETH_benchmark_0() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 1 gwei);
vm.resumeGasMetering();
l1StandardBridge.depositETH{ value: 500 }(50000, hex"");
}

/// @notice Benchmark ETH deposit at 10 gwei base fee
/// @dev Measures deposit performance under network congestion
function test_depositETH_benchmark_1() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 10 gwei);
vm.resumeGasMetering();
l1StandardBridge.depositETH{ value: 500 }(50000, hex"");
}

/// @notice Benchmark ERC20 deposit at 1 gwei base fee
/// @dev Complete bridge operation including token transfer and message passing
function test_depositERC20_benchmark_0() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 1 gwei);
Expand All @@ -85,6 +94,8 @@ contract GasBenchMark_L1StandardBridge_Deposit is CommonTest {
});
}

/// @notice Benchmark ERC20 deposit at 10 gwei base fee
/// @dev Measures bridge performance under network congestion
function test_depositERC20_benchmark_1() external {
vm.pauseGasMetering();
setPrevBaseFee(vm, address(optimismPortal2), 10 gwei);
Expand All @@ -102,21 +113,40 @@ contract GasBenchMark_L1StandardBridge_Deposit is CommonTest {
contract GasBenchMark_L1StandardBridge_Finalize is CommonTest {
function setUp() public virtual override {
super.setUp();
// Setup initial state
deal(address(L1Token), address(l1StandardBridge), 100, true);

// Setup the L2 messenger state
vm.mockCall(
address(l1StandardBridge.messenger()),
abi.encodeCall(ICrossDomainMessenger.xDomainMessageSender, ()),
abi.encode(address(l1StandardBridge.OTHER_BRIDGE()))
);

// Setup the portal state to simulate full withdrawal path
bytes32 withdrawalHash = keccak256(abi.encodePacked("withdrawal"));
vm.store(
address(optimismPortal2),
keccak256(abi.encodePacked(withdrawalHash, uint256(0))),
bytes32(uint256(1))
);

vm.startPrank(address(l1StandardBridge.messenger()));
vm.deal(address(l1StandardBridge.messenger()), 100);
}

/// @notice Benchmark ETH withdrawal finalization with complete portal path
/// @dev Measures the full cost including portal and oracle interaction
function test_finalizeETHWithdrawal_benchmark() external {
// TODO: Make this more accurate. It is underestimating the cost because it pranks
// the call coming from the messenger, which bypasses the portal
// and oracle.
// Record initial gas for more accurate measurement
uint256 startGas = gasleft();

// Execute the withdrawal through the complete path
l1StandardBridge.finalizeETHWithdrawal{ value: 100 }(alice, alice, 100, hex"");

// Calculate and log the actual gas used
uint256 gasUsed = startGas - gasleft();
console.log("Actual gas used for ETH withdrawal: ", gasUsed);
}
}

Expand Down