Class SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>`Abstract`

A base class to handle common Subgraph query logic.

Type Parameters

TResult extends ILightEntity
TListQuery extends SubgraphListQuery<TFilter, TOrderBy>
TSubgraphQuery
TSubgraphQueryVariables extends Exact<{
    block?: InputMaybe<Block_Height>;
    first?: InputMaybe<Scalars["Int"]["input"]>;
    orderBy?: InputMaybe<TOrderBy>;
    orderDirection?: InputMaybe<OrderDirection>;
    skip?: InputMaybe<Scalars["Int"]["input"]>;
    where?: InputMaybe<TFilter>;
}>
TFilter extends {
id?: InputMaybe<Scalars["ID"]["input"]>;
id_gt?: InputMaybe<Scalars["ID"]["input"]>;
} = NonNullable<TListQuery["filter"]>
TOrderBy extends string = NonNullable<TListQuery["order"]>["orderBy"]

Implements

Index

Constructors

constructor

new SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>(): SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>
Type Parameters
- TResult extends ILightEntity
- TListQuery extends SubgraphListQuery<TFilter, TOrderBy>
- TSubgraphQuery
- TSubgraphQueryVariables extends Exact<{
      block?: InputMaybe<Block_Height>;
      first?: InputMaybe<number>;
      orderBy?: InputMaybe<TOrderBy>;
      orderDirection?: InputMaybe<OrderDirection>;
      skip?: InputMaybe<number>;
      where?: InputMaybe<TFilter>;
  }>
- TFilter extends {
  id?: InputMaybe<string>;
  id_gt?: InputMaybe<string>;
  } = NonNullable<TListQuery["filter"]>
- TOrderBy extends string = NonNullable<TListQuery["order"]>["orderBy"]
Returns SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>

Properties

`Private` getRelevantAddressesFromFilterByAddressFieldKeys

getRelevantAddressesFromFilterByAddressFieldKeys: any

For every primary address field key there are more fields generated which it should look for addresses. NOTE: The implementation is a bit "magical" but it rids of a bunch of boilerplate and creates a single point for editing.

`Abstract` requestDocument

requestDocument: TypedDocumentNode<TSubgraphQuery, TSubgraphQueryVariables>

Methods

get

get(subgraphClient, query): Promise<null | TResult>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphGetQuery
Returns Promise<null | TResult>
Implementation of SubgraphGetQueryHandler.get
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:95

`Abstract` getAddressFieldKeysFromFilter

getAddressFieldKeysFromFilter(): {
accountKeys: (keyof TFilter)[];
tokenKeys: (keyof TFilter)[];
}
Returns {
accountKeys: (keyof TFilter)[];
tokenKeys: (keyof TFilter)[];
}
- accountKeys: (keyof TFilter)[]
- tokenKeys: (keyof TFilter)[]
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:82

getRelevantAddressesFromFilter

getRelevantAddressesFromFilter(filter?): RelevantAddresses
Parameters
- Optional filter: TFilter
Returns RelevantAddresses
Implementation of RelevantAddressProviderFromFilter.getRelevantAddressesFromFilter
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:86

getRelevantAddressesFromResult

getRelevantAddressesFromResult(result?): RelevantAddresses
Parameters
- Optional result: null | TResult
Returns RelevantAddresses
Implementation of RelevantAddressProviderFromResult.getRelevantAddressesFromResult
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:93

`Protected` `Abstract` getRelevantAddressesFromResultCore

getRelevantAddressesFromResultCore(result): RelevantAddressesIntermediate
Parameters
- result: TResult
Returns RelevantAddressesIntermediate
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:92

list

list(subgraphClient, query): Promise<PagedResult<TResult>>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphListQuery<TFilter, TOrderBy>
Returns Promise<PagedResult<TResult>>
Implementation of SubgraphListQueryHandler.list
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:96

`Abstract` mapFromSubgraphResponse

mapFromSubgraphResponse(response): TResult[]
Parameters
- response: TSubgraphQuery
Returns TResult[]
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:94

`Protected` querySubgraph

querySubgraph(subgraphClient, variables): Promise<TSubgraphQuery>
Parameters
- subgraphClient: SubgraphClient
- variables: TSubgraphQueryVariables
Returns Promise<TSubgraphQuery>
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:97

Class SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>Abstract

Type Parameters

