@etherisc/gif-next 0.0.2-c4efd5e → 0.0.2-c576a00-897

package/contracts/components/IPoolComponent.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IPoolComponent is IBaseComponent {
+
+    event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
+
+    /**
+     * @dev creates a new bundle for this pool.
+     */
+    function createBundle(
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    ) external returns(NftId bundleNftId);
+
+    /** 
+     * @dev this is a callback function that is called by the product service when underwriting a policy.
+     * the pool has the option to check the details and object to underwriting by reverting.
+     * the function is only called for "active" pools that ask to be involved/notified
+     * by product related state changes.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    ) external;
+
+    /**
+     * @dev returns true iff the policy application data in policyData matches
+     * with the bundle filter criteria encoded in bundleFilter. 
+     */
+    function policyMatchesBundle(
+        bytes memory policyData,
+        bytes memory bundleFilter
+    )
+        external
+        view
+        returns (bool isMatching);
+
+    function isVerifying() external view returns (bool verifying);
+
+    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
+
+    function getStakingFee() external view returns (Fee memory stakingFee);
+
+    function getPerformanceFee()
+        external
+        view
+        returns (Fee memory performanceFee);
+}

package/contracts/components/IProductComponent.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IProductComponent is IBaseComponent {
+    function setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
+
+    function getPoolNftId() external view returns (NftId poolNftId);
+    
+    function getPolicyFee() external view returns (Fee memory policyFee);
+
+    function getProcessingFee() external view returns (Fee memory processingFee);
+}

package/contracts/components/Pool.sol

@@ -1,22 +1,174 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IPoolComponent} from "./IPool.sol";
-import {Component} from "./Component.sol";
+import {ObjectType, POOL} from "../types/ObjectType.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+
+contract Pool is BaseComponent, IPoolComponent {
+
+    bool internal _isVerifying;
+    UFixed internal _collateralizationLevel;
+
+    // may be used to interact with instance by derived contracts
+    IPoolService internal _poolService;
+
+    // only relevant to protect callback functions for "active" pools
+    IProductService private _productService;
+
+    modifier onlyPoolService() {
+        require(
+            msg.sender == address(_poolService), 
+            "ERROR:POL-001:NOT_POOL_SERVICE");
+        _;
+    }
+
+    modifier onlyProductService() {
+        require(
+            msg.sender == address(_productService), 
+            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+        _;
+    }
 
-contract Pool is Component, IPoolComponent {
     constructor(
         address registry,
-        address instance
-    ) Component(registry, instance) {}
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool verifying,
+        UFixed collateralizationLevel
+    )
+        BaseComponent(registry, instanceNftId, token)
+    {
+        _isVerifying = verifying;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
 
-    // from registerable
-    function getType() public view override returns (uint256) {
-        return _registry.POOL();
+        _poolService = _instance.getPoolService();
+        _productService = _instance.getProductService();
+    }
+
+    function createBundle(
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    )
+        external
+        virtual override
+        returns(NftId bundleNftId)
+    {
+        address owner = msg.sender;
+        bundleNftId = _poolService.createBundle(
+            owner,
+            initialAmount,
+            lifetime,
+            filter
+        );
+
+        // TODO add logging
+    }
+
+    /**
+     * @dev see {IPool.underwrite}. 
+     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        external
+        onlyProductService
+        virtual override 
+    {
+        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+    }
+
+    /**
+     * @dev see {IPoolComponent.policyMatchesBundle}. 
+     * Default implementation always returns true
+     */
+    function policyMatchesBundle(
+        bytes memory, // policyData
+        bytes memory // bundleFilter
+    )
+        public
+        view
+        virtual override
+        returns (bool isMatching)
+    {
+        return true;
+    }
+
+
+    function isVerifying() external view override returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _collateralizationLevel;
+    }
+
+    function _underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        internal 
+    {
+        require(
+            policyMatchesBundle(policyData, bundleFilter),
+            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
+        );
+
+        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
+    }
+
+    function _createBundle(
+        address bundleOwner,
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        internal
+        returns(NftId bundleNftId)
+    {
+        bundleNftId = _poolService.createBundle(
+            bundleOwner,
+            amount,
+            lifetime,
+            filter
+        );
+    }
+
+    // from pool component
+    function getStakingFee()
+        external
+        view
+        override
+        returns (Fee memory stakingFee)
+    {
+        return _instance.getPoolSetup(getNftId()).stakingFee;
+    }
+
+    function getPerformanceFee()
+        external
+        view
+        override
+        returns (Fee memory performanceFee)
+    {
+        return _instance.getPoolSetup(getNftId()).performanceFee;
     }
 
     // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function getType() public pure override returns (ObjectType) {
+        return POOL();
     }
 }

package/contracts/components/Product.sol

@@ -1,20 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IProductService} from "../instance/product/IProductService.sol";
-import {Component} from "./Component.sol";
-import {IProductComponent} from "./IProduct.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
 import {NftId} from "../types/NftId.sol";
