@hancock/sdk-nodejs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Manages events emmited by the ethereum blockchain network

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

closeSocket

  • closeSocket(): void

  • Closes the subscriptions to the network events

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected sendMessage

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

unwatchContractEvent

  • unwatchContractEvent(contracts: string[]): void

  • Stop listening the contracts for event of type "contracts-transactions".

    Parameters

    • contracts: string[]

      Contracts to stop listening

    Returns void

unwatchContractTransaction

  • unwatchContractTransaction(contracts: string[]): void

  • Stop listening the contracts for event of type "contracts-events".

    Parameters

    • contracts: string[]

      Contracts to stop listening

    Returns void

unwatchTransaction

  • unwatchTransaction(addresses: string[]): void

  • Stop listening the addresses for event of type "transactions".

    Parameters

    • addresses: string[]

      Addresses to stop listening

    Returns void

unwatchTransfer

  • unwatchTransfer(addresses: string[]): void

  • Stop listening the addresses for event of type "transfers"

    Parameters

    • addresses: string[]

      Addresses to stop listening

    Returns void

watchContractDeployment

  • watchContractDeployment(addresses: string[]): void

  • Add a list of addresses to the watch lists of smart contract deployments An event will be received each time that some smart contract identified by one of the given addresses emits an event

    Parameters

    • addresses: string[]

      addresses to watch

    Returns void

watchContractEvent

  • watchContractEvent(contracts: string[]): void

  • Add a list of smart contract addresses to the watch lists of smart contract events An event will be received each time that some smart contract identified by one of the given addresses emits an event

    Parameters

    • contracts: string[]

      addresses of smart contracts to watch

    Returns void

watchContractTransaction

  • watchContractTransaction(contracts: string[]): void

  • Add a list of smart contract addresses to the watch lists of smart contract transactions An event will be received each time that some smart contract identified by one of the given addresses emits an event

    Parameters

    • contracts: string[]

      addresses of smart contracts to watch

    Returns void

watchTransaction

  • watchTransaction(addresses: string[]): void

  • Add a list of addresses to the watch lists of transactions An event will be received each time that some of the given addresses appears as 'from' or 'to' in some transaction of any kind

    Parameters

    • addresses: string[]

      addresses to watch

    Returns void

watchTransfer

  • watchTransfer(addresses: string[]): void

  • Add a list of addresses to the watch lists of transfers An event will be received each time that some of the given addresses appears as 'from' or 'to' in some transfer transaction

    Parameters

    • addresses: string[]

      addresses to watch

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc