fix: add comments

Author: bayram98

contracts/MultiSender.sol

@@ -1,65 +1,82 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
+// Import required modules
 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
+// Define the contract
 contract MultiSender is Initializable {
+    // Initialize the contract
     function initialize() public initializer {}
 
+    // Event definitions
     event SendETH(address token, address[] recipients, uint256[] amounts);
     event SendERC20(address token, address[] recipients, uint256[] amounts);
 
+    // Function to send ETH to multiple recipients
     function sendETH(
         address[] calldata _recipients,
         uint256[] calldata _amounts
     ) external payable {
+        // Check if the lengths of recipients and amounts arrays are equal
         require(
             _recipients.length == _amounts.length,
             "Must have the same length"
         );
 
+        // Calculate the total amount to be sent
         uint256 totalAmount = 0;
         for (uint256 i = 0; i < _amounts.length; i++) {
             totalAmount += _amounts[i];
         }
 
+        // Check if the sender has enough ETH
         require(msg.value >= totalAmount, "Not enough ETH");
 
-        // Send ETH
+        // Send ETH to recipients
         for (uint256 i = 0; i < _recipients.length; i++) {
             payable(_recipients[i]).transfer(_amounts[i]);
         }
 
+        // Emit the SendETH event
         emit SendETH(address(0), _recipients, _amounts);
     }
 
+    // Function to send ERC20 tokens to multiple recipients
     function sendERC20(
         address _token,
         address[] calldata _recipients,
         uint256[] calldata _amounts
     ) external payable {
+        // Check if the lengths of recipients and amounts arrays are equal
         require(
             _recipients.length == _amounts.length,
             "Must have the same length"
         );
 
+        // Calculate the total amount to be sent
         uint256 totalAmount = 0;
         for (uint256 i = 0; i < _amounts.length; i++) {
             totalAmount += _amounts[i];
         }
 
+        // Create an instance of the ERC20 token contract
         IERC20Upgradeable token = IERC20Upgradeable(_token);
+
+        // Check if the sender has enough tokens
         require(
             token.balanceOf(msg.sender) >= totalAmount,
             "Not enough tokens"
         );
 
-        // Send ERC20 tokens
+        // Send tokens to each recipient
         for (uint256 i = 0; i < _recipients.length; i++) {
             token.transferFrom(msg.sender, _recipients[i], _amounts[i]);
         }
+
+        // Emit the SendERC20 event
         emit SendERC20(_token, _recipients, _amounts);
     }
 }

scripts/deploy.ts

@@ -1,6 +1,7 @@
-import { ethers, run } from 'hardhat';
+import { ethers } from 'hardhat';
 
 async function main() {
+	// Get the first signer from
   const [deployer] = await ethers.getSigners();
 
   console.log(
@@ -10,9 +11,11 @@ async function main() {
 
   console.log("Account balance:", (await deployer.getBalance()).toString());
 
+	// Get the contract factory for the MultiSender contract
   const MultiSender = await ethers.getContractFactory("MultiSender");
+	
+	// Deploy the MultiSender contract
   const multiSender = await MultiSender.deploy();
-
   await multiSender.deployed();
 
   console.log("MultiSender contract deployed to:", multiSender.address);

scripts/sendERC20.ts

@@ -1,17 +1,22 @@
 import { ethers } from 'hardhat';
 
-const deployedMultiSender = '0x8161Bc94E430C246bF8CbE9a1d45Ad082df82065'
+// Replace with the actual contract address
+const deployedMultiSender = '0x8161Bc94E430C246bF8CbE9a1d45Ad082df82065' // MultiSender contract address
+// Replace with the actual token address, recipients and amounts
+const tokenAddress = "0xFF3Ef745D9878AfE5934Ff0b130868AFDDbc58e8"; // USDC Testnet Contract address
+const address1 = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266' // Recipient 1
+const address2 = '0x70997970C51812dc3A010C7d01b50e0d17dc79C8' // Recipient 2
 
 async function main() {
-  const multiSender = await ethers.getContractAt("MultiSender", deployedMultiSender);
+  // Get the first signer
   const [deployer] = await ethers.getSigners();
 
-  // Replace with the actual token address, recipients and amounts
-  const tokenAddress = "0xFF3Ef745D9878AfE5934Ff0b130868AFDDbc58e8"; // USDC Testnet
+  // read the deployed contract
+  const multiSender = await ethers.getContractAt("MultiSender", deployedMultiSender);
+  
+  // get the contract factory for the ERC20 token
   const token = await ethers.getContractAt("ERC20", tokenAddress);
-  // Replace with the actual recipients and amounts
-  const address1 = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
-  const address2 = '0x70997970C51812dc3A010C7d01b50e0d17dc79C8'
+  
   const recipients = [address1, address2];
   const amounts = [ethers.utils.parseUnits("1", 5), ethers.utils.parseUnits("2", 5)];
 

scripts/sendETH.ts

@@ -1,7 +1,9 @@
 import { ethers } from 'hardhat';
 
-const deployedMultiSender = '0x8161Bc94E430C246bF8CbE9a1d45Ad082df82065'
-
+const deployedMultiSender = '0x8161Bc94E430C246bF8CbE9a1d45Ad082df82065' // Deployed MultiSender contract address
+const address1 = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266' // Recipient 1
+const address2 = '0x70997970C51812dc3A010C7d01b50e0d17dc79C8' // Recipient 2
+  
 async function main() {
 
   // read the deployed contract
@@ -10,8 +12,6 @@ async function main() {
   console.log("MultiSender contract address:", multiSender.address);
 
   // Replace with the actual recipients and amounts
-  const address1 = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
-  const address2 = '0x70997970C51812dc3A010C7d01b50e0d17dc79C8'
   const recipients = [address1, address2];
   const amounts = [ethers.utils.parseEther("0.000001"), ethers.utils.parseEther("0.000002")];