Bisonai / orakl

Official Oracle of Kaia Blockchain
https://orakl.network
MIT License
69 stars 13 forks source link

(OraklNode) Pub/Sub based GlobalAggregate & Proof storage #1715

Closed nick-bisonai closed 1 week ago

nick-bisonai commented 1 week ago

Description

Publish GlobalAggregate & Proof through redis to be referenced later also from data availability layer application

Type of change

Please delete options that are not relevant.

Checklist before requesting a review

Deployment

coderabbitai[bot] commented 1 week ago
Walkthrough ## Walkthrough This update involves multiple enhancements and refactoring across several files in the `node` package. Key additions include a new `SubmissionData` struct, refactoring functions for managing global aggregates and proofs, a new function for generating stream keys, and improved resource management in Redis subscriptions. Test functions for Redis publishing and subscribing have also been added, and a couple of error declarations have been removed. ## Changes | Files | Change Summary | |--------------------------------------------|------------------------------------------------------------------------------------------------------------| | `node/pkg/aggregator/types.go` | Added `SubmissionData` struct and `Streamer` field in `App` struct. Changed `Proof` type declaration to alias `types.Proof`. | | `node/pkg/aggregator/utils.go` | Refactored functions for inserting and publishing global aggregates and proofs, added new retrieval functions, removed redundant functions. | | `node/pkg/common/keys/keys.go` | Introduced `SubmissionDataStreamKey` function for generating submission data stream keys. | | `node/pkg/db/redis.go` | Added `defer sub.Close()` in `Subscribe` function to ensure proper resource management. | | `node/pkg/db/redis_test.go` | Added new test functions for publishing and subscribing tests including `TestRedisPublish`, `TestRedisPublishEmptyValue`, `TestRedisPublishEmptyChannel`, and `TestRedisSubscribeEmptyChannel`. | | `node/pkg/error/sentinel.go` | Removed `ErrAggregatorProofInsertion` and `ErrAggregatorInvalidGlobalAggInsertion`. Modified `ErrAggregatorNotFound`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant App participant Aggregator participant DB App->>Aggregator: SetLatestGlobalAggregateAndProof(proof, aggregate) Aggregator->>DB: Store(proof, aggregate) App->>Aggregator: PublishGlobalAggregateAndProof(proof, aggregate) Aggregator->>DB: Publish(proof, aggregate) App->>Aggregator: getLatestGlobalAggregateFromPgs() Aggregator->>DB: Retrieve Latest Aggregate DB-->>Aggregator: Latest Aggregate Data Aggregator-->>App: Aggregate Data ``` ## Poem > In code's domain where functions dwell, > New structs and keys now cast their spell. > Aggregates and proofs take flight, > In tests they shine, both day and night. > Close the subs, let resources rest, > Redis, you've truly passed the test.

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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.
nick-bisonai commented 1 week ago

@coderabbitai full review

coderabbitai[bot] commented 1 week ago
Actions performed Full review triggered.