refactor(experimental): move web socket transport types out of rpc-tr…

…ansport
solana-labs · Feb 1, 2024 · bd0ef5d · bd0ef5d
1 parent c5fdaa6
commit bd0ef5d
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 34 deletions.
diff --git a/packages/library/src/__tests__/rpc-websocket-autopinger-test.ts b/packages/library/src/__tests__/rpc-websocket-autopinger-test.ts
@@ -1,4 +1,4 @@
-import type { IRpcWebSocketTransport } from '@solana/rpc-transport';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
 
 import { getWebSocketTransportWithAutoping } from '../rpc-websocket-autopinger';
 

diff --git a/packages/library/src/__tests__/rpc-websocket-connection-sharding-test.ts b/packages/library/src/__tests__/rpc-websocket-connection-sharding-test.ts
@@ -1,4 +1,4 @@
-import type { IRpcWebSocketTransport } from '@solana/rpc-transport';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
 
 import { getWebSocketTransportWithConnectionSharding } from '../rpc-websocket-connection-sharding';
 

diff --git a/packages/library/src/rpc-websocket-autopinger.ts b/packages/library/src/rpc-websocket-autopinger.ts
@@ -1,4 +1,4 @@
-import type { IRpcWebSocketTransport } from '@solana/rpc-transport';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
 
 type Config = Readonly<{
     intervalMs: number;

diff --git a/packages/library/src/rpc-websocket-connection-sharding.ts b/packages/library/src/rpc-websocket-connection-sharding.ts
@@ -1,4 +1,4 @@
-import type { IRpcWebSocketTransport } from '@solana/rpc-transport';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
 
 import { getCachedAbortableIterableFactory } from './cached-abortable-iterable';
 

diff --git a/packages/library/src/rpc-websocket-transport.ts b/packages/library/src/rpc-websocket-transport.ts
@@ -1,5 +1,6 @@
 import { pipe } from '@solana/functional';
-import { createWebSocketTransport, type IRpcWebSocketTransport } from '@solana/rpc-transport';
+import { createWebSocketTransport } from '@solana/rpc-transport';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
 
 import { getWebSocketTransportWithAutoping } from './rpc-websocket-autopinger';
 import { getWebSocketTransportWithConnectionSharding } from './rpc-websocket-connection-sharding';

diff --git a/packages/rpc-transport/src/__tests__/json-rpc-subscription-test.ts b/packages/rpc-transport/src/__tests__/json-rpc-subscription-test.ts
@@ -1,10 +1,9 @@
-import { IRpcSubscriptionsApi, RpcSubscription, RpcSubscriptions } from '@solana/rpc-types';
+import { IRpcSubscriptionsApi, IRpcWebSocketTransport, RpcSubscription, RpcSubscriptions } from '@solana/rpc-types';
 
 import { SolanaJsonRpcError } from '../json-rpc-errors';
 import { createJsonRpcMessage } from '../json-rpc-message';
 import { getNextMessageId } from '../json-rpc-message-id';
 import { createJsonSubscriptionRpc } from '../json-rpc-subscription';
-import { IRpcWebSocketTransport } from '../transports/transport-types';
 
 jest.mock('../json-rpc-message-id');
 

diff --git a/packages/rpc-transport/src/index.ts b/packages/rpc-transport/src/index.ts
@@ -5,5 +5,4 @@ export * from './json-rpc';
 export type { SolanaJsonRpcErrorCode } from './json-rpc-errors';
 export * from './json-rpc-subscription';
 export * from './transports/http/http-transport';
-export type { IRpcWebSocketTransport } from './transports/transport-types';
 export * from './transports/websocket/websocket-transport';
diff --git a/packages/rpc-transport/src/json-rpc-config.ts b/packages/rpc-transport/src/json-rpc-config.ts
@@ -1,6 +1,4 @@
-import { IIRpcTransport, IRpcApi, IRpcSubscriptionsApi } from '@solana/rpc-types';
-
-import { IRpcWebSocketTransport } from './transports/transport-types';
+import { IIRpcTransport, IRpcApi, IRpcSubscriptionsApi, IRpcWebSocketTransport } from '@solana/rpc-types';
 
 export type RpcConfig<TRpcMethods> = Readonly<{
     api: IRpcApi<TRpcMethods>;

diff --git a/packages/rpc-transport/src/transports/transport-types.ts b/packages/rpc-transport/src/transports/transport-types.ts
diff --git a/packages/rpc-transport/src/transports/websocket/__tests__/websocket-connection-test.ts b/packages/rpc-transport/src/transports/websocket/__tests__/websocket-connection-test.ts
@@ -1,7 +1,8 @@
+import type { RpcWebSocketConnection } from '@solana/rpc-types';
 import WS from 'jest-websocket-mock';
 import { Client } from 'mock-socket';
 
-import { createWebSocketConnection, RpcWebSocketConnection } from '../websocket-connection';
+import { createWebSocketConnection } from '../websocket-connection';
 
 const MOCK_SEND_BUFFER_HIGH_WATERMARK = 42069;
 

diff --git a/packages/rpc-transport/src/transports/websocket/__tests__/websocket-transport-test.ts b/packages/rpc-transport/src/transports/websocket/__tests__/websocket-transport-test.ts
@@ -1,4 +1,5 @@
-import { IRpcWebSocketTransport } from '../../transport-types';
+import type { IRpcWebSocketTransport } from '@solana/rpc-types';
+
 import { createWebSocketConnection } from '../websocket-connection';
 import { createWebSocketTransport } from '../websocket-transport';
 

diff --git a/packages/rpc-transport/src/transports/websocket/websocket-connection.ts b/packages/rpc-transport/src/transports/websocket/websocket-connection.ts
@@ -1,3 +1,4 @@
+import { RpcWebSocketConnection } from '@solana/rpc-types';
 import WebSocket from 'ws-impl';
 
 type Config = Readonly<{
@@ -16,10 +17,6 @@ type IteratorState =
           __hasPolled: false;
           queuedMessages: unknown[];
       };
-export type RpcWebSocketConnection = Readonly<{
-    send(payload: unknown): Promise<void>;
-    [Symbol.asyncIterator](): AsyncGenerator<unknown>;
-}>;
 
 const EXPLICIT_ABORT_TOKEN = Symbol(
     __DEV__

diff --git a/packages/rpc-transport/src/transports/websocket/websocket-transport.ts b/packages/rpc-transport/src/transports/websocket/websocket-transport.ts
@@ -1,4 +1,5 @@
-import { IRpcWebSocketTransport } from '../transport-types';
+import { IRpcWebSocketTransport } from '@solana/rpc-types';
+
 import { createWebSocketConnection } from './websocket-connection';
 
 type Config = Readonly<{

diff --git a/packages/rpc-types/src/rpc-api.ts b/packages/rpc-types/src/rpc-api.ts
@@ -7,6 +7,16 @@ type RpcTransportConfig = Readonly<{
     signal?: AbortSignal;
 }>;
 
+export type RpcWebSocketConnection = Readonly<{
+    send(payload: unknown): Promise<void>;
+    [Symbol.asyncIterator](): AsyncGenerator<unknown>;
+}>;
+
+type RpcWebSocketTransportConfig = Readonly<{
+    payload: unknown;
+    signal: AbortSignal;
+}>;
+
 /**
  * Public RPC Transport API
  */
@@ -25,6 +35,15 @@ export type IRpcTransportFromClusterUrl<TClusterUrl extends ClusterUrl> = TClust
         ? IRpcTransportMainnet
         : IRpcTransport;
 
+export interface IRpcWebSocketTransport {
+    (config: RpcWebSocketTransportConfig): Promise<
+        Readonly<
+            Omit<RpcWebSocketConnection, 'send'> & {
+                send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: RpcWebSocketConnection['send'];
+            }
+        >
+    >;
+}
 /**
  * Public RPC API.
  */