Class HypersyncClient

HyperSync client for querying blockchain data

Index

Constructors

Methods

collect collectEvents collectParquet get getChainId getEvents getHeight getWithRateLimit rateLimitInfo stream streamEvents streamHeight waitForRateLimit newWithAgent

Constructors

constructor

new HypersyncClient(cfg): HypersyncClient
Create a new client with given config
Parameters
- cfg: ClientConfig
Returns HypersyncClient
- Defined in index.d.ts:68

Methods

collect

collect(query, config): Promise<QueryResponse>
Collect blockchain data from the given query
Parameters
- query: Query
- config: StreamConfig
Returns Promise<QueryResponse>
- Defined in index.d.ts:83

collectEvents

collectEvents(query, config): Promise<EventResponse>
Collect blockchain events from the given query
Parameters
- query: Query
- config: StreamConfig
Returns Promise<EventResponse>
- Defined in index.d.ts:85

collectParquet

collectParquet(path, query, config): Promise<void>
Collect blockchain data and save to parquet format
Parameters
- path: string
- query: Query
- config: StreamConfig
Returns Promise<void>
- Defined in index.d.ts:87

get

get(query): Promise<QueryResponse>
Get blockchain data for a single query
Parameters
- query: Query
Returns Promise<QueryResponse>
- Defined in index.d.ts:89

getChainId

getChainId(): Promise<number>
Get the chain_id of the source hypersync instance

Returns Promise<number>
- Defined in index.d.ts:81

getEvents

getEvents(query): Promise<EventResponse>
Get blockchain events for a single query
Parameters
- query: Query
Returns Promise<EventResponse>
- Defined in index.d.ts:91

getHeight

getHeight(): Promise<number>
Get the height of the source hypersync instance

Returns Promise<number>
- Defined in index.d.ts:79

getWithRateLimit

getWithRateLimit(query): Promise<QueryResponseWithRateLimit>
Get blockchain data for a single query, with rate limit info
Parameters
- query: Query
Returns Promise<QueryResponseWithRateLimit>
- Defined in index.d.ts:93

rateLimitInfo

rateLimitInfo(): RateLimitInfo
Get the most recently observed rate limit information. Returns null if no requests have been made yet.

Returns RateLimitInfo
- Defined in index.d.ts:98

stream

stream(query, config): Promise<QueryResponseStream>
Stream blockchain data from the given query
Parameters
- query: Query
- config: StreamConfig
Returns Promise<QueryResponseStream>
- Defined in index.d.ts:107

streamEvents

streamEvents(query, config): Promise<EventStream>
Stream blockchain events from the given query
Parameters
- query: Query
- config: StreamConfig
Returns Promise<EventStream>
- Defined in index.d.ts:109

streamHeight

streamHeight(): Promise<HeightStream>
Stream chain height events

Returns Promise<HeightStream>
- Defined in index.d.ts:105

waitForRateLimit

waitForRateLimit(): Promise<void>
Wait until the current rate limit window resets. Returns immediately if no rate limit info observed or quota available.

Returns Promise<void>
- Defined in index.d.ts:103

`Static` newWithAgent

newWithAgent(cfg, userAgent): HypersyncClient
Internal
Create a new client with custom user agent

This method is intended for internal use when you need to customize the user agent string. Most users should use new() instead.
Parameters
- cfg: ClientConfig
- userAgent: string
Returns HypersyncClient
- Defined in index.d.ts:77