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-communication): deploy proxy script #2392

Merged
merged 2 commits into from
Mar 29, 2024

Conversation

ChiTimesChi
Copy link
Collaborator

@ChiTimesChi ChiTimesChi commented Mar 29, 2024

Description
Adjusted the names for saved deployment artifacts to follow the naming convention: ContractName.Alias

Summary by CodeRabbit

  • Refactor
    • Updated naming conventions for deployed contract artifacts to be more descriptive.

Copy link
Contributor

coderabbitai bot commented Mar 29, 2024

Walkthrough

The update to the DeployProxy script introduces a refined artifact naming convention for the deployed contracts. This enhancement focuses on making the names of the Proxy and ProxyAdmin artifacts more descriptive, thereby improving clarity and manageability for developers working with these contracts.

Changes

Files Change Summary
.../contracts-communication/script/deploy/DeployProxy.s.sol Updated artifact naming conventions for Proxy and ProxyAdmin to be more descriptive.

🐰✨
In the land of code and mystical keys,
A change was made with the greatest of ease.
Names now clear, as clear as the day,
For Proxy and Admin, in their splendid array.
Let's hop with joy, for clarity's sake,
Our coding journey, a piece of cake.
🥕🎉

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

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 3017119 and c2a911e.
Files selected for processing (1)
  • packages/contracts-communication/script/deploy/DeployProxy.s.sol (2 hunks)
Additional Context Used
Additional comments not posted (2)
packages/contracts-communication/script/deploy/DeployProxy.s.sol (2)

28-31: The deployment and artifact saving process for the TransparentUpgradeableProxy uses a concatenated naming convention TransparentUpgradeableProxy.ContractName. This approach aligns with the PR's objective to standardize naming conventions. However, it's important to ensure that this naming convention is consistently applied across all deployment scripts and artifacts within the project to avoid confusion.

Consider documenting the naming convention in a central location accessible to all team members, such as a project README or developer guidelines document, to ensure consistency and clarity.


44-45: Saving the ProxyAdmin artifact with the naming convention ProxyAdmin.ContractName is a clear and logical approach that enhances the manageability of deployment artifacts. This change effectively addresses the PR's objective of standardizing artifact naming conventions.

Ensure that the naming convention for ProxyAdmin artifacts is consistently applied and documented across the project, similar to the TransparentUpgradeableProxy artifacts.

Copy link

codecov bot commented Mar 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.93892%. Comparing base (a01d39d) to head (c2a911e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@              Coverage Diff              @@
##              master       #2392   +/-   ##
=============================================
  Coverage   46.93892%   46.93892%           
=============================================
  Files            383         383           
  Lines          29189       29189           
  Branches          83          83           
=============================================
  Hits           13701       13701           
  Misses         14032       14032           
  Partials        1456        1456           
Flag Coverage Δ
packages 90.62500% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: c2a911e
Status: ✅  Deploy successful!
Preview URL: https://59f7e5e0.sanguine-fe.pages.dev
Branch Preview URL: https://fix-deploy-proxy-script.sanguine-fe.pages.dev

View logs

@ChiTimesChi ChiTimesChi merged commit 46b38a6 into master Mar 29, 2024
37 checks passed
@ChiTimesChi ChiTimesChi deleted the fix/deploy-proxy-script branch March 29, 2024 16:43
ChiTimesChi added a commit that referenced this pull request Mar 29, 2024
aureliusbtc added a commit that referenced this pull request Mar 29, 2024
* v3 SIN testnet deployment

* Chore: rename to comply with #2392

* Chore: `forge fmt`

---------

Co-authored-by: ChiTimesChi <88190723+ChiTimesChi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant