Rename RpcRequest to RpcApiRequestPlan

[lorisleiva]

In this PR, we continue cleaning up the type namespace by renaming RpcRequest to RpcApiRequestPlan. This is because:

• RpcRequest will be used to define a proper request interface that will unify the RPC layers.
• RpcApiRequestPlan better describes what the type actually does. If you call myRpcApi.myMethod({ foo: 42 }), then you will be given an object that contains everything you need to send it to a transport without actually sending it to a transport. This is the role of the Rpc type which wraps the RpcApi proxy and transforms this RpcApiRequestPlan into a PendingRpcRequest which contains the desired send function.

[changeset-bot]

🦋 Changeset detected

Latest commit: 769effe

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]

Nice. I think the relationship makes sense. Give me a pending RPC API request, and I'll turn it into a pending RPC request using the transport.

[steveluscher]

I'm a little bearish on the ‘pending’ moniker because that implies that it, alone, will resolve. I think of this object as more of ‘instructions for making a request’ or ‘a recipe for making a request.’ RpcRequestDescriptor? RpcRequestPlan? RpcRequestRecipe?

[lorisleiva]

@steveluscher I don't mind something like RpcApiRequestPlan. An alternative would be to actually return an object with a send function, much like the PendingRpcRequest, expect that this one would require a function that returns a response from a given request. What do you think?

EDIT: I went with RpcApiRequestPlan but let me know if you prefer the alternative.

[lorisleiva]

Merge activity

• Sep 1, 2:06 PM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Sep 1, 2:09 PM EDT: Graphite rebased this pull request as part of a merge.
• Sep 1, 2:10 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.