IFluidLiquidityAdmin

Git Source

Functions

updateAuths

adds/removes auths. Auths generally could be contracts which can have restricted actions defined on contract. auths can be helpful in reducing governance overhead where it's not needed.

function updateAuths(AdminModuleStructs.AddressBool[] calldata authsStatus_) external;

Parameters

Name	Type	Description
authsStatus_	AdminModuleStructs.AddressBool[]	array of structs setting allowed status for an address. status true => add auth, false => remove auth

updateGuardians

adds/removes guardians. Only callable by Governance.

function updateGuardians(AdminModuleStructs.AddressBool[] calldata guardiansStatus_) external;

Parameters

Name	Type	Description
guardiansStatus_	AdminModuleStructs.AddressBool[]	array of structs setting allowed status for an address. status true => add guardian, false => remove guardian

updateRevenueCollector

changes the revenue collector address (contract that is sent revenue). Only callable by Governance.

function updateRevenueCollector(address revenueCollector_) external;

Parameters

Name	Type	Description
revenueCollector_	address	new revenue collector address

changeStatus

changes current status, e.g. for pausing or unpausing all user operations. Only callable by Auths.

function changeStatus(uint256 newStatus_) external;

Parameters

Name	Type	Description
newStatus_	uint256	new status status = 2 -> pause, status = 1 -> resume.

updateRateDataV1s

update tokens rate data version 1. Only callable by Auths.

function updateRateDataV1s(AdminModuleStructs.RateDataV1Params[] calldata tokensRateData_) external;

Parameters

Name	Type	Description
tokensRateData_	AdminModuleStructs.RateDataV1Params[]	array of RateDataV1Params with rate data to set for each token

updateRateDataV2s

update tokens rate data version 2. Only callable by Auths.

function updateRateDataV2s(AdminModuleStructs.RateDataV2Params[] calldata tokensRateData_) external;

Parameters

Name	Type	Description
tokensRateData_	AdminModuleStructs.RateDataV2Params[]	array of RateDataV2Params with rate data to set for each token

updateTokenConfigs

updates token configs: fee charge on borrowers interest & storage update utilization threshold. Only callable by Auths.

function updateTokenConfigs(AdminModuleStructs.TokenConfig[] calldata tokenConfigs_) external;

Parameters

Name	Type	Description
tokenConfigs_	AdminModuleStructs.TokenConfig[]	contains token address, fee & utilization threshold

updateUserClasses

updates user classes (0–2), which gate user pauses and token-pause enforcement. Only callable by Auths. 0: all operations may be paused. 1: withdraw and payback cannot be paused. 2: nothing may be paused.

function updateUserClasses(AdminModuleStructs.AddressUint256[] calldata userClasses_) external;

Parameters

Name	Type	Description
userClasses_	AdminModuleStructs.AddressUint256[]	struct array of uint256 value to assign for each user address

updateUserSupplyConfigs

sets user supply configs per token basis. Eg: with interest or interest-free and automated limits. Only callable by Auths. Resets decay limit to 0.

function updateUserSupplyConfigs(AdminModuleStructs.UserSupplyConfig[] memory userSupplyConfigs_) external;

Parameters

Name	Type	Description
userSupplyConfigs_	AdminModuleStructs.UserSupplyConfig[]	struct array containing user supply config, see UserSupplyConfig struct for more info

updateUserWithdrawalLimit

sets a new withdrawal limit as the current limit for a certain user. Resets decay limit to 0

function updateUserWithdrawalLimit(address user_, address token_, uint256 newLimit_) external;

Parameters

Name	Type	Description
user_	address	user address for which to update the withdrawal limit
token_	address	token address for which to update the withdrawal limit
newLimit_	uint256	new limit until which user supply can decrease to. Important: input in raw. Must account for exchange price in input param calculation. Note any limit that is < max expansion or > current user supply will set max expansion limit or current user supply as limit respectively. - set 0 to make maximum possible withdrawable: instant full expansion, and if that goes below base limit then fully down to 0. - set type(uint256).max to make current withdrawable 0 (sets current user supply as limit).

updateUserBorrowConfigs

setting user borrow configs per token basis. Eg: with interest or interest-free and automated limits. Only callable by Auths.

function updateUserBorrowConfigs(AdminModuleStructs.UserBorrowConfig[] memory userBorrowConfigs_) external;

Parameters

Name	Type	Description
userBorrowConfigs_	AdminModuleStructs.UserBorrowConfig[]	struct array containing user borrow config, see UserBorrowConfig struct for more info

pauseUserSupply

pause selected supply-side operations for a user per _userClass: class 2 reverts on any pause flag; class 1 forbids pausing withdraw; class 0 allows all. Only callable by Guardians.

function pauseUserSupply(address user_, address[] calldata tokens_, bool pauseSupply_, bool pauseWithdraw_)
    external
    returns (bool[] memory actedSupply_, bool[] memory actedWithdraw_);

Parameters

Name	Type	Description
user_	address	address of user to pause operations for
tokens_	address[]	token addresses to apply supply/withdraw pause flags for
pauseSupply_	bool	if true, deposits/supply are paused for tokens_
pauseWithdraw_	bool	if true, withdrawals are paused for tokens_

Returns

Name	Type	Description
actedSupply_	bool[]	per-token flags; true when that token's supply pause state changed
actedWithdraw_	bool[]	per-token flags; true when that token's withdraw pause state changed

pauseUserBorrow

