event

Type Aliases

EventArgs<T>

type EventArgs<T>: T extends TypedEvent<infer _, infer TObj> ? TObj : never;

The type of the event arguments. Gets the second generic arg

Type parameters

Type parameter
T

Source

dataEntities/event.ts:10

---

EventFromFilter<TFilter>

type EventFromFilter<TFilter>: TFilter extends TypedEventFilter<infer TEvent> ? TEvent : never;

The event type of a filter Gets the first generic arg

Type parameters

Type parameter
TFilter

Source

dataEntities/event.ts:18

---

TypeChainContractFactory<TContract>

type TypeChainContractFactory<TContract>: object;

Typechain contract factories have additional properties

Type parameters

Type parameter
TContract extends Contract

Type declaration

Member	Type
connect	TContract
createInterface	Interface

Source

dataEntities/event.ts:41

Functions

parseTypedLog()

function parseTypedLog<TContract, TFilterName>(
   contractFactory: TypeChainContractFactory<TContract>, 
   log: Log, 
filterName: TFilterName): null | EventArgs<EventFromFilter<ReturnType<TContract["filters"][TFilterName]>>>

Parse a log that matches a given filter name.

Type parameters

Type parameter
TContract extends Contract
TFilterName extends string

Parameters

Parameter	Type	Description
contractFactory	TypeChainContractFactory<TContract>
log	Log	The log to parse
filterName	TFilterName

Returns

null | EventArgs<EventFromFilter<ReturnType<TContract["filters"][TFilterName]>>>

Null if filter name topic does not match log topic

Source

dataEntities/event.ts:53

---

parseTypedLogs()

function parseTypedLogs<TContract, TFilterName>(
   contractFactory: TypeChainContractFactory<TContract>, 
   logs: Log[], 
   filterName: TFilterName): EventArgs<EventFromFilter<ReturnType<TContract["filters"][TFilterName]>>>[]

Parses an array of logs. Filters out any logs whose topic does not match provided the filter name topic.

Type parameters

Type parameter
TContract extends Contract
TFilterName extends string

Parameters

Parameter	Type	Description
contractFactory	TypeChainContractFactory<TContract>
logs	Log[]	The logs to parse
filterName	TFilterName

Returns

EventArgs<EventFromFilter<ReturnType<TContract["filters"][TFilterName]>>>[]

Source

dataEntities/event.ts:78