Skip to content

refactor(test): improve L1ERC721Bridge test structure and documentation#15596

Closed
aliersh wants to merge 1 commit intoethereum-optimism:developfrom
aliersh:ari/l1erc721bridge-test-refactor
Closed

refactor(test): improve L1ERC721Bridge test structure and documentation#15596
aliersh wants to merge 1 commit intoethereum-optimism:developfrom
aliersh:ari/l1erc721bridge-test-refactor

Conversation

@aliersh
Copy link
Contributor

@aliersh aliersh commented Apr 28, 2025

  • Group all tests by their corresponding contract functions
  • Rename test to test_finalizeBridgeERC721_paused_reverts for consistency
  • Move test_finalizeBridgeERC721_paused_reverts to L1ERC721Bridge_finalizeBridgeERC721_Test
  • Convert @dev to @notice tags where appropriate
  • Enforce 100 character line length limit for comments

…ation

- Group all tests by their corresponding contract functions
- Rename test to test_finalizeBridgeERC721_paused_reverts for consistency
- Move test_finalizeBridgeERC721_paused_reverts to L1ERC721Bridge_finalizeBridgeERC721_Test
- Convert @dev to @notice tags where appropriate
- Enforce 100 character line length limit for comments
@aliersh aliersh requested a review from a team as a code owner April 28, 2025 19:55
@aliersh aliersh requested a review from mbaxter April 28, 2025 19:55
@aliersh
Copy link
Contributor Author

aliersh commented Apr 28, 2025

Some considerations:

  • Kept L1ERC721Bridge_TestERC721 as-is
  • Integrated the setup for test_finalizeBridgeERC721_paused_reverts directly inside the test itself
  • Noted that tests inside contract L1ERC721Bridge_TestERC721 should belong to a universal ERC721Bridge test file, since they are directly testing functions from universal/ERC721Bridge.sol

@aliersh aliersh changed the title refactor(tests): reorganize L1ERC721Bridge tests and improve document… refactor(test): improve L1ERC721Bridge test structure and documentation Apr 30, 2025
Comment on lines +242 to +243
/// @dev AD: This contract should be in a universal ERC721Bridge test file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment appears to be a personal note that should be removed or properly documented. If it's meant to indicate that the L1ERC721Bridge_Test contract should be moved to a universal test file, consider converting this to a proper @notice tag as per the PR's goal of converting @dev tags to @notice where appropriate.

Suggested change
/// @dev AD: This contract should be in a universal ERC721Bridge test file.
/// @dev This contract should be in a universal ERC721Bridge test file.

Spotted by Diamond (based on custom rules)

Is this helpful? React 👍 or 👎 to let us know.

@aliersh
Copy link
Contributor Author

aliersh commented May 6, 2025

Replaced by #15735. Rebuilt from latest develop for cleaner diff and easier review.

@aliersh aliersh closed this May 6, 2025
@aliersh aliersh deleted the ari/l1erc721bridge-test-refactor branch May 21, 2025 16:42
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.

1 participant