@superfluid-finance/ethereum-contracts 1.2.3-dev.c35a287.0 → 1.2.3-dev.cd892eb.0

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        35278
+        35281
       ]
     },
-    "id": 35279,
+    "id": 35282,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 35256,
+        "id": 35259,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 35257,
+          "id": 35260,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:97",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 35278,
+        "id": 35281,
         "linearizedBaseContracts": [
-          35278
+          35281
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:97",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 35258,
+              "id": 35261,
               "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": 35261,
+            "id": 35264,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:97",
             "nodeType": "VariableDeclaration",
-            "scope": 35278,
+            "scope": 35281,
             "src": "455:115:97",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 35259,
+              "id": 35262,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:97",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 35260,
+              "id": 35263,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 35268,
+              "id": 35271,
               "nodeType": "Block",
               "src": "681:107:97",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 35261,
+                      "declaration": 35264,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 35265,
+                      "declaration": 35268,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 35267,
+                  "id": 35270,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:97"
                 }
               ]
             },
             "documentation": {
-              "id": 35262,
+              "id": 35265,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:97",
               "text": "@dev Get implementation address."
             },
-            "id": 35269,
+            "id": 35272,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 35263,
+              "id": 35266,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:97"
             },
             "returnParameters": {
-              "id": 35266,
+              "id": 35269,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 35265,
+                  "id": 35268,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 35269,
+                  "scope": 35272,
                   "src": "667:12:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 35264,
+                    "id": 35267,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:97",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:97"
             },
-            "scope": 35278,
+            "scope": 35281,
             "src": "618:170:97",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 35276,
+              "id": 35279,
               "nodeType": "Block",
               "src": "896:171:97",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 35261,
+                      "declaration": 35264,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:97",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 35272,
+                      "declaration": 35275,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:97",
                       "valueSize": 1
                     }
                   ],
-                  "id": 35275,
+                  "id": 35278,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:97"
                 }
               ]
             },
             "documentation": {
-              "id": 35270,
+              "id": 35273,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:97",
               "text": "@dev Set new implementation address."
             },
-            "id": 35277,
+            "id": 35280,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:97",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 35273,
+              "id": 35276,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 35272,
+                  "id": 35275,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:97",
                   "nodeType": "VariableDeclaration",
-                  "scope": 35277,
+                  "scope": 35280,
                   "src": "866:19:97",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 35271,
+                    "id": 35274,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:97",
@@ -335,19 +335,19 @@
               "src": "865:21:97"
             },
             "returnParameters": {
-              "id": 35274,
+              "id": 35277,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:97"
             },
-            "scope": 35278,
+            "scope": 35281,
             "src": "839:228:97",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 35279,
+        "scope": 35282,
         "src": "137:933:97",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.7",
-  "updatedAt": "2022-05-16T08:18:25.153Z",
+  "updatedAt": "2022-05-19T14:37:34.378Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -1,11 +1,11 @@
-SuperTokenFactory.sol : 4997 (19579)
-FullUpgradableSuperTokenProxy.sol : 635 (23941)
-SuperToken.sol : 18673 (5903)
+Superfluid.sol : 22090 (2486)
 SuperfluidToken.sol : 2 (24574)
-Superfluid.sol : 22046 (2530)
-ConstantFlowAgreementV1.sol : 21777 (2799)
+SuperToken.sol : 18673 (5903)
+FullUpgradableSuperTokenProxy.sol : 635 (23941)
+SuperTokenFactory.sol : 4997 (19579)
 AgreementLibrary.sol : 143 (24433)
-AgreementBase.sol : 2 (24574)
 InstantDistributionAgreementV1.sol : 21970 (2606)
-SuperfluidGovernanceBase.sol : 2 (24574)
+AgreementBase.sol : 2 (24574)
+ConstantFlowAgreementV1.sol : 21777 (2799)
 SuperfluidGovernanceII.sol : 6831 (17745)
+SuperfluidGovernanceBase.sol : 2 (24574)

