@superfluid-finance/ethereum-contracts 1.5.2-dev.a97f248.0 → 1.5.2-dev.fe6f63e.0

package/contracts/mocks/CFAAppMocks.sol

@@ -1,361 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import {
-    ISuperfluid,
-    ISuperToken,
-    SuperAppBase,
-    SuperAppDefinitions
-} from "../apps/SuperAppBase.sol";
-import { IConstantFlowAgreementV1 } from "../interfaces/agreements/IConstantFlowAgreementV1.sol";
-
-/**
- * @dev This is a CFA SuperApp that maintains at most one inflow from a sender at any moment.
- *
- * This can test the deposit credit logic in the deleteFlow as a recipient.
- */
-contract ExclusiveInflowTestApp is SuperAppBase {
-
-    IConstantFlowAgreementV1 private _cfa;
-    ISuperfluid private _host;
-    address private _currentSender;
-
-    constructor(IConstantFlowAgreementV1 cfa, ISuperfluid superfluid) {
-        assert(address(cfa) != address(0));
-        assert(address(superfluid) != address(0));
-        _cfa = cfa;
-        _host = superfluid;
-
-        uint256 configWord =
-            SuperAppDefinitions.APP_LEVEL_FINAL
-            | SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
-            ;
-
-        _host.registerAppWithKey(configWord, "");
-    }
-
-    function afterAgreementCreated(
-        ISuperToken superToken,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata /*agreementData*/,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        newCtx = ctx;
-        ISuperfluid.Context memory context = _host.decodeCtx(ctx);
-        if (_currentSender != address(0)) {
-            bytes memory callData = abi.encodeCall(
-                _cfa.deleteFlow,
-                (
-                    superToken,
-                    _currentSender,
-                    address(this),
-                    new bytes(0)
-                )
-            );
-            (newCtx, ) = _host.callAgreementWithContext(
-                _cfa,
-                callData,
-                new bytes(0), // user data
-                newCtx
-            );
-        }
-        _currentSender = context.msgSender;
-    }
-
-    function afterAgreementTerminated(
-        ISuperToken /*superToken*/,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata agreementData,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        (address flowSender, ) = abi.decode(agreementData, (address, address));
-        assert(flowSender == _currentSender);
-        _currentSender = address(0);
-        return ctx;
-    }
-
-}
-
-/**
- * @dev This is CFA SuperApp that refuses to close its outflow by its receiver.
- *
- * This test the logic that the app re-opens the same stream in the termination callback.
- * In reality, the app would have to fund the app with enough tokens to not to be jailed due
- * to low balance.
- */
-contract NonClosableOutflowTestApp is SuperAppBase {
-
-    IConstantFlowAgreementV1 private _cfa;
-    ISuperfluid private _host;
-    address private _receiver;
-    int96 private _flowRate;
-
-    constructor(IConstantFlowAgreementV1 cfa, ISuperfluid superfluid) {
-        assert(address(cfa) != address(0));
-        assert(address(superfluid) != address(0));
-        _cfa = cfa;
-        _host = superfluid;
-
-        uint256 configWord =
-            SuperAppDefinitions.APP_LEVEL_FINAL
-            | SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
-            ;
-
-        _host.registerAppWithKey(configWord, "");
-    }
-
-    function setupOutflow(
-        ISuperToken superToken,
-        address receiver,
-        int96 flowRate
-    )
-        external
-    {
-        _receiver = receiver;
-        _flowRate = flowRate;
-        _host.callAgreement(
-            _cfa,
-            abi.encodeCall(
-                _cfa.createFlow,
-                (
-                    superToken,
-                    receiver,
-                    flowRate,
-                    new bytes(0)
-                )
-            ),
-            new bytes(0) // user data
-        );
-    }
-
-    function afterAgreementTerminated(
-        ISuperToken superToken,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata agreementData,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        (address flowSender, address flowReceiver) = abi.decode(agreementData, (address, address));
-        assert(flowSender == address(this));
-        assert(flowReceiver == _receiver);
-
-        // moved out to avoid stack too deep error
-        bytes memory callData = abi.encodeCall(
-            _cfa.createFlow,
-            (
-                superToken,
-                flowReceiver,
-                _flowRate,
-                new bytes(0)
-            )
-        );
-
-        // recreate the flow
-        (newCtx, ) = _host.callAgreementWithContext(
-            _cfa,
-            callData,
-            "0x",
-            ctx
-        );
-    }
-}
-
-/**
- * @dev This is CFA SuperApp that refuses to accept any opening flow without reverting them.
- */
-contract SelfDeletingFlowTestApp is SuperAppBase {
-
-    IConstantFlowAgreementV1 private _cfa;
-    ISuperfluid private _host;
-    address private _receiver;
-    int96 private _flowRate;
-
-    constructor(IConstantFlowAgreementV1 cfa, ISuperfluid superfluid) {
-        assert(address(cfa) != address(0));
-        assert(address(superfluid) != address(0));
-        _cfa = cfa;
-        _host = superfluid;
-
-        uint256 configWord =
-            SuperAppDefinitions.APP_LEVEL_FINAL
-            | SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
-            ;
-
-        _host.registerAppWithKey(configWord, "");
-    }
-
-    function afterAgreementCreated(
-        ISuperToken superToken,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata /*agreementData*/,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        newCtx = ctx;
-        ISuperfluid.Context memory context = _host.decodeCtx(ctx);
-        (newCtx, ) = _host.callAgreementWithContext(
-            _cfa,
-            abi.encodeCall(
-                _cfa.deleteFlow,
-                (
-                    superToken,
-                    context.msgSender,
-                    address(this),
-                    new bytes(0)
-                )
-            ),
-            new bytes(0), // user data
-            newCtx
-        );
-    }
-}
-
-/**
- * @dev This is CFA SuperApp that closes an updated flow.
- */
-contract ClosingOnUpdateFlowTestApp is SuperAppBase {
-
-    IConstantFlowAgreementV1 private _cfa;
-    ISuperfluid private _host;
-
-    constructor(IConstantFlowAgreementV1 cfa, ISuperfluid superfluid) {
-        assert(address(cfa) != address(0));
-        assert(address(superfluid) != address(0));
-        _cfa = cfa;
-        _host = superfluid;
-
-        uint256 configWord =
-            SuperAppDefinitions.APP_LEVEL_FINAL
-            | SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_UPDATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
-            ;
-
-        _host.registerAppWithKey(configWord, "");
-    }
-
-    function afterAgreementUpdated(
-        ISuperToken superToken,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata /*agreementData*/,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        newCtx = ctx;
-        ISuperfluid.Context memory context = _host.decodeCtx(ctx);
-        (newCtx, ) = _host.callAgreementWithContext(
-            _cfa,
-            abi.encodeCall(
-                _cfa.deleteFlow,
-                (
-                    superToken,
-                    context.msgSender,
-                    address(this),
-                    new bytes(0)
-                )
-            ),
-            new bytes(0), // user data
-            newCtx
-        );
-    }
-}
-
-contract FlowExchangeTestApp is SuperAppBase {
-
-    IConstantFlowAgreementV1 private _cfa;
-    ISuperfluid private _host;
-    ISuperToken private _targetToken;
-
-    constructor(
-        IConstantFlowAgreementV1 cfa,
-        ISuperfluid superfluid,
-        ISuperToken targetToken) {
-        assert(address(cfa) != address(0));
-        assert(address(superfluid) != address(0));
-        _cfa = cfa;
-        _host = superfluid;
-        _targetToken = targetToken;
-
-        uint256 configWord =
-            SuperAppDefinitions.APP_LEVEL_FINAL
-            | SuperAppDefinitions.BEFORE_AGREEMENT_CREATED_NOOP
-            // | SuperAppDefinitions.AFTER_AGREEMENT_CREATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_UPDATED_NOOP
-            | SuperAppDefinitions.BEFORE_AGREEMENT_TERMINATED_NOOP
-            | SuperAppDefinitions.AFTER_AGREEMENT_TERMINATED_NOOP
-            ;
-
-        _host.registerAppWithKey(configWord, "");
-    }
-
-    function afterAgreementCreated(
-        ISuperToken superToken,
-        address /*agreementClass*/,
-        bytes32 /*agreementId*/,
-        bytes calldata /*agreementData*/,
-        bytes calldata /*cbdata*/,
-        bytes calldata ctx
-    )
-        external override
-        returns(bytes memory newCtx)
-    {
-        newCtx = ctx;
-        ISuperfluid.Context memory context = _host.decodeCtx(ctx);
-        (,int96 flowRate,,) = _cfa.getFlow(superToken, context.msgSender, address(this));
-        (newCtx, ) = _host.callAgreementWithContext(
-            _cfa,
-            abi.encodeCall(
-                _cfa.createFlow,
-                (
-                    _targetToken,
-                    context.msgSender,
-                    flowRate,
-                    new bytes(0)
-                )
-            ),
-            new bytes(0), // user data
-            newCtx
-        );
-    }
-}

