@etherisc/gif-next 0.0.2-c0dadcd-773 → 0.0.2-c16a73d-798

package/contracts/{registry → authorization}/ServiceAuthorization.sol

@@ -1,47 +1,57 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessAdmin} from "../shared/IAccessAdmin.sol";
-import {ObjectType} from "../../contracts/type/ObjectType.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+import {IAccess} from "../authorization/IAccess.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {IServiceAuthorization} from "./IServiceAuthorization.sol";
-import {SelectorLib} from "../../contracts/type/Selector.sol";
-import {StrLib} from "../../contracts/type/String.sol";
-import {VersionPart, VersionPartLib} from "../../contracts/type/Version.sol";
+import {SelectorLib} from "../type/Selector.sol";
+import {StrLib} from "../type/String.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 /// @dev Base contract for release specific service authorization contracts.
-contract ServiceAuthorization
-     is IServiceAuthorization
+contract ServiceAuthorization is 
+     IServiceAuthorization
 {
-     uint256 public constant GIF_VERSION = 3;
+     uint256 public constant COMMIT_HASH_LENGTH = 40;
+     uint256 public constant GIF_INITIAL_VERSION = 3;
 
-     string private _commitHash;
+     uint256 public immutable VERSION;
+     string public COMMIT_HASH;
 
      ObjectType[] internal _serviceDomains;
      mapping(ObjectType domain => address service) internal _serviceAddress;
      mapping(ObjectType domain => ObjectType[] authorizedDomains) internal _authorizedDomains;
-     mapping(ObjectType domain => mapping(ObjectType authorizedDomain => IAccessAdmin.Function[] functions)) internal _authorizedFunctions;
+     mapping(ObjectType domain => mapping(ObjectType authorizedDomain => IAccess.FunctionInfo[] functions)) internal _authorizedFunctions;
+
+     constructor(string memory commitHash, uint256 version) {
+          assert(bytes(commitHash).length == COMMIT_HASH_LENGTH);
+          assert(version >= GIF_INITIAL_VERSION);
 
-     constructor(string memory commitHash) {
-          _commitHash = commitHash;
+          COMMIT_HASH = commitHash;
+          VERSION = version;
           _setupDomains();
           _setupDomainAuthorizations();
      }
 
      function getCommitHash() external view returns(string memory commitHash) {
-          return _commitHash;
+          return COMMIT_HASH;
      }
 
-     function getRelease() external view returns(VersionPart release, uint domainsCount) {
-          return (
-               VersionPartLib.toVersionPart(GIF_VERSION),
-               _serviceDomains.length
-          );
+     function getRelease() external view returns(VersionPart release) {
+          return VersionPartLib.toVersionPart(VERSION);
      }
 
      function getServiceDomains() external view returns(ObjectType[] memory serviceDomains) {
           return _serviceDomains;
      }
 
+     function getServiceDomain(uint idx) external view returns(ObjectType serviceDomain) {
+          return _serviceDomains[idx];
+     }
+
      function getServiceAddress(ObjectType serviceDomain) external view returns(address service) {
           return _serviceAddress[serviceDomain];
      }
@@ -50,10 +60,19 @@ contract ServiceAuthorization
           return _authorizedDomains[serviceDomain];
      }
 
-     function getAuthorizedFunctions(ObjectType serviceDomain, ObjectType authorizedDomain) external view returns(IAccessAdmin.Function[] memory authorizatedFunctions) {
+     function getAuthorizedFunctions(ObjectType serviceDomain, ObjectType authorizedDomain) external view returns(IAccess.FunctionInfo[] memory authorizatedFunctions) {
           return _authorizedFunctions[serviceDomain][authorizedDomain];
      }
 
+     // ERC165
+     function supportsInterface(bytes4 interfaceId) public pure returns (bool) {
+          return (
+               interfaceId == type(IServiceAuthorization).interfaceId || 
+               interfaceId == type(IERC165).interfaceId
+          );
+     }
+
+
      /// @dev Overwrite this function for a specific realease.
      function _setupDomains() internal virtual {}
 
@@ -67,20 +86,21 @@ contract ServiceAuthorization
           _serviceAddress[serviceDomain] = serviceAddress;
      }
 
+     /// @dev Use this method to authorize the specified domain to access the service domain.
      function _authorizeForService(ObjectType serviceDomain, ObjectType authorizedDomain)
           internal
-          returns (IAccessAdmin.Function[] storage authorizatedFunctions)
+          returns (IAccess.FunctionInfo[] storage authorizatedFunctions)
      {
           _authorizedDomains[serviceDomain].push(authorizedDomain);
           return _authorizedFunctions[serviceDomain][authorizedDomain];
      }
 
      /// @dev Use this method to authorize a specific function authorization
-     function _authorize(IAccessAdmin.Function[] storage functions, bytes4 selector, string memory name) internal {
+     function _authorize(IAccess.FunctionInfo[] storage functions, bytes4 selector, string memory name) internal {
           functions.push(
-               IAccessAdmin.Function({
+               IAccess.FunctionInfo({
                     selector: SelectorLib.toSelector(selector),
-                    name: StrLib.toStr(name)}));
+                    name: StrLib.toStr(name),
+                    createdAt: TimestampLib.blockTimestamp()}));
      }
-}
-
+}

package/contracts/distribution/BasicDistribution.sol

@@ -0,0 +1,139 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Distribution} from "./Distribution.sol";
+import {DISTRIBUTOR} from "../type/ObjectType.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {NftId} from "../type/NftId.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {Fee} from "../type/Fee.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+
+
+contract BasicDistribution is
+    Distribution
+{
+
+    function setFees(
+        Fee memory distributionFee,
+        Fee memory minDistributionOwnerFee
+    )
+        external
+        virtual
+        onlyOwner()
+        restricted()
+    {
+        _setFees(
+            distributionFee, 
+            minDistributionOwnerFee);
+    }
+
+
+    function createDistributorType(
+        string memory name,
+        UFixed minDiscountPercentage,
+        UFixed maxDiscountPercentage,
+        UFixed commissionPercentage,
+        uint32 maxReferralCount,
+        uint32 maxReferralLifetime,
+        bool allowSelfReferrals,
+        bool allowRenewals,
+        bytes memory data
+    )
+        external
+        virtual
+        onlyOwner()
+        restricted()
+        returns (DistributorType distributorType)
+    {
+        return _createDistributorType(
+            name,
+            minDiscountPercentage,
+            maxDiscountPercentage,
+            commissionPercentage,
+            maxReferralCount,
+            maxReferralLifetime,
+            allowSelfReferrals,
+            allowRenewals,
+            data);
+    }
+
+    function createDistributor(
+        address distributor,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        external
+        virtual
+        onlyOwner()
+        restricted()
+        returns(NftId distributorNftId)
+    {
+        return _createDistributor(distributor, distributorType, data);
+    }
+
+    function updateDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        external
+        virtual
+        onlyOwner()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        restricted()
+    {
+        _updateDistributorType(distributorNftId, distributorType, data);
+    }
+
+    /**
+     * @dev lets distributors create referral codes.
+     * referral codes need to be unique
+     */
+    function createReferral(
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        external
+        virtual
+        onlyDistributor()
+        restricted()
+        returns (ReferralId referralId)
+    {
+        NftId distributorNftId = getDistributorNftId(msg.sender);
+        return _createReferral(
+            distributorNftId,
+            code,
+            discountPercentage,
+            maxReferrals,
+            expiryAt,
+            data); // data
+    }
+
+    function _initializeBasicDistribution(
+        address registry,
+        NftId instanceNftId,
+        IAuthorization authorization, 
+        address initialOwner,
+        string memory name,
+        address token
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _initializeDistribution(
+            registry, 
+            instanceNftId, 
+            authorization,
+            initialOwner, 
+            name, 
+            token, 
+            ""); // component specifc data
+    }
+}

package/contracts/distribution/BasicDistributionAuthorization.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Authorization} from "../authorization/Authorization.sol";
+import {BasicDistribution} from "./BasicDistribution.sol"; 
+import {Distribution} from "./Distribution.sol";
+import {DISTRIBUTION} from "../type/ObjectType.sol";
+import {IAccess} from "../authorization/IAccess.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
+
+
+contract BasicDistributionAuthorization
+     is Authorization
+{
+
+     constructor(string memory distributionlName)
+          Authorization(distributionlName)
+     {}
+
+     function _setupTargets()
+          internal
+          virtual override
+     {
+          _addComponentTargetWithRole(DISTRIBUTION()); // basic target
+     }
+
+
+     function _setupTargetAuthorizations()
+          internal
+          virtual override
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize public role (open access to any account, only allows to lock target)
+          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          _authorize(functions, BasicDistribution.setFees.selector, "setFees");
+          _authorize(functions, BasicDistribution.createDistributorType.selector, "createDistributorType");
+          _authorize(functions, BasicDistribution.createDistributor.selector, "createDistributor");
+          _authorize(functions, BasicDistribution.updateDistributorType.selector, "updateDistributorType");
+          _authorize(functions, BasicDistribution.createReferral.selector, "createReferral");
+          
+          _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
+          _authorize(functions, Distribution.withdrawCommission.selector, "withdrawCommission");
+     }
+}
+

package/contracts/distribution/Distribution.sol

@@ -1,23 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
+import {Amount} from "../type/Amount.sol";
+import {COMPONENT, DISTRIBUTION, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IDistributionService} from "./IDistributionService.sol";
-import {IProductService} from "../product/IProductService.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
+import {Fee} from "../type/Fee.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
-import {IDistribution} from "../instance/module/IDistribution.sol";
 import {IDistributionComponent} from "./IDistributionComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {DistributorType} from "../type/DistributorType.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 
 abstract contract Distribution is
@@ -33,54 +29,149 @@ abstract contract Distribution is
         mapping(address distributor => NftId distributorNftId) _distributorNftId;
     }
 
-    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+    modifier onlyDistributor() {
+        if (!isDistributor(msg.sender)) {
+            revert ErrorDistributionNotDistributor(msg.sender);
+        }
+        _;
+    }
+
+
+    function isDistributor(address candidate)
+        public
+        view
+        returns (bool)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        return $._distributorNftId[candidate].gtz();
+    }
+
+
+    function getDistributorNftId(address distributor)
+        public
+        view
+        returns (NftId distributorNftId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        return $._distributorNftId[distributor];
+    }
 
-    function initializeDistribution(
+
+    function getDiscountPercentage(string memory referralCode)
+        external
+        view
+        returns (
+            UFixed discountPercentage, 
+            ReferralStatus status
+        )
+    {
+        ReferralId referralId = getReferralId(referralCode);
+        return _getInstanceReader().getDiscountPercentage(referralId);
+    }
+
+
+    function getReferralId(
+        string memory referralCode
+    )
+        public
+        view 
+        returns (ReferralId referralId)
+    {
+        return ReferralLib.toReferralId(
+            getNftId(), 
+            referralCode);      
+    }
+
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        // default is no fees
+        return 0 * netPremiumAmount;
+    }
+
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        virtual
+        restricted()
+    {
+        // default is no action
+    }
+
+    /// @dev Returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external pure returns (bool verifying) {
+        return true;
+    }
+
+    /// @inheritdoc IDistributionComponent
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyDistributor()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        onlyNftOwner(distributorNftId)
+        returns (Amount withdrawnAmount) 
+    {
+        return _withdrawCommission(distributorNftId, amount);
+    }
+        
+    function _initializeDistribution(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
+        IAuthorization authorization, 
         address initialOwner,
         string memory name,
         address token,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // component specifidc data 
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, registryData, componentData);
+        _initializeInstanceLinkedComponent(
+            registry, 
+            productNftId, 
+            name, 
+            token, 
+            DISTRIBUTION(), 
+            authorization,
+            true, 
+            initialOwner, 
+            componentData);
 
         DistributionStorage storage $ = _getDistributionStorage();
         $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
-        registerInterface(type(IDistributionComponent).interfaceId);
-    }
-
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getDistributionStorage()._componentService.registerDistribution();
+        _registerInterface(type(IDistributionComponent).interfaceId);
     }
 
