Skip to content

Allow RpcRequest params to be of any type, instead of requiring an array #2751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2024
Merged

Allow RpcRequest params to be of any type, instead of requiring an array #2751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/unlucky-pumpkins-itch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@solana/rpc-spec": patch
---

Allow Rpc Request params to be any type, instead of requiring an array
2 changes: 1 addition & 1 deletion packages/rpc-spec/src/rpc-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Callable } from '@solana/rpc-spec-types';
import { RpcRequest } from './rpc-request';

export type RpcApiConfig = Readonly<{
parametersTransformer?: <T extends unknown[]>(params: T, methodName: string) => unknown[];
parametersTransformer?: <T extends unknown[]>(params: T, methodName: string) => unknown;
Copy link
Contributor

@buffalojoec buffalojoec May 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still want the array enforced for input here?

Copy link
Contributor Author

@mcintyre94 mcintyre94 May 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so, because the developer doesn't control that - it's just the input params to their function. From a JS perspective that'll always be a list, I think.

responseTransformer?: <T>(response: unknown, methodName: string) => T;
}>;

Expand Down
2 changes: 1 addition & 1 deletion packages/rpc-spec/src/rpc-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export type RpcRequest<TResponse> = {
methodName: string;
params: unknown[];
params: unknown;
responseTransformer?: (response: unknown, methodName: string) => TResponse;
};

Expand Down