@etherisc/gif-next 0.0.2-92c50c2-136 → 0.0.2-92cdbc9-533

package/contracts/distribution/IDistributionComponent.sol

@@ -11,56 +11,38 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 interface IDistributionComponent is IInstanceLinkedComponent {
 
+    error ErrorDistributionNotDistributor(address distributor);
+    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+
     event LogDistributorUpdated(address to, address caller);
 
-    function setFees(
-        Fee memory distributionFee,
-        Fee memory minDistributionOwnerFee
-    ) external;
+    /// @dev Returns true iff the provided address is registered as a distributor with this distribution component.
+    function isDistributor(address candidate) external view returns (bool);
 
-    function createDistributorType(
-        string memory name,
-        UFixed minDiscountPercentage,
-        UFixed maxDiscountPercentage,
-        UFixed commissionPercentage,
-        uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
-        bool allowSelfReferrals,
-        bool allowRenewals,
-        bytes memory data
-    ) external returns (DistributorType distributorType);
+    /// @dev Returns the distributor Nft Id for the provided address
+    function getDistributorNftId(address distributor) external view returns (NftId distributorNftId);
 
-    function createDistributor(
-        address distributor,
-        DistributorType distributorType,
-        bytes memory data
-    ) external returns(NftId distributorNftId);
+    function getDiscountPercentage(
+        string memory referralCode
+    ) external view returns (UFixed discountPercentage, ReferralStatus status);
 
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external;
+    function getReferralId(
+        string memory referralCode
+    ) external returns (ReferralId referralId);
 
     function calculateRenewalFeeAmount(
         ReferralId referralId,
         uint256 netPremiumAmount
     ) external view returns (uint256 feeAmount);
 
-    /// @dev callback from product service when a policy is renews for a specific referralId
+    /// @dev Callback function to process a renewal of a policy.
+    /// The default implementation is empty.
+    /// Overwrite this function to implement a use case specific behaviour.
     function processRenewal(
         ReferralId referralId,
         uint256 feeAmount
     ) external;
 
-    function getDiscountPercentage(
-        string memory referralCode
-    ) external view returns (UFixed discountPercentage, ReferralStatus status);
-
-    function getReferralId(
-        string memory referralCode
-    ) external returns (ReferralId referralId);
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    /// @dev Returns true to ensure component is called when transferring distributor Nft Ids.
     function isVerifying() external view returns (bool verifying);
 }

package/contracts/distribution/IDistributionService.sol

@@ -13,6 +13,7 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 
 interface IDistributionService is IService {
+
     error ErrorDistributionServiceCallerNotRegistered(address caller);
     error ErrorIDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
     error ErrorIDistributionServiceCallerNotDistributor(address caller);
@@ -25,7 +26,10 @@ interface IDistributionService is IService {
     error ErrorIDistributionServiceExpirationInvalid(Timestamp expiryAt);
     error ErrorIDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
     error ErrorIDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
-    error ErrorIDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
+
+    error ErrorDistributionServiceVariableFeesTooHight(uint256 maxDiscountPercentage, uint256 limit);
+    error ErrorDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
+
     error ErrorIDistributionServiceReferralInvalid(NftId distributionNftId, ReferralId referralId);
     error ErrorDistributionServiceInvalidFeeTransferred(Amount transferredDistributionFeeAmount, Amount expectedDistributionFeeAmount);
 

package/contracts/instance/IInstance.sol

@@ -17,7 +17,6 @@ import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
 
-import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
@@ -74,14 +73,14 @@ interface IInstance is
     function setStakingRewardRate(UFixed rewardRate) external;
     function refillStakingRewardReserves(Amount dipAmount) external;
 
-    /// @dev defunds the staking reward reserves for the specified target
-    /// permissioned: only the target owner may call this function
+    /// @dev Defunds the staking reward reserves for the specified target.
+    /// Permissioned: only the target owner may call this function.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
+    // get instance release and supporting contracts
     function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleManager() external view returns (BundleManager);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
-    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable);
 }

