createSolanaRpcSubscriptions

function createSolanaRpcSubscriptions<TClusterUrl>(
    clusterUrl,
    config?,
): RpcSubscriptionsFromTransport<
    SolanaRpcSubscriptionsApi,
    RpcSubscriptionsTransportFromClusterUrl<TClusterUrl>
>;

Creates a RpcSubscriptions instance that exposes the Solana JSON RPC WebSocket API given a cluster URL and some optional channel config. See createDefaultRpcSubscriptionsChannelCreator for the shape of the channel config.

Type Parameters

Type Parameter
TClusterUrl extends ClusterUrl

Parameters

ParameterType
clusterUrlTClusterUrl
config?Omit<Readonly<{ intervalMs?: number; maxSubscriptionsPerChannel?: number; minChannels?: number; sendBufferHighWatermark?: number; url: TClusterUrl; }>, "url">

Returns

RpcSubscriptionsFromTransport<SolanaRpcSubscriptionsApi, RpcSubscriptionsTransportFromClusterUrl<TClusterUrl>>

On this page