@superfluid-finance/ethereum-contracts 1.3.2-dev.bf84335.0 → 1.3.2-dev.de7575d.0

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        37106
+        37098
       ]
     },
-    "id": 37107,
+    "id": 37099,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 37084,
+        "id": 37076,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 37085,
+          "id": 37077,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:97",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 37106,
+        "id": 37098,
         "linearizedBaseContracts": [
-          37106
+          37098
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:97",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 37086,
+              "id": 37078,
               "nodeType": "StructuredDocumentation",
               "src": "162:288:97",
               "text": " @dev Implementation slot constant.\n Using https://eips.ethereum.org/EIPS/eip-1967 standard\n Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc\n (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1))."
             },
-            "id": 37089,
+            "id": 37081,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:97",
             "nodeType": "VariableDeclaration",
-            "scope": 37106,
+            "scope": 37098,
             "src": "455:115:97",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 37087,
+              "id": 37079,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:97",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 37088,
+              "id": 37080,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 37096,
+              "id": 37088,
               "nodeType": "Block",
               "src": "681:107:97",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37089,
+                      "declaration": 37081,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37093,
+                      "declaration": 37085,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37095,
+                  "id": 37087,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:97"
                 }
               ]
             },
             "documentation": {
-              "id": 37090,
+              "id": 37082,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:97",
               "text": "@dev Get implementation address."
             },
-            "id": 37097,
+            "id": 37089,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37091,
+              "id": 37083,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:97"
             },
             "returnParameters": {
-              "id": 37094,
+              "id": 37086,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37093,
+                  "id": 37085,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37097,
+                  "scope": 37089,
                   "src": "667:12:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37092,
+                    "id": 37084,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:97",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:97"
             },
-            "scope": 37106,
+            "scope": 37098,
             "src": "618:170:97",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 37104,
+              "id": 37096,
               "nodeType": "Block",
               "src": "896:171:97",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37089,
+                      "declaration": 37081,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37100,
+                      "declaration": 37092,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37103,
+                  "id": 37095,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:97"
                 }
               ]
             },
             "documentation": {
-              "id": 37098,
+              "id": 37090,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:97",
               "text": "@dev Set new implementation address."
             },
-            "id": 37105,
+            "id": 37097,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37101,
+              "id": 37093,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37100,
+                  "id": 37092,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37105,
+                  "scope": 37097,
                   "src": "866:19:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37099,
+                    "id": 37091,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:97",
@@ -335,19 +335,19 @@
               "src": "865:21:97"
             },
             "returnParameters": {
-              "id": 37102,
+              "id": 37094,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:97"
             },
-            "scope": 37106,
+            "scope": 37098,
             "src": "839:228:97",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 37107,
+        "scope": 37099,
         "src": "137:933:97",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.8",
-  "updatedAt": "2022-08-11T12:58:52.103Z",
+  "updatedAt": "2022-08-25T14:16:53.519Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -1,11 +1,11 @@
-Superfluid.sol : 22388 (2188)
+SuperTokenFactory.sol : 5370 (19206)
 FullUpgradableSuperTokenProxy.sol : 606 (23970)
+Superfluid.sol : 22285 (2291)
+SuperToken.sol : 19203 (5373)
 SuperfluidToken.sol : 2 (24574)
-SuperToken.sol : 19204 (5372)
-SuperTokenFactory.sol : 5370 (19206)
+InstantDistributionAgreementV1.sol : 21835 (2741)
 AgreementLibrary.sol : 143 (24433)
-ConstantFlowAgreementV1.sol : 21683 (2893)
+ConstantFlowAgreementV1.sol : 21805 (2771)
 AgreementBase.sol : 2 (24574)
-InstantDistributionAgreementV1.sol : 21844 (2732)
-SuperfluidGovernanceBase.sol : 2 (24574)
 SuperfluidGovernanceII.sol : 7347 (17229)
+SuperfluidGovernanceBase.sol : 2 (24574)

package/contracts/agreements/AgreementLibrary.sol

@@ -53,8 +53,8 @@ library AgreementLibrary {
         address account;
         bytes32 agreementId;
         bytes agreementData;
-        uint256 appAllowanceGranted;
-        int256 appAllowanceUsed;
+        uint256 appCreditGranted;
+        int256 appCreditUsed;
         uint256 noopBit;
     }
 
@@ -140,17 +140,41 @@ library AgreementLibrary {
 
                 appContext = ISuperfluid(msg.sender).decodeCtx(newCtx);
 
-                // adjust allowance used to the range [appAllowanceWanted..appAllowanceGranted]
-                appContext.appAllowanceUsed = max(0, min(
-                    inputs.appAllowanceGranted.toInt256(),
-                    max(appContext.appAllowanceWanted.toInt256(), appContext.appAllowanceUsed)));
-
+                // adjust credit used to the range [appCreditUsed..appCreditGranted]
+                appContext.appCreditUsed = _adjustNewAppCreditUsed(
+                    inputs.appCreditGranted,
+                    appContext.appCreditUsed
+                );
             }
             // [SECURITY] NOTE: ctx should be const, do not modify it ever to ensure callback stack correctness
-            newCtx = _popCallbackStack(ctx, appContext.appAllowanceUsed);
+            newCtx = _popCallbackStack(ctx, appContext.appCreditUsed);
         }
     }
 
+    /**
+     * @dev Determines how much app credit the app will use.
+     * @param appCreditGranted set prior to callback based on input flow
+     * @param appCallbackDepositDelta set in callback - sum of deposit deltas of callback agreements and
+     * current flow owed deposit amount
+     */
+    function _adjustNewAppCreditUsed(
+        uint256 appCreditGranted,
+        int256 appCallbackDepositDelta
+    ) internal pure returns (int256) {
+        // NOTE: we use max(0, ...) because appCallbackDepositDelta can be negative and appCallbackDepositDelta
+        // should never go below 0, otherwise the SuperApp can return more money than borrowed
+        return max(
+            0,
+            
+            // NOTE: we use min(appCreditGranted, appCallbackDepositDelta) to ensure that the SuperApp borrows
+            // appCreditGranted at most and appCallbackDepositDelta at least (if smaller than appCreditGranted)
+            min(
+                appCreditGranted.toInt256(),
+                appCallbackDepositDelta
+            )
+        );
+    }
+
     function _selectorFromNoopBit(uint256 noopBit)
         private pure
         returns (bytes4 selector)
@@ -177,25 +201,25 @@ library AgreementLibrary {
         private
         returns (bytes memory appCtx)
     {
-        // app allowance params stack PUSH
-        // pass app allowance and current allowance used to the app,
+        // app credit params stack PUSH
+        // pass app credit and current credit used to the app,
         appCtx = ISuperfluid(msg.sender).appCallbackPush(
             ctx,
             ISuperApp(inputs.account),
-            inputs.appAllowanceGranted,
-            inputs.appAllowanceUsed,
+            inputs.appCreditGranted,
+            inputs.appCreditUsed,
             inputs.token);
     }
 
     function _popCallbackStack(
         bytes memory ctx,
-        int256 appAllowanceUsedDelta
+        int256 appCreditUsedDelta
     )
         private
         returns (bytes memory newCtx)
     {
-        // app allowance params stack POP
-        return ISuperfluid(msg.sender).appCallbackPop(ctx, appAllowanceUsedDelta);
+        // app credit params stack POP
+        return ISuperfluid(msg.sender).appCallbackPop(ctx, appCreditUsedDelta);
     }
 
     /**************************************************************************

package/contracts/agreements/ConstantFlowAgreementV1.sol

@@ -19,7 +19,6 @@ import { AgreementBase } from "./AgreementBase.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 import { AgreementLibrary } from "./AgreementLibrary.sol";
 
-
 /**
  * @title ConstantFlowAgreementV1 contract
  * @author Superfluid
@@ -898,15 +897,14 @@ contract ConstantFlowAgreementV1 is
         FlowData memory newFlowData;
         (depositDelta,,newFlowData) = _changeFlow(
             currentContext.timestamp,
-            currentContext.appAllowanceToken,
+            currentContext.appCreditToken,
             token, flowParams, oldFlowData);
 
-        // STEP 2: update app allowance used
-        if (currentContext.appAllowanceToken == token) {
-            newCtx = ISuperfluid(msg.sender).ctxUseAllowance(
+        // STEP 2: update app credit used
+        if (currentContext.appCreditToken == token) {
+            newCtx = ISuperfluid(msg.sender).ctxUseCredit(
                 ctx,
-                newFlowData.deposit, // allowanceWantedMore
-                depositDelta // allowanceUsedDelta
+                depositDelta
             );
         } else {
             newCtx = ctx;
@@ -959,14 +957,34 @@ contract ConstantFlowAgreementV1 is
             }
             vars.cbdata = AgreementLibrary.callAppBeforeCallback(cbStates, ctx);
 
-            (,cbStates.appAllowanceGranted,) = _changeFlow(
+            ISuperfluidGovernance gov = ISuperfluidGovernance(ISuperfluid(msg.sender).getGovernance());
+
+            (,cbStates.appCreditGranted,) = _changeFlow(
                     currentContext.timestamp,
-                    currentContext.appAllowanceToken,
+                    currentContext.appCreditToken,
                     token, flowParams, oldFlowData);
-            cbStates.appAllowanceGranted = cbStates.appAllowanceGranted * uint256(currentContext.appCallbackLevel + 1);
-            cbStates.appAllowanceUsed = oldFlowData.owedDeposit.toInt256();
+
+
+            // Rule CFA-2
+            // https://github.com/superfluid-finance/protocol-monorepo/wiki/About-App-Credit
+            // Allow apps to take an additional amount of app credit (minimum deposit)
+            uint256 minimumDeposit = gov.getConfigAsUint256(
+                ISuperfluid(msg.sender), token, SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
+
+            // NOTE: we do not provide additionalAppCreditAmount when cbStates.appCreditGranted is 0
+            // (closing streams)
+            uint256 additionalAppCreditAmount = cbStates.appCreditGranted == 0
+                ? 0
+                : AgreementLibrary.max(
+                    DEFAULT_MINIMUM_DEPOSIT,
+                    minimumDeposit
+                );
+            cbStates.appCreditGranted = cbStates.appCreditGranted + additionalAppCreditAmount;
+
+            cbStates.appCreditUsed = oldFlowData.owedDeposit.toInt256();
+
             // - each app level can at least "relay" the same amount of input flow rate to others
-            // - each app level get a same amount of allowance
+            // - each app level gets the same amount of credit
 
             if (optype == FlowChangeType.CREATE_FLOW) {
                 cbStates.noopBit = SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP;
@@ -983,38 +1001,31 @@ contract ConstantFlowAgreementV1 is
         } else {
             (,,vars.newFlowData) = _changeFlow(
                     currentContext.timestamp,
-                    currentContext.appAllowanceToken,
+                    currentContext.appCreditToken,
                     token, flowParams, oldFlowData);
         }
 
         // REVIEW the re-entrace assumptions from this point on
 
-        // NOTE: vars.appContext.appAllowanceUsed will be adjusted by callAppAfterCallback
-        // and its range will be [0, currentContext.appAllowance]
+        // NOTE: vars.appContext.appCreditUsed will be adjusted by callAppAfterCallback
+        // and its range will be [0, currentContext.appCreditGranted]
         {
-            // clipping the allowance used amount before storing
-            if (vars.appContext.appAllowanceUsed > 0) {
-                // give more to the app
-                vars.appContext.appAllowanceUsed =
-                    _clipDepositNumber(vars.appContext.appAllowanceUsed.toUint256()).toInt256();
-            }
-
-            int256 appAllowanceDelta = vars.appContext.appAllowanceUsed
+            int256 appCreditDelta = vars.appContext.appCreditUsed
                 - oldFlowData.owedDeposit.toInt256();
 
-            // update flow data and account state with the allowance delta
+            // update flow data and account state with the credit delta
             {
                 vars.newFlowData.deposit = (vars.newFlowData.deposit.toInt256()
-                    + appAllowanceDelta).toUint256();
+                    + appCreditDelta).toUint256();
                 vars.newFlowData.owedDeposit = (vars.newFlowData.owedDeposit.toInt256()
-                    + appAllowanceDelta).toUint256();
+                    + appCreditDelta).toUint256();
                 token.updateAgreementData(flowParams.flowId, _encodeFlowData(vars.newFlowData));
                 // update sender and receiver deposit (for sender) and owed deposit (for receiver)
                 _updateAccountFlowState(
                     token,
                     flowParams.sender,
                     0, // flow rate delta
-                    appAllowanceDelta, // deposit delta
+                    appCreditDelta, // deposit delta
                     0, // owed deposit delta
                     currentContext.timestamp
                 );
@@ -1023,22 +1034,21 @@ contract ConstantFlowAgreementV1 is
                     flowParams.receiver,
                     0, // flow rate delta
                     0, // deposit delta
-                    appAllowanceDelta, // owed deposit delta
+                    appCreditDelta, // owed deposit delta
                     currentContext.timestamp
                 );
             }
 
-            if (address(currentContext.appAllowanceToken) == address(0) ||
-                currentContext.appAllowanceToken == token)
+            if (address(currentContext.appCreditToken) == address(0) ||
+                currentContext.appCreditToken == token)
             {
-                newCtx = ISuperfluid(msg.sender).ctxUseAllowance(
+                newCtx = ISuperfluid(msg.sender).ctxUseCredit(
                     newCtx,
-                    vars.newFlowData.deposit, // allowanceWantedMore
-                    appAllowanceDelta // allowanceUsedDelta
+                    appCreditDelta
                 );
             }
 
-            // if receiver super app doesn't have enough available balance to give back app allowance
+            // if receiver super app doesn't have enough available balance to give back app credit
             // revert (non termination callbacks),
             // or take it from the sender and jail the app
             if (ISuperfluid(msg.sender).isApp(ISuperApp(flowParams.receiver))) {
@@ -1055,8 +1065,10 @@ contract ConstantFlowAgreementV1 is
                         int256 userDamageAmount = AgreementLibrary.min(
                             // user will take the damage if the app is broke,
                             -availableBalance,
-                            // but user's damage is limited to the amount of app allowance it gives to the app
-                            AgreementLibrary.max(0, -appAllowanceDelta));
+                            // but user's damage is limited to the amount of app credit it gives to the app
+                            // appCreditDelta should ALWAYS be negative because we are closing an agreement
+                            // therefore the value will be positive due to the '-' sign in front of it
+                            -appCreditDelta);
                         token.settleBalance(
                             flowParams.sender,
                             -userDamageAmount
@@ -1085,11 +1097,11 @@ contract ConstantFlowAgreementV1 is
      *
      * NOTE:
      * - leaving owed deposit unchanged for later adjustment
-     * - depositDelta output is always clipped (see _clipDepositNumber)
+     * - depositDelta output is always clipped (see _clipDepositNumberRoundingUp)
      */
     function _changeFlow(
         uint256 currentTimestamp,
-        ISuperfluidToken appAllowanceToken,
+        ISuperfluidToken appCreditToken,
         ISuperfluidToken token,
         FlowParams memory flowParams,
         FlowData memory oldFlowData
@@ -1097,7 +1109,7 @@ contract ConstantFlowAgreementV1 is
         private
         returns (
             int256 depositDelta,
-            uint256 appAllowanceBase,
+            uint256 appCreditBase,
             FlowData memory newFlowData
         )
     {
@@ -1110,25 +1122,25 @@ contract ConstantFlowAgreementV1 is
                 ISuperfluidGovernance gov = ISuperfluidGovernance(ISuperfluid(msg.sender).getGovernance());
                 minimumDeposit = gov.getConfigAsUint256(
                     ISuperfluid(msg.sender), token, SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
-                // rounding up the number for app allowance too
+                // rounding up the number for app credit too
                 // CAVEAT:
                 // - Now app could create a flow rate that is slightly higher than the incoming flow rate.
                 // - The app may be jailed due to negative balance if it does this without its own balance.
                 // Rule of thumbs:
-                // - App can use app allowance to create a flow that has the same incoming flow rate
+                // - App can use app credit to create a flow that has the same incoming flow rate
                 // - But due to deposit clipping, there is no guarantee that the sum of the out going flow
-                //   deposit can be covered by the allowance always.
-                // - It is advisable for the app to check the allowance usages carefully, and if possible
+                //   deposit can be covered by the credit always.
+                // - It is advisable for the app to check the credit usages carefully, and if possible
                 //   Always have some its own balances to cover the deposits.
 
                 // preliminary calc of new deposit required, may be changed later in step 2.
                 // used as a variable holding the new deposit amount in the meantime
-                appAllowanceBase = _calculateDeposit(flowParams.flowRate, liquidationPeriod);
+                appCreditBase = _calculateDeposit(flowParams.flowRate, liquidationPeriod);
             }
 
             // STEP 2: apply minimum deposit rule and calculate deposit delta
             // preliminary calc depositDelta (minimum deposit rule not yet applied)
-            depositDelta = appAllowanceBase.toInt256()
+            depositDelta = appCreditBase.toInt256()
                 - oldFlowData.deposit.toInt256()
                 + oldFlowData.owedDeposit.toInt256();
 
@@ -1143,11 +1155,11 @@ contract ConstantFlowAgreementV1 is
                 newDeposit = minimumDeposit;
             }
 
-            // allowance should be of the same token
-            if (address(appAllowanceToken) != address(0) &&
-                appAllowanceToken != token)
+            // credit should be of the same token
+            if (address(appCreditToken) != address(0) &&
+                appCreditToken != token)
             {
-                appAllowanceBase = 0;
+                appCreditBase = 0;
             }
 
             // STEP 3: update current flow info
@@ -1204,9 +1216,9 @@ contract ConstantFlowAgreementV1 is
     )
         private view
     {
-        // do not enforce balance checks during callbacks for the appAllowanceToken
+        // do not enforce balance checks during callbacks for the appCreditToken
         if (currentContext.callType != ContextDefinitions.CALL_INFO_CALL_TYPE_APP_CALLBACK ||
-            currentContext.appAllowanceToken != token) {
+            currentContext.appCreditToken != token) {
             (int256 availableBalance,,) = token.realtimeBalanceOf(currentContext.msgSender, currentContext.timestamp);
             require(availableBalance >= 0, "CFA: not enough available balance");
         }
@@ -1296,7 +1308,7 @@ contract ConstantFlowAgreementV1 is
         return ((deposit >> 32)) << 32;
     }
 
-    function _clipDepositNumber(uint256 deposit)
+    function _clipDepositNumberRoundingUp(uint256 deposit)
         internal pure
         returns(uint256)
     {
@@ -1317,7 +1329,7 @@ contract ConstantFlowAgreementV1 is
         // NOTE: safecast for int96 with extra assertion
         assert(liquidationPeriod <= uint256(int256(type(int96).max)));
         deposit = uint256(int256(flowRate * int96(uint96(liquidationPeriod))));
-        return _clipDepositNumber(deposit);
+        return _clipDepositNumberRoundingUp(deposit);
     }
 
     /**************************************************************************