-
Notifications
You must be signed in to change notification settings - Fork 162
feat: add includeClaimable query param to vesting-info endpoints
#1860
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.
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
Conversation
This file contains hidden or 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
Contributor
|
@TarikGul Shouldn't the openapi docs be updated as well? |
Member
Author
Yup perfect timing, just pushed them up :) |
bee344
approved these changes
Dec 15, 2025
Contributor
bee344
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of unnecesary descriptions in the docs, other than that it looks solid.
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.
Adds optional vesting calculation fields to
/accounts/{accountId}/vesting-infoand/rc/accounts/{address}/vesting-infoendpoints.Usage
GET /accounts/{address}/vesting-info?includeClaimable=true
New response fields (when
includeClaimable=true)vested(per schedule) - Amount vested based on time elapsedvestedBalance- Total vested across all schedulesvestingTotal- Total locked across all schedulesvestedClaimable- Actual claimable amount (accounts for already claimed tokens)blockNumberForCalculation- Block number used for calculationblockNumberSource-'relay'or'self'Example response
{ "at": { "hash": "0x...", "height": "12345" }, "vesting": [ { "locked": "1000000000000", "perBlock": "1000000", "startingBlock": "1000", "vested": "500000000000" } ], "vestedBalance": "500000000000", "vestingTotal": "1000000000000", "vestedClaimable": "500000000000", "blockNumberForCalculation": "501000", "blockNumberSource": "relay" }Migration behavior
Vesting migrated from relay chains to Asset Hub. The calculation logic varies based on chain type and migration
state:
Vesting migrated from relay chains to Asset Hub. The calculation logic varies based on chain type and migration
state:
blockNumberSource: 'self')vestedClaimable: '0'(claims paused)vestedClaimable: '0'(vesting moved to Asset Hub)vestedClaimable: '0'(claims paused)blockNumberSource: 'relay'). RequiresSAS_SUBSTRATE_MULTI_CHAIN_URL.Note
This PR also abstracts the relay chain block search logic to make it more modular and reusable across different
services.