Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@solana/rpc

Package Overview
Dependencies
Maintainers
14
Versions
891
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@solana/rpc

A library for sending JSON RPC requests to Solana RPCs

  • 2.0.0
  • next
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
21K
increased by69.61%
Maintainers
14
Weekly downloads
 
Created
Source

npm npm-downloads
code-style-prettier

@solana/rpc

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@rc.

Unless you plan to create a custom RPC interface, you can use the createSolanaRpc(clusterUrl) function to obtain a default implementation of the Solana JSON RPC API.

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<TClusterUrl extends ClusterUrl>

Given a ClusterUrl, this utility type will resolve to as specific a RpcTransport as possible.

function createCustomTransport<TClusterUrl extends ClusterUrl>(
    clusterUrl: TClusterUrl,
): RpcTransportFromClusterUrl<TClusterUrl> {
    /* ... */
}
const transport = createCustomTransport(testnet('http://api.testnet.solana.com'));
transport satisfies RpcTransportTestnet; // OK

Rpc{Devnet|Testnet|Mainnet}<TRpcMethods>

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 suitability 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.

async function getSpecialAccountInfo(
    address: Address<'ReAL1111111111111111111111111111'>,
    rpc: RpcMainnet,
): Promise<SpecialAccountInfo>;
async function getSpecialAccountInfo(
    address: Address<'TeST1111111111111111111111111111'>,
    rpc: RpcDevnet | RpcTestnet,
): Promise<SpecialAccountInfo>;
async function getSpecialAccountInfo(address: Address, rpc: Rpc): Promise<SpecialAccountInfo> {
    /* ... */
}
const rpc = createSolanaRpc(devnet('https://api.devnet.solana.com'));
await getSpecialAccountInfo(address('ReAL1111111111111111111111111111'), rpc); // ERROR

RpcFromTransport<TRpcMethods, TRpcTransport extends RpcTransport>

Given a RpcTransport, this utility type will resolve to as specific a Rpc as possible.

function createCustomRpc<TRpcTransport extends RpcTransport>(
    transport: TRpcTransport,
): RpcFromTransport<MyCustomRpcMethods, TRpcTransport> {
    /* ... */
}
const transport = createDefaultRpcTransport({ url: mainnet('http://rpc.company') });
transport satisfies RpcTransportMainnet; // OK
const rpc = createCustomRpc(transport);
rpc satisfies RpcMainnet<MyCustomRpcMethods>; // OK

SolanaRpcApiFromTransport

Constants

DEFAULT_RPC_CONFIG

When you create Rpc instances with custom transports but otherwise the default RPC API behaviours, use this.

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.

Keywords

FAQs

Package last updated on 07 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc