Add debug_flowHeight API endpoint #669

janezpodhostnik · 2024-11-20T16:32:52Z

Description

Added debug_flowHeight API endpoint so you can get the flow height at a given EVM block

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

coderabbitai · 2024-11-20T16:33:01Z

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.

janezpodhostnik · 2024-11-20T17:20:27Z

@zhangchiqing @m-Peter What do you think of the API endpoint name?

zhangchiqing · 2024-11-20T17:24:55Z

api/debug.go

@@ -361,6 +361,24 @@ func (d *DebugAPI) TraceCall(
 	return tracer.GetResult()
 }

+// FlowHeight returns the Flow height for the given EVM block.
+func (d *DebugAPI) FlowHeight(


Suggested change

func (d *DebugAPI) FlowHeight(

func (d *DebugAPI) FlowHeightByEVMBlock(

Then we would have to query it by: eth_flowHeightByEVMBlock, it's rather easy to get it wrong 😅

FlowHeightByBlock maybe?

Then we would have to query it by: eth_flowHeightByEVMBlock, it's rather easy to get it wrong 😅

Why it's easy to get wrong? Sorry, I didn't get it.

Because it seems to me as a rather long name, with various capital letters and mixed terminology (height vs block). Personally, I wouldn't remember it easily 😅 I don't have a strong preference for the name.

OK. Is TraceBlockByNumber auto mapped to debug_traceBlockByNumber? If so, debug_flowHeightByEVMBlock is the same naming convention, right?

Yep, the naming convention is just to prepend the namespace (e.g. eth_ / net / debug) and lowercase the first character of the method name. debug_flowHeightByEVMBlock is also fine, I believe we will have this command documented, so it's not like we will write it by hand.

Though I am not entirely sure if it will be debug_flowHeightByEVMBlock or debug_flowHeightByEvmBlock.

Though I am not entirely sure if it will be debug_flowHeightByEVMBlock or debug_flowHeightByEvmBlock.

Oh, I see your concern now. Yeah, let's find out.

I'm ok that we name it to FlowHeightByBlock to avoid being mapped to debug_flowHeightByEvmBlock, which looks weird. In that case, we better mention EVM block in the comments.

I tried this locally, and it will be mapped to debug_flowHeightByEVMBlock, so only the first character of the method name gets lower-cased. The rest remains intact.

api/debug.go

tests/e2e_web3js_test.go

tests/web3js/debug_util_test.js

m-Peter

Awesome 👏

m-Peter · 2024-11-21T09:56:48Z

@janezpodhostnik I forgot to mention, there's also this map here: https://github.com/onflow/flow-evm-gateway/blob/main/api/api.go#L37-L39, so we might want to update it, when we settle on the endpoint's name 🙏

janezpodhostnik · 2024-11-21T11:13:39Z

@janezpodhostnik I forgot to mention, there's also this map here: https://github.com/onflow/flow-evm-gateway/blob/main/api/api.go#L37-L39, so we might want to update it, when we settle on the endpoint's name 🙏

Thanks. Added.

I also changed the method name as per the current consensus.

m-Peter

LGTM!

janezpodhostnik · 2024-11-21T14:54:25Z

@zhangchiqing are you ok with the naming?

zhangchiqing

LGTM

Add debug_flowHeight API endpoint

646c16b

janezpodhostnik self-assigned this Nov 20, 2024

janezpodhostnik requested review from peterargue, m-Peter and zhangchiqing as code owners November 20, 2024 16:32

update readme

575017b

zhangchiqing approved these changes Nov 20, 2024

View reviewed changes

m-Peter reviewed Nov 20, 2024

View reviewed changes

tests/e2e_web3js_test.go Outdated Show resolved Hide resolved

m-Peter reviewed Nov 20, 2024

View reviewed changes

tests/web3js/debug_util_test.js Outdated Show resolved Hide resolved

m-Peter reviewed Nov 20, 2024

View reviewed changes

tests/web3js/debug_util_test.js Outdated Show resolved Hide resolved

apply review comments

e61ac1c

m-Peter approved these changes Nov 20, 2024

View reviewed changes

renamed method

0fff9b1

m-Peter approved these changes Nov 21, 2024

View reviewed changes

zhangchiqing approved these changes Nov 21, 2024

View reviewed changes

janezpodhostnik merged commit dd2b134 into feature/local-tx-reexecution Nov 21, 2024
2 checks passed

m-Peter deleted the janez/flow-block-height branch January 14, 2025 08:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug_flowHeight API endpoint #669

Add debug_flowHeight API endpoint #669

janezpodhostnik commented Nov 20, 2024

coderabbitai bot commented Nov 20, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

janezpodhostnik commented Nov 20, 2024

zhangchiqing Nov 20, 2024

m-Peter Nov 20, 2024

janezpodhostnik Nov 20, 2024

zhangchiqing Nov 20, 2024

m-Peter Nov 20, 2024 •

edited

Loading

zhangchiqing Nov 20, 2024

m-Peter Nov 20, 2024

m-Peter Nov 20, 2024

zhangchiqing Nov 20, 2024

m-Peter Nov 21, 2024

m-Peter left a comment

m-Peter commented Nov 21, 2024

janezpodhostnik commented Nov 21, 2024

m-Peter left a comment

janezpodhostnik commented Nov 21, 2024

zhangchiqing left a comment

	func (d *DebugAPI) FlowHeight(
	func (d *DebugAPI) FlowHeightByEVMBlock(

Add debug_flowHeight API endpoint #669

Add debug_flowHeight API endpoint #669

Conversation

janezpodhostnik commented Nov 20, 2024

Description

coderabbitai bot commented Nov 20, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

janezpodhostnik commented Nov 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-Peter Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-Peter left a comment

Choose a reason for hiding this comment

m-Peter commented Nov 21, 2024

janezpodhostnik commented Nov 21, 2024

m-Peter left a comment

Choose a reason for hiding this comment

janezpodhostnik commented Nov 21, 2024

zhangchiqing left a comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)

m-Peter Nov 20, 2024 •

edited

Loading