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

Test RYUSD Share Price Oracle Permission #276

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

cbrit
Copy link
Member

@cbrit cbrit commented Sep 25, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new oracle constant for enhanced validation in the cellar functionality.
    • Added a specific cellar identifier to improve the validation process for oracles.
  • Bug Fixes

    • Enhanced the validation logic for oracles associated with the new cellar identifier.

Copy link

coderabbitai bot commented Sep 25, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new constants related to the TEST_RYUSD_ORACLE, including its definition and an array of allowed price oracles. A specific cellar identifier, CELLAR_TEST_RYUSD, is also defined. The validate_oracle function is updated to include a check for validating oracles associated with the CELLAR_TEST_RYUSD, ensuring that both the normalized cellar ID and the provided oracle details are validated against the allowed list.

Changes

Files Change Summary
src/cellars.rs Added constants: TEST_RYUSD_ORACLE, ALLOWED_TEST_RYUSD_PRICE_ORACLES, and CELLAR_TEST_RYUSD. Updated validate_oracle function to include validation for CELLAR_TEST_RYUSD.

Possibly related PRs

  • Test RYUSD Share Price Oracle Permission #276: The changes in this PR are identical to those in the main PR, including the addition of the TEST_RYUSD_ORACLE, ALLOWED_TEST_RYUSD_PRICE_ORACLES, and CELLAR_TEST_RYUSD constants, as well as the modifications to the validate_oracle function.

Suggested reviewers

  • zmanian
  • otsalex

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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: 1

🧹 Outside diff range and nitpick comments (1)
src/cellars.rs (1)

Line range hint 69-386: Consider adding tests for the new TEST_RYUSD functionality

While the changes for TEST_RYUSD_ORACLE and CELLAR_TEST_RYUSD have been implemented correctly, it would be beneficial to add corresponding unit tests to ensure the new functionality works as expected.

Consider adding the following tests to the existing test module:

  1. A test case for validating the TEST_RYUSD_ORACLE in the test_validate_oracle function.
  2. A test case for the CELLAR_TEST_RYUSD constant to ensure it's recognized as a valid cellar ID.

These additions will help maintain the robustness of the codebase and catch any potential issues early.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5ebaf9b and dd380e5.

📒 Files selected for processing (1)
  • src/cellars.rs (3 hunks)
🔇 Additional comments not posted (2)
src/cellars.rs (2)

239-239: LGTM: New constant CELLAR_TEST_RYUSD added correctly

The new constant CELLAR_TEST_RYUSD is added correctly, following the existing naming convention and structure for cellar constants.


381-386: LGTM: Oracle validation for CELLAR_TEST_RYUSD added correctly

The new condition for validating oracles associated with CELLAR_TEST_RYUSD has been implemented correctly. It follows the existing pattern and uses the appropriate constants.

src/cellars.rs Outdated
Comment on lines 69 to 75
pub const TEST_RYUSD_ORACLE: (U256, &str) = (
// need the real id
U256([2, 0, 0, 0]),
"ddf603866d6d8d207c6200552655df1ebde5a641",
);

pub const ALLOWED_TEST_RYUSD_PRICE_ORACLES: [(U256, &str); 1] = [TEST_RYUSD_ORACLE];
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Placeholder Registry ID for TEST_RYUSD_ORACLE Still Present

The registry ID for TEST_RYUSD_ORACLE remains as a placeholder value (U256([2, 0, 0, 0])). Please update it with the correct registry ID before deploying to production.

🔗 Analysis chain

Update the placeholder registry ID for TEST_RYUSD_ORACLE

The registry ID for TEST_RYUSD_ORACLE is currently set to a placeholder value (U256([2, 0, 0, 0])). Please update this with the correct registry ID before deploying to production.

To ensure the correct registry ID is used, you can run the following command:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the registry ID for TEST_RYUSD_ORACLE
# Expected: The correct registry ID should be displayed

rg --type rust 'pub const TEST_RYUSD_ORACLE: \(U256, &str\) = \(' src/cellars.rs -A 3

Length of output: 229

@cbrit cbrit merged commit c3b7a0f into main Sep 27, 2024
5 of 6 checks passed
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