IB20Asset.scaledBalanceOf

Returns the UI (display) balance of an account by applying the current multiplier to its raw ERC-20 balance.

Signature

IB20Asset.sol

function scaledBalanceOf(address account) external view returns (uint256);

Field	Value
Selector	0x1da24f3e
Canonical signature	scaledBalanceOf(address)

Description

Equivalent to toUIAmount(balanceOf(account)). Returns the caller-visible share count after applying the current multiplier: balanceOf(account) * uiMultiplier() / WAD_PRECISION.

The raw ERC-20 balance is unchanged. Only the displayed value scales with the multiplier.

balanceOfUI(account) from the ERC-8056 Balances extension returns the same value; integrators should prefer the ERC-8056 name.

• While a pending multiplier update exists (effectiveAt() > block.timestamp), this function still uses the current multiplier, not the scheduled one.
• After block.timestamp >= effectiveAt(), the new multiplier takes effect automatically on read: no transaction or event fires at maturation.
• Integer division rounds down. Rounding loss is confined to the scaled view and is at most one unit of the scaled amount when uiMultiplier() != WAD_PRECISION.
• This function applies only to B20 Asset. B20 Stablecoin has no multiplier.

Parameters

Name	Type	Description
account	address	Account whose UI balance is being queried.

Returns

Type	Description
uint256	UI balance: balanceOf(account) * uiMultiplier() / WAD_PRECISION.

Access Control

Read-only. No role required.

Policy Interaction

No direct policy interaction.

Example

Usage Example

uint256 uiBalance = IB20Asset(target).scaledBalanceOf(account);
// Same value through the ERC-8056 name:
uint256 uiBalanceErc8056 = IB20Asset(target).balanceOfUI(account);