@etherisc/gif-next 0.0.2-d13bb9e-069 → 0.0.2-d1ee1ae-450

package/contracts/examples/unpermissioned/SimpleOracle.sol

@@ -32,29 +32,26 @@ contract SimpleOracle is
 
     constructor(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         IAuthorization authorization,
-        address initialOwner,
-        address token
+        address initialOwner
     ) 
     {
         initialize(
             registry,
-            instanceNftId,
+            productNftId,
             authorization,
             initialOwner,
-            "SimpleOracle",
-            token
+            "SimpleOracle"
         );
     }
 
     function initialize(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         public
         virtual
@@ -62,11 +59,10 @@ contract SimpleOracle is
     {
         _initializeBasicOracle(
             registry,
-            instanceNftId,
+            productNftId,
             authorization,
             initialOwner,
-            name,
-            token);
+            name);
     }
 
     /// @dev use case specific handling of oracle requests

package/contracts/examples/unpermissioned/SimplePool.sol

@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 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 {IComponents} from "../../instance/module/IComponents.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Seconds} from "../../type/Timestamp.sol";
 import {UFixed} from "../../type/UFixed.sol";
@@ -16,25 +18,26 @@ contract SimplePool is
     
     constructor(
         address registry,
-        NftId instanceNftId,
-        address token,
+        NftId productNftId,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     ) 
     {
         initialize(
             registry,
-            instanceNftId,
-            token,
+            productNftId,
+            poolInfo,
             authorization,
             initialOwner
         );
     }
 
+
     function initialize(
         address registry,
-        NftId instanceNftId,
-        address token,
+        NftId productNftId,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     )
@@ -44,13 +47,14 @@ contract SimplePool is
     {
         _initializeBasicPool(
             registry,
-            instanceNftId,
-            authorization,
-            token,
+            productNftId,
             "SimplePool",
+            poolInfo,
+            authorization,
             initialOwner);
     }
 
+
     function createBundle(
         Fee memory fee,
         uint256 initialAmount,
@@ -73,4 +77,26 @@ contract SimplePool is
         netStakedAmountInt = netStakedAmount.toInt();
     }
 
+
+    function fundPoolWallet(
+        Amount amount
+    )
+        external
+    {
+        _fundPoolWallet(amount);
+    }
+
+
+    function defundPoolWallet(
+        Amount amount
+    )
+        external
+    {
+        _defundPoolWallet(amount);
+    }
+
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
+    function setLocked(bool locked) external onlyOwner() { _setLocked(locked); }
+    function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
 }

package/contracts/examples/unpermissioned/SimplePoolAuthorization.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
+import {IAccess} from "../../authorization/IAccess.sol";
+import {PUBLIC_ROLE} from "../../type/RoleId.sol";
+import {SimplePool} from "./SimplePool.sol";
+
+contract SimplePoolAuthorization
+    is BasicPoolAuthorization
+{
+    constructor(string memory poolName)
+        BasicPoolAuthorization(poolName)
+    {}
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+
+        // authorize public role (open access to any account, only allows to lock target)
+        IAccess.FunctionInfo[] storage functions;
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, SimplePool.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, SimplePool.setWallet.selector, "setWallet");
+    }
+}

package/contracts/examples/unpermissioned/SimpleProduct.sol

@@ -1,10 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {Amount, AmountLib} from "../../type/Amount.sol";
 import {BasicProduct} from "../../product/BasicProduct.sol";
 import {ClaimId} from "../../type/ClaimId.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
 import {IOracleService} from "../../oracle/IOracleService.sol";
 import {ORACLE} from "../../type/ObjectType.sol";
 import {NftId} from "../../type/NftId.sol";
