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

Implement BlockSnapshotProvider & BlockSnapshot interfaces #632

Merged

Conversation

m-Peter
Copy link
Collaborator

@m-Peter m-Peter commented Oct 28, 2024

Closes: #630
Closes: #631

Description

  • Adds two new types that implement the BlockSnapshotProvider & BlockSnapshot interfaces
  • Injects the BlocksProvider type to the Event Ingestion Engine, with a default callTracer
  • Keeps track of EVM blocks that are received

For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@m-Peter m-Peter self-assigned this Oct 28, 2024
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@m-Peter m-Peter changed the base branch from main to mpeter/aggregate-evm-event-payloads October 28, 2024 16:02
@m-Peter m-Peter added this to the Flow-EVM-M2 milestone Oct 28, 2024
latestBlockPayload *events.BlockEventPayload
}

var _ evmTypes.BlockSnapshotProvider = (*BlocksProvider)(nil)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the existing Blocks in blocks.go could implement this

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately that is not possible, in my opinion. Inside the processEvents of the Engine type, we want to first replay the received EVM block and all its transactions, and if no error or state changes occur, we'll then continue with updating the local state index, the blocks / transactions / receipts indices. Which means, that the Blocks index, does not yet have that current block which is still being processed and replayed.
That's why I have added the OnBlockReceived & OnBlockExecuted methods, to keep track of the latest block that we're processing in BlocksProvider. This will allow the GetSnapshotAt and BlockContext methods to work properly.

}

func (bp *BlocksProvider) OnBlockReceived(blockEvent *events.BlockEventPayload) error {
if bp.latestBlockPayload != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of using latestBlockPayload evmTypes.BlockSnapshot should be implemented by a separate object.

something like

type blockSnapshot {
  BlocksProvider
  height uint64
}

the block context would then look like:

func (bs *blockSnapshot) BlockContext() (evmTypes.BlockContext, error) {
   return bs.BlocksProvider.BlockContext(bs.height)

}

while GetSnapshotAt would look like:

func (bp *BlocksProvider) GetSnapshotAt(height uint64) (
	evmTypes.BlockSnapshot,
	error,
) {
	return *blockSnapshot{
           BlocksProvider: bp,
           height: height
        }, nil
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point 👍 The BlocksProvider is rather counter-intuitive, with implementing both interfaces, so I have moved the BlockSnapshot interface to a dedicated object. See: d9890bf#diff-8eafa2e76b08bd95e6922ee08584718a271ae9f9bf7d1d18bd6c959ee6edb7a3R23-R28

@m-Peter m-Peter force-pushed the mpeter/implement-block-snapshot-provider branch from 2dc415a to db86472 Compare October 29, 2024 14:29
@m-Peter m-Peter marked this pull request as ready for review October 30, 2024 08:26
@m-Peter m-Peter force-pushed the mpeter/implement-block-snapshot-provider branch 2 times, most recently from 2211feb to d9890bf Compare October 30, 2024 11:22
return fmt.Errorf("received nil block")
}

if bp.latestBlock != nil {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to eliminate this case by initializing BlocksProvider with a block?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed this in 3cbf6ae#diff-b3cc424323a936972f841745ae20117fcd028cecb7305a8ee4054023ca021e63R78-R90.

Basically I was thinking of BlocksProvider as a long-lived object, that is wired in the event ingestion component.

Every time a new EVM block comes in (a.k.a latest block here, which is the latest received block from the Event Streaming API, that has not been replayed & indexed yet in EVM Gateway).

Right now, I only check that the received Block is sequential to the latest block, if there's any.

b.storages.Blocks,
b.config.FlowNetworkID,
tracer,
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we read the latest block and initialize the blocks provider with it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #632 (comment).
The latestBlock field of BlocksProvider is not the latest indexed block on the EVM Gateway's DB.
It is the latest block the event ingestion engine has received, and the one that should be replayed. If no errors or state mismatches occur, this block will be saved in the EVM Gateway's DB.

blocks := setupBlocksDB(t)
blocksProvider := NewBlocksProvider(blocks, flowGo.Emulator, nil)

err := blocksProvider.OnBlockReceived(nil)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a valid case? I think it's the caller's responsibility to ensure the block is not nil.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I've removed this in 3cbf6ae.

Base automatically changed from mpeter/aggregate-evm-event-payloads to feature/local-tx-reexecution October 30, 2024 17:40
@m-Peter m-Peter force-pushed the mpeter/implement-block-snapshot-provider branch from d9890bf to 3cbf6ae Compare October 30, 2024 19:01
Comment on lines +35 to +39
// If the given block height, is more than 256 blocks
// in the past, return an empty block hash.
if bs.block.Height-n > 256 {
return gethCommon.Hash{}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// If the given block height, is more than 256 blocks
// in the past, return an empty block hash.
if bs.block.Height-n > 256 {
return gethCommon.Hash{}
}

I think bs.blocks.GetByHeight(n) handles this case already

Copy link
Collaborator Author

@m-Peter m-Peter Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I remove this line, then the relevant test case fails with:

Not equal: 
expected: 0x0000000000000000000000000000000000000000000000000000000000000000
actual  : 0x5bc86e647028e549fd4e95bd845fee4ea79f4e32eef71ebe2d0aa5cf3dc64985

That's because bs.blocks.GetByHeight(n) is using the Blocks DB of the EVM Gateway, which contains all blocks since genesis block. See: https://github.com/onflow/flow-evm-gateway/blob/main/storage/pebble/blocks.go#L124-L144.
We keep track of all indexed blocks in EVM Gateway, so we can return the proper response for endpoints such as:

  • eth_getBlockByNumber
  • eth_getBlockByHash
  • eth_getBlockReceipts etc

An EVM transaction, however, when it is being replayed by the EVM Gateway, it should have access only to the last 256 blocks. Hence this condition in required in the GetHashFunc of BlockContext type.

@m-Peter m-Peter merged commit 7b0085e into feature/local-tx-reexecution Oct 31, 2024
2 checks passed
@m-Peter m-Peter deleted the mpeter/implement-block-snapshot-provider branch October 31, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ✅ Done
3 participants