EventOptions | Truffle Decoding and Encoding

The type of the options parameter to [[WireDecoder.events|events()]]. This type will be expanded in the future as more filtering options are added.

Hierarchy

EventOptions

Index

Properties

Optional address

address?: string

If included, will restrict to events emitted by the given address.

NOTE: In the contract instance decoder, if omitted, defaults to the address of the contract instance being decoded, rather than not filtering by address. However, this behavior can be turned off by explicitly specifying address as undefined.

Optional disableChecks

disableChecks?: boolean

Allows decodings that don't pass the re-encoding test. Don't turn this on unless you know what you're doing!

Optional extras

extras?: ExtrasAllowed

Used to indicate whether "extra" event decodings -- event decodings from non-library contracts other than the one that appears to have emitted the event -- should be returned. Defaults to "off".

Optional fromBlock

fromBlock?: BlockSpecifier

The earliest block to include events from. Defaults to "latest".

Optional name

name?: string

If included, the name parameter will restrict to events with the given name.

Optional toBlock

toBlock?: BlockSpecifier

The latest block to include events from. Defaults to "latest".