HancockSocket | @hancock/sdk-nodejs

Manages events emmited by the blockchain network

Hierarchy

EventEmitter
- HancockSocket
  - HancockEthereumSocket

Constructors

constructor

new HancockSocket(url: string, consumer?: undefined | string, status?: HancockSocketStatus): HancockSocket

- Defined in services/common/socket.ts:12
Parameters
- url: string
- Optional consumer: undefined | string
- Default value status: HancockSocketStatus = "mined"
Returns HancockSocket

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1003
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

closeSocket

closeSocket(): void

- Defined in services/common/socket.ts:26
Closes the subscriptions to the network events

Returns void

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1014
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1015
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1011
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1016
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1012
Parameters
- event: string | symbol
Returns Function[]

on

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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1004
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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1005
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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1006
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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1007
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1013
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1009
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1008
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Protected sendMessage

sendMessage(kind: SOCKET_EVENT_KINDS, body: HancockSocketBody[]): void

- Defined in services/common/socket.ts:125
Parameters
- kind: SOCKET_EVENT_KINDS
- body: HancockSocketBody[]
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1010
Parameters
- n: number
Returns this

unwatchContractEvent

unwatchContractEvent(contracts: string[]): void

- Defined in services/common/socket.ts:119
Stop listening the contracts for event of type "contracts-transactions".

Parameters
- contracts: string[]
  
  Contracts to stop listening
Returns void

unwatchContractTransaction

unwatchContractTransaction(contracts: string[]): void

- Defined in services/common/socket.ts:109
Stop listening the contracts for event of type "contracts-events".

Parameters
- contracts: string[]
  
  Contracts to stop listening
Returns void

unwatchTransaction

unwatchTransaction(addresses: string[]): void

- Defined in services/common/socket.ts:99
Stop listening the addresses for event of type "transactions".

Parameters
- addresses: string[]
  
  Addresses to stop listening
Returns void

unwatchTransfer

unwatchTransfer(addresses: string[]): void

- Defined in services/common/socket.ts:89
Stop listening the addresses for event of type "transfers"

Parameters
- addresses: string[]
  
  Addresses to stop listening
Returns void

watchContractDeployment

watchContractDeployment(addresses: string[]): void

- Defined in services/common/socket.ts:68
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

- Defined in services/common/socket.ts:79
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

- Defined in services/common/socket.ts:57
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

- Defined in services/common/socket.ts:46
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

- Defined in services/common/socket.ts:35
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

Inherited from EventEmitter.listenerCount
- Defined in /home/juanferrer/KST/BlockchainHub/Hancock/kst-hancock-sdk-nodejs/node_modules/@types/node/index.d.ts:1000
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc