fix: add validation for authorization list in genesisState.Validate() for authority module

[kingpinXD]

Closes : #2653

How Has This Been Tested?

• Tested CCTX in localnet
• Tested in development environment
• Go unit tests
• Go integration tests
• Tested via GitHub Actions

Summary by CodeRabbit

• New Features

  • Introduced enhanced validation for the authorization module, improving security and integrity checks during the genesis state validation.
  • Added an AuthorizationList to the GenesisState, allowing for better tracking of authorization-related logic.

• Bug Fixes

  • Improved validation logic to ensure both AuthorizationList and ChainInfo are validated sequentially, enhancing the robustness of the validation process.

• Tests

  • Expanded test coverage for the GenesisState validation logic, including scenarios for the AuthorizationList.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the validation logic within the authorization module. Key updates include the addition of an AuthorizationList validation step in the GenesisState struct and improvements in test coverage to ensure comprehensive checks for both the AuthorizationList and ChainInfo. These modifications strengthen the security and integrity of the genesis state validation, providing clearer documentation and enhancing code clarity without altering the existing public entity declarations.

Changes

Files	Change Summary
x/authority/types/genesis.go, x/authority/types/genesis_test.go	Enhanced validation logic in GenesisState to include AuthorizationList. Test cases updated to reflect this change, ensuring robust coverage for authorization checks.
x/authority/migrations/v2/migrate.go	Added comments for clarity regarding the fixed nature of the authorization list, improving code readability.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GenesisState
    participant AuthorizationList

    Client->>GenesisState: Validate()
    GenesisState->>AuthorizationList: Validate()
    AuthorizationList-->>GenesisState: Validation Result
    GenesisState->>ChainInfo: Validate()
    ChainInfo-->>GenesisState: Validation Result
    GenesisState-->>Client: Overall Validation Result

Loading

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.35%. Comparing base (a3d3682) to head (ca8bede).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2654   +/-   ##
========================================
  Coverage    70.34%   70.35%           
========================================
  Files          338      338           
  Lines        18595    18599    +4     
========================================
+ Hits         13081    13085    +4     
  Misses        4922     4922           
  Partials       592      592           

Files	Coverage Δ
x/authority/migrations/v2/migrate.go	100.00% <ø> (ø)
x/authority/types/genesis.go	100.00% <100.00%> (ø)

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a3d3682 and ca8bede.

Files selected for processing (4)

• changelog.md (1 hunks)
• x/authority/migrations/v2/migrate.go (1 hunks)
• x/authority/types/genesis.go (1 hunks)
• x/authority/types/genesis_test.go (4 hunks)

Files skipped from review due to trivial changes (1)

• x/authority/migrations/v2/migrate.go

Additional context used

Path-based instructions (2)

x/authority/types/genesis.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

x/authority/types/genesis_test.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

Additional comments not posted (3)

x/authority/types/genesis.go (1)

17-23: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to Validate in GenesisState correctly handle the new validation for AuthorizationList.

Verification successful

---

LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to Validate in GenesisState correctly handle the new validation for AuthorizationList.

• File: x/observer/types/genesis_test.go
  • The Validate function is tested to ensure it handles both valid and invalid genesis states correctly.
• File: x/observer/module.go
  • The ValidateGenesis function calls genState.Validate() to validate the genesis state, ensuring the new validation is handled.
• File: x/emissions/module.go
  • Similar to x/observer/module.go, the ValidateGenesis function calls genState.Validate().
• File: x/authority/types/genesis.go
  • The Validate function in this file already includes validation for AuthorizationList.

The instances where Validate is called are handling the new validation logic correctly.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `Validate` in `GenesisState` handle the new validation for `AuthorizationList`.

# Test: Search for the function usage. Expect: Proper handling of the new validation.
rg --type go -A 5 $'Validate()'

Length of output: 248788

x/authority/types/genesis_test.go (1)

30-32: LGTM! But verify the test coverage.

The code changes are approved.

However, ensure that the test coverage is comprehensive and includes all edge cases for the AuthorizationList validation.

Also applies to: 47-48, 53-69, 73-96

changelog.md (1)

16-19: Changelog entry approved.

The changelog entry accurately reflects the changes made in the codebase.