Overview
The IPoolQuotaKeeperV3 interface manages quota-based interest for specific tokens in pools. It tracks per-account quotas, accumulates interest, and configures quota parameters like rates, limits, and fees.
View Functions
pool
function pool() external view returns (address)
The pool contract address
underlying
function underlying() external view returns (address)
The underlying token address
getQuotaRate
function getQuotaRate(address token) external view returns (uint16)
The quota interest rate in basis points per year
cumulativeIndex
function cumulativeIndex(address token) external view returns (uint192)
The cumulative interest index
isQuotedToken
function isQuotedToken(address token) external view returns (bool)
The address of the token to check
True if the token is quoted, false otherwise
getQuota
function getQuota(address creditAccount, address token)
external
view
returns (uint96 quota, uint192 cumulativeIndexLU)
The address of the credit account
The current quota amount for the account
The cumulative index at last update
getTokenQuotaParams
function getTokenQuotaParams(address token)
external
view
returns (
uint16 rate,
uint192 cumulativeIndexLU,
uint16 quotaIncreaseFee,
uint96 totalQuoted,
uint96 limit,
bool isActive
)
The quota interest rate in basis points per year
The cumulative index at last update
The one-time fee charged on quota increases (in basis points)
The total amount of token currently quoted across all accounts
The maximum total quota allowed for this token
Whether the token is currently active for quotas
getQuotaAndOutstandingInterest
function getQuotaAndOutstandingInterest(address creditAccount, address token)
external
view
returns (uint96 quoted, uint128 outstandingInterest)
The address of the credit account
The outstanding quota interest accumulated since last update
poolQuotaRevenue
function poolQuotaRevenue() external view returns (uint256)
The total quota revenue amount
lastQuotaRateUpdate
function lastQuotaRateUpdate() external view returns (uint40)
The unix timestamp of the last rate update
gauge
function gauge() external view returns (address)
The gauge contract address
creditManagers
function creditManagers() external view returns (address[] memory)
Array of credit manager addresses
quotedTokens
function quotedTokens() external view returns (address[] memory)
Array of quoted token addresses
Quota Management Functions
updateQuota
function updateQuota(
address creditAccount,
address token,
int96 requestedChange,
uint96 minQuota,
uint96 maxQuota
)
external
returns (
uint128 caQuotaInterestChange,
uint128 fees,
bool enableToken,
bool disableToken
)
The address of the credit account
The requested change in quota (positive to increase, negative to decrease)
The minimum quota amount allowed after the update
The maximum quota amount allowed after the update
The change in quota interest for the credit account
The fees charged for the quota update
Whether the token should be enabled on the credit account
Whether the token should be disabled on the credit account
removeQuotas
function removeQuotas(
address creditAccount,
address[] calldata tokens,
bool setLimitsToZero
) external
The address of the credit account
Array of token addresses to remove quotas for
Whether to set the account’s limits to zero after removal
accrueQuotaInterest
function accrueQuotaInterest(
address creditAccount,
address[] calldata tokens
) external
The address of the credit account
Array of token addresses to accrue interest for
Configuration Functions
setGauge
function setGauge(address _gauge) external
The address of the new gauge contract
addCreditManager
function addCreditManager(address _creditManager) external
The address of the credit manager to add
addQuotaToken
function addQuotaToken(address token) external
The address of the token to add
updateRates
function updateRates() external
setTokenLimit
function setTokenLimit(address token, uint96 limit) external
The new total quota limit
setTokenQuotaIncreaseFee
function setTokenQuotaIncreaseFee(address token, uint16 fee) external
The new quota increase fee in basis points
Events
UpdateQuota
event UpdateQuota(address indexed creditAccount, address indexed token, int96 quotaChange)
The address of the credit account
The change in quota (positive for increase, negative for decrease)
UpdateTokenQuotaRate
event UpdateTokenQuotaRate(address indexed token, uint16 rate)
The new quota interest rate in basis points per year
SetGauge
event SetGauge(address indexed newGauge)
The address of the new gauge contract
AddCreditManager
event AddCreditManager(address indexed creditManager)
The address of the newly added credit manager
AddQuotaToken
event AddQuotaToken(address indexed token)
The address of the newly added quoted token
SetTokenLimit
event SetTokenLimit(address indexed token, uint96 limit)
The new total quota limit
SetQuotaIncreaseFee
event SetQuotaIncreaseFee(address indexed token, uint16 fee)
The new quota increase fee in basis points
Structs
TokenQuotaParams
struct TokenQuotaParams {
uint16 rate;
uint192 cumulativeIndexLU;
uint16 quotaIncreaseFee;
uint96 totalQuoted;
uint96 limit;
}
The quota interest rate in basis points per year
The cumulative interest index at last update
The one-time fee charged on quota increases (in basis points)
The total amount of token currently quoted across all accounts
The maximum total quota allowed for this token
AccountQuota
struct AccountQuota {
uint96 quota;
uint192 cumulativeIndexLU;
}
The current quota amount for the account
The cumulative interest index at last update for this account