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: add proposer info to block, add new endpoint to fetch last prop… #55

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

yevhen-burkovskyi
Copy link
Contributor

…osed blocks, add new websocket event

@yevhen-burkovskyi yevhen-burkovskyi self-assigned this Jul 2, 2024
Copy link

coderabbitai bot commented Jul 2, 2024

Walkthrough

The recent changes introduce an additional endpoint RECENTLY_PROPOSED_BLOCKS to the StakingEndpoints enum and update several methods in the StakingCache and StakingService classes to facilitate caching and retrieving recently proposed blocks. A new method getRecentlyProposedBlocks has been added to the StakingController. Moreover, the blockUpdate method in StakingGateway now emits a more general event without a specific address. These modifications enhance the handling and access of recently proposed blocks.

Changes

File Path Change Summary
src/modules/staking/.../staking-endpoints.enum.ts Added a new endpoint RECENTLY_PROPOSED_BLOCKS to the StakingEndpoints enum.
src/modules/staking/.../staking.cache.ts Renamed methods related to recently proposed blocks and added a new method to retrieve these blocks.
src/modules/staking/.../staking.service.ts Refactored getValidatorByAddress, added findSingleValidator, updated newBlock logic, and added getRecentlyProposedBlocks method.
src/modules/staking/.../staking.controller.ts Introduced a new method getRecentlyProposedBlocks with a @Get decorator to handle requests for recently proposed blocks.
src/modules/staking/.../staking.gateway.ts Added an additional event emission in blockUpdate method to emit a more general event.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant StakingController
    participant StakingService
    participant StakingCache
    participant StakingGateway

    Client->>+StakingController: GET /recently-proposed-blocks
    StakingController->>+StakingService: getRecentlyProposedBlocks()
    StakingService->>+StakingCache: getRecentlyProposedBlocks()
    StakingCache-->>-StakingService: [blocks]
    StakingService-->>-StakingController: [blocks]
    StakingController-->>-Client: [blocks]
    
    Client->>+StakingService: newBlock(blockInfo)
    StakingService->>StakingService: Process blockInfo
    StakingService->>+StakingCache: setValidatorRecentlyProposedBlock(blockInfo)
    StakingService-->>-Client: Block Processed
    StakingService->>+StakingGateway: Emit "proposed_block"
Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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 Configration 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a065878 and 9abb18e.

Files selected for processing (5)
  • src/modules/staking/enums/staking-endpoints.enum.ts (1 hunks)
  • src/modules/staking/services/staking.cache.ts (1 hunks)
  • src/modules/staking/services/staking.service.ts (4 hunks)
  • src/modules/staking/staking.controller.ts (1 hunks)
  • src/modules/staking/staking.gateway.ts (1 hunks)
Additional comments not posted (11)
src/modules/staking/enums/staking-endpoints.enum.ts (1)

10-10: Add a comment for the new endpoint.

Consider adding a comment to describe the purpose of the new RECENTLY_PROPOSED_BLOCKS endpoint for better readability and maintainability.

  // Endpoint to fetch recently proposed blocks
  RECENTLY_PROPOSED_BLOCKS = '/recently-proposed-blocks',
src/modules/staking/staking.gateway.ts (1)

22-22: Ensure proper handling of WebSocket events.

The addition of a general event emission for proposed_block is a good update. Make sure that this does not lead to any unintended side effects or performance issues due to the increased number of event listeners.

src/modules/staking/staking.controller.ts (1)

78-81: Add error handling for the new endpoint.

Ensure that the new getRecentlyProposedBlocks endpoint has proper error handling to manage potential failures gracefully.

src/modules/staking/services/staking.cache.ts (2)

83-87: Ensure proper TTL for caching recently proposed blocks.

Verify that the TTL (time-to-live) for caching recently proposed blocks is set appropriately to balance between performance and data freshness.


96-102: Ensure consistency in caching mechanisms.

Verify that the caching mechanisms used in getRecentlyProposedBlocks are consistent with other similar methods to maintain uniformity and avoid potential issues.

src/modules/staking/services/staking.service.ts (6)

345-351: LGTM!

The function correctly uses the new findSingleValidator method and handles the case where the validator is not found.


353-358: LGTM!

The new method findSingleValidator is implemented correctly to find a validator by address.


Line range hint 359-399: LGTM!

The newBlock method now includes logic to handle validators and caching, including caching recently proposed blocks and emitting events. The integration appears correct.


Line range hint 521-528: LGTM!

The method correctly uses getValidatorRecentlyProposedBlocks from the cache, and the sorting logic remains intact.


553-555: LGTM!

The new method getRecentlyProposedBlocks is implemented correctly to retrieve recently proposed blocks from the cache.


Line range hint 511-514: LGTM!

The function correctly retrieves and returns recently proposed blocks for a specific validator.

src/modules/staking/services/staking.cache.ts Show resolved Hide resolved
@yevhen-burkovskyi yevhen-burkovskyi force-pushed the feat/dashboard-recently-proposed-blocks branch from 9abb18e to 787529d Compare July 2, 2024 15:07
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 9abb18e and 787529d.

Files selected for processing (5)
  • src/modules/staking/enums/staking-endpoints.enum.ts (1 hunks)
  • src/modules/staking/services/staking.cache.ts (1 hunks)
  • src/modules/staking/services/staking.service.ts (4 hunks)
  • src/modules/staking/staking.controller.ts (1 hunks)
  • src/modules/staking/staking.gateway.ts (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • src/modules/staking/enums/staking-endpoints.enum.ts
  • src/modules/staking/services/staking.cache.ts
  • src/modules/staking/services/staking.service.ts
  • src/modules/staking/staking.controller.ts
  • src/modules/staking/staking.gateway.ts

@yevhen-burkovskyi yevhen-burkovskyi force-pushed the feat/dashboard-recently-proposed-blocks branch from 787529d to 6de82ac Compare July 2, 2024 15:16
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 787529d and 6de82ac.

Files selected for processing (5)
  • src/modules/staking/enums/staking-endpoints.enum.ts (1 hunks)
  • src/modules/staking/services/staking.cache.ts (1 hunks)
  • src/modules/staking/services/staking.service.ts (4 hunks)
  • src/modules/staking/staking.controller.ts (1 hunks)
  • src/modules/staking/staking.gateway.ts (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • src/modules/staking/enums/staking-endpoints.enum.ts
  • src/modules/staking/services/staking.cache.ts
  • src/modules/staking/services/staking.service.ts
  • src/modules/staking/staking.controller.ts
  • src/modules/staking/staking.gateway.ts

@yevhen-burkovskyi yevhen-burkovskyi merged commit 3f700a1 into main Jul 3, 2024
11 checks passed
@yevhen-burkovskyi yevhen-burkovskyi deleted the feat/dashboard-recently-proposed-blocks branch July 3, 2024 05:58
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