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

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        36434
+        36399
       ]
     },
-    "id": 36435,
+    "id": 36400,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 36412,
+        "id": 36377,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 36413,
+          "id": 36378,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:100",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 36434,
+        "id": 36399,
         "linearizedBaseContracts": [
-          36434
+          36399
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:100",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 36414,
+              "id": 36379,
               "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": 36417,
+            "id": 36382,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:100",
             "nodeType": "VariableDeclaration",
-            "scope": 36434,
+            "scope": 36399,
             "src": "455:115:100",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 36415,
+              "id": 36380,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:100",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 36416,
+              "id": 36381,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 36424,
+              "id": 36389,
               "nodeType": "Block",
               "src": "681:107:100",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 36417,
+                      "declaration": 36382,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:100",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 36421,
+                      "declaration": 36386,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:100",
                       "valueSize": 1
                     }
                   ],
-                  "id": 36423,
+                  "id": 36388,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:100"
                 }
               ]
             },
             "documentation": {
-              "id": 36418,
+              "id": 36383,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:100",
               "text": "@dev Get implementation address."
             },
-            "id": 36425,
+            "id": 36390,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:100",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 36419,
+              "id": 36384,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:100"
             },
             "returnParameters": {
-              "id": 36422,
+              "id": 36387,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 36421,
+                  "id": 36386,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:100",
                   "nodeType": "VariableDeclaration",
-                  "scope": 36425,
+                  "scope": 36390,
                   "src": "667:12:100",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 36420,
+                    "id": 36385,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:100",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:100"
             },
-            "scope": 36434,
+            "scope": 36399,
             "src": "618:170:100",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 36432,
+              "id": 36397,
               "nodeType": "Block",
               "src": "896:171:100",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 36417,
+                      "declaration": 36382,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:100",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 36428,
+                      "declaration": 36393,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:100",
                       "valueSize": 1
                     }
                   ],
-                  "id": 36431,
+                  "id": 36396,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:100"
                 }
               ]
             },
             "documentation": {
-              "id": 36426,
+              "id": 36391,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:100",
               "text": "@dev Set new implementation address."
             },
-            "id": 36433,
+            "id": 36398,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:100",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 36429,
+              "id": 36394,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 36428,
+                  "id": 36393,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:100",
                   "nodeType": "VariableDeclaration",
-                  "scope": 36433,
+                  "scope": 36398,
                   "src": "866:19:100",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 36427,
+                    "id": 36392,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:100",
@@ -335,19 +335,19 @@
               "src": "865:21:100"
             },
             "returnParameters": {
-              "id": 36430,
+              "id": 36395,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:100"
             },
-            "scope": 36434,
+            "scope": 36399,
             "src": "839:228:100",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 36435,
+        "scope": 36400,
         "src": "137:933:100",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.7",
-  "updatedAt": "2022-05-05T13:57:31.654Z",
+  "updatedAt": "2022-05-06T14:04:24.915Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -1,5 +1,5 @@
 FullUpgradableSuperTokenProxy.sol : 635 (23941)
-Superfluid.sol : 22163 (2413)
+Superfluid.sol : 22046 (2530)
 SuperfluidToken.sol : 2 (24574)
 SuperTokenFactory.sol : 4997 (19579)
 SuperToken.sol : 18673 (5903)
@@ -8,4 +8,4 @@ AgreementLibrary.sol : 143 (24433)
 AgreementBase.sol : 2 (24574)
 ConstantFlowAgreementV1.sol : 21777 (2799)
 SuperfluidGovernanceBase.sol : 2 (24574)
-SuperfluidGovernanceII.sol : 6919 (17657)
+SuperfluidGovernanceII.sol : 6831 (17745)

package/contracts/gov/SuperfluidGovernanceBase.sol

@@ -111,7 +111,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluidToken superToken,
         bytes32 key,
         address value
-    ) 
+    )
         external override
     {
         _setConfig(host, superToken, key, value);
@@ -122,7 +122,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluidToken superToken,
         bytes32 key,
         uint256 value
-    ) 
+    )
         external override
     {
         _setConfig(host, superToken, key, value);
@@ -132,7 +132,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluid host,
         ISuperfluidToken superToken,
         bytes32 key
-    ) 
+    )
         external override
     {
         _clearConfig(host, superToken, key);
@@ -278,8 +278,8 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         returns (uint256 liquidationPeriod, uint256 patricianPeriod)
         {
             uint256 pppConfig = getConfigAsUint256(
-                host, 
-                superToken, 
+                host,
+                superToken,
                 SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY
             );
             (liquidationPeriod, patricianPeriod) = SuperfluidGovernanceConfigs.decodePPPConfig(pppConfig);
@@ -290,7 +290,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluidToken superToken,
         uint256 liquidationPeriod,
         uint256 patricianPeriod
-    ) 
+    )
         public
     {
         require(liquidationPeriod > patricianPeriod
@@ -325,8 +325,8 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     function getSuperTokenMinimumDeposit(
         ISuperfluid host,
         ISuperfluidToken superToken
-    ) public view 
-    returns (uint256 value) 
+    ) public view
+    returns (uint256 value)
     {
         return getConfigAsUint256(host, superToken,
             SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
@@ -344,7 +344,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     function clearSuperTokenMinimumDeposit(
         ISuperfluid host,
         ISuperToken superToken
-    ) public 
+    ) public
     {
         emit SuperTokenMinimumDepositChanged(host, superToken, false, 0);
         return _clearConfig(host, superToken, SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
@@ -412,23 +412,6 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
             SuperfluidGovernanceConfigs.getTrustedForwarderConfigKey(forwarder));
     }
 
-    /**
-     * @dev Whitelist a new app using a onetime key
-     * @param key is a deployer specific hash key which can be used once to register an app
-     *
-     * NOTE:
-     * To generate the key, use the SuperfluidGovernanceConfigs.getAppRegistrationConfigKey
-     * offchain.
-     */
-    function whiteListNewApp(
-        ISuperfluid host,
-        bytes32 key
-    )
-        external
-    {
-        _setConfig(host, ISuperfluidToken(address(0)), key, 1);
-    }
-
     /**
      * @dev tells if the given factory is authorized to register apps
      */

package/contracts/mocks/SuperfluidMock.sol

@@ -44,8 +44,8 @@ contract SuperfluidUpgradabilityTester is Superfluid {
         assembly { slot:= _ctxStamp.slot offset := _ctxStamp.offset }
         require(slot == 6 && offset == 0, "_ctxStamp changed location");
 
-        assembly { slot:= _appKeysUsed.slot offset := _appKeysUsed.offset }
-        require(slot == 7 && offset == 0, "_appKeysUsed changed location");
+        assembly { slot:= _appKeysUsedDeprecated.slot offset := _appKeysUsedDeprecated.offset }
+        require(slot == 7 && offset == 0, "_appKeysUsedDeprecated changed location");
     }
 
     // @dev Make sure the context struct layout never change over the course of the development

package/contracts/superfluid/Superfluid.sol

@@ -90,7 +90,7 @@ contract Superfluid is
     ///      zero before transaction finishes
     bytes32 internal _ctxStamp;
     /// @dev if app whitelisting is enabled, this is to make sure the keys are used only once
-    mapping(bytes32 => bool) internal _appKeysUsed;
+    mapping(bytes32 => bool) internal _appKeysUsedDeprecated;
 
     constructor(bool nonUpgradable, bool appWhiteListingEnabled) {
         NON_UPGRADABLE_DEPLOYMENT = nonUpgradable;
@@ -315,21 +315,16 @@ contract Superfluid is
             tx.origin,
             registrationKey
         );
-        // check if the key is enabled
+        // check if the key is valid and not expired
         require(
             _gov.getConfigAsUint256(
                 this,
                 ISuperfluidToken(address(0)),
                 configKey
-            ) == 1,
-            "SF: invalid registration key"
+            // solhint-disable-next-line not-rely-on-time
+            ) >= block.timestamp,
+            "SF: invalid or expired registration key"
         );
-        require(
-            !_appKeysUsed[configKey],
-            "SF: registration key already used"
-        );
-        // clear the key so that it can't be reused
-        _appKeysUsed[configKey] = true;
         _registerApp(configWord, ISuperApp(msg.sender), true);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.2.2-dev.a4c583c.0",
+    "version": "1.2.2-dev.bd59c6c.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {

package/scripts/gov-create-new-app-registration-key.js

@@ -6,6 +6,8 @@ const {
     sendGovernanceAction,
 } = require("./libs/common");
 
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+
 /**
  * @dev Create a new super app registration key.
  * @param {Array} argv Overriding command line arguments
@@ -14,7 +16,13 @@ const {
  * @param {Address} options.from Address to deploy contracts from
  * @param {boolean} options.protocolReleaseVersion Specify the protocol release version to be used
  *
- * Usage: npx truffle exec scripts/create-new-app-registration-key.js : {DEPLOYER} {REGISTRATION_KEY}
+ * Note: the key itself doesn't have much meaning, it could be "stolen" from a broadcast tx anyway.
+ * But since it's bound to a deployer address, that doesn't really matter.
+ *
+ * Usage: npx truffle exec scripts/create-new-app-registration-key.js : {DEPLOYER} {REGISTRATION_KEY} [EXPIRATION_TS]
+ *        EXPIRATION_TS is a Unix timestamp in seconds for when the key should expire.
+ *        If not set, we default to 90 days in the future.
+ *        Hint: you may use https://www.unixtimestamp.com/ to calculate a timestamp
  */
 module.exports = eval(`(${S.toString()})({
     doNotPrintColonArgs: true
@@ -22,9 +30,20 @@ module.exports = eval(`(${S.toString()})({
     console.log("======== Creating new app registration key ========");
     let {protocolReleaseVersion} = options;
 
-    if (args.length !== 2) {
+    if (args.length > 3 || args.length < 2) {
         throw new Error("Wrong number of arguments");
     }
+
+    let expirationTs = Math.floor(Date.now() / 1000) + 3600 * 24 * 90; // 90 days from now
+    if (args.length === 3) {
+        const expTsStr = args.pop();
+        const parsedExpTs = parseInt(expTsStr);
+        if (parsedExpTs.toString() !== expTsStr) {
+            throw new Error("EXPIRATON_TS not an integer");
+        }
+        expirationTs = parsedExpTs;
+        console.log("Expiration timestamp", expirationTs);
+    }
     const registrationkey = args.pop();
     const deployer = args.pop();
     console.log("Deployer", deployer);
@@ -54,8 +73,12 @@ module.exports = eval(`(${S.toString()})({
         )
     );
     console.log("App key", appKey);
+    console.log("Expiration date", new Date(expirationTs * 1000)); // print human readable
 
+    // Note that we are NOT using gov.whiteListNewApp here, because it doesn't support setting
+    // an expiration date and will eventually be deprecated.
+    // Instead we use the lower level setConfig directly.
     await sendGovernanceAction(sf, (gov) =>
-        gov.whiteListNewApp(sf.host.address, appKey)
+        gov.setConfig(sf.host.address, ZERO_ADDRESS, appKey, expirationTs)
     );
 });