Clean up SolanaRpcApi: no longer extend RpcApiMethods

[mcintyre94]

Extending RpcApiMethods removes the ability to access typed keys on SolanaRpcApi etc, because it's typed as [method: string]: RpcApiMethod.

In this PR we change from:

interface GetAssetApi extends RpcApiMethods {

To:

type GetAssetApi = {

(Thanks @lorisleiva!)

This allows createRpcApi to maintain its typing, meaning that it still constrains any API methods we attempt to build an RPC for. But we now have typesafe keyof SolanaRpcApi etc.

I've also removed the export of RpcApiMethods, since this should now be used only as a constraint internally and not a type externally.

I've added a typetest with a bit more detail, but this basically makes this work:

'getAccountInfo' satisfies keyof SolanaRpcApi;
// @ts-expect-error RPC API does not have this method
'someMadeUpMethod' satisfies keyof SolanaRpcApi;

Previously someMadeUpMethod would satisfy it, because keyof SolanaRpcApi was just string.

[changeset-bot]

🦋 Changeset detected

Latest commit: 728d517

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

[mcintyre94]

@buffalojoec I'm not sure why this throws an error with this change, but it seems very test-specific so I'm not too worried about it. LMK if this is pointing at a problem I've overlooked though!

[lorisleiva]

Much better 👌

[mcintyre94]

• Allow extending numeric keypaths when extending Solana RPC API #3212
• Clean up SolanaRpcSubscriptionsApi: no longer extend RpcApiSubscriptionsMethods  #3218
• Clean up SolanaRpcApi: no longer extend RpcApiMethods #3213 👈
• master

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

Join @mcintyre94 and the rest of your teammates on Graphite

[buffalojoec]

Looks great! I dug up the original reason why I added this.

The change to the API methods went in here, and it was really only to tee up this change which added the createJsonRpcApi generic helper.

It seems like somewhere along the way the helper was updated and it will no longer throw a type error, cool! Seems like it might be the change from this:

const params = config?.parametersTransformer
    ? config?.parametersTransformer(rawParams, methodName)
    : rawParams;
const responseTransformer = config?.responseTransformer
    ? config?.responseTransformer<ReturnType<TRpcMethods[TMethodName]>>
    : (rawResponse: unknown) => rawResponse as ReturnType<TRpcMethods[TMethodName]>;
return {
    methodName,
    params,
    responseTransformer,
};

... to this:

const rawRequest = { methodName, params: rawParams };
const request = config?.requestTransformer
    ? config?.requestTransformer(Object.freeze(rawRequest))
    : rawRequest;
return Object.freeze({
    ...request,
    ...(config?.responseTransformer
        ? {
                responseTransformer: config.responseTransformer as RpcResponseTransformer<
                    ReturnType<TRpcMethods[TMethodName]>
                >,
            }
        : {}),
});

Note: This is mirrored in rpc-subscriptions-api, so that API should also get the same treatment.

[mcintyre94]

Note: This is mirrored in rpc-subscriptions-api, so that API should also get the same treatment.

Thanks! Added a new PR to the stack: #3218

[steveluscher]

How's autocomplete speed with this; same same?

[mcintyre94]

Yep, still seems ~instant for me!

[mcintyre94]

Merge activity

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