Skip to content

test(stf): add unit tests for isValidIndexedAttestationIndices#287

Open
lodekeeper-z wants to merge 1 commit intoChainSafe:mainfrom
lodekeeper-z:test/indexed-attestation-validation
Open

test(stf): add unit tests for isValidIndexedAttestationIndices#287
lodekeeper-z wants to merge 1 commit intoChainSafe:mainfrom
lodekeeper-z:test/indexed-attestation-validation

Conversation

@lodekeeper-z
Copy link
Copy Markdown
Contributor

Add 9 unit tests for isValidIndexedAttestationIndices, covering:

  • ✅ Valid sorted unique indices
  • ✅ Empty indices → false
  • ✅ Single index → true
  • ✅ Duplicate indices → false
  • ✅ Unsorted indices → false
  • ✅ Out-of-bounds index → false
  • ✅ Boundary: validators_count - 1 → true
  • ✅ Boundary: validators_count → false
  • ✅ Electra allows more indices than phase0 (MAX_VALIDATORS_PER_COMMITTEE * MAX_COMMITTEES_PER_SLOT vs MAX_VALIDATORS_PER_COMMITTEE)

This is a pure validation function on the critical path for attestation processing — every block calls it for each attestation.

🤖 Generated with AI assistance

Cover edge cases for the indexed attestation validation logic:
- Valid sorted unique indices
- Empty indices (reject)
- Single index (accept)
- Duplicate indices (reject)
- Unsorted indices (reject)
- Out-of-bounds index (reject)
- Boundary index (validators_count - 1 valid, validators_count invalid)
- Electra vs phase0 max indices limit

🤖 Generated with AI assistance
@lodekeeper-z lodekeeper-z requested a review from a team as a code owner March 27, 2026 19:49
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a suite of unit tests for a critical validation function used during attestation processing. By ensuring the correctness of index validation across different protocol versions and edge cases, these tests help maintain the integrity of the state transition logic.

Highlights

  • Test Coverage: Added 9 comprehensive unit tests for the isValidIndexedAttestationIndices function to ensure robust validation logic.
  • Edge Case Validation: Tests cover various scenarios including empty inputs, duplicates, unsorted indices, out-of-bounds errors, and boundary conditions.
  • Protocol Versioning: Verified distinct behavior between Phase0 and Electra protocol versions regarding maximum allowed indices.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive suite of unit tests for the isValidIndexedAttestationIndices function, covering edge cases such as empty indices, duplicates, unsorted lists, and boundary conditions for both Phase0 and Electra forks. Feedback was provided to replace a magic number in the Electra test case with a named constant to improve maintainability and adhere to the style guide's principles regarding compile-time constants.

test "isValidIndexedAttestationIndices - electra allows more indices" {
// Phase0 max = MAX_VALIDATORS_PER_COMMITTEE (2048)
// Electra max = MAX_VALIDATORS_PER_COMMITTEE * MAX_COMMITTEES_PER_SLOT
var indices: [2049]ValidatorIndex = undefined;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

To improve maintainability and clarity, it's better to use the preset.MAX_VALIDATORS_PER_COMMITTEE constant instead of the magic number 2049. This makes the test's intent explicit—to test one element over the phase0 limit—and ensures the test remains correct if the preset value changes.

This also aligns with the style guide's principle of using compile-time constants to document and enforce invariants.

    const indices_len = preset.MAX_VALIDATORS_PER_COMMITTEE + 1;
    var indices: [indices_len]ValidatorIndex = undefined;
References
  1. The style guide encourages asserting relationships of compile-time constants to document and enforce invariants. While not a direct assertion, using the constant here makes the relationship explicit and the code more maintainable. (link)

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.

1 participant