@etherisc/gif-next 0.0.2-b1fff40-773 → 0.0.2-b214449-558

package/contracts/authorization/IAuthorization.sol

@@ -11,16 +11,24 @@ interface IAuthorization is
      IAccess 
 {
 
-     /// @dev Returns the release (VersionPart) for which the authorizations are defined by this contract.
-     /// Matches with the release returned by the linked service authorization.
-     function getRelease() external view returns(VersionPart release);
+     error ErrorAuthorizationMainTargetNameEmpty();
+     error ErrorAuthorizationTargetDomainZero();
 
-     /// @dev Returns the list of involved roles.
-     function getRoles() external view returns(RoleId[] memory roles);
+     /// @dev Returns the list of service targets.
+     function getServiceDomains() external view returns(ObjectType[] memory serviceDomains);
 
      /// @dev Returns the service role for the specified service domain.
      function getServiceRole(ObjectType serviceDomain) external pure returns (RoleId serviceRoleId);
 
+     /// @dev Returns the service target for the specified domain.
+     function getServiceTarget(ObjectType serviceDomain) external view returns(Str serviceTarget);
+
+     /// @dev Returns the component role for the specified domain.
+     function getComponentRole(ObjectType componentDomain) external view returns(RoleId componentRoleId);
+
+     /// @dev Returns the list of involved roles.
+     function getRoles() external view returns(RoleId[] memory roles);
+
      /// @dev Returns the name for the provided role id.
      function getRoleInfo(RoleId roleId) external view returns (RoleInfo memory roleInfo);
 
@@ -30,10 +38,18 @@ interface IAuthorization is
      /// @dev Returns the main target id name as string.
      /// This name is used to derive the target id and a corresponding target role name
      /// Overwrite this function to change the basic pool target name.
-     function getTargetName() external view returns (string memory name);
+     function getMainTargetName() external view returns (string memory name);
 
      /// @dev Returns the main target.
-     function getTarget() external view returns(Str target);
+     function getMainTarget() external view returns(Str target);
+
+     /// @dev Returns the token hander name.
+     /// Only components have a token handler.
+     function getTokenHandlerName() external view returns(string memory name);
+
+     /// @dev Returns the token hander target.
+     /// Only components have a token handler.
+     function getTokenHandlerTarget() external view returns(Str target);
 
      /// @dev Returns the complete list of targets.
      function getTargets() external view returns(Str[] memory targets);
@@ -50,5 +66,9 @@ interface IAuthorization is
 
      /// @dev For the given target and role id the list of authorized functions is returned
      function getAuthorizedFunctions(Str target, RoleId roleId) external view returns(FunctionInfo[] memory authorizatedFunctions);
+
+     /// @dev Returns the release (VersionPart) for which the authorizations are defined by this contract.
+     /// Matches with the release returned by the linked service authorization.
+     function getRelease() external view returns(VersionPart release);
 }
 

package/contracts/authorization/IServiceAuthorization.sol

@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
 import {IAccess} from "../authorization/IAccess.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 
-interface IServiceAuthorization {
+interface IServiceAuthorization is IERC165 {
 
      /// @dev Returns the commit hash representing the deployed release
      function getCommitHash()

package/contracts/authorization/ServiceAuthorization.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+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";
@@ -10,30 +12,36 @@ 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 = 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 => IAccess.FunctionInfo[] functions)) internal _authorizedFunctions;
 
-     constructor(string memory commitHash) {
-          _commitHash = commitHash;
+     constructor(string memory commitHash, uint256 version) {
+          assert(bytes(commitHash).length == COMMIT_HASH_LENGTH);
+          assert(version >= GIF_INITIAL_VERSION);
+
+          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) {
-          return VersionPartLib.toVersionPart(GIF_VERSION_3);
+          return VersionPartLib.toVersionPart(VERSION);
      }
 
      function getServiceDomains() external view returns(ObjectType[] memory serviceDomains) {
@@ -56,6 +64,15 @@ contract ServiceAuthorization
           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 {}
 
@@ -86,5 +103,4 @@ contract ServiceAuthorization
                     name: StrLib.toStr(name),
                     createdAt: TimestampLib.blockTimestamp()}));
      }
-}
-
+}

package/contracts/distribution/BasicDistribution.sol

@@ -1,25 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
 import {Distribution} from "./Distribution.sol";
+import {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 {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 {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, TimestampLib} from "../type/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 
 contract BasicDistribution is
@@ -54,8 +44,8 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyOwner()
         restricted()
+        onlyOwner()
         returns (DistributorType distributorType)
     {
         return _createDistributorType(
@@ -77,24 +67,25 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyOwner()
         restricted()
+        onlyOwner()
         returns(NftId distributorNftId)
     {
         return _createDistributor(distributor, distributorType, data);
     }
 
-    function updateDistributorType(
+    function changeDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
     )
         external
         virtual
-        onlyOwner()
         restricted()
+        onlyOwner()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
     {
-        _updateDistributorType(distributorNftId, distributorType, data);
+        _changeDistributorType(distributorNftId, distributorType, data);
     }
 
     /**
@@ -110,8 +101,8 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyDistributor()
         restricted()
+        onlyDistributor()
         returns (ReferralId referralId)
     {
         NftId distributorNftId = getDistributorNftId(msg.sender);
@@ -143,7 +134,6 @@ contract BasicDistribution is
             initialOwner, 
             name, 
             token, 
-            "", // registry data
             ""); // component specifc data
     }
 }

package/contracts/distribution/BasicDistributionAuthorization.sol

@@ -1,13 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccess} from "../authorization/IAccess.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
 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";
+import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
+import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 
 
 contract BasicDistributionAuthorization
@@ -15,16 +17,27 @@ contract BasicDistributionAuthorization
 {
 
      constructor(string memory distributionlName)
-          Authorization(distributionlName)
+          Authorization(distributionlName, DISTRIBUTION())
      {}
 
-     function _setupTargets()
+     function _setupServiceTargets()
           internal
           virtual override
      {
-          _addComponentTargetWithRole(DISTRIBUTION()); // basic target
+          _addServiceTargetWithRole(COMPONENT());
      }
 
+     function _setupTokenHandlerAuthorizations() internal virtual override {
+          IAccess.FunctionInfo[] storage functions;
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(COMPONENT()));
+          _authorize(functions, TokenHandler.approve.selector, "approve");
+          _authorize(functions, TokenHandler.setWallet.selector, "setWallet");
+          _authorize(functions, TokenHandler.pushFeeToken.selector, "pushFeeToken");
+
+          // authorize token handler functions for pool service role
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(DISTRIBUTION()));
+          _authorize(functions, TokenHandler.pushToken.selector, "pushToken");
+     }
 
      function _setupTargetAuthorizations()
           internal
@@ -33,11 +46,11 @@ contract BasicDistributionAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          functions = _authorizeForTarget(getMainTargetName(), 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.changeDistributorType.selector, "changeDistributorType");
           _authorize(functions, BasicDistribution.createReferral.selector, "createReferral");
           
           _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");

package/contracts/distribution/Distribution.sol

@@ -1,25 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-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
@@ -42,13 +36,30 @@ abstract contract Distribution is
         _;
     }
 
-    function register()
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
         external
         virtual
-        onlyOwner()
+        restricted()
     {
-        _getDistributionStorage()._componentService.registerDistribution();
-        _approveTokenHandler(type(uint256).max);
+        // default is no action
+    }
+
+
+    /// @inheritdoc IDistributionComponent
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyDistributor()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        onlyNftOwner(distributorNftId)
+        returns (Amount withdrawnAmount) 
+    {
+        return _withdrawCommission(distributorNftId, amount);
     }
 
 
@@ -112,42 +123,19 @@ abstract contract Distribution is
     }
 
 
-    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()
-        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 
     )
         internal
@@ -156,21 +144,20 @@ abstract contract Distribution is
     {
         _initializeInstanceLinkedComponent(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
             token, 
             DISTRIBUTION(), 
             authorization,
             true, 
             initialOwner, 
-            registryData, 
             componentData);
 
         DistributionStorage storage $ = _getDistributionStorage();
         $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
-        registerInterface(type(IDistributionComponent).interfaceId);
+        _registerInterface(type(IDistributionComponent).interfaceId);
     }
 
     /// @dev Sets the distribution fees to the provided values.
@@ -239,7 +226,7 @@ abstract contract Distribution is
     }
 
     /// @dev Uptates the distributor type for the specified distributor.
-    function _updateDistributorType(
+    function _changeDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
@@ -248,11 +235,10 @@ abstract contract Distribution is
         virtual
     {
         DistributionStorage storage $ = _getDistributionStorage();
-        // TODO re-enable once implemented
-        // $._distributionService.updateDistributorType(
-        //     distributorNftId,
-        //     distributorType,
-        //     data);
+        $._distributionService.changeDistributorType(
+            distributorNftId,
+            distributorType,
+            data);
     }
 
     /// @dev Create a new referral code for the provided distributor.
@@ -285,9 +271,9 @@ abstract contract Distribution is
         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);