Incorrect Typing on contract.queryFilter

[rzmay]

Ethers Version

5.6.2

Search Terms

No response

Describe the Problem

There's an incorrect type definition on the queryFilter method of the BaseContract class. The event argument's type on line 1041 is only used once in the method, on the call to this._getRunningEvent on the immediately following line.

private _getRunningEvent(eventName: EventFilter | string): RunningEvent {
        // ...
}

queryFilter(event: EventFilter, fromBlockOrBlockhash?: BlockTag | string, toBlock?: BlockTag): Promise<Array<Event>> {
        const runningEvent = this._getRunningEvent(event);
        // ...
}

The type for the argument passed to this._getRunningEvent is EventFilter | string, but the only allowed type for the event argument in the queryFilter method is EventFilter. The type of the event argument on the queryFilter method should match the type in the _getRunningEvent.

Suggested change:

queryFilter(event: EventFilter | string, fromBlockOrBlockhash?: BlockTag | string, toBlock?: BlockTag): Promise<Array<Event>> { /* ... */ }

Code Snippet

// Type '"MyEventName"' has no properties in common with type 'EventFilter'.
const events = await contract.queryFilter('MyEventName', block);

Contract ABI

No response

Errors

No response

Environment

No response

Environment (Other)

No response

[henriqueoelze]

Facing the same problem here and agreed with everything above.

[ricmoo]

The call only narrows the type, but I agree, it seems like a wasted opportunity. This will require a minor version bump, and I'll tag it for that, but I don't plan one in next few weeks at least, unless there is a strong need for one.

In the meantime though, this should work:

const logs = await contract.queryFilter(contract.filters.Transfer());

You could also cast it to an EventFilter, but that feels uncomfy...

In v6, things are much more flexible as you can pass in "Transfer", contract.filters.Transfer or contract.filters.Transfer() to all achieve the same thing.

[ricmoo]

This has been updated in v5.7.0.

Thanks! :)