@gooddollar/goodcollective-contracts 1.1.0 → 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

@@ -122,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)));
@@ -138,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))
@@ -146,6 +139,7 @@ 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));
 
@@ -174,7 +168,16 @@ contract DirectPaymentsFactory is AccessControlUpgradeable, UUPSUpgradeable {
         feeRecipient = _feeRecipient;
     }
 
-    function addMember(address account) external onlyPool {
-        memberPools[account].push(msg.sender);
+    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

@@ -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)));
     }
 
@@ -352,6 +354,13 @@ contract DirectPaymentsPool is
         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) {
@@ -391,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);
     }
@@ -400,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

@@ -14,14 +14,6 @@ import "@uniswap/swap-router-contracts/contracts/interfaces/IV3SwapRouter.sol";
 import "../DirectPayments/DirectPaymentsFactory.sol";
 import "../utils/HelperLibrary.sol";
 
-// import "hardhat/console.sol";
-
-interface IRegistry {
-    function feeRecipient() external view returns (address);
-
-    function feeBps() external view returns (uint32);
-}
-
 abstract contract GoodCollectiveSuperApp is SuperAppBaseFlow {
     int96 public constant MIN_FLOW_RATE = 386e9;
 
@@ -166,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
@@ -253,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;
@@ -266,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 {
@@ -284,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

package/contracts/UBI/UBIPool.sol

@@ -28,11 +28,12 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
 
     error CLAIMFOR_DISABLED();
     error NOT_MEMBER(address claimer);
-    error NOT_WHITELISTED(address claimer);
-    error ALREADY_CLAIMED(address claimer);
+    error NOT_MANAGER(address manager);
+    error NOT_WHITELISTED(address whitelistedRoot);
+    error ALREADY_CLAIMED(address whitelistedRoot);
     error INVALID_0_VALUE();
     error EMPTY_MANAGER();
-    error MAX_MEMBERS_REACHED();
+    error MAX_CLAIMERS_REACHED();
 
     bytes32 public constant MANAGER_ROLE = keccak256("MANAGER_ROLE");
     bytes32 public constant MEMBER_ROLE = keccak256("MEMBER_ROLE");
@@ -70,7 +71,8 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
         // can you trigger claim for someone else
         bool claimForEnabled;
         uint maxClaimAmount;
-        uint32 maxMembers;
+        uint32 maxClaimers;
+        bool onlyMembers;
     }
 
     struct PoolStatus {
@@ -88,7 +90,7 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
         uint256 periodClaimers;
         uint256 periodDistributed;
         mapping(address => uint256) lastClaimed;
-        uint32 membersCount;
+        uint32 claimersCount;
     }
 
     PoolSettings public settings;
@@ -123,8 +125,9 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
         registry = _registry;
         settings = _settings;
         ubiSettings = _ubiSettings;
+        _verifyPoolSettings(_settings);
         _verifyUBISettings(_ubiSettings);
-        _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
+        _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);
         setSuperToken(ISuperToken(address(settings.rewardToken)));
     }
