Skip to content

Conversation

@phessophissy
Copy link

Description

This PR adds a new EVM Usability Extension (Section 1.4.2.13) that enhances the user experience of block explorer applications by providing additional data in list endpoints, reducing the need for multiple API calls.

Motivation

This directly addresses the contribution suggestion in Section 3.1:

"EVM Usability Extension: The API standard currently includes only the minimal information about transactions, blocks, proofs, and other entities... For example, Etherscan displays the sender and recipient of each transaction in the list of the most recent transactions. The requirement TX4 in Section 1.4.1.1 only stipulates that the list should contain identifiers (such as transaction hashes)... Formulating the requirements for such an extension, and the specification of the required API, would be a great community contribution."

New Features

Enhanced Transaction Lists

  • Sender and receiver addresses
  • Transaction value
  • Method name/selector for contract calls
  • Timestamp and fee
  • Token transfer count

Enhanced Block Lists

  • Transaction count
  • Gas used/limit
  • Block proposer/validator
  • Block reward

Filtering

  • Filter transactions by address

New Requirements

ID Description Type
X_USE_1 Display sender address in tx list Core
X_USE_2 Display receiver address in tx list Core
X_USE_3 Display value in tx list Core
X_USE_4 Display method name in tx list Optional
X_USE_5 Display timestamp in tx list Core
X_USE_6 Display fee in tx list Optional
X_USE_7 Display tx count in block list Core
X_USE_8 Display gas used in block list Optional
X_USE_9 Display proposer in block list Optional
X_USE_10 Support address filtering Core

Files Changed

  • README.md - Added Section 1.4.2.13 and updated API spec list
  • open-api/1_4_2_13_evm_usability.yml - New OpenAPI specification

Checklist

  • Follows existing documentation style
  • OpenAPI spec follows existing conventions
  • Requirements follow ID naming pattern (X_USE_*)
  • Added to API Specification list in Section 1.3
  • Addresses explicit contribution suggestion from maintainers

This adds a new EVM Usability Extension (Section 1.4.2.13) that provides
enhanced data in list endpoints to improve user experience, similar to
how Etherscan displays transaction lists.

Features include:
- Transaction lists with sender, receiver, value, method name
- Block lists with transaction count, gas used, proposer
- Address filtering for transactions

This directly addresses the contribution suggestion in Section 3.1:
'EVM Usability Extension: The API standard currently includes only
the minimal information... Formulating the requirements for such an
extension would be a great community contribution.'

Includes:
- New OpenAPI spec: open-api/1_4_2_13_evm_usability.yml
- Requirements X_USE_1 through X_USE_10 in README.md
- Updated API Specification list in Section 1.3
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.

1 participant