refactor(experimental): Add getBlockProduction API

[mcintyre94]

Summary

• Add the getBlockProduction API + unit tests
• Add jest-extended which provides some extra jest matchers

Test Plan

pnpm turbo test:unit:node test:unit:browser

Misc notes:

• The number matchers in jest-extended don't support BigInt yet (BigInt support for Number functions jest-community/jest-extended#591). Didn't affect my final tests here but worth being aware of
• I'm not sure exactly where the 32602 error code comes from on the lastSlot too high test. Grepping the solana codebase doesn't show the error I'm seeing and the code isn't in https://github.com/solana-labs/solana/blob/master/rpc-client-api/src/custom_error.rs. The promise rejects with Rejected to value: [SolanaJsonRpcError: JSON-RPC 2.0 error (-32602): lastSlot, 9223372036854776000, is too large; max 0]

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

---

👍 No dependency changes detected in pull request

Pull request alert summary

Issue	Status
Install scripts	✅ 0 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

[steveluscher]

[steveluscher]

That error code is actually a JSON-RPC reserved one that means ‘invalid params.’ https://www.jsonrpc.org/specification#error_object

[steveluscher]

The reason that this doesn't work is actually because the validator hasn't advanced to that slot yet. Apparently we code this as ‘invalid params (32602).’

Kind of sounds like we need an actual error code for this in the RPC, similar to JSON_RPC_SERVER_ERROR_MIN_CONTEXT_SLOT_NOT_REACHED.

[mcintyre94]

I've renamed the 32602 error to JSON_RPC_INVALID_PARAMS for now, since that best matches the current behaviour. Would a github issue on the solana monorepo be the best place to track adding a custom error code?

[steveluscher]

Yes! Totally. That RPC method could do with throwing a more precise error.

[steveluscher]

Dang it, the goal with that return type for the identity case was to make this a type error:

const bp = await rpc
    .getBlockProduction({
        commitment,
        identity: 'abc' as Base58EncodedAddress,
    })
    .send();
bp.value.byIdentity['def' as Base58EncodedAddress]; // SHOULD BE A TYPE ERROR

…but that's not happening yet. Essentially the string type is flowing through that type, rather than the string literal.

Think this is possible to type correctly?

[mcintyre94]

I think this should work with:

    getBlockProduction<TIdentity extends Base58EncodedAddress>(
        config: Readonly<{
            commitment?: Commitment;
            identity: TIdentity;
            range?: SlotRange;
        }>
    ): GetBlockProductionApiResponseBase & GetBlockProductionApiResponseWithSingleIdentity<TIdentity>;

See example playground

My local environment has gone screwy so I need to fix that and test this a bit more locally, but I think this should be right!

[steveluscher]

This has type errors now when you just supply commitment (see the tests file for the error) and still doesn't constrain the type of byIdentity to having only the one key. If that second thing isn't possible with Typescript, then that's cool ¯_(°ペ)_/¯

[mcintyre94]

Ah, thanks, fixed those up! On the second thing, it definitely should work, but also.. isn't. I don't know if some layer of indirection is throwing it here

A more realistic playground using basically the same types here does work!

I think it's probably worth parking for now, but it would be really nice to have that type safety!

[github-actions]

🎉 This PR is included in version 1.76.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[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.