constructor(pool: address)
Stores the address of a subscriptionPool/pool contract (likely the only authorized controller for sensitive ops).
Function-by-function (EN)
adjustBalance(account, newBalance) (nonpayable)
Manually sets account’s token balance to newBalance. Typically restricted to the pool/authorized caller; reverts with UnauthorizedCaller if not.
allowance(owner, spender) → uint256 (view)
Standard ERC-20: current approved amount spender can spend from owner.
approve(spender, value) → bool (nonpayable)
Standard ERC-20 approval. This token may block approvals in some modes and revert with ApproveNotAllowed or with ERC-20 errors on invalid addresses.
balanceOf(account) → uint256 (view)
Standard ERC-20 balance query.
decimals() → uint8 (view)
Token decimals.
getScaledUserBalanceAndSupply(user) → (uint256 userScaled, uint256 totalScaled) (view)
Returns a scaled balance for user and the scaled total supply. Scaled values are usually before applying an index/accumulator (e.g., interest index).
name() → string (view)
Token name.
scaledTotalSupply() → uint256 (view)
Total supply in scaled units (pre-index).
subscriptionPool() → address (view)
Address of the associated pool/controller.
symbol() → string (view)
Token symbol.
totalSupply() → uint256 (view)
Current total token supply (actual units).
transfer(to, value) → bool (nonpayable)
Standard ERC-20 transfer. May be restricted and revert with TransferNotAllowed (e.g., if token is non-transferable/soulbound in some contexts).
transferFrom(from, to, value) → bool (nonpayable)
Standard ERC-20 delegated transfer. Enforces allowance and may also hit TransferNotAllowed.
Events
Approval(owner, spender, value) — Emitted on successful approve.
Transfer(from, to, value) — Emitted on balance movements (transfer, transferFrom, or internal balance changes if implemented that way).
Custom errors (behavioral hints)
ApproveNotAllowed — Approvals disabled under current policy.
TransferNotAllowed — Transfers disabled (token may be non-transferable except for privileged flows).
UnauthorizedCaller — Caller lacks permission (e.g., for adjustBalance).
ERC20InsufficientAllowance / ERC20InsufficientBalance — Standard ERC-20 safety checks.
ERC20Invalid{Sender,Receiver,Approver,Spender} — Zero/invalid address or policy-violating address arguments.
