abstractWeb3BaseProvider <API>

Implements

• LegacySendProvider
• LegacySendAsyncProvider
• EIP1193Provider<API>

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

• 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

[symbol]

• get [symbol](): boolean

• Returns boolean

Methods

abstractconnect

• connect(): void

• Returns void

abstractdisconnect

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

• Parameters

  • optionalcode: number

  • optionaldata: string

  Returns void

abstractgetStatus

• getStatus(): Web3ProviderStatus

• Returns Web3ProviderStatus

abstracton

• on(type: disconnect, callback: Web3ProviderEventCallback<ProviderRpcError>): void
• on<T>(type: string, callback: Web3ProviderEventCallback<T>): void
• on(type: connect | chainChanged, callback: Web3ProviderEventCallback<ProviderConnectInfo>): void
• on(type: accountsChanged, callback: Web3ProviderEventCallback<{ accounts: string[] }>): void

• Parameters

  • type: disconnect

  • callback: Web3ProviderEventCallback<ProviderRpcError>

  Returns void

optionalabstractonce

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

• Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

optionalabstractremoveAllListeners

• removeAllListeners(type: string): void

• Parameters

  • type: string

  Returns void

abstractremoveListener

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

• Parameters

  • type: string

  • callback: Web3ProviderEventCallback<JsonRpcResult>

  Returns void

abstractrequest

• 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>>

abstractreset

• reset(): void

• Returns void

send

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

    Callback

  Returns void

sendAsync

• 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>>

abstractsupportsSubscriptions

• supportsSubscriptions(): boolean

• Returns boolean

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Parameters

  • provider: unknown

  Returns boolean