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: constructor args disable #1246

Merged
merged 1 commit into from
Feb 24, 2025
Merged

Conversation

evilpeach
Copy link
Collaborator

@evilpeach evilpeach commented Feb 24, 2025

Summary by CodeRabbit

  • Documentation

    • Updated the release notes to mention improved handling of optional constructor parameters.
  • Bug Fixes

    • Enhanced the contract verification process so that constructor inputs are now included only when enabled, ensuring more accurate and reliable verifications for users.

Copy link

vercel bot commented Feb 24, 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 Feb 24, 2025 7:15am
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
celatone-frontend-main ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am
initia-celatone-frontend ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am
neutron-celatone-frontend ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am
osmosis-celatone-frontend ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am
sei-celatone-frontend ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am
terra-celatone-frontend ⬜️ Ignored (Inspect) Feb 24, 2025 7:15am

Copy link

coderabbitai bot commented Feb 24, 2025

Walkthrough

This pull request adds a new entry in the "Improvements" section of the CHANGELOG.md to document the handling of undefined constructor arguments (referencing PR #1246). It also updates multiple EVM verification functions in src/lib/services/verification/evm/api.ts to conditionally assign the constructor_arguments property based on whether constructorArgs.enabled is true, ensuring the request payload only includes the argument when enabled.

Changes

File(s) Summary
CHANGELOG.md Added a new "Improvements" entry: - [#1246](https://github.com/alleslabs/celatone-frontend/pull/1246) Handle undefined constructor args
src/lib/services/verification/evm/api.ts Updated multiple verification functions to conditionally assign constructor_arguments based on constructorArgs.enabled (assign value if true, else undefined)

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant VerificationFunction
    participant RequestPayload

    Caller->>VerificationFunction: Call verification function with constructorArgs
    alt constructorArgs.enabled is true
        VerificationFunction->>RequestPayload: Set constructor_arguments = constructorArgs.value
    else constructorArgs.enabled is false
        VerificationFunction->>RequestPayload: Set constructor_arguments = undefined
    end
    RequestPayload-->>Caller: Return request with appropriate payload
Loading

Possibly related PRs

Suggested reviewers

  • songwongtp
  • Poafs1

Poem

I'm just a little rabbit with a hop and a twirl,
Updating code while giving it a whirl.
Constructor args now check if they're enabled,
Otherwise left undefined, so neatly labeled.
With changes in our code garden, we celebrate with a smile!
🐇💻
Yeehaw to clean code in every style!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/lib/services/verification/evm/api.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.json".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 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 5d2a518 and 6b1194b.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • src/lib/services/verification/evm/api.ts (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (6)
CHANGELOG.md (1)

85-85: CHANGELOG Entry Clarity

The new changelog entry for [#1246] clearly documents the improvement to handle undefined constructor arguments. This entry helps users understand that constructor arguments will now only be included when enabled.

src/lib/services/verification/evm/api.ts (5)

71-73: Conditional Inclusion in Solidity Contract Code Submission

The updated code now uses a ternary operator to set
  constructor_arguments: constructorArgs.enabled ? constructorArgs.value : undefined
which ensures that the property is only included when enabled. This change is straightforward and correct.


112-114: FormData Handling in Solidity Upload Files

The conditional block checking if (constructorArgs.enabled) {...} and only appending the "constructor_arguments" entry when enabled is clear and consistent with the new behavior.


164-166: Conditional Inclusion in Vyper Contract Code Submission

The same pattern is applied here by conditionally including the constructor_arguments based on the constructorArgs.enabled flag. This maintains consistency with the Solidity functions.


253-255: Conditional Inclusion in JSON Input Submission

For JSON input verification, the same conditional check is applied:
  constructor_arguments: constructorArgs.enabled ? constructorArgs.value : undefined.
This guarantees that the JSON payload remains clean when the constructor args are disabled.


270-317: Overall Consistency Across Submission Functions

All updated functions – covering Solidity contract code, Solidity-upload files, Vyper contract code, Vyper upload files, and JSON input – now consistently only include the constructor arguments payload when enabled. This uniform approach reduces the risk of sending unwanted data and aligns with the PR objective.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@evilpeach evilpeach merged commit 72c7333 into develop Feb 24, 2025
13 checks passed
@evilpeach evilpeach deleted the fix/constructor-args-disabled branch February 24, 2025 07:33
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.

3 participants