@superfluid-finance/ethereum-contracts 1.2.3-dev.f94fdbb.0 → 1.3.1-dev.b8455ea.0

package/contracts/mocks/FakeSuperfluidMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { CallUtils } from "../libs/CallUtils.sol";
 

package/contracts/mocks/ForwarderMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { CallUtils } from "../libs/CallUtils.sol";
 import { IRelayRecipient } from "../interfaces/utils/IRelayRecipient.sol";

package/contracts/mocks/IDASuperAppTester.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,
@@ -26,7 +26,7 @@ contract IDASuperAppTester is ISuperApp {
         uint32 indexId)
     {
         _host = host;
-        _host.registerApp(configWord);
+        _host.registerAppWithKey(configWord, "");
         _ida = ida;
         _token = token;
         _indexId = indexId;

package/contracts/mocks/IDAv1LibraryMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 pragma experimental ABIEncoderV2;
 
 import {ISuperfluid, ISuperfluidToken, ISuperToken} from "../interfaces/superfluid/ISuperfluid.sol";
@@ -157,7 +157,7 @@ contract IDAv1LibraryMock {
     /**************************************************************************
      * Subscription Operations
      *************************************************************************/
-    
+
     function approveSubscriptionTest(
         ISuperfluidToken token,
         address publisher,
@@ -265,7 +265,7 @@ contract IDAv1LibrarySuperAppMock is IDAv1LibraryMock, SuperAppBase {
             SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP |
             SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP;
 
-        host.registerApp(configWord);
+        host.registerAppWithKey(configWord, "");
     }
 
     function afterAgreementCreated(

package/contracts/mocks/MockSmartWallet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ISuperToken, IERC20 } from "../superfluid/Superfluid.sol";
 

package/contracts/mocks/MultiFlowTesterApp.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,
@@ -41,7 +41,7 @@ contract MultiFlowTesterApp is SuperAppBase {
             SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP |
             SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP;
 
-        _host.registerApp(configWord);
+        _host.registerAppWithKey(configWord, "");
     }
 
     function _parseUserData(

package/contracts/mocks/SuperAppMocks.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,
@@ -51,9 +51,9 @@ contract SuperAppMock is ISuperApp {
 
     constructor(ISuperfluid host, uint256 configWord, bool doubleRegistration) {
         _host = host;
-        _host.registerApp(configWord);
+        _host.registerAppWithKey(configWord, "");
         if (doubleRegistration) {
-            _host.registerApp(configWord);
+            _host.registerAppWithKey(configWord, "");
         }
         _aux = new SuperAppMockAux();
     }
@@ -461,7 +461,7 @@ contract SuperAppMockReturningEmptyCtx {
 
     constructor(ISuperfluid host) {
         _host = host;
-        _host.registerApp(SuperAppDefinitions.APP_LEVEL_FINAL);
+        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_FINAL, "");
     }
 
     function beforeAgreementCreated(
@@ -522,7 +522,7 @@ contract SuperAppMockReturningInvalidCtx {
 
     constructor(ISuperfluid host) {
         _host = host;
-        _host.registerApp(SuperAppDefinitions.APP_LEVEL_FINAL);
+        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_FINAL, "");
     }
 
     function afterAgreementCreated(
@@ -563,7 +563,7 @@ contract SuperAppMock2ndLevel {
 
     constructor(ISuperfluid host, SuperAppMock app, AgreementMock agreement) {
         _host = host;
-        _host.registerApp(SuperAppDefinitions.APP_LEVEL_SECOND);
+        _host.registerAppWithKey(SuperAppDefinitions.APP_LEVEL_SECOND, "");
         _app = app;
         _agreement = agreement;
     }
@@ -597,14 +597,17 @@ contract SuperAppMock2ndLevel {
     }
 }
 
-// The default SuperApp mock that does many tricks
+// An Super App that uses registerAppWithKey
 contract SuperAppMockWithRegistrationkey {
-
-    ISuperfluid private _host;
-
     constructor(ISuperfluid host, uint256 configWord, string memory registrationKey) {
-        _host = host;
-        _host.registerAppWithKey(configWord, registrationKey);
+        host.registerAppWithKey(configWord, registrationKey);
+    }
+}
+
+// An Super App that uses registerAppWithKey
+contract SuperAppMockUsingDeprecatedRegisterApp {
+    constructor(ISuperfluid host, uint256 configWord) {
+        host.registerApp(configWord);
     }
 }
 

package/contracts/mocks/SuperTokenFactoryMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { SuperTokenMock } from "./SuperTokenMock.sol";
 import {

package/contracts/mocks/SuperTokenMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,

package/contracts/mocks/SuperfluidDestructorMock.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: AGPLv3
 // solhint-disable
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 contract SuperfluidDestructorMock {
 

package/contracts/mocks/SuperfluidGovernanceIIMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ISuperfluid } from "../interfaces/superfluid/ISuperfluid.sol";
 import { SuperfluidGovernanceII } from "../gov/SuperfluidGovernanceII.sol";

package/contracts/mocks/SuperfluidMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     Superfluid,
@@ -171,7 +171,7 @@ contract SuperfluidMock is Superfluid {
     function jailApp(ISuperApp app)
         external
     {
-        _jailApp(app, 0);
+        _jailApp(app, 6942);
     }
 
 }

package/contracts/mocks/UUPSProxiableMock.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSProxiable } from "../upgradability/UUPSProxiable.sol";
 

package/contracts/superfluid/FullUpgradableSuperTokenProxy.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ISuperTokenFactory } from "../interfaces/superfluid/ISuperTokenFactory.sol";
 import { Proxy } from "@openzeppelin/contracts/proxy/Proxy.sol";
@@ -32,7 +32,7 @@ contract FullUpgradableSuperTokenProxy is Proxy {
         assembly { // solium-disable-line
             factory := sload(_FACTORY_SLOT)
         }
-        require(address(factory) != address(0), "Not initialized");
+        assert(address(factory) != address(0));
         return address(factory.getSuperTokenLogic());
     }
 

package/contracts/superfluid/SuperToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSProxiable } from "../upgradability/UUPSProxiable.sol";
 

package/contracts/superfluid/SuperTokenFactory.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperTokenFactory,

package/contracts/superfluid/Superfluid.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 
@@ -255,7 +255,7 @@ contract Superfluid is
         external view override
         returns (address logic)
     {
-        if (address(_superTokenFactory) == address(0)) return address(0);
+        assert(address(_superTokenFactory) != address(0));
         if (NON_UPGRADABLE_DEPLOYMENT) return address(_superTokenFactory);
         else return UUPSProxiable(address(_superTokenFactory)).getCodeAddress();
     }
@@ -1076,9 +1076,9 @@ contract Superfluid is
         if (actionSelector == ISuperApp.beforeAgreementCreated.selector ||
             actionSelector == ISuperApp.afterAgreementCreated.selector ||
             actionSelector == ISuperApp.beforeAgreementUpdated.selector ||
-            actionSelector == ISuperApp.afterAgreementCreated.selector ||
+            actionSelector == ISuperApp.afterAgreementUpdated.selector ||
             actionSelector == ISuperApp.beforeAgreementTerminated.selector ||
-            actionSelector == ISuperApp.afterAgreementCreated.selector) {
+            actionSelector == ISuperApp.afterAgreementTerminated.selector) {
             revert("SF: agreement callback is not action");
         }
         _;

package/contracts/superfluid/SuperfluidToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ISuperfluid } from "../interfaces/superfluid/ISuperfluid.sol";
 import { ISuperAgreement } from "../interfaces/superfluid/ISuperAgreement.sol";

package/contracts/tokens/MaticBridgedNativeSuperToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperToken,

package/contracts/tokens/PureSuperToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperToken,

package/contracts/tokens/SETH.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperToken,

package/contracts/upgradability/UUPSProxiable.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSUtils } from "./UUPSUtils.sol";
 import { Initializable } from "@openzeppelin/contracts/proxy/utils/Initializable.sol";

package/contracts/upgradability/UUPSProxy.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSUtils } from "./UUPSUtils.sol";
 import { Proxy } from "@openzeppelin/contracts/proxy/Proxy.sol";

package/contracts/upgradability/UUPSUtils.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 /**
  * @title UUPS (Universal Upgradeable Proxy Standard) Shared Library

package/contracts/utils/BatchLiquidator.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ISuperfluid, ISuperAgreement, ISuperToken } from "../interfaces/superfluid/ISuperfluid.sol";
 import { IConstantFlowAgreementV1 } from "../interfaces/agreements/IConstantFlowAgreementV1.sol";

package/contracts/utils/Resolver.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { AccessControlEnumerable } from "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
 import { IResolver } from "../interfaces/utils/IResolver.sol";

package/contracts/utils/SuperUpgrader.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
@@ -39,7 +39,7 @@ contract SuperUpgrader is AccessControlEnumerable {
     /**
      * @notice The user should ERC20.approve this contract.
      * @dev Execute upgrade function in the name of the user
-     * @param superTokenAddr Super Token Address to upgrade 
+     * @param superTokenAddr Super Token Address to upgrade
      * @param account User address that previous approved this contract.
      * @param amount Amount value to be upgraded.
      */
@@ -50,7 +50,7 @@ contract SuperUpgrader is AccessControlEnumerable {
     )
     external
     {
-        require(msg.sender == account || 
+        require(msg.sender == account ||
             (hasRole(BACKEND_ROLE, msg.sender) &&
             !_optout[account])
         , "operation not allowed");
@@ -69,14 +69,14 @@ contract SuperUpgrader is AccessControlEnumerable {
     }
 
     /**
-     * @dev Test if account is member BACKEND_ROLE 
+     * @dev Test if account is member BACKEND_ROLE
      */
     function isBackendAgent(address account) external view returns(bool yes) {
         return hasRole(BACKEND_ROLE, account);
     }
 
     /**
-     * @dev Add account to BACKEND_ROLE 
+     * @dev Add account to BACKEND_ROLE
      */
     function grantBackendAgent(address account) external {
         require(account != address(0), "operation not allowed");
@@ -85,7 +85,7 @@ contract SuperUpgrader is AccessControlEnumerable {
     }
 
     /**
-     * @dev Remove account to BACKEND_ROLE 
+     * @dev Remove account to BACKEND_ROLE
      */
     function revokeBackendAgent(address account) external {
         // grantRole will check if sender is adminRole member

package/contracts/utils/SuperfluidLoader.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { IResolver } from "../interfaces/utils/IResolver.sol";
 import {

package/contracts/utils/TOGA.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 

package/contracts/utils/TestGovernance.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,
@@ -12,7 +12,7 @@ import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 
 /**
  * @title Test governance contract
- * @author Superfluid 
+ * @author Superfluid
  * @dev A initializable version of the governance for testing purpose
  */
 contract TestGovernance is

package/contracts/utils/TestToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
@@ -23,7 +23,7 @@ contract TestToken is ERC20 {
      * @dev See {ERC20-_mint}.
      */
     function mint(address account, uint256 amount) public returns (bool) {
-        require(amount <= MINT_LIMIT, "Don't mint too many");
+        assert(amount <= MINT_LIMIT); // no revert msg for you, bad boy
         ERC20._mint(account, amount);
         return true;
     }

package/contracts/utils/TokenCustodian.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { IERC777 } from "@openzeppelin/contracts/token/ERC777/IERC777.sol";
 import { IERC1820Registry } from "@openzeppelin/contracts/utils/introspection/IERC1820Registry.sol";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.2.3-dev.f94fdbb.0",
+    "version": "1.3.1-dev.b8455ea.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -51,12 +51,13 @@
         "pre-commit": "if [ ! -z \"$(git status -s .)\" ];then run-s pre-commit:*;else true;fi",
         "pre-commit:lint": "yarn lint",
         "check-updates": "ncu --target minor --dep prod,dev",
-        "cloc": "bash tasks/cloc.sh"
+        "cloc": "bash tasks/cloc.sh",
+        "docgen": "rm -rf docs/api; hardhat docgen"
     },
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@openzeppelin/contracts": "4.5.0",
-        "@superfluid-finance/js-sdk": "^0.6.2-dev.f94fdbb.0",
+        "@superfluid-finance/js-sdk": "^0.6.2-dev.b8455ea.0",
         "@truffle/contract": "4.5.5",
         "ethereumjs-tx": "2.1.2",
         "ethereumjs-util": "7.1.4",
@@ -72,6 +73,7 @@
         "readline": "1.3.0",
         "solhint": "3.3.7",
         "solidity-coverage": "0.7.20",
+        "solidity-docgen": "^0.6.0-beta.10",
         "truffle-flattener": "^1.6.0",
         "truffle-plugin-verify": "^0.5.25"
     }