Rename RpcResponse to RpcResponseData

[lorisleiva]

The purpose of this PR stack is to refactor both the RPC and RPC Subscriptions packages such that they have better interfaces with their respective transports. In this first batch of PRs, we will start by focusing on the RPC packages whilst ensuring minimum changes on the RPC Subscriptions packages.

The end goal of this first part is to have the following interfaces for the RPC packages:

RPC Shared Layer

type RpcRequest<TParams = unknown> = {
  readonly methodName: string;
  readonly params: TParams;
}

type RpcResponse<TResponse = unknown> = {
  readonly json: () => Promise<TResponse>;
  readonly text: () => Promise<string>;
}


type RpcRequestTransformer = {
    <TParams>(request: RpcRequest<unknown>): RpcRequest<TParams>;
};

type RpcResponseTransformer = {
    <TResponse>(response: RpcResponse<unknown>, request: RpcRequest<unknown>): RpcResponse<TResponse>;
};

type RpcResponseTransformerFor<TResponse> = {
    (response: RpcResponse<unknown>, request: RpcRequest<unknown>): RpcResponse<TResponse>;
};

RPC Transport Layer

type RpcTransportRequest = {
  readonly payload: unknown;
  readonly signal?: AbortSignal;
}


type RpcTransport = {
  <TResponse>(
    request: RpcTransportRequest
  ): Promise<RpcResponse<TResponse>>;
}

RPC API Layer

type RpcApi<TRpcMethods> = { ... }

type RpcApiConfig = {
  readonly requestTransformer?: RpcRequestTransformer;
  readonly responseTransformer?: RpcResponseTransformer;
}

type PendingRpcApiRequest<TResponse> = RpcRequest & {
    responseTransformer?: RpcResponseTransformerFor<TResponse>;
};

RPC Layer

type PendingRpcRequest<TResponse> = {
  // Nothing changes here but the final send function returns the result of `response.json()`.
  send(options?: RpcSendOptions): Promise<TResponse>;
};

---

In the first two PRs of the stack, we start by cleaning up the type namespace to allow these new types to exist. First, we rename RpcResponse to RpcResponseData, since RpcResponse will be used to define a proper response interface that aligns all the RPC layers.

[changeset-bot]

🦋 Changeset detected

Latest commit: f16d5af

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

[steveluscher]

[lorisleiva]

Merge activity

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