typo corrections

Author: olivier7delf

packages/smart-contracts/src/contracts/BatchConversionPayments.sol

@@ -25,8 +25,8 @@ contract BatchConversionPayments is BatchNoConversionPayments {
   IEthConversionProxy public paymentEthConversionProxy;
 
   /**
-   * @dev Used by the batchPayment to handle information for heterogeneous batches, grouped by payment network.
-   *  - paymentNetworkId: from 0 to 4, cf. `batchPayment()` method.
+   * @dev Used by the batchPayment to handle information for heterogeneous batches, grouped by payment network:
+   *  - paymentNetworkId: from 0 to 4, cf. `batchPayment()` method
    *  - requestDetails all the data required for conversion and no conversion requests to be paid
    */
   struct MetaDetail {
@@ -39,7 +39,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
    * @param _paymentEthProxy The ETH payment proxy address to use.
    * @param _paymentErc20ConversionProxy The ERC20 Conversion payment proxy address to use.
    * @param _paymentEthConversionFeeProxy The ETH Conversion payment proxy address to use.
-   * @param _chainlinkConversionPathAddress The address of the conversion path contract
+   * @param _chainlinkConversionPathAddress The address of the conversion path contract.
    * @param _owner Owner of the contract.
    */
   constructor(
@@ -85,7 +85,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
 
     // Check that there are paths to USD, and more than one paymentNetworkId
     if (pathsToUSD.length > 0 && metaDetails.length > 1) {
-      // Set to true to limit the batch fee to pay
+      // Set to true to avoid batchFeeAmountUSD to be reset by each batch function
       batchPaymentOrigin = true;
     }
 
@@ -137,6 +137,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
       }
     }
     if (pathsToUSD.length > 0 && metaDetails.length > 1) {
+      // Set back to false, its default value
       batchPaymentOrigin = false;
     }
   }
@@ -148,7 +149,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
    * @param batchFeeAmountUSD The batch fee amount in USD already paid.
    * @param pathsToUSD The list of paths into USD for every token, used to limit the batch fees.
    *                   Without paths, there is not limitation.
-   * @param feeAddress The fee recipient
+   * @param feeAddress The fee recipient.
    */
   function batchMultiERC20ConversionPayments(
     RequestDetail[] calldata requestDetails,
@@ -299,12 +300,4 @@ contract BatchConversionPayments is BatchNoConversionPayments {
   function setPaymentEthConversionProxy(address _paymentEthConversionProxy) external onlyOwner {
     paymentEthConversionProxy = IEthConversionProxy(_paymentEthConversionProxy);
   }
-
-  /**
-   * @notice Update the conversion path contract used to fetch conversions.
-   * @param _chainlinkConversionPathAddress The address of the conversion path contract.
-   */
-  function setConversionPathAddress(address _chainlinkConversionPathAddress) external onlyOwner {
-    chainlinkConversionPath = ChainlinkConversionPath(_chainlinkConversionPathAddress);
-  }
 }

packages/smart-contracts/src/contracts/BatchNoConversionPayments.sol

@@ -28,26 +28,26 @@ contract BatchNoConversionPayments is Ownable {
   IEthereumFeeProxy public paymentEthProxy;
   ChainlinkConversionPath public chainlinkConversionPath;
 
+  /** Used to calculate batch fees: batchFee = 30 represent 0.30% of fee */
   uint256 public batchFee;
-  /** Used to to calculate batch fees */
+  /** Used to calculate batch fees: divide batchFee by feeDenominator */
   uint256 internal feeDenominator = 10000;
+  /** The amount of the batch fee cannot exceed a predefined amount in USD */
+  uint256 public batchFeeAmountUSDLimit;
 
   /** payerAuthorized is set to true only when needed for batch Eth conversion */
   bool internal payerAuthorized = false;
   /** batchPayment function is the caller */
   bool internal batchPaymentOrigin = false;
-
   /** transferBackRemainingEth is set to false only if the payer use batchPayment
   and call both batchEthPayments and batchConversionEthPaymentsWithReference */
   bool internal transferBackRemainingEth = true;
 
-  /** The amount of the batch fee cannot exceed a predefined amount in USD */
-  uint256 public batchFeeAmountUSDLimit;
   address public USDAddress;
   address public ETHAddress;
   address[][] public pathsEthToUSD;
 
-  /** Contain the address of a token, the sum of the amount and fees paid with it, and the batch fee amount */
+  /** Contains the address of a token, the sum of the amount and fees paid with it, and the batch fee amount */
   struct Token {
     address tokenAddress;
     uint256 amountAndFee;
@@ -80,7 +80,7 @@ contract BatchNoConversionPayments is Ownable {
   /**
    * @param _paymentErc20Proxy The address to the ERC20 fee payment proxy to use.
    * @param _paymentEthProxy The address to the Ethereum fee payment proxy to use.
-   * @param _chainlinkConversionPathAddress The address of the conversion path contract
+   * @param _chainlinkConversionPathAddress The address of the conversion path contract.
    * @param _owner Owner of the contract.
    */
   constructor(
@@ -499,9 +499,11 @@ contract BatchNoConversionPayments is Ownable {
 
   /**
    * @notice Fees added when using Erc20/Eth batch functions
-   * @param _batchFee Between 0 and 10000, i.e: batchFee = 50 represent 0.50% of fee
+   * @param _batchFee Between 0 and 200, i.e: batchFee = 30 represent 0.30% of fee
    */
   function setBatchFee(uint256 _batchFee) external onlyOwner {
+    // safety to avoid wrong setting
+    require(_batchFee <= 200, 'The batch fee value is too high: > 2%');
     batchFee = _batchFee;
   }
 
@@ -519,9 +521,17 @@ contract BatchNoConversionPayments is Ownable {
     paymentEthProxy = IEthereumFeeProxy(_paymentEthProxy);
   }
 
+  /**
+   * @notice Update the conversion path contract used to fetch conversions.
+   * @param _chainlinkConversionPathAddress The address of the conversion path contract.
+   */
+  function setConversionPathAddress(address _chainlinkConversionPathAddress) external onlyOwner {
+    chainlinkConversionPath = ChainlinkConversionPath(_chainlinkConversionPathAddress);
+  }
+
   /**
    * This function define variables allowing to limit the fees:
-   * ETHAddress, USDAddress, and pathsEthToUSD
+   * ETHAddress, USDAddress, and pathsEthToUSD.
    * @param _ETHAddress The address representing the Ethereum currency.
    * @param _USDAddress The address representing the USD currency.
    */