@gooddollar/goodcollective-contracts 1.0.6-beta.0b8171a → 1.2.0

package/README.md

@@ -1 +1,14 @@
-# contracts
+# Contracts
+
+## Structs
+
+### Pool Settings
+
+-   `nftType`: 1, // when you update the settings with setPoolSettings, `nftType` should always match what has been set when creating the pool
+-   `uniquenessValidator`: `ethers.constants.AddressZero`,
+-   `rewardPerEvent`: `[100, 300]`,
+-   `validEvents`: `[1, 2]`, // to be defined
+-   `manager`: `<address of the owner/creator of the pool>`,
+-   `membersValidator`: `ethers.constants.AddressZero`, // used to only accept certain members (address zero for anyone can join)
+-   `rewardToken`: `'0x62B8B11039FcfE5aB0C56E502b1C372A3d2a9c7A'`, // what token will a steward/member receive. currently only supports production G$'s
+-   `allowRewardOverride`: `false`,

package/contracts/DirectPayments/DirectPaymentsFactory.sol

@@ -15,6 +15,7 @@ import "hardhat/console.sol";
 
 contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
     error NOT_PROJECT_OWNER();
+    error NOT_POOL();
 
     event PoolCreated(
         address indexed pool,
@@ -45,6 +46,9 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
     address public feeRecipient;
     uint32 public feeBps;
 
+    mapping(address => address[]) public memberPools;
+    address[] public pools;
+
     modifier onlyProjectOwnerOrNon(string memory projectId) {
         DirectPaymentsPool controlPool = projectIdToControlPool[keccak256(bytes(projectId))];
         // console.log("result %s", controlPool.hasRole(controlPool.DEFAULT_ADMIN_ROLE(), msg.sender));
@@ -56,16 +60,21 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
         _;
     }
 
-    modifier onlyProjectOwnerByPool(DirectPaymentsPool pool) {
-        string memory projectId = registry[address(pool)].projectId;
-        DirectPaymentsPool controlPool = projectIdToControlPool[keccak256(bytes(projectId))];
-        if (controlPool.hasRole(controlPool.DEFAULT_ADMIN_ROLE(), msg.sender) == false) {
+    modifier onlyPoolOwner(DirectPaymentsPool pool) {
+        if (pool.hasRole(pool.DEFAULT_ADMIN_ROLE(), msg.sender) == false) {
             revert NOT_PROJECT_OWNER();
         }
 
         _;
     }
 
+    modifier onlyPool() {
+        if (bytes(registry[msg.sender].projectId).length == 0) {
+            revert NOT_POOL();
+        }
+        _;
+    }
+
     function _authorizeUpgrade(address _impl) internal virtual override onlyRole(DEFAULT_ADMIN_ROLE) {}
 
     function initialize(
@@ -113,13 +122,7 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
         //TODO: add check if msg.sender is whitelisted
 
         _settings.nftType = nextNftType;
-        bytes memory initCall = abi.encodeWithSelector(
-            DirectPaymentsPool.initialize.selector,
-            nft,
-            _settings,
-            _limits,
-            address(this)
-        );
+        bytes memory initCall = abi.encodeCall(DirectPaymentsPool.initialize, (nft, _settings, _limits, this));
 
         if (useBeacon) {
             pool = DirectPaymentsPool(address(new BeaconProxy(address(impl), initCall)));
@@ -129,7 +132,6 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
 
         nft.grantRole(nft.getManagerRole(nextNftType), _settings.manager);
         nft.grantRole(nft.getManagerRole(nextNftType), address(pool));
-        pool.grantRole(pool.MINTER_ROLE(), _settings.manager);
 
         //access control to project is determinted by the first pool access control rules
         if (address(projectIdToControlPool[keccak256(bytes(_projectId))]) == address(0))
@@ -137,13 +139,16 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
         registry[address(pool)].ipfs = _ipfs;
         registry[address(pool)].projectId = _projectId;
 
+        pool.grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
         pool.renounceRole(DEFAULT_ADMIN_ROLE, address(this));
+        pools.push(address(pool));
+
         emit PoolCreated(address(pool), _projectId, _ipfs, nextNftType, _settings, _limits);
 
         nextNftType++;
     }
 
-    function changePoolDetails(DirectPaymentsPool _pool, string memory _ipfs) external onlyProjectOwnerByPool(_pool) {
+    function changePoolDetails(DirectPaymentsPool _pool, string memory _ipfs) external onlyPoolOwner(_pool) {
         registry[address(_pool)].ipfs = _ipfs;
         emit PoolDetailsChanged(address(_pool), _ipfs);
     }
@@ -162,4 +167,17 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
         feeBps = _feeBps;
         feeRecipient = _feeRecipient;
     }
+
+    function addMember(address member) external onlyPool {
+        memberPools[member].push(msg.sender);
+    }
+
+    function removeMember(address member) external onlyPool {
+        for (uint i = 0; i < memberPools[member].length; i++) {
+            if (memberPools[member][i] == msg.sender) {
+                memberPools[member][i] = memberPools[member][memberPools[member].length - 1];
+                memberPools[member].pop();
+            }
+        }
+    }
 }

package/contracts/DirectPayments/DirectPaymentsPool.sol

@@ -21,7 +21,7 @@ interface IMembersValidator {
 }
 
 interface IIdentityV2 {
-    function getWhitelistedRoot(address member) external returns (address);
+    function getWhitelistedRoot(address member) external view returns (address);
 }
 
 /**
@@ -112,7 +112,7 @@ contract DirectPaymentsPool is
     DirectPaymentsFactory public registry;
 
     /// @custom:oz-upgrades-unsafe-allow constructor
-    constructor(ISuperfluid _host, ISwapRouter _swapRouter) GoodCollectiveSuperApp(_host, _swapRouter) {}
+    constructor(ISuperfluid _host, IV3SwapRouter _swapRouter) GoodCollectiveSuperApp(_host, _swapRouter) {}
 
     /**
      * @dev Authorizes an upgrade for the implementation contract.
@@ -120,8 +120,8 @@ contract DirectPaymentsPool is
      */
     function _authorizeUpgrade(address impl) internal virtual override onlyRole(DEFAULT_ADMIN_ROLE) {}
 
-    function getRegistry() public view override returns (DirectPaymentsFactory) {
-        return DirectPaymentsFactory(registry);
+    function getRegistry() public view override returns (IRegistry) {
+        return IRegistry(address(registry));
     }
 
     /**
@@ -140,8 +140,10 @@ contract DirectPaymentsPool is
         settings = _settings;
         limits = _limits;
         nft = _nft;
-        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
-        _setupRole(DEFAULT_ADMIN_ROLE, _settings.manager);
+        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender); // when using factory this gives factory role which then set role to the real msg.sender
+        _setupRole(MANAGER_ROLE, _settings.manager);
+        _setupRole(MINTER_ROLE, _settings.manager);
+
         setSuperToken(ISuperToken(address(settings.rewardToken)));
     }
 
@@ -341,10 +343,24 @@ contract DirectPaymentsPool is
             }
         }
 
-        _setupRole(MEMBER_ROLE, member);
+        _grantRole(MEMBER_ROLE, member);
         return true;
     }
 
+    function _grantRole(bytes32 role, address account) internal virtual override {
+        if (role == MEMBER_ROLE) {
+            registry.addMember(account);
+        }
+        super._grantRole(role, account);
+    }
+
+    function _revokeRole(bytes32 role, address account) internal virtual override {
+        if (role == MEMBER_ROLE) {
+            registry.removeMember(account);
+        }
+        super._revokeRole(role, account);
+    }
+
     function mintNFT(address _to, ProvableNFT.NFTData memory _nftData, bool withClaim) external onlyRole(MINTER_ROLE) {
         uint nftId = nft.mintPermissioned(_to, _nftData, true, "");
         if (withClaim) {
@@ -384,7 +400,7 @@ contract DirectPaymentsPool is
      * @dev Sets the safety limits for the pool.
      * @param _limits The new safety limits.
      */
-    function setPoolLimits(SafetyLimits memory _limits) public onlyRole(DEFAULT_ADMIN_ROLE) {
+    function setPoolLimits(SafetyLimits memory _limits) public onlyRole(MANAGER_ROLE) {
         limits = _limits;
         emit PoolLimitsChanged(_limits);
     }
@@ -393,7 +409,7 @@ contract DirectPaymentsPool is
      * @dev Sets the settings for the pool.
      * @param _settings The new pool settings.
      */
-    function setPoolSettings(PoolSettings memory _settings) public onlyRole(DEFAULT_ADMIN_ROLE) {
+    function setPoolSettings(PoolSettings memory _settings) public onlyRole(MANAGER_ROLE) {
         if (_settings.nftType != settings.nftType) revert NFTTYPE_CHANGED();
         if (_settings.manager == address(0)) revert EMPTY_MANAGER();
 

package/contracts/GoodCollective/GoodCollectiveSuperApp.sol

@@ -9,13 +9,11 @@ import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/cont
 import { CFAv1Library, IConstantFlowAgreementV1 } from "@superfluid-finance/ethereum-contracts/contracts/apps/CFAv1Library.sol";
 
 import "@uniswap/v3-periphery/contracts/libraries/TransferHelper.sol";
-import "@uniswap/v3-periphery/contracts/interfaces/ISwapRouter.sol";
+import "@uniswap/swap-router-contracts/contracts/interfaces/IV3SwapRouter.sol";
 
 import "../DirectPayments/DirectPaymentsFactory.sol";
 import "../utils/HelperLibrary.sol";
 
-// import "hardhat/console.sol";
-
 abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
     int96 public constant MIN_FLOW_RATE = 386e9;
 
@@ -51,7 +49,7 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
     // ask about "receiver" can it be different then app?
 
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
-    ISwapRouter public immutable swapRouter;
+    IV3SwapRouter public immutable swapRouter;
 
     struct SupporterData {
         uint256 contribution;
@@ -71,12 +69,12 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
     uint256[48] private _reserved;
 
     /// @custom:oz-upgrades-unsafe-allow constructor
-    constructor(ISuperfluid _host, ISwapRouter _swapRouter) SuperAppBaseFlow(_host) {
+    constructor(ISuperfluid _host, IV3SwapRouter _swapRouter) SuperAppBaseFlow(_host) {
         if (address(_host) == address(0)) revert ZERO_ADDRESS();
         swapRouter = _swapRouter;
     }
 
-    function getRegistry() public view virtual returns (DirectPaymentsFactory);
+    function getRegistry() public view virtual returns (IRegistry);
 
     /**
      * @dev Sets the address of the super token and registers the app with the host
@@ -160,6 +158,28 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
         return _ctx;
     }
 
+    /**
+     * @dev allow single contribution. user needs to approve tokens first. can be used in superfluid batch actions.
+     * @param _sender The address of the sender who is contributing tokens.
+     * @param _customData The SwapData struct containing information about the swap
+     * @param _ctx The context of the transaction for superfluid in case this was used in superfluid batch. otherwise can be empty.
+     * @return Returns the context of the transaction.
+     */
+    function supportWithSwap(
+        address _sender,
+        HelperLibrary.SwapData memory _customData,
+        bytes memory _ctx
+    ) external onlyHostOrSender(_sender) returns (bytes memory) {
+        uint256 balance = superToken.balanceOf(address(this));
+        HelperLibrary.handleSwap(swapRouter, _customData, address(superToken), _sender, address(this));
+        uint256 amountReceived = superToken.balanceOf(address(this)) - balance;
+        if (amountReceived == 0) revert ZERO_AMOUNT();
+
+        // Update the contribution amount for the sender in the supporters mapping
+        _updateSupporter(_sender, int256(amountReceived), 0, ""); //we pass empty ctx since this is not a flow but a single donation
+        return _ctx;
+    }
+
     /**
      * @dev Handles the swap of tokens using the SwapData struct
      * @param _customData The SwapData struct containing information about the swap
@@ -247,7 +267,7 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
     ) internal returns (bytes memory newCtx) {
         newCtx = _ctx;
         bool _isFlow = _ctx.length > 0;
-        _updateStats(_isFlow ? 0 : uint256(_previousFlowRateOrAmount));
+        HelperLibrary.updateStats(stats, superToken, getRegistry(), _isFlow ? 0 : uint256(_previousFlowRateOrAmount));
         // Get the current flow rate for the supporter
         int96 flowRate = superToken.getFlowRate(_supporter, address(this));
         uint256 prevContribution = supporters[_supporter].contribution;
@@ -260,7 +280,14 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
             supporters[_supporter].contribution +=
                 uint96(int96(_previousFlowRateOrAmount)) *
                 (block.timestamp - _lastUpdated);
-            newCtx = _takeFeeFlow(flowRate - int96(_previousFlowRateOrAmount), _ctx);
+            newCtx = HelperLibrary.takeFeeFlow(
+                cfaV1,
+                stats,
+                superToken,
+                getRegistry(),
+                flowRate - int96(_previousFlowRateOrAmount),
+                _ctx
+            );
             // we update the last rate after we do all changes to our own flows
             stats.lastIncomeRate = superToken.getNetFlowRate(address(this));
         } else {
@@ -278,51 +305,6 @@ abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
         );
     }
 
-    // this should be called before any flow rate changes
-    function _updateStats(uint256 _amount) internal {
-        //use last rate before the current possible rate update
-        stats.netIncome += uint96(stats.lastIncomeRate) * (block.timestamp - stats.lastUpdate);
-        uint feeBps;
-        if (address(getRegistry()) != address(0)) {
-            feeBps = getRegistry().feeBps();
-            //fees sent to last recipient, the flowRate to recipient still wasnt updated.
-            stats.totalFees +=
-                uint96(superToken.getFlowRate(address(this), stats.lastFeeRecipient)) *
-                (block.timestamp - stats.lastUpdate);
-        }
-        if (_amount > 0) {
-            stats.netIncome += (_amount * (10000 - feeBps)) / 10000;
-            stats.totalFees += (_amount * feeBps) / 10000;
-        }
-        stats.lastUpdate = block.timestamp;
-    }
-
-    function _takeFeeFlow(int96 _diffRate, bytes memory _ctx) internal returns (bytes memory newCtx) {
-        newCtx = _ctx;
-        if (address(getRegistry()) == address(0)) return newCtx;
-        address recipient = getRegistry().feeRecipient();
-        int96 curFeeRate = superToken.getFlowRate(address(this), stats.lastFeeRecipient);
-        bool newRecipient;
-        if (recipient != stats.lastFeeRecipient) {
-            newRecipient = true;
-            if (stats.lastFeeRecipient != address(0)) {
-                //delete old recipient flow
-                if (curFeeRate > 0)
-                    newCtx = cfaV1.deleteFlowWithCtx(newCtx, address(this), stats.lastFeeRecipient, superToken); //passing in the ctx which is sent to the callback here
-            }
-            stats.lastFeeRecipient = recipient;
-        }
-        if (recipient == address(0)) return newCtx;
-
-        int96 feeRateChange = (_diffRate * int32(getRegistry().feeBps())) / 10000;
-        int96 newFeeRate = curFeeRate + feeRateChange;
-        if (newFeeRate <= 0 && newRecipient == false) {
-            newCtx = cfaV1.deleteFlowWithCtx(newCtx, address(this), recipient, superToken); //passing in the ctx which is sent to the callback here
-        } else if (curFeeRate > 0 && newRecipient == false) {
-            newCtx = cfaV1.updateFlowWithCtx(newCtx, recipient, superToken, newFeeRate); //passing in the ctx which is sent to the callback here
-        } else if (newFeeRate > 0) newCtx = cfaV1.createFlowWithCtx(newCtx, recipient, superToken, newFeeRate); //passing in the ctx which is sent to the callback here
-    }
-
     function _takeFeeSingle(uint256 _amount) internal {
         if (address(getRegistry()) == address(0)) return;
         address recipient = getRegistry().feeRecipient();

package/contracts/GoodCollective/IGoodCollectiveSuperApp.sol

@@ -1,6 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.0;
 
+interface IRegistry {
+    function feeRecipient() external view returns (address);
+
+    function feeBps() external view returns (uint32);
+}
+
 interface IGoodCollectiveSuperApp {
     struct Stats {
         uint256 netIncome; //without fees