Merge pull request #108 from truthixify/feat/single-deposit-event-with-id

Feat: include depositId in depositAsset and emit single enriched DepositEvent

Author: JoE11-y

contracts/L1/src/MerkleManager.sol

@@ -42,8 +42,14 @@ contract MerkleManager {
      * @dev Appends a new deposit commitment to the tree.
      * Updates peaks, root, and mappings. Emits DepositHashAppended.
      * @param commitmentHash The hash of the deposit commitment to append.
+     * @return newRoot The updated MMR root hash after the commitment is appended.
+     * @return newLeavesCount The total number of deposit leaves after this append operation.
+     * @return elementCount The total number of elements in the MMR after this append operation (including non-leaf nodes).
      */
-    function appendDepositHash(bytes32 commitmentHash) internal {
+    function appendDepositHash(bytes32 commitmentHash)
+        internal
+        returns (bytes32 newRoot, uint256 newLeavesCount, uint256 elementCount)
+    {
         // Append element to the tree and retrieve updated peaks and root
         (uint256 nextElementsCount, bytes32 nextRootHash, bytes32[] memory nextPeaks) =
             StatelessMmr.appendWithPeaksRetrieval(commitmentHash, lastPeaks, lastElementsCount, lastRoot);
@@ -59,9 +65,9 @@ contract MerkleManager {
         uint256 mmrLeafIndex = leafCountToMmrIndex(leavesCount);
         commitmentHashToIndex[commitmentHash] = mmrLeafIndex + 1; // +1 to make it 1-based index
         leavesCount += 1;
-
-        // Emit event for the appended deposit
-        emit DepositHashAppended(leavesCount, commitmentHash, lastRoot, lastElementsCount);
+        newRoot = lastRoot;
+        newLeavesCount = leavesCount;
+        elementCount = lastElementsCount;
     }
 
     /**

contracts/L1/src/ZeroXBridgeL1.sol

@@ -72,7 +72,15 @@ contract ZeroXBridgeL1 is Ownable, Starknet, MerkleManager {
     event WhitelistEvent(address indexed token);
     event DewhitelistEvent(address indexed token);
     event DepositEvent(
-        address indexed token, AssetType assetType, uint256 amount, address indexed user, uint256 commitmentHash
+        uint256 depositId,
+        address indexed token,
+        AssetType assetType,
+        uint256 amount,
+        address indexed user,
+        uint256 nonce,
+        uint256 commitmentHash,
+        bytes32 newRoot,
+        uint256 elementCount
     );
     event TokenRegistered(bytes32 indexed assetKey, AssetType assetType, address tokenAddress);
     event UserRegistered(address indexed user, uint256 starknetPubKey);
@@ -182,7 +190,7 @@ contract ZeroXBridgeL1 is Ownable, Starknet, MerkleManager {
      * @param user The address that will receive the bridged tokens on L2
      * @return commitmentHash Returns the generated commitment hash for verification on L2
      */
-    function depositAsset(AssetType assetType, address tokenAddress, uint256 amount, address user)
+    function depositAsset(uint256 depositId, AssetType assetType, address tokenAddress, uint256 amount, address user)
         external
         payable
         returns (uint256)
@@ -228,13 +236,16 @@ contract ZeroXBridgeL1 is Ownable, Starknet, MerkleManager {
         nextDepositNonce[user] = nonce + 1;
 
         // Generate commitment hash
-        bytes32 commitmentHash = keccak256(abi.encodePacked(userRecord[user], usdVal, nonce, block.timestamp));
+        bytes32 commitmentHash =
+            keccak256(abi.encodePacked(depositId, userRecord[user], usdVal, nonce, block.timestamp));
 
         // Append to Merkle tree
-        appendDepositHash(commitmentHash);
+        (bytes32 newRoot, uint256 count, uint256 elementCount) = appendDepositHash(commitmentHash);
 
         // Emit deposit event
-        emit DepositEvent(tokenAddress, assetType, usdVal, user, uint256(commitmentHash));
+        emit DepositEvent(
+            depositId, tokenAddress, assetType, usdVal, user, nonce, uint256(commitmentHash), newRoot, elementCount
+        );
 
         return uint256(commitmentHash);
     }