From 62c366680964b87fcb7976f532e4f760b95cb46d Mon Sep 17 00:00:00 2001 From: Steven Luscher Date: Tue, 30 Jul 2024 08:43:23 -0700 Subject: [PATCH] Update the README for `@solana/rpc` (#2993) Addresses #2983. --- packages/rpc/README.md | 108 +++++++++++++++++++++++++++++- packages/rpc/src/rpc-clusters.ts | 1 - packages/rpc/src/rpc-transport.ts | 2 +- packages/rpc/src/rpc.ts | 6 +- 4 files changed, 113 insertions(+), 4 deletions(-) diff --git a/packages/rpc/README.md b/packages/rpc/README.md index 559e43cf148..c91e8ef22fb 100644 --- a/packages/rpc/README.md +++ b/packages/rpc/README.md @@ -14,4 +14,110 @@ # @solana/rpc -TODO +This package contains utilities for creating objects that you can use to communicate with a Solana JSON RPC server. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@experimental`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library). + +Unless you plan to create a custom RPC interface, you can use the [`createSolanaRpc(clusterUrl)`](#createsolanarpcclusterurl-config) function to obtain a default implementation of the [Solana JSON RPC API](https://solana.com/docs/rpc/http). + +## Types + +### `RpcTransport{Devnet|Testnet|Mainnet}` + +These types refine the base `RpcTransport` type. Each describes a transport that is specific in some way to a particular Solana cluster. + +For instance, a `RpcTransportDevnet` is understood to communicate with a RPC server related to devnet, and as such might only be accepted for use as the transport of a `RpcDevnet`. + +This is useful in cases where you need to make assertions about what capabilities a RPC offers. For example, RPC methods like `requestAirdrop` are not available on mainnet. You can use the ability to assert on the type of RPC transport at compile time to prevent calling unimplemented methods or presuming the existence of unavailable capabilities. + +### `RpcTransportFromClusterUrl` + +Given a `ClusterUrl`, this utility type will resolve to as specific a `RpcTransport` as possible. + +```ts +function createCustomTransport( + clusterUrl: TClusterUrl, +): RpcTransportFromClusterUrl { + /* ... */ +} +const transport = createCustomTransport(testnet('http://api.testnet.solana.com')); +transport satisfies RpcTransportTestnet; // OK +``` + +### `Rpc{Devnet|Testnet|Mainnet}` + +These types refine the base `Rpc` type. Each describes a RPC that is specific in some way to a particular Solana cluster and a corpus of RPC methods. + +This is useful in cases where you need to make assertions about the suitablilty of a RPC for a given purpose. For example, you might like to make it a type error to combine certain types with RPC belonging to certain clusters, at compile time. + +```ts +async function getSpecialAccountInfo( + address: Address<'ReAL1111111111111111111111111111'>, + rpc: RpcMainnet, +): Promise; +async function getSpecialAccountInfo( + address: Address<'TeST1111111111111111111111111111'>, + rpc: RpcDevnet | RpcTestnet, +): Promise; +async function getSpecialAccountInfo(address: Address, rpc: Rpc): Promise { + /* ... */ +} +const rpc = createSolanaRpc(devnet('https://api.devnet.solana.com')); +await getSpecialAccountInfo(address('ReAL1111111111111111111111111111'), rpc); // ERROR +``` + +### `RpcFromTransport` + +Given a `RpcTransport`, this utility type will resolve to as specific a `Rpc` as possible. + +```ts +function createCustomRpc( + transport: TRpcTransport, +): RpcFromTransport { + /* ... */ +} +const transport = createDefaultRpcTransport({ url: mainnet('http://rpc.company') }); +transport satisfies RpcTransportMainnet; // OK +const rpc = createCustomRpc(transport); +rpc satisfies RpcMainnet; // OK +``` + +### SolanaRpcApiFromTransport + +## Constants + +### `DEFAULT_RPC_CONFIG` + +When you create `Rpc` instances with custom transports but otherwise the default RPC API behaviours, use this. + +```ts +const myCustomRpc = createRpc({ + api: createSolanaRpcApi(DEFAULT_RPC_CONFIG), + transport: myCustomTransport, +}); +``` + +## Functions + +### `createDefaultRpcTransport(config)` + +Creates a `RpcTransport` with some default behaviours. + +The default behaviours include: + +- An automatically-set `Solana-Client` request header, containing the version of `@solana/web3.js` +- Logic that coalesces multiple calls in the same runloop, for the same methods with the same arguments, into a single network request. + +#### Arguments + +A config object with the following properties: + +- `dispatcher_NODE_ONLY`: An optional `Undici.Dispatcher` instance that governs how the networking stack should behave. This option is only relevant in Node applications. Consult the documentation for the various subclasses of `Undici.Dispatcher`, such as `Agent`, `Client`, and `Pool`, at https://undici.nodejs.org/#/docs/api/Client. +- `headers`: An optional object where the keys are HTTP header names and the values are HTTP header values. This parameter is typed to disallow certain headers from being overwritten. +- `url`: A `ClusterUrl` at which the RPC server can be contacted. + +### `createSolanaRpc(clusterUrl, config)` + +Creates a `Rpc` instance that exposes the Solana JSON RPC API given a cluster URL and some optional transport config. See `createDefaultRpcTransport` for the shape of the transport config. + +### `createSolanaRpcFromTransport(transport)` + +Creates a `Rpc` instance that exposes the Solana JSON RPC API given the supplied `RpcTransport`. diff --git a/packages/rpc/src/rpc-clusters.ts b/packages/rpc/src/rpc-clusters.ts index b4beea4bdbf..348317a6501 100644 --- a/packages/rpc/src/rpc-clusters.ts +++ b/packages/rpc/src/rpc-clusters.ts @@ -5,7 +5,6 @@ import type { ClusterUrl, DevnetUrl, MainnetUrl, TestnetUrl } from '@solana/rpc- export type RpcTransportDevnet = RpcTransport & { '~cluster': 'devnet' }; export type RpcTransportTestnet = RpcTransport & { '~cluster': 'testnet' }; export type RpcTransportMainnet = RpcTransport & { '~cluster': 'mainnet' }; -export type RpcTransportWithCluster = RpcTransportDevnet | RpcTransportMainnet | RpcTransportTestnet; export type RpcTransportFromClusterUrl = TClusterUrl extends DevnetUrl ? RpcTransportDevnet : TClusterUrl extends TestnetUrl diff --git a/packages/rpc/src/rpc-transport.ts b/packages/rpc/src/rpc-transport.ts index adcb7b3d9a3..40b1f25166f 100644 --- a/packages/rpc/src/rpc-transport.ts +++ b/packages/rpc/src/rpc-transport.ts @@ -7,7 +7,7 @@ import { getRpcTransportWithRequestCoalescing } from './rpc-request-coalescer'; import { getSolanaRpcPayloadDeduplicationKey } from './rpc-request-deduplication'; type RpcTransportConfig = Parameters[0]; -export interface DefaultRpcTransportConfig extends RpcTransportConfig { +interface DefaultRpcTransportConfig extends RpcTransportConfig { url: TClusterUrl; } diff --git a/packages/rpc/src/rpc.ts b/packages/rpc/src/rpc.ts index 9b47483215c..97e2fbb7e2b 100644 --- a/packages/rpc/src/rpc.ts +++ b/packages/rpc/src/rpc.ts @@ -4,7 +4,11 @@ import { ClusterUrl } from '@solana/rpc-types'; import type { RpcFromTransport, SolanaRpcApiFromTransport } from './rpc-clusters'; import { DEFAULT_RPC_CONFIG } from './rpc-default-config'; -import { createDefaultRpcTransport, DefaultRpcTransportConfig } from './rpc-transport'; +import { createDefaultRpcTransport } from './rpc-transport'; + +type DefaultRpcTransportConfig = Parameters< + typeof createDefaultRpcTransport +>[0]; /** Creates a new Solana RPC using the default decorated HTTP transport. */ export function createSolanaRpc(