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

chore(oracle): update miss counter docs #2337

Merged
merged 3 commits into from
Nov 28, 2023
Merged

Conversation

robert-zaremba
Copy link
Member

@robert-zaremba robert-zaremba commented Nov 27, 2023

Description

Oracle docs update: miss counter increase based on ballot support.

Summary by CodeRabbit

  • Documentation

    • Noted compatibility issue with Umee Price Feeder and advised validators to update to umee/v2.3.0 or newer.
    • Provided guidance on adjusting gas_adjustment to handle "out of gas" errors.
    • Instructed on updating libwasmvm to v1.5.0 and the associated library file for binary installations.
  • New Features

    • Implemented a new mechanism for handling exchange rates that do not meet a minimum voting power threshold, maintaining the last known rate and timestamp.
    • Modified the criteria for validator vote misses to include insufficient price votes for certain denominations, affecting all validators.

@robert-zaremba robert-zaremba requested a review from a team as a code owner November 27, 2023 23:14
Copy link
Contributor

coderabbitai bot commented Nov 27, 2023

Walkthrough

The recent updates address compatibility issues and operational improvements. A key compatibility fix involves the Umee Price Feeder with Cosmos SDK v0.47, requiring validators to upgrade to a newer version. Adjustments to the gas_adjustment setting are recommended to avoid "out of gas" errors. Additionally, the oracle module has been updated to refine the exchange rate update mechanism and the conditions for validator voting, affecting how exchange rates are maintained and how validator participation is assessed.

Changes

File(s) Summary
RELEASE_NOTES.md Introduced compatibility fixes for Umee Price Feeder with Cosmos SDK v0.47, guidance on gas_adjustment settings, and updated dependency to libwasmvm v1.5.0.
x/oracle/README.md (3 entries) Updated exchange rate mechanism to ignore rates with insufficient voting power and modified conditions for validator misses in voting.

🐇✨
In the blockchain's heart, where the data streams flow,
The validators dance, and the prices now know,
When to stand still, or with new votes to glow,
A rabbit's keen eye, on the ledger does show. 🌟📜


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 689ca36 and e698221.
Files selected for processing (2)
  • RELEASE_NOTES.md (1 hunks)
  • x/oracle/README.md (2 hunks)
Additional comments: 4
RELEASE_NOTES.md (2)
  • 32-32: The compatibility advisory is clear and actionable, ensuring validators are aware of the necessary upgrade to umee/v2.3.0 or newer.

  • 34-34: The guidance provided for handling "out of gas" errors is practical and should help validators in troubleshooting and configuring their setups.

x/oracle/README.md (2)
  • 51-53: The documentation clearly explains the new mechanism for handling exchange rates that do not meet the VoteThreshold. This change ensures that the old price and timestamp are retained if the votes for an exchange rate do not meet the required threshold.

  • 78-82: The updated documentation accurately reflects the new conditions for a validator miss, including the scenario where validators do not provide enough price votes for a given denomination. This change is important for validators to understand as it affects their performance evaluation and potential penalties.

RELEASE_NOTES.md Show resolved Hide resolved
auto-merge was automatically disabled November 28, 2023 09:36

Merge queue setting changed

x/oracle/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@gsk967 gsk967 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e698221 and 1b00697.
Files selected for processing (1)
  • x/oracle/README.md (2 hunks)
Additional comments: 2
x/oracle/README.md (2)
  • 51-53: The documentation clearly explains the new mechanism for updating exchange rates based on the total voting power. This change should help maintain the integrity of the exchange rates by ensuring they have sufficient validator support.

  • 80-82: The documentation now includes a new condition for a "miss" in the voting process, where all validators receive a miss if the ballot denom support is less than the required VoteThreshold. This change should be carefully communicated to validators to ensure they understand the new criteria for missed votes.

@robert-zaremba robert-zaremba added this pull request to the merge queue Nov 28, 2023
Merged via the queue into main with commit faade06 Nov 28, 2023
22 checks passed
@robert-zaremba robert-zaremba deleted the robert/oracl-docs branch November 28, 2023 16:28
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.

3 participants