Admin Methods

Reserve Manager Admin-Only Methods

These functions are reserved for the protocol administrator and are primarily used for tuning pool parameters, enforcing safety mechanisms, and managing fee flows. They are listed here for transparency.

`setMintFeeQ96`


function setMintFeeQ96(uint256 mintFeeQ96) external;

Parameters:

uint256 mintFeeQ96: The minting fee in 160.96 fixed-point format.

Description: Sets the fee applied when minting index tokens.

`setBurnFeeQ96`


function setBurnFeeQ96(uint256 burnFeeQ96) external;

Parameters:

uint256 burnFeeQ96: The burning fee in 160.96 fixed-point format.

Description: Sets the fee applied when burning index tokens.

`setMaxReserves`


function setMaxReserves(uint256 maxReserves) external;

Parameters:

uint256 maxReserves: Maximum allowed total reserves in the pool.

Description: Sets the cap on total asset reserves to limit risk.

`setMaxReservesIncreaseRateQ96`


function setMaxReservesIncreaseRateQ96(uint256 maxReservesIncreaseRateQ96) external;

Parameters:

uint256 maxReservesIncreaseRateQ96: Maximum rate (as a 160.96 fixed-point number) at which the reserve cap can be increased.

Description: Controls how quickly the reserve ceiling can grow in a single increase tick — as a proportion of the previous value of maxReserves.

`setMaxReservesIncreaseCooldown`


function setMaxReservesIncreaseCooldown(uint256 maxReservesIncreaseCooldown) external;

Parameters:

uint256 maxReservesIncreaseCooldown: Cooldown in seconds between reserve cap increase ticks.

Description: Enforces a minimum wait time between consecutive reserve cap increases.

`setTargetAssetParams`


function setTargetAssetParams(AssetParams[] calldata params) external;

Parameters:

AssetParams[] params: Target allocation and configuration values for each asset.

Description: Updates the configuration of individual assets, including target allocations and other parameters.

`setIsMintEnabled`


function setIsMintEnabled(bool isMintEnabled) external;

Parameters:

bool isMintEnabled: Flag to enable or disable minting.

Description: Allows the administrator to pause or resume minting operations.

`increaseEqualizationBounty`


function increaseEqualizationBounty(uint256 bountyIncrease) external;

Parameters:

uint256 bountyIncrease: The additional bounty amount to be added for triggering equalization.

Description: Increases the incentive paid to users who trigger pool equalization actions.

`startEmigration`


function startEmigration(
  address nextReserveManager
) external;

Parameters:

address nextReserveManager: Address of the new reserve manager being migrated to.

Description: This function is only callable by the reserve manager’s index token as part of the migration process.

`finishEmigration`


function finishEmigration() external;

Description: Finalizes the migration process. Only Callable by the reserve manager’s index token.

`setAllowUnsafeBurn`


function setAllowUnsafeBurn(bool unsafeBurnAllowed) external;

Parameters:

bool unsafeBurnAllowed: Whether or not unsafe burning is allowed.

Description: Unsafe burning refers to burning where internal reserve transfers are allowed to fail without interrupting the transaction. This is potentially dangerous and should only be used if one or more of the reserve tokens cannot be transferred out of the reserve manager due to blacklisting or some external technical failure, so that the rest of the funds can be recovered.