@etherisc/gif-next 0.0.2-f29e479-370 → 0.0.2-f2df3e2-873

package/contracts/instance/ObjectManager.sol

@@ -24,18 +24,16 @@ contract ObjectManager is
     IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectManager initialization
 
     /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
-    function initialize(
-        address authority,
-        address registry,
-        address instance
-    )
+    function initialize(address instanceAddress) 
+        initializer
         external 
     {
-        initialize(authority, registry);
+        IInstance instance = IInstance(instanceAddress);
+        initialize(instance.authority(), instance.getRegistryAddress());
 
-        _instance = IInstance(instance);
+        _instance = instance;
         
-        emit LogObjectManagerInitialized(instance);
+        emit LogObjectManagerInitialized(instanceAddress);
     }
 
     function getInstance() external view returns (IInstance) {

package/contracts/instance/base/ComponentService.sol

@@ -16,7 +16,6 @@ import {InstanceAccessManager} from "../InstanceAccessManager.sol";
 
 abstract contract ComponentService is Service {
 
-    error ErrorComponentServiceAlreadyRegistered(address component, NftId nftId);
     error ErrorComponentServiceNotComponent(address component);
     error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
     error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
@@ -33,13 +32,15 @@ abstract contract ComponentService is Service {
     // view functions
 
     function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
-        return IRegistryService(service);
+        return IRegistryService(_getServiceAddress(REGISTRY()));
     }
 
     function getInstanceService() public view returns (InstanceService) {
-        address service = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
-        return InstanceService(service);
+        return InstanceService(_getServiceAddress(INSTANCE()));
+    }
+
+    function _getServiceAddress(ObjectType domain) internal view returns (address) {
+        return getRegistry().getServiceAddress(domain, getVersion().toMajorPart());
     }
 
     // internal functions
@@ -60,12 +61,6 @@ abstract contract ComponentService is Service {
         // component may only be registerd by initial owner of component
         owner = msg.sender;
 
-        // check component has not already been registerd
-        NftId compoentNftId = getRegistry().getNftId(componentAddress);
-        if(compoentNftId.gtz()) {
-            revert ErrorComponentServiceAlreadyRegistered(componentAddress, compoentNftId);
-        }
-
         // check this is a component
         component = IComponent(componentAddress);
         if(!component.supportsInterface(type(IComponent).interfaceId)) {
@@ -87,48 +82,40 @@ abstract contract ComponentService is Service {
         // check instance has assigned required role to owner
         instanceNftId = componentInfo.parentNftId;
         instance = _getInstance(instanceNftId);
-        bool hasRole = getInstanceService().hasRole(
-            owner, 
-            requiredRole, 
-            address(instance));
-
-        if(!hasRole) {
+        if(!instance.getInstanceAccessManager().hasRole(requiredRole, owner)) {
             revert ErrorComponentServiceExpectedRoleMissing(instanceNftId, requiredRole, owner);
         }
     }
 
     // internal view functions
 
-    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        return IInstance(instanceInfo.objectAddress);
-    }
-
     function _getAndVerifyComponentInfoAndInstance(
-        //address component,
         ObjectType expectedType
     )
         internal
         view
         returns(
+            NftId nftId,
             IRegistry.ObjectInfo memory info, 
             IInstance instance
         )
     {
         IRegistry registry = getRegistry();
-        //TODO redundant check -> just check type
-        //NftId componentNftId = registry.getNftId(component); 
-        //require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
 
         info = registry.getObjectInfo(msg.sender);
         require(info.objectType == expectedType, "OBJECT_TYPE_INVALID");
 
-        address instanceAddress = registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
+        nftId = info.nftId;
+        instance = _getInstance(info.parentNftId);
 
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        if (accessManager.isTargetLocked(info.objectAddress)) {
+        if (instance.getInstanceAccessManager().isTargetLocked(info.objectAddress)) {
             revert IAccess.ErrorIAccessTargetLocked(info.objectAddress);
         }
     }
+
+    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
+        return IInstance(
+            getRegistry().getObjectInfo(
+                instanceNftId).objectAddress);
+    }
 }

package/contracts/instance/base/KeyValueStore.sol

@@ -5,7 +5,7 @@ import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blockn
 import {Key32, KeyId, Key32Lib} from "../../types/Key32.sol";
 import {NftId} from "../../types/NftId.sol";
 import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE} from "../../types/StateId.sol";
+import {StateId, ACTIVE, KEEP_STATE} from "../../types/StateId.sol";
 import {Timestamp, TimestampLib} from "../../types/Timestamp.sol";
 
 import {Lifecycle} from "./Lifecycle.sol";
@@ -79,16 +79,21 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         // update data
         _value[key32].data = data;
 
-        // update metadata (and state)
+        // update state 
+        if(state != KEEP_STATE()) {
+            metadata.state = state;
+        }
+
+        // update reest of metadata
         address updatedBy = msg.sender;
         Blocknumber lastUpdatedIn = metadata.updatedIn;
-        metadata.state = state;
+
         metadata.updatedBy = updatedBy;
         metadata.updatedIn = blockBlocknumber();
 
         // create log entries
         // solhint-disable avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, updatedBy, tx.origin, lastUpdatedIn);
         emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
         // solhing-enable
     }
@@ -134,6 +139,9 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         StateId stateOld = metadata.state;
         require(stateOld.gtz(), "ERROR:KVS-041:NOT_EXISTING");
 
+        // ensure state transistion is valid
+        checkTransition(metadata.objectType, stateOld, state);
+
         // update metadata (and state)
         address updatedBy = msg.sender;
         Blocknumber lastUpdatedIn = metadata.updatedIn;
@@ -143,7 +151,7 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
 
         // create log entry
         // solhint-disable-next-line avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, updatedBy, tx.origin, lastUpdatedIn);
     }
 
     function exists(Key32 key32) public view returns (bool) {

package/contracts/instance/base/Lifecycle.sol

@@ -1,22 +1,31 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
 import {NftId} from "../../types/NftId.sol";
-import {ObjectType, COMPONENT, BUNDLE, POLICY, RISK} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, UNDERWRITTEN, REVOKED, DECLINED} from "../../types/StateId.sol";
+import {ObjectType, COMPONENT, BUNDLE, POLICY, RISK, CLAIM} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, COLLATERALIZED, REVOKED, SUBMITTED, CONFIRMED, DECLINED} from "../../types/StateId.sol";
 import {ILifecycle} from "./ILifecycle.sol";
 
