Skip to content

Commit

Permalink
docs: change contracts version in comments 1.9.0 => 1.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
EvgeniiZaitsevCW committed Jan 24, 2025
1 parent d526648 commit ec928ba
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions contracts/CreditLine.sol
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ contract CreditLine is AccessControlExtUpgradeable, PausableUpgradeable, ICredit
}

// Check that fields `minAddonFixedRate`, `maxAddonFixedRate`, `minAddonPeriodRate`, `maxAddonPeriodRate`
// are zero because they have been deprecated since version 1.9.0
// are zero because they have been deprecated since version 1.8.0
if (config.minAddonFixedRate != 0) {
revert InvalidCreditLineConfiguration();
}
Expand Down Expand Up @@ -313,7 +313,7 @@ contract CreditLine is AccessControlExtUpgradeable, PausableUpgradeable, ICredit
terms.durationInPeriods = durationInPeriods;
terms.interestRatePrimary = borrowerConfig.interestRatePrimary;
terms.interestRateSecondary = borrowerConfig.interestRateSecondary;
// terms.addonAmount = 0 because the field has been deprecated since version 1.9.0
// terms.addonAmount = 0 because the field has been deprecated since version 1.8.0
}

/// @inheritdoc ICreditLinePrimary
Expand Down
4 changes: 2 additions & 2 deletions contracts/LiquidityPool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ contract LiquidityPool is

/// @dev The addons balance of the liquidity pool.
///
/// IMPORTANT! Deprecated since version 1.9.0. Now this variable is always zero.
/// IMPORTANT! Deprecated since version 1.8.0. Now this variable is always zero.
///
/// See the comments of the {_addonTreasury} storage variable for more details.
uint64 internal _addonsBalance;

/// @dev The address of the addon treasury.
///
/// Previously, this address affected the pool logic.
/// But since version 1.9.0, the ability to save the addon amount in the pool has become deprecated.
/// But since version 1.8.0, the ability to save the addon amount in the pool has become deprecated.
/// Now the addon amount must always be output to an external wallet. The addon balance of the pool is always zero.
address internal _addonTreasury;

Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/ICreditLineTypes.sol
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ interface ICreditLineTypes {
///
/// Note:
/// Fields `minAddonFixedRate`, `maxAddonFixedRate`, `minAddonPeriodRate`, `maxAddonPeriodRate` have been
/// deprecated since version 1.9.0 and must be set to zero.
/// deprecated since version 1.8.0 and must be set to zero.
struct CreditLineConfig {
// Slot 1
uint64 minBorrowedAmount;
Expand Down Expand Up @@ -77,7 +77,7 @@ interface ICreditLineTypes {
/// - addonPeriodRate -------- The period rate for the loan addon calculation (extra charges or fees).
///
/// Note:
/// Fields `addonFixedRate`, `addonPeriodRate` have been deprecated since version 1.9.0 and must be set to zero.
/// Fields `addonFixedRate`, `addonPeriodRate` have been deprecated since version 1.8.0 and must be set to zero.
struct BorrowerConfig {
// Slot 1
uint32 expiration;
Expand Down
8 changes: 4 additions & 4 deletions contracts/interfaces/ILiquidityPool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface ILiquidityPoolPrimary {

/// @dev Emitted when tokens are withdrawn from the liquidity pool.
/// @param borrowableAmount The amount of tokens withdrawn from the borrowable balance.
/// @param addonAmount Deprecated since version 1.9.0. This amount is always zero now.
/// @param addonAmount Deprecated since version 1.8.0. This amount is always zero now.
event Withdrawal(uint256 borrowableAmount, uint256 addonAmount);

/// @dev Emitted when tokens are rescued from the liquidity pool.
Expand All @@ -34,7 +34,7 @@ interface ILiquidityPoolPrimary {

/// @dev Withdraws tokens from the liquidity pool.
/// @param borrowableAmount The amount of tokens to withdraw from the borrowable balance.
/// @param addonAmount This parameter has been deprecated since version 1.9.0 and must be zero.
/// @param addonAmount This parameter has been deprecated since version 1.8.0 and must be zero.
/// See the {addonTreasury} function comments for more details.
function withdraw(uint256 borrowableAmount, uint256 addonAmount) external;

Expand All @@ -56,15 +56,15 @@ interface ILiquidityPoolPrimary {
/// @dev Returns the addon treasury address.
///
/// Previously, this address affected the pool logic.
/// But since version 1.9.0, the ability to save the addon amount in the pool has become deprecated.
/// But since version 1.8.0, the ability to save the addon amount in the pool has become deprecated.
/// Now the addon amount must always be output to an external wallet. The addon balance of the pool is always zero.
///
/// @return The current address of the addon treasury.
function addonTreasury() external view returns (address);

/// @dev Gets the borrowable and addons balances of the liquidity pool.
///
/// The addons part of the balance has been deprecated since version 1.9.0 and now it always equals zero.
/// The addons part of the balance has been deprecated since version 1.8.0 and now it always equals zero.
///
/// @return The borrowable and addons balances.
function getBalances() external view returns (uint256, uint256);
Expand Down
2 changes: 1 addition & 1 deletion contracts/libraries/Loan.sol
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ library Loan {
/// - interestRateSecondary -- The secondary interest rate to be applied to the loan.
///
/// Note:
/// The `addonAmount` field has been deprecated since version 1.9.0 and is always zero.
/// The `addonAmount` field has been deprecated since version 1.8.0 and is always zero.
/// The addon amount of a loan is no longer calculated in the contract.
/// It is passed as a parameter of a borrowing function instead.
struct Terms {
Expand Down

0 comments on commit ec928ba

Please # to comment.