Web3RequestManager <API>

Hierarchy

• Web3EventEmitter<{ [ key in Web3RequestManagerEvent ]: SupportedProviders<API> | undefined }>
  • Web3RequestManager

Index

Constructors

• constructor

Accessors

• provider
• providers
• providers

Methods

• emit
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• send
• sendBatch
• setMaxListenerWarningThreshold
• setProvider

Constructors

publicconstructor

• new Web3RequestManager<API>(provider?: string | SupportedProviders<API>, net?: Socket, useRpcCallSpecification?: boolean): Web3RequestManager<API>

• Overrides Web3EventEmitter.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Parameters

  • optionalprovider: string | SupportedProviders<API>

  • optionalnet: Socket

  • optionaluseRpcCallSpecification: boolean

  Returns Web3RequestManager<API>

Accessors

publicprovider

• get provider(): undefined | SupportedProviders<API>

• Returns undefined | SupportedProviders<API>

publicproviders

• get providers(): { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

• Returns { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

  • HttpProvider: Web3BaseProviderConstructor

  • IpcProvider: Web3BaseProviderConstructor

  • WebsocketProvider: Web3BaseProviderConstructor

publicstaticproviders

• get providers(): { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

• Returns { HttpProvider: Web3BaseProviderConstructor; IpcProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

  • HttpProvider: Web3BaseProviderConstructor

  • IpcProvider: Web3BaseProviderConstructor

  • WebsocketProvider: Web3BaseProviderConstructor

Methods

publicemit

• emit<K>(eventName: K, params: { BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]): void

• Inherited from Web3EventEmitter.emit

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  • params: { BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]

  Returns void

publiceventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3EventEmitter.eventNames

  Returns (string | symbol)[]

publicgetMaxListeners

• getMaxListeners(): number

• Inherited from Web3EventEmitter.getMaxListeners

  Returns number

publiclistenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3EventEmitter.listenerCount

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  Returns number

publiclisteners

• listeners<K>(eventName: K): Function[]

• Inherited from Web3EventEmitter.listeners

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  Returns Function[]

publicoff

• off<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

• Inherited from Web3EventEmitter.off

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>

  Returns void

publicon

• on<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

• Inherited from Web3EventEmitter.on

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>

  Returns void

publiconce

• once<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>): void

• Inherited from Web3EventEmitter.once

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | SupportedProviders<API>; PROVIDER_CHANGED: undefined | SupportedProviders<API> }[K]>

  Returns void

publicremoveAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3EventEmitter.removeAllListeners

  Returns EventEmitter

publicsend

• send<Method, ResponseType>(request: Web3APIRequest<API, Method>): Promise<ResponseType>

• Type parameters

  • Method: string
  • ResponseType = Web3APIReturnType<API, Method>

  Parameters

  • request: Web3APIRequest<API, Method>

  Returns Promise<ResponseType>

publicsendBatch

• sendBatch(request: JsonRpcBatchRequest): Promise<JsonRpcBatchResponse<unknown, JsonRpcResult>>

• Parameters

  • request: JsonRpcBatchRequest

  Returns Promise<JsonRpcBatchResponse<unknown, JsonRpcResult>>

publicsetMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3EventEmitter.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

publicsetProvider

• setProvider(provider?: string | SupportedProviders<API>, net?: Socket): boolean

• Use to set provider. Provider can be a provider instance or a string. To set IPC provider as a string please use the IPC socket file which name ends with .ipc

  ---

  Parameters

  • optionalprovider: string | SupportedProviders<API>

  • optionalnet: Socket

  Returns boolean