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

feat(registry): add getallregistrants #158

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

namn-grg
Copy link
Contributor

@namn-grg namn-grg commented Jul 23, 2024

fixes #157

Summary by CodeRabbit

  • New Features
    • Introduced a method to retrieve all active registrants associated with operators.
    • Added a public array to track active operator addresses for improved operator management.
  • Improvements
    • Enhanced the accessibility of the operator status check, allowing internal and external calls.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2024

Walkthrough

The recent updates to the BoltRegistry contract significantly enhance operator management and improve querying capabilities for registrants. A new public array operators has been introduced to track active operators, while the getAllRegistrants method allows for efficient retrieval of registrants associated with those operators. Additionally, the isActiveOperator function's visibility has been changed to public, enhancing its accessibility for internal contract functions.

Changes

File Change Summary
bolt-contracts/src/contracts/BoltRegistry.sol - Added address[] public operators for tracking active operators.
- Introduced function getAllRegistrants() external view returns (Registrant[] memory) for retrieving registrants.
- Changed isActiveOperator visibility from external to public.

Assessment against linked issues

Objective Addressed Explanation
Add a way to query all registered validators in Bolt-registry (#157)

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 95a64f8 and 3d0adaf.

Files selected for processing (1)
  • bolt-contracts/src/contracts/BoltRegistry.sol (3 hunks)
Additional comments not posted (2)
bolt-contracts/src/contracts/BoltRegistry.sol (2)

112-112: Visibility change approved.

Changing the visibility of the isActiveOperator function from external to public is appropriate, as it allows internal calls within the contract, which is necessary for the new getAllRegistrants function.


16-17: Ensure proper management of the operators array.

The operators array is added to store operator addresses. Verify that operators are correctly added and removed to avoid stale or incorrect data.

bolt-contracts/src/contracts/BoltRegistry.sol Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 3d0adaf and 78ba5de.

Files selected for processing (1)
  • bolt-contracts/src/contracts/BoltRegistry.sol (3 hunks)
Additional comments not posted (2)
bolt-contracts/src/contracts/BoltRegistry.sol (2)

112-113: Visibility change approved.

Changing the visibility of the isActiveOperator function from external to public is a good change as it increases accessibility within the contract.


136-154: Optimize the allocation for active operators.

The getAllRegistrants function currently allocates space for all operators, which might include inactive ones. Optimize the allocation to include only active operators.

function getAllRegistrants() external view returns (Registrant[] memory) {
    uint256 activeCount = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            activeCount++;
        }
    }

    Registrant[] memory _registrants = new Registrant[](activeCount);
    uint256 index = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            _registrants[index] = registrants[operators[i]];
            index++;
        }
    }

    return _registrants;
}

Likely invalid or redundant comment.

bolt-contracts/src/contracts/BoltRegistry.sol Show resolved Hide resolved
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.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 78ba5de and 74693db.

Files selected for processing (1)
  • bolt-contracts/src/contracts/BoltRegistry.sol (4 hunks)
Additional comments not posted (3)
bolt-contracts/src/contracts/BoltRegistry.sol (3)

16-17: Add code to manage the operators array.

The operators array is declared but there is no code to add or remove addresses from this array.

Ensure that the operators array is properly managed by adding code to handle additions and removals.


114-114: Visibility change approved.

The change in visibility from external to public enhances the function's accessibility and improves the modularity and efficiency of the contract's logic.


138-156: Optimize the allocation for active operators.

The getAllRegistrants function currently allocates space for all operators, which might include inactive ones. Optimize the allocation to include only active operators.

function getAllRegistrants() external view returns (Registrant[] memory) {
    uint256 activeCount = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            activeCount++;
        }
    }

    Registrant[] memory _registrants = new Registrant[](activeCount);
    uint256 index = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            _registrants[index] = registrants[operators[i]];
            index++;
        }
    }

    return _registrants;
}

bolt-contracts/src/contracts/BoltRegistry.sol Show resolved Hide resolved
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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 74693db and f688c9a.

Files selected for processing (1)
  • bolt-contracts/src/contracts/BoltRegistry.sol (5 hunks)
Additional comments not posted (5)
bolt-contracts/src/contracts/BoltRegistry.sol (5)

16-18: Add code to manage the operators array.

The operators array is declared but there is no code to add or remove addresses from this array.

Ensure that the operators array is properly managed by adding code to handle additions and removals.


53-54: Ensure removal of operators from the operators array upon exit.

The register function adds the operator to the operators array, but there is no corresponding code to remove the operator from the array when they exit. This may lead to stale data in the operators array.

-        delete registrants[msg.sender];
+        // Remove operator from the operators array
+        for (uint256 i = 0; i < operators.length; i++) {
+            if (operators[i] == msg.sender) {
+                operators[i] = operators[operators.length - 1];
+                operators.pop();
+                break;
+            }
+        }
+
+        delete registrants[msg.sender];

100-107: LGTM!

The code correctly removes the operator from the operators array upon exit.


123-125: LGTM!

Changing the visibility of the isActiveOperator function from external to public is appropriate and enhances internal contract functionality.


147-165: Optimize the allocation for active operators.

The getAllRegistrants function currently allocates space for all operators, which might include inactive ones. Optimize the allocation to include only active operators.

function getAllRegistrants() external view returns (Registrant[] memory) {
    uint256 activeCount = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            activeCount++;
        }
    }

    Registrant[] memory _registrants = new Registrant[](activeCount);
    uint256 index = 0;
    for (uint256 i = 0; i < operators.length; i++) {
        if (isActiveOperator(operators[i])) {
            _registrants[index] = registrants[operators[i]];
            index++;
        }
    }

    return _registrants;
}

@merklefruit merklefruit merged commit a82db11 into unstable Jul 25, 2024
2 checks passed
@merklefruit merklefruit deleted the feat/registry/query-all-validators branch July 25, 2024 07:32
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.

feat(contracts): add a way to query all registered validators in Bolt-registry
4 participants