Clean up SolanaRpcApi: no longer extend RpcApiMethods (#3213)

Extending `RpcApiMethods` removes the ability to access typed keys on `SolanaRpcApi` etc, because it's typed as `[method: string]: RpcApiMethod`. In this PR we change from: ```ts interface GetAssetApi extends RpcApiMethods { ``` To: ```ts type GetAssetApi = { ``` (Thanks @lorisleiva!) This allows `createRpcApi` to maintain its typing, meaning that it still constrains any API methods we attempt to build an RPC for. But we now have typesafe `keyof SolanaRpcApi` etc. I've also removed the export of `RpcApiMethods`, since this should now be used only as a constraint internally and not a type externally. I've added a typetest with a bit more detail, but this basically makes this work: ```ts 'getAccountInfo' satisfies keyof SolanaRpcApi; // @ts-expect-error RPC API does not have this method 'someMadeUpMethod' satisfies keyof SolanaRpcApi; ``` Previously `someMadeUpMethod` would satisfy it, because `keyof SolanaRpcApi` was just string.
solana-labs · Sep 9, 2024 · 3fc388f · 3fc388f
1 parent 3df153c
commit 3fc388f
Show file tree

Hide file tree

Showing 68 changed files with 157 additions and 186 deletions.
diff --git a/.changeset/green-eels-applaud.md b/.changeset/green-eels-applaud.md
@@ -0,0 +1,8 @@
+---
+'@solana/rpc-graphql': patch
+'@solana/accounts': patch
+'@solana/rpc-spec': patch
+'@solana/rpc-api': patch
+---
+
+Clean up SolanaRpcApi: no longer extend RpcApiMethods + remove export
diff --git a/README.md b/README.md
@@ -389,8 +389,8 @@ type GetAssetApiResponse = Readonly<{
     /* ...etc... */
 }>;
 
-// Set up an interface for the request method.
-interface GetAssetApi extends RpcApiMethods {
+// Set up a type spec for the request method.
+type GetAssetApi = {
     // Define the method's name, parameters and response type
     getAsset(args: { id: Address }): GetAssetApiResponse;
 }

diff --git a/examples/rpc-custom-api/src/example.ts b/examples/rpc-custom-api/src/example.ts
@@ -14,7 +14,6 @@ import {
     DEFAULT_RPC_CONFIG,
     mainnet,
     RpcApi,
-    RpcApiMethods,
     SolanaRpcApiMainnet,
 } from '@solana/web3.js';
 
@@ -31,13 +30,13 @@ type AssetMetadata = Readonly<{
     name: string;
     symbol: string;
 }>;
-interface TritonGetAssetApi extends RpcApiMethods {
+type TritonGetAssetApi = {
     /**
      * Define the ideal developer-facing API as a TypeScript type. Doing so will enable typechecking
      * and autocompletion for it on the RPC instance.
      */
     getAssetMetadata(address: Address): AssetMetadata;
-}
+};
 
 /**
  * STEP 2: CUSTOM JSON RPC API IMPLEMENTATION

diff --git a/packages/accounts/src/rpc-api/getAccountInfo.ts b/packages/accounts/src/rpc-api/getAccountInfo.ts
@@ -1,5 +1,4 @@
 import type { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type {
     AccountInfoBase,
     AccountInfoWithBase58Bytes,
@@ -31,7 +30,7 @@ type GetAccountInfoApiSliceableCommonConfig = Readonly<{
     dataSlice?: DataSlice;
 }>;
 
-export interface GetAccountInfoApi extends RpcApiMethods {
+export type GetAccountInfoApi = {
     /**
      * Returns all information associated with the account of provided public key
      */
@@ -70,4 +69,4 @@ export interface GetAccountInfoApi extends RpcApiMethods {
         address: Address,
         config?: GetAccountInfoApiCommonConfig,
     ): GetAccountInfoApiResponseBase & NestInRpcResponseOrNull<AccountInfoWithBase58Bytes>;
-}
+};
diff --git a/packages/accounts/src/rpc-api/getMultipleAccounts.ts b/packages/accounts/src/rpc-api/getMultipleAccounts.ts
@@ -1,5 +1,4 @@
 import type { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type {
     AccountInfoBase,
     AccountInfoWithBase58EncodedData,
@@ -26,7 +25,7 @@ type GetMultipleAccountsApiSliceableCommonConfig = Readonly<{
     dataSlice?: DataSlice;
 }>;
 
-export interface GetMultipleAccountsApi extends RpcApiMethods {
+export type GetMultipleAccountsApi = {
     /**
      * Returns the account information for a list of Pubkeys.
      */
@@ -72,4 +71,4 @@ export interface GetMultipleAccountsApi extends RpcApiMethods {
         addresses: Address[],
         config?: GetMultipleAccountsApiCommonConfig,
     ): SolanaRpcResponse<(GetMultipleAccountsApiResponseBase & (AccountInfoWithBase64EncodedData | null))[]>;
-}
+};
diff --git a/packages/rpc-api/README.md b/packages/rpc-api/README.md
@@ -16,12 +16,12 @@
 
 This package contains types that describe the [methods](https://solana.com/docs/rpc/http) of the Solana JSON RPC API, and utilities for creating a `RpcApi` implementation with sensible defaults. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@rc`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
 
-Each RPC method is described in terms of a TypeScript interface of the following form:
+Each RPC method is described in terms of a TypeScript type of the following form:
 
 ```ts
-interface ExampleApi extends RpcApiMethods {
+type ExampleApi = {
     getSomething(address: Address): Something;
-}
+};
 ```
 
 A `RpcApi` that implements `ExampleApi` will ultimately expose its defined methods on any `Rpc` that uses it.

diff --git a/packages/rpc-api/src/__tests__/get-slot-leaders-test.ts b/packages/rpc-api/src/__tests__/get-slot-leaders-test.ts
@@ -6,7 +6,7 @@ import { SOLANA_ERROR__JSON_RPC__INVALID_PARAMS, SolanaError } from '@solana/err
 import type { Rpc } from '@solana/rpc-spec';
 import path from 'path';
 
-import { GetSlotLeadersApi } from '../index';
+import { GetSlotLeadersApi, MinimumLedgerSlotApi } from '../index';
 import { createLocalhostSolanaRpc } from './__setup__';
 
 const validatorKeypairPath = path.resolve(__dirname, '../../../../test-ledger/validator-keypair.json');
@@ -31,7 +31,7 @@ async function getValidatorAddress() {
 }
 
 describe('getSlotLeaders', () => {
-    let rpc: Rpc<GetSlotLeadersApi>;
+    let rpc: Rpc<GetSlotLeadersApi & MinimumLedgerSlotApi>;
     beforeEach(() => {
         rpc = createLocalhostSolanaRpc();
     });

diff --git a/packages/rpc-api/src/__tests__/get-token-largest-accounts-test.ts b/packages/rpc-api/src/__tests__/get-token-largest-accounts-test.ts
@@ -3,15 +3,15 @@ import { SOLANA_ERROR__JSON_RPC__INVALID_PARAMS, SolanaError } from '@solana/err
 import type { Rpc } from '@solana/rpc-spec';
 import type { Commitment } from '@solana/rpc-types';
 
-import { GetTokenLargestAccountsApi } from '../index';
+import { GetTokenLargestAccountsApi, GetTokenSupplyApi } from '../index';
 import { createLocalhostSolanaRpc } from './__setup__';
 
 const CONTEXT_MATCHER = expect.objectContaining({
     slot: expect.any(BigInt),
 });
 
 describe('getTokenLargestAccounts', () => {
-    let rpc: Rpc<GetTokenLargestAccountsApi>;
+    let rpc: Rpc<GetTokenLargestAccountsApi & GetTokenSupplyApi>;
     beforeEach(() => {
         rpc = createLocalhostSolanaRpc();
     });

diff --git a/packages/rpc-api/src/__typetests__/rpc-api-type-test.ts b/packages/rpc-api/src/__typetests__/rpc-api-type-test.ts
@@ -0,0 +1,18 @@
+import { SolanaRpcApi, SolanaRpcApiDevnet, SolanaRpcApiMainnet, SolanaRpcApiTestnet } from '..';
+
+'getAccountInfo' satisfies keyof SolanaRpcApi;
+// @ts-expect-error RPC API does not have this method
+'someMadeUpMethod' satisfies keyof SolanaRpcApi;
+
+// if we extend the RPC API with additional methods, we can access them on keyof
+type TestRpcApi = SolanaRpcApi & {
+    someMadeUpMethod: () => void;
+};
+'someMadeUpMethod' satisfies keyof TestRpcApi;
+
+// request airdrop is available on test networks, but not mainnet
+'requestAirdrop' satisfies keyof SolanaRpcApiDevnet;
+'requestAirdrop' satisfies keyof SolanaRpcApiTestnet;
+'requestAirdrop' satisfies keyof SolanaRpcApi;
+// @ts-expect-error requestAirdrop is not available on mainnet
+'requestAirdrop' satisfies keyof SolanaRpcApiMainnet;
diff --git a/packages/rpc-api/src/getAccountInfo.ts b/packages/rpc-api/src/getAccountInfo.ts
@@ -1,5 +1,4 @@
 import type { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type {
     AccountInfoBase,
     AccountInfoWithBase58Bytes,
@@ -27,7 +26,7 @@ type GetAccountInfoApiSliceableCommonConfig = Readonly<{
     dataSlice?: DataSlice;
 }>;
 
-export interface GetAccountInfoApi extends RpcApiMethods {
+export type GetAccountInfoApi = {
     /**
      * Returns all information associated with the account of provided public key
      */
@@ -66,4 +65,4 @@ export interface GetAccountInfoApi extends RpcApiMethods {
         address: Address,
         config?: GetAccountInfoApiCommonConfig,
     ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithBase58Bytes>>;
-}
+};
diff --git a/packages/rpc-api/src/getBalance.ts b/packages/rpc-api/src/getBalance.ts
@@ -1,10 +1,9 @@
 import type { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, LamportsUnsafeBeyond2Pow53Minus1, Slot, SolanaRpcResponse } from '@solana/rpc-types';
 
 type GetBalanceApiResponse = SolanaRpcResponse<LamportsUnsafeBeyond2Pow53Minus1>;
 
-export interface GetBalanceApi extends RpcApiMethods {
+export type GetBalanceApi = {
     /**
      * Returns the balance of the account of provided Pubkey
      */
@@ -15,4 +14,4 @@ export interface GetBalanceApi extends RpcApiMethods {
             minContextSlot?: Slot;
         }>,
     ): GetBalanceApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getBlock.ts b/packages/rpc-api/src/getBlock.ts
@@ -1,4 +1,3 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type {
     Base58EncodedBytes,
     Blockhash,
@@ -62,7 +61,7 @@ type GetBlockEncoding = 'base58' | 'base64' | 'json' | 'jsonParsed';
 // - These rules apply to both "accounts" and "full" transaction details.
 type GetBlockMaxSupportedTransactionVersion = Exclude<TransactionVersion, 'legacy'>;
 
-export interface GetBlockApi extends RpcApiMethods {
+export type GetBlockApi = {
     /**
      * Returns identity and transaction information about a confirmed block in the ledger
      */
@@ -375,4 +374,4 @@ export interface GetBlockApi extends RpcApiMethods {
               GetBlockApiResponseWithRewards &
               GetBlockApiResponseWithTransactions<TransactionForFullJson<void>>)
         | null;
-}
+};
diff --git a/packages/rpc-api/src/getBlockCommitment.ts b/packages/rpc-api/src/getBlockCommitment.ts
@@ -1,15 +1,14 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { LamportsUnsafeBeyond2Pow53Minus1, Slot } from '@solana/rpc-types';
 
 type GetBlockCommitmentApiResponse = Readonly<{
     commitment: LamportsUnsafeBeyond2Pow53Minus1[] | null;
     totalStake: LamportsUnsafeBeyond2Pow53Minus1;
 }>;
 
-export interface GetBlockCommitmentApi extends RpcApiMethods {
+export type GetBlockCommitmentApi = {
     /**
      * Returns the amount of cluster stake in lamports that has voted on
      * a particular block, as well as the stake attributed to each vote account
      */
     getBlockCommitment(slot: Slot): GetBlockCommitmentApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getBlockHeight.ts b/packages/rpc-api/src/getBlockHeight.ts
@@ -1,9 +1,8 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, Slot, U64UnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
 
 type GetBlockHeightApiResponse = U64UnsafeBeyond2Pow53Minus1;
 
-export interface GetBlockHeightApi extends RpcApiMethods {
+export type GetBlockHeightApi = {
     /**
      * Returns the current block height of the node
      */
@@ -15,4 +14,4 @@ export interface GetBlockHeightApi extends RpcApiMethods {
             minContextSlot?: Slot;
         }>,
     ): GetBlockHeightApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getBlockProduction.ts b/packages/rpc-api/src/getBlockProduction.ts
@@ -1,5 +1,4 @@
 import type { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, Slot, SolanaRpcResponse, U64UnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
 
 type NumberOfLeaderSlots = U64UnsafeBeyond2Pow53Minus1;
@@ -32,7 +31,7 @@ type GetBlockProductionApiResponse<T> = Readonly<{
     range: SlotRange;
 }>;
 
-export interface GetBlockProductionApi extends RpcApiMethods {
+export type GetBlockProductionApi = {
     /**
      * Returns recent block production information from the current or previous epoch.
      */
@@ -45,4 +44,4 @@ export interface GetBlockProductionApi extends RpcApiMethods {
     getBlockProduction(
         config?: GetBlockProductionApiConfigBase,
     ): SolanaRpcResponse<GetBlockProductionApiResponse<BlockProductionWithAllIdentities>>;
-}
+};
diff --git a/packages/rpc-api/src/getBlockTime.ts b/packages/rpc-api/src/getBlockTime.ts
@@ -1,15 +1,14 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Slot, UnixTimestampUnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
 
 /** Estimated production time, as Unix timestamp (seconds since the Unix epoch) */
 type GetBlockTimeApiResponse = UnixTimestampUnsafeBeyond2Pow53Minus1;
 
-export interface GetBlockTimeApi extends RpcApiMethods {
+export type GetBlockTimeApi = {
     /**
      * Returns the estimated production time of a block.
      */
     getBlockTime(
         /** block number, identified by Slot */
         blockNumber: Slot,
     ): GetBlockTimeApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getBlocks.ts b/packages/rpc-api/src/getBlocks.ts
@@ -1,9 +1,8 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, Slot } from '@solana/rpc-types';
 
 type GetBlocksApiResponse = Slot[];
 
-export interface GetBlocksApi extends RpcApiMethods {
+export type GetBlocksApi = {
     /**
      * Returns a list of confirmed blocks between two slots
      */
@@ -15,4 +14,4 @@ export interface GetBlocksApi extends RpcApiMethods {
             commitment?: Exclude<Commitment, 'processed'>;
         }>,
     ): GetBlocksApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getBlocksWithLimit.ts b/packages/rpc-api/src/getBlocksWithLimit.ts
@@ -1,9 +1,8 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, Slot } from '@solana/rpc-types';
 
 type GetBlocksWithLimitApiResponse = Slot[];
 
-export interface GetBlocksWithLimitApi extends RpcApiMethods {
+export type GetBlocksWithLimitApi = {
     /**
      * Returns a list of confirmed blocks starting at the given slot
      * for up to `limit` blocks
@@ -18,4 +17,4 @@ export interface GetBlocksWithLimitApi extends RpcApiMethods {
             commitment?: Exclude<Commitment, 'processed'>;
         }>,
     ): GetBlocksWithLimitApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getClusterNodes.ts b/packages/rpc-api/src/getClusterNodes.ts
@@ -1,5 +1,4 @@
 import { Address } from '@solana/addresses';
-import type { RpcApiMethods } from '@solana/rpc-spec';
 
 type ClusterNode = Readonly<{
     /** The unique identifier of the node's feature set */
@@ -40,7 +39,7 @@ type ClusterNode = Readonly<{
 
 type GetClusterNodesApiResponse = readonly ClusterNode[];
 
-export interface GetClusterNodesApi extends RpcApiMethods {
+export type GetClusterNodesApi = {
     /**
      * Returns information about all the nodes participating in the cluster
      * Note that the optional NO_CONFIG object is ignored. See https://github.com/solana-labs/solana-web3.js/issues/1389
@@ -49,4 +48,4 @@ export interface GetClusterNodesApi extends RpcApiMethods {
         // FIXME: https://github.com/solana-labs/solana-web3.js/issues/1389
         NO_CONFIG?: Record<string, never>,
     ): GetClusterNodesApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getEpochInfo.ts b/packages/rpc-api/src/getEpochInfo.ts
@@ -1,4 +1,3 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { Commitment, Slot, U64UnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
 
 type GetEpochInfoApiResponse = Readonly<{
@@ -16,7 +15,7 @@ type GetEpochInfoApiResponse = Readonly<{
     transactionCount: U64UnsafeBeyond2Pow53Minus1 | null;
 }>;
 
-export interface GetEpochInfoApi extends RpcApiMethods {
+export type GetEpochInfoApi = {
     /**
      * Returns the balance of the account of provided Pubkey
      */
@@ -26,4 +25,4 @@ export interface GetEpochInfoApi extends RpcApiMethods {
             minContextSlot?: Slot;
         }>,
     ): GetEpochInfoApiResponse;
-}
+};
diff --git a/packages/rpc-api/src/getEpochSchedule.ts b/packages/rpc-api/src/getEpochSchedule.ts
@@ -1,4 +1,3 @@
-import type { RpcApiMethods } from '@solana/rpc-spec';
 import type { U64UnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
 
 type GetEpochScheduleApiResponse = Readonly<{
@@ -14,7 +13,7 @@ type GetEpochScheduleApiResponse = Readonly<{
     warmup: boolean;
 }>;
 
-export interface GetEpochScheduleApi extends RpcApiMethods {
+export type GetEpochScheduleApi = {
     /**
      * Returns the epoch schedule information from this cluster's genesis config
      * Note that the optional NO_CONFIG object is ignored. See https://github.com/solana-labs/solana-web3.js/issues/1389
@@ -23,4 +22,4 @@ export interface GetEpochScheduleApi extends RpcApiMethods {
         // FIXME: https://github.com/solana-labs/solana-web3.js/issues/1389
         NO_CONFIG?: Record<string, never>,
     ): GetEpochScheduleApiResponse;
-}
+};