@@ -148,14 +151,15 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
     function distributionFormula() internal returns (uint256) {
         // once every claim cycle
         uint256 currentDay = getCurrentDay();
-        if (currentDay > status.currentDay + ubiSettings.claimPeriodDays) {
+        if (currentDay >= status.currentDay + ubiSettings.claimPeriodDays) {
             status.currentDay = currentDay;
             uint32 cycleLength = ubiSettings.cycleLengthDays;
             uint256 currentBalance = settings.rewardToken.balanceOf(address(this));
             //start early cycle if daily pool size is +%5 previous pool or not enough until end of cycle
             uint256 nextDailyPool = currentBalance / cycleLength;
             bool shouldStartEarlyCycle = nextDailyPool > (status.dailyCyclePool * 105) / 100 ||
-                currentBalance < (status.dailyCyclePool * (cycleLength - currentDayInCycle()));
+                (currentDayInCycle() <= cycleLength &&
+                    currentBalance < (status.dailyCyclePool * (cycleLength - currentDayInCycle())));
 
             if (
                 currentDayInCycle() >= status.currentCycleLength || shouldStartEarlyCycle
@@ -225,7 +229,12 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
     function _claim(address claimer, bool sendToWhitelistedRoot) internal {
         address whitelistedRoot = IIdentityV2(settings.uniquenessValidator).getWhitelistedRoot(claimer);
         if (whitelistedRoot == address(0)) revert NOT_WHITELISTED(claimer);
-        if (address(settings.membersValidator) != address(0) && hasRole(MEMBER_ROLE, claimer) == false)
+
+        // if open for anyone but has limits, we add the first claimers as members to handle the max claimers
+        if ((ubiSettings.maxClaimers > 0 && ubiSettings.onlyMembers == false)) _grantRole(MEMBER_ROLE, claimer);
+
+        // check membership if has claimers limits or limited to members only
+        if ((ubiSettings.maxClaimers > 0 || ubiSettings.onlyMembers) && hasRole(MEMBER_ROLE, claimer) == false)
             revert NOT_MEMBER(claimer);
 
         // calculats the formula up today ie on day 0 there are no active users, on day 1 any user
@@ -246,18 +255,6 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
         emit UBIClaimed(whitelistedRoot, claimer, dailyUbi);
     }
 
-    function addMemberByManager(address member) external onlyRole(MANAGER_ROLE) returns (bool) {
-        if (hasRole(MEMBER_ROLE, member)) return true;
-
-        if (address(settings.uniquenessValidator) != address(0)) {
-            address rootAddress = settings.uniquenessValidator.getWhitelistedRoot(member);
-            if (rootAddress == address(0)) revert NOT_WHITELISTED(member);
-        }
-
-        _grantRole(MEMBER_ROLE, member);
-        return true;
-    }
-
     /**
      * @dev Adds a member to the contract.
      * @param member The address of the member to add.
@@ -265,37 +262,43 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
      */
 
     function addMember(address member, bytes memory extraData) external returns (bool isMember) {
-        if (hasRole(MEMBER_ROLE, member)) return true;
-
         if (address(settings.uniquenessValidator) != address(0)) {
             address rootAddress = settings.uniquenessValidator.getWhitelistedRoot(member);
             if (rootAddress == address(0)) revert NOT_WHITELISTED(member);
         }
 
-        // if no members validator then anyone can join the pool
-        if (address(settings.membersValidator) != address(0)) {
+        if (address(settings.membersValidator) != address(0) && hasRole(MANAGER_ROLE, msg.sender) == false) {
             if (settings.membersValidator.isMemberValid(address(this), msg.sender, member, extraData) == false) {
-                return false;
+                revert NOT_MEMBER(member);
             }
         }
+        // if no members validator then if members only only manager can add members
+        else if (ubiSettings.onlyMembers && hasRole(MANAGER_ROLE, msg.sender) == false) {
+            revert NOT_MANAGER(member);
+        }
 
         _grantRole(MEMBER_ROLE, member);
         return true;
     }
 
+    function removeMember(address member) external onlyRole(MANAGER_ROLE) {
+        _revokeRole(MEMBER_ROLE, member);
+    }
+
     function _grantRole(bytes32 role, address account) internal virtual override {
-        if (role == MEMBER_ROLE) {
+        if (role == MEMBER_ROLE && hasRole(MEMBER_ROLE, account) == false) {
+            if (ubiSettings.maxClaimers > 0 && status.claimersCount > ubiSettings.maxClaimers)
+                revert MAX_CLAIMERS_REACHED();
             registry.addMember(account);
-            if (ubiSettings.maxMembers > 0 && status.membersCount > ubiSettings.maxMembers)
-                revert MAX_MEMBERS_REACHED();
-            status.membersCount += 1;
+            status.claimersCount += 1;
         }
         super._grantRole(role, account);
     }
 
     function _revokeRole(bytes32 role, address account) internal virtual override {
-        if (role == MEMBER_ROLE) {
-            status.membersCount -= 1;
+        if (role == MEMBER_ROLE && hasRole(MEMBER_ROLE, account)) {
+            status.claimersCount -= 1;
+            registry.removeMember(account);
         }
         super._revokeRole(role, account);
     }
@@ -324,7 +327,7 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
      * @param _settings The new pool settings.
      */
     function setPoolSettings(PoolSettings memory _settings) public onlyRole(MANAGER_ROLE) {
-        if (_settings.manager == address(0)) revert EMPTY_MANAGER();
+        _verifyPoolSettings(_settings);
 
         if (_settings.manager != settings.manager) {
             _revokeRole(MANAGER_ROLE, settings.manager);
@@ -334,12 +337,21 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
         emit PoolSettingsChanged(_settings);
     }
 
+    function _verifyPoolSettings(PoolSettings memory _poolSettings) internal pure {
+        if (
+            _poolSettings.manager == address(0) ||
+            address(_poolSettings.uniquenessValidator) == address(0) ||
+            address(_poolSettings.rewardToken) == address(0)
+        ) revert INVALID_0_VALUE();
+    }
+
     function estimateNextDailyUBI() public view returns (uint256) {
         uint256 currentBalance = settings.rewardToken.balanceOf(address(this));
         //start early cycle if we can increase the daily UBI pool
         uint256 nextDailyPool = currentBalance / ubiSettings.cycleLengthDays;
         bool shouldStartEarlyCycle = nextDailyPool > (status.dailyCyclePool * 105) / 100 ||
-            currentBalance < (status.dailyCyclePool * (status.currentCycleLength - currentDayInCycle()));
+            (currentDayInCycle() <= status.currentCycleLength &&
+                currentBalance < (status.dailyCyclePool * (status.currentCycleLength - currentDayInCycle())));
 
         uint256 _dailyCyclePool = status.dailyCyclePool;
         uint256 _dailyUbi;
@@ -379,10 +391,10 @@ contract UBIPool is AccessControlUpgradeable, GoodCollectiveSuperApp, UUPSUpgrad
 
     function hasClaimed(address _member) public view returns (bool) {
         address whitelistedRoot = IIdentityV2(settings.uniquenessValidator).getWhitelistedRoot(_member);
-        return status.lastClaimed[whitelistedRoot] == status.currentDay;
+        return status.lastClaimed[whitelistedRoot] == getCurrentDay();
     }
 
     function nextClaimTime() public view returns (uint256) {
-        return getCurrentDay() * (1 days) - (12 hours);
+        return (getCurrentDay() + ubiSettings.claimPeriodDays) * (1 days) + 12 hours;
     }
 }

package/contracts/UBI/UBIPoolFactory.sol

@@ -108,7 +108,7 @@ contract UBIPoolFactory is AccessControlUpgradeable, UUPSUpgradeable {
     ) internal returns (UBIPool pool) {
         //TODO: add check if msg.sender is whitelisted
 
-        bytes memory initCall = abi.encodeWithSelector(UBIPool.initialize.selector, _settings, _limits, address(this));
+        bytes memory initCall = abi.encodeCall(UBIPool.initialize, (_settings, _limits, this));
 
         if (useBeacon) {
             pool = UBIPool(address(new BeaconProxy(address(impl), initCall)));
@@ -153,6 +153,15 @@ contract UBIPoolFactory is AccessControlUpgradeable, UUPSUpgradeable {
         memberPools[account].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();
+            }
+        }
+    }
+
     function getMemberPools(address member) external view returns (address[] memory) {
         return memberPools[member];
     }

package/contracts/test/HelperLibraryTest.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.8.0;
+
+import "../utils/HelperLibrary.sol";
+
+contract HelperLibraryTest {
+    function handleSwap(
+        IV3SwapRouter swapRouter,
+        HelperLibrary.SwapData memory _customData,
+        address outTokenIfNoPath,
+        address _sender
+    ) external returns (uint256 amountOut) {
+        return HelperLibrary.handleSwap(swapRouter, _customData, outTokenIfNoPath, _sender, _sender);
+    }
+}

package/contracts/utils/HelperLibrary.sol

@@ -6,11 +6,13 @@ import "@uniswap/v3-periphery/contracts/libraries/TransferHelper.sol";
 import "@uniswap/swap-router-contracts/contracts/interfaces/IV3SwapRouter.sol";
 import { ISuperToken } from "@superfluid-finance/ethereum-contracts/contracts/interfaces/superfluid/ISuperfluid.sol";
 import { SuperTokenV1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/SuperTokenV1Library.sol";
+import { CFAv1Library } from "@superfluid-finance/ethereum-contracts/contracts/apps/CFAv1Library.sol";
 
 import "../GoodCollective/IGoodCollectiveSuperApp.sol";
 
 library HelperLibrary {
     using SuperTokenV1Library for ISuperToken;
+    using CFAv1Library for CFAv1Library.InitData;
 
     /**
      * @dev A struct containing information about a token swap
@@ -33,7 +35,17 @@ library HelperLibrary {
         SwapData memory _customData,
         address outTokenIfNoPath,
         address _sender
-    ) external {
+    ) external returns (uint256 amountOut) {
+        return handleSwap(swapRouter, _customData, outTokenIfNoPath, _sender, _sender);
+    }
+
+    function handleSwap(
+        IV3SwapRouter swapRouter,
+        SwapData memory _customData,
+        address outTokenIfNoPath,
+        address _sender,
+        address _recipient
+    ) public returns (uint256 amountOut) {
         // Transfer the tokens from the sender to this contract
         TransferHelper.safeTransferFrom(_customData.swapFrom, _sender, address(this), _customData.amount);
 
@@ -44,25 +56,25 @@ library HelperLibrary {
             // If a path is provided, execute a multi-hop swap
             IV3SwapRouter.ExactInputParams memory params = IV3SwapRouter.ExactInputParams({
                 path: _customData.path,
-                recipient: _sender,
+                recipient: _recipient,
                 amountIn: _customData.amount,
                 amountOutMinimum: _customData.minReturn
             });
-            swapRouter.exactInput(params);
+            return swapRouter.exactInput(params);
         } else {
             // If no path is provided, execute a single-hop swap
             IV3SwapRouter.ExactInputSingleParams memory params = IV3SwapRouter.ExactInputSingleParams({
                 tokenIn: _customData.swapFrom,
                 tokenOut: outTokenIfNoPath,
                 fee: 10000,
-                recipient: _sender,
+                recipient: _recipient,
                 amountIn: _customData.amount,
                 amountOutMinimum: _customData.minReturn,
                 sqrtPriceLimitX96: 0
             });
 
             // Execute the swap using `exactInputSingle`
-            swapRouter.exactInputSingle(params);
+            return swapRouter.exactInputSingle(params);
         }
     }
 
@@ -78,4 +90,60 @@ library HelperLibrary {
             uint96(superToken.getFlowRate(address(this), stats.lastFeeRecipient)) *
             (block.timestamp - stats.lastUpdate);
     }
+
+    // this should be called before any flow rate changes
+    function updateStats(
+        IGoodCollectiveSuperApp.Stats storage stats,
+        ISuperToken superToken,
+        IRegistry registry,
+        uint256 _amount
+    ) external {
+        //use last rate before the current possible rate update
+        stats.netIncome += uint96(stats.lastIncomeRate) * (block.timestamp - stats.lastUpdate);
+        uint feeBps;
+        if (address(registry) != address(0)) {
+            feeBps = registry.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(
+        CFAv1Library.InitData storage cfaV1,
+        IGoodCollectiveSuperApp.Stats storage stats,
+        ISuperToken superToken,
+        IRegistry registry,
+        int96 _diffRate,
+        bytes memory _ctx
+    ) public returns (bytes memory newCtx) {
+        newCtx = _ctx;
+        if (address(registry) == address(0)) return newCtx;
+        address recipient = registry.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 newFeeRate = curFeeRate + (_diffRate * int32(registry.feeBps())) / 10000;
+        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
+    }
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@gooddollar/goodcollective-contracts",
   "packageManager": "yarn@3.2.1",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "license": "MIT",
   "types": "./typechain-types/index.ts",
   "files": [
     "contracts",
+    "artifacts/contracts",
     "typechain-types",
     "releases"
   ],
@@ -63,9 +64,9 @@
     "test": "npx hardhat test",
     "test:coverage": "npx hardhat coverage",
     "deploy": "hardhat deploy --export-all ./releases/deployment.json",
-    "prepublish": "yarn version patch && yarn compile && git add package.json && git commit -m \"version bump\"",
+    "bump": "yarn version patch && yarn compile && git add package.json && git commit -m \"version bump\"",
     "publish": "yarn npm publish --access public",
     "test:setup": "yarn exec ./scripts/deployContracts.sh",
     "verify": "npx hardhat run scripts/verify.ts --network ${0}"
   }
-}
+}