Type definition for two simple RPC methods: getBlockHeight and getBlocks

Author: steveluscher

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

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

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

@@ -0,0 +1,6 @@
+// TODO: Eventually move this into whatever package implements transactions
+declare type Finality = 'confirmed' | 'finalized' | 'processed';
+
+declare type Slot =
+    // TODO(solana-labs/solana/issues/30341) Represent as bigint
+    number;

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

@@ -0,0 +1,20 @@
+import { IJsonRpcTransport } from '@solana/rpc-transport';
+
+type GetBlockHeightApiResponse =
+    // TODO(solana-labs/solana/issues/30341) Represent as bigint
+    number;
+
+declare interface GetBlockHeightApi {
+    /**
+     * Returns the current block height of the node
+     */
+    getBlockHeight(
+        transport: IJsonRpcTransport,
+        config?: readonly {
+            // Defaults to `finalized`
+            commitment?: Finality;
+            // The minimum slot that the request can be evaluated at
+            minContextSlot?: Slot;
+        }
+    ): Promise<GetBlockHeightApiResponse>;
+}

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

@@ -0,0 +1,18 @@
+import { IJsonRpcTransport } from '@solana/rpc-transport';
+
+type GetBlocksApiResponse = Slot[];
+
+declare interface GetBlocksApi {
+    /**
+     * Returns a list of confirmed blocks between two slots
+     */
+    getBlocks(
+        transport: IJsonRpcTransport,
+        startSlot: Slot,
+        endSlotInclusive?: Slot,
+        config?: readonly {
+            // Defaults to `finalized`
+            commitment?: Exclude<Finality, 'processed'>;
+        }
+    ): Promise<GetBlocksApiResponse>;
+}