@etherisc/gif-next 0.0.2-f7b8c9f-518 → 0.0.2-f7eda15-119

package/contracts/instance/base/ComponentService.sol

@@ -0,0 +1,134 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IComponent} from "../../components/IComponent.sol";
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {IAccess} from "../module/IAccess.sol";
+import {ObjectType, INSTANCE, REGISTRY} from "../../types/ObjectType.sol";
+import {NftId} from "../../types/NftId.sol";
+import {RoleId} from "../../types/RoleId.sol";
+
+import {Service} from "../../shared/Service.sol";
+import {InstanceService} from "../InstanceService.sol";
+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);
+    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
+    error ErrorComponentServiceComponentLocked(address component);
+
+    /// @dev modifier to check if caller is a registered service
+    modifier onlyService() {
+        address caller = msg.sender;
+        require(getRegistry().isRegisteredService(caller), "ERROR_NOT_SERVICE");
+        _;
+    }
+
+    // view functions
+
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
+        return IRegistryService(service);
+    }
+
+    function getInstanceService() public view returns (InstanceService) {
+        address service = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
+        return InstanceService(service);
+    }
+
+    // internal functions
+    function _checkComponentForRegistration(
+        address componentAddress,
+        ObjectType requiredType,
+        RoleId requiredRole
+    )
+        internal
+        view
+        returns (
+            IComponent component,
+            address owner,
+            IInstance instance,
+            NftId instanceNftId
+        )
+    {
+        // component may only be registerd by initial owner of component
+        owner = msg.sender;
+
+        // check component has not already been registerd
+        NftId compoentNftId = _registry.getNftId(componentAddress);
+        if(compoentNftId.gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress, compoentNftId);
+        }
+
+        // check this is a component
+        component = IComponent(componentAddress);
+        if(!component.supportsInterface(type(IComponent).interfaceId)) {
+            revert ErrorComponentServiceNotComponent(componentAddress);
+        }
+
+        // check component is of required type
+        IRegistry.ObjectInfo memory componentInfo = component.getInitialInfo();
+        if(componentInfo.objectType != requiredType) {
+            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, componentInfo.objectType);
+        }
+
+        // check msg.sender is component owner
+        address initialOwner = componentInfo.initialOwner;
+        if(owner != initialOwner) {
+            revert ErrorComponentServiceSenderNotOwner(componentAddress, componentInfo.initialOwner, owner);
+        }
+
+        // check instance has assigned required role to owner
+        instanceNftId = componentInfo.parentNftId;
+        instance = _getInstance(instanceNftId);
+        bool hasRole = getInstanceService().hasRole(
+            owner, 
+            requiredRole, 
+            address(instance));
+
+        if(!hasRole) {
+            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(
+            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);
+
+        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
+        if (accessManager.isTargetLocked(info.objectAddress)) {
+            revert IAccess.ErrorIAccessTargetLocked(info.objectAddress);
+        }
+    }
+}

package/contracts/instance/base/IKeyValueStore.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
 import {Key32, KeyId} from "../../types/Key32.sol";
@@ -9,13 +9,9 @@ import {StateId} from "../../types/StateId.sol";
 
 import {ILifecycle} from "./ILifecycle.sol";
 
+// TODO remove - internal only?
 interface IKeyValueStore is ILifecycle {
 
-    struct Key {
-        ObjectType objectType;
-        KeyId id;
-    }
-
     struct Value {
         Metadata metadata;
         bytes data;
@@ -24,20 +20,24 @@ interface IKeyValueStore is ILifecycle {
     struct Metadata {
         ObjectType objectType;
         StateId state;
+        // TODO updatedBy needs concept that says what value should go here
+        // eg account outside gif objects that initiated the tx
+        // implies the caller needs to be propagated through all calls up to key values store itself
+        // to always have the instance address there doesn't seem to make sense
         address updatedBy;
         Blocknumber updatedIn;
         Blocknumber createdIn;
     }
 
-    event LogInfoCreated(Key key, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(Key key, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(Key key, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
+    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
 
     // generic state changing functions
-    function create(Key32 key, ObjectType objectType, bytes memory data) external;
-    function update(Key32 key, StateId state, bytes memory data) external;
-    function updateData(Key32 key, bytes memory data) external;
-    function updateState(Key32 key, StateId state) external;
+    // function create(Key32 key, bytes memory data) external;
+    // function update(Key32 key, bytes memory data, StateId state) external;
+    // function updateData(Key32 key, bytes memory data) external;
+    // function updateState(Key32 key, StateId state) external;
 
     function exists(Key32 key) external view returns (bool);
     function get(Key32 key) external view returns (Value memory value);
@@ -46,5 +46,4 @@ interface IKeyValueStore is ILifecycle {
     function getState(Key32 key) external view returns (StateId state);
 
     function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
-    function toKey(Key32 key32) external pure returns(Key memory key);
 }

package/contracts/instance/base/ILifecycle.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
 import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {StateId} from "../../types/StateId.sol";
 
 interface ILifecycle {
 

package/contracts/instance/base/KeyValueStore.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
 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 {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+import {Timestamp, TimestampLib} from "../../types/Timestamp.sol";
 
 import {Lifecycle} from "./Lifecycle.sol";
 import {IKeyValueStore} from "./IKeyValueStore.sol";
@@ -14,27 +14,23 @@ import {IKeyValueStore} from "./IKeyValueStore.sol";
 contract KeyValueStore is Lifecycle, IKeyValueStore {
 
     mapping(Key32 key32 => Value value) private _value;
-    address private _owner;
 
-    modifier onlyOwner() {
-        require(
-            msg.sender == _owner,
-            "ERROR:KVS-001:NOT_OWNER");
-        _;
-    }
-
-    constructor() {
-        _owner = msg.sender;
+    function create(
+        Key32 key32, 
+        bytes memory data
+    )
+        internal
+    {
+        _create(key32, data);
     }
 
-    function create(
+    function _create(
         Key32 key32, 
-        ObjectType objectType, 
         bytes memory data
     )
-        public
-        onlyOwner
+        internal
     {
+        ObjectType objectType = key32.toObjectType();
         require(objectType.gtz(), "ERROR:KVS-010:TYPE_UNDEFINED");
 
         Metadata storage metadata = _value[key32].metadata;
@@ -55,12 +51,25 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         _value[key32].data = data;
 
         // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoCreated(toKey(key32), initialState, createdBy, tx.origin);
+        emit LogInfoCreated(key32.toObjectType(), key32.toKeyId(), initialState, createdBy, tx.origin);
     }
 
-    function update(Key32 key32, StateId state, bytes memory data) 
-        public
-        onlyOwner
+    function update(
+        Key32 key32, 
+        bytes memory data,
+        StateId state
+    ) 
+        internal
+    {
+        _update(key32, data, state);
+    }
+
+    function _update(
+        Key32 key32, 
+        bytes memory data,
+        StateId state
+    ) 
+        internal
     {
         require(state.gtz(), "ERROR:KVS-020:STATE_UNDEFINED");
         Metadata storage metadata = _value[key32].metadata;
@@ -78,16 +87,20 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         metadata.updatedIn = blockBlocknumber();
 
         // create log entries
-        Key memory key = toKey(key32);
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogStateUpdated(key, state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key, state, updatedBy, tx.origin, lastUpdatedIn);
+        // solhint-disable avoid-tx-origin
+        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
+        // solhing-enable
     }
 
     function updateData(Key32 key32, bytes memory data) 
-        public
-        onlyOwner
+        internal
+    {
+        _updateData(key32, data);
+    }
+
+    function _updateData(Key32 key32, bytes memory data) 
+        internal
     {
         Metadata storage metadata = _value[key32].metadata;
         StateId state = metadata.state;
@@ -103,14 +116,18 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         metadata.updatedIn = blockBlocknumber();
 
         // create log entry
-        Key memory key = toKey(key32);
         // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key, state, updatedBy, tx.origin, lastUpdatedIn);
+        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
     }
 
     function updateState(Key32 key32, StateId state)
-        public
-        onlyOwner
+        internal
+    {
+        _updateState(key32, state);
+    }
+
+    function _updateState(Key32 key32, StateId state)
+        internal
     {
         require(state.gtz(), "ERROR:KVS-040:STATE_UNDEFINED");
         Metadata storage metadata = _value[key32].metadata;
@@ -125,9 +142,8 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         metadata.updatedIn = blockBlocknumber();
 
         // create log entry
-        Key memory key = toKey(key32);
         // solhint-disable-next-line avoid-tx-origin
-        emit LogStateUpdated(key, state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
     }
 
     function exists(Key32 key32) public view returns (bool) {
@@ -153,9 +169,4 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
     function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
         return Key32Lib.toKey32(objectType, id);
     }
-
-    function toKey(Key32 key32) public pure override returns (Key memory key) {
-        (ObjectType objectType, KeyId id) = key32.toKey();
-        return Key(objectType, id);
-    }
 }

package/contracts/instance/base/Lifecycle.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {NftId} from "../../types/NftId.sol";
 import {ObjectType, COMPONENT, BUNDLE, POLICY, RISK} from "../../types/ObjectType.sol";

package/contracts/instance/module/IAccess.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
+
+import {RoleId} from "../../types/RoleId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+
+interface IAccess {
+
+    struct RoleInfo {
+        ShortString name;
+        bool isCustom;
+        bool isLocked;
+        Timestamp createdAt;
+        Timestamp updatedAt;
+    }
+
+    struct TargetInfo {
+        ShortString name;
+        bool isCustom;
+        bool isLocked;
+        Timestamp createdAt;
+        Timestamp updatedAt;
+    }
+
+    error ErrorIAccessRoleIdInvalid(RoleId roleId);
+    error ErrorIAccessRoleIdTooBig(RoleId roleId);
+    error ErrorIAccessRoleIdTooSmall(RoleId roleId);
+    error ErrorIAccessRoleIdAlreadyExists(RoleId roleId, ShortString name);
+    error ErrorIAccessRoleIdNotActive(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 ErrorIAccessSetLockedForNonexstentRole(RoleId roleId);
+    error ErrorIAccessGrantNonexstentRole(RoleId roleId);
+    error ErrorIAccessRevokeNonexstentRole(RoleId roleId); 
+    error ErrorIAccessRenounceNonexstentRole(RoleId roleId);
+
+    error ErrorIAccessTargetAddressZero();
+    error ErrorIAccessTargetAlreadyExists(address target, ShortString name);
+    error ErrorIAccessTargetNameEmpty(address target);
+    error ErrorIAccessTargetNameExists(address target, address existingTarget, ShortString name);
+    error ErrorIAccessSetLockedForNonexstentTarget(address target);
+    error ErrorIAccessTargetLocked(address target);
+}

package/contracts/instance/module/IBundle.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.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
+        Timestamp closedAt; // no open policies, locked amount = 0
+    }
+}

package/contracts/instance/module/IDistribution.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {DistributorType} from "../../types/DistributorType.sol";
+import {NftId} from "../../types/NftId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+import {UFixed} from "../../types/UFixed.sol";
+
+interface IDistribution {
+
+    struct DistributorTypeInfo {
+        string name;
+        UFixed minDiscountPercentage;
+        UFixed maxDiscountPercentage;
+        UFixed commissionPercentage;
+        uint32 maxReferralCount;
+        uint32 maxReferralLifetime;
+        bool allowSelfReferrals;
+        bool allowRenewals;
+        bytes data;
+    }
+
+    struct DistributorInfo {
+        DistributorType distributorType;
+        bool active;
+        bytes data;
+    }
+
+    struct ReferralInfo {   
+        NftId distributorNftId;
+        string referralCode;
+        UFixed discountPercentage;
+        uint32 maxReferrals;
+        uint32 usedReferrals;
+        Timestamp expiryAt;
+        bytes data;
+    }
+
+}

package/contracts/instance/module/IPolicy.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../../types/NftId.sol";
+import {NumberId} from "../../types/NumberId.sol";
+import {ReferralId} from "../../types/Referral.sol";
+import {RiskId} from "../../types/RiskId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+
+interface IPolicy {
+    struct PolicyInfo {
+        NftId productNftId;
+        NftId bundleNftId;
+        ReferralId referralId;
+        RiskId riskId;
+        uint256 sumInsuredAmount;
+        uint256 premiumAmount;
+        uint256 premiumPaidAmount;
+        uint256 lifetime;
+        bytes applicationData;
+        bytes policyData;
+        uint16 claimsCount;
+        uint16 openClaimsCount;
+        uint256 payoutAmount;
+        Timestamp activatedAt; // time of underwriting
+        Timestamp expiredAt; // no new claims (activatedAt + lifetime)
+        Timestamp closedAt; // no locked capital (or declinedAt)
+    }
+
+    // claimId neeeds to be encoded policyNftId:claimId combination
+    struct ClaimInfo {
+        uint256 claimAmount;
+        uint256 paidAmount;
+        bytes data;
+        Timestamp closedAt; // payoment of confirmed claim amount (or declinedAt)
+    }
+
+    // claimId neeeds to be encoded policyNftId:claimId combination
+    struct PayoutInfo {
+        NumberId claimId;
+        uint256 amount;
+        bytes data;
+        Timestamp paidAt; // payoment of confirmed claim amount (or declinedAt)
+    }
+}

package/contracts/instance/module/IRisk.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../../types/NftId.sol";
+
+interface IRisk {
+    struct RiskInfo {
+        NftId productNftId;
+        bytes data;
+    }
+}

package/contracts/instance/module/ISetup.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {Fee} from "../../types/Fee.sol";
+import {NftId} from "../../types/NftId.sol";
+import {UFixed} from "../../types/UFixed.sol";
+import {TokenHandler} from "../../shared/TokenHandler.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
+        bool isIntercepting; // intercepts nft transfers (for products)
+        address wallet;
+    }
+
+    struct DistributionSetupInfo {
+        NftId productNftId;
+        TokenHandler tokenHandler;
+        Fee distributionFee; // default distribution fee (no referral id)
+        bool isIntercepting; // intercepts nft transfers (for distributors)
+        address wallet;
+    }
+
+    struct PoolSetupInfo {
+        NftId productNftId;
+        TokenHandler tokenHandler;
+        UFixed collateralizationLevel;
+        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
+        bool isIntercepting; // intercepts nft transfers (for bundles)
+        bool isConfirmingApplication; // confirms applications before they are underwritten
+        address wallet;
+    }
+}

package/contracts/instance/module/ITreasury.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {Fee} from "../../types/Fee.sol";
+import {NftId} from "../../types/NftId.sol";
+import {TokenHandler} from "../../shared/TokenHandler.sol";
+
+interface ITreasury {
+    struct TreasuryInfo {
+        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
+    }
+}