Web3RequestManager <API>

Hierarchy

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

Index

Constructors

• constructor

Properties

• middleware

Accessors

• provider
• providers
• providers

Methods

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

Constructors

publicconstructor

• new Web3RequestManager<API>(provider?: string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>, useRpcCallSpecification?: boolean, requestManagerMiddleware?: RequestManagerMiddleware<API>): Web3RequestManager<API>

• Overrides Web3EventEmitter.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Parameters

  • optionalprovider: string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>

  • optionaluseRpcCallSpecification: boolean

  • optionalrequestManagerMiddleware: RequestManagerMiddleware<API>

  Returns Web3RequestManager<API>

Properties

publicoptionalmiddleware

middleware?: RequestManagerMiddleware<API>

Accessors

publicprovider

• get provider(): undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>

• Will return the current provider.

  ---

  Returns undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>

  Returns the current provider

publicproviders

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

• Will return all available providers

  ---

  Returns { HttpProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

  • HttpProvider: Web3BaseProviderConstructor

  • WebsocketProvider: Web3BaseProviderConstructor

publicstaticproviders

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

• Will return all available providers

  ---

  Returns { HttpProvider: Web3BaseProviderConstructor; WebsocketProvider: Web3BaseProviderConstructor }

  • HttpProvider: Web3BaseProviderConstructor

  • WebsocketProvider: Web3BaseProviderConstructor

Methods

publicemit

• emit<K>(eventName: K, params: { BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]): void

• Inherited from Web3EventEmitter.emit

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  • params: { BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<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 | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  Returns number

publiclisteners

• listeners<K>(eventName: K): (...args: any[]) => void[]

• Inherited from Web3EventEmitter.listeners

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  Returns (...args: any[]) => void[]

publicoff

• off<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>): void

• Inherited from Web3EventEmitter.off

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>

  Returns void

publicon

• on<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>): void

• Inherited from Web3EventEmitter.on

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>

  Returns void

publiconce

• once<K>(eventName: K, fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>): void

• Inherited from Web3EventEmitter.once

  Type parameters

  • K: Web3EventKey<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }>

  Parameters

  • eventName: K

  • fn: Web3EventCallback<{ BEFORE_PROVIDER_CHANGE: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>; PROVIDER_CHANGED: undefined | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API> }[K]>

  Returns void

publicremoveAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3EventEmitter.removeAllListeners

  Returns EventEmitter

publicsend

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

• Will execute a request

  ---

  Type parameters

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

  Parameters

  • request: Web3APIRequest<API, Method>

    Web3APIRequest The request to send

  Returns Promise<ResponseType>

  The response of the request ResponseType. If there is error in the response, will throw an error

publicsendBatch

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

• Same as send, but, will execute a batch of requests

  ---

  Parameters

  • request: JsonRpcBatchRequest

    JsonRpcBatchRequest The batch request to send

  Returns Promise<JsonRpcBatchResponse<unknown, JsonRpcResult>>

publicsetMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3EventEmitter.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

publicsetMiddleware

• setMiddleware(requestManagerMiddleware: RequestManagerMiddleware<API>): void

• Parameters

  • requestManagerMiddleware: RequestManagerMiddleware<API>

  Returns void

publicsetProvider

• setProvider(provider?: string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>): boolean

• Use to set provider. Provider can be a provider instance or a string.

  ---

  Parameters

  • optionalprovider: string | LegacyRequestProvider | LegacySendProvider | LegacySendAsyncProvider | EIP1193Provider<API> | Web3BaseProvider<API> | SimpleProvider<API> | MetaMaskProvider<API>

    The provider to set

  Returns boolean