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

package/contracts/mocks/CFALibraryMock.sol

@@ -1,213 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
-
-import {ISuperfluid, ISuperfluidToken, ISuperToken} from "../interfaces/superfluid/ISuperfluid.sol";
-
-import {ISuperApp, ISuperAgreement} from "../interfaces/superfluid/ISuperfluid.sol";
-
-import {ContextDefinitions, SuperAppDefinitions} from "../interfaces/superfluid/ISuperfluid.sol";
-
-import {SuperAppBase} from "../apps/SuperAppBase.sol";
-
-import {IConstantFlowAgreementV1} from "../interfaces/agreements/IConstantFlowAgreementV1.sol";
-
-import {CFAv1Library} from "../apps/CFAv1Library.sol";
-
-contract CFALibraryMock {
-    using CFAv1Library for CFAv1Library.InitData;
-
-    //initialize cfaV1 variable
-    CFAv1Library.InitData public cfaV1;
-
-    constructor(ISuperfluid host) {
-        //initialize InitData struct, and set equal to cfaV1
-        cfaV1 = CFAv1Library.InitData(
-            host,
-            IConstantFlowAgreementV1(
-                address(
-                    host.getAgreementClass(
-                        keccak256(
-                            "org.superfluid-finance.agreements.ConstantFlowAgreement.v1"
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-    function createFlowTest(
-        ISuperfluidToken token,
-        address receiver,
-        int96 flowRate
-    ) public {
-        cfaV1.createFlow(receiver, token, flowRate);
-    }
-
-    function updateFlowTest(
-        ISuperfluidToken token,
-        address receiver,
-        int96 flowRate
-    ) public {
-        cfaV1.updateFlow(receiver, token, flowRate);
-    }
-
-    function deleteFlowTest(ISuperfluidToken token, address receiver) public {
-        cfaV1.deleteFlow(address(this), receiver, token);
-    }
-
-    function createFlowByOperatorTest(
-        address sender,
-        address receiver,
-        ISuperfluidToken token,
-        int96 flowRate
-    ) public {
-        cfaV1.createFlowByOperator(sender, receiver, token, flowRate);
-    }
-
-    function updateFlowByOperatorTest(
-        address sender,
-        address receiver,
-        ISuperfluidToken token,
-        int96 flowRate
-    ) public {
-        cfaV1.updateFlowByOperator(sender, receiver, token, flowRate);
-    }
-
-    function deleteFlowByOperator(
-        address sender,
-        address receiver,
-        ISuperfluidToken token
-    ) public {
-        cfaV1.deleteFlowByOperator(sender, receiver, token);
-    }
-
-    function updateFlowOperatorPermissionsTest(
-        address flowOperator,
-        ISuperfluidToken token,
-        uint8 permissions,
-        int96 flowRateAllowance
-    ) public {
-        cfaV1.updateFlowOperatorPermissions(flowOperator, token, permissions, flowRateAllowance);
-    }
-
-    function authorizeFlowOperatorWithFullControlTest(
-        address flowOperator,
-        ISuperfluidToken token
-    ) public {
-        cfaV1.authorizeFlowOperatorWithFullControl(flowOperator, token);
-    }
-
-    function revokeFlowOperatorWithFullControlTest(
-        address flowOperator,
-        ISuperfluidToken token
-    ) public {
-        cfaV1.revokeFlowOperatorWithFullControl(flowOperator, token);
-    }
-}
-
-contract CFALibrarySuperAppMock is SuperAppBase {
-
-    using CFAv1Library for CFAv1Library.InitData;
-    CFAv1Library.InitData internal cfaV1;
-
-    // default values for smoke tests
-    uint8 internal constant PERMISSIONS = 7;
-    int96 internal constant FLOW_RATE = 1000000000000;
-    int96 internal constant UPDATED_FLOW_RATE = 2000000000000;
-    address internal immutable sender;
-    address internal immutable receiver;
-    address internal immutable flowOperator;
-
-    // for selectively testing functions in the same callback
-    enum FunctionIndex {
-        CREATE_FLOW,
-        UPDATE_FLOW,
-        DELETE_FLOW,
-        CREATE_FLOW_BY_OPERATOR,
-        UPDATE_FLOW_BY_OPERATOR,
-        DELETE_FLOW_BY_OPERATOR,
-        UPDATE_FLOW_OPERATOR_PERMISSIONS,
-        AUTHORIZE_FLOW_OPERATOR_WITH_FULL_CONTROL,
-        REVOKE_FLOW_OPERATOR_WITH_FULL_CONTROL
-    }
-
-    constructor(
-        ISuperfluid host,
-        address defaultSender,
-        address defaultReceiver,
-        address defaultFlowOperator
-    ) {
-        cfaV1 = CFAv1Library.InitData(
-            host,
-            IConstantFlowAgreementV1(
-                address(
-                    host.getAgreementClass(
-                        keccak256(
-                            "org.superfluid-finance.agreements.ConstantFlowAgreement.v1"
-                        )
-                    )
-                )
-            )
-        );
-        sender = defaultSender;
-        receiver = defaultReceiver;
-        flowOperator = defaultFlowOperator;
-
-        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 createFlow(ISuperToken token) external {
-        cfaV1.createFlow(receiver, token, FLOW_RATE);
-    }
-
-    // literally ONLY for the revokeFlowOperatorWithFullControlWithCtx test.
-    function authorizeFlowOperatorWithFullControl(ISuperToken token) external {
-        cfaV1.authorizeFlowOperatorWithFullControl(flowOperator, token);
-    }
-
-    function afterAgreementCreated(
-        ISuperToken token,
-        address,
-        bytes32,
-        bytes calldata,
-        bytes calldata,
-        bytes calldata ctx
-    ) external override returns (bytes memory) {
-        bytes memory userData = cfaV1.host.decodeCtx(ctx).userData;
-        (uint8 functionIndex) = abi.decode(userData, (uint8));
-
-        if (functionIndex == uint8(FunctionIndex.CREATE_FLOW))
-            return cfaV1.createFlowWithCtx(ctx, receiver, token, FLOW_RATE);
-        else if (functionIndex == uint8(FunctionIndex.UPDATE_FLOW))
-            return cfaV1.updateFlowWithCtx(ctx, receiver, token, UPDATED_FLOW_RATE);
-        else if (functionIndex == uint8(FunctionIndex.DELETE_FLOW))
-            return cfaV1.deleteFlowWithCtx(ctx, address(this), receiver, token);
-        else if (functionIndex == uint8(FunctionIndex.CREATE_FLOW_BY_OPERATOR))
-            return cfaV1.createFlowByOperatorWithCtx(ctx, sender, receiver, token, FLOW_RATE);
-        else if (functionIndex == uint8(FunctionIndex.UPDATE_FLOW_BY_OPERATOR))
-            return cfaV1.updateFlowByOperatorWithCtx(ctx, sender, receiver, token, UPDATED_FLOW_RATE);
-        else if (functionIndex == uint8(FunctionIndex.DELETE_FLOW_BY_OPERATOR))
-            return cfaV1.deleteFlowByOperatorWithCtx(ctx, sender, receiver, token);
-        else if (functionIndex == uint8(FunctionIndex.UPDATE_FLOW_OPERATOR_PERMISSIONS))
-            return cfaV1.updateFlowOperatorPermissionsWithCtx(
-                ctx,
-                flowOperator,
-                token,
-                PERMISSIONS,
-                FLOW_RATE
-            );
-        else if (functionIndex == uint8(FunctionIndex.AUTHORIZE_FLOW_OPERATOR_WITH_FULL_CONTROL))
-            return cfaV1.authorizeFlowOperatorWithFullControlWithCtx(ctx, flowOperator, token);
-        else if (functionIndex == uint8(FunctionIndex.REVOKE_FLOW_OPERATOR_WITH_FULL_CONTROL))
-            return cfaV1.revokeFlowOperatorWithFullControlWithCtx(ctx, flowOperator, token);
-        else revert("invalid function index");
-    }
-}

package/contracts/mocks/CallUtilsMock.sol

@@ -1,79 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import { CallUtils } from "../libs/CallUtils.sol";
-
-contract CallUtilsMock {
-    error Custom();
-    error CustomVal(uint256);
-
-    enum Gm { Ngmi }
-
-    uint[] public a;
-    // case 1: catch all
-    function revertEmpty() public pure {
-        // solhint-disable-next-line reason-string
-        revert();
-    }
-    // case 2: (Panic(uint256)) 0x01
-    function revertAssert() public pure {
-        assert(false);
-    }
-    // case 2: (Panic(uint256)) 0x11
-    function revertOverflow() public pure returns(uint) {
-        uint b = type(uint256).max + 1;
-        return b;
-    }
-    // case 2: (Panic(uint256)) 0x12
-    function revertDivByZero() public pure {
-        int z = 0;
-        int b = 0;
-        b = z / b;
-    }
-    // case 2: (Panic(uint256)) 0x21
-    function revertEnum() public pure {
-        uint max = type(uint).max;
-        Gm(max);
-    }
-    // case 2: (Panic(uint256)) 0x31
-    function revertPop() public {
-        a.pop();
-    }
-    // case 2: (Panic(uint256)) 0x32
-    function revertArrayAccess() public view {
-        a[type(uint).max];
-    }
-    // case 2: (Panic(uint256)) 0x41
-    function revertBigArray() public pure returns(uint8[] memory) {
-        uint8[] memory d = new uint8[](type(uint256).max);
-        return d;
-    }
-    // case 2: (Panic(uint256)) 0x51
-    function revertZeroInitializedFunctionPointer() external pure returns (int) {
-        // Variable containing a function pointer
-        function (int, int) internal pure returns (int) funcPtr;
-
-        // This call will fail because funcPtr is still a zero-initialized function pointer
-        return funcPtr(4, 5);
-    }
-
-    // case 3: Error(string)
-    function revertString() public pure {
-        revert("gm");
-    }
-    // case 4: custom errors
-    function revertCustom() public pure {
-        revert Custom();
-    }
-    function revertCustomVal() public pure {
-        revert CustomVal(26);
-    }
-
-    function revertTest(string memory funcSig) public {
-        // solhint-disable-next-line avoid-low-level-calls
-        (bool success, bytes memory data) = address(this).call(abi.encodeWithSignature(funcSig));
-        if (!success) {
-            CallUtils.revertFromReturnedData(data);
-        }
-    }
-}

package/contracts/mocks/CallUtilsTester.sol

@@ -1,14 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import { CallUtils } from "../libs/CallUtils.sol";
-
-contract CallUtilsTester {
-    function testIsValidAbiEncodedBytes() external pure {
-        require(!CallUtils.isValidAbiEncodedBytes(abi.encode(1, 2, 3)), "bad data");
-        require(CallUtils.isValidAbiEncodedBytes(abi.encode(new bytes(0))), "0");
-        require(CallUtils.isValidAbiEncodedBytes(abi.encode(new bytes(1))), "1");
-        require(CallUtils.isValidAbiEncodedBytes(abi.encode(new bytes(32))), "32");
-        require(CallUtils.isValidAbiEncodedBytes(abi.encode(new bytes(33))), "33");
-    }
-}

package/contracts/mocks/CustomSuperTokenMock.sol

@@ -1,104 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import {
-    CustomSuperTokenBase,
-    ISuperToken
-}
-from "../interfaces/superfluid/CustomSuperTokenBase.sol";
-import { UUPSProxy } from "../upgradability/UUPSProxy.sol";
-
-abstract contract CustomSuperTokenBaseMock is CustomSuperTokenBase, UUPSProxy {
-    function getFirstCustomTokenStorageSlot() external pure virtual returns (uint slot);
-
-    function callSelfBurn(
-        address to,
-        uint256 amount,
-        bytes memory userData
-    ) external virtual;
-
-    function callSelfTransferFrom(
-        address holder,
-        address spender,
-        address recipient,
-        uint256 amount
-    ) external virtual;
-
-    function callSelfApproveFor(
-        address account,
-        address spender,
-        uint256 amount
-    ) external virtual;
-}
-
-// solhint-disable-next-line no-empty-blocks
-abstract contract CustomSuperTokenMock is CustomSuperTokenBaseMock, ISuperToken {}
-
-contract CustomSuperTokenProxyMock is CustomSuperTokenBaseMock {
-
-    uint256 private _firstStorageSlot;
-
-    function getFirstCustomTokenStorageSlot() external pure override returns (uint slot) {
-        assembly { slot:= _firstStorageSlot.slot }
-    }
-
-    // this function overrides the default ISuperToken.selfMint behavior
-    function selfMint(
-        address to,
-        uint256 amount,
-        bytes memory userData
-    ) external {
-        // this makes msg.sender to self
-        this.delegatecallSelfMint(to, amount, userData);
-    }
-
-    // this function uses delegatecall to avoid calling shadow mint defined in this contract
-    function delegatecallSelfMint(
-        address to,
-        uint256 amount,
-        bytes memory userData
-    ) external {
-        address logic = _implementation();
-        // solhint-disable-next-line avoid-low-level-calls
-        (bool success, ) = logic.delegatecall(
-            abi.encodeCall(
-                ISuperToken(address(this)).selfMint,
-                (
-                    to,
-                    amount,
-                    userData
-                )
-            )
-        );
-        assert(success);
-    }
-
-    // this function self calls burn
-    function callSelfBurn(
-        address to,
-        uint256 amount,
-        bytes memory userData
-    ) external override {
-        // this makes msg.sender to self
-        ISuperToken(address(this)).selfBurn(to, amount, userData);
-    }
-
-    // this function self calls transferFrom
-    function callSelfTransferFrom(
-        address holder,
-        address spender,
-        address recipient,
-        uint256 amount
-    ) external override {
-        ISuperToken(address(this)).selfTransferFrom(holder, spender, recipient, amount);
-    }
-
-    // this function self calls approveFor
-    function callSelfApproveFor(
-        address account,
-        address spender,
-        uint256 amount
-    ) external override {
-        ISuperToken(address(this)).selfApproveFor(account, spender, amount);
-    }
-}

package/contracts/mocks/ERC777SenderRecipientMock.sol

@@ -1,238 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import "@openzeppelin/contracts/utils/Context.sol";
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import "@openzeppelin/contracts/token/ERC777/IERC777.sol";
-import "@openzeppelin/contracts/token/ERC777/IERC777Sender.sol";
-import "@openzeppelin/contracts/token/ERC777/IERC777Recipient.sol";
-import "@openzeppelin/contracts/utils/introspection/IERC1820Registry.sol";
-import "@openzeppelin/contracts/utils/introspection/ERC1820Implementer.sol";
-
-import {
-    ISuperToken
-} from "../superfluid/SuperToken.sol";
-
-
-contract ERC777SenderRecipientMock is Context, IERC777Sender, IERC777Recipient, ERC1820Implementer {
-    event TokensToSendCalled(
-        address operator,
-        address from,
-        address to,
-        uint256 amount,
-        bytes data,
-        bytes operatorData,
-        address token,
-        uint256 fromBalance,
-        uint256 toBalance
-    );
-
-    event TokensReceivedCalled(
-        address operator,
-        address from,
-        address to,
-        uint256 amount,
-        bytes data,
-        bytes operatorData,
-        address token,
-        uint256 fromBalance,
-        uint256 toBalance
-    );
-
-    bool private _shouldRevertSend;
-    bool private _shouldRevertReceive;
-
-    IERC1820Registry private _erc1820 = IERC1820Registry(0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24);
-
-    bytes32 constant private _TOKENS_SENDER_INTERFACE_HASH = keccak256("ERC777TokensSender");
-    bytes32 constant private _TOKENS_RECIPIENT_INTERFACE_HASH = keccak256("ERC777TokensRecipient");
-
-    function tokensToSend(
-        address operator,
-        address from,
-        address to,
-        uint256 amount,
-        bytes calldata userData,
-        bytes calldata operatorData
-    ) external override {
-        if (_shouldRevertSend) {
-            revert("_shouldRevertSend");
-        }
-
-        IERC777 token = IERC777(_msgSender());
-
-        uint256 fromBalance = token.balanceOf(from);
-        // when called due to burn, to will be the zero address, which will have a balance of 0
-        uint256 toBalance = token.balanceOf(to);
-
-        emit TokensToSendCalled(
-            operator,
-            from,
-            to,
-            amount,
-            userData,
-            operatorData,
-            address(token),
-            fromBalance,
-            toBalance
-        );
-    }
-
-    function tokensReceived(
-        address operator,
-        address from,
-        address to,
-        uint256 amount,
-        bytes calldata userData,
-        bytes calldata operatorData
-    ) external override {
-        if (_shouldRevertReceive) {
-            revert("_shouldRevertReceive");
-        }
-
-        IERC777 token = IERC777(_msgSender());
-
-        uint256 fromBalance = token.balanceOf(from);
-        // when called due to burn, to will be the zero address, which will have a balance of 0
-        uint256 toBalance = token.balanceOf(to);
-
-        emit TokensReceivedCalled(
-            operator,
-            from,
-            to,
-            amount,
-            userData,
-            operatorData,
-            address(token),
-            fromBalance,
-            toBalance
-        );
-    }
-
-    function senderFor(address account) public {
-        _registerInterfaceForAddress(_TOKENS_SENDER_INTERFACE_HASH, account);
-
-        address self = address(this);
-        if (account == self) {
-            registerSender(self);
-        }
-    }
-
-    function registerSender(address sender) public {
-        _erc1820.setInterfaceImplementer(address(this), _TOKENS_SENDER_INTERFACE_HASH, sender);
-    }
-
-    function recipientFor(address account) public {
-        _registerInterfaceForAddress(_TOKENS_RECIPIENT_INTERFACE_HASH, account);
-
-        address self = address(this);
-        if (account == self) {
-            registerRecipient(self);
-        }
-    }
-
-    function registerRecipient(address recipient) public {
-        _erc1820.setInterfaceImplementer(address(this), _TOKENS_RECIPIENT_INTERFACE_HASH, recipient);
-    }
-
-    function setShouldRevertSend(bool shouldRevert) public {
-        _shouldRevertSend = shouldRevert;
-    }
-
-    function setShouldRevertReceive(bool shouldRevert) public {
-        _shouldRevertReceive = shouldRevert;
-    }
-
-    function send(IERC777 token, address to, uint256 amount, bytes memory data) public {
-        // This is 777's send function, not the Solidity send function
-        token.send(to, amount, data); // solhint-disable-line check-send-result
-    }
-
-    function burn(IERC777 token, uint256 amount, bytes memory data) public {
-        token.burn(amount, data);
-    }
-
-    function upgradeAll(ISuperToken token) public {
-        IERC20 underlying = IERC20(token.getUnderlyingToken());
-        uint256 amount = underlying.balanceOf(address(this));
-        underlying.approve(address(token), amount);
-        token.upgrade(amount);
-    }
-
-    function upgradeAllToSelf(ISuperToken token) public {
-        IERC20 underlying = IERC20(token.getUnderlyingToken());
-        uint256 amount = underlying.balanceOf(address(this));
-        underlying.approve(address(token), amount);
-        token.upgradeTo(address(this), amount, "");
-    }
-}
-
-contract ERC777RecipientReverting is IERC777Recipient, IERC1820Implementer {
-    bytes32 constant private _TOKENS_RECIPIENT_INTERFACE_HASH = keccak256("ERC777TokensRecipient");
-
-    // allow to use the hook for this contract itself
-    constructor() {
-        IERC1820Registry erc1820 = IERC1820Registry(0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24);
-        erc1820.setInterfaceImplementer(address(this), keccak256("ERC777TokensRecipient"), address(this));
-    }
-
-    function tokensReceived(
-        address /*operator*/,
-        address /*from*/,
-        address /*to*/,
-        uint256 /*amount*/,
-        bytes calldata /*userData*/,
-        bytes calldata /*operatorData*/
-    ) external pure override {
-        revert("they shall not pass");
-    }
-
-    // allow anybody to use the hook
-    function canImplementInterfaceForAddress(bytes32 interfaceHash, address /*addr*/)
-        external pure override
-        returns(bytes32)
-    {
-        return
-            interfaceHash == _TOKENS_RECIPIENT_INTERFACE_HASH ?
-            keccak256(abi.encodePacked("ERC1820_ACCEPT_MAGIC")) :
-            bytes32(0x00);
-    }
-}
-
-/*
-* ERC777Recipient which drains all gas it gets, trying to make the caller run out of gas
-*/
-contract ERC777RecipientDrainingGas is IERC777Recipient, IERC1820Implementer {
-    bytes32 constant private _TOKENS_RECIPIENT_INTERFACE_HASH = keccak256("ERC777TokensRecipient");
-    uint256 internal _uselessVar = 1;
-
-    event DrainedGas(uint256 allowance, uint256 burned);
-
-    function tokensReceived(
-        address /*operator*/,
-        address /*from*/,
-        address /*to*/,
-        uint256 /*amount*/,
-        bytes calldata /*userData*/,
-        bytes calldata /*operatorData*/
-    ) external override {
-        uint256 initialGas = gasleft();
-        while (gasleft() > 30000) { // need to leave enough for the send() itself to not fail
-            _uselessVar++; // SSTORE drains much faster than an empty loop
-        }
-        emit DrainedGas(initialGas, gasleft());
-    }
-
-    // allow anybody to use the hook
-    function canImplementInterfaceForAddress(bytes32 interfaceHash, address /*addr*/)
-        external pure override
-        returns(bytes32)
-    {
-        return
-            interfaceHash == _TOKENS_RECIPIENT_INTERFACE_HASH ?
-            keccak256(abi.encodePacked("ERC1820_ACCEPT_MAGIC")) :
-            bytes32(0x00);
-    }
-}
-
-

package/contracts/mocks/FakeSuperfluidMock.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.18;
-
-import { CallUtils } from "../libs/CallUtils.sol";
-
-contract FakeSuperfluidMock {
-
-    function callAgreement(
-        address agreement,
-        bytes calldata callData
-    )
-        external
-    {
-        bool success;
-        bytes memory returnedData;
-        // solhint-disable-next-line avoid-low-level-calls
-        (success, returnedData) = agreement.call(callData);
-        assert(!success);
-        CallUtils.revertFromReturnedData(returnedData);
-    }
-}