[VEN-3338] SingleTokenConverter whitelisted assets

contracts/TokenConverter/SingleTokenConverter.sol

@@ -18,6 +18,10 @@ contract SingleTokenConverter is AbstractTokenConverter {
     /// @notice Address of the base asset token
     address public baseAsset;
 
+    /// @notice The mapping contains the assets which are sent to destination directly
+    /// @dev Asset -> bool(should transfer directly on true)
+    mapping(address => bool) public assetsDirectTransfer;
+
     /// @notice Emitted when base asset is updated
     event BaseAssetUpdated(address indexed oldBaseAsset, address indexed newBaseAsset);
 
@@ -29,6 +33,20 @@ contract SingleTokenConverter is AbstractTokenConverter {
         uint256 amount
     );
 
+    /// @notice Emitted after the assetsDirectTransfer mapping is updated
+    event AssetsDirectTransferUpdated(address indexed receiver, address indexed asset, bool value);
+
+    /// @notice Thrown when the base asset is the same as the new base asset
+    error SameBaseAssetNotAllowed();
+
+    /// @notice Thrown if someone tries to add `baseAssets` to the `assetsDirectTransfer` collection
+    error DirectTransferBaseAssetNotAllowed();
+
+    /// @notice Thrown when the `assetsDirectTransfer[asset]` is already `value`
+    /// @param asset The asset address whose `assetDirectTransfer` value went to be set
+    /// @param value The value to be set
+    error SameAssetDirectTransferNotAllowed(address asset, bool value);
+
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
         // Note that the contract is upgradeable. Use initialize() or reinitializers
@@ -56,11 +74,25 @@ contract SingleTokenConverter is AbstractTokenConverter {
 
     /// @notice Sets the base asset for the contract
     /// @param baseAsset_ The new address of the base asset
+    /// @custom:error ZeroAddressNotAllowed is thrown when address is zero
+    /// @custom:error SameBaseAssetNotAllowed is thrown when `baseAsset_` is equal to the current base asset
+    /// @custom:event BaseAssetUpdated is emitted on success
     /// @custom:access Only Governance
     function setBaseAsset(address baseAsset_) external onlyOwner {
         _setBaseAsset(baseAsset_);
     }
 
+    /// @notice Update the assetsDirectTransfer mapping
+    /// @param assets Addresses of the assets need to be added or removed for direct transfer
+    /// @param values Boolean value to indicate whether direct transfer is allowed for each asset.
+    /// @custom:event AssetsDirectTransferUpdated emits on success
+    /// @custom:error InputLengthMisMatch thrown when assets and values array lengths don't match
+    /// @custom:access Restricted by ACM
+    function setAssetsDirectTransfer(address[] calldata assets, bool[] calldata values) external virtual {
+        _checkAccessAllowed("setAssetsDirectTransfer(address[],bool[])");
+        _setAssetsDirectTransfer(assets, values);
+    }
+
     /// @notice Get the balance for specific token
     /// @param tokenAddress Address of the token
     /// @return tokenBalance Balance of the token the contract has
@@ -69,16 +101,18 @@ contract SingleTokenConverter is AbstractTokenConverter {
         tokenBalance = token.balanceOf(address(this));
     }
 
+    /// @dev It returns the balance of the `asset` in this contract. If `asset` is the `baseAsset`
+    /// or `assetsDirectTransfer[asset]` is true, then the balance of `asset` in this contract will
+    /// be transferred to the `destinationAddress` and 0 will be returned
     /// @param comptroller Comptroller address (pool)
     /// @param asset Asset address.
     /// @return balanceLeft Amount of asset, for _privateConversion
-    // solhint-disable-next-line
     function _updateAssetsState(address comptroller, address asset) internal override returns (uint256 balanceLeft) {
         IERC20Upgradeable token = IERC20Upgradeable(asset);
         uint256 balance = token.balanceOf(address(this));
         balanceLeft = balance;
 
-        if (asset == baseAsset) {
+        if (asset == baseAsset || assetsDirectTransfer[asset]) {
             balanceLeft = 0;
             token.safeTransfer(destinationAddress, balance);
             emit AssetTransferredToDestination(destinationAddress, comptroller, asset, balance);
@@ -109,12 +143,47 @@ contract SingleTokenConverter is AbstractTokenConverter {
         }
     }
 
+    /// @dev Update the assetsDirectTransfer mapping for destinationAddress
+    /// @param assets Addresses of the assets need to be added or removed for direct transfer
+    /// @param values Boolean value to indicate whether direct transfer is allowed for each asset.
+    /// @custom:event AssetsDirectTransferUpdated emits on success
+    /// @custom:error InputLengthMisMatch thrown when assets and values array lengths don't match
+    /// @custom:error DirectTransferBaseAssetNotAllowed thrown when an asset in `assets` is the `baseAsset`
+    /// @custom:error SameAssetDirectTransferNotAllowed thrown when the value to set for an asset doesn't differs
+    /// from its current value
+    function _setAssetsDirectTransfer(address[] calldata assets, bool[] calldata values) internal {
+        uint256 assetsLength = assets.length;
+
+        if (assetsLength != values.length) {
+            revert InputLengthMisMatch();
+        }
+
+        for (uint256 i; i < assetsLength; ++i) {
+            if (assets[i] == baseAsset) {
+                revert DirectTransferBaseAssetNotAllowed();
+            }
+
+            if (assetsDirectTransfer[assets[i]] == values[i]) {
+                revert SameAssetDirectTransferNotAllowed(assets[i], values[i]);
+            }
+
+            assetsDirectTransfer[assets[i]] = values[i];
+            emit AssetsDirectTransferUpdated(destinationAddress, assets[i], values[i]);
+        }
+    }
+
     /// @dev Sets the base asset for the contract
     /// @param baseAsset_ The new address of the base asset
     /// @custom:error ZeroAddressNotAllowed is thrown when address is zero
+    /// @custom:error SameBaseAssetNotAllowed is thrown when `baseAsset_` is equal to the current base asset
     /// @custom:event BaseAssetUpdated is emitted on success
     function _setBaseAsset(address baseAsset_) internal {
         ensureNonzeroAddress(baseAsset_);
+
+        if (baseAsset == baseAsset_) {
+            revert SameBaseAssetNotAllowed();
+        }
+
         emit BaseAssetUpdated(baseAsset, baseAsset_);
         baseAsset = baseAsset_;
     }

deploy/006-update-single-token-converter-implementation.ts

@@ -0,0 +1,21 @@
+import { DeployFunction } from "hardhat-deploy/types";
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy } = deployments;
+  const { deployer } = await getNamedAccounts();
+
+  await deploy("SingleTokenConverterImp", {
+    contract: "SingleTokenConverter",
+    from: deployer,
+    args: [],
+    log: true,
+    autoMine: true,
+    skipIfAlreadyDeployed: false,
+  });
+};
+
+func.tags = ["SingleTokenConverterImpl"];
+
+export default func;

hardhat.config.ts

@@ -1,9 +1,8 @@
 import "module-alias/register";
 
 import "@nomicfoundation/hardhat-chai-matchers";
-import "@nomicfoundation/hardhat-toolbox";
 import "@nomiclabs/hardhat-ethers";
-import "@nomiclabs/hardhat-etherscan";
+import "@nomicfoundation/hardhat-verify";
 import "@openzeppelin/hardhat-upgrades";
 import "@typechain/hardhat";
 import dotenv from "dotenv";
@@ -254,57 +253,12 @@ const config: HardhatUserConfig = {
       accounts: DEPLOYER_PRIVATE_KEY ? [`0x${DEPLOYER_PRIVATE_KEY}`] : [],
     },
   },
+  sourcify: {
+    enabled: true,
+  },
   etherscan: {
-    apiKey: {
-      bscmainnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      bsctestnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      sepolia: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      ethereum: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      opbnbtestnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      opbnbmainnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      arbitrumsepolia: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      arbitrumone: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      opsepolia: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      opmainnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      basesepolia: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      basemainnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      unichainsepolia: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      unichainmainnet: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-      berachainbartio: ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
-    },
+    apiKey: process.env.ETHERSCAN_API_KEY || "ETHERSCAN_API_KEY",
     customChains: [
-      {
-        network: "bscmainnet",
-        chainId: 56,
-        urls: {
-          apiURL: "https://api.bscscan.com/api",
-          browserURL: "https://bscscan.com",
-        },
-      },
-      {
-        network: "bsctestnet",
-        chainId: 97,
-        urls: {
-          apiURL: "https://api-testnet.bscscan.com/api",
-          browserURL: "https://testnet.bscscan.com",
-        },
-      },
-      {
-        network: "sepolia",
-        chainId: 11155111,
-        urls: {
-          apiURL: "https://api-sepolia.etherscan.io/api",
-          browserURL: "https://sepolia.etherscan.io",
-        },
-      },
-      {
-        network: "ethereum",
-        chainId: 1,
-        urls: {
-          apiURL: "https://api.etherscan.io/api",
-          browserURL: "https://etherscan.io",
-        },
-      },
       {
         network: "opbnbtestnet",
         chainId: 5611,
@@ -321,22 +275,6 @@ const config: HardhatUserConfig = {
           browserURL: "https://opbnbscan.com/",
         },
       },
-      {
-        network: "arbitrumsepolia",
-        chainId: 421614,
-        urls: {
-          apiURL: `https://api-sepolia.arbiscan.io/api`,
-          browserURL: "https://sepolia.arbiscan.io/",
-        },
-      },
-      {
-        network: "arbitrumone",
-        chainId: 42161,
-        urls: {
-          apiURL: `https://api.arbiscan.io/api/`,
-          browserURL: "https://arbiscan.io/",
-        },
-      },
       {
         network: "opsepolia",
         chainId: 11155420,
@@ -345,30 +283,6 @@ const config: HardhatUserConfig = {
           browserURL: "https://sepolia-optimistic.etherscan.io/",
         },
       },
-      {
-        network: "opmainnet",
-        chainId: 10,
-        urls: {
-          apiURL: "https://api-optimistic.etherscan.io/api",
-          browserURL: "https://optimistic.etherscan.io/",
-        },
-      },
-      {
-        network: "basesepolia",
-        chainId: 84532,
-        urls: {
-          apiURL: "https://api-sepolia.basescan.org/api",
-          browserURL: "https://sepolia.basescan.org/",
-        },
-      },
-      {
-        network: "basemainnet",
-        chainId: 8453,
-        urls: {
-          apiURL: "https://api.basescan.org/api",
-          browserURL: "https://basescan.org/",
-        },
-      },
       {
         network: "unichainsepolia",
         chainId: 1301,

package.json

@@ -66,8 +66,7 @@
     "@matterlabs/hardhat-zksync-verify": "0.7.0",
     "@nomicfoundation/hardhat-chai-matchers": "^1.0.3",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.4",
-    "@nomicfoundation/hardhat-toolbox": "^2.0.0",
-    "@nomiclabs/hardhat-etherscan": "^3.0.3",
+    "@nomicfoundation/hardhat-verify": "^2.0.14",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^9.0.1",