Merge pull request #2 from Giveth/f_setup_tests_for_contract

test: add donation handler test cases

Author: divine-comedian

README.md

@@ -1,3 +1,103 @@
+# DonationHandler Smart Contract
+
+A flexible and secure smart contract system for handling both ETH and ERC20 token donations with support for single and batch transactions.
+
+## Overview
+
+The DonationHandler is an upgradeable smart contract that facilitates donations in both ETH and ERC20 tokens. It supports single donations as well as batch donations to multiple recipients, with optional data attachments for each transaction.
+
+### Key Features
+
+- **Multiple Asset Support**: Handle both ETH and ERC20 token donations
+- **Batch Processing**: Efficiently process multiple donations in a single transaction
+- **Upgradeable**: Uses OpenZeppelin's upgradeable contract pattern
+- **Security Features**: 
+  - Reentrancy protection
+  - Input validation
+  - Ownership controls
+  - Custom error handling
+
+### Core Functionality
+
+1. **ETH Donations**
+   - Single ETH donations via `donateETH()`
+   - Batch ETH donations via `donateManyETH()`
+   - Direct ETH transfers are prevented
+
+2. **ERC20 Donations**
+   - Single token donations via `donateERC20()`
+   - Batch token donations via `donateManyERC20()`
+   - Automatic allowance checking
+
+### Security Measures
+
+- ReentrancyGuard implementation
+- Input validation for array lengths
+- Zero address checks
+- Amount validation
+- ERC20 allowance verification
+- Custom error handling for better gas efficiency
+
+### Testing Coverage
+
+The contract includes comprehensive test coverage for:
+- Single ETH donations
+- Multiple ETH donations
+- Single ERC20 token donations
+- Multiple ERC20 token donations
+- Error cases and edge conditions
+- Direct ETH transfer prevention
+
+### Events
+
+```solidity
+event DonationMade(
+    address indexed recipientAddress,
+    uint256 amount,
+    address indexed tokenAddress,
+    bytes data
+);
+```
+
+### Custom Errors
+
+```solidity
+error InvalidInput();
+error InsufficientAllowance();
+```
+
+## Usage Examples
+
+### Making a Single ETH Donation
+```solidity
+// Donate 1 ETH to a recipient
+donationHandler.donateETH{value: 1 ether}(
+    recipientAddress,
+    1 ether,
+    "0x" // Optional data
+);
+```
+
+### Making Multiple ERC20 Donations
+```solidity
+// Batch donate tokens to multiple recipients
+donationHandler.donateManyERC20(
+    tokenAddress,
+    totalAmount,
+    recipientAddresses,
+    amounts,
+    data
+);
+```
+
+## Technical Requirements
+
+- Solidity ^0.8.0
+- OpenZeppelin Contracts (Upgradeable)
+- Foundry for testing and deployment
+
+---
+
 <img src="https://raw.githubusercontent.com/defi-wonderland/brand/v1.0.0/external/solidity-foundry-boilerplate-banner.png" alt="wonderland banner" align="center" />
 <br />
 

foundry.toml

@@ -9,7 +9,7 @@ multiline_func_header = 'params_first_multi'
 sort_imports = true
 
 [profile.default]
-solc_version = '0.8.23'
+solc = "0.8.23"
 libs = ['node_modules', 'lib']
 optimizer_runs = 10_000
 via_ir = true

package.json

@@ -12,7 +12,7 @@
   "scripts": {
     "build": "forge build",
     "build:optimized": "FOUNDRY_PROFILE=optimized forge build",
-    "coverage": "forge coverage --report summary --report lcov --match-path 'test/unit/*'",
+    "coverage": "forge coverage --ir-minimum --report summary --report lcov --match-path 'test/unit/*'",
     "deploy:mainnet": "bash -c 'source .env && forge script Deploy --rpc-url $MAINNET_RPC --account $MAINNET_DEPLOYER_NAME --broadcast --verify --chain mainnet -vvvvv'",
     "deploy:sepolia": "bash -c 'source .env && forge script Deploy --rpc-url $SEPOLIA_RPC --account $SEPOLIA_DEPLOYER_NAME --broadcast --verify --chain sepolia -vvvvv'",
     "lint:check": "yarn lint:sol && forge fmt --check",

src/contracts/DonationHandler.sol

@@ -14,7 +14,8 @@ contract DonationHandler is OwnableUpgradeable, ReentrancyGuardUpgradeable {
   /// @param recipientAddress The address of the recipient of the donation
   /// @param amount The amount of the donation
   /// @param tokenAddress The address of the token being donated
-  event DonationMade(address indexed recipientAddress, uint256 amount, address indexed tokenAddress);
+  /// @param data The data of the donation, including projectId
+  event DonationMade(address indexed recipientAddress, uint256 amount, address indexed tokenAddress, bytes data);
 
   // Custom errors
   /// @notice Error emitted when the input is invalid
@@ -67,6 +68,7 @@ contract DonationHandler is OwnableUpgradeable, ReentrancyGuardUpgradeable {
   /// @param requiredAmount The required amount of the allowance
   /// @param owner The owner of the token
   modifier checkERC20Allowance(address tokenAddress, uint256 requiredAmount, address owner) {
+    require(tokenAddress != ETH_TOKEN_ADDRESS, 'Invalid token address');
     uint256 allowance = IERC20(tokenAddress).allowance(owner, address(this));
     if (allowance < requiredAmount) {
       revert InsufficientAllowance();
@@ -106,6 +108,7 @@ contract DonationHandler is OwnableUpgradeable, ReentrancyGuardUpgradeable {
   /// @param amount The amount of the donation
   /// @param data The data of the donation
   function donateETH(address recipientAddress, uint256 amount, bytes calldata data) external payable nonReentrant {
+    require(msg.value == amount, 'Incorrect ETH amount sent');
     _handleETH(amount, recipientAddress, data);
   }
 
@@ -155,33 +158,35 @@ contract DonationHandler is OwnableUpgradeable, ReentrancyGuardUpgradeable {
     uint256 amount,
     bytes calldata data
   ) external nonReentrant checkERC20Allowance(tokenAddress, amount, msg.sender) {
-    require(tokenAddress != ETH_TOKEN_ADDRESS, 'Invalid token address');
     _handleERC20(tokenAddress, amount, recipientAddress, data);
   }
 
   // Internal functions
   /// @notice Handle a single ETH donation
   /// @param amount The amount of the donation
   /// @param recipientAddress The address of the recipient of the donation
-  function _handleETH(uint256 amount, address recipientAddress, bytes memory) internal {
+  function _handleETH(uint256 amount, address recipientAddress, bytes memory data) internal {
     // Interactions
+
+    if (recipientAddress == ETH_TOKEN_ADDRESS) revert InvalidInput();
+    if (amount == 0) revert InvalidInput();
     (bool success,) = recipientAddress.call{value: amount}('');
     require(success, 'ETH transfer failed');
     // Effects
-    emit DonationMade(recipientAddress, amount, ETH_TOKEN_ADDRESS);
+    emit DonationMade(recipientAddress, amount, ETH_TOKEN_ADDRESS, data);
   }
 
   /// @notice Handle a single ERC20 donation
   /// @param token The address of the token being donated
   /// @param amount The amount of the donation
   /// @param recipientAddress The address of the recipient of the donation
-  function _handleERC20(address token, uint256 amount, address recipientAddress, bytes memory) internal {
+  function _handleERC20(address token, uint256 amount, address recipientAddress, bytes memory data) internal {
     if (token == address(0) || recipientAddress == address(0)) revert InvalidInput();
     if (amount == 0) revert InvalidInput();
     bool success = IERC20(token).transferFrom(msg.sender, recipientAddress, amount);
     require(success, 'ERC20 transfer failed');
 
-    emit DonationMade(recipientAddress, amount, token);
+    emit DonationMade(recipientAddress, amount, token, data);
   }
 
   // Receive function to accept ETH