providers
Index
Namespaces
Classes
Namespaces
http
HttpProvider
Re-exports HttpProvider
default
Renames and re-exports HttpProvider
HttpProviderOptions
providerOptions
ipc
IpcProvider
Re-exports IpcProvider
default
Renames and re-exports IpcProvider
ws
WebSocketProvider
Re-exports WebSocketProvider
default
Renames and re-exports WebSocketProvider
Classes
abstractEip1193Provider
Type parameters
- API: Web3APISpec = EthExecutionAPI
constructor
Type parameters
- API: unknown = EthExecutionAPI
Returns Eip1193Provider<API>
[symbol]
Returns boolean
abstractconnect
Returns void
abstractdisconnect
Parameters
optionalcode: number
optionaldata: string
Returns void
abstractgetStatus
Returns Web3ProviderStatus
abstracton
Parameters
type: disconnect
callback: Web3ProviderEventCallback<ProviderRpcError>
Returns void
optionalabstractonce
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
optionalabstractremoveAllListeners
Parameters
type: string
Returns void
abstractremoveListener
Parameters
type: string
callback: Web3ProviderEventCallback<JsonRpcResult>
Returns void
abstractrequest
Type parameters
- Method: string
- ResultType = unknown
Parameters
args: Web3APIPayload<API, Method>
Returns Promise<JsonRpcResponseWithResult<ResultType>>
abstractreset
Returns void
send
Type parameters
- ResultType = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void
Returns void
sendAsync
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
Returns Promise<JsonRpcResponse<R, JsonRpcResult>>
abstractsupportsSubscriptions
Returns boolean
staticisWeb3Provider
Parameters
provider: unknown
Returns boolean
abstractSocketProvider
Type parameters
- MessageEvent
- CloseEvent
- ErrorEvent
- API: Web3APISpec = EthExecutionAPI
constructor
Type parameters
- MessageEvent
- CloseEvent
- ErrorEvent
- API: unknown = EthExecutionAPI
Parameters
socketPath: string
optionalsocketOptions: object
optionalreconnectOptions: object
Returns SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>
SocketConnection
Returns unknown
[symbol]
Returns boolean
connect
Returns void
disconnect
Parameters
optionalcode: number
optionaldata: string
Returns void
abstractgetStatus
Returns Web3ProviderStatus
on
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
once
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
removeAllListeners
Parameters
type: string
Returns void
removeListener
Parameters
type: string
callback: Web3ProviderEventCallback<JsonRpcResult>
Returns void
request
Type parameters
- Method: string
- ResultType = Web3APIReturnType<API, Method>
Parameters
request: Web3APIPayload<API, Method>
Returns Promise<JsonRpcResponseWithResult<ResultType>>
reset
Returns void
send
Type parameters
- ResultType = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void
Returns void
sendAsync
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
Returns Promise<JsonRpcResponse<R, JsonRpcResult>>
supportsSubscriptions
Returns boolean
staticisWeb3Provider
Parameters
provider: unknown
Returns boolean