abstractSocketProvider <MessageEvent, CloseEvent, ErrorEvent, API>

Hierarchy

• Eip1193Provider<API>
  • SocketProvider

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

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

Constructors

publicconstructor

• new SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>(socketPath: string, options?: object, reconnectOptions?: object): SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>

• Overrides Eip1193Provider.constructor

  Type parameters

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

  Parameters

  • socketPath: string

  • optionaloptions: object

  • optionalreconnectOptions: object

  Returns SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>

Accessors

[symbol]

• get [symbol](): boolean

• Inherited from Eip1193Provider.__@symbol@41960

  Returns boolean

Methods

publicconnect

• connect(): void

• Overrides Eip1193Provider.connect

  Returns void

publicdisconnect

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

• Overrides Eip1193Provider.disconnect

  Parameters

  • optionalcode: number

  • optionaldata: string

  Returns void

abstractgetStatus

• getStatus(): Web3ProviderStatus

• Inherited from Eip1193Provider.getStatus

  Returns Web3ProviderStatus

publicon

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

• Overrides Eip1193Provider.on

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

publiconce

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

• Overrides Eip1193Provider.once

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

publicremoveAllListeners

• removeAllListeners(type: string): void

• Overrides Eip1193Provider.removeAllListeners

  Parameters

  • type: string

  Returns void

publicremoveListener

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

• Overrides Eip1193Provider.removeListener

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<JsonRpcResult>

  Returns void

publicrequest

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

• Overrides Eip1193Provider.request

  Type parameters

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

  Parameters

  • request: Web3APIPayload<API, Method>

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

publicreset

• reset(): void

• Overrides Eip1193Provider.reset

  Returns void

send

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

• Inherited from Eip1193Provider.send

  Type parameters

  • ResultType = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

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

  Returns void

sendAsync

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

• Inherited from Eip1193Provider.sendAsync

  Type parameters

  • R = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

  Returns Promise<JsonRpcResponse<R, JsonRpcResult>>

publicsupportsSubscriptions

• supportsSubscriptions(): boolean

• Overrides Eip1193Provider.supportsSubscriptions

  Returns boolean

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from Eip1193Provider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean