search

ExocoreNetwork / exocore

Omnichain Restaking
7 stars 9 forks source link

fix(oralce):separate prepareRound from endBlock into beginBlock #122

Closed leonz789 closed 2 months ago

leonz789 commented 3 months ago

Description

Move prepareRound from EndBlock into Beginblock. Currently we invoke prepareRound in the EndBlock of every block after all transaction executed. When there're create-price transactions in the first block since a node restart(like when a node restart from some height x, and some create-price messages are included in height x by other validators), the aggregator will be initialized/recached when the first message executed, this will consume extra gas which will conduct different gasUsed compared to other validators/nodes execution. In this fix, we put the prepareRound into BeginBlock. In this way, avoid the initialization of aggregator be executed inside transaction.

Closes #XXX

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes across the x/oracle/keeper package involve renaming and modifying the PrepareRound method to PrepareRoundBeginBlock, along with adjustments to block calculation logic for feeders. Logging enhancements have been made to price proposal processing, and various updates to context preparation and round handling in multiple files.

Changes

File Change Summary
x/oracle/keeper/aggregator/context.go Renamed PrepareRound method to PrepareRoundBeginBlock with new block calculation logic.
x/oracle/keeper/aggregator/context_test.go Reflected the renaming of PrepareRound to PrepareRoundBeginBlock and updated related test logic.
x/oracle/keeper/msg_server_create_price.go Added logging with additional context during price proposal processing within CreatePrice function.
x/oracle/keeper/single.go Adjusted block calculations and replaced PrepareRound with PrepareRoundBeginBlock across multiple functions.
x/oracle/module.go Updated BeginBlock to include new preparation logic for oracle rounds and modified EndBlock to update logging and context reset.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OracleModule
    participant AggregatorContext
    participant Cache

    User->>OracleModule: Send BeginBlock
    OracleModule->>Cache: Retrieve AggregatorContext
    OracleModule->>AggregatorContext: PrepareRoundBeginBlock
    OracleModule->>User: Acknowledge BeginBlock

    User->>OracleModule: Send EndBlock
    OracleModule->>AggregatorContext: Seal active rounds
    OracleModule->>AggregatorContext: Reset context
    OracleModule->>User: Respond with new validator updates

Poem

In the realm of code so fine,
PrepareRound takes on a new design.
Logs now whisper, more context to bear,
Oracle’s heart beats with care.
Round by round, each block stands tall,
Keeper’s changes bless us all.
🌟🐰🚀

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
leonz789 commented 2 months ago

merged into #118