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

chore(contracts): add token deployments for Sepolia, Kroma Sepolia #338

Merged
merged 2 commits into from
Jul 9, 2024

Conversation

seolaoh
Copy link
Contributor

@seolaoh seolaoh commented Jul 4, 2024

Description

Deployed GovernanceToken, MintManager on Sepolia and Kroma Sepolia. Also minted and distributed the token to trusted validator and security council owners.

Additionally, to verify the contract on block explorer, the contracts deployments need metadata and constructor arguments. Added the extra data during saving deterministic proxy deployments in deploy script.

@seolaoh seolaoh self-assigned this Jul 4, 2024
@seolaoh seolaoh requested a review from a team as a code owner July 4, 2024 09:09
Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

The changes predominantly focus on updating the deployment logic of deterministic proxies and improving clarity in logging messages. In deploy-utils.ts, the function deployDeterministicProxy has been updated to use a new ABI, and additional information about the proxy deployment is now retrieved and assigned. In forge-verify.ts, a minor typo in a log message has been corrected.

Changes

Files Change Summary
packages/contracts/src/deploy-utils.ts Updated deployDeterministicProxy to utilize create2DeployerAbi instead of contractABI, and included additional proxy deployment info retrieval.
packages/contracts/tasks/forge-verify.ts Corrected a typo in a log message from "unsuccesful" to "unsuccessful."

Sequence Diagrams

sequenceDiagram
    participant User
    participant deploy-utils.ts
    participant EthProvider

    User->>deploy-utils.ts: call deployDeterministicProxy()
    deploy-utils.ts->>EthProvider: Retrieve proxy build info and artifact
    EthProvider-->>deploy-utils.ts: Proxy build info and artifact data
    deploy-utils.ts->>deploy-utils.ts: Extract compiled output
    deploy-utils.ts->>EthProvider: Deploy proxy and get transaction receipt
    EthProvider-->>deploy-utils.ts: Deployment transaction receipt
    deploy-utils.ts->>User: Return proxy deployment details
Loading
sequenceDiagram
    participant User
    participant forge-verify.ts

    User->>forge-verify.ts: Execute verification task
    forge-verify.ts->>forge-verify.ts: Log outcome with corrected message
    forge-verify.ts->>User: Display verification status
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 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.

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 0fdc7c0 and efbd129.

Files ignored due to path filters (11)
  • packages/contracts/deploy-config/sepolia.json is excluded by !**/*.json
  • packages/contracts/deployments/kromaSepolia/GovernanceToken.json is excluded by !**/*.json
  • packages/contracts/deployments/kromaSepolia/GovernanceTokenProxy.json is excluded by !**/*.json
  • packages/contracts/deployments/kromaSepolia/MintManager.json is excluded by !**/*.json
  • packages/contracts/deployments/kromaSepolia/solcInputs/1cc21f973aa4cfc73d832518987f54f8.json is excluded by !**/*.json
  • packages/contracts/deployments/kromaSepolia/solcInputs/37a0cebac478897ae0c20446c8a2494a.json is excluded by !**/*.json
  • packages/contracts/deployments/sepolia/L1GovernanceToken.json is excluded by !**/*.json
  • packages/contracts/deployments/sepolia/L1GovernanceTokenProxy.json is excluded by !**/*.json
  • packages/contracts/deployments/sepolia/L1MintManager.json is excluded by !**/*.json
  • packages/contracts/deployments/sepolia/solcInputs/1cc21f973aa4cfc73d832518987f54f8.json is excluded by !**/*.json
  • packages/contracts/deployments/sepolia/solcInputs/37a0cebac478897ae0c20446c8a2494a.json is excluded by !**/*.json
Files selected for processing (2)
  • packages/contracts/src/deploy-utils.ts (1 hunks)
  • packages/contracts/tasks/forge-verify.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/contracts/tasks/forge-verify.ts
Additional comments not posted (7)
packages/contracts/src/deploy-utils.ts (7)

306-307: Introduce new ABI definition.

The new ABI definition create2DeployerAbi is correctly introduced for the deploy function.


309-311: Instantiate contract with new ABI.

The contract instantiation with the new ABI create2DeployerAbi is correctly done.


314-314: Connect contract with signer.

The contract is correctly connected to the signer.


317-318: Deploy contract using CREATE2.

The deployment call using create2Deployer.deploy is correctly performed and the transaction is awaited.


323-326: Retrieve and parse proxy build information.

The retrieval and parsing of the proxy build information are correctly performed. This includes getting the build info, reading the artifact, and extracting the compiled output.


328-330: Retrieve deployment transaction receipt.

The transaction receipt for the deployment is correctly retrieved.


335-338: Update proxy deployment object with new metadata.

The proxy deployment object is correctly updated to include the transaction hash, deployment arguments, and metadata.

@seolaoh seolaoh force-pushed the chore/add-token-deployments-sepolia branch from efbd129 to d7193ee Compare July 4, 2024 09:33
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 efbd129 and d7193ee.

Files selected for processing (2)
  • packages/contracts/src/deploy-utils.ts (1 hunks)
  • packages/contracts/tasks/forge-verify.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/contracts/src/deploy-utils.ts
Additional comments not posted (1)
packages/contracts/tasks/forge-verify.ts (1)

160-160: Corrected typo in log message.

The log message typo has been corrected from "unsuccesful" to "unsuccessful".

@seolaoh seolaoh merged commit cce60b9 into dev Jul 9, 2024
2 checks passed
@seolaoh seolaoh deleted the chore/add-token-deployments-sepolia branch July 9, 2024 05:36
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