+import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+import {Fee} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
 
-contract Product is Component, IProductComponent {
+contract Product is BaseComponent, IProductComponent {
     IProductService private _productService;
     address private _pool;
 
     constructor(
         address registry,
-        address instance,
+        NftId instanceNftid,
+        address token,
         address pool
-    ) Component(registry, instance) {
+    ) BaseComponent(registry, instanceNftid, token) {
+        // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
     }
@@ -35,21 +40,78 @@ contract Product is Component, IProductComponent {
         );
     }
 
-    function _underwrite(NftId nftId) internal {
-        _productService.underwrite(nftId);
+    function _underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.underwrite(
+            policyNftId, 
+            requirePremiumPayment, 
+            activateAt);
+    }
+
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.collectPremium(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.activate(
+            policyNftId, 
+            activateAt);
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
         return _registry.getNftId(_pool);
     }
 
-    // from registerable
-    function getType() public view override returns (uint256) {
-        return _registry.PRODUCT();
+    // from product component
+    function setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _productService.setFees(policyFee, processingFee);
+    }
+
+
+    function getPolicyFee()
+        external
+        view
+        override
+        returns (Fee memory policyFee)
+    {
+        return _instance.getProductSetup(getNftId()).policyFee;
+    }
+
+    function getProcessingFee()
+        external
+        view
+        override
+        returns (Fee memory processingFee)
+    {
+        return _instance.getProductSetup(getNftId()).processingFee;
     }
 
     // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function getType() public pure override returns (ObjectType) {
+        return PRODUCT();
     }
 }

package/contracts/experiment/kvstore/BundleModuleStore.sol

@@ -0,0 +1,93 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+/*
+
+from test_brownie.util import contract_from_address
+fa = {'from': accounts[0]}
+nl = NftIdLib.deploy(fa)
+tl = TimestampLib.deploy(fa)
+bm = BundleModuleStore.deploy(fa)
+kv = contract_from_address(KeyValueStore, bm.getStore())
+
+bi = bm.createBundleInfo(123456, 10**(5+6), kv.s2b('some filter')) # gas: 362979
+tx1 = bm.createBundleInfo(bi, fa)
+
+bi.dict()['lockedAmount'] = 42
+tx2 = bm.updateBundleInfo(bi, {'from': accounts[1]})
+
+bik32 = tx1.return_value
+bik = bm.toKey(bik32)
+
+tx1.info()
+tx2.info()
+
+ */
+
+import {NftId, toNftId} from "../../types/NftId.sol";
+import {ObjectType, BUNDLE} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE} from "../../types/StateId.sol";
+import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+
+import {IBundle} from "./IBundle.sol";
+import {KeyId, KeyMapper} from "./KeyMapper.sol";
+import {KeyValueStore} from "./KeyValueStore.sol";
+
+contract BundleModuleStore is KeyMapper, IBundle {
+
+    KeyValueStore private _store;
+
+    constructor() {
+        _store = new KeyValueStore();
+    }
+
+    function createBundleInfo(IBundle.BundleInfo memory info) public returns (bytes32 key) {
+        key = toBundleKey32(info.nftId);
+        _store.create(key, BUNDLE(), abi.encode(info));
+    }
+
+    function updateBundleInfo(IBundle.BundleInfo memory info) public {
+        bytes32 key = toBundleKey32(info.nftId);
+        _store.update(key, abi.encode(info));
+    }
+
+    function getBundleInfo(bytes32 key) public view returns (IBundle.BundleInfo memory) {
+        bytes memory data = _store.getData(key);
+        return abi.decode(data, (IBundle.BundleInfo));
+    }
+
+    function toBundleKey32(NftId bundleNftId) public pure returns (bytes32 key) {
+        return toKey32(BUNDLE(), toKeyId(bundleNftId));
+    }
+
+    function toKeyId(NftId nftId) public pure returns (KeyId keyId) {
+        uint248 intNftId = nftId.toInt();
+        keyId = KeyId.wrap(bytes31(intNftId));
+    }
+
+    function createBundleInfo(
+        uint256 bundleId,
+        uint256 amount,
+        bytes calldata filter
+    )
+        public 
+        view
+        returns(IBundle.BundleInfo memory info)
+    {
+        uint256 lifetime = 30 * 24 * 3600;
+        return IBundle.BundleInfo(
+            toNftId(bundleId),
+            toNftId(123456),
+            ACTIVE(),
+            filter,
+            amount, // capital amount
+            0, // locked amount
+            amount, // balance
+            blockTimestamp().addSeconds(lifetime), // expiredAt
+            zeroTimestamp()); // closedAt
+    }
+
+    function getStore() public view returns (KeyValueStore) {
+        return _store;
+    }
+}

