contracts icon indicating copy to clipboard operation
contracts copied to clipboard
verified publisher icon lifinance

Deprecate stargate v1 and amarok [CalldataVerificationFacet v1.3.0]

Open 0xDEnYO opened this issue 10 months ago • 3 comments

Which Jira task belongs to this PR?

https://lifi.atlassian.net/browse/LF-12447

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
  • [ ] I have added tests that cover the functionality / test the bug
  • [ ] For new facets: I have checked all points from this list: https://www.notion.so/lifi/New-Facet-Contract-Checklist-157f0ff14ac78095a2b8f999d655622e
  • [ ] 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>

0xDEnYO avatar Feb 18 '25 02:02 0xDEnYO

Walkthrough

This pull request introduces a new JSON configuration file for the Stargate protocol, detailing sections for endpoint mappings, chain IDs, contract addresses for composers, and routers. It also updates the import paths in two demo scripts to reflect a change in the directory structure for configuration files. Additionally, the legacy sections have been removed from an existing Stargate configuration file, streamlining the overall JSON format.

Changes

File(s) Change Summary
archive/config/stargateV1.json Added a new JSON configuration file for the Stargate protocol with sections: endpointIds, chains, composers, and routers.
archive/scripts/demoScripts/demoDeBridge.ts, archive/scripts/demoScripts/demoSynapseBridge.ts Updated relative import paths to correctly reference configuration and deployment JSON files.
config/stargate.json Removed the legacy sections (chains, composers, and routers) and restructured the file to focus on current configuration sections.

Possibly related PRs

  • lifinance/contracts#993: This PR involves updates to the Stargate configuration, particularly the removal of legacy sections, which is closely related to the new JSON configuration structure introduced in the current changes.

Suggested labels

AuditRequired

Suggested reviewers

  • ezynda3
  • maxklenk

[!WARNING]

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
📜 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 dc25a8549b0c88375076a0304bffbe6535d5bfe6 and a448cccdd468e4a9c8c3876bd19d51ab000edea6.

📒 Files selected for processing (1)
  • config/stargate.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: run-unit-tests
  • GitHub Check: generate-tag
🔇 Additional comments (4)
config/stargate.json (4)

1-50: Legacy Fields Removal and JSON Structure Simplification
The legacy sections (chains, composers, and routers) have been successfully removed from this configuration, aligning with the project's deprecation of stargate v1 and amarok. This streamlined structure better reflects the intended JSON schema by focusing on the current endpointV2 configuration.

51-79: Validation of the Token Messaging Section
The tokenMessaging section now clearly defines network-specific configurations and includes an updated documentation link. Please ensure that any other parts of the system or demos referencing this section are updated accordingly.

80-149: Repositioned EndpointIds Array and Integrity Check
The endpointIds array has been repositioned to the end of the file, which enhances clarity by separating current endpoint mappings from deprecated configurations. Verify that each chain ID to endpoint ID mapping is correct and consistently aligned with the new configuration in archive/config/stargateV1.json. Additionally, double-check that no remnants of the legacy identifiers remain that could cause confusion.

150-151: File Closure and JSON Validity
The file ends cleanly with no extra trailing commas or syntax issues. It should parse correctly with standard JSON parsers.

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.
  • @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 Feb 18 '25 02:02 coderabbitai[bot]

Test Coverage Report

Line Coverage: 78.75% (2079 / 2640 lines) Function Coverage: 83.68% ( 359 / 429 functions) Branch Coverage: 45.24% ( 233 / 515 branches) Test coverage (78.75%) is above min threshold (76%). Check passed.

lifi-action-bot avatar Feb 18 '25 03:02 lifi-action-bot

This PR has a cross-dependency with PR(#999) (both are updating the CalldataVerificationFacet). We will create a separate PR (#1003) that combines the changes in CalldataVerificationFacet and ensures the audit. Once this is merged, we will merge this PR here.

0xDEnYO avatar Feb 18 '25 03:02 0xDEnYO