IB20Asset.toScaledBalance

Converts a raw token balance to its UI-scaled view using the current multiplier.

toScaledBalance is a deprecated alias of toUIAmount. Prefer toUIAmount(raw) for new integrations.

Signature

IB20Asset.sol

function toScaledBalance(uint256 rawBalance) external view returns (uint256);

Field	Value
Selector	0x04f04c99
Canonical signature	toScaledBalance(uint256)

Description

Converts a raw balance to its UI (scaled) view: rawBalance * uiMultiplier() / WAD_PRECISION.

This is a deprecated alias of toUIAmount. The two functions are equivalent. Use toUIAmount in new code.

The result is the amount that wallets and indexers display as a share count after a stock split. Raw ERC-20 balances, transfer amounts, totalSupply, and allowances are unaffected by the multiplier and remain raw.

Integer division rounds down. Rounding loss is confined to the scaled view and is at most one unit of the scaled amount; a round trip back through fromUIAmount may return slightly less than the original raw amount when uiMultiplier() != WAD_PRECISION.

Multipliers are Asset-only. Stablecoin has no multiplier.

Parameters

Name	Type	Description
rawBalance	uint256	Raw token amount to convert.

Returns

Type	Description
uint256	UI balance at the effective multiplier: rawBalance * uiMultiplier() / WAD_PRECISION.

Access Control

Read-only. No role required.

Policy Interaction

No direct policy interaction.

Example

Usage Example

// Deprecated alias; prefer toUIAmount
uint256 ui = IB20Asset(target).toScaledBalance(rawBalance);

// Preferred equivalent
uint256 ui = IB20Asset(target).toUIAmount(rawBalance);