TResult extends ILightEntity

TListQuery extends SubgraphListQuery<TFilter, TOrderBy>

TSubgraphQuery

TSubgraphQueryVariables extends Exact<{ block?: InputMaybe<Block_Height>; first?: InputMaybe<Scalars["Int"]["input"]>; orderBy?: InputMaybe<TOrderBy>; orderDirection?: InputMaybe<OrderDirection>; skip?: InputMaybe<Scalars["Int"]["input"]>; where?: InputMaybe<TFilter>; }>

TFilter extends { id?: InputMaybe<Scalars["ID"]["input"]>; id_gt?: InputMaybe<Scalars["ID"]["input"]>; } = NonNullable<TListQuery["filter"]>

TOrderBy extends string = NonNullable<TListQuery["order"]>["orderBy"]

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TResult extends ILightEntity

TListQuery extends SubgraphListQuery<TFilter, TOrderBy>

TSubgraphQuery

TSubgraphQueryVariables extends Exact<{ block?: InputMaybe<Block_Height>; first?: InputMaybe<number>; orderBy?: InputMaybe<TOrderBy>; orderDirection?: InputMaybe<OrderDirection>; skip?: InputMaybe<number>; where?: InputMaybe<TFilter>; }>

TFilter extends { id?: InputMaybe<string>; id_gt?: InputMaybe<string>; } = NonNullable<TListQuery["filter"]>

TOrderBy extends string = NonNullable<TListQuery["order"]>["orderBy"]

Returns SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>

Properties

Private getRelevantAddressesFromFilterByAddressFieldKeys

Abstract requestDocument

Methods

get

Parameters

subgraphClient: SubgraphClient

query: SubgraphGetQuery

Returns Promise<null | TResult>

Abstract getAddressFieldKeysFromFilter

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

accountKeys: (keyof TFilter)[]

tokenKeys: (keyof TFilter)[]

getRelevantAddressesFromFilter

Parameters

Optional filter: TFilter

Returns RelevantAddresses

getRelevantAddressesFromResult

Parameters

Optional result: null | TResult

Returns RelevantAddresses

Protected Abstract getRelevantAddressesFromResultCore

Parameters

result: TResult

Returns RelevantAddressesIntermediate

list

Parameters

subgraphClient: SubgraphClient

query: SubgraphListQuery<TFilter, TOrderBy>

Returns Promise<PagedResult<TResult>>

Abstract mapFromSubgraphResponse

Parameters

response: TSubgraphQuery

Returns TResult[]

Protected querySubgraph

Parameters

subgraphClient: SubgraphClient

variables: TSubgraphQueryVariables

Returns Promise<TSubgraphQuery>

Settings

Member Visibility

Theme

On This Page

Class SubgraphQueryHandler<TResult, TListQuery, TSubgraphQuery, TSubgraphQueryVariables, TFilter, TOrderBy>`Abstract`

TSubgraphQueryVariables extends Exact<{
block?: InputMaybe<Block_Height>;
first?: InputMaybe<Scalars["Int"]["input"]>;
orderBy?: InputMaybe<TOrderBy>;
orderDirection?: InputMaybe<OrderDirection>;
skip?: InputMaybe<Scalars["Int"]["input"]>;
where?: InputMaybe<TFilter>;
}>

TFilter extends {
id?: InputMaybe<Scalars["ID"]["input"]>;
id_gt?: InputMaybe<Scalars["ID"]["input"]>;
} = NonNullable<TListQuery["filter"]>

TSubgraphQueryVariables extends Exact<{
block?: InputMaybe<Block_Height>;
first?: InputMaybe<number>;
orderBy?: InputMaybe<TOrderBy>;
orderDirection?: InputMaybe<OrderDirection>;
skip?: InputMaybe<number>;
where?: InputMaybe<TFilter>;
}>

TFilter extends {
id?: InputMaybe<string>;
id_gt?: InputMaybe<string>;
} = NonNullable<TListQuery["filter"]>

`Private` getRelevantAddressesFromFilterByAddressFieldKeys

`Abstract` requestDocument

`Abstract` getAddressFieldKeysFromFilter

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

`Optional` filter: TFilter

`Optional` result: null | TResult

`Protected` `Abstract` getRelevantAddressesFromResultCore

`Abstract` mapFromSubgraphResponse

`Protected` querySubgraph