Skip to content

Commit

Permalink
fix: better readability
Browse files Browse the repository at this point in the history
  • Loading branch information
0xmikko committed May 15, 2023
1 parent 8f2b97f commit d66a234
Show file tree
Hide file tree
Showing 15 changed files with 163 additions and 129 deletions.
2 changes: 1 addition & 1 deletion contracts/adapters/AbstractAdapter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ abstract contract AbstractAdapter is IAdapter, ACLTrait {

/// @dev Ensures that external call credit account is set and returns its address
function _creditAccount() internal view returns (address) {
return creditManager.externalCallCreditAccountOrRevert(); // U:[AA-2]
return creditManager.getExternalCallCreditAccountOrRevert(); // U:[AA-2]
}

/// @dev Ensures that token is registered as collateral in the credit manager and returns its mask
Expand Down
12 changes: 6 additions & 6 deletions contracts/credit/CreditConfiguratorV3.sol
Original file line number Diff line number Diff line change
Expand Up @@ -375,11 +375,11 @@ contract CreditConfigurator is ICreditConfigurator, ACLNonReentrantTrait {
// If there is an existing adapter for the target contract, it has to be removed
address currentAdapter = creditManager.contractToAdapter(targetContract);
if (currentAdapter != address(0)) {
creditManager.setContractAllowance(currentAdapter, address(0)); // F: [CC-15A]
creditManager.setContractAllowance({adapter: currentAdapter, targetContract: address(0)}); // F: [CC-15A]
}

// Sets a link between adapter and targetContract in creditFacade and creditManager
creditManager.setContractAllowance(adapter, targetContract); // F:[CC-15]
creditManager.setContractAllowance({adapter: adapter, targetContract: targetContract}); // F:[CC-15]

// adds contract to the list of allowed contracts
allowedContractsSet.add(targetContract); // F:[CC-15]
Expand All @@ -406,8 +406,8 @@ contract CreditConfigurator is ICreditConfigurator, ACLNonReentrantTrait {
// Sets both contractToAdapter[targetContract] and adapterToContract[adapter]
// To address(0), which would make Credit Manager revert on attempts to
// call the respective targetContract using the adapter
creditManager.setContractAllowance(adapter, address(0)); // F:[CC-17]
creditManager.setContractAllowance(address(0), targetContract); // F:[CC-17]
creditManager.setContractAllowance({adapter: adapter, targetContract: address(0)}); // F:[CC-17]
creditManager.setContractAllowance({adapter: address(0), targetContract: targetContract}); // F:[CC-17]

// removes contract from the list of allowed contracts
allowedContractsSet.remove(targetContract); // F:[CC-17]
Expand All @@ -432,7 +432,7 @@ contract CreditConfigurator is ICreditConfigurator, ACLNonReentrantTrait {
}

/// Removes the adapter => target contract link only
creditManager.setContractAllowance(adapter, address(0)); // F: [CC-40]
creditManager.setContractAllowance({adapter: adapter, targetContract: address(0)}); // F: [CC-40]

emit ForbidAdapter(adapter); // F: [CC-40]
}
Expand Down Expand Up @@ -751,7 +751,7 @@ contract CreditConfigurator is ICreditConfigurator, ACLNonReentrantTrait {
external
controllerOnly // F:[CC-2B]
{
uint256 maxEnabledTokensCurrent = creditManager.maxAllowedEnabledTokenLength();
uint256 maxEnabledTokensCurrent = creditManager.maxEnabledTokens();

// Checks that value is actually changed, to avoid redundant checks
if (maxEnabledTokens != maxEnabledTokensCurrent) {
Expand Down
232 changes: 133 additions & 99 deletions contracts/credit/CreditManagerV3.sol

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions contracts/interfaces/ICreditManagerV3.sol
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ interface ICreditManagerV3 is ICreditManagerV3Events, IVersion {
function liquidationThresholds(address token) external view returns (uint16);

/// @dev The maximal number of enabled tokens on a single Credit Account
function maxAllowedEnabledTokenLength() external view returns (uint8);
function maxEnabledTokens() external view returns (uint8);

/// @dev Returns the fee parameters of the Credit Manager
/// @return feeInterest Percentage of interest taken by the protocol as profit
Expand Down Expand Up @@ -326,7 +326,7 @@ interface ICreditManagerV3 is ICreditManagerV3Events, IVersion {

function setCreditAccountForExternalCall(address creditAccount) external;

function externalCallCreditAccountOrRevert() external view returns (address creditAccount);
function getExternalCallCreditAccountOrRevert() external view returns (address creditAccount);

function getTokenByMask(uint256 tokenMask) external view returns (address token);

Expand Down
6 changes: 3 additions & 3 deletions contracts/libraries/CreditLogic.sol
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ library CreditLogic {
CollateralDebtData memory collateralDebtData,
address creditAccount,
uint256 quotedTokenMask,
uint256 maxAllowedEnabledTokenLength,
uint256 maxEnabledTokens,
address underlying,
function (uint256, bool) view returns (address, uint16) collateralTokensByMaskFn,
bool countCollateral
Expand All @@ -336,7 +336,7 @@ library CreditLogic {
uint256 underlyingPriceRAY =
countCollateral ? convertToUSD(collateralDebtData._priceOracle, RAY, underlying) : 0;

collateralDebtData.quotedTokens = new address[](maxAllowedEnabledTokenLength);
collateralDebtData.quotedTokens = new address[](maxEnabledTokens);

unchecked {
for (uint256 tokenMask = 2; tokenMask <= quotedTokenMask; tokenMask <<= 1) {
Expand All @@ -363,7 +363,7 @@ library CreditLogic {

++j;

if (j >= maxAllowedEnabledTokenLength) {
if (j >= maxEnabledTokens) {
revert TooManyEnabledTokensException();
}
}
Expand Down
4 changes: 2 additions & 2 deletions contracts/pool/PoolQuotaKeeper.sol
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ contract PoolQuotaKeeper is IPoolQuotaKeeper, ACLNonReentrantTrait, ContractsReg
creditManagerOnly // F:[PQK-4]
returns (uint256 caQuotaInterestChange, bool enableToken, bool disableToken)
{
int128 quotaRevenueChange;
int128 quotaRevenueChange; // TODO: better naming(?)

AccountQuota storage accountQuota = accountQuotas[creditAccount][token];
TokenQuotaParams storage tokenQuotaParams = totalQuotaParams[token];
Expand Down Expand Up @@ -149,7 +149,7 @@ contract PoolQuotaKeeper is IPoolQuotaKeeper, ACLNonReentrantTrait, ContractsReg
}
}

if (quotaRevenueChange > 0) {
if (quotaRevenueChange != 0) {
IPool4626(pool).changeQuotaRevenue(quotaRevenueChange);
}
}
Expand Down
2 changes: 1 addition & 1 deletion contracts/support/DataCompressor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ contract DataCompressor is IDataCompressor, ContractsRegisterTrait {
result.degenNFT = creditFacade.degenNFT();
result.isIncreaseDebtForbidden = creditFacade.maxDebtPerBlockMultiplier() == 0; // V2 only: true if increasing debt is forbidden
result.forbiddenTokenMask = creditFacade.forbiddenTokenMask(); // V2 only: mask which forbids some particular tokens
result.maxEnabledTokensLength = creditManagerV2.maxAllowedEnabledTokenLength(); // V2 only: a limit on enabled tokens imposed for security
result.maxEnabledTokensLength = creditManagerV2.maxEnabledTokens(); // V2 only: a limit on enabled tokens imposed for security
{
(
result.feeInterest,
Expand Down
2 changes: 1 addition & 1 deletion contracts/test/integration/credit/CreditConfigurator.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,7 @@ contract CreditConfiguratorTest is Test, ICreditManagerV3Events, ICreditConfigur
vm.prank(CONFIGURATOR);
creditConfigurator.setMaxEnabledTokens(255);

assertEq(creditManager.maxAllowedEnabledTokenLength(), 255, "Credit manager max enabled tokens incorrect");
assertEq(creditManager.maxEnabledTokens(), 255, "Credit manager max enabled tokens incorrect");
}

/// @dev [CC-38]: addEmergencyLiquidator works correctly and emits event
Expand Down
6 changes: 3 additions & 3 deletions contracts/test/integration/credit/CreditManager.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ contract CreditManagerTest is Test, ICreditManagerV3Events, BalanceHelper {
}

function enableTokensMoreThanLimit(address creditAccount) internal {
uint256 maxAllowedEnabledTokenLength = creditManager.maxAllowedEnabledTokenLength();
_addAndEnableTokens(creditAccount, maxAllowedEnabledTokenLength, 2);
uint256 maxEnabledTokens = creditManager.maxEnabledTokens();
_addAndEnableTokens(creditAccount, maxEnabledTokens, 2);
}

function _openAccountAndTransferToCF() internal returns (address creditAccount) {
Expand Down Expand Up @@ -2011,7 +2011,7 @@ contract CreditManagerTest is Test, ICreditManagerV3Events, BalanceHelper {
vm.prank(CONFIGURATOR);
creditManager.setMaxEnabledTokens(255);

assertEq(creditManager.maxAllowedEnabledTokenLength(), 255, "Incorrect max enabled tokens");
assertEq(creditManager.maxEnabledTokens(), 255, "Incorrect max enabled tokens");
}

// /// @dev [CM-64]: closeCreditAccount reverts when attempting to liquidate while paused,
Expand Down
4 changes: 2 additions & 2 deletions contracts/test/integration/credit/CreditManager_Quotas.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ contract CreditManagerQuotasTest is Test, ICreditManagerV3Events, BalanceHelper
// function test_CMQ_11_updateQuotas_reverts_on_too_many_tokens_enabled() public {
// (,,, address creditAccount) = cms.openCreditAccount();

// uint256 maxTokens = creditManager.maxAllowedEnabledTokenLength();
// uint256 maxTokens = creditManager.maxEnabledTokens();

// QuotaUpdate[] memory quotaUpdates = _addManyLimitedTokens(maxTokens + 1, 100);

Expand Down Expand Up @@ -675,7 +675,7 @@ contract CreditManagerQuotasTest is Test, ICreditManagerV3Events, BalanceHelper
});
enabledTokensMap |= tokensToEnable;

address[] memory quotedTokens = new address[](creditManager.maxAllowedEnabledTokenLength() + 1);
address[] memory quotedTokens = new address[](creditManager.maxEnabledTokens() + 1);

quotedTokens[0] = tokenTestSuite.addressOf(Tokens.LINK);
quotedTokens[1] = tokenTestSuite.addressOf(Tokens.USDT);
Expand Down
2 changes: 1 addition & 1 deletion contracts/test/unit/adapters/AbstractAdapter.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ contract AbstractAdapterUnitTest is TestHelper, CreditManagerMockEvents {
function test_U_AA_02_creditAccount_works_correctly(address creditAccount) public {
creditManager.setExternalCallCreditAccount(creditAccount);

vm.expectCall(address(creditManager), abi.encodeCall(creditManager.externalCallCreditAccountOrRevert, ()));
vm.expectCall(address(creditManager), abi.encodeCall(creditManager.getExternalCallCreditAccountOrRevert, ()));
assertEq(abstractAdapter.creditAccount(), creditAccount, "Incorrect external call credit account");
}

Expand Down
4 changes: 2 additions & 2 deletions contracts/test/unit/adapters/CreditManagerMock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ contract CreditManagerMock is CreditManagerMockEvents {
address public creditFacade;
address public addressProvider;

address public externalCallCreditAccountOrRevert;
address public getExternalCallCreditAccountOrRevert;
mapping(address => uint256) public getTokenMaskOrRevert;

bytes _result;
Expand All @@ -34,7 +34,7 @@ contract CreditManagerMock is CreditManagerMockEvents {
}

function setExternalCallCreditAccount(address creditAccount) external {
externalCallCreditAccountOrRevert = creditAccount;
getExternalCallCreditAccountOrRevert = creditAccount;
}

function setMask(address token, uint256 mask) external {
Expand Down
2 changes: 1 addition & 1 deletion contracts/test/unit/credit/CreditConfigurator.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,7 @@ contract CreditConfiguratorTest is Test, ICreditManagerV3Events, ICreditConfigur
vm.prank(CONFIGURATOR);
creditConfigurator.setMaxEnabledTokens(255);

assertEq(creditManager.maxAllowedEnabledTokenLength(), 255, "Credit manager max enabled tokens incorrect");
assertEq(creditManager.maxEnabledTokens(), 255, "Credit manager max enabled tokens incorrect");
}

/// @dev [CC-38]: addEmergencyLiquidator works correctly and emits event
Expand Down
6 changes: 3 additions & 3 deletions contracts/test/unit/credit/CreditManager.t.old.sol
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ contract OldCreditManagerTest is Test, ICreditManagerV3Events, BalanceHelper {
}

function enableTokensMoreThanLimit(address creditAccount) internal {
uint256 maxAllowedEnabledTokenLength = creditManager.maxAllowedEnabledTokenLength();
_addAndEnableTokens(creditAccount, maxAllowedEnabledTokenLength, 2);
uint256 maxEnabledTokens = creditManager.maxEnabledTokens();
_addAndEnableTokens(creditAccount, maxEnabledTokens, 2);
}

function _openAccountAndTransferToCF() internal returns (address creditAccount) {
Expand Down Expand Up @@ -1958,7 +1958,7 @@ contract OldCreditManagerTest is Test, ICreditManagerV3Events, BalanceHelper {
vm.prank(CONFIGURATOR);
creditManager.setMaxEnabledTokens(255);

assertEq(creditManager.maxAllowedEnabledTokenLength(), 255, "Incorrect max enabled tokens");
assertEq(creditManager.maxEnabledTokens(), 255, "Incorrect max enabled tokens");
}

// /// @dev [CM-67]: checkEmergencyPausable returns pause state and enable emergencyLiquidation if needed
Expand Down
4 changes: 2 additions & 2 deletions contracts/test/unit/credit/CreditManager_Quotas.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ contract CreditManagerQuotasTest is Test, ICreditManagerV3Events, BalanceHelper
// function test_CMQ_11_updateQuotas_reverts_on_too_many_tokens_enabled() public {
// (,,, address creditAccount) = cms.openCreditAccount();

// uint256 maxTokens = creditManager.maxAllowedEnabledTokenLength();
// uint256 maxTokens = creditManager.maxEnabledTokens();

// QuotaUpdate[] memory quotaUpdates = _addManyLimitedTokens(maxTokens + 1, 100);

Expand Down Expand Up @@ -675,7 +675,7 @@ contract CreditManagerQuotasTest is Test, ICreditManagerV3Events, BalanceHelper
});
enabledTokensMap |= tokensToEnable;

address[] memory quotedTokens = new address[](creditManager.maxAllowedEnabledTokenLength() + 1);
address[] memory quotedTokens = new address[](creditManager.maxEnabledTokens() + 1);

quotedTokens[0] = tokenTestSuite.addressOf(Tokens.LINK);
quotedTokens[1] = tokenTestSuite.addressOf(Tokens.USDT);
Expand Down

0 comments on commit d66a234

Please sign in to comment.