seolaoh commented 3 weeks ago

Description

Since we use Ownable2Step contract to set the owner of GovernanceToken and MintManager, the new owner should accept the ownership. The purpose is to reduce human error, so I thought it is more appropriate to follow this step when deploying the contracts via deploy script. So the deploy step is changed like below.

Deploy Process

deploy L1GovernanceTokenProxy contract
deploy L1MintManager contract
- mintManagerOwner is set as pendingOwner of L1MintManager
deploy L1GovernanceToken contract, upgrade proxy, and initialize
- L1MintManager is set as pendingOwner of L1GovernanceToken
- mintManagerOwner is set as admin of L1GovernanceTokenProxy
call L1MintManager.acceptOwnership(), L1MintManager.acceptOwnershipOfToken() by mintManagerOwner > confirm ownership transfer of L1MintManager, L1GovernanceToken
change admin of L1GovernanceTokenProxy to zero address by mintManagerOwner

Test Transactions on Holesky

coderabbitai[bot] commented 3 weeks ago

Walkthrough

This update introduces various enhancements and modifications across multiple files in the Kroma project. Key changes include updates to storage layout definitions and hexadecimal values, deployment of tokens and mint managers, adjustments to gas costs in tests, and additions of new ownership transfer mechanisms. The modifications ensure more accurate handling of recipients during token distribution and introduce new events for consistent state tracking. The assertion checks during deployment have been adjusted accordingly.

Changes

Files/Directories	Change Summaries
`kroma-bindings/bindings/mintmanager_more.go`	Updated `MintManagerStorageLayoutJSON` and `MintManagerDeployedBin` constants.
`op-e2e/e2eutils/setup.go`	Added deployment, ownership acceptance, proxy upgrade, initialization, and distribution functionalities for `L1MintManager` and `GovernanceToken`.
`packages/contracts/.gas-snapshot`	Adjusted gas costs in various tests within `GovernanceToken_Test` and `MintManagerTest` classes.
`packages/contracts/.storage-layout`	Added `_pendingOwner` field in `GovernanceToken` and `MintManager` classes, affecting storage slots and offsets.
`packages/contracts/contracts/governance/GovernanceToken.sol`	Updated contract inheritance to `Ownable2StepUpgradeable`, removed `ERC20Burnable`, and added `Mint` and `Burn` events.
`packages/contracts/contracts/governance/MintManager.sol`	Switched to `Ownable2Step`, added token distribution logic with recipient shares, and ownership management functions.
`packages/contracts/contracts/test/GovernanceToken.t.sol`	Added `Mint` and `Burn` events, updated setup and test functions to include additional assertions and ownership changes.
`packages/contracts/contracts/test/KromaVestingWallet.t.sol`	Added function calls `vm.prank(tokenOwner)` and `token.acceptOwnership()` before `token.mint()`.
`packages/contracts/contracts/test/MintManager.t.sol`	Added owner and pending owner checks, logic for ownership transfer and acceptance, and additional success and revert tests.
`packages/contracts/deploy/.../018-L1MintManager.ts`	Renamed contract variable from `'owner'` to `'pendingOwner'` in `deployFn` function.
`packages/contracts/deploy/.../019-L1GovernanceToken.ts`	Modified assertion check from `'owner'` to `'pendingOwner'` in `assertContractVariable` function.
`packages/contracts/deploy/.../012-MintManager.ts`	Renamed contract variable from `'owner'` to `'pendingOwner'`.
`packages/contracts/deploy/.../013-GovernanceToken.ts`	Modified contract variable assertion from `'owner'` to `'pendingOwner'` in `deployFn` function.

[!TIP]

Early access features: enabled
We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

0xHansLee commented 2 weeks ago

Could you update the scenario for deployments you wrote in confluence?

seolaoh commented 2 weeks ago

Could you update the scenario for deployments you wrote in confluence?

I already updated it.

0xHansLee commented 2 weeks ago

Should this PR be merged to dev directly?