LogsSubscription

subscribe('logs')

Subscribes to incoming logs, filtered by the given options. If a valid numerical fromBlock options property is set, web3.js will retrieve logs beginning from this point, backfilling the response as necessary.

You can subscribe to logs matching a given filter object, which can take the following parameters:

• fromBlock: (optional, default: 'latest') Integer block number, or 'latest' for the last mined block or 'pending', 'earliest' for not yet mined transactions.
• address: (optional) Contract address or a list of addresses from which logs should originate.
• topics: (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with or options.

Hierarchy

• Web3Subscription<{ data: LogsOutput }, { address?: Address | Address[]; fromBlock?: BlockNumberOrTag; topics?: Topic[] }>
  • LogsSubscription

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 LogsSubscription(args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }, options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<unknown, {}> }): LogsSubscription
• new LogsSubscription(args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }, options: { requestManager: Web3RequestManager<EthExecutionAPI>; returnFormat?: DataFormat }): LogsSubscription

• Inherited from Web3Subscription.constructor

  Parameters

  • args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }

  • optionalreadonlyaddress: string | string[]

  • optionalreadonlyfromBlock: BlockNumberOrTag

  • optionalreadonlytopics: string[]

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

  • optionalreturnFormat: DataFormat

  • subscriptionManager: Web3SubscriptionManager<unknown, {}>

  Returns LogsSubscription

Properties

readonlyargs

args: { address?: string | string[]; fromBlock?: BlockNumberOrTag; topics?: string[] }

Inherited from Web3Subscription.args

Type declaration

• optionalreadonlyaddress?: string | string[]

• optionalreadonlyfromBlock?: BlockNumberOrTag

• optionalreadonlytopics?: string[]

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

_processSubscriptionResult

• _processSubscriptionResult(data: unknown): void

• Inherited from Web3Subscription._processSubscriptionResult

  Parameters

  • data: unknown

  Returns void

emit

• emit<K>(eventName: K, params: { data: LogsOutput } & CommonSubscriptionEvents[K]): void

• Inherited from Web3Subscription.emit

  Type parameters

  • K: Web3EventKey<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • params: { data: LogsOutput } & 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<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  Returns number

listeners

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

• Inherited from Web3Subscription.listeners

  Type parameters

  • K: Web3EventKey<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

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

off

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

• Inherited from Web3Subscription.off

  Type parameters

  • K: Web3EventKey<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ data: LogsOutput } & CommonSubscriptionEvents[K]>

  Returns void

on

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

• Inherited from Web3Subscription.on

  Type parameters

  • K: Web3EventKey<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ data: LogsOutput } & CommonSubscriptionEvents[K]>

  Returns void

once

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

• Inherited from Web3Subscription.once

  Type parameters

  • K: Web3EventKey<{ data: LogsOutput } & CommonSubscriptionEvents>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ data: LogsOutput } & 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>