Reserve Manager Getter Methods
These view-only functions expose the internal state of the reserve manager. They do not modify state and are safe to call off-chain. Use them to inspect pool configuration, metrics, asset parameters, and protocol status.
getMintFeeQ96
function getMintFeeQ96() external view returns (uint256);Returns:
uint256: Mint fee rate as a 160.96 fixed-point number.
Description:
Returns the current fee rate applied when minting index tokens.
getCompoundingMintFeeQ96
function getCompoundingMintFeeQ96() external view returns (uint256);Returns:
uint256: Effective compounding mint fee in 160.96 fixed-point format.
Description:
Returns the effective mint fee when minting n tokens, including recursive fees on the minted fee itself.
getBurnFeeQ96
function getBurnFeeQ96() external view returns (uint256);Returns:
uint256: Burn fee rate as a 160.96 fixed-point number.
Description:
Returns the current fee rate applied when burning index tokens.
getIsMintEnabled
function getIsMintEnabled() external view returns (bool);Returns:
bool: True if minting is enabled, false otherwise.
Description:
Indicates if minting of index tokens is currently permitted.
getSurplus
function getSurplus() external view returns (int256);Returns:
int256: Surplus value of reserves minus index token supply and bounty.
Description:
The surplus is defined as:
totalReservesScaled - indexToken.totalSupply - equalizationBounty.
getIndexToken
function getIndexToken() external view returns (address);Returns:
address: The address of the reserve manager’s index token.
Description:
Returns the ERC20 contract address of the index token.
getAllAssets
function getAllAssets() external view returns (address[] memory);Returns:
address[]: Array of all active collateral assets.
Description:
Returns all underlying assets currently held as collateral.
getCurrentAssetParams
function getCurrentAssetParams() external view returns (AssetParams[] memory);Returns:
AssetParams[]: Parameters for assets actively backing index tokens.
Description:
Returns the current parameters for all assets in the reserve manager.
getTargetAssetParams
function getTargetAssetParams() external view returns (AssetParams[] memory);Returns:
AssetParams[]: Target allocation and configuration of pool assets.
Description:
Returns the target asset parameters the manager aims to reach.
getAssetParams
function getAssetParams(address asset) external view returns (AssetParams memory);Parameters:
address asset: Address of the asset to query.
Returns:
AssetParams: Configuration of the specified asset.
Description:
Returns the detailed parameters of a single asset.
getSpecificReservesScaled
function getSpecificReservesScaled(address asset) external view returns (uint256);Parameters:
address asset: Address of the asset.
Returns:
uint256: Scaled reserve amount (normalized to index token decimals).
Description:
Returns the normalized reserves of a specific asset.
getTotalReservesScaled
function getTotalReservesScaled() external view returns (uint256);Returns:
uint256: Scaled total reserves across all assets.
Description:
Returns the normalized total reserves in the pool.
getSpecificReserves
function getSpecificReserves(address asset) external view returns (uint256);Parameters:
address asset: Address of the asset.
Returns:
uint256: Actual (unscaled) reserve amount.
Description:
Returns the raw reserve amount of an asset without scaling.
getMaxReserves
function getMaxReserves() external view returns (uint256);Returns:
uint256: Maximum allowed scaled reserves.
Description:
Returns the current ceiling on total scaled reserves.
getMaxReservesIncreaseRateQ96
function getMaxReservesIncreaseRateQ96() external view returns (uint256);Returns:
uint256: Increase rate (96.96 fixed-point) applied tomaxReserves.
Description:
Represents the proportional rate at which maxReserves can grow during one cooldown cycle.
getMaxReservesIncreaseCooldown
function getMaxReservesIncreaseCooldown() external view returns (uint256);Returns:
uint256: Cooldown period in seconds.
Description:
Specifies how long must pass between increases in maxReserves.
getLastMaxReservesChangeTimestamp
function getLastMaxReservesChangeTimestamp() external view returns (uint256);Returns:
uint256: Timestamp of the lastmaxReservesincrease.
Description:
Returns when the reserve ceiling was last increased.
getEqualizationBounty
function getEqualizationBounty() external view returns (uint256);Returns:
uint256: Equalization bounty in index tokens.
Description:
The bounty rewarded to arbitrageurs who move reserves closer to equalization with target allocations.
getIsEqualized
function getIsEqualized() external view returns (bool);Returns:
bool: True if reserves match target allocations.
Description:
Indicates whether the pool’s reserves are equalized.
getEqualizationVectorScaled
function getEqualizationVectorScaled() external view returns (int256[] memory);Returns:
int256[]: Scaled reserve deltas required for equalization.
Description:
Each element corresponds to an asset in getCurrentAssetParams.
getTotalReservesDiscrepencyScaled
function getTotalReservesDiscrepencyScaled() external view returns (uint256);Returns:
uint256: Total discrepancy (scaled) between current and target reserves.
Description:
The sum of absolute equalization vector elements — i.e., the pool’s discrepancy.
getMigrationBurnConversionRateQ96
function getMigrationBurnConversionRateQ96() external view returns (uint256);Returns:
uint256: Conversion rate (Q96) for burning index tokens.
Description:
Specifies how many reserves are received per index token burned during migration.
isEmigrating
function isEmigrating() external view returns (bool);Returns:
bool: True if reserves are migrating to another manager.
Description:
Indicates whether the reserve manager is undergoing a soft migration.
getAllowUnsafeBurn
function getAllowUnsafeBurn() external view returns (bool);Returns:
bool: True if unsafe burns are allowed.
Description:
Indicates whether “unsafe” burning (where outgoing reserve transfers may fail) is permitted.
This mode is primarily for emergency recovery situations.