Merge pull request #75 from Merit-Systems/feat/memo-field

Add data field to batchDeposit

Author: shafu0x

broadcast/Deploy.Sepolia.sol/11155111/run-1744918968.json

@@ -36,7 +36,7 @@ interface IEscrow {
     event FeeRecipientSet          (address newFeeRecipient);
     event TokenWhitelisted         (address indexed token);
     event TokenRemovedFromWhitelist(address indexed token);
-    event BatchDeposited           (uint indexed batchId, uint repoId, uint timestamp, uint[] depositIds);
+    event BatchDeposited           (uint indexed batchId, uint[] depositIds, bytes data);
     event SignerSet                (address indexed newSigner);
     event BatchDepositLimitSet     (uint newLimit);
 
@@ -56,11 +56,10 @@ interface IEscrow {
     /**
      * @notice Allows batch creation of multiple deposits in a single transaction.
      * @param params An array of `DepositParams` structs for each deposit.
-     * @param repoId The ID of the repository.
-     * @param timestamp The timestamp of the batch deposit.
+     * @param data Arbitrary data to be stored with the batch deposit.
      * @return depositIds An array of newly assigned deposit IDs.
      */
-    function batchDeposit(DepositParams[] calldata params, uint repoId, uint timestamp) external returns (uint[] memory depositIds);
+    function batchDeposit(DepositParams[] calldata params, bytes calldata data) external returns (uint[] memory depositIds);
 
     /**
      * @notice Claims the tokens of a single deposit, if the caller is authorized by signature.

broadcast/Deploy.Sepolia.sol/11155111/run-1744920841.json

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: MIT
+pragma solidity =0.8.26;
+
+library DepositEncoder {
+    uint8 constant ENCODING_VERSION = 1;
+
+    enum DEPOSIT_TYPE {
+        REPO,
+        SOLO
+    }
+
+    function encode(
+        DEPOSIT_TYPE depositType,
+        uint64       repoId,
+        uint64       timestamp
+    ) internal pure returns (bytes memory) {
+        return abi.encode(ENCODING_VERSION, depositType, repoId, timestamp);
+    }
+}

broadcast/Deploy.Sepolia.sol/11155111/run-latest.json

@@ -2,9 +2,9 @@
 pragma solidity =0.8.26;
 
 library Params {
-    address constant MAINNET_USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
-    address constant OWNER        = 0x9d8A62f656a8d1615C1294fd71e9CFb3E4855A4F;
-    address constant SIGNER       = 0x9d8A62f656a8d1615C1294fd71e9CFb3E4855A4F;
+    address constant MAINNET_USDC     = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
+    address constant OWNER            = 0x9d8A62f656a8d1615C1294fd71e9CFb3E4855A4F;
+    address constant SIGNER           = 0x9d8A62f656a8d1615C1294fd71e9CFb3E4855A4F;
 
     uint    constant BATCH_DEPOSIT_LIMIT = 500;
 

interface/IEscrow.sol

@@ -5,6 +5,7 @@ import {Deploy} from "./Deploy.s.sol";
 import {Params} from "../libraries/Params.sol";	
 import {Script} from "forge-std/Script.sol";	
 import {Escrow} from "../src/Escrow.sol";
+import {console} from "forge-std/console.sol";
 
 contract DeployBase is Deploy {	
     function run() public returns (Escrow escrow) {	
@@ -18,5 +19,7 @@ contract DeployBase is Deploy {
             Params.BASE_FEE_BPS,
             Params.BATCH_DEPOSIT_LIMIT
         );	
+
+        console.log("Escrow deployed at:", address(escrow));
     }	
 }

libraries/Encoder.sol

@@ -7,6 +7,7 @@ import {MockERC20}      from "solmate/test/utils/mocks/MockERC20.sol";
 import {Script}         from "forge-std/Script.sol";
 import {CreatePayments} from "./utils/CreatePayments.s.sol";
 import {Escrow}         from "../src/Escrow.sol";
+import {DepositEncoder} from "../libraries/Encoder.sol";
 
 abstract contract DeployTestBase is Deploy {
     uint constant AMOUNT_TO_MINT = 100_000_000 * 10**6;
@@ -42,13 +43,15 @@ abstract contract DeployTestBase is Deploy {
         address sender,
         address recipient
     ) internal {
-        new CreatePayments().deploy(
+        new CreatePayments().createPayment(
             address(escrow),
             address(mockUSDC),
             5,
             100 * 10**6,
             sender,
-            recipient
+            recipient,
+            DepositEncoder.DEPOSIT_TYPE.REPO,
+            100
         );
     }
 }

libraries/Params.sol

@@ -1,39 +1,57 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.26;
 
-import {Deploy}    from "../Deploy.s.sol";
-import {Params}    from "../../libraries/Params.sol";
-import {MockERC20} from "solmate/test/utils/mocks/MockERC20.sol";
-import {Script} from "forge-std/Script.sol";
-import {DepositParams} from "../../src/Escrow.sol";
-import {Escrow} from "../../src/Escrow.sol";
+import {Deploy}         from "../Deploy.s.sol";
+import {Params}         from "../../libraries/Params.sol";
+import {MockERC20}      from "solmate/test/utils/mocks/MockERC20.sol";
+import {Script}         from "forge-std/Script.sol";
+import {DepositParams}  from "../../src/Escrow.sol";
+import {Escrow}         from "../../src/Escrow.sol";
+import {DepositEncoder} from "../../libraries/Encoder.sol";
 
 contract CreatePayments is Script {
     // NOTE: You need to change these values before running this script
     uint    constant NUMBER_OF_DEPOSITS = 5;
     uint    constant AMOUNT_PER_DEPOSIT = 100 * 10**6;
     address constant ESCROW_ADDRESS     = 0x18578b0168D940623b89Dd0Be880fF994305Fd7e;
     address constant TOKEN              = 0x883066fabE2CC5b8f5dC626bF2eb47C6FBD4BE03;
-    uint    constant REPO_ID            = 1234;
+    uint64  constant REPO_ID            = 1234;
 
     function run() public {
-      deploy(
+      // Create repo payment
+      createPayment(
         ESCROW_ADDRESS,
         TOKEN,
         NUMBER_OF_DEPOSITS,
         AMOUNT_PER_DEPOSIT,
         Params.SEPOLIA_TESTER_SHAFU,
-        Params.SEPOLIA_TESTER_JSON
-        );
+        Params.SEPOLIA_TESTER_JSON,
+        DepositEncoder.DEPOSIT_TYPE.REPO,
+        REPO_ID
+      );
+
+      // Create solo payment
+      createPayment(
+        ESCROW_ADDRESS,
+        TOKEN,
+        1, // Solo payments have exactly one deposit
+        AMOUNT_PER_DEPOSIT,
+        Params.SEPOLIA_TESTER_SHAFU,
+        Params.SEPOLIA_TESTER_JSON,
+        DepositEncoder.DEPOSIT_TYPE.SOLO,
+        0 // Solo payments use repo ID 0
+      );
     }
 
-    function deploy(
+    function createPayment(
         address escrowAddress,
         address token,
         uint256 numberOfDeposits,
         uint256 amountPerDeposit,
         address sender,
-        address recipient
+        address recipient,
+        DepositEncoder.DEPOSIT_TYPE depositType,
+        uint64 repoId
     ) public {
       MockERC20 mockUSDC = MockERC20(token);
       Escrow    escrow   = Escrow(escrowAddress);
@@ -54,9 +72,13 @@ contract CreatePayments is Script {
 
       mockUSDC.mint(sender, amountPerDeposit * numberOfDeposits);
       mockUSDC.approve(address(escrow), amountPerDeposit * numberOfDeposits);
-      escrow.batchDeposit(depositParams, REPO_ID, block.timestamp);
+      bytes memory data = DepositEncoder.encode(    
+            depositType,
+            repoId,
+            uint64(block.timestamp)
+      );
+      escrow.batchDeposit(depositParams, data);
 
       vm.stopBroadcast();
-        
     }
 }

script/Deploy.Base.s.sol

@@ -44,7 +44,7 @@ contract DeploySepolia is Script {
             mockUSDC.approve(address(escrow), totalAmount);
 
             uint256 gasBefore = gasleft();
-            escrow.batchDeposit(depositParams, 1, block.timestamp);
+            escrow.batchDeposit(depositParams, abi.encode(1, block.timestamp));
             uint256 gasAfter = gasleft();
             console.log("Gas used for %d deposits:", numDeposits, gasBefore - gasAfter);
         }