Merge pull request #112 from solidstate-network/transitive-owner

Add transitive owner utilities

Author: ItsNickBarry

contracts/access/ownable/OwnableInternal.sol

@@ -2,16 +2,24 @@
 
 pragma solidity ^0.8.0;
 
+import { AddressUtils } from '../../utils/AddressUtils.sol';
+import { IERC173 } from '../IERC173.sol';
 import { IOwnableInternal } from './IOwnableInternal.sol';
 import { OwnableStorage } from './OwnableStorage.sol';
 
 abstract contract OwnableInternal is IOwnableInternal {
+    using AddressUtils for address;
     using OwnableStorage for OwnableStorage.Layout;
 
     modifier onlyOwner() {
+        require(msg.sender == _owner(), 'Ownable: sender must be owner');
+        _;
+    }
+
+    modifier onlyTransitiveOwner() {
         require(
-            msg.sender == OwnableStorage.layout().owner,
-            'Ownable: sender must be owner'
+            msg.sender == _transitiveOwner(),
+            'Ownable: sender must be transitive owner'
         );
         _;
     }
@@ -20,6 +28,20 @@ abstract contract OwnableInternal is IOwnableInternal {
         return OwnableStorage.layout().owner;
     }
 
+    function _transitiveOwner() internal view virtual returns (address) {
+        address owner = _owner();
+
+        while (owner.isContract()) {
+            try IERC173(owner).owner() returns (address transitiveOwner) {
+                owner = transitiveOwner;
+            } catch {
+                return owner;
+            }
+        }
+
+        return owner;
+    }
+
     function _transferOwnership(address account) internal virtual {
         OwnableStorage.layout().setOwner(account);
         emit OwnershipTransferred(msg.sender, account);

contracts/access/ownable/OwnableMock.sol

@@ -10,4 +10,12 @@ contract OwnableMock is Ownable {
     constructor(address owner) {
         OwnableStorage.layout().setOwner(owner);
     }
+
+    function setOwner(address owner) external {
+        OwnableStorage.layout().setOwner(owner);
+    }
+
+    function __transitiveOwner() external view returns (address) {
+        return _transitiveOwner();
+    }
 }

test/access/Ownable.ts

@@ -1,6 +1,8 @@
 import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
 import { describeBehaviorOfOwnable } from '@solidstate/spec';
 import { OwnableMock, OwnableMock__factory } from '@solidstate/typechain-types';
+import { expect } from 'chai';
+import { deployMockContract } from 'ethereum-waffle';
 import { ethers } from 'hardhat';
 
 describe('Ownable', function () {
@@ -20,4 +22,40 @@ describe('Ownable', function () {
     getOwner: async () => owner,
     getNonOwner: async () => nonOwner,
   });
+
+  describe('__internal', () => {
+    describe('#_transitiveOwner()', () => {
+      it('returns owner if owner is EOA', async () => {
+        expect(await instance.callStatic.__transitiveOwner()).to.equal(
+          owner.address,
+        );
+      });
+
+      it('returns owner if owner is not Ownable', async () => {
+        const ownerInstance = await deployMockContract(owner, []);
+
+        await instance.setOwner(ownerInstance.address);
+
+        expect(await instance.callStatic.__transitiveOwner()).to.equal(
+          ownerInstance.address,
+        );
+      });
+
+      it('returns transitive owner', async () => {
+        const secondOwnerInstance = await new OwnableMock__factory(
+          owner,
+        ).deploy(owner.address);
+
+        const firstOwnerInstance = await new OwnableMock__factory(owner).deploy(
+          secondOwnerInstance.address,
+        );
+
+        await instance.setOwner(firstOwnerInstance.address);
+
+        expect(await instance.callStatic.__transitiveOwner()).to.equal(
+          owner.address,
+        );
+      });
+    });
+  });
 });