@@ -32,38 +35,33 @@ contract SimpleProduct is
 
     constructor(
         address registry,
-        NftId instanceNftid,
+        NftId instanceNftId,
+        string memory name,
+        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
-        address initialOwner,
-        address token,
-        bool isInterceptor,
-        address pool,
-        address distribution
+        address initialOwner
     )
     {
         initialize(
             registry,
-            instanceNftid,
+            instanceNftId,
+            name,
+            productInfo,
+            feeInfo,
             authorization,
-            initialOwner,
-            "SimpleProduct",
-            token,
-            isInterceptor,
-            pool,
-            distribution); 
+            initialOwner); 
     }
 
 
     function initialize(
         address registry,
         NftId instanceNftid,
-        IAuthorization authorization,
-        address initialOwner,
         string memory name,
-        address token,
-        bool isInterceptor,
-        address pool,
-        address distribution
+        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
+        IAuthorization authorization,
+        address initialOwner
     )
         public
         virtual
@@ -72,23 +70,22 @@ contract SimpleProduct is
         _initializeBasicProduct(
             registry,
             instanceNftid,
-            authorization,
-            initialOwner,
             name,
-            token,
-            isInterceptor,
-            pool,
-            distribution); 
+            productInfo,
+            feeInfo,
+            authorization,
+            initialOwner); 
 
         _oracleService = IOracleService(_getServiceAddress(ORACLE()));
     }
 
+
     function createRisk(
-        RiskId id,
+        string memory id,
         bytes memory data
-    ) public {
-        _createRisk(
-            id,
+    ) public returns (RiskId) {
+        return _createRisk(
+            bytes32(abi.encodePacked(id)),
             data
         );
     }
@@ -187,6 +184,13 @@ contract SimpleProduct is
         _activate(policyNftId, activateAt);
     }
 
+    function adjustActivation(
+        NftId policyNftId,
+        Timestamp activateAt
+    ) public {
+        _adjustActivation(policyNftId, activateAt);
+    }
+
     function close(
         NftId policyNftId
     ) public {
@@ -201,6 +205,13 @@ contract SimpleProduct is
         return _submitClaim(policyNftId, claimAmount, submissionData);
     }
 
+    function revokeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    ) public {
+        _revokeClaim(policyNftId, claimId);
+    }
+
     function confirmClaim(
         NftId policyNftId,
         ClaimId claimId,
@@ -234,6 +245,13 @@ contract SimpleProduct is
         return _createPayout(policyNftId, claimId, amount, data);
     }
 
+    function cancelPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    ) public {
+        _cancelPayout(policyNftId, payoutId);
+    }
+
     // TODO add test
     function createPayoutForBeneficiary(
         NftId policyNftId,
@@ -348,4 +366,8 @@ contract SimpleProduct is
     function getOracleService() public view returns (IOracleService) {
         return _oracleService;
     }
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
+    function setLocked(bool locked) external onlyOwner() { _setLocked(locked); }
+    function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
 }

package/contracts/examples/unpermissioned/SimpleProductAuthorization.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {BasicProductAuthorization} from "../../product/BasicProductAuthorization.sol";
+import {IAccess} from "../../authorization/IAccess.sol";
+import {PUBLIC_ROLE} from "../../type/RoleId.sol";
+import {SimpleProduct} from "./SimpleProduct.sol";
+
+contract SimpleProductAuthorization
+    is BasicProductAuthorization
+{
+    constructor(string memory componentName)
+        BasicProductAuthorization(componentName)
+    {}
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+
+        // authorize public role (open access to any account, only allows to lock target)
+        IAccess.FunctionInfo[] storage functions;
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, SimpleProduct.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, SimpleProduct.setWallet.selector, "setWallet");
+    }
+}

package/contracts/instance/BundleSet.sol

@@ -1,20 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IInstance} from "./IInstance.sol";
-import {INSTANCE} from "../type/ObjectType.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
 import {LibNftIdSet} from "../type/NftIdSet.sol";
-import {NftId} from "../type/NftId.sol";
-import {TimestampLib} from "../type/Timestamp.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {Key32} from "../type/Key32.sol";
+import {BUNDLE} from "../type/ObjectType.sol";
 
 import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
 
 contract BundleSet is 
     ObjectSet
 {
+    using LibNftIdSet for LibNftIdSet.Set;
 
     event LogBundleSetPolicyLinked(NftId bundleNftId, NftId policyNftId);
     event LogBundleSetPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
@@ -34,93 +32,99 @@ contract BundleSet is
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
     /// @dev links a policy to its bundle
-    // to link a policy it MUST NOT yet have been linked
-    function linkPolicy(NftId policyNftId) external restricted() {
-        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
-        // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+    function linkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
 
         // ensure bundle is unlocked (in active set) and registered with this instance
-        if (!_isActive(poolNftId, bundleNftId)) {
+        if (!_isActive(poolNftId, _toBundleKey32(bundleNftId))) {
             revert ErrorBundleSetBundleLocked(bundleNftId, policyNftId);
         }
 
-        LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
+        _activePolicies[bundleNftId].add(policyNftId);
         emit LogBundleSetPolicyLinked(bundleNftId, policyNftId);
     }
 
 
     /// @dev unlinks a policy from its bundle
-    // to unlink a policy it must closable, ie. meet one of the following criterias
-    // - the policy MUST be past its expiry period and it MUST NOT have any open claims
-    // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
-    function unlinkPolicy(NftId policyNftId) external restricted() {
-        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
-
-        NftId bundleNftId = policyInfo.bundleNftId;
-        // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+    function unlinkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
 
         // ensure bundle is registered with this instance
-        if (!_contains(poolNftId, bundleNftId)) {
+        if (!_contains(poolNftId, _toBundleKey32(bundleNftId))) {
             revert ErrorBundleSetBundleUnknown(bundleNftId);
         }
 
-        LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
-        emit LogBundleSetPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+        _activePolicies[bundleNftId].remove(policyNftId);
+        emit LogBundleSetPolicyUnlinked(bundleNftId, policyNftId);
     }
 
 
     /// @dev add a new bundle to a pool registerd with this instance
     // the corresponding pool is fetched via instance reader
     function add(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
 
         // ensure pool is registered with instance
         if(poolNftId.eqz()) {
             revert ErrorBundleSetBundleNotRegistered(bundleNftId);
         }
 
-        _add(poolNftId, bundleNftId);
+        _add(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleAdded(poolNftId, bundleNftId);
     }
 
 
     /// @dev unlocked (active) bundles are available to collateralize new policies
     function unlock(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
-        _activate(poolNftId, bundleNftId);
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
+        _activate(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleUnlocked(poolNftId, bundleNftId);
     }
 
     /// @dev locked (deactivated) bundles may not collateralize any new policies
     function lock(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
-        _deactivate(poolNftId, bundleNftId);
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
+        _deactivate(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleLocked(poolNftId, bundleNftId);
     }
 
+
+    function checkBundle(NftId productNftId, NftId bundleId)
+        public
+        view 
+        returns (bool exists, bool active)
+    {
+        Key32 bundleKey32 = bundleId.toKey32(BUNDLE());
+        exists = _contains(productNftId, bundleKey32);
+
+        if (exists) {
+            active = _isActive(productNftId, bundleKey32);
+        }
+    }
+
     function bundles(NftId poolNftId) external view returns(uint256) {
         return _objects(poolNftId);
     }
 
-    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
-        return _getObject(poolNftId, idx);
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getObject(poolNftId, idx).toKeyId());
     }
 
     function activeBundles(NftId poolNftId) external view returns(uint256) {
         return _activeObjs(poolNftId);
     }
 
-    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
-        return _getActiveObject(poolNftId, idx);
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getActiveObject(poolNftId, idx).toKeyId());
     }
 
     function activePolicies(NftId bundleNftId) external view returns(uint256) {
-        return LibNftIdSet.size(_activePolicies[bundleNftId]);
+        return _activePolicies[bundleNftId].size();
     }
 
     function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
-        return LibNftIdSet.getElementAt(_activePolicies[bundleNftId], idx);
+        return _activePolicies[bundleNftId].getElementAt(idx);
+    }
+
+    function _toBundleKey32(NftId nftId) private pure returns (Key32) {
+        return nftId.toKey32(BUNDLE());
     }
 }

package/contracts/instance/IInstance.sol

@@ -1,34 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {NftId} from "../type/NftId.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {VersionPart} from "../type/Version.sol";
 
 
 interface IInstance is 
-    IRegisterable, 
-    ITransferInterceptor, 
-    IAccessManaged
+    IRegisterable
 {
     error ErrorInstanceInstanceAdminZero();
-    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAlreadySet(address instanceAdmin);
     error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
     error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
     error ErrorInstanceBundleSetInstanceMismatch(address instance);
     error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
+    error ErrorInstanceRiskSetAlreadySet(address instanceRiskSet);
+    error ErrorInstanceRiskSetInstanceMismatch(address instance);
+    error ErrorInstanceRiskSetAuthorityMismatch(address instanceAuthority);
+
     error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
@@ -38,26 +38,69 @@ interface IInstance is
         uint64 requestsCount;
     }
 
-    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
-    function grantRole(RoleId roleId, address account) external;
-    function revokeRole(RoleId roleId, address account) external;
+    ///--- instance ---------------------------------------------------------//
 
-    function createTarget(address target, string memory name) external;
-    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
-    function setTargetLocked(address target, bool locked) external;
+    /// @dev Locks/unlocks the complete instance, including all its components.
+    function setInstanceLocked(bool locked) external;
 
+    /// @dev Upgrades the instance reader to the specified target.
+    function upgradeInstanceReader() external;
+
+    /// @dev Sets the instance reader for the instance.
+    /// Permissioned: only the instance service may call this function.
+    function setInstanceReader(InstanceReader instanceReader) external;
+
+    ///--- staking ----------------------------------------------------------//
+
+    /// @dev Sets the duration for locking new stakes on this instance..
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+
+    /// @dev Sets the staking reward rate [apr] for this instance.
     function setStakingRewardRate(UFixed rewardRate) external;
+
+    /// @dev Sets the maximum staked amount for this instance.
+    function setStakingMaxAmount(Amount maxStakedAmount) external;
+
+    /// @dev Refills the staking reward reserves for the specified target.
     function refillStakingRewardReserves(Amount dipAmount) external;
 
     /// @dev Defunds the staking reward reserves for the specified target.
-    /// Permissioned: only the target owner may call this function.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
-    // get instance release and supporting contracts
-    function getMajorVersion() external pure returns (VersionPart majorVersion);
+    ///--- product/component ------------------------------------------------//
+
+    /// @dev Locks/unlocks the specified target.
+    function setTargetLocked(address target, bool locked) external;
+
+    /// @dev Register a product with the instance.
+    function registerProduct(address product, address token) external returns (NftId productNftId);
+
+    ///--- authz ------------------------------------------------------------//
+
+    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
+    function grantRole(RoleId roleId, address account) external;
+    function revokeRole(RoleId roleId, address account) external;
+
+    function createTarget(address target, string memory name) external;
+    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+
+    //--- getters -----------------------------------------------------------//
+
+    /// @dev returns the overall locking state of the instance (including all components)
+    function isInstanceLocked() external view returns (bool isLocked);
+
+    /// @dev returns the locking state of the specified target
+    function isTargetLocked(address target) external view returns (bool isLocked);
+
+    // get products
+    function products() external view returns (uint256 productCount);
+    function getProductNftId(uint256 idx) external view returns (NftId productNftId);
+
+    // get supporting contracts
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleSet() external view returns (BundleSet);
+    function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
+    function isTokenRegistryDisabled() external view returns (bool);
 }