Skip to content

docs(handler): clarify PrecompileProvider::run return semantics#3769

Open
flag4table wants to merge 1 commit into
bluealloy:mainfrom
flag4table:main
Open

docs(handler): clarify PrecompileProvider::run return semantics#3769
flag4table wants to merge 1 commit into
bluealloy:mainfrom
flag4table:main

Conversation

@flag4table

Copy link
Copy Markdown

Clarifies the return semantics of PrecompileProvider::run.

The docs now distinguish between:

  • Ok(Some(output)) when the provider handled the precompile call
  • Ok(None) when the provider does not contain a precompile for the requested address
  • Err(error) for provider errors that should abort EVM execution

This also documents that non-fatal precompile failures should be represented in the returned output instead of Err.

Closes #2393.

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.

Consider documenting Ok(None) and Err case for PrecompileProvider::run

1 participant