graph-tooling icon indicating copy to clipboard operation
graph-tooling copied to clipboard

Please document the fields in your Ethereum types

Open PaulRBerg opened this issue 7 months ago • 0 comments

Which packages are impacted by your issue?

@graphprotocol/graph-ts

https://github.com/graphprotocol/graph-tooling/blob/4b4ad3e22322ea30ae8e27143a759c1fcc6b12e0/packages/ts/chain/ethereum.ts#L531-L618

Describe the issue

It would be super duper helpful if the ethereum types, e.g. Transaction, Event`, etc., contained explanatory comments.

Lacking this information leads to uncertainty, e.g.:

  • https://github.com/graphprotocol/graph-tooling/discussions/2035
  • https://github.com/graphprotocol/graph-tooling/discussions/2036
  • https://discord.com/channels/438038660412342282/438070183794573313/1276303366221201499

In particular, I see that you provide some types that are not part of the standard Ethereum JavaScript API, e.g. transactionLogIndex. This index value can be easily misunderstood for the transactionIndex, which is the index of the tx within the block.

Explanatory comments would provide clarity.

PaulRBerg avatar May 18 '25 11:05 PaulRBerg