abstractWeb3BaseProvider <API>

Implements

• LegacySendProvider
• LegacySendAsyncProvider
• EIP1193Provider<API>

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

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

Constructors

constructor

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

• Type parameters

  • API: unknown = EthExecutionAPI

  Returns Web3BaseProvider<API>

Accessors

public[symbol]

• get [symbol](): boolean

• Returns boolean

Methods

publicasEIP1193Provider

• asEIP1193Provider(): Eip1193Compatible<API>

• 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

publicabstractconnect

• connect(): void

• Returns void

publicabstractdisconnect

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

• Parameters

  • optionalcode: number

  • optionaldata: string

  Returns void

publicabstractgetStatus

• getStatus(): Web3ProviderStatus

• Returns Web3ProviderStatus

publicabstracton

• 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

• Implementation of EIP1193Provider.on

  Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  Returns void

publicabstractonce

• 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

• Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  Returns void

publicoptionalabstractremoveAllListeners

• removeAllListeners(type: string): void

• Parameters

  • type: string

  Returns void

publicabstractremoveListener

• 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

• Implementation of EIP1193Provider.removeListener

  Parameters

  • type: disconnect

  • listener: Web3Eip1193ProviderEventCallback<ProviderRpcError>

  Returns void

publicabstractrequest

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

• Implementation of EIP1193Provider.request

  Type parameters

  • Method: string
  • ResultType = unknown

  Parameters

  • args: Web3APIPayload<API, Method>

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

publicabstractreset

• reset(): void

• Returns void

publicsend

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

• Implementation of LegacySendProvider.send

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • ResultType = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  • callback: (err: null | Error, response?: JsonRpcResponseWithError<JsonRpcResult> | JsonRpcResponseWithResult<ResultType> | (JsonRpcResponseWithError<JsonRpcResult> | JsonRpcResponseWithResult<ResultType>)[]) => void

    Callback

  Returns void

publicsendAsync

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

• Implementation of LegacySendAsyncProvider.sendAsync

  @deprecated

  Please use .request instead.

  ---

  Type parameters

  • R = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

    Request Payload

  Returns Promise<JsonRpcResponse<R, JsonRpcResult>>

publicabstractsupportsSubscriptions

• supportsSubscriptions(): boolean

• Returns boolean

publicstaticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Parameters

  • provider: unknown

  Returns boolean