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

Use Remote State to generate traces for Debug API #567

Closed
wants to merge 21 commits into from

Conversation

m-Peter
Copy link
Collaborator

@m-Peter m-Peter commented Sep 23, 2024

Closes: #530 #583

Description


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 added this to the Flow-EVM-M2 milestone Sep 23, 2024
@m-Peter m-Peter self-assigned this Sep 23, 2024
Copy link
Contributor

coderabbitai bot commented Sep 23, 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 force-pushed the traces-api-use-remote-state branch 4 times, most recently from f79eb77 to 3e97e28 Compare September 23, 2024 14:23
@m-Peter m-Peter force-pushed the feature/remote-state branch from 68d27a8 to 8ccf6d5 Compare September 24, 2024 09:58
@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch from 3e97e28 to 7749f32 Compare September 24, 2024 10:20
@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch from 7749f32 to 06d260e Compare September 24, 2024 10:46
@m-Peter m-Peter marked this pull request as ready for review September 24, 2024 10:51
@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch from 06d260e to dd0196a Compare September 25, 2024 09:47
api/debug.go Outdated
Comment on lines 78 to 125
tracerConfig := json.RawMessage(tracerConfig)
tracerCtx := &tracers.Context{
BlockHash: receipt.BlockHash,
BlockNumber: receipt.BlockNumber,
TxIndex: int(receipt.TransactionIndex),
TxHash: receipt.TxHash,
}
tracer, err := tracers.DefaultDirectory.New(tracerName, tracerCtx, tracerConfig)
if err != nil {
return nil, err
}

block, err := d.blocks.GetByHeight(receipt.BlockNumber.Uint64())
if err != nil {
return nil, err
}
// We need to re-execute the given transaction and all the
// transactions that precede it in the same block, based on
// the previous block state, to generate the correct trace.
previousBlock, err := d.blocks.GetByHeight(block.Height - 1)
if err != nil {
return nil, err
}
previousBlockHeight := previousBlock.Height

client, err := d.client.GetClientForHeight(previousBlockHeight)
if err != nil {
return nil, err
}

exeClient, ok := client.(*grpc.Client)
if !ok {
return nil, fmt.Errorf("could not convert to execution client")
}

ledger, err := evm.NewRemoteLedger(exeClient.ExecutionDataRPCClient(), previousBlockHeight)
if err != nil {
return nil, fmt.Errorf("could not create remote ledger for height: %d, with: %w", previousBlockHeight, err)
}

blockExecutor, err := evm.NewBlockExecutor(
previousBlock,
ledger,
d.config.FlowNetworkID,
d.blocks,
d.receipts,
d.logger,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

we should extract all this logic into a tracer component. I don't like for API layer to have too much logic, it starts to get duplicated and it's harder to test in isolation. I suggest extracting the above into a tracer component in the services that just takes in a config of the tracer.

Copy link
Contributor

Choose a reason for hiding this comment

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

at that point we should also write unit tests with just the tracer component

@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch 3 times, most recently from 26dae9f to 713ab98 Compare September 25, 2024 13:43
@m-Peter m-Peter force-pushed the feature/remote-state branch from 8ccf6d5 to a0e6820 Compare September 30, 2024 07:22
@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch 3 times, most recently from 29188dd to 738ef71 Compare September 30, 2024 09:08
@m-Peter m-Peter force-pushed the traces-api-use-remote-state branch from 738ef71 to 4aff62b Compare September 30, 2024 09:47
@j1010001 j1010001 requested a review from ramtinms September 30, 2024 16:00
Comment on lines +78 to +81
var fixedHash *string
if payload.PrevRandao == gethCommon.HexToHash("0x0") {
hash := payload.Hash.String()
fixedHash = &hash
Copy link
Contributor

Choose a reason for hiding this comment

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

not sure why we populate it using this heuristic?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This change is not really related to the objective of the PR, but it is required due to upgrading the flow-go versioned.
This heuristic allows us to decode block events prior to the addition of the PrevRandao field. The decoding of legacy block events was moved in flow-go (https://github.com/onflow/flow-go/blob/master/fvm/evm/events/events.go#L188-L190), so we no longer have a way to distinguish them, hence the usage of this heuristic. I'll add a comment to describe this though, as it is for sure not clear why it's needed 😅

@m-Peter
Copy link
Collaborator Author

m-Peter commented Nov 4, 2024

Closing in favor of: #635

@m-Peter m-Peter closed this Nov 4, 2024
@m-Peter m-Peter deleted the traces-api-use-remote-state branch November 4, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants