chore(protocol-contracts): add decimals to mock ERC20 for registry tasks (#1642)

Author: melanciani

protocol-contracts/confidential-token-wrappers-registry/contracts/mocks/ERC20Mock.sol

@@ -4,16 +4,25 @@ pragma solidity ^0.8.20;
 import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
 contract ERC20Mock is ERC20 {
+    uint8 private immutable _decimals;
+
     error MintAmountExceedsMax(uint256 amount, uint256 maxAmount);
 
-    uint256 public constant MAX_MINT_AMOUNT = 1_000_000 * 10 ** 18;
+    uint256 public constant MAX_MINT_AMOUNT_TOKENS = 1_000_000;
 
-    constructor(string memory name_, string memory symbol_) ERC20(name_, symbol_) {}
+    constructor(string memory name_, string memory symbol_, uint8 decimals_) ERC20(name_, symbol_) {
+        _decimals = decimals_;
+    }
 
     function mint(address to, uint256 amount) external {
-        if (amount > MAX_MINT_AMOUNT) {
-            revert MintAmountExceedsMax(amount, MAX_MINT_AMOUNT);
+        uint256 maxMintAmount = MAX_MINT_AMOUNT_TOKENS * 10 ** decimals();
+        if (amount > maxMintAmount) {
+            revert MintAmountExceedsMax(amount, maxMintAmount);
         }
         _mint(to, amount);
     }
+
+    function decimals() public view virtual override returns (uint8) {
+        return _decimals;
+    }
 }

protocol-contracts/confidential-token-wrappers-registry/tasks/mocks/deployMocks.ts

@@ -1,18 +1,18 @@
-import { task } from 'hardhat/config';
+import { task, types } from 'hardhat/config';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 
 const ERC20_MOCK_CONTRACT_NAME = 'ERC20Mock';
 
 // Deploy the ERC20Mock contract
-async function deployERC20Mock(hre: HardhatRuntimeEnvironment, name: string, symbol: string) {
+async function deployERC20Mock(hre: HardhatRuntimeEnvironment, name: string, symbol: string, decimals: number) {
   const { getNamedAccounts, ethers, deployments, network } = hre;
   const { save, getArtifact } = deployments;
 
   const { deployer } = await getNamedAccounts();
   const deployerSigner = await ethers.getSigner(deployer);
 
   const factory = await ethers.getContractFactory(ERC20_MOCK_CONTRACT_NAME, deployerSigner);
-  const contract = await factory.deploy(name, symbol);
+  const contract = await factory.deploy(name, symbol, decimals);
   await contract.waitForDeployment();
 
   const contractAddress = await contract.getAddress();
@@ -40,14 +40,15 @@ async function deployERC20Mock(hre: HardhatRuntimeEnvironment, name: string, sym
 
 // Deploy the ERC20Mock contract
 // Example usage:
-// npx hardhat task:deployERC20Mock --name "Mock Token" --symbol "MTK" --network testnet
+// npx hardhat task:deployERC20Mock --name "Mock Token" --symbol "MTK" --decimals 18 --network testnet
 task('task:deployERC20Mock')
   .addParam('name', 'The name of the ERC20 token')
   .addParam('symbol', 'The symbol of the ERC20 token')
-  .setAction(async function ({ name, symbol }, hre) {
+  .addParam('decimals', 'The decimals of the ERC20 token', 18, types.int)
+  .setAction(async function ({ name, symbol, decimals }, hre) {
     console.log('Deploying ERC20Mock contract...\n');
 
-    await deployERC20Mock(hre, name, symbol);
+    await deployERC20Mock(hre, name, symbol, parseInt(decimals));
 
     console.log('✅ ERC20Mock contract deployed\n');
   });