fix(node-api): added ValidateValidatorStatus

[abi87]

The ValidateValidatorStatus function is unused, leaving validator_status fields from API requests unvalidated. This PR adds back the validation

Summary by CodeRabbit

• New Features
  • Introduced enhanced validation for validator statuses in the API, ensuring compliance with Ethereum Beacon Node specifications.
  • Added a new validation function to improve the accuracy of validator status checks.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 23.47%. Comparing base (0ea12a8) to head (30eb657).

Files with missing lines	Patch %	Lines
mod/node-api/engines/echo/vaildator.go	0.00%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2090      +/-   ##
==========================================
- Coverage   23.47%   23.47%   -0.01%     
==========================================
  Files         357      357              
  Lines       16055    16056       +1     
  Branches       12       12              
==========================================
  Hits         3769     3769              
- Misses      12116    12117       +1     
  Partials      170      170              

Files with missing lines	Coverage Δ
mod/node-api/engines/echo/vaildator.go	0.00% <0.00%> (ø)

[coderabbitai]

Walkthrough

The changes introduce a new validation function, ValidateValidatorStatus, which verifies if a given field matches a valid validator status as per Ethereum Beacon Node API specifications. The ConstructValidator function has been updated to incorporate this new validation function into the validators map. The existing validation structure and error handling in the CustomValidator type remain unchanged.

Changes

File Path	Change Summary
mod/node-api/engines/echo/vaildator.go	- Added method: ValidateValidatorStatus(fl validator.FieldLevel)
	- Updated method signature: ConstructValidator() to include "validator_status": ValidateValidatorStatus

Suggested reviewers

• itsdevbear

🐰 In the code, a new check,
For validators, we now peck.
Status validated, neat and clear,
In the echo, we give a cheer!
With each function, we refine,
Making sure our code will shine! ✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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]

Actionable comments posted: 1

🧹 Outside diff range comments (1)

mod/node-api/engines/echo/vaildator.go (1)

Line range hint 163-180: LGTM! Consider using a constant for allowed statuses.

The implementation of ValidateValidatorStatus is correct and aligns with the PR objective. It efficiently validates the validator status against the allowed values from the Ethereum Beacon Node API specifications.

For improved maintainability, consider defining the allowed statuses as a package-level constant. This would make it easier to update the list if needed and potentially reuse it elsewhere. For example:

var allowedValidatorStatuses = map[string]bool{
    "pending_initialized": true,
    "pending_queued":      true,
    "active_ongoing":      true,
    "active_exiting":      true,
    "active_slashed":      true,
    "exited_unslashed":    true,
    "exited_slashed":      true,
    "withdrawal_possible": true,
    "withdrawal_done":     true,
}

func ValidateValidatorStatus(fl validator.FieldLevel) bool {
    return validateAllowedStrings(fl.Field().String(), allowedValidatorStatuses)
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between a659c95 and 62cbd7b.

📒 Files selected for processing (1)

• mod/node-api/engines/echo/vaildator.go (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

mod/node-api/engines/echo/vaildator.go (1)

Line range hint 1-228: Overall, the changes look good and achieve the PR objective.

The implementation of ValidateValidatorStatus and its integration into the ConstructValidator function successfully reintroduce validation for validator status fields. The code is consistent with the existing structure and follows good practices.

Consider the minor suggestions for improved clarity and maintainability:

1. Adding a comment for the new validator in ConstructValidator.
2. Defining the allowed validator statuses as a package-level constant.

These changes will enhance the code's readability and make it easier to maintain in the future.

[nidhi-singh02]

This change is part of https://github.com/berachain/beacon-kit/pull/1983/files#diff-a80e7b873ee5fd2392e59400c2fcf215804b06ec615e73b55a0e936d4ae77b52R69 which is available for review , @itsdevbear Wanted to know your thoughts on merging it so it gets addressed automatically.