Class EventQueryHandler

A base class to handle common Subgraph query logic.

Hierarchy (view full)

SubgraphQueryHandler<AllEvents, EventListQuery, EventsQuery, EventsQueryVariables>
- EventQueryHandler

Index

Constructors

constructor

new EventQueryHandler(): EventQueryHandler
Returns EventQueryHandler
Inherited from SubgraphQueryHandler.constructor

Properties

getAddressFieldKeysFromFilter

getAddressFieldKeysFromFilter: (() => {
accountKeys: (keyof Event_Filter)[];
tokenKeys: (keyof Event_Filter)[];
})

Type declaration

- (): {
  accountKeys: (keyof Event_Filter)[];
  tokenKeys: (keyof Event_Filter)[];
  }
- Returns {
  accountKeys: (keyof Event_Filter)[];
  tokenKeys: (keyof Event_Filter)[];
  }
  - accountKeys: (keyof Event_Filter)[]
  - tokenKeys: (keyof Event_Filter)[]

requestDocument

requestDocument: TypedDocumentNode<EventsQuery, Exact<{
    block?: InputMaybe<Block_Height>;
    first?: number;
    orderBy?: Event_OrderBy;
    orderDirection?: OrderDirection;
    skip?: number;
    where?: Event_Filter;
}>>

Methods

get

get(subgraphClient, query): Promise<null | AllEvents>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphGetQuery
Returns Promise<null | AllEvents>
Inherited from SubgraphQueryHandler.get
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:95

getRelevantAddressesFromFilter

getRelevantAddressesFromFilter(filter?): RelevantAddresses
Parameters
- Optional filter: Event_Filter
Returns RelevantAddresses
Inherited from SubgraphQueryHandler.getRelevantAddressesFromFilter
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:86

getRelevantAddressesFromResult

getRelevantAddressesFromResult(result?): RelevantAddresses
Parameters
- Optional result: null | AllEvents
Returns RelevantAddresses
Inherited from SubgraphQueryHandler.getRelevantAddressesFromResult
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:93

getRelevantAddressesFromResultCore

getRelevantAddressesFromResultCore(): RelevantAddressesIntermediate
Returns RelevantAddressesIntermediate
Overrides SubgraphQueryHandler.getRelevantAddressesFromResultCore
- Defined in packages/sdk-core/dist/module/subgraph/events/events.d.ts:11

list

list(subgraphClient, query): Promise<PagedResult<AllEvents>>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphListQuery<Event_Filter, Event_OrderBy>
Returns Promise<PagedResult<AllEvents>>
Inherited from SubgraphQueryHandler.list
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:96

mapFromSubgraphResponse

mapFromSubgraphResponse(response): AllEvents[]
Parameters
- response: EventsQuery
Returns AllEvents[]
Overrides SubgraphQueryHandler.mapFromSubgraphResponse
- Defined in packages/sdk-core/dist/module/subgraph/events/events.d.ts:12

`Protected` querySubgraph

querySubgraph(subgraphClient, variables): Promise<EventsQuery>
Parameters
- subgraphClient: SubgraphClient
- variables: Exact<{
      block?: InputMaybe<Block_Height>;
      first?: number;
      orderBy?: Event_OrderBy;
      orderDirection?: OrderDirection;
      skip?: number;
      where?: Event_Filter;
  }>
Returns Promise<EventsQuery>
Inherited from SubgraphQueryHandler.querySubgraph
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:97

Class EventQueryHandler

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EventQueryHandler

Properties

getAddressFieldKeysFromFilter

Type declaration

Returns { accountKeys: (keyof Event_Filter)[]; tokenKeys: (keyof Event_Filter)[]; }

accountKeys: (keyof Event_Filter)[]

tokenKeys: (keyof Event_Filter)[]

requestDocument

Methods

get

Parameters

subgraphClient: SubgraphClient

query: SubgraphGetQuery

Returns Promise<null | AllEvents>

getRelevantAddressesFromFilter

Parameters

Optional filter: Event_Filter

Returns RelevantAddresses

getRelevantAddressesFromResult

Parameters

Optional result: null | AllEvents

Returns RelevantAddresses

getRelevantAddressesFromResultCore

Returns RelevantAddressesIntermediate

list

Parameters

subgraphClient: SubgraphClient

query: SubgraphListQuery<Event_Filter, Event_OrderBy>

Returns Promise<PagedResult<AllEvents>>

mapFromSubgraphResponse

Parameters

response: EventsQuery

Returns AllEvents[]

Protected querySubgraph

Parameters

subgraphClient: SubgraphClient

variables: Exact<{ block?: InputMaybe<Block_Height>; first?: number; orderBy?: Event_OrderBy; orderDirection?: OrderDirection; skip?: number; where?: Event_Filter; }>

Returns Promise<EventsQuery>

Settings

Member Visibility

Theme

On This Page

Returns {
accountKeys: (keyof Event_Filter)[];
tokenKeys: (keyof Event_Filter)[];
}

`Optional` filter: Event_Filter

`Optional` result: null | AllEvents

`Protected` querySubgraph

variables: Exact<{
block?: InputMaybe<Block_Height>;
first?: number;
orderBy?: Event_OrderBy;
orderDirection?: OrderDirection;
skip?: number;
where?: Event_Filter;
}>