@etherisc/gif-next 0.0.2-b8e869c-076 → 0.0.2-b95860d-028

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

@@ -2,6 +2,7 @@
 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";
@@ -81,6 +82,7 @@ contract BasicDistribution is
         external
         virtual
         onlyOwner()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
         restricted()
     {
         _updateDistributorType(distributorNftId, distributorType, data);
@@ -132,7 +134,6 @@ contract BasicDistribution is
             initialOwner, 
             name, 
             token, 
-            "", // registry data
             ""); // component specifc data
     }
 }

package/contracts/distribution/Distribution.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
+import {COMPONENT, DISTRIBUTION, DISTRIBUTOR} from "../type/ObjectType.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IDistributionService} from "./IDistributionService.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
@@ -36,15 +36,6 @@ abstract contract Distribution is
         _;
     }
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getDistributionStorage()._componentService.registerDistribution();
-        _approveTokenHandler(type(uint256).max);
-    }
-
 
     function isDistributor(address candidate)
         public
@@ -128,6 +119,7 @@ abstract contract Distribution is
         virtual
         restricted()
         onlyDistributor()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
         onlyNftOwner(distributorNftId)
         returns (Amount withdrawnAmount) 
     {
@@ -136,12 +128,11 @@ abstract contract Distribution is
         
     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
@@ -150,21 +141,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.

package/contracts/distribution/DistributionService.sol

@@ -12,7 +12,6 @@ import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {ObjectType, COMPONENT, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, REGISTRY} from "../type/ObjectType.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
@@ -38,21 +37,21 @@ contract DistributionService is
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while DistributionService is not deployed in DistributionServiceManager constructor
-        //      owner is DistributionServiceManager deployer
-        initializeService(registryAddress, address(0), owner);
+        (
+            address registryAddress,
+            address authority
+        ) = abi.decode(data, (address, address));
+
+        _initializeService(registryAddress, authority, owner);
 
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
-        registerInterface(type(IDistributionService).interfaceId);
+        _registerInterface(type(IDistributionService).interfaceId);
     }
 
 
@@ -74,7 +73,7 @@ contract DistributionService is
         InstanceReader instanceReader = instance.getInstanceReader();
 
         {
-            NftId productNftId = _getProductNftId(instanceReader, distributionNftId);
+            NftId productNftId = _getProductNftId(distributionNftId);
             IComponents.ProductInfo memory productInfo = instance.getInstanceReader().getProductInfo(productNftId);
 
             UFixed variableDistributionFees = productInfo.distributionFee.fractionalFee;
@@ -164,6 +163,7 @@ contract DistributionService is
     )
         external
         virtual
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (ReferralId referralId)
     {
         (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
@@ -175,66 +175,91 @@ contract DistributionService is
             revert ErrorIDistributionServiceExpirationInvalid(expiryAt);
         }
 
-        InstanceReader instanceReader = instance.getInstanceReader();
-        DistributorType distributorType = instanceReader.getDistributorInfo(distributorNftId).distributorType;
-        IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
+        {
+            InstanceReader instanceReader = instance.getInstanceReader();
+            DistributorType distributorType = instanceReader.getDistributorInfo(distributorNftId).distributorType;
+            IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
 
-        if (distributorTypeData.maxReferralCount < maxReferrals) {
-            revert ErrorIDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
-        }
-        if (distributorTypeData.minDiscountPercentage > discountPercentage) {
-            revert ErrorIDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
-        }
-        if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
-            revert ErrorIDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
-        }
-        if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime) {
-            revert ErrorIDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt.toInt());
+            if (distributorTypeData.maxReferralCount < maxReferrals) {
+                revert ErrorIDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
+            }
+            if (distributorTypeData.minDiscountPercentage > discountPercentage) {
+                revert ErrorIDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
+            }
+            if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
+                revert ErrorIDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
+            }
+            if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime) {
+                revert ErrorIDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt.toInt());
+            }
         }
 
-        referralId = ReferralLib.toReferralId(distributionNftId, code);
-        IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
-            distributorNftId,
-            code,
-            discountPercentage,
-            maxReferrals,
-            0, // used referrals
-            expiryAt,
-            data
-        );
-
-        instance.getInstanceStore().createReferral(referralId, info);
-        return referralId;
+        {
+            referralId = ReferralLib.toReferralId(distributionNftId, code);
+            IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
+                distributorNftId,
+                code,
+                discountPercentage,
+                maxReferrals,
+                0, // used referrals
+                expiryAt,
+                data
+            );
+
+            instance.getInstanceStore().createReferral(referralId, info);
+        }
     }
 
+    /// @inheritdoc IDistributionService
+    function processReferral(
+        NftId distributionNftId, 
+        ReferralId referralId
+    ) 
+        external
+        virtual
+        restricted()
+        onlyNftOfType(distributionNftId, DISTRIBUTION())
+    {
+        if (referralIsValid(distributionNftId, referralId)) {
+            IRegistry registry = getRegistry();
+            IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+            IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+
+            // update book keeping for referral info
+            IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
+            referralInfo.usedReferrals += 1;
+            instance.getInstanceStore().updateReferral(referralId, referralInfo, KEEP_STATE());
+        }
+    }
 
     function processSale(
         NftId distributionNftId, // assume always of distribution type
         ReferralId referralId,
-        IPolicy.Premium memory premium
+        IPolicy.PremiumInfo memory premium
     )
         external
         virtual
-        restricted
+        restricted()
+        onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
-        IInstance instance = _getInstanceForDistribution(distributionNftId);
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
         // get distribution owner fee amount
-        Amount distributionOwnerFee = AmountLib.toAmount(premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount);
+        Amount distributionOwnerFee = premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount;
 
         // update referral/distributor info if applicable
         if (referralIsValid(distributionNftId, referralId)) {
 
             // increase distribution balance by commission amount and distribution owner fee
-            Amount commissionAmount = AmountLib.toAmount(premium.commissionAmount);
+            Amount commissionAmount = premium.commissionAmount;
             _componentService.increaseDistributionBalance(store, distributionNftId, commissionAmount, distributionOwnerFee);
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
-            referralInfo.usedReferrals += 1;
-            store.updateReferral(referralId, referralInfo, KEEP_STATE());
 
             _componentService.increaseDistributorBalance(store, referralInfo.distributorNftId, AmountLib.zero(), commissionAmount);
 
@@ -253,6 +278,7 @@ contract DistributionService is
         public 
         virtual
         // TODO: restricted() (once #462 is done)
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (Amount withdrawnAmount) 
     {
         (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
@@ -290,12 +316,18 @@ contract DistributionService is
         }
     }
 
-    function referralIsValid(NftId distributionNftId, ReferralId referralId) public view returns (bool isValid) {
+    function referralIsValid(NftId distributionNftId, ReferralId referralId) 
+        public 
+        view 
+        returns (bool isValid) 
+    {
         if (distributionNftId.eqz() || referralId.eqz()) {
             return false;
         }
 
-        IInstance instance = _getInstanceForDistribution(distributionNftId);
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -312,7 +344,7 @@ contract DistributionService is
         returns(IInstance instance)
     {
         NftId instanceNftId = getRegistry().getObjectInfo(distributionNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        address instanceAddress = getRegistry().getObjectAddress(instanceNftId);
         return IInstance(instanceAddress);
     }
 

package/contracts/distribution/DistributionServiceManager.sol

@@ -12,15 +12,15 @@ contract DistributionServiceManager is ProxyManager {
     /// @dev initializes proxy manager with distribution service implementation and deploys instance
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
-        DistributionService distSrv = new DistributionService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
-            address(distSrv), 
+        DistributionService svc = new DistributionService{salt: salt}();
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);
 

package/contracts/distribution/IDistributionService.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
-import {Fee} from "../type/Fee.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IService} from "../shared/IService.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -75,11 +74,18 @@ interface IDistributionService is IService {
         external
         returns (ReferralId referralId);
 
+    /// @dev callback from product service when a referral is used. 
+    /// Calling this will increment the referral usage counter. 
+    function processReferral(
+        NftId distributionNftId, 
+        ReferralId referralId
+    ) external;
+
     /// @dev callback from product service when selling a policy for a specific referralId
     function processSale(
         NftId distributionNftId,
         ReferralId referralId,
-        IPolicy.Premium memory premium
+        IPolicy.PremiumInfo memory premium
     ) external;
 
     function referralIsValid(

package/contracts/examples/fire/DamageLevel.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+type DamageLevel is uint8;
+
+// type bindings
+using {
+    DamageLevelLib.eq,
+    DamageLevelLib.eqz,
+    DamageLevelLib.toInt
+} for DamageLevel global;
+
+// solhint-disable-next-line func-name-mixedcase
+function DAMAGE_SMALL() pure returns (DamageLevel) {
+    return DamageLevel.wrap(1);
+}
+
+// solhint-disable-next-line func-name-mixedcase
+function DAMAGE_MEDIUM() pure returns (DamageLevel) {
+    return DamageLevel.wrap(2);
+}
+
+// solhint-disable-next-line func-name-mixedcase
+function DAMAGE_LARGE() pure returns (DamageLevel) {
+    return DamageLevel.wrap(3);
+}
+
+library DamageLevelLib {
+
+    error ErrorDamageLeveLibInvalidDamageLevel(uint8 damageLevel);
+
+    function zero() internal pure returns (DamageLevel) {
+        return DamageLevel.wrap(0);
+    }
+
+    function toDamageLevel(uint8 damage) internal pure returns (DamageLevel) {
+        if (damage == 1) {
+            return DAMAGE_SMALL();
+        } else if (damage == 2) {
+            return DAMAGE_MEDIUM();
+        } else if (damage == 3) {
+            return DAMAGE_LARGE();
+        } else {
+            revert ErrorDamageLeveLibInvalidDamageLevel(damage);
+        }
+    }
+
+    function toInt(DamageLevel damageLevel) internal pure returns (uint8) {
+        return uint8(DamageLevel.unwrap(damageLevel));
+    }
+
+    function eq(DamageLevel a, DamageLevel b) internal pure returns (bool) {
+        return DamageLevel.unwrap(a) == DamageLevel.unwrap(b);
+    }
+
+    function eqz(DamageLevel a) internal pure returns (bool) {
+        return DamageLevel.unwrap(a) == 0;
+    }
+}

package/contracts/examples/fire/FirePool.sol

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {BasicPool} from "../../pool/BasicPool.sol";
+import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
+import {Fee} from "../../type/Fee.sol";
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {NftId} from "../../type/NftId.sol";
+import {Seconds} from "../../type/Timestamp.sol";
+import {UFixed} from "../../type/UFixed.sol";
+
+contract FirePool is
+    BasicPool
+{
+    
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        string memory componentName,
+        address token,
+        IAuthorization authorization
+    ) 
+    {
+        address initialOwner = msg.sender;
+        _intialize(
+            registry,
+            instanceNftId,
+            componentName,
+            token,
+            authorization,
+            initialOwner);
+    }
+
+    function _intialize(
+        address registry,
+        NftId instanceNftId,
+        string memory componentName,
+        address token,
+        IAuthorization authorization,
+        address initialOwner
+    )
+        internal
+        initializer
+    {
+        _initializeBasicPool(
+            registry,
+            instanceNftId,
+            authorization,
+            token,
+            componentName,
+            initialOwner);
+    }
+
+    function createBundle(
+        Fee memory fee,
+        Amount initialAmount,
+        Seconds lifetime
+    )
+        external
+        virtual 
+        restricted()
+        returns(NftId bundleNftId, Amount netStakedAmount)
+    {
+        address owner = msg.sender;
+        bundleNftId = _createBundle(
+            owner,
+            fee,
+            lifetime,
+            "" // filter
+        );
+        netStakedAmount = _stake(bundleNftId, initialAmount);
+    }
+
+}

package/contracts/examples/fire/FirePoolAuthorization.sol

@@ -0,0 +1,34 @@
+
+
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
+import {FirePool} from "./FirePool.sol";
+import {IAccess} from "../../../contracts/authorization/IAccess.sol";
+import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+
+contract FirePoolAuthorization
+    is BasicPoolAuthorization
+{
+
+    constructor(string memory poolName)
+        BasicPoolAuthorization(poolName)
+    {}
+
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+        IAccess.FunctionInfo[] storage functions;
+
+        // authorize public role (open access to any account, only allows to lock target)
+        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        // TODO: FirePool.createBundle must require a custom role (e.g. INVESTOR) instead of PUBLIC_ROLE
+        _authorize(functions, FirePool.createBundle.selector, "createBundle");
+    }
+
+}
+