@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-cf68d0c-530

package/contracts/experiment/cloning/Cloner.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
+
+
+contract Cloner {
+
+    Mock1 public mock1;
+    Mock2 public mock2;
+
+    constructor() {
+        mock1 = new Mock1();
+        mock2 = new Mock2();
+    }
+
+    function createClone(address master)
+        external 
+        returns (address cloned)
+    {
+        cloned = Clones.clone(master);
+    }
+}
+
+
+contract Mock1 {
+    function getValue() external virtual view returns (uint256) {
+        return 42;
+    }
+}
+
+contract Mock2 is Mock1 {
+    uint256 internal _value;
+
+    constructor() {
+        _value = 42;
+    }
+
+    function setValue(uint256 value) external virtual {
+        _value = value;
+    }
+
+    function getValue() external virtual override view returns (uint256) {
+        return _value;
+    }
+}
+

package/contracts/instance/AccessManagedSimple.sol

@@ -3,10 +3,10 @@
 
 pragma solidity ^0.8.20;
 
-import {AuthorityUtils} from "@openzeppelin5/contracts/access/manager/AuthorityUtils.sol";
-import {Context} from "@openzeppelin5/contracts/utils/Context.sol";
-import {IAccessManaged} from "@openzeppelin5/contracts/access/manager/IAccessManaged.sol";
-import {IAuthority} from "@openzeppelin5/contracts/access/manager/IAuthority.sol";
+import {AuthorityUtils} from "@openzeppelin/contracts/access/manager/AuthorityUtils.sol";
+import {Context} from "@openzeppelin/contracts/utils/Context.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {IAuthority} from "@openzeppelin/contracts/access/manager/IAuthority.sol";
 
 import {IAccessManagerSimple} from "./IAccessManagerSimple.sol";
 
@@ -19,17 +19,18 @@ import {IAccessManagerSimple} from "./IAccessManagerSimple.sol";
  * functions, and ideally only used in `external` functions. See {restricted}.
  */
 abstract contract AccessManagedSimple is Context, IAccessManaged {
+    bool private _initialized;
     address private _authority;
 
     bool private _consumingSchedule;
 
-    /**
-     * @dev Initializes the contract connected to an initial authority.
-     */
-    constructor(address initialAuthority) {
+    function initializeAccessManagedSimple(address initialAuthority) internal {
+        require(!_initialized, "AccessManaged: already initialized");
         _setAuthority(initialAuthority);
+        _initialized = true;
     }
 
+
     /**
      * @dev Restricts access to a function as defined by the connected Authority for this contract and the
      * caller and selector of the function that entered the contract.

package/contracts/instance/AccessManagerSimple.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Context} from "@openzeppelin5/contracts/utils/Context.sol";
-import {IAccessManaged} from "@openzeppelin5/contracts/access/manager/IAccessManaged.sol";
+import {Context} from "@openzeppelin/contracts/utils/Context.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IAccessManagerSimple} from "./IAccessManagerSimple.sol";
 
@@ -46,6 +46,8 @@ contract AccessManagerSimple is Context, IAccessManagerSimple {
         uint32 nonce;
     }
 
+    bool private _initialized;
+
     uint64 public constant ADMIN_ROLE = type(uint64).min; // 0
     uint64 public constant PUBLIC_ROLE = type(uint64).max; // 2**64-1
 
@@ -67,14 +69,22 @@ contract AccessManagerSimple is Context, IAccessManagerSimple {
     }
 
     constructor(address initialAdmin) {
+        initialize(initialAdmin);
+    }
+    
+    function initialize(address initialAdmin) public {
+        require(!_initialized, "AccessManager: already initialized");
+        
         if (initialAdmin == address(0)) {
             revert AccessManagerInvalidInitialAdmin(address(0));
         }
 
         // admin is active immediately and without any execution delay.
         _grantRole(ADMIN_ROLE, initialAdmin, 0, 0);
+        _initialized = true;
     }
 
+
     // =================================================== GETTERS ====================================================
     /// @inheritdoc IAccessManagerSimple
     function canCall(

package/contracts/instance/IAccessManagerSimple.sol

@@ -3,7 +3,7 @@
 
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin5/contracts/access/manager/IAccessManaged.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 interface IAccessManagerSimple {
     /**

package/contracts/instance/IInstance.sol

@@ -1,6 +1,33 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-interface IInstance {
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {InstanceReader} from "./InstanceReader.sol";
+
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {ISetup} from "./module/ISetup.sol";
+import {NftId} from "../types/NftId.sol";
+import {StateId} from "../types/StateId.sol";
+
+interface IInstance is IERC165 {
+
+    function getComponentOwnerService() external view returns (IComponentOwnerService);
+    // TODO: renable these when we have the services
+    function getDistributionService() external view returns (IDistributionService);
+    // function getProductService() external view returns (IProductService);
+    // function getPoolService() external view returns (IPoolService);
+
+    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external;
+
+    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
+    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external;
+    function updateDistributionSetupState(NftId distributionNftId, StateId newState) external;
+
+    function createPoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup) external;
+
+    function getInstanceReader() external view returns (InstanceReader);
 }

package/contracts/instance/IInstanceService.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
+
+import {AccessManagerSimple} from "./AccessManagerSimple.sol";
+import {Instance} from "./Instance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+
+interface IInstanceService is IService {
+
+    event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
+
+    function createInstanceClone()
+        external 
+        returns (
+            AccessManagerSimple clonedAccessManager, 
+            Instance clonedInstance,
+            NftId instanceNftId,
+            InstanceReader clonedInstanceReader
+        );
+}
+

package/contracts/instance/Instance.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin5/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin5/contracts/utils/ShortStrings.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {AccessManagedSimple} from "./AccessManagedSimple.sol";
 import {AccessManagerSimple} from "./AccessManagerSimple.sol";
@@ -14,17 +14,26 @@ import {ISetup} from "./module/ISetup.sol";
 import {Key32, KeyId, Key32Lib} from "../types/Key32.sol";
 import {KeyValueStore} from "./base/KeyValueStore.sol";
 import {IInstance} from "./IInstance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
 import {NftId} from "../types/NftId.sol";
 import {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
+import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {RoleId, RoleIdLib} from "../types/RoleId.sol";
 import {StateId, ACTIVE} from "../types/StateId.sol";
+import {ERC165} from "../shared/ERC165.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {ComponentOwnerService} from "./service/ComponentOwnerService.sol";
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
+import {VersionPart} from "../types/Version.sol";
 
 contract Instance is
     AccessManagedSimple,
     KeyValueStore,
-    IInstance
+    IInstance,
+    ERC165,
+    Registerable
 {
 
     uint64 public constant ADMIN_ROLE = type(uint64).min;
@@ -33,6 +42,8 @@ contract Instance is
 
     uint32 public constant EXECUTION_DELAY = 0;
 
+    bool private _initialized;
+
     mapping(ShortString name => RoleId roleId) internal _role;
     mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
     RoleId [] internal _roles;
@@ -40,13 +51,26 @@ contract Instance is
     mapping(ShortString name => address target) internal _target;
 
     AccessManagerSimple internal _accessManager;
+    InstanceReader internal _instanceReader;
 
-    constructor(address accessManagerAddress)
-        AccessManagedSimple(accessManagerAddress)
+    constructor(address accessManagerAddress, address registryAddress, NftId registryNftId)
     {
+        initialize(accessManagerAddress, registryAddress, registryNftId, msg.sender);
+    }
+
+    function initialize(address accessManagerAddress, address registryAddress, NftId registryNftId, address initialOwner) public {
+        require(!_initialized, "Contract instance has already been initialized");
+
+        initializeAccessManagedSimple(accessManagerAddress);
+
         _accessManager = AccessManagerSimple(accessManagerAddress);
         _createRole(RoleIdLib.toRoleId(ADMIN_ROLE), "AdminRole", false, false);
         _createRole(RoleIdLib.toRoleId(PUBLIC_ROLE), "PublicRole", false, false);
+
+        _initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
+
+        _registerInterface(type(IInstance).interfaceId);    
+        _initialized = true;
     }
 
     //--- Role ------------------------------------------------------//
@@ -183,11 +207,11 @@ contract Instance is
     }
 
     //--- DistributionSetup ------------------------------------------------------//
-    function createDistributionSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup) external restricted() {
+    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external restricted() {
         create(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup));
     }
 
-    function updateDistributionSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external restricted() {
+    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external restricted() {
         update(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup), newState);
     }
 
@@ -196,11 +220,11 @@ contract Instance is
     }
 
     //--- PoolSetup ------------------------------------------------------//
-    function createPoolSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup) external restricted() {
+    function createPoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup) external restricted() {
         create(_toNftKey32(distributionNftId, POOL()), abi.encode(setup));
     }
 
-    function updatePoolSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external restricted() {
+    function updatePoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external restricted() {
         update(_toNftKey32(distributionNftId, POOL()), abi.encode(setup), newState);
     }
 
@@ -389,4 +413,31 @@ contract Instance is
     function toPolicyKey32(NftId policyNftId) public pure returns (Key32) {
         return policyNftId.toKey32(POLICY());
     }
+
+    function getComponentOwnerService() external view returns (IComponentOwnerService) {
+        return ComponentOwnerService(_registry.getServiceAddress("ComponentOwnerService", VersionPart.wrap(3)));
+    }
+
+    function getDistributionService() external view returns (IDistributionService) {
+        return IDistributionService(_registry.getServiceAddress("DistributionService", VersionPart.wrap(3)));
+    }
+
+    // TODO reactivate when services are available
+    // function getProductService() external view returns (IProductService) {
+    //     return ProductService(_registry.getServiceAddress("ProductService", VersionPart.wrap(3)));
+    // }
+
+    // TODO reactivate when services are available
+    // function getPoolService() external view returns (IPoolService) {
+    //     return PoolService(_registry.getServiceAddress("PoolService", VersionPart.wrap(3)));
+    // }
+
+    function setInstanceReader(InstanceReader instanceReader) external restricted() {
+        require(address(_instanceReader) == address(0), "InstanceReader is set");
+        _instanceReader = instanceReader;
+    }
+
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
+    }
 }

package/contracts/instance/InstanceAccessManager.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin5/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin5/contracts/utils/ShortStrings.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {AccessManagedSimple} from "./AccessManagedSimple.sol";
 import {AccessManagerSimple} from "./AccessManagerSimple.sol";
@@ -79,9 +79,9 @@ contract InstanceAccessManager is
     AccessManagerSimple internal _accessManager;
 
     constructor(address accessManager)
-        AccessManagedSimple(accessManager)
     {
         _accessManager = AccessManagerSimple(accessManager);
+        initializeAccessManagedSimple(accessManager);
 
         _createRole(RoleIdLib.toRoleId(_accessManager.ADMIN_ROLE()), ADMIN_ROLE_NAME, false, false);
         _createRole(RoleIdLib.toRoleId(_accessManager.PUBLIC_ROLE()), PUBLIC_ROLE_NAME, false, false);

package/contracts/instance/InstanceReader.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {DistributorType} from "../types/DistributorType.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
 import {Key32} from "../types/Key32.sol";
 import {NftId} from "../types/NftId.sol";
-import {ObjectType, DISTRIBUTOR, INSTANCE, PRODUCT, POLICY, TREASURY} from "../types/ObjectType.sol";
+import {ObjectType, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, TREASURY} from "../types/ObjectType.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../types/Referral.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RiskId} from "../types/RiskId.sol";
-import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
+import {UFixed, MathLib, UFixedLib} from "../types/UFixed.sol";
 import {Version} from "../types/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
@@ -20,11 +20,13 @@ import {IInstance} from "./IInstance.sol";
 import {IKeyValueStore} from "../instance/base/IKeyValueStore.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
 import {ITreasury} from "../instance/module/ITreasury.sol";
 import {TimestampLib} from "../types/Timestamp.sol";
 
 
 contract InstanceReader {
+    bool private _initialized;
 
     IRegistry internal _registry;
     NftId internal _instanceNftId;
@@ -36,6 +38,12 @@ contract InstanceReader {
         NftId instanceNftId
     )
     {
+        initialize(registry, instanceNftId);
+    }
+
+    function initialize(address registry, NftId instanceNftId) public {
+        require(!_initialized, "ERROR:CRD-000:ALREADY_INITIALIZED");
+
         require(
             address(registry) != address(0),
             "ERROR:CRD-001:REGISTRY_ZERO");
@@ -54,8 +62,11 @@ contract InstanceReader {
 
         _instance = IInstance(instanceInfo.objectAddress);
         _store = IKeyValueStore(instanceInfo.objectAddress);
+
+        _initialized = true;
     }
 
+
     // module specific functions
 
     function getPolicyInfo(NftId policyNftId)
@@ -126,6 +137,38 @@ contract InstanceReader {
         }
     }
 
+    function getDistributionSetupInfo(NftId distributionNftId)
+        public
+        view
+        returns (ISetup.DistributionSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toDistributionKey(distributionNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.DistributionSetupInfo));
+        }
+    }
+
+    function getPoolSetupInfo(NftId poolNftId)
+        public
+        view
+        returns (ISetup.PoolSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.PoolSetupInfo));
+        }
+    }
+
+    function getProductSetupInfo(NftId productNftId)
+        public
+        view
+        returns (ISetup.ProductSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toProductKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.ProductSetupInfo));
+        }
+    }
 
     function getReferralInfo(ReferralId referralId)
         public 
@@ -175,19 +218,19 @@ contract InstanceReader {
 
         if (info.expiryAt.eqz()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_UNKNOWN());
         }
 
         if (info.expiryAt < TimestampLib.blockTimestamp()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXPIRED());
         }
 
         if (info.usedReferrals >= info.maxReferrals) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXHAUSTED());
         }
 
@@ -212,6 +255,18 @@ contract InstanceReader {
         return distributorNftId.toKey32(DISTRIBUTOR());
     }
 
+    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
+        return distributionNftId.toKey32(DISTRIBUTION());
+    }
+
+    function toPoolKey(NftId poolNftId) public pure returns (Key32) { 
+        return poolNftId.toKey32(POOL());
+    }
+
+    function toProductKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(PRODUCT());
+    }
+
     // low level function
     function getInstance() external view returns (IInstance instance) {
         return _instance;
@@ -226,10 +281,10 @@ contract InstanceReader {
     }
 
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
-        return UFixedMathLib.toUFixed(value, exp);
+        return UFixedLib.toUFixed(value, exp);
     }
 
     function toInt(UFixed value) public pure returns (uint256) {
-        return UFixedMathLib.toInt(value);
+        return UFixedLib.toInt(value);
     }
 }