@superfluid-finance/ethereum-contracts 1.3.2-dev.75a0001.0 → 1.3.2-dev.bf84335.0

package/contracts/mocks/StreamRedirector.sol

@@ -0,0 +1,179 @@
+// SPDX-License-Identifier: AGPLv3
+pragma solidity 0.8.14;
+
+import { ISuperfluid, ISuperToken, SuperAppBase, ISuperApp, SuperAppDefinitions } from "../apps/SuperAppBase.sol";
+import { CFAv1Library } from "../apps/CFAv1Library.sol";
+import { IConstantFlowAgreementV1 } from "../interfaces/agreements/IConstantFlowAgreementV1.sol";
+import { ISuperAgreement } from "../interfaces/superfluid/ISuperfluid.sol";
+
+contract StreamRedirector is SuperAppBase {
+    using CFAv1Library for CFAv1Library.InitData;
+    CFAv1Library.InitData public cfaV1;
+    ISuperfluid public host;
+    bytes32 public constant CFA_ID =
+        keccak256("org.superfluid-finance.agreements.ConstantFlowAgreement.v1");
+    address public receiver; // flow is redirected to hardcoded receiver address
+    ISuperToken public token; // accepted super token
+
+    constructor(
+        ISuperfluid _host,
+        ISuperToken _token,
+        address _receiver,
+        uint256 _appLevel
+    ) {
+        assert(address(_token) != address(0));
+        assert(address(_receiver) != address(0));
+        assert(address(_host) != address(0));
+
+        host = _host;
+
+        cfaV1 = CFAv1Library.InitData(
+            host,
+            IConstantFlowAgreementV1(address(host.getAgreementClass(CFA_ID)))
+        );
+
+        uint256 configWord = _appLevel |
+            SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP |
+            SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP;
+
+        token = _token;
+        receiver = _receiver;
+
+        host.registerAppWithKey(configWord, "");
+    }
+
+    /**
+     * Custom Errors
+     */
+    error OnlyHost();
+    error OnlyCFA();
+    error UnsupportedToken();
+
+    /**
+     * Creates a stream from an _originAccount who has granted this SuperApp ACL permissions
+     * to this SuperApp.
+     * @param _originAccount ACL permissions granter
+     * @param _flowRate desired flow rate
+     */
+    function startStreamToSelf(address _originAccount, int96 _flowRate) public {
+        cfaV1.createFlowByOperator(
+            _originAccount,
+            address(this),
+            token,
+            _flowRate
+        );
+    }
+
+    /**
+     * Terminates a stream from an _originAccount who has granted this SuperApp ACL permissions
+     * @param _originAccount ACL permissions granter
+     */
+    function stopStreamToSelf(address _originAccount) public {
+        cfaV1.deleteFlowByOperator(_originAccount, address(this), token);
+    }
+
+    /**
+     * Creates a stream from this Super App to another SuperApp.
+     * @param _superApp the targeted super app
+     * @param _flowRate desired flow rate
+     */
+    function startStreamToSuperApp(address _superApp, int96 _flowRate) public {
+        cfaV1.createFlow(_superApp, token, _flowRate);
+    }
+
+    /**
+     * Delete a stream from sender to receiver.
+     * @param _sender the sender super app
+     * @param _receiver the receiver super app
+     */
+    function stopStreamToSuperApp(address _sender, address _receiver) public {
+        cfaV1.deleteFlow(_sender, _receiver, token);
+    }
+
+    /**
+     * A callback which occurs after CF agreement creation which redirects a stream.
+     */
+    function afterAgreementCreated(
+        ISuperToken _superToken,
+        address _agreementClass,
+        bytes32, // agreementId,
+        bytes calldata, // agreementData,
+        bytes calldata, // cbdata,
+        bytes calldata _ctx
+    )
+        external
+        override
+        onlyHost
+        onlySupportedSuperToken(_superToken)
+        onlyCFA(_agreementClass)
+        returns (bytes memory newCtx)
+    {
+        newCtx = _ctx;
+        int96 netFlowRate = cfaV1.cfa.getNetFlow(_superToken, address(this));
+        newCtx = cfaV1.createFlowWithCtx(
+            newCtx,
+            receiver,
+            _superToken,
+            netFlowRate
+        );
+    }
+
+    function afterAgreementTerminated(
+        ISuperToken _superToken,
+        address _agreementClass,
+        bytes32, // _agreementId,
+        bytes calldata, // calldata _agreementData,
+        bytes calldata, // calldata _cbdata,
+        bytes calldata _ctx
+    ) external override onlyHost returns (bytes memory newCtx) {
+        if (!_isCFAv1(_agreementClass) || address(_superToken) != address(token)) {
+            return _ctx;
+        }
+
+        newCtx = _ctx;
+        (, int96 currentFlowRate, , ) = cfaV1.cfa.getFlow(
+            _superToken,
+            address(this),
+            receiver
+        );
+
+        if (currentFlowRate > 0) {
+            newCtx = cfaV1.deleteFlowWithCtx(
+                newCtx,
+                address(this),
+                receiver,
+                _superToken
+            );
+        }
+    }
+
+    /**
+     * Alleviates the composite app rule by allowing this app to call
+     * the target app.
+     * @param _targetApp address of the target super app, should be initialized with final_level
+     */
+    function allowCompositeApp(address _targetApp) public {
+        host.allowCompositeApp(ISuperApp(_targetApp));
+    }
+
+    function _isCFAv1(address agreementClass) private view returns (bool) {
+        return ISuperAgreement(agreementClass).agreementType() == CFA_ID;
+    }
+
+    /**
+     * Modifiers
+     */
+    modifier onlyHost() {
+        if (msg.sender != address(host)) revert OnlyHost();
+        _;
+    }
+    modifier onlySupportedSuperToken(ISuperToken _superToken) {
+        if (address(_superToken) != address(token)) revert UnsupportedToken();
+        _;
+    }
+
+    modifier onlyCFA(address agreementClass) {
+        if (!_isCFAv1(agreementClass)) revert OnlyCFA();
+        _;
+    }
+}

package/contracts/mocks/SuperAppMocks.sol

@@ -10,7 +10,6 @@ import {
 } from "../superfluid/Superfluid.sol";
 import { AgreementMock } from "./AgreementMock.sol";
 
-
 contract SuperAppMockAux {
 
     function actionPingAgreement(ISuperfluid host, AgreementMock agreement, uint256 ping, bytes calldata ctx)
@@ -78,7 +77,7 @@ contract SuperAppMock is ISuperApp {
     function actionNoop(bytes calldata ctx) external requireValidCtx(ctx) returns (bytes memory newCtx) {
         ISuperfluid.Context memory context = ISuperfluid(msg.sender).decodeCtx(ctx);
         emit NoopEvent(
-            context.appLevel,
+            context.appCallbackLevel,
             context.callType,
             context.agreementSelector);
         return ctx;
@@ -92,7 +91,7 @@ contract SuperAppMock is ISuperApp {
         ISuperfluid.Context memory context = ISuperfluid(msg.sender).decodeCtx(ctx);
         assert(context.msgSender == expectedMsgSender);
         emit NoopEvent(
-            context.appLevel,
+            context.appCallbackLevel,
             context.callType,
             context.agreementSelector);
         return ctx;
@@ -326,7 +325,7 @@ contract SuperAppMock is ISuperApp {
         ISuperfluid.Context memory context = ISuperfluid(msg.sender).decodeCtx(ctx);
         if (_nextCallbackAction.actionType == NextCallbackActionType.Noop) {
             emit NoopEvent(
-                context.appLevel,
+                context.appCallbackLevel,
                 context.callType,
                 context.agreementSelector);
             return ctx;

package/contracts/mocks/SuperfluidMock.sol

@@ -52,11 +52,11 @@ contract SuperfluidUpgradabilityTester is Superfluid {
     function validateContextStructLayout()
         external pure
     {
-        // context.appLevel
+        // context.appCallbackLevel
         {
             Context memory context;
             assembly { mstore(add(context, mul(32, 0)), 42) }
-            require(context.appLevel == 42, "appLevel changed location");
+            require(context.appCallbackLevel == 42, "appLevel changed location");
         }
         // context.callType
         {

package/contracts/superfluid/Superfluid.sol

@@ -62,7 +62,7 @@ contract Superfluid is
      *   will not be able to call other app.
      */
     // solhint-disable-next-line var-name-mixedcase
-    uint immutable public MAX_APP_LEVEL = 1;
+    uint immutable public MAX_APP_CALLBACK_LEVEL = 1;
 
     // solhint-disable-next-line var-name-mixedcase
     uint64 immutable public CALLBACK_GAS_LIMIT = 3000000;
@@ -370,7 +370,7 @@ contract Superfluid is
         }
         require(
             SuperAppDefinitions.isConfigWordClean(configWord) &&
-            SuperAppDefinitions.getAppLevel(configWord) > 0 &&
+            SuperAppDefinitions.getAppCallbackLevel(configWord) > 0 &&
             (configWord & SuperAppDefinitions.APP_JAIL_BIT) == 0,
             "SF: invalid config word");
         require(_appManifests[ISuperApp(app)].configWord == 0 , "SF: app already registered");
@@ -382,8 +382,8 @@ contract Superfluid is
         return _appManifests[app].configWord > 0;
     }
 
-    function getAppLevel(ISuperApp appAddr) public override view returns(uint8) {
-        return SuperAppDefinitions.getAppLevel(_appManifests[appAddr].configWord);
+    function getAppCallbackLevel(ISuperApp appAddr) public override view returns(uint8) {
+        return SuperAppDefinitions.getAppCallbackLevel(_appManifests[appAddr].configWord);
     }
 
     function getAppManifest(
@@ -421,7 +421,10 @@ contract Superfluid is
         ISuperApp sourceApp = ISuperApp(msg.sender);
         require(isApp(sourceApp), "SF: sender is not an app");
         require(isApp(targetApp), "SF: target is not an app");
-        require(getAppLevel(sourceApp) > getAppLevel(targetApp), "SF: source app should have higher app level");
+        require(
+            getAppCallbackLevel(sourceApp) > getAppCallbackLevel(targetApp),
+            "SF: source app should have higher app level"
+        );
         _compositeApps[ISuperApp(msg.sender)][targetApp] = true;
     }
 
@@ -514,11 +517,13 @@ contract Superfluid is
         returns (bytes memory appCtx)
     {
         Context memory context = decodeCtx(ctx);
-        if (isApp(ISuperApp(context.msgSender))) {
+        // NOTE: we use 1 as a magic number here as we want to do this check once we are in a callback
+        // we use 1 instead of MAX_APP_CALLBACK_LEVEL because 1 captures what we are trying to enforce
+        if (isApp(ISuperApp(context.msgSender)) && context.appCallbackLevel >= 1) {
             require(_compositeApps[ISuperApp(context.msgSender)][app],
                 "SF: APP_RULE_COMPOSITE_APP_IS_NOT_WHITELISTED");
         }
-        context.appLevel++;
+        context.appCallbackLevel++;
         context.callType = ContextDefinitions.CALL_INFO_CALL_TYPE_APP_CALLBACK;
         context.appAllowanceGranted = appAllowanceGranted;
         context.appAllowanceWanted = 0;
@@ -588,12 +593,12 @@ contract Superfluid is
         isAgreement(agreementClass)
         returns(bytes memory returnedData)
     {
-        // beaware of the endiness
+        // beware of the endianness
         bytes4 agreementSelector = CallUtils.parseSelector(callData);
 
         //Build context data
-        bytes memory  ctx = _updateContext(Context({
-            appLevel: isApp(ISuperApp(msgSender)) ? 1 : 0,
+        bytes memory ctx = _updateContext(Context({
+            appCallbackLevel: 0,
             callType: ContextDefinitions.CALL_INFO_CALL_TYPE_AGREEMENT,
             timestamp: getNow(),
             msgSender: msgSender,
@@ -636,9 +641,9 @@ contract Superfluid is
         isValidAppAction(callData)
         returns(bytes memory returnedData)
     {
-        //Build context data
+        // Build context data
         bytes memory ctx = _updateContext(Context({
-            appLevel: isApp(ISuperApp(msgSender)) ? 1 : 0,
+            appCallbackLevel: 0,
             callType: ContextDefinitions.CALL_INFO_CALL_TYPE_APP_ACTION,
             timestamp: getNow(),
             msgSender: msgSender,
@@ -861,8 +866,8 @@ contract Superfluid is
         private
         returns (bytes memory ctx)
     {
-        require(context.appLevel <= MAX_APP_LEVEL, "SF: APP_RULE_MAX_APP_LEVEL_REACHED");
-        uint256 callInfo = ContextDefinitions.encodeCallInfo(context.appLevel, context.callType);
+        require(context.appCallbackLevel <= MAX_APP_CALLBACK_LEVEL, "SF: APP_RULE_MAX_APP_LEVEL_REACHED");
+        uint256 callInfo = ContextDefinitions.encodeCallInfo(context.appCallbackLevel, context.callType);
         uint256 allowanceIO =
             context.appAllowanceGranted.toUint128() |
             (uint256(context.appAllowanceWanted.toUint128()) << 128);
@@ -906,7 +911,7 @@ contract Superfluid is
                 address,
                 bytes4,
                 bytes));
-            (context.appLevel, context.callType) = ContextDefinitions.decodeCallInfo(callInfo);
+            (context.appCallbackLevel, context.callType) = ContextDefinitions.decodeCallInfo(callInfo);
         }
         {
             uint256 allowanceIO;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.3.2-dev.75a0001.0",
+    "version": "1.3.2-dev.bf84335.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -36,7 +36,7 @@
         "testenv:deploy": "yarn run-truffle exec scripts/deploy-test-environment.js : TEST",
         "pretest": "{ yarn testenv:start > /dev/null& } && sleep 5",
         "test": "run-s test:*:*",
-        "test:contracts:hardhat": "yarn run-hardhat test testsuites/all-contracts.js --parallel",
+        "test:contracts:hardhat": "yarn run-hardhat test testsuites/all-contracts.js",
         "test:contracts:foundry": "yarn run-forge test --hardhat",
         "test:contracts:solc-0.8.0-compatibility": "test/test-solc-0.8.0-compatibility.sh",
         "test:deployment:scripts-js-hardhat": "yarn run-hardhat test test/scripts/deployment.test.js",
@@ -57,7 +57,7 @@
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@openzeppelin/contracts": "4.7.0",
-        "@superfluid-finance/js-sdk": "^0.6.3-dev.75a0001.0",
+        "@superfluid-finance/js-sdk": "^0.6.3-dev.bf84335.0",
         "@truffle/contract": "4.5.15",
         "ethereumjs-tx": "2.1.2",
         "ethereumjs-util": "7.1.5",

package/scripts/deploy-test-token.js

@@ -16,7 +16,7 @@ const {
  * @param {Address} options.from Address to deploy contracts from
  * @param {boolean} options.resetToken Reset the token deployment
  *
- * Usage: npx truffle exec scripts/deploy-test-token.js : {TOKEN_SYMBOL}
+ * Usage: npx truffle exec scripts/deploy-test-token.js : {TOKEN_DECIMALS} {TOKEN_SYMBOL}
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
     args,
@@ -25,11 +25,15 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     console.log("======== Deploying test token ========");
     let {resetToken} = options;
 
-    if (args.length !== 1) {
+    // > 2 because decimals is an optional field
+    // symbol should be required though
+    if (args.length > 2 || args.length < 1) {
         throw new Error("Wrong number of arguments");
     }
     const tokenSymbol = args.pop();
     console.log("Token symbol", tokenSymbol);
+    const tokenDecimals = args.pop() || 18;
+    console.log("Token decimals", tokenDecimals);
 
     resetToken = resetToken || !!process.env.RESET_TOKEN;
     console.log("reset token: ", resetToken);
@@ -62,7 +66,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
         const testToken = await web3tx(TestToken.new, "TestToken.new")(
             tokenSymbol + " Fake Token",
             tokenSymbol,
-            18
+            tokenDecimals
         );
         testTokenAddress = testToken.address;
         await web3tx(resolver.set, `Resolver set ${name}`)(