WebSocketProviderWithRetries
Defined in: atomiq-chain-evm/src/evm/providers/WebSocketProviderWithRetries.ts:17
WebSocket RPC provider with reconnect support and retry logic for transient RPC failures.
Extends
Constructors
Constructor
new WebSocketProviderWithRetries(
url,
network?,
options?): WebSocketProviderWithRetries;
Defined in: atomiq-chain-evm/src/evm/providers/WebSocketProviderWithRetries.ts:30
Creates a new WebSocket provider which retries RPC calls based on the provided policy.
Parameters
| Parameter | Type | Description |
|---|---|---|
url | string | () => WebSocketLike | |
network? | Networkish | |
options? | any |
Returns
WebSocketProviderWithRetries
Overrides
ReconnectingWebSocketProvider.constructor
Properties
connectionTimeout
connectionTimeout: number = 10;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:25
Inherited from
ReconnectingWebSocketProvider.connectionTimeout
connectTimer
connectTimer: any;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:29
Inherited from
ReconnectingWebSocketProvider.connectTimer
logger
readonly logger: LoggerType;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:34
Inherited from
ReconnectingWebSocketProvider.logger
pingInterval
pingInterval: any;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:27
Inherited from
ReconnectingWebSocketProvider.pingInterval
pingIntervalSeconds
pingIntervalSeconds: number = 30;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:24
Inherited from
ReconnectingWebSocketProvider.pingIntervalSeconds
reconnectSeconds
reconnectSeconds: number = 5;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:23
Inherited from
ReconnectingWebSocketProvider.reconnectSeconds
reconnectTimer
reconnectTimer: any;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:28
Inherited from
ReconnectingWebSocketProvider.reconnectTimer
requestTimeoutSeconds
requestTimeoutSeconds: number = 10;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:22
Inherited from
ReconnectingWebSocketProvider.requestTimeoutSeconds
retryPolicy?
readonly optional retryPolicy: object;
Defined in: atomiq-chain-evm/src/evm/providers/WebSocketProviderWithRetries.ts:19
delay?
optional delay: number;
exponential?
optional exponential: boolean;
maxRetries?
optional maxRetries: number;
websocket
websocket: any = null;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:32
Inherited from
ReconnectingWebSocketProvider.websocket
wsCtor()
wsCtor: () => WebSocketLike;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:31
Returns
WebSocketLike
Inherited from
ReconnectingWebSocketProvider.wsCtor
Methods
_connected()
_connected(): void;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:321
Returns
void
Inherited from
ReconnectingWebSocketProvider._connected
_disconnected()
_disconnected(): void;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:331
Returns
void
Inherited from
ReconnectingWebSocketProvider._disconnected
_getSubscriber()
_getSubscriber(sub): Subscriber;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:235
Parameters
| Parameter | Type |
|---|---|
sub | Subscription |
Returns
Subscriber
Inherited from
ReconnectingWebSocketProvider._getSubscriber
_processMessage()
_processMessage(message): Promise<void>;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:346
Sub-classes must call this with messages received over their transport to be processed and dispatched.
Parameters
| Parameter | Type |
|---|---|
message | string |
Returns
Promise<void>
Inherited from
ReconnectingWebSocketProvider._processMessage
_register()
_register(filterId, subscriber): void;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:259
Register a new subscriber. This is used internalled by Subscribers and generally is unecessary unless extending capabilities.
Parameters
| Parameter | Type |
|---|---|
filterId | string | number |
subscriber | SocketSubscriber |
Returns
void
Inherited from
ReconnectingWebSocketProvider._register
_send()
_send(payload): Promise<any[]>;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:292
Parameters
| Parameter | Type |
|---|---|
payload | any |
Returns
Promise<any[]>
Inherited from
ReconnectingWebSocketProvider._send
_waitUntilReady()
_waitUntilReady(timeoutSeconds): Promise<void>;
Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:275
Resolves once the [[_start]] has been called. This can be used in sub-classes to defer sending data until the connection has been established.
Parameters
| Parameter | Type | Default value |
|---|---|---|
timeoutSeconds | number | 5 |
Returns
Promise<void>
Inherited from
ReconnectingWebSocketProvider._waitUntilReady
_write()
_write(message): Promise<void>;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:107
Sub-classes must override this to send %%message%% over their transport.
Parameters
| Parameter | Type |
|---|---|
message | string |
Returns
Promise<void>
Inherited from
ReconnectingWebSocketProvider._write
destroy()
destroy(): Promise<void>;
Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:112
Returns
Promise<void>
Inherited from
ReconnectingWebSocketProvider.destroy
send()
send(method, params): Promise<any>;
Defined in: atomiq-chain-evm/src/evm/providers/WebSocketProviderWithRetries.ts:37
Parameters
| Parameter | Type |
|---|---|
method | string |
params | any[] | Record<string, any> |
Returns
Promise<any>