-    function setFees(
+    /// @dev Sets the distribution fees to the provided values.
+    function _setFees(
         Fee memory distributionFee,
         Fee memory minDistributionOwnerFee
     )
-        external
-        override
-        onlyOwner()
-        restricted()
+        internal
+        virtual
     {
         _getDistributionStorage()._componentService.setDistributionFees(
             distributionFee, 
             minDistributionOwnerFee);
     }
 
-
-    function createDistributorType(
+    /// @dev Creates a new distributor type using the provided parameters.
+    function _createDistributorType(
         string memory name,
         UFixed minDiscountPercentage,
         UFixed maxDiscountPercentage,
@@ -91,7 +182,8 @@ abstract contract Distribution is
         bool allowRenewals,
         bytes memory data
     )
-        public
+        internal
+        virtual
         returns (DistributorType distributorType)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -107,12 +199,14 @@ abstract contract Distribution is
             data);
     }
 
-    function createDistributor(
+    /// @dev Turns the provided account into a new distributor of the specified type.
+    function _createDistributor(
         address distributor,
         DistributorType distributorType,
         bytes memory data
     )
-        public
+        internal
+        virtual
         returns(NftId distributorNftId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -128,14 +222,14 @@ abstract contract Distribution is
         $._distributorNftId[distributor] = distributorNftId;
     }
 
-    function updateDistributorType(
+    /// @dev Uptates the distributor type for the specified distributor.
+    function _updateDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
     )
-        public
-        // TODO figure out what we need for authz
-        // and add it
+        internal
+        virtual
     {
         DistributionStorage storage $ = _getDistributionStorage();
         // TODO re-enable once implemented
@@ -145,10 +239,7 @@ abstract contract Distribution is
         //     data);
     }
 
-    /**
-     * @dev lets distributors create referral codes.
-     * referral codes need to be unique
-     */
+    /// @dev Create a new referral code for the provided distributor.
     function _createReferral(
         NftId distributorNftId,
         string memory code,
@@ -158,6 +249,7 @@ abstract contract Distribution is
         bytes memory data
     )
         internal
+        virtual
         returns (ReferralId referralId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -170,88 +262,20 @@ abstract contract Distribution is
             data);
     }
 
-    function isDistributor(address candidate)
-        public
-        view
-        returns (bool)
-    {
-        DistributionStorage storage $ = _getDistributionStorage();
-        return $._distributorNftId[candidate].gtz();
-    }
-
-    function getDistributorNftId(address distributor)
-        public
-        view
-        returns (NftId distributorNftId)
-    {
-        DistributionStorage storage $ = _getDistributionStorage();
-        return $._distributorNftId[distributor];
-    }
-
-    function getDiscountPercentage(string memory referralCode)
-        external
-        view
-        returns (
-            UFixed discountPercentage, 
-            ReferralStatus status
-        )
-    {
-        ReferralId referralId = getReferralId(referralCode);
-        return _getInstanceReader().getDiscountPercentage(referralId);
-    }
-
-
-    function getReferralId(
-        string memory referralCode
-    )
-        public
-        view 
-        returns (ReferralId referralId)
-    {
-        return ReferralLib.toReferralId(
-            getNftId(), 
-            referralCode);      
-    }
-
-    function calculateRenewalFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        // default is no fees
-        return 0 * netPremiumAmount;
-    }
-
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        onlyOwner
-        restricted()
-        virtual override
+    function _withdrawCommission(NftId distributorNftId, Amount amount) 
+        internal
+        returns (Amount withdrawnAmount) 
     {
-        // default is no action
+        return _getDistributionStorage()._distributionService.withdrawCommission(distributorNftId, amount);
     }
 
-
-    function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
+    function _nftTransferFrom(address from, address to, uint256 tokenId, address operator) internal virtual override {
         // keep track of distributor nft owner
-        emit LogDistributorUpdated(to, msg.sender);
+        emit LogDistributorUpdated(to, operator);
         DistributionStorage storage $ = _getDistributionStorage();
         $._distributorNftId[from] = NftIdLib.zero();
         $._distributorNftId[to] = NftIdLib.toNftId(tokenId);
     }
-    
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
-    function isVerifying() external pure returns (bool verifying) {
-        return true;
-    }
 
     function _getDistributionStorage() private pure returns (DistributionStorage storage $) {
         assembly {