IB20Asset.toUIAmount

Converts a raw ERC-20 balance to its UI representation using the effective multiplier.

Signature

IB20Asset.sol

function toUIAmount(uint256 rawAmount) external view returns (uint256);

Field	Value
Selector	0x3248d4ff
Canonical signature	toUIAmount(uint256)

Description

Converts rawAmount to its UI representation at the effective multiplier. The formula is rawAmount * uiMultiplier() / WAD_PRECISION, where WAD_PRECISION is 1e18. 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 the multiplier differs from WAD_PRECISION.

The effective multiplier is time-dependent. If a pending update has been scheduled via updateUIMultiplier and block.timestamp >= effectiveAt, the new multiplier is used even though no event fires at that moment. Call uiMultiplier() to inspect the value this function applies.

toScaledBalance is a deprecated alias of this function. Prefer toUIAmount.

• This function is Asset-only. Stablecoin has no multiplier.
• A multiplier of 1e18 means UI equals raw.
• A 2-for-1 split sets the multiplier to 2e18; a 1-for-2 reverse split sets it to 5e17.
• The multiplier is an absolute value, not a ratio applied to the current one.

Parameters

Name	Type	Description
rawAmount	uint256	Raw ERC-20 balance to convert.

Returns

Type	Description
uint256	UI amount: rawAmount * uiMultiplier() / 1e18, rounded down.