@etherisc/gif-next 0.0.2-adb0ad8-584 → 0.0.2-ae6744f-037

package/contracts/distribution/BasicDistribution.sol

@@ -44,8 +44,8 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyOwner()
         restricted()
+        onlyOwner()
         returns (DistributorType distributorType)
     {
         return _createDistributorType(
@@ -67,25 +67,25 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyOwner()
         restricted()
+        onlyOwner()
         returns(NftId distributorNftId)
     {
         return _createDistributor(distributor, distributorType, data);
     }
 
-    function updateDistributorType(
+    function changeDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
     )
         external
         virtual
+        restricted()
         onlyOwner()
         onlyNftOfType(distributorNftId, DISTRIBUTOR())
-        restricted()
     {
-        _updateDistributorType(distributorNftId, distributorType, data);
+        _changeDistributorType(distributorNftId, distributorType, data);
     }
 
     /**
@@ -101,8 +101,8 @@ contract BasicDistribution is
     )
         external
         virtual
-        onlyDistributor()
         restricted()
+        onlyDistributor()
         returns (ReferralId referralId)
     {
         NftId distributorNftId = getDistributorNftId(msg.sender);

package/contracts/distribution/BasicDistributionAuthorization.sol

@@ -37,7 +37,7 @@ contract BasicDistributionAuthorization
           _authorize(functions, BasicDistribution.setFees.selector, "setFees");
           _authorize(functions, BasicDistribution.createDistributorType.selector, "createDistributorType");
           _authorize(functions, BasicDistribution.createDistributor.selector, "createDistributor");
-          _authorize(functions, BasicDistribution.updateDistributorType.selector, "updateDistributorType");
+          _authorize(functions, BasicDistribution.changeDistributorType.selector, "changeDistributorType");
           _authorize(functions, BasicDistribution.createReferral.selector, "createReferral");
           
           _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");

package/contracts/distribution/Distribution.sol

@@ -37,6 +37,32 @@ abstract contract Distribution is
     }
 
 
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        virtual
+        restricted()
+    {
+        // default is no action
+    }
+
+
+    /// @inheritdoc IDistributionComponent
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyDistributor()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        onlyNftOwner(distributorNftId)
+        returns (Amount withdrawnAmount) 
+    {
+        return _withdrawCommission(distributorNftId, amount);
+    }
+
+
     function isDistributor(address candidate)
         public
         view
@@ -97,35 +123,12 @@ abstract contract Distribution is
     }
 
 
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        virtual
-        restricted()
-    {
-        // default is no action
-    }
-
     /// @dev Returns true iff the component needs to be called when selling/renewing policis
     function isVerifying() external pure returns (bool verifying) {
         return true;
     }
 
-    /// @inheritdoc IDistributionComponent
-    function withdrawCommission(NftId distributorNftId, Amount amount) 
-        external 
-        virtual
-        restricted()
-        onlyDistributor()
-        onlyNftOfType(distributorNftId, DISTRIBUTOR())
-        onlyNftOwner(distributorNftId)
-        returns (Amount withdrawnAmount) 
-    {
-        return _withdrawCommission(distributorNftId, amount);
-    }
-        
+
     function _initializeDistribution(
         address registry,
         NftId productNftId,
@@ -223,7 +226,7 @@ abstract contract Distribution is
     }
 
     /// @dev Uptates the distributor type for the specified distributor.
-    function _updateDistributorType(
+    function _changeDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
@@ -232,11 +235,10 @@ abstract contract Distribution is
         virtual
     {
         DistributionStorage storage $ = _getDistributionStorage();
-        // TODO re-enable once implemented
-        // $._distributionService.updateDistributorType(
-        //     distributorNftId,
-        //     distributorType,
-        //     data);
+        $._distributionService.changeDistributorType(
+            distributorNftId,
+            distributorType,
+            data);
     }
 
     /// @dev Create a new referral code for the provided distributor.

package/contracts/distribution/DistributionService.sol

@@ -136,21 +136,20 @@ contract DistributionService is
         instance.getInstanceStore().createDistributor(distributorNftId, info);
     }
 
-    // function updateDistributorType(
-    //     NftId distributorNftId,
-    //     DistributorType distributorType,
-    //     bytes memory data
-    // )
-    //     external
-    //     virtual
-    // {
-    //     (, IInstance instance) = _getAndVerifyCallingDistribution();
-    //     InstanceReader instanceReader = instance.getInstanceReader();
-    //     IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
-    //     distributorInfo.distributorType = distributorType;
-    //     distributorInfo.data = data;
-    //     instance.updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
-    // }
+    function changeDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        external
+        virtual
+    {
+        (,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        IDistribution.DistributorInfo memory distributorInfo = instance.getInstanceReader().getDistributorInfo(distributorNftId);
+        distributorInfo.distributorType = distributorType;
+        distributorInfo.data = data;
+        instance.getInstanceStore().updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
+    }
 
 
     function createReferral(
@@ -223,7 +222,7 @@ contract DistributionService is
         if (referralIsValid(distributionNftId, referralId)) {
             IRegistry registry = getRegistry();
             IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-            IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+            IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
@@ -244,7 +243,7 @@ contract DistributionService is
     {
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
@@ -285,7 +284,7 @@ contract DistributionService is
         InstanceReader reader = instance.getInstanceReader();
         
         IComponents.ComponentInfo memory distributionInfo = reader.getComponentInfo(distributionNftId);
-        address distributionWallet = distributionInfo.wallet;
+        address distributionWallet = distributionInfo.tokenHandler.getWallet();
         
         Amount commissionAmount = reader.getFeeAmount(distributorNftId);
         
@@ -328,7 +327,7 @@ contract DistributionService is
 
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {

package/contracts/distribution/IDistributionService.sol

@@ -56,12 +56,11 @@ interface IDistributionService is IService {
         bytes memory data
     ) external returns (NftId distributorNftId);
 
-    // TODO re-enable and reorganize (service contract too large)
-    // function updateDistributorType(
-    //     NftId distributorNftId,
-    //     DistributorType distributorType,
-    //     bytes memory data
-    // ) external;
+    function changeDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    ) external;
 
     function createReferral(
         NftId distributorNftId,

package/contracts/examples/fire/FirePool.sol

@@ -1,22 +1,23 @@
 // 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";
+import {UFixed, UFixedLib} from "../../type/UFixed.sol";
 
 contract FirePool is
     BasicPool
-{
-    
+{   
     constructor(
         address registry,
-        NftId instanceNftId,
+        NftId fireProductNftId,
         string memory componentName,
         address token,
         IAuthorization authorization
@@ -25,18 +26,28 @@ contract FirePool is
         address initialOwner = msg.sender;
         _intialize(
             registry,
-            instanceNftId,
+            fireProductNftId,
             componentName,
             token,
+            IComponents.PoolInfo({
+                maxBalanceAmount: AmountLib.max(),
+                isInterceptingBundleTransfers: false,
+                isProcessingConfirmedClaims: false,
+                isExternallyManaged: false,
+                isVerifyingApplications: false,
+                collateralizationLevel: UFixedLib.one(),
+                retentionLevel: UFixedLib.one()
+            }),
             authorization,
             initialOwner);
     }
 
     function _intialize(
         address registry,
-        NftId instanceNftId,
+        NftId fireProductNftId,
         string memory componentName,
         address token,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     )
@@ -45,10 +56,11 @@ contract FirePool is
     {
         _initializeBasicPool(
             registry,
-            instanceNftId,
-            authorization,
-            token,
+            fireProductNftId,
             componentName,
+            token,
+            poolInfo,
+            authorization,
             initialOwner);
     }
 
@@ -72,4 +84,7 @@ contract FirePool is
         netStakedAmount = _stake(bundleNftId, initialAmount);
     }
 
+    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/fire/FirePoolAuthorization.sol

@@ -27,6 +27,7 @@ contract FirePoolAuthorization
         // authorize public role (open access to any account, only allows to lock target)
         functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
         // TODO: FirePool.createBundle must require a custom role (e.g. INVESTOR) instead of PUBLIC_ROLE
+        _authorize(functions, FirePool.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, FirePool.createBundle.selector, "createBundle");
     }
 

package/contracts/examples/fire/FireProduct.sol

@@ -1,14 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {ACTIVE, PAUSED} from "../../type/StateId.sol";
 import {Amount, AmountLib} from "../../type/Amount.sol";
 import {BasicProduct} from "../../product/BasicProduct.sol";
 import {ClaimId} from "../../type/ClaimId.sol";
 import {DamageLevel, DAMAGE_SMALL, DAMAGE_MEDIUM, DAMAGE_LARGE} from "./DamageLevel.sol";
+import {FeeLib} from "../../type/Fee.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
 import {IPolicy} from "../../instance/module/IPolicy.sol";
-import {NftId} from "../../type/NftId.sol";
+import {NftId, NftIdLib} from "../../type/NftId.sol";
 import {PayoutId} from "../../type/PayoutId.sol";
 import {POLICY, BUNDLE} from "../../type/ObjectType.sol";
 import {ReferralLib} from "../../type/Referral.sol";
@@ -65,7 +69,6 @@ contract FireProduct is
         NftId instanceNftid,
         string memory componentName,
         address token,
-        address pool,
         IAuthorization authorization
     )
     {
@@ -76,17 +79,15 @@ contract FireProduct is
             instanceNftid,
             componentName,
             token,
-            pool,
             authorization,
             initialOwner);
     }
 
     function _initialize(
         address registry,
-        NftId instanceNftid,
+        NftId instanceNftId,
         string memory componentName,
         address token,
-        address pool,
         IAuthorization authorization,
         address initialOwner
     )
@@ -95,14 +96,28 @@ contract FireProduct is
     {
         _initializeBasicProduct(
             registry,
-            instanceNftid,
-            authorization,
-            initialOwner,
+            instanceNftId,
             componentName,
             token,
-            false, // is interceptor
-            false, // has distribution
-            0);  // number of oracles
+            IComponents.ProductInfo({
+                isProcessingFundedClaims: false,
+                isInterceptingPolicyTransfers: false,
+                hasDistribution: false,
+                expectedNumberOfOracles: 0,
+                numberOfOracles: 0,
+                poolNftId: NftIdLib.zero(),
+                distributionNftId: NftIdLib.zero(),
+                oracleNftId: new NftId[](0),
+                productFee: FeeLib.zero(),
+                processingFee: FeeLib.zero(),
+                distributionFee: FeeLib.zero(),
+                minDistributionOwnerFee: FeeLib.zero(),
+                poolFee: FeeLib.zero(),
+                stakingFee: FeeLib.zero(),
+                performanceFee: FeeLib.zero()
+            }),
+            authorization,
+            initialOwner);  // number of oracles
     }
     
     function cities() public view returns (uint256) {
@@ -415,4 +430,7 @@ contract FireProduct is
         }
     }
 
+    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/fire/FireProductAuthorization.sol

@@ -25,6 +25,7 @@ contract FireProductAuthorization
         // authorize public role (open access to any account, only allows to lock target)
         functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
         // fully public functions
+        _authorize(functions, FireProduct.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, FireProduct.createApplication.selector, "createApplication");
         
         // only owner

package/contracts/examples/unpermissioned/SimpleDistribution.sol

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {Amount} from "../../type/Amount.sol";
 import {BasicDistribution} from "../../distribution/BasicDistribution.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
 import {NftId} from "../../type/NftId.sol";
@@ -47,4 +50,8 @@ contract SimpleDistribution is
             name,
             token);
     }
+
+    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/SimpleDistributionAuthorization.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {BasicDistributionAuthorization} from "../../distribution/BasicDistributionAuthorization.sol";
+import {IAccess} from "../../authorization/IAccess.sol";
+import {PUBLIC_ROLE} from "../../type/RoleId.sol";
+import {SimpleDistribution} from "./SimpleDistribution.sol";
+
+contract SimpleDistributionAuthorization
+    is BasicDistributionAuthorization
+{
+    constructor(string memory componentName)
+        BasicDistributionAuthorization(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(getTargetName(), PUBLIC_ROLE());
+        _authorize(functions, SimpleDistribution.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, SimpleDistribution.setWallet.selector, "setWallet");
+    }
+}

package/contracts/examples/unpermissioned/SimplePool.sol

@@ -1,11 +1,14 @@
 // 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";
@@ -18,6 +21,7 @@ contract SimplePool is
         address registry,
         NftId productNftId,
         address token,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     ) 
@@ -26,15 +30,18 @@ contract SimplePool is
             registry,
             productNftId,
             token,
+            poolInfo,
             authorization,
             initialOwner
         );
     }
 
+
     function initialize(
         address registry,
         NftId productNftId,
         address token,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     )
@@ -45,12 +52,14 @@ contract SimplePool is
         _initializeBasicPool(
             registry,
             productNftId,
-            authorization,
-            token,
             "SimplePool",
+            token,
+            poolInfo,
+            authorization,
             initialOwner);
     }
 
+
     function createBundle(
         Fee memory fee,
         uint256 initialAmount,
@@ -73,4 +82,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(getTargetName(), PUBLIC_ROLE());
+        _authorize(functions, SimplePool.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, SimplePool.setWallet.selector, "setWallet");
+    }
+}