package/contracts/mocks/CFAHookMocks.sol

@@ -1,148 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity ^0.8.0;
-
-import { IConstantFlowAgreementHook } from "../interfaces/agreements/IConstantFlowAgreementHook.sol";
-import { ISuperfluidToken } from "../interfaces/superfluid/ISuperfluidToken.sol";
-import { ConstantFlowAgreementV1 } from "../agreements/ConstantFlowAgreementV1.sol";
-
-/// @title BaseCFAHookMock abstract contract
-/// @author Superfluid
-/// @notice An abstract contract with functionality inherited by both hook mocks
-/// @dev This should provide a good starting point of some of the properties the CFAHook contract should have
-abstract contract BaseCFAHookMock is IConstantFlowAgreementHook {
-    ConstantFlowAgreementV1 internal cfaV1;
-    address internal immutable owner;
-
-    // Custom Errors
-    error NOT_CFA();
-    error NOT_OWNER();
-
-    modifier onlyCFA() {
-        if (msg.sender != address(cfaV1)) revert NOT_CFA();
-        _;
-    }
-
-    modifier onlyOwner() {
-        if (msg.sender != owner) revert NOT_OWNER();
-        _;
-    }
-
-    constructor() {
-        owner = msg.sender;
-    }
-
-    /// @notice Sets the CFA contract which can call the hooks
-    /// @dev Only the owner of the contract can set the CFA contract
-    /// @param _cfaV1 address of cfav1 contract
-    function setCFA(ConstantFlowAgreementV1 _cfaV1) external onlyOwner {
-        cfaV1 = _cfaV1;
-    }
-}
-
-/// @title GoodCFAHookMock contract
-/// @author Superfluid
-/// @dev A "good" mock contract which just emits an event in the hooks and returns true
-contract GoodCFAHookMock is BaseCFAHookMock {
-    event OnCreateEvent(
-        ISuperfluidToken token,
-        address sender,
-        address receiver,
-        address flowOperator,
-        int96 flowRate
-    );
-    event OnUpdateEvent(
-        ISuperfluidToken token,
-        address sender,
-        address receiver,
-        address flowOperator,
-        int96 flowRate,
-        int96 oldFlowRate
-    );
-    event OnDeleteEvent(
-        ISuperfluidToken token,
-        address sender,
-        address receiver,
-        address flowOperator,
-        int96 flowRate,
-        int96 oldFlowRate
-    );
-
-    function onCreate(
-        ISuperfluidToken token,
-        IConstantFlowAgreementHook.CFAHookParams memory newFlowData
-    ) external onlyCFA returns (bool) {
-        emit OnCreateEvent(
-            token,
-            newFlowData.sender,
-            newFlowData.receiver,
-            newFlowData.flowOperator,
-            newFlowData.flowRate
-        );
-
-        return true;
-    }
-
-    function onUpdate(
-        ISuperfluidToken token,
-        IConstantFlowAgreementHook.CFAHookParams memory newFlowData,
-        int96 oldFlowRate
-    ) external onlyCFA returns (bool) {
-        emit OnUpdateEvent(
-            token,
-            newFlowData.sender,
-            newFlowData.receiver,
-            newFlowData.flowOperator,
-            newFlowData.flowRate,
-            oldFlowRate
-        );
-
-        return true;
-    }
-
-    function onDelete(
-        ISuperfluidToken token,
-        IConstantFlowAgreementHook.CFAHookParams memory newFlowData,
-        int96 oldFlowRate
-    ) external onlyCFA returns (bool) {
-        emit OnDeleteEvent(
-            token,
-            newFlowData.sender,
-            newFlowData.receiver,
-            newFlowData.flowOperator,
-            newFlowData.flowRate,
-            oldFlowRate
-        );
-
-        return true;
-    }
-}
-
-/// @title BadCFAHookMock contract
-/// @author Superfluid
-/// @dev A "bad" mock contract which just reverts
-contract BadCFAHookMock is BaseCFAHookMock {
-    error BAD_HOOK();
-
-    function onCreate(
-        ISuperfluidToken, // token
-        IConstantFlowAgreementHook.CFAHookParams memory // newFlowData,
-    ) external view onlyCFA returns (bool) {
-        revert BAD_HOOK();
-    }
-
-    function onUpdate(
-        ISuperfluidToken, // token,
-        IConstantFlowAgreementHook.CFAHookParams memory, // newFlowData,
-        int96 // oldFlowRate
-    ) external view onlyCFA returns (bool) {
-        revert BAD_HOOK();
-    }
-
-    function onDelete(
-        ISuperfluidToken, // token,
-        IConstantFlowAgreementHook.CFAHookParams memory, // newFlowData,
-        int96 // oldFlowRate
-    ) external view onlyCFA returns (bool) {
-        revert BAD_HOOK();
-    }
-}