add fee batch amount limit to batchMultiERC20ConversionPayments

olivier7delf · olivier7delf · commit 256f5d663cad · 2022-10-07T15:47:05.000+02:00
diff --git a/packages/smart-contracts/scripts/test-deploy-batch-conversion-deployment.ts b/packages/smart-contracts/scripts/test-deploy-batch-conversion-deployment.ts
@@ -28,6 +28,7 @@ export async function deployBatchConversionPayment(
     const _EthereumFeeProxyAddress = ethereumFeeProxyArtifact.getAddress('private');
     const _paymentErc20ConversionFeeProxy = erc20ConversionProxy.getAddress('private');
     const _paymentEthConversionFeeProxy = ethConversionArtifact.getAddress('private');
+    const _chainlinkConversionPath = '0x4e71920b7330515faf5EA0c690f1aD06a85fB60c';
 
     // Deploy BatchConversionPayments contract
     const { address: BatchConversionPaymentsAddress } = await deployOne(
@@ -40,6 +41,7 @@ export async function deployBatchConversionPayment(
           _EthereumFeeProxyAddress,
           _paymentErc20ConversionFeeProxy,
           _paymentEthConversionFeeProxy,
+          _chainlinkConversionPath,
           await (await hre.ethers.getSigners())[0].getAddress(),
         ],
       },
@@ -75,6 +77,8 @@ export async function deployBatchConversionPayment(
     const batchConversion = batchConversionPaymentsArtifact.connect(hre.network.name, owner);
     await batchConversion.connect(owner).setBatchFee(30);
     await batchConversion.connect(owner).setBatchConversionFee(30);
+    await batchConversion.connect(owner).setUSDAddress(currencyManager.fromSymbol('USD')!.hash);
+    await batchConversion.connect(owner).setBatchFeeAmountUSDLimit(300); // * 1_000_000_000_000_000_000);
 
     // ----------------------------------
     console.log('Contracts deployed');
diff --git a/packages/smart-contracts/src/contracts/BatchConversionPayments.sol b/packages/smart-contracts/src/contracts/BatchConversionPayments.sol
@@ -3,6 +3,7 @@ pragma solidity ^0.8.4;
 
 import './interfaces/IERC20ConversionProxy.sol';
 import './interfaces/IEthConversionProxy.sol';
+import './ChainlinkConversionPath.sol';
 import './BatchNoConversionPayments.sol';
 
 /**
@@ -24,9 +25,13 @@ contract BatchConversionPayments is BatchNoConversionPayments {
 
   IERC20ConversionProxy public paymentErc20ConversionProxy;
   IEthConversionProxy public paymentEthConversionProxy;
+  ChainlinkConversionPath public chainlinkConversionPath;
 
   uint256 public batchConversionFee;
 
+  uint256 public batchFeeAmountUSDLimit; // maybe not necessary
+  address public USDAddress;
+
   /**
    * @dev All the information of a request, except the feeAddress
    *   _recipient Recipient address of the payment
@@ -57,6 +62,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
     uint256[] amounts;
     bytes[] paymentReferences;
     uint256[] feeAmounts;
+    //address[][] pathsToUSD; // TODO is there another solution ?
   }
 
   /**
@@ -76,17 +82,20 @@ 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 _owner Owner of the contract.
    */
   constructor(
     address _paymentErc20Proxy,
     address _paymentEthProxy,
     address _paymentErc20ConversionProxy,
     address _paymentEthConversionFeeProxy,
+    address _chainlinkConversionPathAddress,
     address _owner
   ) BatchNoConversionPayments(_paymentErc20Proxy, _paymentEthProxy, _owner) {
     paymentErc20ConversionProxy = IERC20ConversionProxy(_paymentErc20ConversionProxy);
     paymentEthConversionProxy = IEthConversionProxy(_paymentEthConversionFeeProxy);
+    chainlinkConversionPath = ChainlinkConversionPath(_chainlinkConversionPathAddress);
     batchConversionFee = 0;
   }
 
@@ -99,16 +108,29 @@ contract BatchConversionPayments is BatchNoConversionPayments {
    * - batchEthPayments, paymentNetworkId=3
    * - batchEthConversionPayments, paymentNetworkId=4
    * If metaDetails use paymentNetworkId = 4, it must be at the end of the list, or the transaction can be reverted
+   * @param pathsToUSD The list of paths into USD for every token, used to limit the batch fees, caution,
+                       Caution, the calculation of batchFeeAmountUSD which allows to limit the batch fees takes only 
+                       into consideration these paths. Without paths, there is not limitation.
    * @param _feeAddress The address where fees should be paid
    * @dev batchRouter only reduces gas consumption when using more than a single payment network.
    *      For single payment network payments, it is more efficient to use the suited batch function.
    */
-  function batchRouter(MetaDetail[] calldata metaDetails, address _feeAddress) external payable {
+  function batchRouter(
+    MetaDetail[] calldata metaDetails,
+    address[][] calldata pathsToUSD,
+    address _feeAddress
+  ) external payable {
     require(metaDetails.length < 6, 'more than 5 metaDetails');
+    uint256 batchFeeAmountUSD = 0;
     for (uint256 i = 0; i < metaDetails.length; i++) {
       MetaDetail calldata metaConversionDetail = metaDetails[i];
       if (metaConversionDetail.paymentNetworkId == 0) {
-        batchMultiERC20ConversionPayments(metaConversionDetail.conversionDetails, _feeAddress);
+        batchFeeAmountUSD = batchMultiERC20ConversionPayments(
+          metaConversionDetail.conversionDetails,
+          batchFeeAmountUSD,
+          pathsToUSD,
+          _feeAddress
+        );
       } else if (metaConversionDetail.paymentNetworkId == 1) {
         batchERC20Payments(
           metaConversionDetail.cryptoDetails.tokenAddresses[0],
@@ -154,12 +176,15 @@ contract BatchConversionPayments is BatchNoConversionPayments {
    * @notice Send a batch of ERC20 payments with amounts based on a request
    * currency (e.g. fiat), with fees and paymentReferences to multiple accounts, with multiple tokens.
    * @param conversionDetails list of requestInfo, each one containing all the information of a request
+   * @param pathsToUSD The list of paths into USD for every token
    * @param _feeAddress The fee recipient
    */
   function batchMultiERC20ConversionPayments(
     ConversionDetail[] calldata conversionDetails,
+    uint256 batchFeeAmountUSD,
+    address[][] calldata pathsToUSD,
     address _feeAddress
-  ) public {
+  ) public returns (uint256) {
     // a list of unique tokens, with the sum of maxToSpend by token
     Token[] memory uTokens = new Token[](conversionDetails.length);
     for (uint256 i = 0; i < conversionDetails.length; i++) {
@@ -237,16 +262,23 @@ contract BatchConversionPayments is BatchNoConversionPayments {
         requestedToken.safeTransfer(msg.sender, excessAmount);
       }
 
+      uint256 batchFeeToPay = ((uTokens[k].amountAndFee - excessAmount) * batchConversionFee) /
+        tenThousand;
+
+      (batchFeeToPay, batchFeeAmountUSD) = calculateBatchFeeToPay(
+        batchFeeToPay,
+        uTokens[k].tokenAddress,
+        batchFeeAmountUSD,
+        pathsToUSD
+      );
+
       // Payer pays the exact batch fees amount
       require(
-        safeTransferFrom(
-          uTokens[k].tokenAddress,
-          _feeAddress,
-          ((uTokens[k].amountAndFee - excessAmount) * batchConversionFee) / tenThousand
-        ),
+        safeTransferFrom(uTokens[k].tokenAddress, _feeAddress, batchFeeToPay),
         'batch fee transferFrom() failed'
       );
     }
+    return batchFeeAmountUSD;
   }
 
   /**
@@ -295,6 +327,34 @@ contract BatchConversionPayments is BatchNoConversionPayments {
     payerAuthorized = false;
   }
 
+  function calculateBatchFeeToPay(
+    uint256 batchFeeToPay,
+    address tokenAddress,
+    uint256 batchFeeAmountUSD,
+    address[][] calldata pathsToUSD
+  ) internal view returns (uint256, uint256) {
+    if (pathsToUSD.length > 0) {
+      for (uint256 i = 0; i < pathsToUSD.length; i++) {
+        if (
+          pathsToUSD[i][0] == tokenAddress && pathsToUSD[i][pathsToUSD[i].length - 1] == USDAddress
+        ) {
+          uint256 conversionUSD = 0;
+          (conversionUSD, ) = chainlinkConversionPath.getConversion(batchFeeToPay, pathsToUSD[i]);
+          // calculate the batch fee to pay, taking care of the batchFeeAmountUSDLimit
+          uint256 conversionToPayUSD = conversionUSD;
+          if (batchFeeAmountUSD + conversionToPayUSD > batchFeeAmountUSDLimit) {
+            conversionToPayUSD = batchFeeAmountUSDLimit - batchFeeAmountUSD;
+            batchFeeToPay = (batchFeeToPay * conversionToPayUSD) / conversionUSD;
+          }
+          batchFeeAmountUSD += conversionToPayUSD;
+          // add only once the fees
+          break;
+        }
+      }
+    }
+    return (batchFeeToPay, batchFeeAmountUSD);
+  }
+
   /*
    * Admin functions to edit the conversion proxies address and fees
    */
@@ -322,4 +382,20 @@ 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 address of the conversion path contract
+   */
+  function setConversionPathAddress(address _chainlinkConversionPathAddress) external onlyOwner {
+    chainlinkConversionPath = ChainlinkConversionPath(_chainlinkConversionPathAddress);
+  }
+
+  function setUSDAddress(address _USDAddress) external onlyOwner {
+    USDAddress = _USDAddress;
+  }
+
+  function setBatchFeeAmountUSDLimit(uint256 _batchFeeAmountUSDLimit) external onlyOwner {
+    batchFeeAmountUSDLimit = _batchFeeAmountUSDLimit;
+  }
 }
diff --git a/packages/smart-contracts/src/lib/artifacts/BatchConversionPayments/0.1.0.json b/packages/smart-contracts/src/lib/artifacts/BatchConversionPayments/0.1.0.json
@@ -22,6 +22,11 @@
           "name": "_paymentEthConversionFeeProxy",
           "type": "address"
         },
+        {
+          "internalType": "address",
+          "name": "_chainlinkConversionPathAddress",
+          "type": "address"
+        },
         {
           "internalType": "address",
           "name": "_owner",
@@ -50,6 +55,19 @@
       "name": "OwnershipTransferred",
       "type": "event"
     },
+    {
+      "inputs": [],
+      "name": "USDAddress",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "batchConversionFee",
@@ -202,6 +220,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "batchFeeAmountUSDLimit",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [
         {
@@ -246,6 +277,11 @@
           "name": "conversionDetails",
           "type": "tuple[]"
         },
+        {
+          "internalType": "address[][]",
+          "name": "pathsToUSD",
+          "type": "address[][]"
+        },
         {
           "internalType": "address",
           "name": "_feeAddress",
@@ -383,6 +419,11 @@
           "name": "metaDetails",
           "type": "tuple[]"
         },
+        {
+          "internalType": "address[][]",
+          "name": "pathsToUSD",
+          "type": "address[][]"
+        },
         {
           "internalType": "address",
           "name": "_feeAddress",
@@ -394,6 +435,19 @@
       "stateMutability": "payable",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "chainlinkConversionPath",
+      "outputs": [
+        {
+          "internalType": "contract ChainlinkConversionPath",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "owner",
@@ -492,6 +546,32 @@
       "stateMutability": "nonpayable",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "_batchFeeAmountUSDLimit",
+          "type": "uint256"
+        }
+      ],
+      "name": "setBatchFeeAmountUSDLimit",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_chainlinkConversionPathAddress",
+          "type": "address"
+        }
+      ],
+      "name": "setConversionPathAddress",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [
         {
@@ -544,6 +624,19 @@
       "stateMutability": "nonpayable",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_USDAddress",
+          "type": "address"
+        }
+      ],
+      "name": "setUSDAddress",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [
         {
diff --git a/packages/smart-contracts/test/contracts/BatchConversionPayments.test.ts b/packages/smart-contracts/test/contracts/BatchConversionPayments.test.ts