package/contracts/experiment/kvstore/IBundle.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {StateId} from "../../types/StateId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+import {Blocknumber} from "../../types/Blocknumber.sol";
+
+interface IBundle {
+
+    struct BundleInfo {
+        NftId nftId;
+        NftId poolNftId;
+        StateId state; // active, paused, closed (expriy only implicit)
+        bytes filter; // required conditions for applications to be considered for collateralization by this bundle
+        uint256 capitalAmount; // net investment capital amount (<= balance)
+        uint256 lockedAmount; // capital amount linked to collateralizaion of non-closed policies (<= balance)
+        uint256 balanceAmount; // total amount of funds: net investment capital + net premiums - payouts
+        Timestamp expiredAt; // no new policies
+        Timestamp closedAt;
+    }
+}

package/contracts/experiment/kvstore/KeyMapper.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType, BUNDLE, RISK} from "../../types/ObjectType.sol";
+
+type KeyId is bytes31;
+
+contract KeyMapper {
+
+    uint8 public constant TYPE_SHIFT = 31 * 8;
+    uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+
+    struct Key {
+        ObjectType objectType;
+        KeyId id;
+    }
+
+    function toKey(ObjectType objectType, KeyId id) public pure returns(Key memory) {
+        return Key(objectType, id);
+    }
+
+    function toKey(bytes32 key) public pure returns (Key memory) {
+        ObjectType objectType = ObjectType.wrap(uint8(uint256(key & TYPE_MASK) >> TYPE_SHIFT));
+        KeyId id = KeyId.wrap(bytes31((key & ID_MASK) << ID_SHIFT));
+        return Key(objectType, id);
+    }
+
+    function toKey32(Key memory key) public pure returns(bytes32) {
+        return toKey32(key.objectType, key.id);
+    }
+
+    function toKey32(ObjectType objectType, KeyId id) public pure returns(bytes32) {
+        uint256 uintObjectType = ObjectType.unwrap(objectType);
+        uint256 uintId = uint248(KeyId.unwrap(id));
+        uint256 uintKey = (uintObjectType << TYPE_SHIFT) + uintId;
+        return bytes32(uintKey);
+    }
+}

package/contracts/experiment/kvstore/KeyValueStore.sol

