Add new RpcRequest, RpcResponse types and their transformer types

[lorisleiva]

Now that we've made room for these new types, we add the following:

• RpcRequest: The method name and the params are all we need to create a request. Combining them into a single object makes it easier to play with RPC requests. For instance, we can now have a RpcRequestTransformer instead of a RpcParamsTransformer.
• RpcResponse: This is the response abstraction that all the layers of the RPC packages will use moving forward. Instead of a simple unknown piece of data, the RpcResponse object contains two async methods:
  • json: Returns the parsed piece of data.
  • text: Returns the unparsed piece of data (as a string).
• RpcRequestTransformer and RpcResponseTransformer: Functions that take a request/response and return a new request/response respectively. Note that the response transformer also provides the associated request as a second argument.
• RpcResponseTransformerFor: Same as RpcResponseTransformer but we know exactly the type of the return data we expect.
• createJsonRpcResponseTransformer: This function is a helper that transforms a function of type (json: unknown) => T to a RpcResponseTransformerFor<T> by wrapping it in a json async function.

[changeset-bot]

🦋 Changeset detected

Latest commit: 9ab06b7

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[lorisleiva]

• Split RpcResponse into RpcResponse and RpcTransportResponse #3170
• Add toPayload and toText optional functions to RpcRequest #3168
• Add more response transformers #3163
• Combine RpcResponseTransformer and RpcResponseTransformerFor #3162
• Add more request transformers #3161
• Refactor fix for issue 479 as a transformer #3160
• Add getDefaultCommitmentRequestTransformer helper #3159
• Use RpcRequestTransformer type parameter on request argument #3158
• Update RPC APIs to use new types #3150
• Move types outside of rpc-request file #3149
• Update RPC transports to use new types #3148
• Add new RpcRequest, RpcResponse types and their transformer types #3147 👈
• Rename RpcRequest to RpcApiRequestPlan #3146
• Rename RpcResponse to RpcResponseData #3145
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @lorisleiva and the rest of your teammates on Graphite

[buffalojoec]

[steveluscher]

[steveluscher]

Should request be optional? I could imagine someone not caring about the input.

[lorisleiva]

It doesn't need to be used by the response transformer but the caller of a response transformer should always provide it, in case it may be needed. Which is way it's not optional in the signature.

[lorisleiva]

I've added documentation for the new types/functions.

[lorisleiva]

Merge activity

• Sep 1, 2:06 PM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Sep 1, 2:12 PM EDT: Graphite rebased this pull request as part of a merge.
• Sep 1, 2:13 PM EDT: @lorisleiva merged this pull request with Graphite.

[github-actions]

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.