providers

Index

Namespaces

• http
• ws

Classes

• Eip1193Provider
• SocketProvider

Namespaces

http

http:

HttpProvider

Re-exports HttpProvider

default

Renames and re-exports HttpProvider

HttpProviderOptions

HttpProviderOptions:

providerOptions

providerOptions: RequestInit

ws

ws:

WebSocketProvider

Re-exports WebSocketProvider

default

Renames and re-exports WebSocketProvider

Classes

abstractEip1193Provider

Eip1193Provider<API>:

This is an abstract class, which extends Web3BaseProvider class. This class is used to implement a provider that adheres to the EIP-1193 standard for Ethereum providers.

---

Type parameters

• API: Web3APISpec = EthExecutionAPI

constructor

• new Eip1193Provider<API>(): Eip1193Provider<API>

• Inherited from Web3BaseProvider.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Returns Eip1193Provider<API>

[symbol]

• get [symbol](): boolean

• Inherited from Web3BaseProvider.__@symbol@42005

  Returns boolean

abstractconnect

• connect(): void

• Inherited from Web3BaseProvider.connect

  Returns void

abstractdisconnect

• disconnect(code?: number, data?: string): void

• Inherited from Web3BaseProvider.disconnect

  Parameters

  • optionalcode: number

  • optionaldata: string

  Returns void

abstractgetStatus

• getStatus(): Web3ProviderStatus

• Inherited from Web3BaseProvider.getStatus

  Returns Web3ProviderStatus

abstracton

• on(type: disconnect, callback: Web3ProviderEventCallback<ProviderRpcError>): void
• on<T>(type: string, callback: Web3ProviderEventCallback<T>): void
• on(type: connect | chainChanged, callback: Web3ProviderEventCallback<ProviderConnectInfo>): void
• on(type: accountsChanged, callback: Web3ProviderEventCallback<{ accounts: string[] }>): void

• Inherited from Web3BaseProvider.on

  Parameters

  • type: disconnect

  • callback: Web3ProviderEventCallback<ProviderRpcError>

  Returns void

optionalabstractonce

• once<T>(type: string, callback: Web3ProviderEventCallback<T>): void

• Inherited from Web3BaseProvider.once

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

optionalabstractremoveAllListeners

• removeAllListeners(type: string): void

• Inherited from Web3BaseProvider.removeAllListeners

  Parameters

  • type: string

  Returns void

abstractremoveListener

• removeListener(type: string, callback: Web3ProviderEventCallback<JsonRpcResult>): void

• Inherited from Web3BaseProvider.removeListener

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<JsonRpcResult>

  Returns void

abstractrequest

• request<Method, ResultType>(args: Web3APIPayload<API, Method>): Promise<JsonRpcResponseWithResult<ResultType>>

• Inherited from Web3BaseProvider.request

  Type parameters

  • Method: string
  • ResultType = unknown

  Parameters

  • args: Web3APIPayload<API, Method>

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

abstractreset

• reset(): void

• Inherited from Web3BaseProvider.reset

  Returns void

send

