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

feat: verify with third party framework #1198

Merged
merged 3 commits into from
Jan 20, 2025
Merged

Conversation

evilpeach
Copy link
Collaborator

@evilpeach evilpeach commented Jan 17, 2025

Fixes: FRO-757, 756

Summary by CodeRabbit

  • New Features

    • Added EVM contract verification with Hardhat
    • Added EVM contract verification with Foundry
  • Improvements

    • Enhanced Solidity contract verification options
    • Updated contract verification form handling
    • Improved dynamic command generation for contract verification
  • Bug Fixes

    • Refined contract address form validation
    • Addressed issues with the EVM contract details verification page

Copy link

vercel bot commented Jan 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
celatone-frontend-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 8:35am
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
celatone-frontend-main ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am
initia-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am
neutron-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am
osmosis-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am
sei-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am
terra-celatone-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:35am

Copy link

coderabbitai bot commented Jan 17, 2025

Walkthrough

This pull request updates the EVM contract verification functionality by adding support for Hardhat and Foundry. It includes modifications to the CHANGELOG.md to document these new features, updates to the EvmContractVerifySolidity component to pass the control prop, and a complete reimplementation of the EvmContractVerifySolidityFoundry and EvmContractVerifySolidityHardhat components to facilitate dynamic command generation. Additionally, the helper function is modified to accommodate new verification options, enhancing the overall user experience for contract verification.

Changes

File Change Summary
CHANGELOG.md Added new feature entries for EVM contract verification with Hardhat and Foundry.
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidity.tsx Updated to pass control prop to EvmContractVerifySolidityHardhat and EvmContractVerifySolidityFoundry components.
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityFoundry.tsx Reimplemented component with dynamic command generation and added props interface.
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityHardhat.tsx Created new component with dynamic command generation and added props interface.
src/lib/pages/evm-contract-verify/helper.ts Added new verification options (Hardhat and Foundry) to getVerifyFormInitialValue function.

Possibly related PRs

Suggested reviewers

  • Poafs1
  • songwongtp

Poem

🐰 In the land of code where contracts thrive,
Hardhat and Foundry help them come alive!
With commands that sparkle, so clear and bright,
Our rabbit hops high, in pure delight!
Verification's magic, a joyful sight! 🚀


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7a9563 and 61a2be1.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidity.tsx (1 hunks)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityFoundry.tsx (1 hunks)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityHardhat.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidity.tsx
🔇 Additional comments (4)
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityHardhat.tsx (2)

29-52: LGTM! Well-structured Hardhat configuration command.

The command generation logic is well-structured and includes all necessary configuration:

  • Network configuration with URL
  • Custom chain configuration with verifier URL
  • Proper solidity version placeholder

54-59: LGTM! Clear verification command structure.

The verification command is properly formatted with:

  • Network selection
  • Contract address (with placeholder)
  • Constructor arguments placeholder
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityFoundry.tsx (1)

24-32: LGTM! Well-structured Foundry verification command.

The command generation logic is well-structured and includes all necessary parameters:

  • RPC URL
  • Custom verifier configuration
  • Contract address (with placeholder)
  • Constructor arguments placeholder
CHANGELOG.md (1)

42-43: LGTM! Well-documented changelog entries.

The changelog entries properly document the new EVM contract verification features for both Hardhat and Foundry.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@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: 1

🧹 Nitpick comments (2)
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityFoundry.tsx (1)

25-32: Consider improving the command string construction.

The command string construction could be improved in the following ways:

  1. Add validation for empty or undefined values
  2. Consider escaping special characters in the inputs
  3. Add a placeholder or helper text for [contractFile]:[contractName]
  const cmd = useMemo(() => {
+   if (!rpc || !contractAddress) return "";
+   const escapedRpc = rpc.replace(/['"]/g, '\\"');
    return `forge verify-contract \\
-    --rpc-url ${rpc} \\
+    --rpc-url "${escapedRpc}" \\
    --verifier custom \\
    --verifier-url ${verifierUrl} \\
    ${contractAddress} \\
-    [contractFile]:[contractName]`;
+    <contractFile>:<contractName>  # Replace with your contract file and name`;
  }, [rpc, contractAddress]);
src/lib/pages/evm-contract-verify/helper.ts (1)

39-43: Consider using a more type-safe approach for verification options.

The current implementation could benefit from using a discriminated union type for the verification options to ensure type safety and better maintainability.

+ type VerificationFormOption = {
+   option: VerificationOptions;
+ };

+ type VerificationForm = 
+   | (VerificationFormOption & { 
+       constructorArgs?: { enabled: boolean; value: string }; 
+       optimizerConfig?: { enabled: boolean; runs: number }; 
+       evmVersion?: string;
+     })
+   | VerificationFormOption;

  case VerificationOptions.Hardhat:
  case VerificationOptions.Foundry:
    return {
      option: verificationOption,
    } as VerificationForm;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70e721d and d7a9563.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidity.tsx (1 hunks)
  • src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidityFoundry.tsx (1 hunks)
  • src/lib/pages/evm-contract-verify/helper.ts (1 hunks)
🔇 Additional comments (2)
src/lib/pages/evm-contract-verify/components/solidity/EvmContractVerifySolidity.tsx (1)

33-33: LGTM!

The control prop is correctly passed to the EvmContractVerifySolidityFoundry component.

CHANGELOG.md (1)

42-42: LGTM!

The changelog entry is well-formatted and clearly describes the new feature.

@evilpeach evilpeach changed the title feat: verify with Foundry feat: verify with third party framework Jan 17, 2025
@Poafs1 Poafs1 merged commit c33dff4 into develop Jan 20, 2025
13 checks passed
@Poafs1 Poafs1 deleted the feat/verify-via-foundary branch January 20, 2025 06:11
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.

2 participants