wrong & missing return for `/evm/transactions` endpoint

Open
#127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Start with the OpenAPI documentation for the /evm/transactions endpoint and compare its response schema with the raw output described in the issue. Trace the documented fields for gas_used, effective_gas_price, success, and the max_* values, then update the documentation so the schema and endpoint response agree; confirm the endpoint reference no longer lists conflicting fields.

Written by the indexing model from the issue text.

Description

Hey Team,

It seems like the raw output vs openapi schema does not align for sim.

The endpoint also returns gas_used, effective_gas_price and success, while the spec defines max_fee_per_gas, max_priority_fee_per_gas (which are not being returned) and also no success attribute is defined.
While I understand that the spec has those max_* returns as optional and IIRC I have seen them existing in Echo in the past, the success seems like the most crucially missing attribute here.

Also might be an oversight to double return the same value with gas_price and effective_gas_price:

Image

Thanks,
8x4

Dominant language
MDX
Stars
6
Forks
6
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from duneanalytics/sim-docs

All issues in duneanalytics/sim-docs

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.