Skip to content

docs: clarify Log.index vs Log.transactionIndex JSDoc comments #5145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xAxiom wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −4
Open

docs: clarify Log.index vs Log.transactionIndex JSDoc comments #5145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src.ts/providers/provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,14 +862,18 @@ export class Log implements LogParams {
readonly topics!: ReadonlyArray<string>;

/**
* The index within the block this log occurred at. This is generally
* not useful to developers, but can be used with the various roots
* to proof inclusion within a block.
* The index of this log within the block it was emitted in (i.e. the
* ``logIndex`` in the JSON-RPC receipt). This is generally not useful
* to developers, but can be used with the various roots to proof
* inclusion within a block.
*/
readonly index!: number;

/**
* The index within the transaction of this log.
* The index of the transaction that emitted this log within its block
* (i.e. the ``transactionIndex`` in the JSON-RPC receipt). This is
* **not** the log's position within the transaction — use
* [[Log-index]] for that.
*/
readonly transactionIndex!: number;

Expand Down