fei-protocol · thomas-waite · Apr 25, 2022 · Apr 2, 2022 · Apr 2, 2022 · Apr 3, 2022
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,11 @@
+1. Do not use optimistic timelock - use the raw OZ timelock
+2. Combine/aggregate some of the pod specific roles
+3. Allow Orca pods to be created without a timelock
+4. If min delay is defined on an orca pod, enforce a limit
+5. Remove podAdminGateway migration concept from admin. Admin will be fixed (the migrated admin will lose timelock proposer/cancel access)
+6. Prefix all internal methods with `_`
+7. Remove burner function for pod creation. Just create inside constructor
+8. Find way to stop DAO proposal being bricked by podId changing underfoot
+9. DAO vote to migrate all roles
+
+No orca controller upgrade functionality
diff --git a/contracts/core/TribeRoles.sol b/contracts/core/TribeRoles.sol
@@ -86,11 +86,6 @@ library TribeRoles {
     /*///////////////////////////////////////////////////////////////
                                  Minor Roles
     //////////////////////////////////////////////////////////////*/
-
-    /// @notice capable of deploying optimistic governance pods
-    bytes32 internal constant POD_DEPLOYER_ROLE =
-        keccak256("POD_DEPLOYER_ROLE");
-
     bytes32 internal constant POD_METADATA_REGISTER_ROLE =
         keccak256("POD_METADATA_REGISTER_ROLE");
 

diff --git a/contracts/dao/timelock/OptimisticTimelock.sol b/contracts/dao/timelock/OptimisticTimelock.sol
@@ -26,7 +26,6 @@ contract OptimisticTimelock is TimelockController, CoreRef {
 
         In addition it allows for much more granular and flexible access for multisig operators
     */
-    // Guardian can become admin on every Optimistic timelock and effetively become 
     function becomeAdmin() public onlyGuardianOrGovernor {
         this.grantRole(TIMELOCK_ADMIN_ROLE, msg.sender);
     }

diff --git a/contracts/pods/PodAdminGateway.sol b/contracts/pods/PodAdminGateway.sol
@@ -18,132 +18,54 @@ import {IPodFactory} from "./interfaces/IPodFactory.sol";
 ///     2. Removing a member from a pod
 ///     3. Transferring a pod member
 ///     4. Toggling a pod membership transfer switch
+///     5. Vetoing a pod proposal
 contract PodAdminGateway is CoreRef, IPodAdminGateway {
     /// @notice Pod factory which creates optimistic pods and acts as a source of information
-    IPodFactory private immutable podFactory;
-
-    constructor(address _core, address _podFactory) CoreRef(_core) {
+    MemberToken public immutable memberToken;
+
+    /// @notice Pod controller for the pods
+    ControllerV1 public immutable podController;
+
+    /// @notice Pod factory
+    IPodFactory public immutable podFactory;
+
+    constructor(
+        address _core,
+        address _memberToken,
+        address _podController,
+        address _podFactory
+    ) CoreRef(_core) {
+        memberToken = MemberToken(_memberToken);
+        podController = ControllerV1(_podController);
         podFactory = IPodFactory(_podFactory);
     }
 
     ////////////////////////   GETTERS   ////////////////////////////////
-    // TODO: Whatever global set of roles are, map them one to one to the specific pod roles.
-    // Pod specific roles:
-    // ADMIN: If can add, should be able to remove and lock transfers. Should also be able to veto
-    // GUARDIAN: Can remove and veto 
-    // 
-
-    /// @notice Calculate the specific pod admin role related to adding pod members
-    function getPodAddMemberRole(uint256 _podId)
+    /// @notice Calculate the specific pod admin role identifier
+    /// @dev This role is able to add pod members, remove pod members, lock and unlock transfers and veto
+    ///      proposals
+    function getSpecificPodAdminRole(uint256 _podId)
         public
         pure
         override
         returns (bytes32)
     {
-        return keccak256(abi.encode(_podId, "ORCA_POD", "POD_ADD_MEMBER_ROLE"));
+        return keccak256(abi.encode(_podId, "_ORCA_POD", "_ADMIN"));
     }
 
-    /// @notice Calculate the pod admin role related to removing pod members
-    function getPodRemoveMemberRole(uint256 _podId)
+    /// @notice Calculate the specific pod guardian role identifier
+    /// @dev This role is able to remove pod members and veto pod proposals
+    function getSpecificPodGuardianRole(uint256 _podId)
         public
         pure
         override
         returns (bytes32)
     {
-        return
-            keccak256(abi.encode(_podId, "ORCA_POD", "POD_REMOVE_MEMBER_ROLE"));
-    }
-
-    /// @notice Calculate the specific pod veto role, which allows an
-    function getPodVetoRole(uint256 _podId)
-        public
-        pure
-        override
-        returns (bytes32)
-    {
-        return keccak256(abi.encode(_podId, "ORCA_POD", "POD_VETO_ROLE"));
-    }
-
-    /// @notice Calculate the specific pod transfer admin role
-    // TODO: Remove this - not needed
-    function getPodTransferAdminRole(uint256 _podId)
-        public
-        pure
-        override
-        returns (bytes32)
-    {
-        return
-            keccak256(
-                abi.encode(_podId, "ORCA_POD", "POD_TRANSFER_ADMIN_ROLE")
-            );
-    }
-
-    /// @notice Calculate the specific pod membership transfer lock role
-    function getSetMembershipTransferLockRole(uint256 _podId)
-        public
-        pure
-        override
-        returns (bytes32)
-    {
-        return
-            keccak256(
-                abi.encode(
-                    _podId,
-                    "ORCA_POD",
-                    "SET_MEMBERSHIP_TRANSFER_LOCK_ROLE"
-                )
-            );
+        return keccak256(abi.encode(_podId, "_ORCA_POD", "_GUARDIAN"));
     }
 
     /////////////////////////    ADMIN PRIVILEDGES       ////////////////////////////
 
-    /// @notice Transfer the pod admin address for a pod to another address
-    function transferPodAdmin(uint256 _podId, address newPodAdmin)
-        external
-        override
-        hasAnyOfThreeRoles(
-            TribeRoles.GOVERNOR,
-            TribeRoles.POD_ADMIN,
-            getPodTransferAdminRole(_podId)
-        )
-    {
-        _transferPodAdmin(_podId, newPodAdmin);
-    }
-
-    /// @notice Batch transfer the pod admin address for several pods
-    /// @dev Mass transfer of podAdmins only expected to be performed by GOVERNOR or POD_ADMIN
-    function batchTransferPodAdmins(
-        uint256[] calldata _podIds,
-        address[] calldata newPodAdmins
-    )
-        external
-        override
-        hasAnyOfTwoRoles(TribeRoles.GOVERNOR, TribeRoles.POD_ADMIN)
-    {
-        require(
-            _podIds.length == newPodAdmins.length,
-            "MISMATCHED_ARG_LENGTHS"
-        );
-        uint256 numPodsToTransfer = _podIds.length;
-        for (uint256 i = 0; i < numPodsToTransfer; ) {
-            _transferPodAdmin(_podIds[i], newPodAdmins[i]);
-
-            // i is bounded by numPodsToTransfer
-            unchecked {
-                i += 1;
-            }
-        }
-    }
-
-    /// @notice Transfer a pod admin from this gateway to another address
-    function _transferPodAdmin(uint256 _podId, address newPodAdmin) internal {
-        ControllerV1 podController = podFactory.podController();
-
-        address oldPodAdmin = address(this);
-        emit UpdatePodAdmin(_podId, oldPodAdmin, newPodAdmin);
-        podController.updatePodAdmin(_podId, newPodAdmin);
-    }
-
     /// @notice Admin functionality to add a member to a pod
     /// @dev Permissioned to GOVERNOR, POD_ADMIN and POD_ADD_MEMBER_ROLE
     function addPodMember(uint256 _podId, address _member)
@@ -152,10 +74,9 @@ contract PodAdminGateway is CoreRef, IPodAdminGateway {
         hasAnyOfThreeRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
-            getPodAddMemberRole(_podId)
+            getSpecificPodAdminRole(_podId)
         )
     {
-        MemberToken memberToken = podFactory.getMemberToken();
         _addMemberToPod(_podId, _member, memberToken);
     }
 
@@ -177,11 +98,10 @@ contract PodAdminGateway is CoreRef, IPodAdminGateway {
         hasAnyOfThreeRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
-            getPodAddMemberRole(_podId)
+            getSpecificPodAdminRole(_podId)
         )
     {
         uint256 numMembers = _members.length;
-        MemberToken memberToken = podFactory.getMemberToken();
         for (uint256 i = 0; i < numMembers; ) {
             _addMemberToPod(_podId, _members[i], memberToken);
             // i is constrained by being < _members.length
@@ -196,14 +116,14 @@ contract PodAdminGateway is CoreRef, IPodAdminGateway {
     function removePodMember(uint256 _podId, address _member)
         external
         override
-        hasAnyOfFourRoles(
+        hasAnyOfFiveRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
             TribeRoles.GUARDIAN,
-            getPodRemoveMemberRole(_podId)
+            getSpecificPodGuardianRole(_podId),
+            getSpecificPodAdminRole(_podId)
         )
     {
-        MemberToken memberToken = podFactory.getMemberToken();
         _removePodMember(_podId, _member, memberToken);
     }
 
@@ -222,15 +142,15 @@ contract PodAdminGateway is CoreRef, IPodAdminGateway {
     function batchRemovePodMember(uint256 _podId, address[] calldata _members)
         external
         override
-        hasAnyOfFourRoles(
+        hasAnyOfFiveRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
             TribeRoles.GUARDIAN,
-            getPodRemoveMemberRole(_podId)
+            getSpecificPodGuardianRole(_podId),
+            getSpecificPodAdminRole(_podId)
         )
     {
         uint256 numMembers = _members.length;
-        MemberToken memberToken = podFactory.getMemberToken();
         for (uint256 i = 0; i < numMembers; ) {
             _removePodMember(_podId, _members[i], memberToken);
 
@@ -242,60 +162,58 @@ contract PodAdminGateway is CoreRef, IPodAdminGateway {
     }
 
     /// @notice Admin functionality to turn off pod membership transfer
-    /// @dev Permissioned to GOVERNOR, POD_ADMIN, GUARDIAN and the specific role
+    /// @dev Permissioned to GOVERNOR, POD_ADMIN and the specific pod admin role
     function lockMembershipTransfers(uint256 _podId)
         external
         override
-        hasAnyOfFourRoles(
+        hasAnyOfThreeRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
-            TribeRoles.GUARDIAN,
-            getSetMembershipTransferLockRole(_podId)
+            getSpecificPodAdminRole(_podId)
         )
     {
         _setMembershipTransferLock(_podId, true);
     }
 
     /// @notice Admin functionality to turn on pod membership transfers
-    /// @dev Permissioned to GOVERNOR, POD_ADMIN, GUARDIAN and the specific role
+    /// @dev Permissioned to GOVERNOR, POD_ADMIN and the specific pod admin role
     function unlockMembershipTransfers(uint256 _podId)
         external
         override
-        hasAnyOfFourRoles(
+        hasAnyOfThreeRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_ADMIN,
-            TribeRoles.GUARDIAN,
-            getSetMembershipTransferLockRole(_podId)
+            getSpecificPodAdminRole(_podId)
         )
     {
         _setMembershipTransferLock(_podId, false);
     }
 
     /// @notice Internal method to toggle a pod membership transfer lock
     function _setMembershipTransferLock(uint256 _podId, bool _lock) internal {
-        ControllerV1 podController = podFactory.podController();
         podController.setPodTransferLock(_podId, _lock);
         emit PodMembershipTransferLock(_podId, _lock);
     }
 
     ///////////////  VETO CONTROLLER /////////////////
 
     /// @notice Allow a proposal to be vetoed in a pod timelock
-    /// @dev Permissioned to GOVERNOR, POD_ADMIN, GUARDIAN and specific POD_VETO_ROLE
-    function veto(uint256 _podId, bytes32 proposalId)
+    /// @dev Permissioned to GOVERNOR, POD_VETO_ADMIN, GUARDIAN, POD_ADMIN and the specific
+    ///      pod admin and guardian roles
+    function veto(uint256 _podId, bytes32 _proposalId)
         external
         override
-        hasAnyOfFourRoles(
+        hasAnyOfSixRoles(
             TribeRoles.GOVERNOR,
             TribeRoles.POD_VETO_ADMIN,
             TribeRoles.GUARDIAN,
-            // TODO: Pod specific admin 
-            // TODO: Global pod admin
-            getPodVetoRole(_podId)
+            TribeRoles.POD_ADMIN,
+            getSpecificPodGuardianRole(_podId),
+            getSpecificPodAdminRole(_podId)
         )
     {
-        address timelock = podFactory.getPodTimelock(_podId);
-        emit VetoTimelock(_podId, timelock);
-        TimelockController(payable(timelock)).cancel(proposalId);
+        address _podTimelock = podFactory.getPodTimelock(_podId);
+        emit VetoTimelock(_podId, _podTimelock, _proposalId);
+        TimelockController(payable(_podTimelock)).cancel(_proposalId);
     }
 }