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

refactor(verifier): update solidity tests to have cbor auxdata ids starting from 1 #1196

Merged
merged 2 commits into from
Jan 20, 2025

Conversation

rimrakhimov
Copy link
Member

@rimrakhimov rimrakhimov commented Jan 20, 2025

Summary by CodeRabbit

  • Tests

    • Commented out Sourcify verifier tests in the test suite.
    • Updated test case JSON files for smart contract verification.
      • Modified CBOR auxdata indexing in various contract test configurations.
  • Refactor

    • Adjusted auxdata identifier generation in verification process.
    • Added placeholder for new verification method.
    • Simplified return statement in the request normalization function.

Copy link

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request encompasses changes across multiple files in the smart contract verifier project. The modifications primarily involve adjustments to test cases and verification logic, with a notable focus on CBOR auxiliary data indexing. In the sourcify.rs file, several test-related components have been commented out, effectively disabling Sourcify verifier tests. Simultaneously, JSON test case files for various smart contracts have been updated, changing the indexing of CBOR auxiliary data from "0" to "1" or incrementing existing indices. The all_metadata_extracting_verifier.rs file was modified to adjust the identifier generation for auxiliary data, incrementing the length by one. Additionally, a new placeholder asynchronous function verify_solidity_compiler_output was introduced in the new_verifier.rs file.

Possibly related PRs

  • feat(verification-common): implement transformation functions #1157: The changes in the main PR involve commenting out functions and constants related to the Sourcify Verifier Service, while this PR introduces new data structures and type definitions for handling auxiliary data, which may be relevant to the functionality being disabled in the main PR.

Poem

🐰 Hopping through code with glee,
Sourcify tests now rest quietly,
CBOR data shifts its key,
From zero to one, watch and see!
A rabbit's refactor, light and free 🔍


📜 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 1696bb9 and 2c804d9.

📒 Files selected for processing (1)
  • smart-contract-verifier/smart-contract-verifier-server/src/services/common.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Unit, doc and integration tests
🔇 Additional comments (2)
smart-contract-verifier/smart-contract-verifier-server/src/services/common.rs (2)

86-93: LGTM! Style improvement in the closure.

The changes simplify the closure by removing the explicit return statement while maintaining the same logical conditions and functionality.


86-93: Verify the impact on CBOR auxiliary data verification.

While this change is a style improvement, let's verify that the compiler version normalization still works correctly with the updated CBOR auxiliary data IDs.

✅ Verification successful

Compiler version normalization is independent of CBOR auxiliary data handling

The changes to the compiler version normalization function are a style improvement that operates independently of CBOR auxiliary data handling. The normalization occurs before the verification process and only ensures that the correct compiler version is used, regardless of how CBOR auxiliary data is processed during verification.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the compiler version normalization is used in conjunction with CBOR auxiliary data handling

# Search for usage of normalize_request_compiler_version in relation to CBOR data
rg -A 5 "normalize_request_compiler_version.*cbor" || rg -B 5 "cbor.*normalize_request_compiler_version"

# Search for test files that might be affected
fd -e rs -e json | xargs rg "normalize_request_compiler_version"

Length of output: 1009


Script:

#!/bin/bash
# Get context around normalize_request_compiler_version usage
rg -B 5 -A 10 "normalize_request_compiler_version" smart-contract-verifier/smart-contract-verifier-server/src/services/solidity_verifier.rs smart-contract-verifier/smart-contract-verifier-server/src/services/vyper_verifier.rs

# Look for CBOR mentions in the same files
rg -B 2 -A 2 "cbor|auxdata" smart-contract-verifier/smart-contract-verifier-server/src/services/solidity_verifier.rs smart-contract-verifier/smart-contract-verifier-server/src/services/vyper_verifier.rs

Length of output: 8777


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.

@rimrakhimov rimrakhimov merged commit 8f2caa9 into main Jan 20, 2025
5 checks passed
@rimrakhimov rimrakhimov deleted the rimrakhimov/verifier/fix-auxdata-ids-generation branch January 20, 2025 18:47
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.

1 participant