@superfluid-finance/ethereum-contracts 1.3.2-dev.8696fa0.0 → 1.3.2-dev.9e41aae.0

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        37098
+        37220
       ]
     },
-    "id": 37099,
+    "id": 37221,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 37076,
+        "id": 37198,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 37077,
+          "id": 37199,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:97",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 37098,
+        "id": 37220,
         "linearizedBaseContracts": [
-          37098
+          37220
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:97",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 37078,
+              "id": 37200,
               "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": 37081,
+            "id": 37203,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:97",
             "nodeType": "VariableDeclaration",
-            "scope": 37098,
+            "scope": 37220,
             "src": "455:115:97",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 37079,
+              "id": 37201,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:97",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 37080,
+              "id": 37202,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 37088,
+              "id": 37210,
               "nodeType": "Block",
               "src": "681:107:97",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37081,
+                      "declaration": 37203,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37085,
+                      "declaration": 37207,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37087,
+                  "id": 37209,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:97"
                 }
               ]
             },
             "documentation": {
-              "id": 37082,
+              "id": 37204,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:97",
               "text": "@dev Get implementation address."
             },
-            "id": 37089,
+            "id": 37211,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37083,
+              "id": 37205,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:97"
             },
             "returnParameters": {
-              "id": 37086,
+              "id": 37208,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37085,
+                  "id": 37207,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37089,
+                  "scope": 37211,
                   "src": "667:12:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37084,
+                    "id": 37206,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:97",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:97"
             },
-            "scope": 37098,
+            "scope": 37220,
             "src": "618:170:97",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 37096,
+              "id": 37218,
               "nodeType": "Block",
               "src": "896:171:97",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37081,
+                      "declaration": 37203,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37092,
+                      "declaration": 37214,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37095,
+                  "id": 37217,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:97"
                 }
               ]
             },
             "documentation": {
-              "id": 37090,
+              "id": 37212,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:97",
               "text": "@dev Set new implementation address."
             },
-            "id": 37097,
+            "id": 37219,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37093,
+              "id": 37215,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37092,
+                  "id": 37214,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37097,
+                  "scope": 37219,
                   "src": "866:19:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37091,
+                    "id": 37213,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:97",
@@ -335,19 +335,19 @@
               "src": "865:21:97"
             },
             "returnParameters": {
-              "id": 37094,
+              "id": 37216,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:97"
             },
-            "scope": 37098,
+            "scope": 37220,
             "src": "839:228:97",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 37099,
+        "scope": 37221,
         "src": "137:933:97",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.8",
-  "updatedAt": "2022-08-29T16:08:02.781Z",
+  "updatedAt": "2022-08-30T13:03:13.792Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -7,5 +7,5 @@ InstantDistributionAgreementV1.sol : 21835 (2741)
 AgreementLibrary.sol : 143 (24433)
 ConstantFlowAgreementV1.sol : 21805 (2771)
 AgreementBase.sol : 2 (24574)
-SuperfluidGovernanceII.sol : 7347 (17229)
+SuperfluidGovernanceII.sol : 8402 (16174)
 SuperfluidGovernanceBase.sol : 2 (24574)

package/contracts/gov/SuperfluidGovernanceBase.sol

@@ -218,7 +218,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     }
 
     /**************************************************************************
-    /* Known Configurations
+    /* Convenience methods for known Configurations
     /*************************************************************************/
 
     // Superfluid rewardAddress
@@ -232,7 +232,8 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluid host,
         ISuperfluidToken superToken
     )
