refactor: replace "lowest quality" with "oldest"

ToucanProtocol · Oct 5, 2023 · 32fff2c · 32fff2c
1 parent 37d2e08
commit 32fff2c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/contracts/OffsetHelper.sol b/contracts/OffsetHelper.sol
@@ -140,7 +140,7 @@ contract OffsetHelper is OffsetHelperStorage {
     // ----------------------------------------
 
     /**
-     * @notice Retire carbon credits using the lowest quality (oldest) TCO2
+     * @notice Retire carbon credits using the oldest TCO2
      * tokens available from the specified Toucan token pool by sending ERC20
      * tokens (cUSD, USDC, WETH, WMATIC). Use `calculateNeededTokenAmount` first in
      * order to find out how much of the ERC20 token is required to retire the
@@ -153,7 +153,7 @@ contract OffsetHelper is OffsetHelperStorage {
      *
      * Note: The client must approve the ERC20 token that is sent to the contract.
      *
-     * @dev When automatically redeeming pool tokens for the lowest quality
+     * @dev When automatically redeeming pool tokens for the oldest ones
      * TCO2s there are no fees and you receive exactly 1 TCO2 token for 1 pool
      * token.
      *
@@ -182,7 +182,7 @@ contract OffsetHelper is OffsetHelperStorage {
     }
 
     /**
-     * @notice Retire carbon credits using the lowest quality (oldest) TCO2
+     * @notice Retire carbon credits using the oldest TCO2
      * tokens available from the specified Toucan token pool by sending ERC20
      * tokens (cUSD, USDC, WETH, WMATIC). All provided token is consumed for
      * offsetting.
@@ -194,7 +194,7 @@ contract OffsetHelper is OffsetHelperStorage {
      *
      * Note: The client must approve the ERC20 token that is sent to the contract.
      *
-     * @dev When automatically redeeming pool tokens for the lowest quality
+     * @dev When automatically redeeming pool tokens for the oldest ones
      * TCO2s there are no fees and you receive exactly 1 TCO2 token for 1 pool
      * token.
      *
@@ -228,7 +228,7 @@ contract OffsetHelper is OffsetHelperStorage {
     }
 
     /**
-     * @notice Retire carbon credits using the lowest quality (oldest) TCO2
+     * @notice Retire carbon credits using the oldest TCO2
      * tokens available from the specified Toucan token pool by sending native tokens e.g., MATIC.
      * Use `calculateNeededETHAmount()` first in order to find out how much
      * native tokens are required to retire the specified quantity of TCO2.
@@ -268,7 +268,7 @@ contract OffsetHelper is OffsetHelperStorage {
     }
 
     /**
-     * @notice Retire carbon credits using the lowest quality (oldest) TCO2
+     * @notice Retire carbon credits using the oldest TCO2
      * tokens available from the specified Toucan token pool by sending native tokens e.g., MATIC.
      * All provided native tokens  is consumed for offsetting.
      *
@@ -304,7 +304,7 @@ contract OffsetHelper is OffsetHelperStorage {
     }
 
     /**
-     * @notice Retire carbon credits using the lowest quality (oldest) TCO2
+     * @notice Retire carbon credits using the oldest TCO2
      * tokens available by sending Toucan pool tokens,  e.g., NCT.
      *
      * This function:

diff --git a/docs/OffsetHelper.md b/docs/OffsetHelper.md
@@ -148,7 +148,7 @@ function initialize() external virtual
 function autoOffsetExactOutToken(address _depositedToken, address _poolToken, uint256 _amountToOffset) public returns (address[] tco2s, uint256[] amounts)
 ```
 
-Retire carbon credits using the lowest quality (oldest) TCO2
+Retire carbon credits using the oldest TCO2
 tokens available from the specified Toucan token pool by sending ERC20
 tokens (USDC, WETH, WMATIC). Use `calculateNeededTokenAmount` first in
 order to find out how much of the ERC20 token is required to retire the
@@ -187,7 +187,7 @@ token._
 function autoOffsetExactInToken(address _fromToken, uint256 _amountToSwap, address _poolToken) public returns (address[] tco2s, uint256[] amounts)
 ```
 
-Retire carbon credits using the lowest quality (oldest) TCO2
+Retire carbon credits using the oldest TCO2
 tokens available from the specified Toucan token pool by sending ERC20
 tokens (USDC, WETH, WMATIC). All provided token is consumed for
 offsetting.
@@ -225,7 +225,7 @@ token._
 function autoOffsetExactOutETH(address _poolToken, uint256 _amountToOffset) public payable returns (address[] tco2s, uint256[] amounts)
 ```
 
-Retire carbon credits using the lowest quality (oldest) TCO2
+Retire carbon credits using the oldest TCO2
 tokens available from the specified Toucan token pool by sending MATIC.
 Use `calculateNeededETHAmount()` first in order to find out how much
 MATIC is required to retire the specified quantity of TCO2.
@@ -259,7 +259,7 @@ to the user._
 function autoOffsetExactInETH(address _poolToken) public payable returns (address[] tco2s, uint256[] amounts)
 ```
 
-Retire carbon credits using the lowest quality (oldest) TCO2
+Retire carbon credits using the oldest TCO2
 tokens available from the specified Toucan token pool by sending MATIC.
 All provided MATIC is consumed for offsetting.
 
@@ -288,7 +288,7 @@ This function:
 function autoOffsetPoolToken(address _poolToken, uint256 _amountToOffset) public returns (address[] tco2s, uint256[] amounts)
 ```
 
-Retire carbon credits using the lowest quality (oldest) TCO2
+Retire carbon credits using the oldest TCO2
 tokens available by sending Toucan pool tokens, for example, BCT or NCT.
 
 This function: