[ETHEREUM-CONTRACTS] Dedicated allowlist contract for SuperApp registration

packages/ethereum-contracts/CHANGELOG.md

@@ -9,6 +9,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `SuperToken` now implements [EIP-2612](https://eips.ethereum.org/EIPS/eip-2612) (permit extension for EIP-20 signed approvals).
 - `SuperfluidPool` now has additional methods `increaseMemberUnits` and `decreaseMemberUnits` which allow the pool admin to change member units parameterized with delta amounts.
 
+### Changed
+- Curation of the SuperApp registration allowlist can now be delegated by governance to a newly added `ACL` contract.
+
 ### Breaking
 - `SuperfluidPool` does no longer mint and burn EIP-721 tokens (NFTs) on member unit updates. The gas overhead of this operation caused friction for integrations with other protocols (e.g. Uniswap V4).
 

packages/ethereum-contracts/contracts/interfaces/superfluid/ISuperfluid.sol

@@ -658,6 +658,12 @@ interface ISuperfluid {
     // solhint-disable func-name-mixedcase
     function getERC2771Forwarder() external view returns(address);
 
+    /**
+     * @dev returns the address of the ACL contract used for granular permissioning.
+     * @return address of the ACL contract
+     */
+    function getACL() external view returns(address);
+
     /**************************************************************************
      * Function modifiers for access control and parameter validations
      *

packages/ethereum-contracts/contracts/mocks/CFAAppMocks.t.sol

@@ -36,7 +36,7 @@ contract ExclusiveInflowTestApp is SuperAppBase {
             // | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
             ;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function afterAgreementCreated(
@@ -121,7 +121,7 @@ contract NonClosableOutflowTestApp is SuperAppBase {
             // | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
             ;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function setupOutflow(
@@ -210,7 +210,7 @@ contract SelfDeletingFlowTestApp is SuperAppBase {
             | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
             ;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function afterAgreementCreated(
@@ -267,7 +267,7 @@ contract ClosingOnUpdateFlowTestApp is SuperAppBase {
             | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
             ;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function afterAgreementUpdated(
@@ -326,7 +326,7 @@ contract FlowExchangeTestApp is SuperAppBase {
             | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
             ;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function afterAgreementCreated(

packages/ethereum-contracts/contracts/mocks/IDASuperAppTester.t.sol

@@ -26,7 +26,7 @@ contract IDASuperAppTester is ISuperApp {
         uint32 indexId)
     {
         _host = host;
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
         _ida = ida;
         _token = token;
         _indexId = indexId;

packages/ethereum-contracts/contracts/mocks/MultiFlowTesterApp.t.sol

@@ -41,7 +41,7 @@ contract MultiFlowTesterApp is SuperAppBase {
             SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP |
             SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP;
 
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
     }
 
     function _parseUserData(

packages/ethereum-contracts/contracts/mocks/StreamRedirector.t.sol

@@ -33,7 +33,7 @@ contract StreamRedirector is SuperAppBase {
         token = _token;
         receiver = _receiver;
 
-        host.registerAppWithKey(configWord, "");
+        host.registerApp(configWord);
     }
 
     /**

packages/ethereum-contracts/contracts/mocks/SuperAppMocks.t.sol

@@ -52,9 +52,9 @@ contract SuperAppMock is ISuperApp {
 
     constructor(ISuperfluid host, uint256 configWord, bool doubleRegistration) {
         _host = host;
-        _host.registerAppWithKey(configWord, "");
+        _host.registerApp(configWord);
         if (doubleRegistration) {
-            _host.registerAppWithKey(configWord, "");
+            _host.registerApp(configWord);
         }
         _aux = new SuperAppMockAux();
     }
@@ -472,7 +472,7 @@ contract SuperAppMockReturningEmptyCtx {
 
     constructor(ISuperfluid host) {
         _host = host;
-        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_FINAL, "");
+        _host.registerApp(SuperAppDefinitions.APP_LEVEL_FINAL);
     }
 
     function beforeAgreementCreated(
@@ -533,7 +533,7 @@ contract SuperAppMockReturningInvalidCtx {
 
     constructor(ISuperfluid host) {
         _host = host;
-        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_FINAL, "");
+        _host.registerApp(SuperAppDefinitions.APP_LEVEL_FINAL);
     }
 
     function afterAgreementCreated(
@@ -574,7 +574,7 @@ contract SuperAppMock2ndLevel {
 
     constructor(ISuperfluid host, SuperAppMock app, AgreementMock agreement) {
         _host = host;
-        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_SECOND, "");
+        _host.registerApp(SuperAppDefinitions.APP_LEVEL_SECOND);
         _app = app;
         _agreement = agreement;
     }
@@ -630,6 +630,6 @@ contract SuperAppMockNotSelfRegistering { }
 // Factory which allows anybody to deploy arbitrary contracts as app (do NOT allow this in a real factory!)
 contract SuperAppFactoryMock {
     function registerAppWithHost(ISuperfluid host, ISuperApp app, uint256 configWord) external {
-        host.registerAppByFactory(app, configWord);
+        host.registerApp(app, configWord);
     }
 }

packages/ethereum-contracts/contracts/mocks/SuperTokenLibraryV1Mock.t.sol

@@ -384,7 +384,7 @@ contract SuperTokenLibraryCFASuperAppMock is SuperAppBase {
             SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP |
             SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP;
 
-        host.registerAppWithKey(configWord, "");
+        host.registerApp(configWord);
     }
 
     function createFlow(ISuperToken token) external {

packages/ethereum-contracts/contracts/mocks/SuperfluidMock.t.sol

@@ -12,7 +12,7 @@ import { CallUtils } from "../libs/CallUtils.sol";
 contract SuperfluidUpgradabilityTester is Superfluid {
 
     // 3_000_000 is the min callback gas limit used in a prod deployment
-    constructor() Superfluid(false, false, 3_000_000, address(0), address(0))
+    constructor() Superfluid(false, false, 3_000_000, address(0), address(0), address(0))
     // solhint-disable-next-line no-empty-blocks
     {
     }
@@ -135,10 +135,12 @@ contract SuperfluidMock is Superfluid {
         bool appWhiteListingEnabled,
         uint64 callbackGasLimit,
         address simpleForwarderAddress,
-        address erc2771ForwarderAddress
+        address erc2771ForwarderAddress,
+        address allowListAddress
     )
         Superfluid(
-            nonUpgradable, appWhiteListingEnabled, callbackGasLimit, simpleForwarderAddress, erc2771ForwarderAddress
+            nonUpgradable, appWhiteListingEnabled, callbackGasLimit, simpleForwarderAddress, erc2771ForwarderAddress,
+            allowListAddress
         )
     // solhint-disable-next-line no-empty-blocks
     {

packages/ethereum-contracts/contracts/superfluid/Superfluid.sol

@@ -25,6 +25,7 @@ import { CallbackUtils } from "../libs/CallbackUtils.sol";
 import { BaseRelayRecipient } from "../libs/BaseRelayRecipient.sol";
 import { SimpleForwarder } from "../utils/SimpleForwarder.sol";
 import { ERC2771Forwarder } from "../utils/ERC2771Forwarder.sol";
+import { ACL } from "../utils/ACL.sol";
 
 /**
  * @dev The Superfluid host implementation.
@@ -59,6 +60,9 @@ contract Superfluid is
     SimpleForwarder immutable public SIMPLE_FORWARDER;
     ERC2771Forwarder immutable internal _ERC2771_FORWARDER;
 
+    // ACL (for superapp registration)
+    ACL immutable internal _ACL;
+
     /**
      * @dev Maximum number of level of apps can be composed together
      *
@@ -71,6 +75,8 @@ contract Superfluid is
 
     uint32 constant public MAX_NUM_AGREEMENTS = 256;
 
+    bytes32 constant public ACL_SUPERAPP_REGISTRATION_ROLE = keccak256("ACL_SUPERAPP_REGISTRATION_ROLE");
+
     /* WARNING: NEVER RE-ORDER VARIABLES! Always double-check that new
        variables are added APPEND-ONLY. Re-ordering variables can
        permanently BREAK the deployed proxy contract. */
@@ -105,13 +111,15 @@ contract Superfluid is
         bool appWhiteListingEnabled,
         uint64 callbackGasLimit,
         address simpleForwarderAddress,
-        address erc2771ForwarderAddress
+        address erc2771ForwarderAddress,
+        address aclAddress
     ) {
         NON_UPGRADABLE_DEPLOYMENT = nonUpgradable;
         APP_WHITE_LISTING_ENABLED = appWhiteListingEnabled;
         CALLBACK_GAS_LIMIT = callbackGasLimit;
         SIMPLE_FORWARDER = SimpleForwarder(simpleForwarderAddress);
         _ERC2771_FORWARDER = ERC2771Forwarder(erc2771ForwarderAddress);
+        _ACL = ACL(aclAddress);
     }
 
     ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -375,8 +383,16 @@ contract Superfluid is
         _registerApp(ISuperApp(msg.sender), configWord);
     }
 
-    // internally we keep using the gov config method with key
+    // Checks if the deployer account has permission to register SuperApps, reverts if not.
+    // New method: lookup in the ACL contract.
+    // Legacy/fallback method: lookup in the governance contract.
     function _enforceAppRegistrationPermissioning(string memory registrationKey, address deployer) internal view {
+        // new method: check if the deployer is granted permission in the ACL
+        if (_ACL.hasRole(ACL_SUPERAPP_REGISTRATION_ROLE, deployer)) {
+            return;
+        }
+
+        // legacy/fallback method: check if permission is given by gov
         bytes32 configKey = SuperfluidGovernanceConfigs.getAppRegistrationConfigKey(
             // solhint-disable-next-line avoid-tx-origin
             deployer,
@@ -958,6 +974,10 @@ contract Superfluid is
         return address(_ERC2771_FORWARDER);
     }
 
+    function getACL() external view override returns(address) {
+        return address(_ACL);
+    }
+
     /**************************************************************************
     * Internal
     **************************************************************************/

packages/ethereum-contracts/contracts/utils/ACL.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
+
+contract ACL is AccessControl {
+    constructor() {
+        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
+    }
+
+    /// Allows the default admin to set the admin role for a given role.
+    /// This gives the flexibility to set up sophisticated permissioning schemes in the future.
+    function setRoleAdmin(bytes32 role, bytes32 adminRole) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        _setRoleAdmin(role, adminRole);
+    }
+}

packages/ethereum-contracts/contracts/utils/SuperfluidFrameworkDeploymentSteps.t.sol

@@ -31,6 +31,7 @@ import { TOGA } from "./TOGA.sol";
 import { IResolver } from "../interfaces/utils/IResolver.sol";
 import { SimpleForwarder } from "../utils/SimpleForwarder.sol";
 import { ERC2771Forwarder } from "../utils/ERC2771Forwarder.sol";
+import { ACL } from "../utils/ACL.sol";
 import { MacroForwarder } from "../utils/MacroForwarder.sol";
 
 /// @title Superfluid Framework Deployment Steps
@@ -143,10 +144,11 @@ contract SuperfluidFrameworkDeploymentSteps {
         } else if (step == 1) { // CORE CONTRACT: Superfluid (Host)
             SimpleForwarder simpleForwarder = new SimpleForwarder();
             ERC2771Forwarder erc2771Forwarder = new ERC2771Forwarder();
+            ACL acl = new ACL();
             // Deploy Host and initialize the test governance.
             // 3_000_000 is the min callback gas limit used in a prod deployment
             host = SuperfluidHostDeployerLibrary.deploy(
-                true, false, 3_000_000, address(simpleForwarder), address(erc2771Forwarder)
+                true, false, 3_000_000, address(simpleForwarder), address(erc2771Forwarder), address(acl)
             );
             simpleForwarder.transferOwnership(address(host));
             erc2771Forwarder.transferOwnership(address(host));
@@ -319,12 +321,14 @@ library SuperfluidHostDeployerLibrary {
         bool _appWhiteListingEnabled,
         uint64 callbackGasLimit,
         address simpleForwarderAddress,
-        address erc2771ForwarderAddress
+        address erc2771ForwarderAddress,
+        address allowListAddress
     )
         external returns (Superfluid)
     {
         return new Superfluid(
-            _nonUpgradable, _appWhiteListingEnabled, callbackGasLimit, simpleForwarderAddress, erc2771ForwarderAddress
+            _nonUpgradable, _appWhiteListingEnabled, callbackGasLimit, simpleForwarderAddress, erc2771ForwarderAddress,
+            allowListAddress
         );
     }
 }