SyncingSubscription

subscribe('syncing')

Subscribe to syncing events. This will return true when the node is syncing and when it’s finished syncing will return false, for the changed event.

@example

(await web3.eth.subscribe('syncing')).on('changed', console.log);
> `true` // when syncing

(await web3.eth.subscribe('syncing')).on('data', console.log);
> {
     startingBlock: 0,
     currentBlock: 0,
     highestBlock: 0,
     pulledStates: 0,
     knownStates: 0
  }

Hierarchy

• Web3Subscription<{ changed: boolean; data: SyncOutput }>
  • SyncingSubscription

Index

Constructors

• constructor

Properties

• args

Accessors

• id
• lastBlock

Methods

• _processSubscriptionError
• _processSubscriptionResult
• emit
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• processSubscriptionData
• removeAllListeners
• resubscribe
• sendSubscriptionRequest
• sendUnsubscribeRequest
• setMaxListenerWarningThreshold
• subscribe
• unsubscribe

Constructors

constructor

• new SyncingSubscription(args: any, options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<unknown, {}> }): SyncingSubscription
• new SyncingSubscription(args: any, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): SyncingSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: any

  • options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<unknown, {}> }

  • optionalreturnFormat: DataFormat

  • subscriptionManager: Web3SubscriptionManager<unknown, {}>

  Returns SyncingSubscription

Properties

readonlyargs

args: any

Inherited from Web3Subscription.args

Accessors

id

• get id(): undefined | string

• Inherited from Web3Subscription.id

  Returns undefined | string

lastBlock

• get lastBlock(): undefined | BlockOutput

• Inherited from Web3Subscription.lastBlock

  Returns undefined | BlockOutput

Methods

_processSubscriptionError

• _processSubscriptionError(error: Error): void

• Inherited from Web3Subscription._processSubscriptionError

  Parameters

  • error: Error

  Returns void

public_processSubscriptionResult

• _processSubscriptionResult(data: boolean | { status: SyncOutput; syncing: boolean }): void

• Overrides Web3Subscription._processSubscriptionResult

  Parameters

  • data: boolean | { status: SyncOutput; syncing: boolean }

  • status: SyncOutput

  • syncing: boolean

  Returns void

emit

• emit<K>(eventName: K, params: { changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • params: { changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3Subscription.eventNames

  Returns (string | symbol)[]

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3Subscription.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3Subscription.listenerCount

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  Returns number

listeners

• listeners<K>(eventName: K): (...args: any[]) => void[]

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  Returns (...args: any[]) => void[]

off

• off<K>(eventName: K, fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>): void

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>): void

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>

  Returns void

once

• once<K>(eventName: K, fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>): void

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ changed: boolean; data: SyncOutput } & CommonSubscriptionEvents[K]>

  Returns void

processSubscriptionData

• processSubscriptionData(data: JsonRpcSubscriptionResult | JsonRpcSubscriptionResultOld<Log> | JsonRpcNotification<Log>): void

• Inherited from Web3Subscription.processSubscriptionData

  Parameters

  • data: JsonRpcSubscriptionResult | JsonRpcSubscriptionResultOld<Log> | JsonRpcNotification<Log>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3Subscription.removeAllListeners

  Returns EventEmitter

resubscribe

• resubscribe(): Promise<void>

• Inherited from Web3Subscription.resubscribe

  Returns Promise<void>

sendSubscriptionRequest

• sendSubscriptionRequest(): Promise<string>

• Inherited from Web3Subscription.sendSubscriptionRequest

  Returns Promise<string>

sendUnsubscribeRequest

• sendUnsubscribeRequest(): Promise<void>

• Inherited from Web3Subscription.sendUnsubscribeRequest

  Returns Promise<void>

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3Subscription.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

subscribe

• subscribe(): Promise<string>

• Inherited from Web3Subscription.subscribe

  Returns Promise<string>

unsubscribe

• unsubscribe(): Promise<void>

• Inherited from Web3Subscription.unsubscribe

  Returns Promise<void>