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

Requests to access node use CCF encoding from now on #53

Merged

Conversation

illia-malachyn
Copy link
Contributor

@illia-malachyn illia-malachyn commented May 16, 2024

Closes #41

Summary by CodeRabbit

  • New Features

    • Enhanced event and transaction processing with updated encoding version for improved data handling.
  • Bug Fixes

    • Improved error logging for event hash mismatches.
  • Configuration

    • Updated testnet-clone.json with new spork configuration for better network synchronization.

@illia-malachyn
Copy link
Contributor Author

Can u review it? @peterargue

@peterargue
Copy link
Collaborator

peterargue commented May 21, 2024

I got it working in my original PR against testnet. needed to make the following changes

  • Update to v0.33.17
  • Update the onflow/flow-core-contracts to v1.2.4
  • Add code to handle decoding CCF encoded payloads

After those changes, it was able to index using my PR.

@illia-malachyn I think the issues you had were related to updating to library versions that do not support testnet which is running v0.33. Try with the go.mod in my PR

@illia-malachyn
Copy link
Contributor Author

illia-malachyn commented May 23, 2024

The indexer is working even without these changes. I added the decodePayload function as it seems reasonable. I didn't update to the versions you've proposed. Is that fine?

@illia-malachyn
Copy link
Contributor Author

illia-malachyn commented May 23, 2024

I double-checked this PR. The indexer works well. All 3 commits are required.
We can merge it I guess @peterargue

@illia-malachyn illia-malachyn force-pushed the illia-malachyn/41-fix-event-hash-check branch from 1734640 to 0a062b3 Compare May 23, 2024 15:05
go.mod Outdated Show resolved Hide resolved
@illia-malachyn illia-malachyn force-pushed the illia-malachyn/41-fix-event-hash-check branch from 0a062b3 to ae4023f Compare May 27, 2024 16:40
Copy link

coderabbitai bot commented May 27, 2024

Walkthrough

The recent changes enhance the encoding and processing of events and transactions by introducing the EventEncodingVersion field in several functions within access/access.go. This ensures that the payloads are correctly formatted in the CCF format. Additionally, the event hash check in state/process.go has been updated to handle full event payloads. The testnet-clone.json file also saw updates in the spork configuration.

Changes

File Path Change Summary
access/access.go Added EventEncodingVersion field to multiple functions to ensure correct payload formatting.
state/convert.go Replaced jsoncdc.Decode with decodePayload for handling different payload decoding scenarios.
state/process.go Updated loop to use eventHash and added error logging for mismatched event hashes.
testnet-clone.json Updated spork configuration: changed root_block and version for spork ID 37.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant AccessService
    participant Entities

    Client->>AccessService: BlockEvents()
    AccessService->>Entities: GetEventsForBlockIDsRequest(EventEncodingVersion)
    Entities-->>AccessService: Event Data
    AccessService-->>Client: Event Data

    Client->>AccessService: Transaction()
    AccessService->>Entities: GetTransactionRequest(EventEncodingVersion)
    Entities-->>AccessService: Transaction Data
    AccessService-->>Client: Transaction Data

    Client->>AccessService: TransactionResult()
    AccessService->>Entities: GetTransactionByIndexRequest(EventEncodingVersion)
    Entities-->>AccessService: Transaction Result Data
    AccessService-->>Client: Transaction Result Data
Loading

Assessment against linked issues

Objective (Issue #41) Addressed Explanation
Convert payload format to the correct CCF format
Request full event payload, including system events
Correct event hash computation

In code's embrace, events now flow,
With CCF they rightly show.
Hashes checked, errors caught,
Progress made, solutions brought.
Sporks aligned in JSON's glow,
Onward, upward, let us go!


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.

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 full the 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 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: 0

Outside diff range and nitpick comments (2)
state/process.go (2)

Line range hint 307-324: Consider refactoring to reduce complexity and improve readability.

The nested loops and conditionals in the processBlock function make it hard to follow and maintain. Consider breaking down the function into smaller, more manageable functions. Each segment handling a specific part of the block processing (e.g., transaction fetching, result processing, error handling) could be a separate function.


Line range hint 366-391: Add documentation to clarify the purpose and behavior of useSlowPath.

The useSlowPath function uses specific error codes and messages to determine the control flow. Adding detailed documentation about why each error leads to the slow path would help maintainers understand the decision logic. Additionally, consider defining constants for error messages to avoid magic strings in the code.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between bab50a2 and ae4023f.
Files ignored due to path filters (2)
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum
Files selected for processing (4)
  • access/access.go (6 hunks)
  • state/convert.go (3 hunks)
  • state/process.go (2 hunks)
  • testnet-clone.json (1 hunks)
Additional comments not posted (4)
testnet-clone.json (1)

21-28: The updated sporks configuration with the new root_block and version values seems correct. Ensure that these values are consistent with the intended spork updates for the testnet environment.

state/convert.go (2)

7-9: The addition of new imports for cadence, ccf, and jsoncdc is appropriate for supporting the new CCF encoding. Ensure that these libraries are compatible with the rest of the project dependencies.


Line range hint 186-214: The implementation of decodeEvent and decodePayload to handle CCF encoded payloads is a crucial part of the solution to the problem described in Issue #41. It's important to ensure that the error handling and logging within these functions are robust and provide enough information for debugging.

access/access.go (1)

168-170: The addition of the EventEncodingVersion field set to entities.EventEncodingVersion_CCF_V0 in various client methods is a significant change. This aligns with the PR's objective to standardize the event encoding to CCF format. Ensure that this new encoding version is supported and correctly implemented in all related backend services and that it does not break existing functionalities.

Also applies to: 390-391, 411-413, 434-435, 460-461, 481-482

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.

[Rosetta] Fix Event hash check
2 participants