IpcProvider <API>
Hierarchy
- SocketProvider<Buffer | string, CloseEvent, Error, API>
- IpcProvider
Index
Constructors
constructor
Type parameters
- API: unknown = EthExecutionAPI
Parameters
socketPath: string
optionalsocketOptions: object
optionalreconnectOptions: object
Returns default<API>
Accessors
SocketConnection
Returns unknown
[symbol]
Returns boolean
Methods
connect
Returns void
disconnect
Parameters
optionalcode: number
optionaldata: string
Returns void
publicgetStatus
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