feat: add includeClaimedRewards query param in staking-info
#1593
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the
includeClaimedRewardsquery param in the endpoint/accounts/{accountId}/staking-info. When set tofalse:claimedRewardswill be omitted from the response andAccountsStakingInfoServicewill be skipped, potentially speeding up the response time.Defaults to
trueso it does not break the current functionality of the endpoint.Motivation
An exchange reported significantly long response times for the endpoint
/accounts/{accountId}/staking-infoafter the release of v20.0.0. This is most likely due to the breaking changes introduced to this endpoint (calculation ofclaimedRewardschanged). To address this, a new flag/query parameter has been added to improve performance when theclaimedRewardsdata is not required, speeding up the response time.