@@ -0,0 +1,156 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+/*
+
+fa = {'from': accounts[0]}
+tl = TimestampLib.deploy(fa)
+kv = KeyValueStore.deploy(fa)
+
+pk = kv.s2k('policy key 1')
+pd = kv.s2b('policy info data 1.a')
+
+rk = kv.s2k('risk key 1')
+rd = kv.s2b('risk info data 1.a')
+
+kv.exists(pk)
+ptx = kv.create(pk, kv.policy(), pd)
+rtx = kv.create(rk, kv.policy(), rd)
+kv.exists(pk)
+kv.get(pk)
+
+kv.b2s(kv.getData(pk))
+
+pd1b = kv.s2b('b')
+ptxb = kv.update(pk, pd1b, True, True) # gas: 48019, 46428
+
+pd1c = kv.s2b('c')
+ptxc = kv.update(pk, pd1c, True, True) # gas: 43819, 42228
+
+pd1d = kv.s2b('d')
+ptxd = kv.update(pk, pd1d, True, False) # gas: 32655, 32699
+
+pd1e = kv.s2b('e')
+ptxe = kv.update(pk, pd1e, False, True) # gas: 34525, 34575
+
+pd1f = kv.s2b('f')
+ptxf = kv.update(pk, pd1f, False, False) # gas: 32638, 32682
+
+pd1g = kv.s2b('g')
+ptxg = kv.update(pk, pd1f, True, True, True, False) # gas: 
+
+
+
+*/
+
+type KeyId is bytes32;
+
+import {ObjectType, RISK, POLICY} from "../../types/ObjectType.sol";
+import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
+
+contract KeyValueStore {
+
+    event LogInfoCreated(bytes32 key, ObjectType objectType, address createdBy);
+    event LogInfoUpdated(bytes32 key, ObjectType objectType, address updatedBy, Blocknumber lastUpdateIn);
+
+    struct Metadata {
+        ObjectType objectType;
+        address updatedBy;
+        Blocknumber updatedIn;
+        Blocknumber createdIn;
+    }
+
+    struct Value {
+        Metadata metadata;
+        bytes data;
+    }
+
+    mapping(bytes32 key => Value value) private _value;
+    bytes32[] private _keys;
+
+    // key store functions
+    function create(bytes32 key, ObjectType objectType, bytes memory data) public {
+        Metadata storage metadata = _value[key].metadata;
+        require(metadata.updatedBy == address(0), "ERROR_ALREADY_CREATED");
+
+        address createdBy = msg.sender;
+        Blocknumber blocknumber = blockBlocknumber();
+        metadata.objectType = objectType;
+        metadata.updatedBy = createdBy;
+        metadata.updatedIn = blocknumber;
+        metadata.createdIn = blocknumber;
+
+        _value[key].data = data;
+        _keys.push(key);
+
+        emit LogInfoCreated(key, objectType, createdBy);
+    }
+
+    function update(bytes32 key, bytes memory data) public {
+        update(key, data, true, true);
+    }
+
+    function update(bytes32 key, bytes memory data, bool updateMetadata, bool log) public {
+        _value[key].data = data;
+        Blocknumber blocknumber = blockBlocknumber();
+
+        if(updateMetadata && log) {
+            Metadata storage metadata = _value[key].metadata;
+            require(metadata.updatedBy != address(0), "ERROR_NOT_EXISTING");
+
+            if (log) {
+                emit LogInfoUpdated(key, metadata.objectType, msg.sender, metadata.updatedIn);
+            }
+
+            metadata.updatedBy = msg.sender;
+            metadata.updatedIn = blocknumber;
+        } else if (log) {
+            emit LogInfoUpdated(key, POLICY(), msg.sender, blocknumber);
+        }
+    }
+
+    function exists(bytes32 key) public view returns (bool) {
+        return _value[key].metadata.updatedBy != address(0);
+    }
+
+    function get(bytes32 key) public view returns (Value memory value) {
+        return _value[key];
+    }
+
+    function getMetadata(bytes32 key) public view returns (Metadata memory metadata) {
+        return _value[key].metadata;
+    }
+
+    function getData(bytes32 key) public view returns (bytes memory data) {
+        return _value[key].data;
+    }
+
+    function getKeyCount() public view returns (uint256 keyCount) {
+        return _keys.length;
+    }
+
+    function getKey(uint256 index) public view returns (bytes32 key) {
+        return _keys[index];
+    }
+
+    function policy() public pure returns (ObjectType) {
+        return POLICY();
+    }
+
+    function risk() public pure returns (ObjectType) {
+        return RISK();
+    }
+
+    function s2k(string memory s) public pure returns (bytes32 k) {
+        return keccak256(abi.encodePacked(s));
+    }
+
+    function s2b(string memory s) public pure returns (bytes memory b) {
+        return abi.encode(s);
+    }
+
+    function b2s(bytes memory b) public pure returns (string memory s) {
+        return abi.decode(b, (string));
+    }
+}