Type definition of a more complicated RPC method, getAccountInfo

Author: steveluscher

packages/rpc-core/src/types/jsonRpcApi.d.ts

@@ -1,4 +1,5 @@
+import { GetAccountInfoApi } from './rpc-methods/getAccountInfo';
 import { GetBlockHeightApi } from './rpc-methods/getBlockHeight';
 import { GetBlocksApi } from './rpc-methods/getBlocks';
 
-declare interface JsonRpcApi extends GetBlockHeightApi, GetBlocksApi {}
+declare interface JsonRpcApi extends GetAccountInfoApi, GetBlockHeightApi, GetBlocksApi {}

packages/rpc-core/src/types/rpc-methods/common.d.ts

@@ -1,3 +1,8 @@
+declare type DataSlice = readonly {
+    offset: number;
+    length: number;
+};
+
 // TODO: Eventually move this into whatever package implements transactions
 declare type Finality = 'confirmed' | 'finalized' | 'processed';
 

packages/rpc-core/src/types/rpc-methods/getAccountInfo.d.ts

@@ -0,0 +1,92 @@
+import { Base58EncodedAddress } from '@solana/keys';
+import { IJsonRPCTransport } from '../../rpc';
+
+type Base64EncodedBytes = string & { readonly __base64EncodedBytes: unique symbol };
+type Base64EncodedZStdCompressedBytes = string & { readonly __base64EncodedZStdCompressedBytes: unique symbol };
+
+type Base64EncodedDataResponse = [Base64EncodedBytes, 'base64'];
+type Base64EncodedZStdCompressedDataResponse = [Base64EncodedZStdCompressedBytes, 'base64+zstd'];
+
+type GetAccountInfoApiResponseBase = Readonly<{
+    context: Readonly<{
+        slot: Slot;
+    }>;
+    value: Readonly<{
+        executable: boolean;
+        lamports: number; // TODO(solana-labs/solana/issues/30341) Represent as bigint
+        owner: Base64EncodedAddress;
+        rentEpoch: number; // TODO(solana-labs/solana/issues/30341) Represent as bigint
+        space: number; // TODO(solana-labs/solana/issues/30341) Represent as bigint
+    }> | null;
+}>;
+
+type GetAccountInfoApiResponseWithEncodedData = Readonly<{
+    value: Readonly<{
+        data: Base64EncodedDataResponse;
+    }> | null;
+}>;
+
+type GetAccountInfoApiResponseWithEncodedZStdCompressedData = Readonly<{
+    value: Readonly<{
+        data: Base64EncodedZStdCompressedDataResponse;
+    }> | null;
+}>;
+
+type GetAccountInfoApiResponseWithJsonData = Readonly<{
+    value: Readonly<{
+        data:
+            | Readonly<{
+                  // Name of the program that owns this account.
+                  program: string;
+                  parsed: unknown;
+                  space: number; // TODO(solana-labs/solana/issues/30341) Represent as bigint
+              }>
+            // If `jsonParsed` encoding is requested but a parser cannot be found for the given
+            // account the `data` field falls back to `base64`.
+            | Base64EncodedDataResponse;
+    }> | null;
+}>;
+
+type GetAccountInfoApiCommonConfig = readonly {
+    // Defaults to `finalized`
+    commitment?: Finality;
+    // The minimum slot that the request can be evaluated at
+    minContextSlot?: Slot;
+};
+
+type GetAccountInfoApiBase64EncodingCommonConfig = readonly {
+    // Limit the returned account data using the provided "offset: <usize>" and "length: <usize>" fields.
+    dataSlice?: DataSlice;
+};
+
+declare interface GetAccountInfoApi {
+    /**
+     * Returns all information associated with the account of provided public key
+     */
+    getAccountInfo(
+        transport: IJsonRPCTransport,
+        address: Base58EncodedAddress,
+        config?: readonly {
+            encoding: 'base64';
+        } &
+            GetAccountInfoApiCommonConfig &
+            GetAccountInfoApiBase64EncodingCommonConfig
+    ): Promise<GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithEncodedData>;
+    getAccountInfo(
+        transport: IJsonRPCTransport,
+        address: Base58EncodedAddress,
+        config?: readonly {
+            encoding: 'base64+zstd';
+        } &
+            GetAccountInfoApiCommonConfig &
+            GetAccountInfoApiBase64EncodingCommonConfig
+    ): Promise<GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithEncodedZStdCompressedData>;
+    getAccountInfo(
+        transport: IJsonRPCTransport,
+        address: Base58EncodedAddress,
+        config?: readonly {
+            encoding: 'jsonParsed';
+        } &
+            GetAccountInfoApiCommonConfig
+    ): Promise<GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithJsonData>;
+}