pause selected borrow-side operations for a user per _userClass: class 2 reverts on any pause flag; class 1 forbids pausing payback; class 0 allows all. Only callable by Guardians.

function pauseUserBorrow(address user_, address[] calldata tokens_, bool pauseBorrow_, bool pausePayback_)
    external
    returns (bool[] memory actedBorrow_, bool[] memory actedPayback_);

Parameters

Name	Type	Description
user_	address	address of user to pause operations for
tokens_	address[]	token addresses to apply borrow/payback pause flags for
pauseBorrow_	bool	if true, borrows are paused for tokens_
pausePayback_	bool	if true, paybacks are paused for tokens_

Returns

Name	Type	Description
actedBorrow_	bool[]	per-token flags; true when that token's borrow pause state changed
actedPayback_	bool[]	per-token flags; true when that token's payback pause state changed

unpauseUserSupply

unpause selected supply-side operations for a particular user. Only callable by Guardians.

function unpauseUserSupply(address user_, address[] calldata tokens_, bool unpauseSupply_, bool unpauseWithdraw_)
    external
    returns (bool[] memory actedSupply_, bool[] memory actedWithdraw_);

Parameters

Name	Type	Description
user_	address	address of user to unpause operations for
tokens_	address[]	token addresses to apply supply/withdraw unpause flags for
unpauseSupply_	bool	if true, deposits/supply are unpaused for tokens_
unpauseWithdraw_	bool	if true, withdrawals are unpaused for tokens_

Returns

Name	Type	Description
actedSupply_	bool[]	per-token flags; true when that token's supply pause state changed
actedWithdraw_	bool[]	per-token flags; true when that token's withdraw pause state changed

unpauseUserBorrow

unpause selected borrow-side operations for a particular user. Only callable by Guardians.

function unpauseUserBorrow(address user_, address[] calldata tokens_, bool unpauseBorrow_, bool unpausePayback_)
    external
    returns (bool[] memory actedBorrow_, bool[] memory actedPayback_);

Parameters

Name	Type	Description
user_	address	address of user to unpause operations for
tokens_	address[]	token addresses to apply borrow/payback unpause flags for
unpauseBorrow_	bool	if true, borrows are unpaused for tokens_
unpausePayback_	bool	if true, paybacks are unpaused for tokens_

Returns

Name	Type	Description
actedBorrow_	bool[]	per-token flags; true when that token's borrow pause state changed
actedPayback_	bool[]	per-token flags; true when that token's payback pause state changed

pauseTokens

pause selected operations for the given tokens. Only callable by Guardians.

function pauseTokens(
    address[] calldata tokens_,
    bool pauseSupply_,
    bool pauseWithdraw_,
    bool pauseBorrow_,
    bool pausePayback_
)
    external
    returns (
        bool[] memory actedSupply_,
        bool[] memory actedWithdraw_,
        bool[] memory actedBorrow_,
        bool[] memory actedPayback_
    );

Parameters

Name	Type	Description
tokens_	address[]	token addresses to pause
pauseSupply_	bool	if true, deposits/supply are paused
pauseWithdraw_	bool	if true, withdrawals are paused
pauseBorrow_	bool	if true, borrows are paused
pausePayback_	bool	if true, paybacks are paused

Returns

Name	Type	Description
actedSupply_	bool[]	per-token flags; true when that token's supply pause state changed
actedWithdraw_	bool[]	per-token flags; true when that token's withdraw pause state changed
actedBorrow_	bool[]	per-token flags; true when that token's borrow pause state changed
actedPayback_	bool[]	per-token flags; true when that token's payback pause state changed

unpauseTokens

unpause selected operations for the given tokens. Only callable by Guardians.

function unpauseTokens(
    address[] calldata tokens_,
    bool unpauseSupply_,
    bool unpauseWithdraw_,
    bool unpauseBorrow_,
    bool unpausePayback_
)
    external
    returns (
        bool[] memory actedSupply_,
        bool[] memory actedWithdraw_,
        bool[] memory actedBorrow_,
        bool[] memory actedPayback_
    );

Parameters

Name	Type	Description
tokens_	address[]	token addresses to unpause
unpauseSupply_	bool	if true, deposits/supply are unpaused
unpauseWithdraw_	bool	if true, withdrawals are unpaused
unpauseBorrow_	bool	if true, borrows are unpaused
unpausePayback_	bool	if true, paybacks are unpaused

Returns

Name	Type	Description
actedSupply_	bool[]	per-token flags; true when that token's supply pause state changed
actedWithdraw_	bool[]	per-token flags; true when that token's withdraw pause state changed
actedBorrow_	bool[]	per-token flags; true when that token's borrow pause state changed
actedPayback_	bool[]	per-token flags; true when that token's payback pause state changed

collectRevenue

collects revenue for tokens to configured revenueCollector address.

Note that this can revert if token balance is < revenueAmount (utilization > 100%)

function collectRevenue(address[] calldata tokens_) external;

Parameters

Name	Type	Description
tokens_	address[]	array of tokens to collect revenue for

updateExchangePrices

gets the current updated exchange prices for n tokens and updates all prices, rates related data in storage.

function updateExchangePrices(address[] calldata tokens_)
    external
    returns (uint256[] memory supplyExchangePrices_, uint256[] memory borrowExchangePrices_);

Parameters

Name	Type	Description
tokens_	address[]	tokens to update exchange prices for

Returns

Name	Type	Description
supplyExchangePrices_	uint256[]	new supply rates of overall system for each token
borrowExchangePrices_	uint256[]	new borrow rates of overall system for each token