Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@solana/rpc-spec
Advanced tools
A generic implementation of JSON RPCs using proxies
This package contains types that describe the implementation of the JSON RPC API, as well as methods to create one. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK @solana/web3.js@rc
.
This API is designed to be used as follows:
const rpc =
// Step 1 - Create an `Rpc` instance. This may be stateful.
createSolanaRpc(mainnet('https://api.mainnet-beta.solana.com'));
const response = await rpc
// Step 2 - Call supported methods on it to produce `PendingRpcRequest` objects.
.getLatestBlockhash({ commitment: 'confirmed' })
// Step 3 - Call the `send()` method on those pending requests to trigger them.
.send({ abortSignal: AbortSignal.timeout(10_000) });
PendingRpcRequest<TResponse>
Pending requests are the result of calling a supported method on on Rpc
object. They encapsulate all of the information necessary to make the request without actually making it.
Calling the send(options)
method on a PendingRpcRequest
will trigger the request and return a promise for TResponse
.
Rpc<TRpcMethods, TRpcTransport>
An object that exposes all of the functions described by TRpcMethods
, and fulfils them using TRpcTransport
. Calling each method returns a PendingRpcRequest<TResponse>
where TResponse
is that method's response type.
RpcApi<TRpcMethods>
For each of TRpcMethods
this object exposes a method with the same name that maps between its input arguments and a RpcRequest<TResponse>
that describes how to prepare a JSON RPC request to fetch TResponse
.
RpcApiMethods
This is a marker interface that all RPC method definitions must extend to be accepted for use with the RpcApi
creator.
RpcRequest
This type describes how a particular request should be issued to the JSON RPC server. Given a function that was called on a Rpc
, this object gives you the opportunity to:
TResponse
specified by the PendingRpcRequest<TResponse>
returned from that function.RpcSendOptions
A configuration object consisting of the following properties:
abortSignal
: An optional signal that you can supply when triggering a PendingRpcRequest
that you might later need to abort.RpcTransport
Any function that implements this interface can act as a transport for an Rpc
. It need only return a promise for a response given the following config:
payload
: A value of arbitrary type to be sent.signal
: An optional AbortSignal
on which the 'abort'
event will be fired if the request should be cancelled.createRpc(config)
Creates an RPC instance given an RpcApi<TRpcMethods>
and a RpcTransport
capable of fulfilling them.
A config object with the following properties:
api
: An instance of RpcApi
transport
: A function that implements the RpcTransport
interfacecreateRpcApi(config)
Creates a JavaScript proxy that converts any function call called on it to a RpcRequest
by:
methodName
to the name of the function calledparams
to the arguments supplied to that function, optionally transformed by config.parametersTransformer
responseTransformer
to config.responseTransformer
or the identity function if no such config exists// For example, given this `RpcApi`:
const rpcApi = createRpcApi({
paramsTransformer: (...rawParams) => rawParams.reverse(),
responseTransformer: response => response.result,
});
// ...the following function call:
rpcApi.foo('bar', { baz: 'bat' });
// ...will produce the following `RpcRequest` object:
//
// {
// methodName: 'foo',
// params: [{ baz: 'bat' }, 'bar'],
// responseTransformer: (response) => response.result,
// }
A config object with the following properties:
parametersTransformer<T>(params: T, methodName): unknown
: An optional function that maps between the shape of the arguments an RPC method was called with and the shape of the params expected by the JSON RPC server.responseTransformer<T>(response, methodName): T
: An optional function that maps between the shape of the JSON RPC server response for a given method and the shape of the response expected by the RpcApi
.FAQs
A generic implementation of JSON RPCs using proxies
The npm package @solana/rpc-spec receives a total of 5,780 weekly downloads. As such, @solana/rpc-spec popularity was classified as popular.
We found that @solana/rpc-spec demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.