package/contracts/interfaces/superfluid/ISuperfluid.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity >= 0.8.0;
+pragma solidity >= 0.8.2;
 
 import { ISuperfluidGovernance } from "./ISuperfluidGovernance.sol";
 import { ISuperfluidToken } from "./ISuperfluidToken.sol";
@@ -184,7 +184,9 @@ interface ISuperfluid {
      *************************************************************************/
 
     /**
-     * @dev Message sender declares it as a super app
+     * @dev Message sender (must be a contract) declares itself as a super app.
+     * @custom:deprecated you should use `registerAppWithKey` or `registerAppByFactory` instead,
+     * because app registration is currently governance permissioned on mainnets.
      * @param configWord The super app manifest configuration, flags are defined in
      * `SuperAppDefinitions`
      */
@@ -196,18 +198,24 @@ interface ISuperfluid {
     event AppRegistered(ISuperApp indexed app);
 
     /**
-     * @dev Message sender declares it as a super app, using a registration key
+     * @dev Message sender declares itself as a super app.
      * @param configWord The super app manifest configuration, flags are defined in
      * `SuperAppDefinitions`
-     * @param registrationKey The registration key issued by the governance
+     * @param registrationKey The registration key issued by the governance, needed to
+     * register on a mainnet.
+     * See https://github.com/superfluid-finance/protocol-monorepo/wiki/Super-App-White-listing-Guide
+     * On testnets or in dev environment, a placeholder (e.g. empty string) can be used.
+     * @notice While the message sender must be the super app itself, the transaction sender (tx.origin)
+     * must be the deployer account the registration key was issued for.
      */
     function registerAppWithKey(uint256 configWord, string calldata registrationKey) external;
 
     /**
-     * @dev Message sender declares app as a super app
+     * @dev Message sender (must be a contract) declares app as a super app
      * @param configWord The super app manifest configuration, flags are defined in
      * `SuperAppDefinitions`
-     * NOTE: only factory contracts authorized by governance can register super apps
+     * @notice On mainnet deployments, only factory contracts pre-authorized by governance can use this.
+     * See https://github.com/superfluid-finance/protocol-monorepo/wiki/Super-App-White-listing-Guide
      */
     function registerAppByFactory(ISuperApp app, uint256 configWord) external;
 

package/contracts/superfluid/Superfluid.sol

@@ -315,16 +315,18 @@ contract Superfluid is
             tx.origin,
             registrationKey
         );
-        // check if the key is valid and not expired
-        require(
-            _gov.getConfigAsUint256(
-                this,
-                ISuperfluidToken(address(0)),
-                configKey
-            // solhint-disable-next-line not-rely-on-time
-            ) >= block.timestamp,
-            "SF: invalid or expired registration key"
-        );
+        if (APP_WHITE_LISTING_ENABLED) {
+            // check if the key is valid and not expired
+            require(
+                _gov.getConfigAsUint256(
+                    this,
+                    ISuperfluidToken(address(0)),
+                    configKey
+                // solhint-disable-next-line not-rely-on-time
+                ) >= block.timestamp,
+                "SF: invalid or expired registration key"
+            );
+        }
         _registerApp(configWord, ISuperApp(msg.sender), true);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.2.3-dev.c35a287.0",
+    "version": "1.2.3-dev.cd892eb.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -56,7 +56,7 @@
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@openzeppelin/contracts": "4.5.0",
-        "@superfluid-finance/js-sdk": "^0.6.1-dev.c35a287.0",
+        "@superfluid-finance/js-sdk": "^0.6.2-dev.cd892eb.0",
         "@truffle/contract": "4.5.5",
         "ethereumjs-tx": "2.1.2",
         "ethereumjs-util": "7.1.4",

package/scripts/{deploy-unlisted-native-super-token.js → deploy-unlisted-pure-super-token.js}

@@ -7,20 +7,20 @@ const {
 } = require("./libs/common");
 
 /**
- * @dev Deploy unlisted native super token to the network.
+ * @dev Deploy unlisted pure super token to the network.
  * @param {Array} argv Overriding command line arguments
  * @param {boolean} options.isTruffle Whether the script is used within native truffle framework
  * @param {Web3} options.web3  Injected web3 instance
  * @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/deploy-unlisted-native-super-token.js : {NAME} {SYMBOL} {INITIAL SUPPLY}
+ * Usage: npx truffle exec scripts/deploy-unlisted-pure-super-token.js : {NAME} {SYMBOL} {INITIAL SUPPLY}
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
     args,
     options = {}
 ) {
-    console.log("======== Deploying unlisted native super token ========");
+    console.log("======== Deploying unlisted pure super token ========");
     let {protocolReleaseVersion} = options;
 
     if (args.length !== 3) {
@@ -62,7 +62,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     console.log("Invoking initializeCustomSuperToken...");
     await superTokenFactory.initializeCustomSuperToken(token.address);
 
-    console.log(`Native SuperToken deployed at ${token.address}`);
+    console.log(`Pure SuperToken deployed at ${token.address}`);
 
     return token.address;
 });

package/scripts/gov-transfer-framework-ownership.js

@@ -34,10 +34,10 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 
     const myAccount = (await web3.eth.getAccounts())[0];
     console.log("My account", myAccount);
-    console.log("Transfering ownership of the framework to", newGovOwner);
+    console.log("Transferring ownership of the framework to", newGovOwner);
     if (newResolverAdmin !== undefined) {
         console.log(
-            "Transfering admin role of the resolver to",
+            "Transferring admin role of the resolver to",
             newResolverAdmin
         );
     }
@@ -62,7 +62,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
             console.log("ERR: I am not owner of the governance.");
         }
     } else {
-        console.log("I remain the owned of the governance.");
+        console.log("I remain the owner of the governance.");
     }
 
     if (

package/scripts/libs/getConfig.js

@@ -173,13 +173,13 @@ module.exports = function getConfig(chainId) {
             // avalanche mainnet
             liquidationPeriod: 3600 * 4,
             patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["AVAXx"],
+            tokenList: [],
             // governance default configs
             gov_enableAppWhiteListing: true,
             // misc
             disableTestGovernance: true,
             data: {
-                initialBlockNumber: 11950000,
+                initialBlockNumber: 14700000,
                 getLogsRange: 50000,
             },
         },
@@ -198,7 +198,7 @@ module.exports = function getConfig(chainId) {
             // celo mainnet
             liquidationPeriod: 3600 * 4,
             patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["CELOx"],
+            tokenList: [],
             // governance default configs
             gov_enableAppWhiteListing: true,
             // misc

package/utils/README.md

@@ -6,4 +6,22 @@ If you have python installed, you can start a webserver with the document root s
 ```python
 python -m SimpleHTTPServer 1337
 ```
-Then navigate to http://localhost:1337/supertoken-deployer.html.
+Then navigate to http://localhost:1337/supertoken-deployer.html
+
+Alternatively, you can also find it on IPFS: [QmbjeSLXfmePAnWRBhkhajCpdu58Xsn7BqQwj8pSxRS9d8](http://ipfs.io/ipfs/QmbjeSLXfmePAnWRBhkhajCpdu58Xsn7BqQwj8pSxRS9d8)
+
+## Stream Closer
+
+This is a single-file Dapp for closing streams / deleting flows.
+The flow parameters _token_, _sender_ and _receiver_ can be set either in the UI or provided as URL parameters.
+If you have python installed, you can start a webserver with the document root set to the current directory with
+```python
+python -m SimpleHTTPServer 1337
+```
+
+Then navigate to http://localhost:1337/stream-closer.html
+
+Alternatively, you can also find it on IPFS: [QmRJmHatYiGgGsXYCsYZdqPMx4dd2qbMskMJvXGWZ53oJJ](http://ipfs.io/ipfs/QmRJmHatYiGgGsXYCsYZdqPMx4dd2qbMskMJvXGWZ53oJJ)
+
+In order to set the parameter in the URL, use this format:
+stream-closer.html?chainId=<chainId>&token=<tokenAddress>&sender=<senderAddress>&receiver=<receiverAddress>