TransactionReceipt interface is missing the optional events property

[leeren]

This is the TransactionReceipt interface declaration in @ethersproject/abstract-providers:

export interface TransactionReceipt {
    to: string;
    from: string;
    contractAddress: string;
    transactionIndex: number;
    root?: string;
    gasUsed: BigNumber;
    logsBloom: string;
    blockHash: string;
    transactionHash: string;
    logs: Array<Log>;
    blockNumber: number;
    confirmations: number;
    cumulativeGasUsed: BigNumber;
    effectiveGasPrice: BigNumber;
    byzantium: boolean;
    type: number;
    status?: number;
}

events should be included as a property if wait() is called on the originating TransactionResponse. Could this please be added?

[ricmoo]

The events property is only available on a ContractReceipt (see the docs), as a normal receipt does not have access to the ABI.

(moving to discussions)

[aspiers]

Filed as #2512.

[aspiers]

Also just noticed that https://docs.ethers.io/v5/api/contract/contract/#contract-functionsSend seems to be misleading, in that it claims to return a TransactionResponse, but actually returns a ContractTransaction which is an extension of that with the extra property of having a wait() method which returns the ContractReceipt mentioned above:

ethers.js/packages/contracts/src.ts/index.ts

Lines 103 to 105 in 0578a88

	export interface ContractTransaction extends TransactionResponse {
	wait(confirmations?: number): Promise<ContractReceipt>;
	}

Again, for anyone using TypeScript, not knowing this can be a blocker.

[pheuberger]

I want to second what @aspiers wrote. I ran into the exact same issue today and was mightily confused by the documentation (or lack thereof). I hope this will be addressed.

[Sh0g0-1758]

I ran into this issue today. Hopefully ethers.js team will fix it.

[ricmoo]

@Sh0g0-1758 It is included in the docs: https://docs.ethers.org/v6/api/contract/#ContractTransactionResponse

Because not all logs are certain to have a matching event, it returns a Log or EventLog.

[KuphJr]

I just ran into this issue today. The confusing thing is, getting transaction events works fine in Ethers version 5.7.2.
In fact, I am using that older version for my project as I am unsure of how else to get events without creating a listener, which is cumbersome.
Until either the documentation is updated or there is a fix to this, I will have to use the previous version.

[ricmoo]

Do you have an example of one that works in v5 and not v6? Any transaction hash with the relevant ABI fragments will suffice. You only get events for logs which Have a corresponding Event in the ABI. It please include any additional info and I’ll get to it right away.

[pacorain]

I have been having trouble with this trying to write smart contract tests with Hardhat on Ethers v6. All of my Googling brought me here, as well as some v5 code that doesn’t work (Property 'events' does not exist on type 'ContractTransactionReceipt'.). So I’m sharing how I was able to get it working.

Whenever I would await tx, I would get a ContractTransactionReceipt back, which doesn’t have an events property. I couldn’t find any kind of receipt in the v6 docs that had events.

Instead, I found that contracts have a queryFilter function for querying event logs, and figured out how to use that.

Here is the code I was able to get working. factory is the contract that is emitting an event here, and I am trying to get data (i.e. a new contract address) from that event.

            const { factory, owner } = await loadFixture(deployExampleContractFactoryFixture);
            const tx = await factory.newExampleContract();
            const receipt = await tx.wait();

            const events = await factory.queryFilter(factory.filters.ExampleContractCreated, receipt?.blockNumber, receipt?.blockNumber)
            const addressString = events[0].args[0];

            const newContract = await ethers.getContractAt("ExampleContract", addressString, owner);

            expect(await newContract.someValue()).to.equal(0)

Another way (and possibly the intended way) to do it is to use ContractTransactionReceipt.logs, which returns Array< EventLog | Log >. However, I struggled with this because TypeScript is new to me and I couldn’t figure out how to transform that into an array of event logs.

[ricmoo]

An EventLog is only available for events which have a corresponding Event fragment in the ABI. I can add a type guard function though, which will ensure within the scope it is an EventLog. For now, you can use something like:

function isEventLog(value: any): value is EventLog {
  return (value && !!value.event);
}

// when using your TypeScript, you can then use:
if (isEventLog(log)) {
  // TypeScript will no longer complain:
  console.log("Event", log.event);
}

Does that make sense? I’ll add a similar static method to the EventLog class.

[mshakeg]

log.event doesn't seem to exist on EventLog in hardhat-ethers@3.0.0 but fragment does so I did:

function isEventLog(value: Log | EventLog): value is EventLog {
  return (value && !!value.fragment);
}