feat: Add transferable field to /accounts/{accountId}/balance-info#1722
Merged
Conversation
andrew-ifrita
approved these changes
Jul 30, 2025
TarikGul
commented
Jul 31, 2025
Member
Author
|
Merging, Controller Injection tests are failing again which is fine. |
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
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.
Add transferable balance field and documentation
This PR adds the
transferablefield to balance-info endpoints and provides documentation explaining its calculation.Changes
transferablefield to theIAccountBalanceInfointerface with detailed JSDoc documentationtransferablefield for both balance-info endpoints:/accounts/{accountId}/balance-info/rc/accounts/{address}/balance-infoTransferable Balance Formula
The transferable balance uses the formula:
free - max(maybeEd, frozen - reserve)Where:
maybeEdis the existential deposit if there are frozen funds or reserves, otherwise zeroNOTE: The polkadot-js implementation I am using here is a UI-friendly calculation that considers: