Add events property to ContractFactory.deploy

[Dan-Nolan]

In testing I have been using the events property found on the TransactionReceipt. However, I just noticed that it is not documented:

const tx = await contract.setValue(value);
const receipt = await tx.wait();
const event = receipt.events.find(x => x.event === "ValueChange");

The reason this came up is the deployTransaction does not appear to have this same property:

const tx = contract.deployTransaction;
const receipt = await tx.wait();
console.log( receipt.events ); // undefined

Is events something we can depend on for tests or is this something that will potentially break in future versions?

[ra-phael]

+1

I was looking to get the values of an event from a transaction receipt. I couldn't find the answer in the docs and Google led me here #487.

After inspecting the receipt I was glad to find it's simply and conveniently there :)

const receipt = await tx.wait();
const firstEvent = receipt.events?.[0];
const eventArguments = firstEvent?.args;

[ricmoo]

This is not part of the Provider API, but instead an extension that Contracts apply.

There are some docs here. It may be a good idea to link to the Contract API from the Provider API though.

I should also add the events to the factory.deploy; I'll add this for the upcoming minor bump.

[ricmoo]

Fixed in 5.5.0. Try it out and let me know if there are any problems; if so re-open this please.

Thanks! :)

[ricmoo]

Fixed in 5.5.0. Try it out and let me know if there are any problems; if so re-open this please.

Thanks! :)