HttpProvider <API>

Hierarchy

• Web3BaseProvider<API>
  • HttpProvider

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

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

Constructors

publicconstructor

• new HttpProvider<API>(clientUrl: string, httpProviderOptions?: HttpProviderOptions): default<API>

• Overrides Web3BaseProvider.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Parameters

  • clientUrl: string

  • optionalhttpProviderOptions: HttpProviderOptions

  Returns default<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

publicconnect

• connect(): void

• Overrides Web3BaseProvider.connect

  Returns void

publicdisconnect

• disconnect(): void

• Overrides Web3BaseProvider.disconnect

  Returns void

publicgetStatus

• getStatus(): Web3ProviderStatus

• Overrides Web3BaseProvider.getStatus

  Returns Web3ProviderStatus

publicon

• on(): void

• Overrides Web3BaseProvider.on

  Returns void

publiconce

• once(): void

• Overrides Web3BaseProvider.once

  Returns void

publicreconnect

• reconnect(): void

• Returns void

publicremoveAllListeners

• removeAllListeners(): void

• Overrides Web3BaseProvider.removeAllListeners

  Returns void

publicremoveListener

• removeListener(): void

• Overrides Web3BaseProvider.removeListener

  Returns void

publicrequest

• request<Method, ResultType>(payload: Web3APIPayload<API, Method>, requestOptions?: RequestInit): Promise<JsonRpcResponseWithResult<ResultType>>

• Overrides Web3BaseProvider.request

  Type parameters

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

  Parameters

  • payload: Web3APIPayload<API, Method>

  • optionalrequestOptions: RequestInit

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

publicreset

• reset(): void

• Overrides Web3BaseProvider.reset

  Returns void

send

• send<ResultType, P>(payload: JsonRpcPayload<P>, callback: (err: null | Error, response?: JsonRpcResponseWithError<JsonRpcResult> | JsonRpcResponseWithResult<ResultType> | JsonRpcBatchResponse<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?: JsonRpcResponseWithError<JsonRpcResult> | JsonRpcResponseWithResult<ResultType> | JsonRpcBatchResponse<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>>

publicsupportsSubscriptions

• supportsSubscriptions(): boolean

• Overrides Web3BaseProvider.supportsSubscriptions

  Returns boolean

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from Web3BaseProvider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean