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(upgrade): update layer2 oracle to online #875

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

zakir-code
Copy link
Contributor

@zakir-code zakir-code commented Jan 7, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced upgrade testing by adding verification of Layer 2 oracle online status
    • Introduced mechanism to fix base oracle status during testnet and mainnet upgrades
  • Bug Fixes

    • Ensured Layer 2 oracles are correctly marked as online during system upgrades

Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request introduces enhancements to the upgrade testing framework, specifically focusing on verifying the online status of layer 2 oracles. A new function checkLayer2OracleIsOnline is added to the app_test package, which checks that all oracles managed by the Layer2Keeper are online. The Test_UpgradeTestnet and checkAppUpgrade functions are updated to incorporate this new verification step, ensuring a comprehensive check of oracle operational status during the upgrade process.

Changes

File Change Summary
app/upgrade_test.go Added checkLayer2OracleIsOnline function to verify oracle online status
app/upgrades/v8/upgrade.go Added fixBaseOracleStatus function call in upgradeTestnet and upgradeMainnet functions

Sequence Diagram

sequenceDiagram
    participant Test as Upgrade Test
    participant Layer2Keeper as Layer2 Keeper
    participant Oracle as Layer 2 Oracles

    Test->>Layer2Keeper: Get list of oracles
    Layer2Keeper-->>Test: Return oracle list
    loop For Each Oracle
        Test->>Oracle: Check Online Status
        Oracle-->>Test: Confirm Online Status
    end
    Test->>Layer2Keeper: Fix Base Oracle Status
    Layer2Keeper->>Oracle: Update Online Status
Loading

Possibly Related PRs

Poem

🐰 Oracles dancing in the light,
Checking status, making things right
Upgrades flow with rabbit's might
Online and ready, a technical delight!
Testing magic takes its flight 🚀


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: 0

🧹 Nitpick comments (1)
app/upgrades/v8/upgrade.go (1)

Line range hint 391-403: Add logging for oracle status changes and validate oracle addresses.

The function correctly fixes oracle status but could benefit from:

  1. Logging oracle status changes for better debugging and auditing.
  2. Validating oracle addresses before updating their status.

Apply this diff to add logging and validation:

 func fixBaseOracleStatus(ctx sdk.Context, crosschainKeeper crosschainkeeper.Keeper) {
     if crosschainKeeper.ModuleName() != layer2types.ModuleName {
         return
     }
     oracles := crosschainKeeper.GetAllOracles(ctx, false)
     for _, oracle := range oracles {
+        if err := sdk.VerifyAddressFormat([]byte(oracle.OracleAddress)); err != nil {
+            ctx.Logger().Error("invalid oracle address", "address", oracle.OracleAddress, "error", err)
+            continue
+        }
+        ctx.Logger().Info("fixing oracle status",
+            "address", oracle.OracleAddress,
+            "previous_online", oracle.Online,
+            "previous_slash_times", oracle.SlashTimes,
+            "previous_start_height", oracle.StartHeight)
         oracle.Online = true
         oracle.SlashTimes = 0
         oracle.StartHeight = ctx.BlockHeight()
         crosschainKeeper.SetOracle(ctx, oracle)
     }
     crosschainKeeper.SetLastTotalPower(ctx)
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13c5874 and 354c4ce.

📒 Files selected for processing (2)
  • app/upgrade_test.go (3 hunks)
  • app/upgrades/v8/upgrade.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Mergify Merge Protections
  • GitHub Check: Summary
🔇 Additional comments (4)
app/upgrade_test.go (3)

34-34: LGTM!

The added import for the crosschain keeper is necessary for the new oracle verification functionality.


175-180: LGTM! Well-structured oracle verification function.

The function effectively verifies the online status of all oracles with clear error messages that include the oracle address for debugging.


88-88: LGTM! Appropriate placement of oracle verification.

The oracle verification is correctly placed after the upgrade execution in both test functions.

Also applies to: 172-172

app/upgrades/v8/upgrade.go (1)

69-69: LGTM! Appropriate placement of oracle status fix.

The oracle status fix is correctly placed before token-related operations in the upgrade process.

@zakir-code zakir-code merged commit e58d312 into main Jan 7, 2025
13 checks passed
@zakir-code zakir-code deleted the fx0x55/update-base-oracle branch January 7, 2025 08:27
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