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-L06 Initialization Performed Outside of Initialization Function #652

Conversation

zimpha
Copy link
Member

@zimpha zimpha commented Jul 17, 2023

Purpose or design rationale of this PR

This PR fix the bug (L-06 Initialization Performed Outside of Initialization Function) reported by OpenZeppelin. The following are the details:

The updateMessenger function in L2MessageQueue can only be called before any message is appended, otherwise it will revert since nextMessageIndex is sequentially increased. Therefore, the updateMessenger logic aligns closer with the purpose of the initialize function, rather than a standalone function.

Consider moving the logic of updateMessenger into the initialize function with the onlyOwner modifier. This can be done since the predeployed contracts should exist before L2ScrollMessenger.

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 7ff47bd during Contracts #1178

Summary coverage rate:
  lines......: 52.2% (894 of 1712 lines)
  functions..: 69.8% (203 of 291 functions)
  branches...: no data found

Files changed coverage rate: n/a

Thegaram
Thegaram previously approved these changes Jul 24, 2023
@icemelon
Copy link
Member

I have a question. Will we ever possibly change the L2ScrollMessenger contract address and need to update it in the L2MessageQueue? @zimpha

@zimpha
Copy link
Member Author

zimpha commented Jul 25, 2023

I have a question. Will we ever possibly change the L2ScrollMessenger contract address and need to update it in the L2MessageQueue? @zimpha

We won't update it in normal situation unless we have a very big breaking change. In such case, we can deploy another L2MessageQueue.

@icemelon icemelon merged commit 3832422 into develop Jul 25, 2023
3 checks passed
@icemelon icemelon deleted the fix/initialization_performed_outside_of_initialization_function branch July 25, 2023 17:24
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