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): not upgrade already deployed contract #371

Merged
merged 1 commit into from
Aug 8, 2024

Conversation

seolaoh
Copy link
Contributor

@seolaoh seolaoh commented Aug 2, 2024

Description

There was a bug in this change, so I fixed it. If the contract is not deployed newly, skip upgrading the proxy contract.

@seolaoh seolaoh self-assigned this Aug 2, 2024
@seolaoh seolaoh requested a review from a team as a code owner August 2, 2024 08:58
Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent changes to the deploy-utils.ts file enhance the deployment functionality by modifying the return types of the deploy and deployAndUpgradeByDeployer functions. The deployImpl function now returns a tuple that includes a contract object and a boolean indicating whether it was newly deployed. These adjustments streamline control flow and improve clarity in handling contract deployment scenarios.

Changes

File Change Summary
packages/contracts/src/deploy-utils.ts Modified return types for deploy and deployAndUpgradeByDeployer to `Promise<Contract

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeployUtils
    participant Contract

    User->>DeployUtils: deploy(name, opts)
    DeployUtils->>DeployUtils: deployImpl(hre, name, opts)
    DeployUtils->>Contract: Deploy contract
    Contract-->>DeployUtils: (contract, newlyDeployed)
    DeployUtils-->>User: return contract (if newlyDeployed)
Loading

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 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 Configuration 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.

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 details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ec4403 and c462f07.

Files selected for processing (1)
  • packages/contracts/src/deploy-utils.ts (5 hunks)
Additional comments not posted (3)
packages/contracts/src/deploy-utils.ts (3)

46-49: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to deploy match the new signature.

Verification successful

All function calls to deploy match the new signature.

The changes are consistent across the codebase.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `deploy` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts -A 5 $'deploy('

Length of output: 94


Script:

#!/bin/bash
# Description: Verify all function calls to `deploy` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts -A 5 'deploy\('

Length of output: 19304


167-173: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to deployImpl match the new signature.

Also applies to: 204-204, 221-221

Verification successful

All function calls to deployImpl match the new signature.

The function deployImpl is correctly used with the new signature in the codebase.

  • packages/contracts/src/deploy-utils.ts: Both usages of deployImpl return a tuple [created, newlyDeployed].
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `deployImpl` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts -A 5 $'deployImpl('

Length of output: 106


Script:

#!/bin/bash
# Description: Verify all function calls to `deployImpl` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts -A 5 $'deployImpl\\('

Length of output: 817


113-116: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to deployAndUpgradeByDeployer match the new signature.

Copy link
Contributor

@sm-stack sm-stack left a comment

Choose a reason for hiding this comment

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

LGTM

@seolaoh seolaoh merged commit bc896c5 into dev Aug 8, 2024
2 checks passed
@seolaoh seolaoh deleted the fix/reuse-already-deployed branch August 8, 2024 04:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants