Rename RpcResponse to RpcResponseData

solana-labs · Aug 30, 2024 · f16d5af · f16d5af
1 parent 1193f5f
commit f16d5af
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 9 deletions.
diff --git a/.changeset/gorgeous-foxes-type.md b/.changeset/gorgeous-foxes-type.md
@@ -0,0 +1,8 @@
+---
+'@solana/rpc-subscriptions-spec': patch
+'@solana/rpc-spec-types': patch
+'@solana/rpc-spec': patch
+'@solana/rpc-api': patch
+---
+
+Rename `RpcResponse` type to `RpcResponseData` to make room for a new `RpcResponse` type
diff --git a/packages/rpc-api/src/__tests__/get-stake-minimum-delegation-test.ts b/packages/rpc-api/src/__tests__/get-stake-minimum-delegation-test.ts
@@ -11,7 +11,7 @@ describe('getStakeMinimumDelegation', () => {
     });
     (['confirmed', 'finalized', 'processed'] as Commitment[]).forEach(commitment => {
         describe(`when called with \`${commitment}\` commitment`, () => {
-            it('returns the result as a bigint wrapped in an RpcResponse', async () => {
+            it('returns the result as a bigint wrapped in an RpcResponseData', async () => {
                 expect.assertions(1);
                 const result = await rpc.getStakeMinimumDelegation({ commitment }).send();
                 expect(result.value).toEqual(expect.any(BigInt));

diff --git a/packages/rpc-api/src/__tests__/is-blockhash-valid-test.ts b/packages/rpc-api/src/__tests__/is-blockhash-valid-test.ts
@@ -11,7 +11,7 @@ describe('isBlockhashValid', () => {
     });
     (['confirmed', 'finalized', 'processed'] as Commitment[]).forEach(commitment => {
         describe(`when called with \`${commitment}\` commitment`, () => {
-            it('returns the result as a bool wrapped in an RpcResponse', async () => {
+            it('returns the result as a bool wrapped in an RpcResponseData', async () => {
                 expect.assertions(1);
                 const blockhash = '9PCVWkKP3bq1sT5eLFurUysMvVs4PxJsTfza5QSBB4d1' as Blockhash;
                 const result = await rpc.isBlockhashValid(blockhash, { commitment }).send();

diff --git a/packages/rpc-spec-types/src/rpc-response.ts b/packages/rpc-spec-types/src/rpc-response.ts
@@ -2,10 +2,11 @@ interface IHasIdentifier {
     readonly id: number;
 }
 
-type RpcErrorResponse = Readonly<{
+type RpcErrorResponsePayload = Readonly<{
     code: number;
     data?: unknown;
     message: string;
 }>;
 
-export type RpcResponse<TResponse> = IHasIdentifier & Readonly<{ error: RpcErrorResponse } | { result: TResponse }>;
+export type RpcResponseData<TResponse> = IHasIdentifier &
+    Readonly<{ error: RpcErrorResponsePayload } | { result: TResponse }>;
diff --git a/packages/rpc-spec/src/rpc.ts b/packages/rpc-spec/src/rpc.ts
@@ -3,7 +3,7 @@ import {
     createRpcMessage,
     Flatten,
     OverloadImplementations,
-    RpcResponse,
+    RpcResponseData,
     UnionToIntersection,
 } from '@solana/rpc-spec-types';
 
@@ -69,7 +69,7 @@ function createPendingRpcRequest<TRpcMethods, TRpcTransport extends RpcTransport
         async send(options?: RpcSendOptions): Promise<TResponse> {
             const { methodName, params, responseTransformer } = pendingRequest;
             const payload = createRpcMessage(methodName, params);
-            const response = await rpcConfig.transport<RpcResponse<unknown>>({
+            const response = await rpcConfig.transport<RpcResponseData<unknown>>({
                 payload,
                 signal: options?.abortSignal,
             });

diff --git a/packages/rpc-subscriptions-spec/src/rpc-subscriptions.ts b/packages/rpc-subscriptions-spec/src/rpc-subscriptions.ts
@@ -9,7 +9,7 @@ import {
     createRpcMessage,
     Flatten,
     OverloadImplementations,
-    RpcResponse,
+    RpcResponseData,
     UnionToIntersection,
 } from '@solana/rpc-spec-types';
 
@@ -155,7 +155,7 @@ function createPendingRpcSubscription<
              * STEP 2: Wait for the acknowledgement from the server with the subscription id.
              */
             for await (const message of connection as AsyncIterable<
-                RpcNotification<unknown> | RpcResponse<RpcSubscriptionId>
+                RpcNotification<unknown> | RpcResponseData<RpcSubscriptionId>
             >) {
                 if ('id' in message && message.id === subscribeMessage.id) {
                     if ('error' in message) {
@@ -175,7 +175,7 @@ function createPendingRpcSubscription<
             return {
                 async *[Symbol.asyncIterator]() {
                     for await (const message of connection as AsyncIterable<
-                        RpcNotification<unknown> | RpcResponse<RpcSubscriptionId>
+                        RpcNotification<unknown> | RpcResponseData<RpcSubscriptionId>
                     >) {
                         if (!('params' in message) || message.params.subscription !== subscriptionId) {
                             continue;