ctb: Break out Safe deployment from configuration

[maurelian]

TL;DR

This Pull Request breaks down the 'DeployOwnership' script into clearer and more purposeful functions.

What changed?

The deployAndConfigureFoundationSafe and deployAndConfigureSecurityCouncilSafe functions are split into separate functions for deploying and configuring the safes.
This allows for a clearer understanding of the steps taken during the deployment process.

How to test?

This is tested by DeployOwnership.t.sol.

Why make this change?

This refactoring improves the code readability and maintainability by separating the deployment process into distinct stages.

[maurelian]

• ctb: Add removeDeployerFromSafe method to deploy scripts #10620
• ctb: Add Guardian Safe to ownership deployment #10616
• ctb: Break out Safe deployment from configuration #10615 👈
• develop

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @maurelian and the rest of your teammates on Graphite

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.22%. Comparing base (a00d387) to head (8dec833).
Report is 4 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop   #10615       +/-   ##
============================================
- Coverage    42.36%   29.22%   -13.15%     
============================================
  Files           73       31       -42     
  Lines         4836     2898     -1938     
  Branches       766      614      -152     
============================================
- Hits          2049      847     -1202     
+ Misses        2680     1976      -704     
+ Partials       107       75       -32     

Flag	Coverage Δ
cannon-go-tests	?
chain-mon-tests	27.14% <ø> (ø)
common-ts-tests	?
contracts-ts-tests	12.25% <ø> (ø)
core-utils-tests	?
sdk-tests	40.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 42 files with indirect coverage changes

[coderabbitai]

Walkthrough

Walkthrough

The recent update focuses on enhancing the deployment and configuration processes for various modules like the Foundation Safe, Security Council Safe, Deputy Guardian Module, and Liveness Module in DeployOwnership.s.sol. The code has been refactored for clarity and separation of concerns, ensuring distinct and manageable deployment and configuration steps.

Changes

File Path	Change Summary
packages/contracts-bedrock/scripts/DeployOwnership.s.sol	Restructured deployment and configuration functions for various modules. Added new configuration functions and updated return types.
.../DeployOwnership.s.sol	Updated LivenessModuleConfig, DeputyGuardianModuleConfig, and SecurityCouncilConfig structs with configuration notices. Renamed deployment functions for Foundation Safe and Security Council Safe with return type modifications. Added configureSecurityCouncilSafe function for Security Council Safe configuration.

---

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5c7a50d and 8dec833.

Files selected for processing (1)

• packages/contracts-bedrock/scripts/DeployOwnership.s.sol (4 hunks)

Files skipped from review as they are similar to previous changes (1)

• packages/contracts-bedrock/scripts/DeployOwnership.s.sol

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[semgrep-app]

Semgrep found 1 todos_require_linear finding:

• packages/core-utils/src/common/bn.ts
  • L17 - Triage

Please create a GitHub ticket for this TODO.

_{Ignore this finding from todos_require_linear.}