@etherisc/gif-next 0.0.2-4e6a781-730 → 0.0.2-4e99ed1-062

package/contracts/components/Component.sol

@@ -1,15 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 import {IComponent} from "./IComponent.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType, INSTANCE, PRODUCT} from "../types/ObjectType.sol";
@@ -17,9 +20,9 @@ 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
-// TODO make contract upgradeable
 // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
 // same pattern as for Service which is also upgradeable
 abstract contract Component is
@@ -28,47 +31,32 @@ 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
         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)
-        IInstanceService _instanceService; // instance service for this component
-
+        InstanceReader _instanceReader; // instance reader for this component
+        bool _isNftInterceptor; // declares if component is involved in nft transfers
         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 onlyProductService() {
-        if(msg.sender != address(_getComponentStorage()._productService)) {
-            revert ErrorComponentNotProductService(msg.sender);
+    function _getComponentStorage() private pure returns (ComponentStorage storage $) {
+        assembly {
+            $.slot := COMPONENT_LOCATION_V1
         }
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId instanceNftId,
-        string memory name,
-        address token,
-        ObjectType componentType,
-        bool isInterceptor,
-        address initialOwner,
-        bytes memory data
-    ) {
-        _initializeComponent(registry, instanceNftId, name, token, componentType, isInterceptor, initialOwner, data);
     }
 
-    function _getComponentStorage() private pure returns (ComponentStorage storage $) {
-        assembly {
-            $.slot := CONTRACT_LOCATION_V1
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert ErrorComponentNotChainNft(msg.sender);
         }
+        _;
     }
 
-    function _initializeComponent(
+    function initializeComponent(
         address registry,
         NftId instanceNftId,
         string memory name,
@@ -76,70 +64,52 @@ 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
     )
-        internal
-        initializer 
+        public
         virtual
+        onlyInitializing()
     {
-        ComponentStorage storage $ = _getComponentStorage();
-        _initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
-
-        // set unique name of component
-        $._name = name;
+        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));
-        $._productService = IProductService(getRegistry().getServiceAddress(PRODUCT(), gifVersion));
-
-        // set wallet and token
+        // set component state
+        $._name = name;
+        $._isNftInterceptor = isInterceptor;
+        $._instanceReader = $._instance.getInstanceReader();
         $._wallet = address(this);
         $._token = IERC20Metadata(token);
 
-        _registerInterface(type(IComponent).interfaceId);
+        registerInterface(type(IAccessManaged).interfaceId);
+        registerInterface(type(IComponent).interfaceId);
     }
 
     function lock() external onlyOwner override {
-        _getComponentStorage()._instanceService.setTargetLocked(getName(), true);
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
     }
     
     function unlock() external onlyOwner override {
-        _getComponentStorage()._instanceService.setTargetLocked(getName(), false);
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
     }
 
-    // only product service may set product nft id during registration of product setup
-    function setProductNftId(NftId productNftId)
+    function setWallet(address newWallet)
         external
         override
-        onlyProductService() 
+        onlyOwner
     {
         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 onlyOwner {
-        ComponentStorage storage $ = _getComponentStorage();
-
         address currentWallet = $._wallet;
         uint256 currentBalance = $._token.balanceOf(currentWallet);
 
@@ -147,8 +117,9 @@ abstract contract Component is
         if (newWallet == address(0)) {
             revert ErrorComponentWalletAddressZero();
         }
+
         if (newWallet == currentWallet) {
-            revert ErrorComponentWalletAddressIsSameAsCurrent(newWallet);
+            revert ErrorComponentWalletAddressIsSameAsCurrent();
         }
 
         if (currentBalance > 0) {
@@ -165,7 +136,7 @@ abstract contract Component is
 
         // effects
         $._wallet = newWallet;
-        emit LogComponentWalletAddressChanged(newWallet);
+        emit LogComponentWalletAddressChanged(currentWallet, newWallet);
 
         // interactions
         if (currentBalance > 0) {
@@ -180,11 +151,44 @@ 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;
+    }
+
+    function nftMint(address to, uint256 tokenId) 
+        external 
+        virtual
+        onlyChainNft
+    {}
+
+    /// @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
+        onlyChainNft
+    {
+        _nftTransferFrom(from, to, tokenId);
+    }
+
+    function getWallet() public view override returns (address walletAddress)
     {
         return _getComponentStorage()._wallet;
     }
@@ -193,6 +197,10 @@ abstract contract Component is
         return _getComponentStorage()._token;
     }
 
+    function isNftInterceptor() public view override returns(bool isInterceptor) {
+        return _getComponentStorage()._isNftInterceptor;
+    }
+
     function getInstance() public view override returns (IInstance instance) {
         return _getComponentStorage()._instance;
     }
@@ -205,12 +213,41 @@ abstract contract Component is
         return _getComponentStorage()._productNftId;
     }
 
-    function getInstanceService() public view returns (IInstanceService) {
-        return _getComponentStorage()._instanceService;
+    function getComponentInfo() public view returns (IComponents.ComponentInfo memory info) {
+        info = _getInstanceReader().getComponentInfo(getNftId());
+
+        // fallback to initial info (wallet is always != address(0))
+        if(info.wallet == address(0)) {
+            info = _getInitialInfo();
+        }
     }
 
-    function getProductService() public view returns (IProductService) {
-        return _getComponentStorage()._productService;
+    /// @dev defines initial component specification
+    /// overwrite this function according to your use case
+    function _getInitialInfo()
+        internal
+        view 
+        virtual
+        returns (IComponents.ComponentInfo memory info)
+    { }
+
+
+    /// @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
+    { }
+
+    /// @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 {ReferralId} from "../types/Referral.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";
@@ -15,73 +16,200 @@ import {ISetup} from "../instance/module/ISetup.sol";
 import {Registerable} from "../shared/Registerable.sol";
 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, TimestampLib} from "../types/Timestamp.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+
 
 abstract contract Distribution is
     Component,
     IDistributionComponent
 {
-    using NftIdLib for NftId;
-
-    bool internal _isVerifying;
-    Fee internal _initialDistributionFee;
-
-    TokenHandler internal _tokenHandler;
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Distribution")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
 
-    IDistributionService private _distributionService;
+    struct DistributionStorage {
+        Fee _minDistributionOwnerFee;
+        Fee _distributionFee;
+        TokenHandler _tokenHandler;
+        IDistributionService _distributionService;
+        mapping(address distributor => NftId distributorNftId) _distributorNftId;
+    }
 
-    constructor(
+    function initializeDistribution(
         address registry,
         NftId instanceNftId,
-        // TODO refactor into tokenNftId
         string memory name,
         address token,
-        bool verifying,
+        Fee memory minDistributionOwnerFee,
         Fee memory distributionFee,
         address initialOwner,
-        bytes memory data
-    ) Component (
-        registry, 
-        instanceNftId, 
-        name, token, 
-        DISTRIBUTION(), 
-        true, 
-        initialOwner, 
-        data
-    ) {
-        _isVerifying = verifying;
-        _initialDistributionFee = distributionFee;
+        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, registryData);
 
-        _tokenHandler = new TokenHandler(token);
-        _distributionService = getInstance().getDistributionService();
+        DistributionStorage storage $ = _getDistributionStorage();
+        // TODO add validation
+        $._minDistributionOwnerFee = minDistributionOwnerFee;
+        $._distributionFee = distributionFee;
+        $._tokenHandler = new TokenHandler(token);
+        $._distributionService = getInstance().getDistributionService();
 
-        _registerInterface(type(IDistributionComponent).interfaceId);
+        registerInterface(type(IDistributionComponent).interfaceId);
     }
 
     function setFees(
+        Fee memory minDistributionOwnerFee,
         Fee memory distributionFee
     )
         external
         override
+        onlyOwner
         restricted()
     {
-        _distributionService.setFees(distributionFee);
+        _getDistributionStorage()._distributionService.setFees(minDistributionOwnerFee, distributionFee);
     }
 
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
+    function getDistributionFee() external view returns (Fee memory distributionFee) {
+        DistributionStorage storage $ = _getDistributionStorage();
+        return $._distributionFee;
+    }
+
+    function createDistributorType(
+        string memory name,
+        UFixed minDiscountPercentage,
+        UFixed maxDiscountPercentage,
+        UFixed commissionPercentage,
+        uint32 maxReferralCount,
+        uint32 maxReferralLifetime,
+        bool allowSelfReferrals,
+        bool allowRenewals,
+        bytes memory data
     )
+        public
+        returns (DistributorType distributorType)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        distributorType = $._distributionService.createDistributorType(
+            name,
+            minDiscountPercentage,
+            maxDiscountPercentage,
+            commissionPercentage,
+            maxReferralCount,
+            maxReferralLifetime,
+            allowSelfReferrals,
+            allowRenewals,
+            data);
+    }
+
+    function createDistributor(
+        address distributor,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        public
+        returns(NftId distributorNftId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        require($._distributorNftId[distributor].eqz(), "ERROR:DST-030:ALREADY_DISTRIBUTOR");
+
+        distributorNftId = $._distributionService.createDistributor(
+            distributor,
+            distributorType,
+            data);
+
+        $._distributorNftId[distributor] = distributorNftId;
+    }
+
+    function updateDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        public
+        // TODO figure out what we need for authz
+        // and add it
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        $._distributionService.updateDistributorType(
+            distributorNftId,
+            distributorType,
+            data);
+    }
+
+    /**
+     * @dev lets distributors create referral codes.
+     * referral codes need to be unique
+     */
+    function _createReferral(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        internal
+        returns (ReferralId referralId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        referralId = $._distributionService.createReferral(
+            distributorNftId,
+            code,
+            discountPercentage,
+            maxReferrals,
+            expiryAt,
+            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
-        virtual override
-        returns (uint256 feeAmount)
+        returns (
+            UFixed discountPercentage, 
+            ReferralStatus status
+        )
     {
-        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
-        Fee memory fee = setupInfo.distributionFee;
-        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
+        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
@@ -95,33 +223,18 @@ abstract contract Distribution is
         return 0 * netPremiumAmount;
     }
 
-    function processSale(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        restricted()
-        virtual override
-    {
-        // default is no action
-    }
-
     function processRenewal(
         ReferralId referralId,
         uint256 feeAmount
     )
         external
+        onlyOwner
         restricted()
         virtual override
     {
         // 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());
@@ -133,18 +246,35 @@ abstract contract Distribution is
     }
 
     function _getInitialSetupInfo() internal view returns (ISetup.DistributionSetupInfo memory setupInfo) {
+        DistributionStorage storage $ = _getDistributionStorage();
         return ISetup.DistributionSetupInfo(
             zeroNftId(),
-            _tokenHandler,
-            _initialDistributionFee,
-            _isVerifying,
-            address(this)
+            $._tokenHandler,
+            $._minDistributionOwnerFee,
+            $._distributionFee,
+            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
     function isVerifying() external view returns (bool verifying) {
-        return _isVerifying;
+        return true;
+    }
+
+    function _getDistributionStorage() private pure returns (DistributionStorage storage $) {
+        assembly {
+            $.slot := DISTRIBUTION_STORAGE_LOCATION_V1
+        }
     }
 }