EventListener | @irisnet/irishub-sdk

IRISHub Event Listener

since: v0.17

Hierarchy

EventListener

Index

Methods

connect

connect(): void

- Defined in src/nets/event-listener.ts:118
Connect to server

since

v0.17

Returns void

disconnect

disconnect(): Promise<void>

- Defined in src/nets/event-listener.ts:126
Disconnect from server and clear all the listeners

since

v0.17

Returns Promise<void>

Private newBlockHandler

newBlockHandler(callback: (error?: SdkError, data?: types.EventDataNewBlock) => void, error?: any, data?: any): void

- Defined in src/nets/event-listener.ts:306
Parameters
- callback: (error?: SdkError, data?: types.EventDataNewBlock) => void
  - - (error?: SdkError, data?: types.EventDataNewBlock): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataNewBlock
      Returns void
- Optional error: any
- Optional data: any
Returns void

Private newBlockHeaderHandler

newBlockHeaderHandler(callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void, error: any, data: any): void

- Defined in src/nets/event-listener.ts:393
Parameters
- callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void
  - - (error?: SdkError, data?: types.EventDataNewBlockHeader): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataNewBlockHeader
      Returns void
- error: any
- data: any
Returns void

subscribeNewBlock

subscribeNewBlock(callback: (error?: SdkError, data?: types.EventDataNewBlock) => void, conditions?: EventQueryBuilder): EventSubscription

- Defined in src/nets/event-listener.ts:139
Subscribe new block notifications

since

v0.17

Parameters
- callback: (error?: SdkError, data?: types.EventDataNewBlock) => void
  
  A function to receive notifications
  - - (error?: SdkError, data?: types.EventDataNewBlock): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataNewBlock
      Returns void
- Optional conditions: EventQueryBuilder
  
  Query conditions
Returns EventSubscription

subscribeNewBlockHeader

subscribeNewBlockHeader(callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void): EventSubscription

- Defined in src/nets/event-listener.ts:176
Subscribe new block header notifications

since

v0.17

Parameters
- callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void
  
  A function to receive notifications
  - - (error?: SdkError, data?: types.EventDataNewBlockHeader): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataNewBlockHeader
      Returns void
Returns EventSubscription

subscribeTx

subscribeTx(conditions: EventQueryBuilder, callback: (error?: SdkError, data?: types.EventDataResultTx) => void): EventSubscription

- Defined in src/nets/event-listener.ts:248
Subscribe successful Txs notifications

since

v0.17

Parameters
- conditions: EventQueryBuilder
  
  Query conditions
- callback: (error?: SdkError, data?: types.EventDataResultTx) => void
  
  A function to receive notifications
  - - (error?: SdkError, data?: types.EventDataResultTx): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataResultTx
      Returns void
Returns EventSubscription

subscribeValidatorSetUpdates

subscribeValidatorSetUpdates(callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void): EventSubscription

- Defined in src/nets/event-listener.ts:211
Subscribe validator set update notifications

since

v0.17

Parameters
- callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void
  
  A function to receive notifications
  - - (error?: SdkError, data?: EventDataValidatorSetUpdates[]): void
    - Parameters
      - Optional error: SdkError
      - Optional data: EventDataValidatorSetUpdates[]
      Returns void
Returns EventSubscription

Private txHandler

txHandler(callback: (error?: SdkError, data?: types.EventDataResultTx) => void, error: any, data: any): void

- Defined in src/nets/event-listener.ts:475
Parameters
- callback: (error?: SdkError, data?: types.EventDataResultTx) => void
  - - (error?: SdkError, data?: types.EventDataResultTx): void
    - Parameters
      - Optional error: SdkError
      - Optional data: types.EventDataResultTx
      Returns void
- error: any
- data: any
Returns void

unsubscribe

unsubscribe(subscription: EventSubscription): void

- Defined in src/nets/event-listener.ts:282
Unsubscribe the specified event

since

v0.17

Parameters
- subscription: EventSubscription
  
  The event subscription instance
Returns void

Private validatorSetUpdatesHandler

validatorSetUpdatesHandler(callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void, error: any, data: any): void

- Defined in src/nets/event-listener.ts:455
Parameters
- callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void
  - - (error?: SdkError, data?: EventDataValidatorSetUpdates[]): void
    - Parameters
      - Optional error: SdkError
      - Optional data: EventDataValidatorSetUpdates[]
      Returns void
- error: any
- data: any
Returns void

Hierarchy

Index

Methods

Methods

connect

Returns void

disconnect

Returns Promise<void>

Private newBlockHandler

Parameters

callback: (error?: SdkError, data?: types.EventDataNewBlock) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataNewBlock

Returns void

Optional error: any

Optional data: any

Returns void

Private newBlockHeaderHandler

Parameters

callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataNewBlockHeader

Returns void

error: any

data: any

Returns void

subscribeNewBlock

Parameters

callback: (error?: SdkError, data?: types.EventDataNewBlock) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataNewBlock

Returns void

Optional conditions: EventQueryBuilder

Returns EventSubscription

subscribeNewBlockHeader

Parameters

callback: (error?: SdkError, data?: types.EventDataNewBlockHeader) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataNewBlockHeader

Returns void

Returns EventSubscription

subscribeTx

Parameters

conditions: EventQueryBuilder

callback: (error?: SdkError, data?: types.EventDataResultTx) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataResultTx

Returns void

Returns EventSubscription

subscribeValidatorSetUpdates

Parameters

callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void

Parameters

Optional error: SdkError

Optional data: EventDataValidatorSetUpdates[]

Returns void

Returns EventSubscription

Private txHandler

Parameters

callback: (error?: SdkError, data?: types.EventDataResultTx) => void

Parameters

Optional error: SdkError

Optional data: types.EventDataResultTx

Returns void

error: any

data: any

Returns void

unsubscribe

Parameters

subscription: EventSubscription

Returns void

Private validatorSetUpdatesHandler

Parameters

callback: (error?: SdkError, data?: EventDataValidatorSetUpdates[]) => void

Parameters