Event Log types

[epheph]

In abstract-provider, the type for a Log is defined as:

export interface Log {
    blockNumber?: number;
    blockHash?: string;
    transactionIndex?: number;

    removed?: boolean;

    transactionLogIndex?: number,

    address: string;
    data: string;

    topics: Array<string>;

    transactionHash?: string;
    logIndex?: number;
}

I see that many of these are marked as optional with a ? . Some, like transactionHash, seem like they would always have to be there and others, like blockHash should perhaps be nullable and not optional (only if you wanted to match the JSON-RPC API more closely).

It seems that there are two types of Logs that get returned, one from a getLogs of a mined transaction (including logIndex, blockHash, etc) and one from a getLogs of pending (or from eth_getFilterChanges?), which has Object keys that are nullable/undefined?

Does that sound right architecturally?

[ricmoo]

It might make more sense to break that into two types of logs, but there is one other reason sometimes those things aren't filled in nicely, mainly Ganache, which is not the most standards compliant beast, especially slightly older versions.

But for the most part a lot of those changes (as I recall) were added when the "pending" filter was added. I'll have to check my notes.

For now though, I think it makes enough sense though, no? Or are there problems with marking them as optional? I'm still fairly new to TypeScript.

[ricmoo]

I don't think that there are any Ganache issues any more with this, so I have made removed the optional component. If there are any problems please re-open the issue, but I think this is safe. :)

I also removed the transactionLogIndex, since that is only populated in certain calls (so it's not reliably available) and anyone who would have it, could easily compute it from the data the call returned.

The changes are local, but will go out with the next v5 release.

Thanks! :)

[ricmoo]

This was published in 5.0.0-beta.180.

Thanks! :)