-contract Lifecycle is ILifecycle {
+contract Lifecycle is
+    Initializable,
+    ILifecycle
+{
     mapping(ObjectType objectType => StateId initialState)
         private _initialState;
 
     mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
         private _isValidTransition;
 
-    constructor() {
+    function initializeLifecycle()
+        public
+        onlyInitializing
+    {
         _setupBundleLifecycle();
         _setupComponentLifecycle();
         _setupPolicyLifecycle();
+        _setupClaimLifecycle();
         _setupRiskLifecycle();
     }
 
@@ -78,6 +87,7 @@ contract Lifecycle is ILifecycle {
     function _setupBundleLifecycle() internal {
         _initialState[BUNDLE()] = ACTIVE();
         _isValidTransition[BUNDLE()][ACTIVE()][PAUSED()] = true;
+        _isValidTransition[BUNDLE()][ACTIVE()][CLOSED()] = true;
         _isValidTransition[BUNDLE()][PAUSED()][ACTIVE()] = true;
         _isValidTransition[BUNDLE()][PAUSED()][CLOSED()] = true;
     }
@@ -86,11 +96,18 @@ contract Lifecycle is ILifecycle {
         _initialState[POLICY()] = APPLIED();
         _isValidTransition[POLICY()][APPLIED()][REVOKED()] = true;
         _isValidTransition[POLICY()][APPLIED()][DECLINED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][UNDERWRITTEN()] = true;
-        _isValidTransition[POLICY()][UNDERWRITTEN()][ACTIVE()] = true;
+        _isValidTransition[POLICY()][APPLIED()][COLLATERALIZED()] = true;
+        _isValidTransition[POLICY()][COLLATERALIZED()][ACTIVE()] = true;
         _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
     }
 
+    function _setupClaimLifecycle() internal {
+        _initialState[CLAIM()] = SUBMITTED();
+        _isValidTransition[CLAIM()][SUBMITTED()][CONFIRMED()] = true;
+        _isValidTransition[CLAIM()][SUBMITTED()][DECLINED()] = true;
+        _isValidTransition[CLAIM()][CONFIRMED()][CLOSED()] = true;
+    }
+
     function _setupRiskLifecycle() internal {
         _initialState[RISK()] = ACTIVE();
         _isValidTransition[RISK()][ACTIVE()][PAUSED()] = true;

package/contracts/instance/module/IAccess.sol

@@ -8,40 +8,47 @@ import {Timestamp} from "../../types/Timestamp.sol";
 
 interface IAccess {
 
+    enum Type {
+        NotInitialized,
+        Core,
+        Gif,
+        Custom        
+    }
+
     struct RoleInfo {
         ShortString name;
-        bool isCustom;
-        bool isLocked;
+        Type rtype;
+        //bool isLocked;
+        RoleId admin;
         Timestamp createdAt;
         Timestamp updatedAt;
     }
 
     struct TargetInfo {
         ShortString name;
-        bool isCustom;
+        Type ttype;
         bool isLocked;
         Timestamp createdAt;
         Timestamp updatedAt;
     }
 
-    error ErrorIAccessRoleIdInvalid(RoleId roleId);
+    error ErrorIAccessCallerIsNotRoleAdmin(address caller, RoleId roleId);
+
+    error ErrorIAccessRoleIdDoesNotExist(RoleId roleId);
     error ErrorIAccessRoleIdTooBig(RoleId roleId);
     error ErrorIAccessRoleIdTooSmall(RoleId roleId);
-    error ErrorIAccessRoleIdAlreadyExists(RoleId roleId, ShortString name);
-    error ErrorIAccessRoleIdNotActive(RoleId roleId);
+    error ErrorIAccessRoleIdExists(RoleId roleId);
     error ErrorIAccessRoleNameEmpty(RoleId roleId);
-    error ErrorIAccessRoleNameNotUnique(RoleId roleId, ShortString name);
-    error ErrorIAccessRoleInvalidUpdate(RoleId roleId, bool isCustom);
-    error ErrorIAccessRoleIsCustomIsImmutable(RoleId roleId, bool isCustom, bool isCustomExisting);
-    error ErrorIAccessGrantNonexstentRole(RoleId roleId);
-    error ErrorIAccessRevokeNonexstentRole(RoleId roleId); 
-    error ErrorIAccessRenounceNonexstentRole(RoleId roleId);
+    error ErrorIAccessRoleNameExists(RoleId roleId, RoleId existingRoleId, ShortString name);
+    error ErrorIAccessRoleTypeInvalid(RoleId roleId, Type rtype);
 
     error ErrorIAccessTargetAddressZero();
-    error ErrorIAccessTargetDoesNotExist(ShortString name);
-    error ErrorIAccessTargetAddressDoesNotExist(address target);
+    error ErrorIAccessTargetDoesNotExist(address target);
     error ErrorIAccessTargetExists(address target, ShortString name);
+    error ErrorIAccessTargetTypeInvalid(address target, Type ttype);
     error ErrorIAccessTargetNameEmpty(address target);
     error ErrorIAccessTargetNameExists(address target, address existingTarget, ShortString name);
     error ErrorIAccessTargetLocked(address target);
+    error ErrorIAccessTargetNotRegistered(address target);
+    error ErrorIAccessTargetAuthorityInvalid(address target, address targetAuthority);
 }

package/contracts/instance/module/IBundle.sol

@@ -1,20 +1,23 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount} from "../../types/Amount.sol";
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
+import {Seconds} from "../../types/Seconds.sol";
 import {Timestamp} from "../../types/Timestamp.sol";
 
 interface IBundle {
+
     struct BundleInfo {
         NftId poolNftId;
         Fee fee; // bundle fee on net premium amounts
         bytes filter; // required conditions for applications to be considered for collateralization by this bundle
-        uint256 capitalAmount; // net investment capital + net premiums - payouts
-        uint256 lockedAmount; // capital amount linked to collateralizaion of non-closed policies (<= balance)
-        uint256 balanceAmount; // total amount of funds: capitalAmount + fees (balance >= captial)
-        uint256 lifetime;
-        Timestamp expiredAt; // no new policies
+        Amount capitalAmount; // net stakings + net premiums - payouts
+        Amount lockedAmount; // capital amount linked to collateralizaion of non-closed policies (<= capital amount)
+        Amount feeAmount; // accumulated fee amount
+        Seconds lifetime;
+        Timestamp expiredAt; // no new policies starting with this timestamp
         Timestamp closedAt; // no open policies, locked amount = 0
     }
 }

package/contracts/instance/module/IComponents.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {Amount} from "../../types/Amount.sol";
+import {Fee} from "../../types/Fee.sol";
+import {NftId} from "../../types/NftId.sol";
+import {RoleId} from "../../types/RoleId.sol";
+import {TokenHandler} from "../../shared/TokenHandler.sol";
+import {UFixed} from "../../types/UFixed.sol";
+
+interface IComponents {
+
+    struct ComponentInfo {
+        string name; // component name (needs to be unique per instance)
+        IERC20Metadata token;
+        TokenHandler tokenHandler;
+        address wallet;
+        Amount balanceAmount; // calculated balance (may not necessarily match withg wallet balance)
+        Amount feeAmount; // accumulated fees belonging to component owner
+        bytes data; // will hold component type specific additional info (eg encoded pool info)
+    }
+
+    struct PoolInfo {
+        NftId productNftId; // the nft of the product this pool is linked to
+        RoleId bundleOwnerRole; // the required role for bundle owners
+        // TODO maxCapitalAmount -> maxBalanceAmount
+        uint256 maxCapitalAmount; // max capital amount allowed for pool
+        uint256 balanceAmount; // current pool balance (accounting view)
+        uint256 feeAmount; // accumulated fee amount
+        bool isInterceptingBundleTransfers; // intercepts nft transfers for bundles
+        bool isExternallyManaged; // funding bundles is restricted to book keeping, actual funds may be provided as needed to support payouts
+        bool isVerifyingApplications; // underwriting requires the pool component checks/confirms the applications 
+        UFixed collateralizationLevel; // factor to calculate collateral for sum insurance (default 100%)
+        UFixed retentionLevel; // amount of collateral held in pool (default 100%)
+        Fee poolFee; // pool fee on net premium
+        Fee stakingFee; // pool fee on staked capital from investor
+        Fee performanceFee; // pool fee on profits from capital investors
+    }
+}

package/contracts/instance/module/IDistribution.sol

@@ -24,7 +24,8 @@ interface IDistribution {
         DistributorType distributorType;
         bool active;
         bytes data;
-        // TODO: track commission, number of sold policies, etc.
+        uint256 sumCommisions;
+        uint256 numPoliciesSold;
     }
 
     struct ReferralInfo {   

package/contracts/instance/module/IPolicy.sol

@@ -1,14 +1,40 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount} from "../../types/Amount.sol";
 import {NftId} from "../../types/NftId.sol";
 import {ClaimId} from "../../types/ClaimId.sol";
 import {ReferralId} from "../../types/Referral.sol";
 import {RiskId} from "../../types/RiskId.sol";
+import {Seconds} from "../../types/Seconds.sol";
 import {Timestamp} from "../../types/Timestamp.sol";
 
 interface IPolicy {
 
+    struct Premium {
+        // this is the net premium calculated by the product 
+        uint256 netPremiumAmount;
+        // fullPremium = netPremium + all fixed amounts + all variable amounts (excl commission and minDistribtuionOwnerFee variable part)
+        uint256 fullPremiumAmount;
+        // premium = fullPremium - discount
+        uint256 premiumAmount;
+        uint256 productFeeFixAmount;
+        uint256 poolFeeFixAmount;
+        uint256 bundleFeeFixAmount;
+        uint256 distributionFeeFixAmount;
+        uint256 productFeeVarAmount;
+        uint256 poolFeeVarAmount;
+        uint256 bundleFeeVarAmount;
+        uint256 distributionFeeVarAmount;
+        uint256 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;
+        // this value is based on distributor type referenced in the referral 
+        uint256 commissionAmount;
+        // this is based on referral used
+        uint256 discountAmount;
+    }
+
     /// @dev policy data for the full policy lifecycle
     struct PolicyInfo {
         NftId productNftId;
@@ -17,13 +43,13 @@ interface IPolicy {
         RiskId riskId;
         uint256 sumInsuredAmount;
         uint256 premiumAmount;
-        uint256 premiumPaidAmount;
-        uint256 lifetime;
+        uint256 premiumPaidAmount; // when lower than premium amount: max payout decreased accordingly
+        Seconds lifetime;
         bytes applicationData;
         bytes policyData;
         uint16 claimsCount;
         uint16 openClaimsCount;
-        uint256 payoutAmount;
+        Amount payoutAmount;
         Timestamp activatedAt; // time of underwriting
         Timestamp expiredAt; // no new claims (activatedAt + lifetime)
         Timestamp closedAt; // no locked capital (or declinedAt)
@@ -31,16 +57,20 @@ interface IPolicy {
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct ClaimInfo {
-        uint256 claimAmount;
-        uint256 paidAmount;
+        Amount claimAmount;
+        Amount paidAmount;
+        uint8 payoutsCount;
+        uint8 openPayoutsCount;
         bytes data;
-        Timestamp closedAt; // payoment of confirmed claim amount (or declinedAt)
+        // TODO consider to add processData that may include information supporting confirm or decline
+        Timestamp closedAt; // payment of confirmed claim amount (or declinedAt)
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct PayoutInfo {
         ClaimId claimId;
-        uint256 amount;
+        Amount amount;
+        // TODO consider to add a beneficiary address that will be the receiver of the payout tokens
         bytes data;
         Timestamp paidAt; // payoment of confirmed claim amount (or declinedAt)
     }

package/contracts/instance/module/ISetup.sol

@@ -5,21 +5,19 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 
 import {Fee} from "../../types/Fee.sol";
 import {NftId} from "../../types/NftId.sol";
-import {UFixed} from "../../types/UFixed.sol";
+import {RoleId} from "../../types/RoleId.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
+import {UFixed} from "../../types/UFixed.sol";
 
 interface ISetup {
+
     struct ProductSetupInfo {
         IERC20Metadata token;
         TokenHandler tokenHandler;
         NftId distributionNftId;
         NftId poolNftId;
-        Fee distributionFee; // default distribution fee (no referral id)
         Fee productFee; // product fee on net premium
-        Fee processingFee; // product fee on payout amounts
-        Fee poolFee; // pool fee on net premium
-        Fee stakingFee; // pool fee on staked capital from investor
-        Fee performanceFee; // pool fee on profits from capital investors
+        Fee processingFee; // product fee on payout amounts        
         bool isIntercepting; // intercepts nft transfers (for products)
         address wallet;
     }
@@ -27,22 +25,9 @@ interface ISetup {
     struct DistributionSetupInfo {
         NftId productNftId;
         TokenHandler tokenHandler;
-        Fee distributionFee; // default distribution fee (no referral id)
-        address wallet;
-        // TODO: add sum of distibution owner fees (excl commissions from distributors)
-    }
-
-    struct PoolSetupInfo {
-        NftId productNftId;
-        TokenHandler tokenHandler;
-        bool isInterceptingBundleTransfers; // intercepts nft transfers for bundles
-        bool isExternallyManaged; // funding bundles is restricted to book keeping, actual funds may be provided as needed to support payouts
-        bool isVerifyingApplications; // underwriting requires the pool component checks/confirms the applications 
-        UFixed collateralizationLevel; // factor to calculate collateral for sum insurance (default 100%)
-        UFixed retentionLevel; // amount of collateral held in pool (default 100%)
-        Fee poolFee; // pool fee on net premium
-        Fee stakingFee; // pool fee on staked capital from investor
-        Fee performanceFee; // pool fee on profits from capital investors
+        Fee minDistributionOwnerFee;
+        Fee distributionFee; // recalculated whenever any fee on the product/pool/dist/disttype is changed
         address wallet;
+        uint256 sumDistributionOwnerFees;
     }
 }