WebSocketProvider <API>

Use WebSocketProvider to connect to a Node using a WebSocket connection, i.e. over the ws or wss protocol.

@example

const provider = new WebSocketProvider(
        `ws://localhost:8545`,
        {
            headers: {
                // to provide the API key if the Node requires the key to be inside the `headers` for example:
                'x-api-key': '<Api key>',
            },
        },
        {
            delay: 500,
            autoReconnect: true,
            maxAttempts: 10,
        },
    );

The second and the third parameters are both optional. And you can for example, the second parameter could be an empty object or undefined. *

@example

const provider = new WebSocketProvider(
        `ws://localhost:8545`,
        {},
        {
            delay: 500,
            autoReconnect: true,
            maxAttempts: 10,
        },
    );

Hierarchy

• SocketProvider<WebSocket.MessageEvent, WebSocket.CloseEvent, WebSocket.ErrorEvent, API>
  • WebSocketProvider

Index

Constructors

• constructor

Accessors

• SocketConnection
• [symbol]

Methods

• connect
• disconnect
• getStatus
• on
• once
• removeAllListeners
• removeListener
• request
• reset
• send
• sendAsync
• supportsSubscriptions
• isWeb3Provider

Constructors

publicconstructor

• new WebSocketProvider<API>(socketPath: string, socketOptions?: ClientOptions | ClientRequestArgs, reconnectOptions?: Partial<ReconnectOptions>): default<API>

• Overrides SocketProvider.constructor

  This is a class used for Web Socket connections. It extends the abstract class SocketProvider SocketProvider that extends the EIP-1193 provider EIP1193Provider.

  ---

  Type parameters

  • API: unknown = EthExecutionAPI

  Parameters

  • socketPath: string

    The path to the Web Socket.

  • optionalsocketOptions: ClientOptions | ClientRequestArgs

    The options for the Web Socket client.

  • optionalreconnectOptions: Partial<ReconnectOptions>

    The options for the socket reconnection ReconnectOptions

  Returns default<API>

Accessors

SocketConnection

• get SocketConnection(): unknown

• Inherited from SocketProvider.SocketConnection

  Returns unknown

[symbol]

• get [symbol](): boolean

• Inherited from SocketProvider.__@symbol@168

  Returns boolean

Methods

connect

• connect(): void

• Inherited from SocketProvider.connect

  Try to establish a connection to the socket

  ---

  Returns void

disconnect

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

• Inherited from SocketProvider.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

publicgetStatus

• getStatus(): Web3ProviderStatus

• Overrides SocketProvider.getStatus

  Returns Web3ProviderStatus

on

• on(type: disconnect, listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void
• on(type: connect, listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void
• on(type: chainChanged, listener: Web3Eip1193ProviderEventCallback<string>): void
• on(type: accountsChanged, listener: Web3Eip1193ProviderEventCallback<string[]>): void
• on<T>(type: message, listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void
• on<T>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void

• Inherited from SocketProvider.on

  Registers a listener for the specified event type.

  ---

  Parameters

  • type: disconnect

    The event type to listen for

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

    The callback to be invoked when the event is emitted

  Returns void

once

• once(type: disconnect, listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void
• once(type: connect, listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void
• once(type: chainChanged, listener: Web3Eip1193ProviderEventCallback<string>): void
• once(type: accountsChanged, listener: Web3Eip1193ProviderEventCallback<string[]>): void
• once<T>(type: message, listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderEventCallback<T>): void
• once<T>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void

• Inherited from SocketProvider.once

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

  ---

  Parameters

  • type: disconnect

    The event type to listen for

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

    The callback to be invoked when the event is emitted

  Returns void

removeAllListeners

• removeAllListeners(type: string): void

• Inherited from SocketProvider.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: disconnect, listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void
• removeListener(type: connect, listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void
• removeListener(type: chainChanged, listener: Web3Eip1193ProviderEventCallback<string>): void
• removeListener(type: accountsChanged, listener: Web3Eip1193ProviderEventCallback<string[]>): void
• removeListener<T>(type: message, listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderEventCallback<T>): void
• removeListener<T>(type: string, listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>): void

• Inherited from SocketProvider.removeListener

  Removes a listener for the specified event type.

  ---

  Parameters

  • type: disconnect

    The event type to remove the listener for

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

    The callback to be executed

  Returns void

request

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

• Inherited from SocketProvider.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

• Inherited from SocketProvider.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 SocketProvider.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 SocketProvider.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

• Inherited from SocketProvider.supportsSubscriptions

  ---

  Returns boolean

  true if the socket supports subscriptions

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from SocketProvider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean