refactor(experimental): add cluster level API for rpc-core

packages/rpc-core/src/rpc-methods/__typetests__/api-type-test.ts

@@ -0,0 +1,29 @@
+import { IRpcApi, IRpcApiDevnet, IRpcApiMainnet, IRpcApiTestnet } from '@solana/rpc-transport';
+
+import { createSolanaRpcApi, SolanaRpcMethods } from '..';
+
+const config = null as unknown as Parameters<typeof createSolanaRpcApi>[0];
+
+// No cluster specified should be generic `IRpcApi`
+createSolanaRpcApi(config) satisfies IRpcApi<SolanaRpcMethods>;
+
+// When devnet is specified, should be `IRpcApiDevnet`
+createSolanaRpcApi<'devnet'>(config) satisfies IRpcApiDevnet<SolanaRpcMethods>;
+// @ts-expect-error Should not be a testnet API
+createSolanaRpcApi<'devnet'>(config) satisfies IRpcApiTestnet<SolanaRpcMethods>;
+// @ts-expect-error Should not be a mainnet API
+createSolanaRpcApi<'devnet'>(config) satisfies IRpcApiMainnet<SolanaRpcMethods>;
+
+// When testnet is specified, should be `IRpcApiTestnet`
+createSolanaRpcApi<'testnet'>(config) satisfies IRpcApiTestnet<SolanaRpcMethods>;
+// @ts-expect-error Should not be a devnet API
+createSolanaRpcApi<'testnet'>(config) satisfies IRpcApiDevnet<SolanaRpcMethods>;
+// @ts-expect-error Should not be a mainnet API
+createSolanaRpcApi<'testnet'>(config) satisfies IRpcApiMainnet<SolanaRpcMethods>;
+
+// When mainnet is specified, should be `IRpcApiMainnet`
+createSolanaRpcApi<'mainnet'>(config) satisfies IRpcApiMainnet<Omit<SolanaRpcMethods, 'requestAirdrop'>>;
+// @ts-expect-error Should not be a devnet API
+createSolanaRpcApi<'mainnet'>(config) satisfies IRpcApiDevnet<Omit<SolanaRpcMethods, 'requestAirdrop'>>;
+// @ts-expect-error Should not be a testnet API
+createSolanaRpcApi<'mainnet'>(config) satisfies IRpcApiTestnet<Omit<SolanaRpcMethods, 'requestAirdrop'>>;

packages/rpc-core/src/rpc-methods/index.ts

@@ -1,4 +1,4 @@
-import { createJsonRpcApi } from '@solana/rpc-transport';
+import { createJsonRpcApi, IRpcApiDevnet, IRpcApiMainnet, IRpcApiTestnet } from '@solana/rpc-transport';
 import { IRpcApi } from '@solana/rpc-transport';
 
 import { getParamsPatcherForSolanaLabsRpc, ParamsPatcherConfig } from '../params-patcher';
@@ -113,11 +113,25 @@ export type SolanaRpcMethods = GetAccountInfoApi &
     SendTransactionApi &
     SimulateTransactionApi;
 
-export function createSolanaRpcApi(config?: Config): IRpcApi<SolanaRpcMethods> {
-    return createJsonRpcApi<SolanaRpcMethods>({
+export function createSolanaRpcApi<TCluster extends 'devnet' | 'testnet' | 'mainnet' | void = void>(
+    config?: Config,
+): TCluster extends 'devnet'
+    ? IRpcApiDevnet<SolanaRpcMethods>
+    : TCluster extends 'testnet'
+      ? IRpcApiTestnet<SolanaRpcMethods>
+      : TCluster extends 'mainnet'
+        ? IRpcApiMainnet<Omit<SolanaRpcMethods, 'requestAirdrop'>>
+        : IRpcApi<SolanaRpcMethods> {
+    return createJsonRpcApi<SolanaRpcMethods, TCluster>({
         parametersTransformer: getParamsPatcherForSolanaLabsRpc(config) as (params: unknown[]) => unknown[],
         responseTransformer: patchResponseForSolanaLabsRpc,
-    });
+    }) as TCluster extends 'devnet'
+        ? IRpcApiDevnet<SolanaRpcMethods>
+        : TCluster extends 'testnet'
+          ? IRpcApiTestnet<SolanaRpcMethods>
+          : TCluster extends 'mainnet'
+            ? IRpcApiMainnet<Omit<SolanaRpcMethods, 'requestAirdrop'>>
+            : IRpcApi<SolanaRpcMethods>;
 }
 
 export type {