Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EthereumConnection

Connect to Ethereum network via web3 Maintains connection state, network properties Reconnects in case of connection dropped. NB: each consumer has to resubscribe atm after reconnection (on "connected" event) Usage: const ethereumConnection = new EthereumConnection(); await ethereumConnection.connect().catch( e => {..} )

fires

EthereumConnection#connected

fires

EthereumConnection#disconnected NB: it's only in case of error code 1000, normal end

fires

EthereumConnection#connectionLost

Hierarchy

  • EventEmitter
    • EthereumConnection

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

accounts

accounts: string[]

blockGasLimit

blockGasLimit: number

Readonly givenProvider

givenProvider: IGivenProvider

isProviderWithEvents

isProviderWithEvents: boolean

isStopping

isStopping: boolean = false

isTryingToReconnect

isTryingToReconnect: boolean = false

networkId

networkId: number

options

options: IOptions

provider

provider: Web3.Provider

safeBlockGasLimit

safeBlockGasLimit: number

web3

web3: Web3

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

connect

  • connect(): Promise<void>

  • Returns Promise<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>

getAccountNonce

  • getAccountNonce(account: string): Promise<number>

  • next nonce for the account

    Parameters

    • account: string

      Ethereum account with leading 0x

    Returns Promise<number>

    The result web3.eth.getTransactionCount(account) which is essentially the nonce for the next tx

getMaxListeners

  • getMaxListeners(): number

isConnected

  • isConnected(): Promise<boolean>

  • Get connection state

    memberof

    EthereumConnection

    Returns Promise<boolean>

    result from web3.eth.net.isListening()

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...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: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

stop

  • stop(): Promise<void>

  • Returns Promise<void>

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc