onflow / rosetta

Rosetta implementation for the Flow blockchain
Apache License 2.0
15 stars 13 forks source link

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

Closed illia-malachyn closed 4 months ago

illia-malachyn commented 4 months ago

Closes #41

Summary by CodeRabbit

illia-malachyn commented 4 months ago

Can u review it? @peterargue

peterargue commented 4 months ago

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

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 commented 4 months ago

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 commented 4 months ago

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

coderabbitai[bot] commented 4 months ago

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

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 - [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.` 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](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.