-        public view returns (address)
+        public view
+        returns (address)
     {
         return getConfigAsAddress(
             host, superToken,
@@ -246,11 +247,11 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     )
         public
     {
-        emit RewardAddressChanged(host, superToken, true, rewardAddress);
-        return _setConfig(
+        _setConfig(
             host, superToken,
             SuperfluidGovernanceConfigs.SUPERFLUID_REWARD_ADDRESS_CONFIG_KEY,
             rewardAddress);
+        emit RewardAddressChanged(host, superToken, true, rewardAddress);
     }
 
     function clearRewardAddress(
@@ -259,10 +260,10 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     )
         public
     {
-        emit RewardAddressChanged(host, superToken, false, address(0));
         _clearConfig(
             host, superToken,
             SuperfluidGovernanceConfigs.SUPERFLUID_REWARD_ADDRESS_CONFIG_KEY);
+        emit RewardAddressChanged(host, superToken, false, address(0));
     }
 
     // CFAv1 liquidationPeriod (DEPRECATED BY PPPConfigurationChanged)
@@ -283,16 +284,17 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     function getPPPConfig(
         ISuperfluid host,
         ISuperfluidToken superToken
-    ) public view
+    )
+        public view
         returns (uint256 liquidationPeriod, uint256 patricianPeriod)
-        {
-            uint256 pppConfig = getConfigAsUint256(
-                host,
-                superToken,
-                SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY
-            );
-            (liquidationPeriod, patricianPeriod) = SuperfluidGovernanceConfigs.decodePPPConfig(pppConfig);
-        }
+    {
+        uint256 pppConfig = getConfigAsUint256(
+            host,
+            superToken,
+            SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY
+        );
+        (liquidationPeriod, patricianPeriod) = SuperfluidGovernanceConfigs.decodePPPConfig(pppConfig);
+    }
 
     function setPPPConfig(
         ISuperfluid host,
@@ -307,23 +309,27 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
             && patricianPeriod < type(uint32).max,
             "SFGov: Invalid liquidationPeriod or patricianPeriod"
         );
-        emit PPPConfigurationChanged(host, superToken, true, liquidationPeriod, patricianPeriod);
         uint256 value = (uint256(liquidationPeriod) << 32) | uint256(patricianPeriod);
-        return _setConfig(
+        _setConfig(
             host,
             superToken,
             SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY,
             value
         );
+        emit PPPConfigurationChanged(host, superToken, true, liquidationPeriod, patricianPeriod);
     }
 
     function clearPPPConfig(
         ISuperfluid host,
         ISuperfluidToken superToken
-    ) public {
+    )
+        public
+    {
+        _clearConfig(host, superToken, SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY);
         emit PPPConfigurationChanged(host, superToken, false, 0, 0);
-        return _clearConfig(host, superToken, SuperfluidGovernanceConfigs.CFAV1_PPP_CONFIG_KEY);
     }
+
+    // CFAv1 minimum deposit
     event SuperTokenMinimumDepositChanged(
         ISuperfluid indexed host,
         ISuperfluidToken indexed superToken,
@@ -334,8 +340,9 @@ 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);
@@ -345,18 +352,21 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         ISuperfluid host,
         ISuperfluidToken superToken,
         uint256 value
-    ) public {
+    )
+        public
+    {
+        _setConfig(host, superToken, SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY, value);
         emit SuperTokenMinimumDepositChanged(host, superToken, true, value);
-        return _setConfig(host, superToken, SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY, value);
     }
 
     function clearSuperTokenMinimumDeposit(
         ISuperfluid host,
         ISuperToken superToken
-    ) public
+    )
+        public
     {
+        _clearConfig(host, superToken, SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
         emit SuperTokenMinimumDepositChanged(host, superToken, false, 0);
-        return _clearConfig(host, superToken, SuperfluidGovernanceConfigs.SUPERTOKEN_MINIMUM_DEPOSIT_KEY);
     }
 
     // trustedForwarder
@@ -401,26 +411,78 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
     )
         public
     {
-        _setConfig(
+        _clearConfig(
             host, superToken,
-            SuperfluidGovernanceConfigs.getTrustedForwarderConfigKey(forwarder),
-            0);
+            SuperfluidGovernanceConfigs.getTrustedForwarderConfigKey(forwarder));
         emit TrustedForwarderChanged(host, superToken, true, forwarder, false);
     }
 