• send<ResultType, P>(payload: JsonRpcPayload<P>, callback: (err: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void): void

• Inherited from Web3BaseProvider.send

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • ResultType = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  • callback: (err: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void

    Callback

  Returns void

sendAsync

• sendAsync<R, P>(payload: JsonRpcPayload<P>): Promise<JsonRpcResponse<R, JsonRpcResult>>

• Inherited from Web3BaseProvider.sendAsync

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • R = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  Returns Promise<JsonRpcResponse<R, JsonRpcResult>>

abstractsupportsSubscriptions

• supportsSubscriptions(): boolean

• Inherited from Web3BaseProvider.supportsSubscriptions

  Returns boolean

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from Web3BaseProvider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean

abstractSocketProvider

SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>:

Type parameters

• MessageEvent
• CloseEvent
• ErrorEvent
• API: Web3APISpec = EthExecutionAPI

constructor

• new SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>(socketPath: string, socketOptions?: unknown, reconnectOptions?: Partial<ReconnectOptions>): SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>

• Overrides Eip1193Provider.constructor

  This is an abstract class for implementing a socket provider (e.g. WebSocket, IPC). It extends the EIP-1193 provider EIP1193Provider.

  ---

  Type parameters

  • MessageEvent
  • CloseEvent
  • ErrorEvent
  • API: unknown = EthExecutionAPI

  Parameters

  • socketPath: string

    The path to the socket (e.g. /ipc/path or ws://localhost:8546)

  • optionalsocketOptions: unknown

    The options for the socket connection. Its type is supposed to be specified in the inherited classes.

  • optionalreconnectOptions: Partial<ReconnectOptions>

    The options for the socket reconnection ReconnectOptions

  Returns SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>

SocketConnection

• get SocketConnection(): unknown

• Returns unknown

[symbol]

• get [symbol](): boolean

• Inherited from Eip1193Provider.__@symbol@42005

  Returns boolean

connect

• connect(): void

• Overrides Eip1193Provider.connect

  Try to establish a connection to the socket

  ---

  Returns void

disconnect

• disconnect(code?: number, data?: string): void

• Overrides Eip1193Provider.disconnect

  Disconnects the socket

  ---

  Parameters

  • optionalcode: number

    The code to be sent to the server

  • optionaldata: string

    The data to be sent to the server

  Returns void

abstractgetStatus

• getStatus(): Web3ProviderStatus

• Inherited from Eip1193Provider.getStatus

  Returns Web3ProviderStatus

on

• on<T>(type: string, callback: Web3ProviderEventCallback<T>): void

• Overrides Eip1193Provider.on

  Registers a listener for the specified event type.

  ---

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

    The event type to listen for

  • callback: Web3ProviderEventCallback<T>

    The callback to be invoked when the event is emitted

  Returns void

once

• once<T>(type: string, callback: Web3ProviderEventCallback<T>): void

• Overrides Eip1193Provider.once

  Registers a listener for the specified event type that will be invoked at most once.

  ---

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

    The event type to listen for

  • callback: Web3ProviderEventCallback<T>

    The callback to be invoked when the event is emitted

  Returns void

removeAllListeners

• removeAllListeners(type: string): void

• Overrides Eip1193Provider.removeAllListeners

  Removes all listeners for the specified event type.

  ---

  Parameters

  • type: string

    The event type to remove the listeners for

  Returns void

removeListener

• removeListener(type: string, callback: Web3ProviderEventCallback<JsonRpcResult>): void

• Overrides Eip1193Provider.removeListener

  Removes a listener for the specified event type.

  ---

  Parameters

  • type: string

    The event type to remove the listener for

  • callback: Web3ProviderEventCallback<JsonRpcResult>

    The callback to be executed

  Returns void

request

• request<Method, ResultType>(request: Web3APIPayload<API, Method>): Promise<JsonRpcResponseWithResult<ResultType>>

• Overrides Eip1193Provider.request

  Creates a request object to be sent to the server

  ---

  Type parameters

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

  Parameters

  • request: Web3APIPayload<API, Method>

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

reset

• reset(): void

• Overrides Eip1193Provider.reset

  Resets the socket, removing all listeners and pending requests

  ---

  Returns void

send

• send<ResultType, P>(payload: JsonRpcPayload<P>, callback: (err: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void): void

• Inherited from Eip1193Provider.send

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • ResultType = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  • callback: (err: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void

    Callback

  Returns void

sendAsync

• sendAsync<R, P>(payload: JsonRpcPayload<P>): Promise<JsonRpcResponse<R, JsonRpcResult>>

• Inherited from Eip1193Provider.sendAsync

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • R = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  Returns Promise<JsonRpcResponse<R, JsonRpcResult>>

supportsSubscriptions

• supportsSubscriptions(): boolean

• Overrides Eip1193Provider.supportsSubscriptions

  Returns boolean

  true if the socket supports subscriptions

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from Eip1193Provider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean