contracts icon indicating copy to clipboard operation
contracts copied to clipboard

(fix): adds calldata extraction handling for GenericSwapV3 single swap calls (CallDataVerificationFacet v1.2.0) [CalldataVerificationFacet v1.2.0]

Open 0xDEnYO opened this issue 1 year ago • 1 comments

Which Jira task belongs to this PR?

Why did I implement it this way?

Checklist before requesting a review

  • [x] I have performed a self-review of my code
  • [x] This pull request is as small as possible and only tackles one problem
  • [x] I have added tests that cover the functionality / test the bug
  • [x] I have updated any required documentation

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

  • [ ] I have checked that any arbitrary calls to external contracts are validated and or restricted
  • [ ] I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
  • [ ] I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

Summary by CodeRabbit

  • New Features

    • Enhanced validation of callData in the Calldata Verification contract, ensuring a minimum length for generic swap calls.
    • Improved handling of function selectors with distinct processing for single and multiple swaps.
    • Introduction of new error handling for invalid call data.
    • New AcrossFacetV3 contract added, enabling robust token bridging through the Across Protocol.
    • New audit entry added for the Calldata Verification contract version 1.2.0.
  • Bug Fixes

    • Strengthened error handling in tests for invalid generic swap call data, ensuring appropriate reversion.
  • Tests

    • Expanded test suite for Calldata Verification with new tests for parameter extraction and validation for generic swaps.
    • New tests added for validating calldata for Stargate and Across bridge operations.

0xDEnYO avatar Aug 16 '24 10:08 0xDEnYO

Walkthrough

The changes introduce new audit entries and updates to the audited contracts section in the auditLog.json file. A new audit entry labeled audit20240902 has been added, documenting an audit completed on September 2, 2024, by Sujith Somraaj, along with a report path. Additionally, two new audited contracts, CalldataVerificationFacet (version 1.2.0) and IAcrossSpokePool (version 1.0.0), have been included, linking them to their respective audits.

Changes

File Change Summary
audit/auditLog.json Added new audit entry audit20240902 with details; included new audited contracts CalldataVerificationFacet (1.2.0) and IAcrossSpokePool (1.0.0).

Possibly related PRs

  • #917: The changes in audit/auditLog.json for this PR include the addition of new audit entries and updates to the audited contracts section, which is directly related to the updates made in the main PR regarding the audit log.

Suggested labels

AuditNotRequired

Suggested reviewers

  • maxklenk

📜 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 c81517f65e31279a088c90c745ea0d85bc113aaa and de8c0e16574288d712e8c62530a260035cc72c4e.

📒 Files selected for processing (1)
  • audit/auditLog.json (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: run-unit-tests
  • GitHub Check: enforce-min-test-coverage
🔇 Additional comments (3)
audit/auditLog.json (3)

10-16: LGTM: Audit entry follows the established format.

The new audit entry for audit20240902 is well-structured and contains all required fields with consistent formatting.


147-151: Action Required: Document audits for previous versions.

The entry only shows version 1.2.0 of CalldataVerificationFacet. If previous versions (1.0.0, 1.0.1, 1.1.0, 1.1.1) exist and are still active, their audit status should be documented.

Let's verify the existence of previous versions:

#!/bin/bash
# Description: Check for previous versions of CalldataVerificationFacet

# Search for version declarations in the contract
ast-grep --pattern $'contract CalldataVerificationFacet {
  $$$
  // @version $VERSION
  $$$
}'

# Search for version tags
git tag -l | grep -i "calldata.*facet"

196-200: LGTM: New interface contract properly documented.

The IAcrossSpokePool interface is correctly added with version 1.0.0, referencing the appropriate audit (audit20250106).


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.

coderabbitai[bot] avatar Aug 16 '24 10:08 coderabbitai[bot]

Test Coverage Report

Line Coverage: 78.66% (2238 / 2845 lines) Function Coverage: 84.71% ( 388 / 458 functions) Branch Coverage: 39.60% ( 221 / 558 branches) Test coverage (78.66%) is above min threshold (76%). Check passed.

lifi-action-bot avatar Jan 11 '25 13:01 lifi-action-bot