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

fix(contracts): OZ-L2-L05 Lack of Event Emissions #650

Merged
merged 3 commits into from Jul 24, 2023

Conversation

zimpha
Copy link
Member

@zimpha zimpha commented Jul 17, 2023

Purpose or design rationale of this PR

This PR fix the bug (L-05 Lack of Event Emissions) reported by OpenZeppelin. The following are the details:

Throughout the codebase, several instances were identified where events should be emitted.

  • When Whitelist is deployed, the owner is set by the constructor. Because owner is not set using _transferOwnership , the OwnershipTransferred event is not emitted.
  • The updateMessenger function does not emit an event upon the successful update of the L2ScrollMessenger address.
  • The L2GatewayRouter does not emit an event when setting defaultERC20Gateway in the initialize function.

Consider emitting the OwnershipTransferred event, as well as an event when the address of the L2ScrollMessenger gets updated on the L2MessageQueue contract. Furthermore, consider emitting the SetERC20Gateway event when the L2GatewayRouter is initialized. Emitting events provides a way for external integrations to track changes being made to the contract configuration by external integrations. This is especially important for monitoring operations and proper incident response, particularly with regard to trusted entities with special privileges.

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

@zimpha zimpha added the bug Something isn't working label Jul 17, 2023
@zimpha zimpha self-assigned this Jul 17, 2023
@github-actions
Copy link

github-actions bot commented Jul 17, 2023

LCOV of commit b3c3afa during Contracts #1167

Summary coverage rate:
  lines......: 52.1% (894 of 1715 lines)
  functions..: 69.5% (203 of 292 functions)
  branches...: no data found

Files changed coverage rate: n/a

@HAOYUatHZ HAOYUatHZ merged commit 2bd9694 into develop Jul 24, 2023
3 checks passed
@HAOYUatHZ HAOYUatHZ deleted the fix/lack_of_event_emissions branch July 24, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants