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: fix show_validator_vote sctipt function #646

Merged
merged 1 commit into from
Aug 15, 2024
Merged

chore: fix show_validator_vote sctipt function #646

merged 1 commit into from
Aug 15, 2024

Conversation

zakir-code
Copy link
Contributor

@zakir-code zakir-code commented Aug 14, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced output formatting for the validator votes display.
    • Updated the API endpoint for fetching proposals to a more recent version.
    • Added filtering to retrieve only bonded validators, improving data relevance.
  • Improvements

    • Introduced structured output using printf for better readability and visual appeal.
    • Explicitly defined PROPOSAL_ID for better function logic clarity.

Copy link

coderabbitai bot commented Aug 14, 2024

Walkthrough

The changes enhance the show_validator_vote function in run.sh, improving its output formatting and refining data retrieval. Notably, the proposal ID is now explicitly set, and the API version was updated for better data handling. Output formatting has shifted from echo to printf, ensuring better readability, while the logic now only fetches bonded validators, streamlining data processing and improving usability.

Changes

Files Change Summary
contrib/scripts/run.sh Updated show_validator_vote to set PROPOSAL_ID, changed API version to v1, improved output formatting using printf, and filtered API calls to retrieve only bonded validators.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant API

    User->>Script: Call show_validator_vote(PROPOSAL_ID)
    Script->>API: Fetch proposals (v1)
    API-->>Script: Return proposal data
    Script->>API: Fetch bonded validators
    API-->>Script: Return bonded validators
    Script->>User: Display formatted output
Loading

Poem

🐇 In a script where changes dance,
Better votes now take their chance.
With colors bright and data neat,
Bonded validators we greet!
A hop, a skip, a joyful cheer,
Improved clarity brings us near! 🥕


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4edcd2b and 5b36df0.

Files selected for processing (1)
  • contrib/scripts/run.sh (1 hunks)
Additional comments not posted (3)
contrib/scripts/run.sh (3)

148-153: Improved output formatting with printf.

The use of printf for output formatting enhances readability and structure. This change is beneficial for maintaining consistent column alignment and applying color formatting to the header row.


154-154: Filter validators to bonded status.

The API call now filters for bonded validators using status=BOND_STATUS_BONDED. This change optimizes the data retrieval process by focusing only on relevant validators.


139-139: Ensure PROPOSAL_ID is passed correctly.

The PROPOSAL_ID is now a required argument for the function. Ensure that this change is documented and that all calls to this function provide the necessary argument.

@fx0x55 fx0x55 merged commit f9a8720 into main Aug 15, 2024
4 checks passed
@fx0x55 fx0x55 deleted the zakir/run branch August 15, 2024 00:31
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