package/contracts/instance/IInstanceService.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {Amount} from "../type/Amount.sol";
 import {BundleManager} from "./BundleManager.sol";
 import {Instance} from "./Instance.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
@@ -22,7 +23,6 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
     error ErrorInstanceServiceMasterInstanceAlreadySet();
-    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
     error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
     error ErrorInstanceServiceMasterBundleManagerAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
@@ -32,6 +32,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch();
 
+    error ErrorInstanceServiceAccessManagerZero();
     error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
     error ErrorInstanceServiceBundleManagerZero();
@@ -49,15 +50,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
     error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
     
-    event LogInstanceCloned(
-        address clonedOzAccessManager,
-        address clonedInstanceAccessManager,
-        address clonedInstance,
-        address clonedInstanceStore,
-        address clonedBundleManager, 
-        address clonedInstanceReader, 
-        NftId clonedInstanceNftId
-    );
+    event LogInstanceCloned(NftId instanceNftId, address instance);
 
     function createInstanceClone()
         external 
@@ -72,10 +65,12 @@ interface IInstanceService is IService {
     function setStakingRewardRate(UFixed rewardRate) external;
     function refillStakingRewardReserves(address rewardProvider, Amount dipAmount) external;
 
-    /// @dev defunds the staking reward reserves for the specified target
-    /// permissioned: only the target owner may call this function
+    /// @dev Defunds the staking reward reserves for the specified target.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
+    /// @dev Sets up the component authorization for the specified instance.
+    /// The authorization is based on the authz specification provided by the component via getAuthorization.
+    function initializeAuthorization(NftId instanceNftId, IInstanceLinkedComponent component) external;
 
     function createComponentTarget(
         NftId instanceNftId,

package/contracts/instance/Instance.sol

@@ -8,7 +8,7 @@ import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../type/ObjectType.sol";
-import {RoleId, RoleIdLib, eqRoleId, ADMIN_ROLE, INSTANCE_ROLE, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -19,7 +19,6 @@ import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 
@@ -66,18 +65,44 @@ contract Instance is
         _;
     }
 
-    function initialize(address authority, address registryAddress, address initialOwner) 
+    function initialize(
+        InstanceAdmin instanceAdmin, 
+        InstanceStore instanceStore,
+        BundleManager bundleManager,
+        InstanceReader instanceReader,
+        IRegistry registry, 
+        address initialOwner
+    ) 
         external 
         initializer()
     {
-        if(authority == address(0)) {
+        _instanceAdmin = instanceAdmin;
+        if(_instanceAdmin.authority() == address(0)) {
+            // TODO rename error
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        __AccessManaged_init(authority);
-        
-        IRegistry registry = IRegistry(registryAddress);
-        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
+        // set authority to instance admin authority
+        __AccessManaged_init(_instanceAdmin.authority());
+
+        // setup instance object info
+        initializeRegisterable(
+            address(registry), 
+            registry.getNftId(), 
+            INSTANCE(), 
+            true, 
+            initialOwner, 
+            "");
+
+        // store instance supporting contracts
+        _instanceStore = instanceStore;
+        _bundleManager = bundleManager;
+        _instanceReader = instanceReader;
+
+        // initialize instance supporting contracts
+        _instanceStore.initialize();
+        _bundleManager.initialize();
+        _instanceReader.initialize();
 
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
@@ -124,37 +149,36 @@ contract Instance is
 
     function createRole(string memory roleName, string memory adminName)
         external
-        // TODO decide if onlyOwner or restricted to instance owner role is better
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
         returns (RoleId roleId, RoleId admin)
     {
-        (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
+        // TODO refactor
+        // (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
     }
 
     function grantRole(RoleId roleId, address account) 
         external 
-        // TODO decide if onlyOwner or restricted to instance owner role is better
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        AccessManagerExtendedInitializeable(authority()).grantRole(roleId.toInt(), account, 0);
+        _instanceAdmin.grantRole(roleId, account);
     }
 
     function revokeRole(RoleId roleId, address account) 
         external 
-        // TODO decide if onlyOwner or restricted to instance owner role is better
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
+        // TODO refactor
+        // AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
     }
 
     //--- Targets ------------------------------------------------------------//
 
     function createTarget(address target, string memory name) 
         external 
-        // TODO decide if onlyOwner or restricted to instance owner role is better
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _instanceAdmin.createTarget(target, name);
+        // TODO refactor
+        // _instanceAdmin.createTarget(target, name);
     }
 
     function setTargetFunctionRole(
@@ -163,59 +187,40 @@ contract Instance is
         RoleId roleId
     ) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
+        // TODO refactor
+        // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
     function setTargetLocked(address target, bool locked)
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _instanceAdmin.setTargetLockedByInstance(target, locked);
+        // TODO refactor
+        // _instanceAdmin.setTargetLockedByInstance(target, locked);
     }
 
     //--- ITransferInterceptor ----------------------------------------------//
 
     // TODO interception of child components nfts
     function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        _instanceAdmin.transferInstanceOwnerRole(address(0), to);
+        // TODO refactor
+        // _instanceAdmin.transferInstanceOwnerRole(address(0), to);
     }
 
     function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
-        _instanceAdmin.transferInstanceOwnerRole(from, to);
+        // TODO refactor
+        // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
 
-    //function nftBurn(address from, uint256 tokenId) external onlyChainNft {
-        //_instanceAdmin.transferInstanceOwnerRole(from, address(0));
-    //}
-
     //--- initial setup functions -------------------------------------------//
 
-    function setInstanceAdmin(InstanceAdmin accessManager) external restricted {
-        if(address(_instanceAdmin) != address(0)) {
-            revert ErrorInstanceInstanceAdminAlreadySet(address(_instanceAdmin));
-        }
-        if(accessManager.authority() != authority()) {
-            revert ErrorInstanceInstanceAdminAuthorityMismatch(authority());
-        }
-        _instanceAdmin = accessManager;      
-    }
-    
-    function setBundleManager(BundleManager bundleManager) external restricted() {
-        if(address(_bundleManager) != address(0)) {
-            revert ErrorInstanceBundleManagerAlreadySet(address(_bundleManager));
-        }
-        if(bundleManager.getInstance() != Instance(this)) {
-            revert ErrorInstanceBundleManagerInstanceMismatch(address(this));
-        }
-        if(bundleManager.authority() != authority()) {
-            revert ErrorInstanceBundleManagerAuthorityMismatch(authority());
-        }
-        _bundleManager = bundleManager;
-    }
 
-    function setInstanceReader(InstanceReader instanceReader) external restricted() {
+    function setInstanceReader(InstanceReader instanceReader)
+        external
+        restricted()
+    {
         if(instanceReader.getInstance() != Instance(this)) {
             revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
         }
@@ -223,16 +228,6 @@ contract Instance is
         _instanceReader = instanceReader;
     }
 
-    function setInstanceStore(InstanceStore instanceStore) external restricted {
-        if(address(_instanceStore) != address(0)) {
-            revert ErrorInstanceInstanceStoreAlreadySet(address(_instanceStore));
-        }
-        if(instanceStore.authority() != authority()) {
-            revert ErrorInstanceInstanceStoreAuthorityMismatch(authority());
-        }
-        _instanceStore = instanceStore;
-    }
-
     //--- external view functions -------------------------------------------//
 
     function getInstanceReader() external view returns (InstanceReader) {
@@ -247,10 +242,6 @@ contract Instance is
         return _instanceAdmin;
     }
 
-    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable) {
-        return AccessManagerExtendedInitializeable(authority());
-    }
-
     function getInstanceStore() external view returns (InstanceStore) {
         return _instanceStore;
     }