abstractEip1193Provider <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.

Hierarchy

• Web3BaseProvider<API>
  • Eip1193Provider
    • SocketProvider

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

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

Constructors

constructor

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

• Inherited from Web3BaseProvider.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Returns Eip1193Provider<API>

Accessors

[symbol]

• get [symbol](): boolean

• Inherited from Web3BaseProvider.[symbol]

  Returns boolean

Methods

asEIP1193Provider

• asEIP1193Provider(): Eip1193Compatible<API>

• Inherited from Web3BaseProvider.asEIP1193Provider

  Modify the return type of the request method to be fully compatible with EIP-1193

  [deprecated] In the future major releases (&gt;= v5) all providers are supposed to be fully compatible with EIP-1193. So this method will not be needed and would not be available in the future.

  @example

  const provider = new Web3HttpProvider('http://localhost:8545');
  const fullyCompatibleProvider = provider.asEIP1193Provider();
  const result = await fullyCompatibleProvider.request({ method: 'eth_getBalance' });
  console.log(result); // '0x0234c8a3397aab58' or something like that

  ---

  Returns Eip1193Compatible<API>

  A new instance of the provider with the request method fully compatible with EIP-1193

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, listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>): void
• on<T>(type: string, listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void
• on<T>(type: string, listener: Web3Eip1193ProviderEventCallback<ProviderMessage> | Web3ProviderMessageEventCallback<T>): void
• on(type: connect, listener: Web3Eip1193ProviderEventCallback<ProviderConnectInfo>): void
• on(type: chainChanged, listener: Web3Eip1193ProviderEventCallback<string>): void
• on(type: accountsChanged, listener: Web3Eip1193ProviderEventCallback<string[]>): void

• Inherited from Web3BaseProvider.on

  Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  Returns void

abstractonce

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

• Inherited from Web3BaseProvider.once

  Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  Returns void

optionalabstractremoveAllListeners

• removeAllListeners(type: string): void

• Inherited from Web3BaseProvider.removeAllListeners

  Parameters

  • type: string

  Returns void

abstractremoveListener

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

• Inherited from Web3BaseProvider.removeListener

  Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  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