-    function clearTrustedForwarder(
+    // Superfluid registrationKey
+    event AppRegistrationKeyChanged(
+        ISuperfluid indexed host,
+        address indexed deployer,
+        string appRegistrationKey,
+        uint256 expirationTs
+    );
+
+    function verifyAppRegistrationKey(
         ISuperfluid host,
-        ISuperfluidToken superToken,
-        address forwarder
+        address deployer,
+        string memory registrationKey
+    )
+        public view
+        returns(bool validNow, uint256 expirationTs)
+    {
+        bytes32 configKey = SuperfluidGovernanceConfigs.getAppRegistrationConfigKey(
+            deployer,
+            registrationKey
+        );
+        uint256 expirationTs = getConfigAsUint256(host, ISuperfluidToken(address(0)), configKey);
+        return (
+            // solhint-disable-next-line not-rely-on-time
+            expirationTs >= block.timestamp,
+            expirationTs
+        );
+    }
+
+    function setAppRegistrationKey(
+        ISuperfluid host,
+        address deployer,
+        string memory registrationKey,
+        uint256 expirationTs
     )
         public
     {
-        emit TrustedForwarderChanged(host, superToken, false, forwarder, false);
-        return _clearConfig(
-            host, superToken,
-            SuperfluidGovernanceConfigs.getTrustedForwarderConfigKey(forwarder));
+        bytes32 configKey = SuperfluidGovernanceConfigs.getAppRegistrationConfigKey(
+            deployer,
+            registrationKey
+        );
+        _setConfig(host, ISuperfluidToken(address(0)), configKey, expirationTs);
+        emit AppRegistrationKeyChanged(host, deployer, registrationKey, expirationTs);
     }
 
+    function clearAppRegistrationKey(
+        ISuperfluid host,
+        address deployer,
+        string memory registrationKey
+    )
+        public
+    {
+        bytes32 configKey = SuperfluidGovernanceConfigs.getAppRegistrationConfigKey(
+            deployer,
+            registrationKey
+        );
+        _clearConfig(host, ISuperfluidToken(address(0)), configKey);
+        emit AppRegistrationKeyChanged(host, deployer, registrationKey, 0);
+    }
+
+    // Superfluid App factory
+    event AppFactoryAuthorizationChanged(
+        ISuperfluid indexed host,
+        address indexed factory,
+        bool authorized
+    );
+
     /**
      * @dev tells if the given factory is authorized to register apps
      */
@@ -453,11 +515,11 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
             assembly { cs := extcodesize(factory) }
             require(cs > 0, "SFGov: factory must be a contract");
         }
-
         _setConfig(
             host, ISuperfluidToken(address(0)),
             SuperfluidGovernanceConfigs.getAppFactoryConfigKey(factory),
             1);
+        emit AppFactoryAuthorizationChanged(host, factory, true);
     }
 
     /**
@@ -473,6 +535,7 @@ abstract contract SuperfluidGovernanceBase is ISuperfluidGovernance
         _clearConfig(
             host, ISuperfluidToken(address(0)),
             SuperfluidGovernanceConfigs.getAppFactoryConfigKey(factory));
+        emit AppFactoryAuthorizationChanged(host, factory, false);
     }
 
     // TODO: would like to use virtual modifier, but solhint doesn't like it atm

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.3.2-dev.8696fa0.0",
+    "version": "1.3.2-dev.9e41aae.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -57,7 +57,7 @@
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@openzeppelin/contracts": "4.7.0",
-        "@superfluid-finance/js-sdk": "^0.6.4-dev.8696fa0.0",
+        "@superfluid-finance/js-sdk": "^0.6.4-dev.9e41aae.0",
         "@truffle/contract": "4.5.15",
         "ethereumjs-tx": "2.1.2",
         "ethereumjs-util": "7.1.5",

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

@@ -6,8 +6,6 @@ const {
     sendGovernanceAction,
 } = require("./libs/common");
 
-const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
-
 /**
  * @dev Create a new super app registration key.
  * @param {Array} argv Overriding command line arguments
@@ -43,11 +41,12 @@ module.exports = eval(`(${S.toString()})({
             throw new Error("EXPIRATON_TS not an integer");
         }
         expirationTs = parsedExpTs;
-        console.log("Expiration timestamp", expirationTs);
     }
-    const registrationkey = args.pop();
+    const registrationKey = args.pop();
     const deployer = args.pop();
     console.log("Deployer", deployer);
+    console.log("Registration key", registrationKey);
+    console.log("Expiration timestamp", expirationTs);
 
     console.log("protocol release version:", protocolReleaseVersion);
 
@@ -63,23 +62,14 @@ module.exports = eval(`(${S.toString()})({
     });
     await sf.initialize();
 
-    const appKey = web3.utils.sha3(
-        web3.eth.abi.encodeParameters(
-            ["string", "address", "string"],
-            [
-                "org.superfluid-finance.superfluid.appWhiteListing.registrationKey",
-                deployer,
-                registrationkey,
-            ]
-        )
-    );
-    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.setConfig(sf.host.address, ZERO_ADDRESS, appKey, expirationTs)
+        gov.setAppRegistrationKey(
+            sf.host.address,
+            deployer,
+            registrationKey,
+            expirationTs
+        )
     );
 });