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

polkadot-js · Aug 19, 2024 · 92dfe00 · 92dfe00
1 parent f82c572
commit 92dfe00
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/packages/api-derive/src/balances/all.ts b/packages/api-derive/src/balances/all.ts
@@ -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))
     );
   }
 

diff --git a/packages/api-derive/src/balances/types.ts b/packages/api-derive/src/balances/types.ts
@@ -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.
    *