ReconnectingWebSocketProvider

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:20

WebSocket RPC provider with automatic reconnect, heartbeat ping and connection timeout handling.

Extends

• SocketProvider

Extended by

• WebSocketProviderWithRetries

Constructors

Constructor

new ReconnectingWebSocketProvider(
   url, 
   network?, 
   options?): ReconnectingWebSocketProvider;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:36

Parameters

Parameter	Type
url	string | () => WebSocketLike
network?	Networkish
options?	JsonRpcApiProviderOptions

Returns

ReconnectingWebSocketProvider

Overrides

SocketProvider.constructor

Properties

connectionTimeout

connectionTimeout: number = 10;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:25

---

connectTimer

connectTimer: any;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:29

---

logger

readonly logger: LoggerType;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:34

---

pingInterval

pingInterval: any;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:27

---

pingIntervalSeconds

pingIntervalSeconds: number = 30;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:24

---

reconnectSeconds

reconnectSeconds: number = 5;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:23

---

reconnectTimer

reconnectTimer: any;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:28

---

requestTimeoutSeconds

requestTimeoutSeconds: number = 10;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:22

Overrides

SocketProvider.requestTimeoutSeconds

---

websocket

websocket: any = null;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:32

---

wsCtor()

wsCtor: () => WebSocketLike;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:31

Returns

WebSocketLike

Methods

_connected()

_connected(): void;

Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:321

Returns

void

Inherited from

SocketProvider._connected

---

_disconnected()

_disconnected(): void;

Defined in: atomiq-chain-evm/src/evm/providers/SocketProvider.ts:331

Returns

void

Inherited from

SocketProvider._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

SocketProvider._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

SocketProvider._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

SocketProvider._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

SocketProvider._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

SocketProvider._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>

Overrides

SocketProvider._write

---

destroy()

destroy(): Promise<void>;

Defined in: atomiq-chain-evm/src/evm/providers/ReconnectingWebSocketProvider.ts:112

Returns

Promise<void>