add comment (#17116)

taikoxyz · May 13, 2024 · adf619a · adf619a
1 parent ff0fff1
commit adf619a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/protocol/contracts/bridge/IQuotaManager.sol b/packages/protocol/contracts/bridge/IQuotaManager.sol
@@ -6,6 +6,13 @@ pragma solidity 0.8.24;
 interface IQuotaManager {
     /// @notice Consumes a specific amount of quota for a given address.
     /// This function must revert if available quota is smaller than the given amount of quota.
+    ///
+    /// @dev Note that IQuotaManager is used by vaults and bridge, and should be registered in a
+    /// shared address manager on the L1, therefore, a registered IQuotaManager and its per-token
+    /// quota settings will be shared by all Taiko L2s. To enable a per-L2 quota, we need to modify
+    /// this function to:
+    ///  `function consumeQuota(uint256 _srcChainId, address _token, uint256 _amount) `
+    ///
     /// @param _token The token address. Ether is represented with address(0).
     /// @param _amount The amount of quota to consume.
     function consumeQuota(address _token, uint256 _amount) external;