getProgramAccounts field withContext is not exposed

[kulych]

Motivation

It seems that a field withContext available in getProgramAccounts http method is not exposed via solana-web3.js.

Example use case

I am working on a synchronization mechanism between http request and websocket data.
The synchronization mechanism will use slot as a revision field, will first connect to websocket, save all updates and simultaneously send a request. The request response should also return slot so that only newer updates from websocket are then applied.

Details

According to getProgramAccounts documentation, there is a withContext field available which will make the response contain context.
Such field is however not exposed by solana-web3js.

Similarly to the pair

• getMultipleAccountsInfo
• getMultipleAccountsInfoAndContext

I would expect the same for getProgramAccounts and (does not exist) getProgramAccountsAndContext.
Or adding the withContext boolean to the function signature. As the result type depends on this value a separate function is imo better.

[steveluscher]

As the result type depends on this value a separate function is imo better.

Separate functions are one of the most regrettable things about this library. With Typescript, you can modulate the return type of a function depending on its inputs. Take a look how we're doing this in the new web3.js library.

solana-web3.js/packages/rpc-core/src/rpc-methods/getAccountInfo.ts

Lines 77 to 116 in 21cfcdd

	export interface GetAccountInfoApi {
	/**
	* Returns all information associated with the account of provided public key
	*/
	getAccountInfo(
	address: Base58EncodedAddress,
	config: GetAccountInfoApiCommonConfig &
	GetAccountInfoApiSliceableCommonConfig &
	Readonly<{
	encoding: 'base64';
	}>
	): GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithBase64EncodedData;
	getAccountInfo(
	address: Base58EncodedAddress,
	config: GetAccountInfoApiCommonConfig &
	GetAccountInfoApiSliceableCommonConfig &
	Readonly<{
	encoding: 'base64+zstd';
	}>
	): GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithBase64EncodedZStdCompressedData;
	getAccountInfo(
	address: Base58EncodedAddress,
	config: GetAccountInfoApiCommonConfig &
	Readonly<{
	encoding: 'jsonParsed';
	}>
	): GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithJsonData;
	getAccountInfo(
	address: Base58EncodedAddress,
	config: GetAccountInfoApiCommonConfig &
	GetAccountInfoApiSliceableCommonConfig &
	Readonly<{
	encoding: 'base58';
	}>
	): GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithBase58EncodedData_DEPRECATED;
	getAccountInfo(
	address: Base58EncodedAddress,
	config?: GetAccountInfoApiCommonConfig
	): GetAccountInfoApiResponseBase & GetAccountInfoApiResponseWithDefaultData;
	}

[github-actions]

🎉 This issue has been resolved in version 1.77.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 issue for 7 days since it was closed, it has been automatically locked. Please open a new issue if it requires a follow up.