Skip to main content

Module: dataEntities/event

EventArgs

EventArgs: &lt;T&gt; T extends TypedEvent< infer _, infer TObj > ? TObj : never

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

Type parameters

Parameter
T

Source

arbitrum-sdk/src/lib/dataEntities/event.ts:10


EventFromFilter

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

The event type of a filter Gets the first generic arg

Type parameters

Parameter
TFilter

Source

arbitrum-sdk/src/lib/dataEntities/event.ts:18


TypeChainContractFactory

TypeChainContractFactory: <TContract>object;

Typechain contract factories have additional properties

Type parameters

Parameter
TContract extends Contract

Type declaration

MemberType
connect
createInterface

Source

arbitrum-sdk/src/lib/dataEntities/event.ts:41


parseTypedLog()

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

Parse a log that matches a given filter name.

Type parameters

Parameter
TContract extends Contract\< TContract >
TFilterName extends string

Parameters

ParameterTypeDescription
contractFactoryTypeChainContractFactory\< TContract >
logLogThe log to parse
filterNameTFilterName

Returns

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

Null if filter name topic does not match log topic

Source

arbitrum-sdk/src/lib/dataEntities/event.ts:53


parseTypedLogs()

parseTypedLogs<TContract, TFilterName>(
contractFactory,
logs,
filterName): 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

Parameter
TContract extends Contract\< TContract >
TFilterName extends string

Parameters

ParameterTypeDescription
contractFactoryTypeChainContractFactory\< TContract >
logsLog[]The logs to parse
filterNameTFilterName

Returns

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

Source

arbitrum-sdk/src/lib/dataEntities/event.ts:78