@etherisc/gif-next 3.0.0-dd00d66-173 → 3.0.0-e1241ec-031

package/contracts/authorization/AccessManagerCloneable.sol

@@ -4,9 +4,9 @@ pragma solidity ^0.8.20;
 import {AccessManagerUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagerUpgradeable.sol";
 import {IAccessManager} from "@openzeppelin/contracts/access/manager/IAccessManager.sol";
 
-import {IAccessAdmin} from "./IAccessAdmin.sol";
 import {InitializableERC165} from "../shared/InitializableERC165.sol";
-import {VersionPartLib, VersionPart} from "../type/Version.sol";
+import {RegistryLinked} from "../shared/RegistryLinked.sol";
+import {VersionPart} from "../type/Version.sol";
 
 
 /// @dev An AccessManager based on OpenZeppelin that is cloneable and has a central lock property.
@@ -14,7 +14,8 @@ import {VersionPartLib, VersionPart} from "../type/Version.sol";
 /// Cloned by upon release preparation and instance cloning.
 contract AccessManagerCloneable is
     AccessManagerUpgradeable,
-    InitializableERC165
+    InitializableERC165,
+    RegistryLinked
 {
     error ErrorAccessManagerCallerNotAdmin(address caller);
     error ErrorAccessManagerRegistryAlreadySet(address registry);
@@ -23,6 +24,9 @@ contract AccessManagerCloneable is
     error ErrorAccessManagerTargetAdminLocked(address target);
     error ErrorAccessManagerCallerAdminLocked(address caller);
 
+    event LogAccessManagerLocked(address indexed accessManager, bool indexed locked);
+
+    VersionPart private _release;
     bool private _isLocked;
 
 
@@ -34,36 +38,35 @@ contract AccessManagerCloneable is
         _;
     }
 
-    function initialize(address adminAddress, VersionPart release)
-        public
 
+    function initialize(address admin)
+        public
+        override
+        initializer()
     {
-        if(_getInitializedVersion() != 0) {
-            revert InvalidInitialization();
-        }
+        __ERC165_init();
+        __AccessManager_init(admin);
 
-        AccessManagerCloneable_init(adminAddress, release);
+        _registerInterface(type(IAccessManager).interfaceId);
     }
 
-    function AccessManagerCloneable_init(
-        address admin,
+
+    /// @dev Completes the setup of the access manager.
+    /// Links the access manager to the registry and sets the release version.
+    function completeSetup(
+        address registry, 
         VersionPart release
     )
-        internal
-        reinitializer(release.toInt())
+        external
+        onlyAdminRole
+        reinitializer(uint64(release.toInt()))
     {
-        if (!release.isValidRelease()) {
-            revert ErrorAccessManagerInvalidRelease(release);
-        }
-
-        __ERC165_init();
-        __AccessManager_init(admin);
-
-        _registerInterface(type(IAccessManager).interfaceId);
+        _checkAndSetRegistry(registry);
+        _checkAndSetRelease(release);
     }
 
     /// @dev Returns true if the caller is authorized to call the target with the given selector and the manager lock is not set to locked.
-    /// Return values as in OpenZeppelin AccessManager.
+    /// Feturn values as in OpenZeppelin AccessManager.
     /// For a locked manager the function reverts with ErrorAccessManagerTargetAdminLocked.
     function canCall(
         address caller,
@@ -94,6 +97,7 @@ contract AccessManagerCloneable is
         onlyAdminRole() 
     {
         _isLocked = locked;
+        emit LogAccessManagerLocked(address(this), locked);
     }
 
 
@@ -101,10 +105,10 @@ contract AccessManagerCloneable is
     /// For the registry admin release 3 is returned.
     /// For the release admin and the instance admin the actual release version is returned.
     function getRelease() external view returns (VersionPart release) {
-        return VersionPartLib.toVersionPart(
-            uint8(_getInitializedVersion()));
+        return _release;
     }
 
+
     /// @dev Returns true iff all contracts of this access manager are locked.
     function isLocked()
         public
@@ -113,4 +117,28 @@ contract AccessManagerCloneable is
     {
         return _isLocked;
     }
+
+
+    function _checkAndSetRelease(VersionPart release)
+        internal
+    {
+        if (!release.isValidRelease()) {
+            revert ErrorAccessManagerInvalidRelease(release);
+        }
+
+        _release = release;
+    }
+
+
+    function _checkAndSetRegistry(address registry)
+        internal
+    {
+        // checks
+        if(address(getRegistry()) != address(0)) {
+            revert ErrorAccessManagerRegistryAlreadySet(address(getRegistry()) );
+        }
+
+        // effects
+        __RegistryLinked_init(registry);
+    }
 }

package/contracts/authorization/Authorization.sol

@@ -9,7 +9,7 @@ import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
 import {ServiceAuthorization} from "../authorization/ServiceAuthorization.sol";
 import {Str, StrLib} from "../type/String.sol";
-import {VersionPart} from "../type/Version.sol";
+
 
 contract Authorization is
     ServiceAuthorization,
@@ -30,7 +30,7 @@ contract Authorization is
     constructor(
         string memory mainTargetName, 
         ObjectType domain,
-        VersionPart release,
+        uint8 release,
         string memory commitHash,
         IAccess.TargetType targetType,
         bool includeTokenHandler

package/contracts/authorization/IAccessAdmin.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IAccess} from "./IAccess.sol";
 import {IAuthorization} from "./IAuthorization.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
+import {IRelease} from "../registry/IRelease.sol";
 
 import {Blocknumber} from "../type/Blocknumber.sol";
 import {NftId} from "../type/NftId.sol";
@@ -18,7 +19,8 @@ import {VersionPart} from "../type/Version.sol";
 interface IAccessAdmin is 
     IAccessManaged,
     IAccess,
-    IRegistryLinked
+    IRegistryLinked,
+    IRelease
 {
 
     // roles, targets and functions
@@ -57,7 +59,6 @@ interface IAccessAdmin is
     error ErrorAccessAdminTargetNotCreated(address target);
     error ErrorAccessAdminTargetNotRegistered(address target);
     error ErrorAccessAdminTargetTypeMismatch(address target, ObjectType expectedType, ObjectType actualType);
-    error ErrorAccessAdminTargetReleaseMismatch(address target, VersionPart expectedRelease, VersionPart actualRelease);
 
     // check authorization
     error ErrorAccessAdminAlreadyInitialized(address authorization);
@@ -138,5 +139,4 @@ interface IAccessAdmin is
 
     function authorizedFunctions(address target) external view returns (uint256 numberOfFunctions);
     function getAuthorizedFunction(address target, uint256 idx) external view returns (FunctionInfo memory func, RoleId roleId);
-        function getRelease() external view returns (VersionPart);
 }

package/contracts/authorization/IServiceAuthorization.sol

@@ -16,7 +16,7 @@ interface IServiceAuthorization is
 
      error ErrorAuthorizationMainTargetNameEmpty();
      error ErrorAuthorizationTargetDomainZero();
-     error ErrorAuthorizationReleaseInvalid(VersionPart release);
+     error ErrorAuthorizationReleaseInvalid(uint8 release);
      error ErrorAuthorizationCommitHashInvalid(string commitHash);
 
      /// @dev Returns the main domain of the authorization.

package/contracts/authorization/ServiceAuthorization.sol

@@ -30,7 +30,7 @@ contract ServiceAuthorization is
      string public constant ROLE_NAME_SUFFIX = "_Role";
 
      ObjectType public immutable DOMAIN;
-     VersionPart internal immutable _release;
+     uint256 internal immutable _release;
      string internal _commitHash;
 
      string internal _mainTargetName;
@@ -55,7 +55,7 @@ contract ServiceAuthorization is
      constructor(
           string memory mainTargetName, 
           ObjectType domain,
-          VersionPart release,
+          uint8 release,
           string memory commitHash
      )
      {
@@ -68,7 +68,7 @@ contract ServiceAuthorization is
                revert ErrorAuthorizationTargetDomainZero();
           }
 
-          if (!VersionPartLib.isValidRelease(release)) {
+          if (release < VersionPartLib.releaseMin().toInt() || release >= VersionPartLib.releaseMax().toInt()) {
                revert ErrorAuthorizationReleaseInvalid(release);
           }
 
@@ -103,7 +103,7 @@ contract ServiceAuthorization is
 
      /// @inheritdoc IServiceAuthorization
      function getRelease() public view returns(VersionPart release) {
-          return _release;
+          return VersionPartLib.toVersionPart(_release);
      }
 
      /// @inheritdoc IServiceAuthorization

package/contracts/distribution/BasicDistribution.sol

@@ -119,6 +119,7 @@ contract BasicDistribution is
     }
 
     function _initializeBasicDistribution(
+        address registry,
         NftId instanceNftId,
         IAuthorization authorization, 
         address initialOwner,
@@ -129,6 +130,7 @@ contract BasicDistribution is
         onlyInitializing()
     {
         __Distribution_init(
+            registry, 
             instanceNftId, 
             authorization,
             false,

package/contracts/distribution/BasicDistributionAuthorization.sol

@@ -2,16 +2,15 @@
 pragma solidity ^0.8.20;
 
 import {IAccess} from "../authorization/IAccess.sol";
-import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 
 import {Authorization} from "../authorization/Authorization.sol";
 import {BasicDistribution} from "./BasicDistribution.sol"; 
 import {Distribution} from "./Distribution.sol";
 import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
 import {PUBLIC_ROLE} from "../type/RoleId.sol";
-import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {VersionPartLib} from "../type/Version.sol";
+
 
 contract BasicDistributionAuthorization
      is Authorization
@@ -21,7 +20,7 @@ contract BasicDistributionAuthorization
           Authorization(
                distributionName, 
                DISTRIBUTION(), 
-               GIF_INITIAL_RELEASE(),
+               3,
                COMMIT_HASH,
                TargetType.Component, 
                true)
@@ -61,7 +60,7 @@ contract BasicDistributionAuthorization
           _authorize(functions, BasicDistribution.changeDistributorType.selector, "changeDistributorType");
           _authorize(functions, BasicDistribution.createReferral.selector, "createReferral");
           
-          _authorize(functions, IComponent.withdrawFees.selector, "withdrawFees");
+          _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
           _authorize(functions, Distribution.withdrawCommission.selector, "withdrawCommission");
      }
 }

package/contracts/distribution/Distribution.sol

@@ -104,6 +104,7 @@ abstract contract Distribution is
 
 
     function __Distribution_init(
+        address registry,
         NftId productNftId,
         IAuthorization authorization, 
         bool isInterceptor,
@@ -115,6 +116,7 @@ abstract contract Distribution is
         onlyInitializing()
     {
         __InstanceLinkedComponent_init(
+            registry, 
             productNftId, 
             name, 
             DISTRIBUTION(), 

package/contracts/distribution/DistributionService.sol

@@ -20,6 +20,8 @@ import {KEEP_STATE} from "../type/StateId.sol";
 import {ObjectType, ACCOUNTING, COMPONENT, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, REGISTRY} from "../type/ObjectType.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+// TODO PoolLib feels wrong, should likely go in a component type independent lib
+import {PoolLib} from "../pool/PoolLib.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Service} from "../shared/Service.sol";
@@ -42,13 +44,14 @@ contract DistributionService is
     )
         internal
         virtual override
-        onlyInitializing()
+        initializer()
     {
         (
-            address authority
-        ) = abi.decode(data, (address));
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-        __Service_init(authority, owner);
+        __Service_init(authority, registry, owner);
 
         _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
@@ -78,7 +81,7 @@ contract DistributionService is
         (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
 
         {
-            NftId productNftId = _getRegistry().getParentNftId(distributionNftId);
+            NftId productNftId = getRegistry().getParentNftId(distributionNftId);
             IComponents.FeeInfo memory feeInfo = instance.getInstanceReader().getFeeInfo(productNftId);
 
             UFixed variableDistributionFees = feeInfo.distributionFee.fractionalFee;
@@ -109,7 +112,7 @@ contract DistributionService is
 
         instance.getInstanceStore().createDistributorType(distributorType, info);
 
-        emit LogDistributionServiceDistributorTypeCreated(distributionNftId, name);
+        emit LogDistributionServiceDistributorTypeCreated(distributionNftId, name, commissionPercentage);
     }
 
 
@@ -131,12 +134,11 @@ contract DistributionService is
                 NftIdLib.zero(), 
                 distributionNftId,
                 DISTRIBUTOR(),
-                getRelease(),
                 true, // intercepting property for bundles is defined on pool
-                address(0)),
-            distributor,
-            ""
-        );
+                address(0),
+                distributor,
+                ""
+            ));
 
         IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo({
             distributorType: distributorType,
@@ -195,11 +197,9 @@ contract DistributionService is
             revert ErrorDistributionServiceExpirationInvalid(expiryAt);
         }
 
-        {
-            NftId distributorDistributionNftId = _getRegistry().getParentNftId(distributorNftId);
-            if (distributorDistributionNftId != distributionNftId) {
-                revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
-            }
+        NftId distributorDistributionNftId = getRegistry().getParentNftId(distributorNftId);
+        if (distributorDistributionNftId != distributionNftId) {
+            revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
         }
 
         {
@@ -236,7 +236,7 @@ contract DistributionService is
 
             instance.getInstanceStore().createReferral(referralId, info);
 
-            emit LogDistributionServiceReferralCreated(distributionNftId, distributorNftId, referralId, code);
+            emit LogDistributionServiceReferralCreated(distributionNftId, distributorNftId, referralId, code, discountPercentage, maxReferrals, expiryAt);
         }
     }
 
@@ -251,7 +251,7 @@ contract DistributionService is
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
         if (referralIsValid(distributionNftId, referralId)) {
-            IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+            IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
@@ -272,7 +272,7 @@ contract DistributionService is
         restricted()
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
-        IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
@@ -295,12 +295,14 @@ contract DistributionService is
             IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
             distributorInfo.numPoliciesSold += 1;
             store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
+            emit LogDistributionServiceSaleProcessedWithReferral(distributionNftId, referralInfo.distributorNftId, referralId, distributorInfo.numPoliciesSold, premium.premiumAmount, distributionOwnerFee, commissionAmount);
         } else {
             // increase distribution balance by distribution owner fee
             _accountingService.increaseDistributionBalance(store, distributionNftId, AmountLib.zero(), distributionOwnerFee);
+            emit LogDistributionServiceSaleProcessed(distributionNftId, referralId, premium.premiumAmount, distributionOwnerFee);
         }
 
-        emit LogDistributionServiceSaleProcessed(distributionNftId, referralId);
+        
     }
 
     /// @inheritdoc IDistributionService
@@ -340,7 +342,7 @@ contract DistributionService is
 
         // transfer amount to distributor
         {
-            address distributor = _getRegistry().ownerOf(distributorNftId);
+            address distributor = getRegistry().ownerOf(distributorNftId);
             emit LogDistributionServiceCommissionWithdrawn(distributorNftId, distributor, address(distributionInfo.tokenHandler.TOKEN()), withdrawnAmount);
             distributionInfo.tokenHandler.pushToken(distributor, withdrawnAmount);
         }
@@ -357,7 +359,7 @@ contract DistributionService is
             return false;
         }
 
-        IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -438,11 +440,7 @@ contract DistributionService is
             IInstance instance
         )
     {
-        (poolNftId, instance) = ContractLib.getAndVerifyComponent(
-            msg.sender, 
-            DISTRIBUTION(), 
-            getRelease(), 
-            true);
+        return PoolLib.getAndVerifyActiveComponent(getRegistry(), msg.sender, DISTRIBUTION());
     }
 
 

package/contracts/distribution/DistributionServiceManager.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {DistributionService} from "./DistributionService.sol";
 
@@ -12,17 +12,19 @@ contract DistributionServiceManager is ProxyManager {
     /// @dev initializes proxy manager with distribution service implementation and deploys instance
     constructor(
         address authority, 
+        address registry,
         bytes32 salt
     ) 
     {
         DistributionService svc = new DistributionService{salt: salt}();
-        bytes memory data = abi.encode(authority);
-        IUpgradeable upgradeable = initialize(
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);
 
-        _distributionService = DistributionService(address(upgradeable));
+        _distributionService = DistributionService(address(versionable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/distribution/IDistributionService.sol

@@ -40,12 +40,13 @@ interface IDistributionService is IService {
     error ErrorDistributionServiceReferralDistributionMismatch(ReferralId referralId, NftId referralDistributionNft, NftId distributionNftId);
 
     event LogDistributionServiceCommissionWithdrawn(NftId distributorNftId, address recipient, address tokenAddress, Amount amount);
-    event LogDistributionServiceDistributorTypeCreated(NftId distributionNftId, string name);
+    event LogDistributionServiceDistributorTypeCreated(NftId distributionNftId, string name, UFixed commissionPercentage);
     event LogDistributionServiceDistributorCreated(NftId distributionNftId, NftId distributorNftId, DistributorType distributorType, address distributor);
     event LogDistributionServiceDistributorTypeChanged(NftId distributorNftId, DistributorType oldDistributorType, DistributorType newDistributorType);
-    event LogDistributionServiceReferralCreated(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, string code);
+    event LogDistributionServiceReferralCreated(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, string code, UFixed discountPercentage, uint32 maxReferrals, Timestamp expiryAt);
     event LogDistributionServiceReferralProcessed(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, uint32 usedReferrals);
-    event LogDistributionServiceSaleProcessed(NftId distributionNftId, ReferralId referralId);
+    event LogDistributionServiceSaleProcessed(NftId distributionNftId, ReferralId referralId, Amount premium, Amount distributionOwnerFee);
+    event LogDistributionServiceSaleProcessedWithReferral(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, uint32 numPoliciesSold, Amount premium, Amount distributionOwnerFee, Amount commissionAmount);
 
     function createDistributorType(
         string memory name,

package/contracts/examples/fire/FirePool.sol

@@ -16,6 +16,7 @@ contract FirePool is
     BasicPool
 {   
     constructor(
+        address registry,
         NftId fireProductNftId,
         string memory componentName,
         IAuthorization authorization
@@ -23,6 +24,7 @@ contract FirePool is
     {
         address initialOwner = msg.sender;
         _intialize(
+            registry,
             fireProductNftId,
             componentName,
             IComponents.PoolInfo({
@@ -39,6 +41,7 @@ contract FirePool is
     }
 
     function _intialize(
+        address registry,
         NftId fireProductNftId,
         string memory componentName,
         IComponents.PoolInfo memory poolInfo,
@@ -49,6 +52,7 @@ contract FirePool is
         initializer
     {
         _initializeBasicPool(
+            registry,
             fireProductNftId,
             componentName,
             poolInfo,

package/contracts/examples/fire/FireProduct.sol

@@ -65,6 +65,7 @@ contract FireProduct is
     mapping(uint256 fireId => mapping (NftId policyId => bool claimed)) private _claimed;
 
     constructor(
+        address registry,
         NftId instanceNftid,
         string memory componentName,
         IAuthorization authorization
@@ -73,6 +74,7 @@ contract FireProduct is
         address initialOwner = msg.sender;
 
         _initialize(
+            registry,
             instanceNftid,
             componentName,
             authorization,
@@ -80,6 +82,7 @@ contract FireProduct is
     }
 
     function _initialize(
+        address registry,
         NftId instanceNftId,
         string memory componentName,
         IAuthorization authorization,
@@ -89,6 +92,7 @@ contract FireProduct is
         initializer
     {
         _initializeBasicProduct(
+            registry,
             instanceNftId,
             componentName,
             IComponents.ProductInfo({