Skip to main content
Version: 1.16.1

Type Alias: TokenUIMultiplier

TokenUIMultiplier = { next?: { effectiveAt: number; uiMultiplier: bigint; }; uiMultiplier: bigint; }

Defined in: chain.ts:482

An ERC-8056 token's UI multiplier, with 18 decimals (10n ** 18n is 1x): the UI amount is raw * uiMultiplier / 1e18.

Properties​

next?​

readonly optional next?: { effectiveAt: number; uiMultiplier: bigint; }

Defined in: chain.ts:490

A scheduled change that has not taken effect yet. After effectiveAt, uiMultiplier is the new value: read the token info again then. Best-effort: absent when the token does not implement ERC-8056's pending-multiplier extension, or when the scheduled value is invalid.

effectiveAt​

readonly effectiveAt: number

When it takes effect, in unix seconds.

uiMultiplier​

readonly uiMultiplier: bigint

The scheduled multiplier.


uiMultiplier​

readonly uiMultiplier: bigint

Defined in: chain.ts:484

The multiplier in effect now.