@superfluid-finance/ethereum-contracts 1.2.2-dev.6a8632e.0 → 1.2.2-dev.a4c583c.0

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        36349
+        36434
       ]
     },
-    "id": 36350,
+    "id": 36435,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 36327,
+        "id": 36412,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 36328,
+          "id": 36413,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:100",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 36349,
+        "id": 36434,
         "linearizedBaseContracts": [
-          36349
+          36434
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:100",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 36329,
+              "id": 36414,
               "nodeType": "StructuredDocumentation",
               "src": "162:288:100",
               "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": 36332,
+            "id": 36417,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:100",
             "nodeType": "VariableDeclaration",
-            "scope": 36349,
+            "scope": 36434,
             "src": "455:115:100",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 36330,
+              "id": 36415,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:100",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 36331,
+              "id": 36416,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 36339,
+              "id": 36424,
               "nodeType": "Block",
               "src": "681:107:100",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 36332,
+                      "declaration": 36417,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:100",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 36336,
+                      "declaration": 36421,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:100",
                       "valueSize": 1
                     }
                   ],
-                  "id": 36338,
+                  "id": 36423,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:100"
                 }
               ]
             },
             "documentation": {
-              "id": 36333,
+              "id": 36418,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:100",
               "text": "@dev Get implementation address."
             },
-            "id": 36340,
+            "id": 36425,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:100",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 36334,
+              "id": 36419,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:100"
             },
             "returnParameters": {
-              "id": 36337,
+              "id": 36422,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 36336,
+                  "id": 36421,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:100",
                   "nodeType": "VariableDeclaration",
-                  "scope": 36340,
+                  "scope": 36425,
                   "src": "667:12:100",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 36335,
+                    "id": 36420,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:100",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:100"
             },
-            "scope": 36349,
+            "scope": 36434,
             "src": "618:170:100",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 36347,
+              "id": 36432,
               "nodeType": "Block",
               "src": "896:171:100",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 36332,
+                      "declaration": 36417,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:100",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 36343,
+                      "declaration": 36428,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:100",
                       "valueSize": 1
                     }
                   ],
-                  "id": 36346,
+                  "id": 36431,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:100"
                 }
               ]
             },
             "documentation": {
-              "id": 36341,
+              "id": 36426,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:100",
               "text": "@dev Set new implementation address."
             },
-            "id": 36348,
+            "id": 36433,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:100",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 36344,
+              "id": 36429,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 36343,
+                  "id": 36428,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:100",
                   "nodeType": "VariableDeclaration",
-                  "scope": 36348,
+                  "scope": 36433,
                   "src": "866:19:100",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 36342,
+                    "id": 36427,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:100",
@@ -335,19 +335,19 @@
               "src": "865:21:100"
             },
             "returnParameters": {
-              "id": 36345,
+              "id": 36430,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:100"
             },
-            "scope": 36349,
+            "scope": 36434,
             "src": "839:228:100",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 36350,
+        "scope": 36435,
         "src": "137:933:100",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.7",
-  "updatedAt": "2022-05-04T10:31:47.583Z",
+  "updatedAt": "2022-05-05T13:57:31.654Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -4,9 +4,8 @@ SuperfluidToken.sol : 2 (24574)
 SuperTokenFactory.sol : 4997 (19579)
 SuperToken.sol : 18673 (5903)
 InstantDistributionAgreementV1.sol : 21970 (2606)
-SlotsBitmapLibrary.sol : 2724 (21852)
 AgreementLibrary.sol : 143 (24433)
 AgreementBase.sol : 2 (24574)
-ConstantFlowAgreementV1.sol : 21634 (2942)
+ConstantFlowAgreementV1.sol : 21777 (2799)
 SuperfluidGovernanceBase.sol : 2 (24574)
 SuperfluidGovernanceII.sol : 6919 (17657)

package/contracts/agreements/AgreementLibrary.sol

@@ -203,6 +203,7 @@ library AgreementLibrary {
      *************************************************************************/
 
     function max(int256 a, int256 b) internal pure returns (int256) { return a > b ? a : b; }
+    function max(uint256 a, uint256 b) internal pure returns (uint256) { return a > b ? a : b; }
 
     function min(int256 a, int256 b) internal pure returns (int256) { return a > b ? b : a; }
 }

package/contracts/agreements/ConstantFlowAgreementV1.sol

@@ -44,6 +44,21 @@ contract ConstantFlowAgreementV1 is
      * E_NO_NEGATIVE_ALLOWANCE - sender cannot set a negative allowance
      */
 
+    /**
+     * @dev Default minimum deposit value
+     *
+     * NOTE:
+     * - It may come as a surprise that it is not 0, this is the minimum friction we have in the system for the
+     *   imperfect blockchain system we live in.
+     * - It is related to deposit clipping, and it is always rounded-up when clipping.
+     */
+    uint256 public constant DEFAULT_MINIMUM_DEPOSIT = uint256(uint96(1 << 32));
+    /// @dev Maximum deposit value
+    uint256 public constant MAXIMUM_DEPOSIT = uint256(uint96(type(int96).max));
+
+    /// @dev Maximum flow rate
+    uint256 public constant MAXIMUM_FLOW_RATE = uint256(uint96(type(int96).max));
+
     bytes32 private constant CFAV1_PPP_CONFIG_KEY =
         keccak256("org.superfluid-finance.agreements.ConstantFlowAgreement.v1.PPPConfiguration");
 
@@ -105,40 +120,61 @@ contract ConstantFlowAgreementV1 is
      * IConstantFlowAgreementV1 interface
      *************************************************************************/
 
-    /// @dev IConstantFlowAgreementV1.createFlow implementation
-    function getMaximumFlowRateFromDeposit(
-        ISuperfluidToken token,
-        uint256 deposit)
-        external view override
-        returns (int96 flowRate)
-    {
-        require(deposit < 2**95, "CFA: deposit number too big");
-        deposit = _clipDepositNumberRoundingDown(deposit);
-        (uint256 liquidationPeriod, ) = _decode3PsData(token);
-        uint256 flowrate1 = deposit / liquidationPeriod;
-
-        // NOTE downcasting is safe as we constrain deposit to less than
-        // 2 ** 95 so the resulting value flowRate1 will fit into int96
-        return int96(int256(flowrate1));
-    }
-
-    function getDepositRequiredForFlowRate(
-        ISuperfluidToken token,
-        int96 flowRate)
-        external view override
-        returns (uint256 deposit)
-    {
-        require(flowRate >= 0, "CFA: not for negative flow rate");
-        ISuperfluid host = ISuperfluid(token.getHost());
-        ISuperfluidGovernance gov = ISuperfluidGovernance(host.getGovernance());
-        uint256 minimumDeposit = gov.getConfigAsUint256(host, token, SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
-        uint256 pppConfig = gov.getConfigAsUint256(host, token, CFAV1_PPP_CONFIG_KEY);
-        (uint256 liquidationPeriod, ) = SuperfluidGovernanceConfigs.decodePPPConfig(pppConfig);
-        require(uint256(int256(flowRate))
-            * liquidationPeriod <= uint256(int256(type(int96).max)), "CFA: flow rate too big");
-        uint256 calculatedDeposit = _calculateDeposit(flowRate, liquidationPeriod);
-        return calculatedDeposit < minimumDeposit && flowRate > 0 ? minimumDeposit : calculatedDeposit;
-    }
+     function _getMaximumFlowRateFromDepositPure(
+         uint256 liquidationPeriod,
+         uint256 deposit)
+         internal pure
+         returns (int96 flowRate)
+     {
+         require(deposit <= MAXIMUM_DEPOSIT, "CFA: deposit number too big");
+         deposit = _clipDepositNumberRoundingDown(deposit);
+
+         uint256 flowrate1 = deposit / liquidationPeriod;
+
+         // NOTE downcasting is safe as we constrain deposit to less than
+         // 2 ** 95 (MAXIMUM_DEPOSIT) so the resulting value flowRate1 will fit into int96
+         return int96(int256(flowrate1));
+     }
+
+     function _getDepositRequiredForFlowRatePure(
+         uint256 minimumDeposit,
+         uint256 liquidationPeriod,
+         int96 flowRate)
+         internal pure
+         returns (uint256 deposit)
+     {
+         require(flowRate > 0, "CFA: not for non-positive flow rate");
+         require(uint256(int256(flowRate)) * liquidationPeriod <= uint256(int256(type(int96).max)),
+             "CFA: flow rate too big");
+         uint256 calculatedDeposit = _calculateDeposit(flowRate, liquidationPeriod);
+         return AgreementLibrary.max(minimumDeposit, calculatedDeposit);
+     }
+
+     /// @dev IConstantFlowAgreementV1.getMaximumFlowRateFromDeposit implementation
+     function getMaximumFlowRateFromDeposit(
+         ISuperfluidToken token,
+         uint256 deposit)
+         external view override
+         returns (int96 flowRate)
+     {
+         (uint256 liquidationPeriod, ) = _decode3PsData(token);
+         flowRate = _getMaximumFlowRateFromDepositPure(liquidationPeriod, deposit);
+     }
+
+     /// @dev IConstantFlowAgreementV1.getDepositRequiredForFlowRate implementation
+     function getDepositRequiredForFlowRate(
+         ISuperfluidToken token,
+         int96 flowRate)
+         external view override
+         returns (uint256 deposit)
+     {
+         ISuperfluid host = ISuperfluid(token.getHost());
+         ISuperfluidGovernance gov = ISuperfluidGovernance(host.getGovernance());
+         uint256 minimumDeposit = gov.getConfigAsUint256(host, token, SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
+         uint256 pppConfig = gov.getConfigAsUint256(host, token, CFAV1_PPP_CONFIG_KEY);
+         (uint256 liquidationPeriod, ) = SuperfluidGovernanceConfigs.decodePPPConfig(pppConfig);
+         return _getDepositRequiredForFlowRatePure(minimumDeposit, liquidationPeriod, flowRate);
+     }
 
     function isPatricianPeriodNow(
         ISuperfluidToken token,
@@ -682,7 +718,7 @@ contract ConstantFlowAgreementV1 is
         newCtx = ctx;
         require(FlowOperatorDefinitions.isPermissionsClean(permissions), "CFA: Unclean permissions");
         ISuperfluid.Context memory currentContext = AgreementLibrary.authorizeTokenAccess(token, ctx);
-        // [SECURITY] NOTE: we are holding the assumption here that ctx is correct and we validate it with 
+        // [SECURITY] NOTE: we are holding the assumption here that ctx is correct and we validate it with
         // authorizeTokenAccess:
         require(currentContext.msgSender != flowOperator, "CFA: E_NO_SENDER_FLOW_OPERATOR");
         require(flowRateAllowance >= 0, "CFA: E_NO_NEGATIVE_ALLOWANCE");

package/contracts/agreements/InstantDistributionAgreementV1.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity 0.8.13;
 
+import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+
 import {
     IInstantDistributionAgreementV1,
     ISuperfluidToken
@@ -14,10 +16,9 @@ import {
 from "../interfaces/superfluid/ISuperfluid.sol";
 import { AgreementBase } from "./AgreementBase.sol";
 
-import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 import { UInt128SafeMath } from "../libs/UInt128SafeMath.sol";
+import { SlotsBitmapLibrary } from "../libs/SlotsBitmapLibrary.sol";
 import { AgreementLibrary } from "./AgreementLibrary.sol";
-import { SlotsBitmapLibrary } from "./SlotsBitmapLibrary.sol";
 
 
 /**

package/contracts/{agreements → libs}/SlotsBitmapLibrary.sol

@@ -1,9 +1,7 @@
 // SPDX-License-Identifier: AGPLv3
 pragma solidity 0.8.13;
 
-import {
-    ISuperfluidToken
-} from "../interfaces/agreements/IInstantDistributionAgreementV1.sol";
+import {ISuperfluidToken} from "../interfaces/superfluid/ISuperfluidToken.sol";
 
 /**
  * @title Slots Bitmap library

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.2.2-dev.6a8632e.0",
+    "version": "1.2.2-dev.a4c583c.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -16,6 +16,7 @@
         "!/build/contracts/*Mock*.json",
         "!/build/contracts/*Tester*.json",
         "!/build/contracts/*Anvil.json",
+        "!/build/contracts/*Properties.json",
         "/build/contracts-sizes.txt",
         "/build/abi.js",
         "scripts/**/*",