feat(aggregation-mode): add setters and subscriptions to agg mode Payment Service (#2200)

Author: maximopalopoli

aggregation_mode/batcher/abi/AggregationModePaymentService.json

@@ -11,12 +11,23 @@ contract AggregationModePaymentServiceDeployer is Script {
         string memory configData = vm.readFile(configPath);
 
         address owner = stdJson.readAddress(configData, ".permissions.paymentServiceOwner");
+        address recipient = stdJson.readAddress(configData, ".permissions.recipient");
+        uint256 amountToPay = stdJson.readUint(configData, ".amounts.amountToPayInWei");
+        uint256 paymentExpirationTimeSeconds = stdJson.readUint(configData, ".amounts.paymentExpirationTimeSeconds");
 
         vm.startBroadcast();
 
         AggregationModePaymentService implementation = new AggregationModePaymentService();
-        ERC1967Proxy proxy =
-            new ERC1967Proxy(address(implementation), abi.encodeWithSignature("initialize(address)", owner));
+        ERC1967Proxy proxy = new ERC1967Proxy(
+            address(implementation),
+            abi.encodeWithSignature(
+                "initialize(address,address,uint256,uint256)",
+                owner,
+                recipient,
+                amountToPay,
+                paymentExpirationTimeSeconds
+            )
+        );
 
         vm.stopBroadcast();
 

contracts/script/deploy/AggregationModePaymentServiceDeployer.s.sol

@@ -9,8 +9,13 @@
     "sp1AggregationProgramVKHash": "0x00d6e32a34f68ea643362b96615591c94ee0bf99ee871740ab2337966a4f77af",
     "risc0AggregationProgramImageId": "0x8908f01022827e80a5de71908c16ee44f4a467236df20f62e7c994491629d74c"
   },
+  "amounts": {
+    "amountToPayInWei": 1000000000000000000,
+    "paymentExpirationTimeSeconds": 86400
+  },
   "permissions": {
     "owner": "0x14dC79964da2C08b23698B3D3cc7Ca32193d9955",
-    "paymentServiceOwner": "0x14dC79964da2C08b23698B3D3cc7Ca32193d9955"
+    "paymentServiceOwner": "0x14dC79964da2C08b23698B3D3cc7Ca32193d9955",
+    "recipient": "0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f"
   }
 }

contracts/script/deploy/config/devnet/proof-aggregator-service.devnet.config.json

@@ -11,8 +11,14 @@ import {UUPSUpgradeable} from "@openzeppelin-upgrades/contracts/proxy/utils/UUPS
  * @notice Handles deposits that grant time-limited access to aggregation services.
  */
 contract AggregationModePaymentService is Initializable, OwnableUpgradeable, UUPSUpgradeable {
-    /// @notice for how much time the payment is valid in seconds (86400s = 24hs)
-    uint256 public constant PAYMENT_VALID_UNTIL_SECONDS = 86400;
+    /// @notice for how much time the payment is valid in seconds
+    uint256 public paymentExpirationTimeSeconds;
+
+    /// @notice The amount to pay for a subscription in wei.
+    uint256 public amountToPayInWei;
+
+    /// @notice The address where the payment funds will be sent.
+    address public paymentFundsRecipient;
 
     /**
      * @notice Emitted when a user deposits funds to purchase service time.
@@ -23,7 +29,24 @@ contract AggregationModePaymentService is Initializable, OwnableUpgradeable, UUP
      */
     event UserPayment(address user, uint256 indexed amount, uint256 indexed from, uint256 indexed until);
 
-    error InvalidDepositAmount(uint256 amount);
+    /// @notice Event emitted when the payment expiration time is updated
+    /// @param newExpirationTime the new expiration time in seconds
+    event PaymentExpirationTimeUpdated(uint256 indexed newExpirationTime);
+
+    /// @notice Event emitted when the amount to pay for subscription is updated
+    /// @param newAmountToPay the new amount to pay for a subscription in wei.
+    event AmountToPayUpdated(uint256 indexed newAmountToPay);
+
+    /// @notice Event emitted when the funds recipient is updated
+    /// @param newFundsRecipient the new address for receiving the funds on withdrawal.
+    event FundsRecipientUpdated(address indexed newFundsRecipient);
+
+    /// @notice Event emitted when the balance is withdrawn to the recipient address
+    /// @param recipient the address where the funds will be sent
+    /// @param amount the amont send to the recipient address
+    event FundsWithdrawn(address indexed recipient, uint256 amount);
+
+    error InvalidDepositAmount(uint256 amountReceived, uint256 amountRequired);
 
     /**
      * @notice Disables initializers for the implementation contract.
@@ -36,10 +59,14 @@ contract AggregationModePaymentService is Initializable, OwnableUpgradeable, UUP
      * @notice Initializes the contract and transfers ownership to the provided address.
      * @param _owner Address that becomes the contract owner.
      */
-    function initialize(address _owner) public initializer {
+    function initialize(address _owner, address _paymentFundsRecipient, uint256 _amountToPayInWei, uint256 _paymentExpirationTimeSeconds) public initializer {
         __Ownable_init();
         __UUPSUpgradeable_init();
         _transferOwnership(_owner);
+
+        paymentExpirationTimeSeconds = _paymentExpirationTimeSeconds;
+        amountToPayInWei = _amountToPayInWei;
+        paymentFundsRecipient = _paymentFundsRecipient;
     }
 
     /**
@@ -52,17 +79,55 @@ contract AggregationModePaymentService is Initializable, OwnableUpgradeable, UUP
         onlyOwner // solhint-disable-next-line no-empty-blocks
     {}
 
+    /**
+     * @notice Sets the new expiration time. Only callable by the owner
+     * @param newExpirationTimeInSeconds The new expiration time for the users payments in seconds.
+     */
+    function setPaymentExpirationTimeSeconds(uint256 newExpirationTimeInSeconds) public onlyOwner() {
+        paymentExpirationTimeSeconds = newExpirationTimeInSeconds;
+
+        emit PaymentExpirationTimeUpdated(newExpirationTimeInSeconds);
+    }
+
+    /**
+     * @notice Sets the new amount to pay. Only callable by the owner
+     * @param newRecipient The new address for receiving the funds on withdrawal.
+     */
+    function setFundsRecipientAddress(address newRecipient) public onlyOwner() {
+        paymentFundsRecipient = newRecipient;
+
+        emit FundsRecipientUpdated(newRecipient);
+    }
+
+    /**
+     * @notice Sets the new amount to pay. Only callable by the owner
+     * @param newAmountToPay The new amount to pay for subscription in wei.
+     */
+    function setAmountToPay(uint256 newAmountToPay) public onlyOwner() {
+        amountToPayInWei = newAmountToPay;
+
+        emit AmountToPayUpdated(newAmountToPay);
+    }
+
     /**
      * @notice Accepts payments and validates they meet the minimum requirement.
      */
     receive() external payable {
         uint256 amount = msg.value;
 
-        // 1 eth
-        if (amount < 1000000000000000000) {
-            revert InvalidDepositAmount(amount);
+        if (amount < amountToPayInWei) {
+            revert InvalidDepositAmount(amount, amountToPayInWei);
         }
 
-        emit UserPayment(msg.sender, amount, block.timestamp, block.timestamp + PAYMENT_VALID_UNTIL_SECONDS);
+        emit UserPayment(msg.sender, amount, block.timestamp, block.timestamp + paymentExpirationTimeSeconds);
+    }
+
+    /**
+     * @notice Withdraws the contract balance to the recipient address.
+     */
+    function withdraw() external onlyOwner {
+        uint256 balance = address(this).balance;
+        payable(paymentFundsRecipient).transfer(balance);
+        emit FundsWithdrawn(paymentFundsRecipient, balance);
     }
 }