Skip to content
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

Revise api.derive.balances.all to include ED when necessary #5957

Merged
merged 1 commit into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/api-derive/src/balances/all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,16 @@ function calcShared (api: DeriveApi, bestNumber: BlockNumber, data: DeriveBalanc

if (data.frameSystemAccountInfo?.frozen) {
const { frameSystemAccountInfo, freeBalance, reservedBalance } = data;
const noFrozenReserved = frameSystemAccountInfo.frozen.isZero() && reservedBalance.isZero();
const ED = api.consts.balances.existentialDeposit;
const maybeED = noFrozenReserved ? new BN(0) : ED;
const frozenReserveDif = frameSystemAccountInfo.frozen.sub(reservedBalance);

transferable = api.registry.createType(
'Balance',
allLocked
? 0
: freeBalance.sub(bnMax(new BN(0), frameSystemAccountInfo.frozen.sub(reservedBalance)))
: freeBalance.sub(bnMax(maybeED, frozenReserveDif))
);
}

Expand Down
3 changes: 2 additions & 1 deletion packages/api-derive/src/balances/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ export interface DeriveBalancesAllAccountData extends DeriveBalancesAccountData
*/
lockedBreakdown: (PalletBalancesBalanceLock | BalanceLockTo212)[];
/**
* Calculated transferable balance. This uses the formula: free - max(0, frozen - reserve)
* Calculated transferable balance. This uses the formula: free - max(maybeEd, frozen - reserve)
* Where `maybeEd` means if there is no frozen and reserves it will be zero, else it will be the existential deposit.
* This is only correct when the return type of `api.query.system.account` is `FrameSystemAccountInfo`.
* Which is the most up to date calulcation for transferrable balances.
*
Expand Down