@etherisc/gif-next 0.0.2-ff1bf36-818 → 0.0.2-ff596ab-857

package/contracts/instance/module/IPolicy.sol

@@ -11,74 +11,95 @@ import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IPolicy {
 
-    struct Premium {
+    struct PremiumInfo {
+        // slot 0
         // premium splitting per target wallet
         Amount productFeeAmount;
         Amount distributionFeeAndCommissionAmount;
+        // slot 1
         Amount poolPremiumAndFeeAmount;
 
         // detailed positions
         // this is the net premium calculated by the product 
-        uint256 netPremiumAmount;
+        Amount netPremiumAmount;
+        // slot 2
         // fullPremium = netPremium + all fixed amounts + all variable amounts (excl commission and minDistribtuionOwnerFee variable part)
-        uint256 fullPremiumAmount;
+        Amount fullPremiumAmount;
         // effective premium = fullPremium - discount 
-        uint256 premiumAmount;
-        uint256 productFeeFixAmount;
-        uint256 poolFeeFixAmount;
-        uint256 bundleFeeFixAmount;
-        uint256 distributionFeeFixAmount;
-        uint256 productFeeVarAmount;
-        uint256 poolFeeVarAmount;
-        uint256 bundleFeeVarAmount;
-        uint256 distributionFeeVarAmount;
-        uint256 distributionOwnerFeeFixAmount;
+        Amount premiumAmount;
+        // slot 3
+        Amount productFeeFixAmount;
+        Amount poolFeeFixAmount;
+        // slot 4
+        Amount bundleFeeFixAmount;
+        Amount distributionFeeFixAmount;
+        // slot 5
+        Amount productFeeVarAmount;
+        Amount poolFeeVarAmount;
+        // slot 6
+        Amount bundleFeeVarAmount;
+        Amount distributionFeeVarAmount;
+        // slot 7
+        Amount distributionOwnerFeeFixAmount;
         // this is the remaining amount when the commission and discount are subtracted from the distribution fee variable part (must be at least the minDistributionOwnerFee)
-        uint256 distributionOwnerFeeVarAmount;
+        Amount distributionOwnerFeeVarAmount;
+        // slot 8
         // this value is based on distributor type referenced in the referral 
-        uint256 commissionAmount;
+        Amount commissionAmount;
         // this is based on referral used
-        uint256 discountAmount;
+        Amount discountAmount;
     }
 
     /// @dev policy data for the full policy lifecycle
     struct PolicyInfo {
+        // slot 0
         NftId productNftId;
         NftId bundleNftId;
-        ReferralId referralId;
         RiskId riskId;
+        // slot 1
         Amount sumInsuredAmount;
         Amount premiumAmount; // expected premium at application time
-        Amount premiumPaidAmount; // actual paid premium 
-        Seconds lifetime;
-        // policy application data, no changes after applying for a policy
-        bytes applicationData;
-        bytes processData;
+        ReferralId referralId;
+        // slot 2
         uint16 claimsCount;
         uint16 openClaimsCount;
         Amount claimAmount; // sum of confirmed claim amounts (max = sum insured amount)
         Amount payoutAmount; // sum of payouts (max = sum confirmed claim amountst)
+        // slot 3
         Timestamp activatedAt; // time of underwriting
+        Seconds lifetime;
         Timestamp expiredAt; // no new claims (activatedAt + lifetime)
         Timestamp closedAt; // no locked capital (or declinedAt)
+        // slot 4
+        bytes applicationData;
+        // slot 5
+        bytes processData;
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct ClaimInfo {
+        // slot 0
         Amount claimAmount;
         Amount paidAmount;
-        uint8 payoutsCount;
-        uint8 openPayoutsCount;
-        bytes submissionData; // claim submission data, no changes after submitting the claim
-        bytes processData; // data that may include information supporting confirm or decline
         Timestamp closedAt; // payment of confirmed claim amount (or declinedAt)
+        uint24 payoutsCount;
+        // slot 1
+        uint24 openPayoutsCount;
+        // slot 2
+        bytes submissionData; // use case specific claim submission data, no changes after submitting the claim
+        // slot 3
+        bytes processData; // use case specific data that may include information supporting confirm or decline
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct PayoutInfo {
+        // slot 0
         ClaimId claimId;
         Amount amount;
-        bytes data;
-        Timestamp paidAt; // payoment of confirmed claim amount (or declinedAt)
+        Timestamp paidAt; // timestamp for actual payout
+        // slot 1
+        address beneficiary; // for address(0) beneficiary is policy nft owner
+        // slot 2
+        bytes data; // use case specific supporting data
     }
 }

package/contracts/instance/module/IRisk.sol

@@ -2,10 +2,15 @@
 pragma solidity ^0.8.20;
 
 import {NftId} from "../../type/NftId.sol";
+import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IRisk {
+
     struct RiskInfo {
+        // slot 0
         NftId productNftId;
+        Timestamp createdAt;
+        // slot 1
         bytes data;
     }
 }

package/contracts/oracle/BasicOracle.sol

@@ -27,22 +27,19 @@ contract BasicOracle is
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         internal
         virtual
         onlyInitializing()
     {
 
-        _initializeOracle(
+        __Oracle_init(
             registry,
             instanceNftId,
             authorization,
             initialOwner,
             name,
-            token,
-            "",
             "");
     }
 }

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -14,19 +14,26 @@ contract BasicOracleAuthorization
      is Authorization
 {
 
-     constructor(string memory componentName)
-          Authorization(componentName)
+     constructor(
+          string memory componentName,
+          string memory commitHash
+     )
+          Authorization(
+               componentName, 
+               ORACLE(), 
+               3, 
+               commitHash, 
+               true, 
+               false)
      {}
 
-     function _setupTargets()
+     function _setupServiceTargets()
           internal
           virtual override
      {
-          // basic component target
-          _addComponentTargetWithRole(ORACLE()); 
+          _authorizeServiceDomain(ORACLE(), address(15));
      }
 
-
      function _setupTargetAuthorizations()
           internal
           virtual override
@@ -34,12 +41,12 @@ contract BasicOracleAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), getServiceRole(ORACLE()));
+          functions = _authorizeForTarget(getMainTargetName(), getServiceRole(ORACLE()));
           _authorize(functions, IOracle.request.selector, "request");
           _authorize(functions, IOracle.cancel.selector, "cancel");
 
           // 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, BasicOracle.respond.selector, "respond");
      }
 }

package/contracts/oracle/IOracle.sol

@@ -9,14 +9,19 @@ import {Timestamp} from "../type/Timestamp.sol";
 interface IOracle {
 
     struct RequestInfo {
+        // slot 0
         NftId requesterNftId; // originator of the request
-        string callbackMethodName; // callback function of the requestor to call to provide response data
         NftId oracleNftId; // responsible oracle component
-        bytes requestData; 
-        bytes responseData; 
+        bool isCancelled;
         Timestamp respondedAt; // response timestamp
+        // slot 1
         Timestamp expiredAt; // expiry timestamp
-        bool isCancelled;
+        // slot 2
+        string callbackMethodName; // callback function of the requestor to call to provide response data
+        // slot 3
+        bytes requestData; 
+        // slot 4
+        bytes responseData; 
     }
 
 

package/contracts/oracle/IOracleService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -17,7 +18,7 @@ interface IOracleService is IService {
     event LogOracleServiceRequestCancelled(RequestId requestId, NftId requesterNftId);
 
     // create request
-    error ErrorOracleServiceInstanceMismatch(NftId expectedInstanceNftId, NftId oracleInstanceNftId);
+    error ErrorOracleServiceProductMismatch(ObjectType callerObjectType, NftId productNft, NftId oracleParentNftId);
     error ErrorOracleServiceExpiryInThePast(Timestamp blockTimestamp, Timestamp expiryAt);
     error ErrorOracleServiceCallbackMethodNameEmpty();
 

package/contracts/oracle/Oracle.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
+import {COMPONENT, PRODUCT, ORACLE} from "../type/ObjectType.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
@@ -27,15 +27,6 @@ abstract contract Oracle is
     }
 
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getOracleStorage()._componentService.registerOracle();
-    }
-
-
     function request(
         RequestId requestId,
         NftId requesterId,
@@ -71,49 +62,46 @@ abstract contract Oracle is
         return false;
     }
 
+    /// @dev Not relevant for oracle components
     function withdrawFees(Amount amount)
         external
         virtual
         override(IInstanceLinkedComponent, InstanceLinkedComponent)
         onlyOwner()
         restricted()
-        returns (Amount withdrawnAmount)
+        returns (Amount)
     {
         revert ErrorOracleNotImplemented("withdrawFees");
     }
 
 
-    function _initializeOracle(
+    function __Oracle_init(
         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
         virtual
         onlyInitializing()
     {
-        _initializeInstanceLinkedComponent(
+        __InstanceLinkedComponent_init(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
-            token, 
             ORACLE(), 
             authorization,
             true, 
             initialOwner, 
-            registryData, 
             componentData);
 
         OracleStorage storage $ = _getOracleStorage();
-        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
 
-        registerInterface(type(IOracleComponent).interfaceId);
+        _registerInterface(type(IOracleComponent).interfaceId);
     }
 
 

package/contracts/oracle/OracleService.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IComponent} from "../shared/IComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
@@ -11,14 +11,15 @@ import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, ORACLE, INSTANCE} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, ORACLE, PRODUCT} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
+import {Service} from "../shared/Service.sol";
 import {StateId, ACTIVE, KEEP_STATE, FULFILLED, FAILED, CANCELLED} from "../type/StateId.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 
 
 contract OracleService is
-    ComponentVerifyingService,
+    Service,
     IOracleService
 {
 
@@ -27,14 +28,16 @@ contract OracleService is
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        initializeService(registryAddress, address(0), owner);
-        registerInterface(type(IOracleService).interfaceId);
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
+
+        __Service_init(authority, registry, owner);
+        _registerInterface(type(IOracleService).interfaceId);
     }
 
     function request(
@@ -45,63 +48,51 @@ contract OracleService is
     )
         external 
         virtual 
-        // restricted() // add authz
-        returns (
-            RequestId requestId
-        ) 
+        restricted()
+        onlyNftOfType(oracleNftId, ORACLE())
+        returns (RequestId requestId) 
     {
+        // checks
+        // get and check active caller
         (
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory requesterInfo, 
+            address instance
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
-        // oracleNftId exists and is active oracle
         (
-            IRegistry.ObjectInfo memory oracleInfo, 
-        ) = _getAndVerifyComponentInfo(
-            oracleNftId, 
-            ORACLE(), 
-            true); // only active
-
-        // check that requester and oracle share same instance
-        if (componentInfo.parentNftId != oracleInfo.parentNftId) {
-            revert ErrorOracleServiceInstanceMismatch(componentInfo.parentNftId, oracleInfo.parentNftId);
-        }
-
-        // check expiriyAt >= now
-        if (expiryAt < TimestampLib.blockTimestamp()) {
-            revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
-        }
-
-        // check callbackMethodName.length > 0
-        if (bytes(callbackMethodName).length == 0) {
-            revert ErrorOracleServiceCallbackMethodNameEmpty();
+            NftId requesterNftId,
+            IOracleComponent oracle
+        ) = _checkRequestParams(
+            getRegistry(), oracleNftId, requesterInfo, expiryAt, callbackMethodName);
+
+        // effects
+        {
+            // create request info
+            IOracle.RequestInfo memory request = IOracle.RequestInfo({
+                requesterNftId: requesterNftId,
+                callbackMethodName: callbackMethodName,
+                oracleNftId: oracleNftId,
+                requestData: requestData,
+                responseData: "",
+                respondedAt: TimestampLib.zero(),
+                expiredAt: expiryAt,
+                isCancelled: false
+            });
+
+            // store request with instance
+            requestId = IInstance(instance).getInstanceStore().createRequest(request);
         }
 
-        // create request info
-        IOracle.RequestInfo memory request = IOracle.RequestInfo({
-            requesterNftId: componentNftId,
-            callbackMethodName: callbackMethodName,
-            oracleNftId: oracleNftId,
-            requestData: requestData,
-            responseData: "",
-            respondedAt: TimestampLib.zero(),
-            expiredAt: expiryAt,
-            isCancelled: false
-        });
-
-        // store request with instance
-        requestId = instance.getInstanceStore().createRequest(request);
+        emit LogOracleServiceRequestCreated(requestId, requesterNftId, oracleNftId, expiryAt);
 
-        // call oracle component
-        IOracleComponent(oracleInfo.objectAddress).request(
+        // interactions
+        // callback to oracle component
+        oracle.request(
             requestId, 
-            componentNftId, 
+            requesterNftId, 
             requestData, 
             expiryAt);
-
-        emit LogOracleServiceRequestCreated(requestId, componentNftId, oracleNftId, expiryAt);
     }
 
 
@@ -113,19 +104,21 @@ contract OracleService is
     )
         external
         virtual
-        // restricted() // add authz
+        restricted()
         returns (bool success)
     {
         (
-            NftId oracleNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(ORACLE());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyComponent(
+            getRegistry(), msg.sender, ORACLE(), true);
 
+        NftId oracleNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = true;
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, oracleNftId, callerIsOracle);
         request.responseData = responseData;
-        request.respondedAt = TimestampLib.blockTimestamp();
+        request.respondedAt = TimestampLib.current();
 
         instance.getInstanceStore().updateRequest(
             requestId, request, KEEP_STATE());
@@ -160,14 +153,16 @@ contract OracleService is
     function resend(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
-            NftId requesterNftId,
-            IRegistry.ObjectInfo memory requesterInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
+        NftId requesterNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = false;
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
 
@@ -178,7 +173,7 @@ contract OracleService is
                 "(uint64,bytes)"
             ));
 
-        (bool success, bytes memory returnData) = requesterInfo.objectAddress.call(
+        (bool success, bytes memory returnData) = info.objectAddress.call(
             abi.encodeWithSignature(
                 functionSignature, 
                 requestId,
@@ -189,7 +184,7 @@ contract OracleService is
             instance.getInstanceStore().updateRequestState(requestId, FULFILLED());
             emit LogOracleServiceResponseResent(requestId, requesterNftId);
         } else {
-            emit LogOracleServiceDeliveryFailed(requestId, requesterInfo.objectAddress, functionSignature);
+            emit LogOracleServiceDeliveryFailed(requestId, info.objectAddress, functionSignature);
         }
     }
 
@@ -197,14 +192,16 @@ contract OracleService is
     function cancel(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
-            NftId requesterNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
+        NftId requesterNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = false;
         // TODO property isCancelled and state update to CANCELLED are redundant, get rid of isCancelled
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
@@ -214,13 +211,59 @@ contract OracleService is
 
         // call oracle component
         // TODO add check that oracle is active?
-        address oracleAddress = getRegistry().getObjectInfo(request.oracleNftId).objectAddress;
+        address oracleAddress = getRegistry().getObjectAddress(request.oracleNftId);
         IOracleComponent(oracleAddress).cancel(requestId);
 
         emit LogOracleServiceRequestCancelled(requestId, requesterNftId);
     }
 
 
+    function _checkRequestParams(
+        IRegistry registry,
+        NftId oracleNftId,
+        IRegistry.ObjectInfo memory requesterInfo,
+        Timestamp expiryAt,
+        string memory callbackMethodName
+    )
+        internal
+        virtual
+        view
+        returns (
+            NftId requesterNftId,
+            IOracleComponent oracle
+        )
+    {
+        // get oracle info
+        (IRegistry.ObjectInfo memory oracleInfo,) = ContractLib.getInfoAndInstance(
+            registry, oracleNftId, true);
+
+        // obtain return values
+        requesterNftId = requesterInfo.nftId;
+        oracle = IOracleComponent(oracleInfo.objectAddress);
+
+        // check that requester and oracle share same product cluster
+        if (requesterInfo.objectType == PRODUCT()) {
+            if (oracleInfo.parentNftId != requesterNftId) {
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterNftId, oracleInfo.parentNftId);
+            }
+        } else {
+            if (oracleInfo.parentNftId != requesterInfo.parentNftId) {
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterInfo.parentNftId, oracleInfo.parentNftId);
+            }
+        }
+
+        // check expiriyAt >= now
+        if (expiryAt < TimestampLib.current()) {
+            revert ErrorOracleServiceExpiryInThePast(TimestampLib.current(), expiryAt);
+        }
+
+        // check callbackMethodName.length > 0
+        if (bytes(callbackMethodName).length == 0) {
+            revert ErrorOracleServiceCallbackMethodNameEmpty();
+        }
+    }
+
+
     function _checkAndGetRequestInfo(
         IInstance instance,
         RequestId requestId,
@@ -255,23 +298,12 @@ contract OracleService is
         }
 
         // check expiry
-        if (info.expiredAt < TimestampLib.blockTimestamp()) {
+        if (info.expiredAt < TimestampLib.current()) {
             revert ErrorOracleServiceRequestExpired(requestId, info.expiredAt);
         }
     }
 
 
-    function _getInstanceForComponent(NftId componentNftId)
-        internal
-        view
-        returns(IInstance instance)
-    {
-        NftId instanceNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        return IInstance(instanceAddress);
-    }
-
-
     function _getDomain() internal pure override returns(ObjectType) {
         return ORACLE();
     }