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.

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

chore(protocol): enhancements to simulation setup and execution documentation #16068

Merged
merged 8 commits into from
Feb 27, 2024

Conversation

NaijaCoderGirl
Copy link
Contributor

Summary

I've fixed the simulation forge command in package.json and restructured the protocol simulations README to improve the experience when following the commands to simulate and test the protocol.

Key Changes

  • Commit 4fd3a2e modifies the export:simconf script in package.json to target the test_L2_NoFeeCheck_simulation test rather than the previously referenced test_simulation. This adjustment aligns with the updates from PR feat(protocol)!: re-implement multi-hop bridging with optional caching #15761, which introduced the test_L2_NoFeeCheck_simulation tests while removing the test_simulation.

  • Commit 7d8c60c updates the README.md in the packages/protocol/simulation directory. The new README layout offers a clear, step-by-step guide for setting up the simulation environment, including a reminder to run foundryup for updating Foundry tools, which is a step I found necessary during the process.

Rationale for Updates

The motivation behind these changes is to address the issue with the current command forge test --match-test 'test_simulation' -vv > simulation/out/simconf_$(date +%s).txt" failing due to the removal of test_simulation tests from packages/protocol/test/L2/TaikoL2.t.sol. This was notably changed in this commit, while the introduction of test_L2_NoFeeCheck_simulation tests occurred in another commit, leading to the need t o update it.

Testing:

After fixing the command in package.json, I generated PNG images of the simulation to visually verify the outcomes. The images named <timestamp>_above_average_traffic.png, <timestamp>_below_average_traffic.png, and <timestamp>_target_traffic.png illustrate the simulation results under various traffic conditions.

@dantaik dantaik added this pull request to the merge queue Feb 27, 2024
Merged via the queue into taikoxyz:main with commit b206047 Feb 27, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants