ethers.js icon indicating copy to clipboard operation
ethers.js copied to clipboard

Wrong (Unclear?) property specification in ethers.Log

Open oswaldoleal opened this issue 9 months ago • 2 comments

Suggestion

Inside the provider.Log definition the specifications for the index and transactionIndex properties seem to be swapped.

When in the context of a Log, the transactionIndex property name should refer to the index of a the log's transaction within the block while the index property should refer to the log's index within a transaction/block.

The implementation is fine, but the documentation being swapped is missleading. Either, the definitions are wrong or the property names are wrong (unclear at the very least)

Images of the documentation

Image

Image

oswaldoleal avatar Mar 11 '25 19:03 oswaldoleal

Hi! It looks like the PR linked above (#4962) is stale. Can I pick this issue and open a fresh PR to update the documentation?

undefinedIsMyLife avatar Nov 18 '25 17:11 undefinedIsMyLife

Hi! It looks like the PR linked above (#4962) is stale. Can I pick this issue and open a fresh PR to update the documentation?

The fix implemented on the PR referenced there is correct, I don't really know why it wasn't merged to main. Maybe it was overlooked by the maintainers, idk

oswaldoleal avatar Nov 18 '25 17:11 oswaldoleal