@etherisc/gif-next 0.0.2-770fd3b-604 → 0.0.2-77a1ccf-469

package/contracts/components/Component.sol

@@ -18,6 +18,7 @@ import {VersionPart} from "../types/Version.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RoleId, RoleIdLib} from "../types/RoleId.sol";
 import {IAccess} from "../instance/module/IAccess.sol";
+import {VersionPart} from "../types/Version.sol";
 
 // TODO discuss to inherit from oz accessmanaged
 // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
@@ -28,40 +29,21 @@ abstract contract Component is
     AccessManagedUpgradeable
 {
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Component.sol")) - 1)) & ~bytes32(uint256(0xff));
-    bytes32 public constant CONTRACT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
+    bytes32 public constant COMPONENT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
 
     struct ComponentStorage {
-        IInstance _instance; // instance for this component
-        InstanceReader _instanceReader; // instance reader for this component
         string _name; // unique (per instance) component name
         IERC20Metadata _token; // token for this component
+        IInstance _instance; // instance for this component
         address _wallet; // wallet for this component (default = component contract itself)
+        InstanceReader _instanceReader; // instance reader for this component
         bool _isNftInterceptor; // declares if component is involved in nft transfers
-        IInstanceService _instanceService; // instance service for this component
-
         NftId _productNftId; // only relevant for components that are linked to a aproduct
-        IProductService _productService; // product service for component, might not be relevant for some component types (eg oracles)
-    }
-
-
-    modifier onlyChainNft() {
-        if(msg.sender != getRegistry().getChainNftAddress()) {
-            revert ErrorComponentNotChainNft(msg.sender);
-        }
-        _;
-    }
-
-
-    modifier onlyProductService() {
-        if(msg.sender != address(_getComponentStorage()._productService)) {
-            revert ErrorComponentNotProductService(msg.sender);
-        }
-        _;
     }
 
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
-            $.slot := CONTRACT_LOCATION_V1
+            $.slot := COMPONENT_LOCATION_V1
         }
     }
 
@@ -73,78 +55,44 @@ abstract contract Component is
         ObjectType componentType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
         onlyInitializing()
     {
-        ComponentStorage storage $ = _getComponentStorage();
-        initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
-
-        // set unique name of component
-        $._name = name;
-        $._isNftInterceptor = isInterceptor;
+        initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, registryData);
 
         // set and check linked instance
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        $._instance = IInstance(instanceInfo.objectAddress);
+        ComponentStorage storage $ = _getComponentStorage();
+        $._instance = IInstance(
+            getRegistry().getObjectInfo(instanceNftId).objectAddress);
+
         if(!$._instance.supportsInterface(type(IInstance).interfaceId)) {
-            revert ErrorComponentNotInstance(instanceNftId, instanceInfo.objectAddress);
+            revert ErrorComponentNotInstance(instanceNftId);
         }
 
         // initialize AccessManagedUpgradeable
         __AccessManaged_init($._instance.authority());
 
-        // set linked services
-        VersionPart gifVersion = $._instance.getMajorVersion();
-        $._instanceService = IInstanceService(getRegistry().getServiceAddress(INSTANCE(), gifVersion));
+        // set component state
+        $._name = name;
+        $._isNftInterceptor = isInterceptor;
         $._instanceReader = $._instance.getInstanceReader();
-        $._productService = IProductService(getRegistry().getServiceAddress(PRODUCT(), gifVersion));
-
-        // set wallet and token
         $._wallet = address(this);
         $._token = IERC20Metadata(token);
 
         registerInterface(type(IComponent).interfaceId);
     }
 
-    /// @dev callback function for nft transfers. may only be called by chain nft contract.
-    /// default implementation is empty. overriding functions MUST add onlyChainNft modifier
-    function nftTransferFrom(address from, address to, uint256 tokenId)
-        external
-        virtual override
-        onlyChainNft()
-    { }
-
-    // TODO discuss replacement with modifier restricted from accessmanaged
     function lock() external onlyOwner override {
-        _getComponentStorage()._instanceService.setTargetLocked(getName(), true);
+        IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), true);
     }
     
     function unlock() external onlyOwner override {
-        _getComponentStorage()._instanceService.setTargetLocked(getName(), false);
+        IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), false);
     }
 
-    // only product service may set product nft id during registration of product setup
-    function setProductNftId(NftId productNftId)
-        external
-        override
-        onlyProductService() 
-    {
-        ComponentStorage storage $ = _getComponentStorage();
-
-        if($._productNftId.gtz()) {
-            revert ErrorComponentProductNftAlreadySet();
-        }
-
-        $._productNftId = productNftId;
-    }
-
-    /// @dev Sets the wallet address for the component. 
-    /// if the current wallet has tokens, these will be transferred. 
-    /// if the new wallet address is externally owned, an approval from the 
-    /// owner of the external wallet for the component to move all tokens must exist. 
     function setWallet(address newWallet)
         external
         override
@@ -159,8 +107,9 @@ abstract contract Component is
         if (newWallet == address(0)) {
             revert ErrorComponentWalletAddressZero();
         }
+
         if (newWallet == currentWallet) {
-            revert ErrorComponentWalletAddressIsSameAsCurrent(newWallet);
+            revert ErrorComponentWalletAddressIsSameAsCurrent();
         }
 
         if (currentBalance > 0) {
@@ -177,7 +126,7 @@ abstract contract Component is
 
         // effects
         $._wallet = newWallet;
-        emit LogComponentWalletAddressChanged(newWallet);
+        emit LogComponentWalletAddressChanged(currentWallet, newWallet);
 
         // interactions
         if (currentBalance > 0) {
@@ -192,11 +141,41 @@ abstract contract Component is
         }
     }
 
-    function getWallet()
-        public
-        view
+    function setProductNftId(NftId productNftId)
+        external
         override
-        returns (address walletAddress)
+    {
+        ComponentStorage storage $ = _getComponentStorage();
+
+        // verify caller is product service
+        if(msg.sender != _getServiceAddress(PRODUCT())) {
+            revert ErrorComponentNotProductService(msg.sender);
+        }
+
+        // verify component is not yet linked to a product
+        if($._productNftId.gtz()) {
+            revert ErrorComponentProductNftAlreadySet();
+        }
+
+        $._productNftId = productNftId;
+    }
+
+    /// @dev callback function for nft transfers
+    /// may only be called by chain nft contract.
+    /// do not override this function to implement business logic for handling transfers
+    /// override internal function _nftTransferFrom instead
+    function nftTransferFrom(address from, address to, uint256 tokenId)
+        external
+        virtual override
+    {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert ErrorComponentNotChainNft(msg.sender);
+        }
+
+        _nftTransferFrom(from, to, tokenId);
+    }
+
+    function getWallet() public view override returns (address walletAddress)
     {
         return _getComponentStorage()._wallet;
     }
@@ -213,10 +192,6 @@ abstract contract Component is
         return _getComponentStorage()._instance;
     }
 
-    function getInstanceReader() public view returns (InstanceReader reader) {
-        return _getComponentStorage()._instanceReader;
-    }
-
     function getName() public view override returns(string memory name) {
         return _getComponentStorage()._name;
     }
@@ -225,12 +200,22 @@ abstract contract Component is
         return _getComponentStorage()._productNftId;
     }
 
-    function getInstanceService() public view returns (IInstanceService) {
-        return _getComponentStorage()._instanceService;
-    }
+    /// @dev internal function for nft transfers.
+    /// handling logic that deals with nft transfers need to overwrite this function
+    function _nftTransferFrom(address from, address to, uint256 tokenId)
+        internal
+        virtual
+    { }
 
-    function getProductService() public view returns (IProductService) {
-        return _getComponentStorage()._productService;
+    /// @dev returns reader for linked instance
+    function _getInstanceReader() internal view returns (InstanceReader reader) {
+        return _getComponentStorage()._instanceReader;
     }
 
+    /// @dev returns the service address for the specified domain
+    /// gets address via lookup from registry using the major version form the linked instance
+    function _getServiceAddress(ObjectType domain) internal view returns (address service) {
+        VersionPart majorVersion = _getComponentStorage()._instance.getMajorVersion();
+        return getRegistry().getServiceAddress(domain, majorVersion);
+    }
 }

package/contracts/components/Distribution.sol

@@ -4,10 +4,11 @@ pragma solidity ^0.8.19;
 import {DISTRIBUTION} from "../types/ObjectType.sol";
 import {IDistributionService} from "../instance/service/IDistributionService.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {NftId, zeroNftId, NftIdLib, toNftId} from "../types/NftId.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../types/Referral.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
 import {Component} from "./Component.sol";
+import {IDistribution} from "../instance/module/IDistribution.sol";
 import {IDistributionComponent} from "./IDistributionComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
@@ -17,7 +18,8 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {UFixed} from "../types/UFixed.sol";
 import {DistributorType} from "../types/DistributorType.sol";
-import {Timestamp} from "../types/Timestamp.sol";
+import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 
 
 abstract contract Distribution is
@@ -28,6 +30,7 @@ abstract contract Distribution is
     bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
 
     struct DistributionStorage {
+        Fee _minDistributionOwnerFee;
         Fee _distributionFee;
         TokenHandler _tokenHandler;
         IDistributionService _distributionService;
@@ -39,18 +42,20 @@ abstract contract Distribution is
         NftId instanceNftId,
         string memory name,
         address token,
+        Fee memory minDistributionOwnerFee,
         Fee memory distributionFee,
         address initialOwner,
-        bytes memory data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
         onlyInitializing()
     {
-        initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, data);
+        initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, registryData);
 
         DistributionStorage storage $ = _getDistributionStorage();
         // TODO add validation
+        $._minDistributionOwnerFee = minDistributionOwnerFee;
         $._distributionFee = distributionFee;
         $._tokenHandler = new TokenHandler(token);
         $._distributionService = getInstance().getDistributionService();
@@ -59,6 +64,7 @@ abstract contract Distribution is
     }
 
     function setFees(
+        Fee memory minDistributionOwnerFee,
         Fee memory distributionFee
     )
         external
@@ -66,7 +72,7 @@ abstract contract Distribution is
         onlyOwner
         restricted()
     {
-        _getDistributionStorage()._distributionService.setFees(distributionFee);
+        _getDistributionStorage()._distributionService.setFees(minDistributionOwnerFee, distributionFee);
     }
 
     function getDistributionFee() external view returns (Fee memory distributionFee) {
@@ -140,7 +146,7 @@ abstract contract Distribution is
      * @dev lets distributors create referral codes.
      * referral codes need to be unique
      */
-    function createReferral(
+    function _createReferral(
         NftId distributorNftId,
         string memory code,
         UFixed discountPercentage,
@@ -148,8 +154,7 @@ abstract contract Distribution is
         Timestamp expiryAt,
         bytes memory data
     )
-        public
-        // TODO add authz (only active distributor)
+        internal
         returns (ReferralId referralId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -162,22 +167,6 @@ abstract contract Distribution is
             data);
     }
 
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
-        Fee memory fee = setupInfo.distributionFee;
-        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
-        // TODO: use this? 
-        // return _distributionService.calculateFeeAmount(referralId, premiumAmount);        
-    }
-
     function isDistributor(address candidate)
         public
         view
@@ -205,7 +194,7 @@ abstract contract Distribution is
         )
     {
         ReferralId referralId = getReferralId(referralCode);
-        return getInstanceReader().getDiscountPercentage(referralId);
+        return _getInstanceReader().getDiscountPercentage(referralId);
     }
 
 
@@ -259,11 +248,6 @@ abstract contract Distribution is
         // default is no action
     }
 
-    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
-        // default is invalid
-        return false;
-    }
-
     function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
         InstanceReader reader = getInstance().getInstanceReader();
         setupInfo = reader.getDistributionSetupInfo(getNftId());
@@ -279,10 +263,21 @@ abstract contract Distribution is
         return ISetup.DistributionSetupInfo(
             zeroNftId(),
             $._tokenHandler,
+            $._minDistributionOwnerFee,
             $._distributionFee,
-            address(this)
+            address(this),
+            0
         );
     }
+
+
+    function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
+        // keep track of distributor nft owner
+        emit LogDistributorUpdated(to, msg.sender);
+        DistributionStorage storage $ = _getDistributionStorage();
+        $._distributorNftId[from] = zeroNftId();
+        $._distributorNftId[to] = toNftId(tokenId);
+    }
     
 
     /// @dev returns true iff the component needs to be called when selling/renewing policis

package/contracts/components/IComponent.sol

@@ -3,48 +3,66 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
 
+/// @dev component base class
+/// component examples are product, distribution, pool and oracle
 interface IComponent is 
     IRegisterable,
     ITransferInterceptor
 {
-
     error ErrorComponentNotChainNft(address caller);
     error ErrorComponentNotProductService(address caller);
-    error ErrorComponentNotInstance(NftId instanceNftId, address instance);
+    error ErrorComponentNotInstance(NftId instanceNftId);
     error ErrorComponentProductNftAlreadySet();
+
     error ErrorComponentWalletAddressZero();
-    error ErrorComponentWalletAddressIsSameAsCurrent(address newWallet);
+    error ErrorComponentWalletAddressIsSameAsCurrent();
     error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
-    error ErrorComponentUnauthorized(address caller, uint64 requiredRoleIdNum);
 
-    event LogComponentWalletAddressChanged(address newWallet);
+    event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
 
-    function getName() external view returns (string memory name);
-
-    // TODO remove and replace with accessmanaged target locking mechanism
+    /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
+    /// only component owner (nft holder) is authorizes to call this function
     function lock() external;
-    function unlock() external;
 
-    function getToken() external view returns (IERC20Metadata token);
+    /// @dev unlocks component to (re-)enable functions that may change state related to this component
+    /// only component owner (nft holder) is authorizes to call this function
+    function unlock() external;
 
+    /// @dev sets the wallet address for the component
+    /// if the current wallet has tokens, these will be transferred
+    /// if the new wallet address is externally owned, an approval from the 
+    /// owner of the external wallet for the component to move all tokens must exist
     function setWallet(address walletAddress) external;
-    function getWallet() external view returns (address walletAddress);
 
-    function isNftInterceptor() external view returns(bool isInterceptor);
+    /// @dev only product service may set product nft id during registration of product setup
+    function setProductNftId(NftId productNftId) external;
+
+    /// @dev returns the name of this component
+    /// to successfully register the component with an instance the name MUST be unique in the linked instance
+    function getName() external view returns (string memory name);
+
+    /// @dev defines which ERC20 token is used by this component
+    function getToken() external view returns (IERC20Metadata token);
 
+    /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);
 
-    function setProductNftId(NftId productNftId) external;
+    /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
+    /// the default address is the component token address
+    function getWallet() external view returns (address walletAddress);
+
+    /// @dev defines the product to which this component is linked to
+    /// this is only relevant for pool and distribution components
     function getProductNftId() external view returns (NftId productNftId);
 
-    function getInstanceService() external view returns (IInstanceService);
-    function getProductService() external view returns (IProductService);
+    function isNftInterceptor() external view returns(bool isInterceptor);
 }

package/contracts/components/IDistributionComponent.sol

@@ -17,6 +17,7 @@ interface IDistributionComponent is IComponent {
     function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
 
     function setFees(
+        Fee memory minDistributionOwnerFee,
         Fee memory distributionFee
     ) external;
 
@@ -44,25 +45,6 @@ interface IDistributionComponent is IComponent {
         bytes memory data
     ) external;
 
-    /**
-     * @dev lets distributors create referral codes.
-     * referral codes need to be unique
-     * distributor is identified via msg.sender.
-     */
-    function createReferral(
-        NftId distributorNftId,
-        string memory code,
-        UFixed discountPercentage,
-        uint32 maxReferrals,
-        Timestamp expiryAt,
-        bytes memory data
-    ) external returns (ReferralId referralId);
-
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    ) external view returns (uint256 feeAmount);
-
     function calculateRenewalFeeAmount(
         ReferralId referralId,
         uint256 netPremiumAmount
@@ -92,9 +74,6 @@ interface IDistributionComponent is IComponent {
         string memory referralCode
     ) external returns (ReferralId referralId);
 
-    /// @dev returns true iff the referral id is valid
-    function referralIsValid(ReferralId referralId) external view returns (bool isValid);
-
     /// @dev returns true iff the component needs to be called when selling/renewing policis
     function isVerifying() external view returns (bool verifying);
 }