Echidna Coverage Report

Files

Total Lines

3914

Coverage

80.0%

583 / 726 lines

Actions

66.0% contracts/contracts/echidna/Debugger.sol

Lines covered: 4 / 6 (66.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

library Debugger {
    event Debug(string debugString);
    event Debug(string description, string data);
    event Debug(string prefix, string description, string data);
    event Debug(string description, bytes32 data);
    event Debug(string prefix, string description, bytes32 data);
    event Debug(string description, uint256 data);
    event Debug(string prefix, string description, uint256 data);
    event Debug(string description, int256 data);
    event Debug(string prefix, string description, int256 data);
    event Debug(string description, address data);
    event Debug(string prefix, string description, address data);
    event Debug(string description, bool data);
    event Debug(string prefix, string description, bool data);

    function log(string memory debugString) internal {
        emit Debug(debugString);
    }

    function log(string memory description, string memory data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        string memory data
    ) internal {
        emit Debug(prefix, description, data);
    }

    function log(string memory description, bytes32 data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        bytes32 data
    ) internal {
        emit Debug(prefix, description, data);
    }

    function log(string memory description, uint256 data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        uint256 data
    ) internal {
        emit Debug(prefix, description, data);
    }

    function log(string memory description, int256 data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        int256 data
    ) internal {
        emit Debug(prefix, description, data);
    }

    function log(string memory description, address data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        address data
    ) internal {
        emit Debug(prefix, description, data);
    }

    function log(string memory description, bool data) internal {
        emit Debug(description, data);
    }

    function log(
        string memory prefix,
        string memory description,
        bool data
    ) internal {
        emit Debug(prefix, description, data);
    }
}


0.0% contracts/contracts/echidna/Echidna.sol

Lines covered: 0 / 1 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaTestApproval.sol";

/**
 * @title Echidna test contract for OUSD
 * @notice Target contract to be tested, containing all mixins
 * @author Rappie
 */
contract Echidna is EchidnaTestApproval {

}


100.0% contracts/contracts/echidna/EchidnaConfig.sol

Lines covered: 20 / 20 (100.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title Top-level mixin for configuring the desired fuzzing setup
 * @author Rappie
 */
contract EchidnaConfig {
    address internal constant ADDRESS_VAULT = address(0x10000);
    address internal constant ADDRESS_OUTSIDER_USER = address(0x20000);

    address internal constant ADDRESS_USER0 = address(0x30000);
    address internal constant ADDRESS_USER1 = address(0x40000);

    // Will be set in EchidnaSetup constructor
    address internal ADDRESS_OUTSIDER_CONTRACT;
    address internal ADDRESS_CONTRACT0;
    address internal ADDRESS_CONTRACT1;

    // Toggle known issues
    //
    // This can be used to skip tests that are known to fail. This is useful
    // when debugging a specific issue, but should be disabled when running
    // the full test suite.
    //
    //   True => skip tests that are known to fail
    //   False => run all tests
    //
    bool internal constant TOGGLE_KNOWN_ISSUES = false;

    // Toggle known issues within limits
    //
    // Same as TOGGLE_KNOWN_ISSUES, but also skip tests that are known to fail
    // within limits set by the variables below.
    //
    bool internal constant TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS = false;

    // Starting balance
    //
    // Gives OUSD a non-zero starting supply, which can be useful to ignore
    // certain edge cases.
    //
    // The starting balance is given to outsider accounts that are not used as
    // accounts while fuzzing.
    //
    bool internal constant TOGGLE_STARTING_BALANCE = true;
    uint256 internal constant STARTING_BALANCE = 1_000_000e18;

    // Change supply
    //
    // Set a limit to the amount of change per rebase, which can be useful to
    // ignore certain edge cases.
    //
    //  True => limit the amount of change to a percentage of total supply
    //  False => no limit
    //
    bool internal constant TOGGLE_CHANGESUPPLY_LIMIT = true;
    uint256 internal constant CHANGESUPPLY_DIVISOR = 10; // 10% of total supply

    // Mint limit
    //
    // Set a limit the amount minted per mint, which can be useful to
    // ignore certain edge cases.
    //
    //  True => limit the amount of minted tokens
    //  False => no limit
    //
    bool internal constant TOGGLE_MINT_LIMIT = true;
    uint256 internal constant MINT_MODULO = 1_000_000_000_000e18;

    // Known rounding errors
    uint256 internal constant TRANSFER_ROUNDING_ERROR = 1e18 - 1;
    uint256 internal constant OPT_IN_ROUNDING_ERROR = 1e18 - 1;
    uint256 internal constant MINT_ROUNDING_ERROR = 1e18 - 1;

    /**
     * @notice Modifier to skip tests that are known to fail
     * @dev see TOGGLE_KNOWN_ISSUES for more information
     */
    modifier hasKnownIssue() {
        if (TOGGLE_KNOWN_ISSUES) return;
        _;
    }

    /**
     * @notice Modifier to skip tests that are known to fail within limits
     * @dev see TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS for more information
     */
    modifier hasKnownIssueWithinLimits() {
        if (TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS) return;
        _;
    }

    /**
     * @notice Translate an account ID to an address
     * @param accountId The ID of the account
     * @return account The address of the account
     */
    function getAccount(uint8 accountId)
        internal
        view
        returns (address account)
    {
        accountId = accountId / 64;
        if (accountId == 0) return account = ADDRESS_USER0;
        if (accountId == 1) return account = ADDRESS_USER1;
        if (accountId == 2) return account = ADDRESS_CONTRACT0;
        if (accountId == 3) return account = ADDRESS_CONTRACT1;
        require(false, "Unknown account ID");
    }
}


0.0% contracts/contracts/echidna/EchidnaDebug.sol

Lines covered: 0 / 1 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import { Address } from "@openzeppelin/contracts/utils/Address.sol";

import "./EchidnaHelper.sol";
import "./Debugger.sol";

import "../token/OUSD.sol";

/**
 * @title Room for random debugging functions
 * @author Rappie
 */
contract EchidnaDebug is EchidnaHelper {
    function debugOUSD() public pure {
        // assert(ousd.balanceOf(ADDRESS_USER0) == 1000);
        // assert(ousd.rebaseState(ADDRESS_USER0) != OUSD.RebaseOptions.OptIn);
        // assert(Address.isContract(ADDRESS_CONTRACT0));
        // Debugger.log("nonRebasingSupply", ousd.nonRebasingSupply());
        // assert(false);
    }
}


95.0% contracts/contracts/echidna/EchidnaHelper.sol

Lines covered: 70 / 73 (95.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaSetup.sol";
import "./Debugger.sol";

/**
 * @title Mixin containing helper functions
 * @author Rappie
 */
contract EchidnaHelper is EchidnaSetup {
    /**
     * @notice Mint tokens to an account
     * @param toAcc Account to mint to
     * @param amount Amount to mint
     * @return Amount minted (in case of capped mint with modulo)
     */
    function mint(uint8 toAcc, uint256 amount) public returns (uint256) {
        address to = getAccount(toAcc);

        if (TOGGLE_MINT_LIMIT) {
            amount = amount % MINT_MODULO;
        }

        hevm.prank(ADDRESS_VAULT);
        ousd.mint(to, amount);

        return amount;
    }

    /**
     * @notice Burn tokens from an account
     * @param fromAcc Account to burn from
     * @param amount Amount to burn
     */
    function burn(uint8 fromAcc, uint256 amount) public {
        address from = getAccount(fromAcc);
        hevm.prank(ADDRESS_VAULT);
        ousd.burn(from, amount);
    }

    /**
     * @notice Change the total supply of OUSD (rebase)
     * @param amount New total supply
     */
    function changeSupply(uint256 amount) public {
        if (TOGGLE_CHANGESUPPLY_LIMIT) {
            amount =
                ousd.totalSupply() +
                (amount % (ousd.totalSupply() / CHANGESUPPLY_DIVISOR));
        }

        hevm.prank(ADDRESS_VAULT);
        ousd.changeSupply(amount);
    }

    /**
     * @notice Transfer tokens between accounts
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function transfer(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);
        hevm.prank(from);
        // slither-disable-next-line unchecked-transfer
        ousd.transfer(to, amount);
    }

    /**
     * @notice Transfer approved tokens between accounts
     * @param authorizedAcc Account that is authorized to transfer
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function transferFrom(
        uint8 authorizedAcc,
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address authorized = getAccount(authorizedAcc);
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);
        hevm.prank(authorized);
        // slither-disable-next-line unchecked-transfer
        ousd.transferFrom(from, to, amount);
    }

    /**
     * @notice Opt in to rebasing
     * @param targetAcc Account to opt in
     */
    function optIn(uint8 targetAcc) public {
        address target = getAccount(targetAcc);
        hevm.prank(target);
        ousd.rebaseOptIn();
    }

    /**
     * @notice Opt out of rebasing
     * @param targetAcc Account to opt out
     */
    function optOut(uint8 targetAcc) public {
        address target = getAccount(targetAcc);
        hevm.prank(target);
        ousd.rebaseOptOut();
    }

    /**
     * @notice Approve an account to spend OUSD
     * @param ownerAcc Account that owns the OUSD
     * @param spenderAcc Account that is approved to spend the OUSD
     * @param amount Amount to approve
     */
    function approve(
        uint8 ownerAcc,
        uint8 spenderAcc,
        uint256 amount
    ) public {
        address owner = getAccount(ownerAcc);
        address spender = getAccount(spenderAcc);
        hevm.prank(owner);
        // slither-disable-next-line unused-return
        ousd.approve(spender, amount);
    }

    /**
     * @notice Get the sum of all OUSD balances
     * @return total Total balance
     */
    function getTotalBalance() public view returns (uint256 total) {
        total += ousd.balanceOf(ADDRESS_VAULT);
        total += ousd.balanceOf(ADDRESS_OUTSIDER_USER);
        total += ousd.balanceOf(ADDRESS_OUTSIDER_CONTRACT);
        total += ousd.balanceOf(ADDRESS_USER0);
        total += ousd.balanceOf(ADDRESS_USER1);
        total += ousd.balanceOf(ADDRESS_CONTRACT0);
        total += ousd.balanceOf(ADDRESS_CONTRACT1);
    }

    /**
     * @notice Get the sum of all non-rebasing OUSD balances
     * @return total Total balance
     */
    function getTotalNonRebasingBalance() public returns (uint256 total) {
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_VAULT)
            ? ousd.balanceOf(ADDRESS_VAULT)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_OUTSIDER_USER)
            ? ousd.balanceOf(ADDRESS_OUTSIDER_USER)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_OUTSIDER_CONTRACT)
            ? ousd.balanceOf(ADDRESS_OUTSIDER_CONTRACT)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_USER0)
            ? ousd.balanceOf(ADDRESS_USER0)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_USER1)
            ? ousd.balanceOf(ADDRESS_USER1)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_CONTRACT0)
            ? ousd.balanceOf(ADDRESS_CONTRACT0)
            : 0;
        total += ousd._isNonRebasingAccountEchidna(ADDRESS_CONTRACT1)
            ? ousd.balanceOf(ADDRESS_CONTRACT1)
            : 0;
    }
}


100.0% contracts/contracts/echidna/EchidnaSetup.sol

Lines covered: 16 / 16 (100.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./IHevm.sol";
import "./EchidnaConfig.sol";
import "./OUSDEchidna.sol";

contract Dummy {}

/**
 * @title Mixin for setup and deployment
 * @author Rappie
 */
contract EchidnaSetup is EchidnaConfig {
    IHevm hevm = IHevm(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
    OUSDEchidna ousd = new OUSDEchidna();

    /**
     * @notice Deploy the OUSD contract and set up initial state
     */
    constructor() {
        ousd.initialize(ADDRESS_VAULT, 1e18);

        // Deploy dummny contracts as users
        Dummy outsider = new Dummy();
        ADDRESS_OUTSIDER_CONTRACT = address(outsider);
        Dummy dummy0 = new Dummy();
        ADDRESS_CONTRACT0 = address(dummy0);
        Dummy dummy1 = new Dummy();
        ADDRESS_CONTRACT1 = address(dummy1);

        // Start out with a reasonable amount of OUSD
        if (TOGGLE_STARTING_BALANCE) {
            // Rebasing tokens
            hevm.prank(ADDRESS_VAULT);
            ousd.mint(ADDRESS_OUTSIDER_USER, STARTING_BALANCE / 2);

            // Non-rebasing tokens
            hevm.prank(ADDRESS_VAULT);
            ousd.mint(ADDRESS_OUTSIDER_CONTRACT, STARTING_BALANCE / 2);
        }
    }
}


92.0% contracts/contracts/echidna/EchidnaTestAccounting.sol

Lines covered: 37 / 40 (92.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaDebug.sol";
import "./EchidnaTestSupply.sol";

/**
 * @title Mixin for testing accounting functions
 * @author Rappie
 */
contract EchidnaTestAccounting is EchidnaTestSupply {
    /**
     * @notice After opting in, balance should not increase. (Ok to lose rounding funds doing this)
     * @param targetAcc Account to opt in
     */
    function testOptInBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        optIn(targetAcc);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceAfter <= balanceBefore);
    }

    /**
     * @notice After opting out, balance should remain the same
     * @param targetAcc Account to opt out
     */
    function testOptOutBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        optOut(targetAcc);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceAfter == balanceBefore);
    }

    /**
     * @notice Account balance should remain the same after opting in minus rounding error
     * @param targetAcc Account to opt in
     */
    function testOptInBalanceRounding(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        optIn(targetAcc);
        uint256 balanceAfter = ousd.balanceOf(target);

        int256 delta = int256(balanceAfter) - int256(balanceBefore);
        Debugger.log("delta", delta);

        // slither-disable-next-line tautology
        assert(-1 * delta >= 0);
        assert(-1 * delta <= int256(OPT_IN_ROUNDING_ERROR));
    }

    /**
     * @notice After opting in, total supply should remain the same
     * @param targetAcc Account to opt in
     */
    function testOptInTotalSupply(uint8 targetAcc) public {
        uint256 totalSupplyBefore = ousd.totalSupply();
        optIn(targetAcc);
        uint256 totalSupplyAfter = ousd.totalSupply();

        assert(totalSupplyAfter == totalSupplyBefore);
    }

    /**
     * @notice After opting out, total supply should remain the same
     * @param targetAcc Account to opt out
     */
    function testOptOutTotalSupply(uint8 targetAcc) public {
        uint256 totalSupplyBefore = ousd.totalSupply();
        optOut(targetAcc);
        uint256 totalSupplyAfter = ousd.totalSupply();

        assert(totalSupplyAfter == totalSupplyBefore);
    }

    /**
     * @notice Account balance should remain the same when a smart contract auto converts
     * @param targetAcc Account to auto convert
     */
    function testAutoConvertBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        // slither-disable-next-line unused-return
        ousd._isNonRebasingAccountEchidna(target);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceAfter == balanceBefore);
    }

    /**
     * @notice The `balanceOf` function should never revert
     * @param targetAcc Account to check balance of
     */
    function testBalanceOfShouldNotRevert(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        // slither-disable-next-line unused-return
        try ousd.balanceOf(target) {
            assert(true);
        } catch {
            assert(false);
        }
    }
}


96.0% contracts/contracts/echidna/EchidnaTestApproval.sol

Lines covered: 30 / 31 (96.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaTestMintBurn.sol";
import "./Debugger.sol";

/**
 * @title Mixin for testing approval related functions
 * @author Rappie
 */
contract EchidnaTestApproval is EchidnaTestMintBurn {
    /**
     * @notice Performing `transferFrom` with an amount inside the allowance should not revert
     * @param authorizedAcc The account that is authorized to transfer
     * @param fromAcc The account that is transferring
     * @param toAcc The account that is receiving
     * @param amount The amount to transfer
     */
    function testTransferFromShouldNotRevert(
        uint8 authorizedAcc,
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address authorized = getAccount(authorizedAcc);
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(amount <= ousd.balanceOf(from));
        require(amount <= ousd.allowance(from, authorized));

        hevm.prank(authorized);
        // slither-disable-next-line unchecked-transfer
        try ousd.transferFrom(from, to, amount) {
            // pass
        } catch {
            assert(false);
        }
    }

    /**
     * @notice Performing `transferFrom` with an amount outside the allowance should revert
     * @param authorizedAcc The account that is authorized to transfer
     * @param fromAcc The account that is transferring
     * @param toAcc The account that is receiving
     * @param amount The amount to transfer
     */
    function testTransferFromShouldRevert(
        uint8 authorizedAcc,
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address authorized = getAccount(authorizedAcc);
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(amount > 0);
        require(
            !(amount <= ousd.balanceOf(from) &&
                amount <= ousd.allowance(from, authorized))
        );

        hevm.prank(authorized);
        // slither-disable-next-line unchecked-transfer
        try ousd.transferFrom(from, to, amount) {
            assert(false);
        } catch {
            // pass
        }
    }

    /**
     * @notice Approving an amount should update the allowance and overwrite any previous allowance
     * @param ownerAcc The account that is approving
     * @param spenderAcc The account that is being approved
     * @param amount The amount to approve
     */
    function testApprove(
        uint8 ownerAcc,
        uint8 spenderAcc,
        uint256 amount
    ) public {
        address owner = getAccount(ownerAcc);
        address spender = getAccount(spenderAcc);

        approve(ownerAcc, spenderAcc, amount);
        uint256 allowanceAfter1 = ousd.allowance(owner, spender);

        assert(allowanceAfter1 == amount);

        approve(ownerAcc, spenderAcc, amount / 2);
        uint256 allowanceAfter2 = ousd.allowance(owner, spender);

        assert(allowanceAfter2 == amount / 2);
    }
}


95.0% contracts/contracts/echidna/EchidnaTestMintBurn.sol

Lines covered: 43 / 45 (95.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaDebug.sol";
import "./EchidnaTestAccounting.sol";

/**
 * @title Mixin for testing Mint and Burn functions
 * @author Rappie
 */
contract EchidnaTestMintBurn is EchidnaTestAccounting {
    /**
     * @notice Minting 0 tokens should not affect account balance
     * @param targetAcc Account to mint to
     */
    function testMintZeroBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        mint(targetAcc, 0);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceAfter == balanceBefore);
    }

    /**
     * @notice Burning 0 tokens should not affect account balance
     * @param targetAcc Account to burn from
     */
    function testBurnZeroBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        burn(targetAcc, 0);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceAfter == balanceBefore);
    }

    /**
     * @notice Minting tokens must increase the account balance by at least amount
     * @param targetAcc Account to mint to
     * @param amount Amount to mint
     * @custom:error testMintBalance(uint8,uint256): failed!💥
     *   Call sequence:
     *       changeSupply(1)
     *       testMintBalance(0,1)
     *   Event sequence:
     *       Debug(«balanceBefore», 0)
     *       Debug(«balanceAfter», 0)
     */
    function testMintBalance(uint8 targetAcc, uint256 amount)
        public
        hasKnownIssue
        hasKnownIssueWithinLimits
    {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        uint256 amountMinted = mint(targetAcc, amount);
        uint256 balanceAfter = ousd.balanceOf(target);

        Debugger.log("amountMinted", amountMinted);
        Debugger.log("balanceBefore", balanceBefore);
        Debugger.log("balanceAfter", balanceAfter);

        assert(balanceAfter >= balanceBefore + amountMinted);
    }

    /**
     * @notice Burning tokens must decrease the account balance by at least amount
     * @param targetAcc Account to burn from
     * @param amount Amount to burn
     * @custom:error testBurnBalance(uint8,uint256): failed!💥
     *   Call sequence:
     *       changeSupply(1)
     *       mint(0,3)
     *       testBurnBalance(0,1)
     *   Event sequence:
     *       Debug(«balanceBefore», 2)
     *       Debug(«balanceAfter», 2)
     */
    function testBurnBalance(uint8 targetAcc, uint256 amount)
        public
        hasKnownIssue
        hasKnownIssueWithinLimits
    {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        burn(targetAcc, amount);
        uint256 balanceAfter = ousd.balanceOf(target);

        Debugger.log("balanceBefore", balanceBefore);
        Debugger.log("balanceAfter", balanceAfter);

        assert(balanceAfter <= balanceBefore - amount);
    }

    /**
     * @notice Minting tokens should not increase the account balance by less than rounding error above amount
     * @param targetAcc Account to mint to
     * @param amount Amount to mint
     */
    function testMintBalanceRounding(uint8 targetAcc, uint256 amount) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        uint256 amountMinted = mint(targetAcc, amount);
        uint256 balanceAfter = ousd.balanceOf(target);

        int256 delta = int256(balanceAfter) - int256(balanceBefore);

        // delta == amount, if no error
        // delta < amount,  if too little is minted
        // delta > amount,  if too much is minted
        int256 error = int256(amountMinted) - delta;

        assert(error >= 0);
        assert(error <= int256(MINT_ROUNDING_ERROR));
    }

    /**
     * @notice A burn of an account balance must result in a zero balance
     * @param targetAcc Account to burn from
     */
    function testBurnAllBalanceToZero(uint8 targetAcc) public hasKnownIssue {
        address target = getAccount(targetAcc);

        burn(targetAcc, ousd.balanceOf(target));
        assert(ousd.balanceOf(target) == 0);
    }

    /**
     * @notice You should always be able to burn an account's balance
     * @param targetAcc Account to burn from
     */
    function testBurnAllBalanceShouldNotRevert(uint8 targetAcc)
        public
        hasKnownIssue
    {
        address target = getAccount(targetAcc);
        uint256 balance = ousd.balanceOf(target);

        hevm.prank(ADDRESS_VAULT);
        try ousd.burn(target, balance) {
            assert(true);
        } catch {
            assert(false);
        }
    }
}


95.0% contracts/contracts/echidna/EchidnaTestSupply.sol

Lines covered: 39 / 41 (95.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaDebug.sol";
import "./EchidnaTestTransfer.sol";

import { StableMath } from "../utils/StableMath.sol";

/**
 * @title Mixin for testing supply related functions
 * @author Rappie
 */
contract EchidnaTestSupply is EchidnaTestTransfer {
    using StableMath for uint256;

    uint256 prevRebasingCreditsPerToken = type(uint256).max;

    /**
     * @notice After a `changeSupply`, the total supply should exactly
     * match the target total supply. (This is needed to ensure successive
     * rebases are correct).
     * @param supply New total supply
     * @custom:error testChangeSupply(uint256): failed!💥
     *   Call sequence:
     *       testChangeSupply(1044505275072865171609)
     *   Event sequence:
     *       TotalSupplyUpdatedHighres(1044505275072865171610, 1000000000000000000000000, 957391048054055578595)
     */
    function testChangeSupply(uint256 supply)
        public
        hasKnownIssue
        hasKnownIssueWithinLimits
    {
        hevm.prank(ADDRESS_VAULT);
        ousd.changeSupply(supply);

        assert(ousd.totalSupply() == supply);
    }

    /**
     * @notice The total supply must not be less than the sum of account balances.
     * (The difference will go into future rebases)
     * @custom:error testTotalSupplyLessThanTotalBalance(): failed!💥
     *   Call sequence:
     *     mint(0,1)
     *     changeSupply(1)
     *     optOut(64)
     *     transfer(0,64,1)
     *     testTotalSupplyLessThanTotalBalance()
     *   Event sequence:
     *     Debug(«totalSupply», 1000000000000000001000001)
     *     Debug(«totalBalance», 1000000000000000001000002)
     */
    function testTotalSupplyLessThanTotalBalance()
        public
        hasKnownIssue
        hasKnownIssueWithinLimits
    {
        uint256 totalSupply = ousd.totalSupply();
        uint256 totalBalance = getTotalBalance();

        Debugger.log("totalSupply", totalSupply);
        Debugger.log("totalBalance", totalBalance);

        assert(totalSupply >= totalBalance);
    }

    /**
     * @notice Non-rebasing supply should not be larger than total supply
     * @custom:error testNonRebasingSupplyVsTotalSupply(): failed!💥
     *   Call sequence:
     *     mint(0,2)
     *     changeSupply(3)
     *     burn(0,1)
     *     optOut(0)
     *     testNonRebasingSupplyVsTotalSupply()
     */
    function testNonRebasingSupplyVsTotalSupply() public hasKnownIssue {
        uint256 nonRebasingSupply = ousd.nonRebasingSupply();
        uint256 totalSupply = ousd.totalSupply();

        assert(nonRebasingSupply <= totalSupply);
    }

    /**
     * @notice Global `rebasingCreditsPerToken` should never increase
     * @custom:error testRebasingCreditsPerTokenNotIncreased(): failed!💥
     *   Call sequence:
     *     testRebasingCreditsPerTokenNotIncreased()
     *     changeSupply(1)
     *     testRebasingCreditsPerTokenNotIncreased()
     */
    function testRebasingCreditsPerTokenNotIncreased() public hasKnownIssue {
        uint256 curRebasingCreditsPerToken = ousd
            .rebasingCreditsPerTokenHighres();

        Debugger.log(
            "prevRebasingCreditsPerToken",
            prevRebasingCreditsPerToken
        );
        Debugger.log("curRebasingCreditsPerToken", curRebasingCreditsPerToken);

        assert(curRebasingCreditsPerToken <= prevRebasingCreditsPerToken);

        prevRebasingCreditsPerToken = curRebasingCreditsPerToken;
    }

    /**
     * @notice The rebasing credits per token ratio must greater than zero
     */
    function testRebasingCreditsPerTokenAboveZero() public {
        assert(ousd.rebasingCreditsPerTokenHighres() > 0);
    }

    /**
     * @notice The sum of all non-rebasing balances should not be larger than
     * non-rebasing supply
     * @custom:error testTotalNonRebasingSupplyLessThanTotalBalance(): failed!💥
     *   Call sequence
     *     mint(0,2)
     *     changeSupply(1)
     *     optOut(0)
     *     burn(0,1)
     *     testTotalNonRebasingSupplyLessThanTotalBalance()
     *   Event sequence:
     *     Debug(«totalNonRebasingSupply», 500000000000000000000001)
     *     Debug(«totalNonRebasingBalance», 500000000000000000000002)
     */
    function testTotalNonRebasingSupplyLessThanTotalBalance()
        public
        hasKnownIssue
        hasKnownIssueWithinLimits
    {
        uint256 totalNonRebasingSupply = ousd.nonRebasingSupply();
        uint256 totalNonRebasingBalance = getTotalNonRebasingBalance();

        Debugger.log("totalNonRebasingSupply", totalNonRebasingSupply);
        Debugger.log("totalNonRebasingBalance", totalNonRebasingBalance);

        assert(totalNonRebasingSupply >= totalNonRebasingBalance);
    }

    /**
     * @notice An accounts credits / credits per token should not be larger it's balance
     * @param targetAcc The account to check
     */
    function testCreditsPerTokenVsBalance(uint8 targetAcc) public {
        address target = getAccount(targetAcc);

        (uint256 credits, uint256 creditsPerToken, ) = ousd
            .creditsBalanceOfHighres(target);
        uint256 expectedBalance = credits.divPrecisely(creditsPerToken);

        uint256 balance = ousd.balanceOf(target);

        Debugger.log("credits", credits);
        Debugger.log("creditsPerToken", creditsPerToken);
        Debugger.log("expectedBalance", expectedBalance);
        Debugger.log("balance", balance);

        assert(expectedBalance == balance);
    }
}


96.0% contracts/contracts/echidna/EchidnaTestTransfer.sol

Lines covered: 103 / 107 (96.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "./EchidnaDebug.sol";
import "./Debugger.sol";

/**
 * @title Mixin for testing transfer related functions
 * @author Rappie
 */
contract EchidnaTestTransfer is EchidnaDebug {
    /**
     * @notice The receiving account's balance after a transfer must not increase by
     * less than the amount transferred
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     * @custom:error testTransferBalanceReceivedLess(uint8,uint8,uint256): failed!💥
     *   Call sequence:
     *     changeSupply(1)
     *     mint(64,2)
     *     testTransferBalanceReceivedLess(64,0,1)
     *   Event sequence:
     *     Debug(«totalSupply», 1000000000000000000500002)
     *     Debug(«toBalBefore», 0)
     *     Debug(«toBalAfter», 0)
     */
    function testTransferBalanceReceivedLess(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public hasKnownIssue hasKnownIssueWithinLimits {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 toBalBefore = ousd.balanceOf(to);
        transfer(fromAcc, toAcc, amount);
        uint256 toBalAfter = ousd.balanceOf(to);

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("toBalBefore", toBalBefore);
        Debugger.log("toBalAfter", toBalAfter);

        assert(toBalAfter >= toBalBefore + amount);
    }

    /**
     * @notice The receiving account's balance after a transfer must not
     * increase by more than the amount transferred
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferBalanceReceivedMore(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 toBalBefore = ousd.balanceOf(to);
        transfer(fromAcc, toAcc, amount);
        uint256 toBalAfter = ousd.balanceOf(to);

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("toBalBefore", toBalBefore);
        Debugger.log("toBalAfter", toBalAfter);

        assert(toBalAfter <= toBalBefore + amount);
    }

    /**
     * @notice The sending account's balance after a transfer must not
     * decrease by less than the amount transferred
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     * @custom:error testTransferBalanceSentLess(uint8,uint8,uint256): failed!💥
     *   Call sequence:
     *     mint(0,1)
     *     changeSupply(1)
     *     testTransferBalanceSentLess(0,64,1)
     *   Event sequence:
     *     Debug(«totalSupply», 1000000000000000000500001)
     *     Debug(«fromBalBefore», 1)
     *     Debug(«fromBalAfter», 1)
     */
    function testTransferBalanceSentLess(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public hasKnownIssue hasKnownIssueWithinLimits {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 fromBalBefore = ousd.balanceOf(from);
        transfer(fromAcc, toAcc, amount);
        uint256 fromBalAfter = ousd.balanceOf(from);

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("fromBalBefore", fromBalBefore);
        Debugger.log("fromBalAfter", fromBalAfter);

        assert(fromBalAfter <= fromBalBefore - amount);
    }

    /**
     * @notice The sending account's balance after a transfer must not
     * decrease by more than the amount transferred
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferBalanceSentMore(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 fromBalBefore = ousd.balanceOf(from);
        transfer(fromAcc, toAcc, amount);
        uint256 fromBalAfter = ousd.balanceOf(from);

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("fromBalBefore", fromBalBefore);
        Debugger.log("fromBalAfter", fromBalAfter);

        assert(fromBalAfter >= fromBalBefore - amount);
    }

    /**
     * @notice The receiving account's balance after a transfer must not
     * increase by less than the amount transferred (minus rounding error)
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferBalanceReceivedLessRounding(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 toBalBefore = ousd.balanceOf(to);
        transfer(fromAcc, toAcc, amount);
        uint256 toBalAfter = ousd.balanceOf(to);

        int256 toDelta = int256(toBalAfter) - int256(toBalBefore);

        // delta == amount, if no error
        // delta < amount,  if too little is sent
        // delta > amount,  if too much is sent
        int256 error = int256(amount) - toDelta;

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("toBalBefore", toBalBefore);
        Debugger.log("toBalAfter", toBalAfter);
        Debugger.log("toDelta", toDelta);
        Debugger.log("error", error);

        assert(error >= 0);
        assert(error <= int256(TRANSFER_ROUNDING_ERROR));
    }

    /**
     * @notice The sending account's balance after a transfer must
     * not decrease by less than the amount transferred (minus rounding error)
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferBalanceSentLessRounding(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(from != to);

        uint256 fromBalBefore = ousd.balanceOf(from);
        transfer(fromAcc, toAcc, amount);
        uint256 fromBalAfter = ousd.balanceOf(from);

        int256 fromDelta = int256(fromBalAfter) - int256(fromBalBefore);

        // delta == -amount, if no error
        // delta < -amount,  if too much is sent
        // delta > -amount,  if too little is sent
        int256 error = int256(amount) + fromDelta;

        Debugger.log("totalSupply", ousd.totalSupply());
        Debugger.log("fromBalBefore", fromBalBefore);
        Debugger.log("fromBalAfter", fromBalAfter);
        Debugger.log("fromDelta", fromDelta);
        Debugger.log("error", error);

        assert(error >= 0);
        assert(error <= int256(TRANSFER_ROUNDING_ERROR));
    }

    /**
     * @notice An account should always be able to successfully transfer
     * an amount within its balance.
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     * @custom:error testTransferWithinBalanceDoesNotRevert(uint8,uint8,uint8): failed!💥
     *   Call sequence:
     *       mint(0,1)
     *       changeSupply(3)
     *       optOut(0)
     *       testTransferWithinBalanceDoesNotRevert(0,128,2)
     *       optIn(0)
     *       testTransferWithinBalanceDoesNotRevert(128,0,1)
     *   Event sequence:
     *       error Revert Panic(17): SafeMath over-/under-flows
     */
    function testTransferWithinBalanceDoesNotRevert(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public hasKnownIssue {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        require(amount > 0);
        amount = amount % ousd.balanceOf(from);

        Debugger.log("Total supply", ousd.totalSupply());

        hevm.prank(from);
        // slither-disable-next-line unchecked-transfer
        try ousd.transfer(to, amount) {
            assert(true);
        } catch {
            assert(false);
        }
    }

    /**
     * @notice An account should never be able to successfully transfer
     * an amount greater than their balance.
     * @param fromAcc Account to transfer from
     * @param toAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferExceedingBalanceReverts(
        uint8 fromAcc,
        uint8 toAcc,
        uint256 amount
    ) public {
        address from = getAccount(fromAcc);
        address to = getAccount(toAcc);

        amount = ousd.balanceOf(from) + 1 + amount;

        hevm.prank(from);
        // slither-disable-next-line unchecked-transfer
        try ousd.transfer(to, amount) {
            assert(false);
        } catch {
            assert(true);
        }
    }

    /**
     * @notice A transfer to the same account should not change that account's balance
     * @param targetAcc Account to transfer to
     * @param amount Amount to transfer
     */
    function testTransferSelf(uint8 targetAcc, uint256 amount) public {
        address target = getAccount(targetAcc);

        uint256 balanceBefore = ousd.balanceOf(target);
        transfer(targetAcc, targetAcc, amount);
        uint256 balanceAfter = ousd.balanceOf(target);

        assert(balanceBefore == balanceAfter);
    }

    /**
     * @notice Transfers to the zero account revert
     * @param fromAcc Account to transfer from
     * @param amount Amount to transfer
     */
    function testTransferToZeroAddress(uint8 fromAcc, uint256 amount) public {
        address from = getAccount(fromAcc);

        hevm.prank(from);
        // slither-disable-next-line unchecked-transfer
        try ousd.transfer(address(0), amount) {
            assert(false);
        } catch {
            assert(true);
        }
    }
}


0.0% contracts/contracts/echidna/IHevm.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

// https://github.com/ethereum/hevm/blob/main/doc/src/controlling-the-unit-testing-environment.md#cheat-codes

interface IHevm {
    function warp(uint256 x) external;

    function roll(uint256 x) external;

    function store(
        address c,
        bytes32 loc,
        bytes32 val
    ) external;

    function load(address c, bytes32 loc) external returns (bytes32 val);

    function sign(uint256 sk, bytes32 digest)
        external
        returns (
            uint8 v,
            bytes32 r,
            bytes32 s
        );

    function addr(uint256 sk) external returns (address addr);

    function ffi(string[] calldata) external returns (bytes memory);

    function prank(address sender) external;
}


100.0% contracts/contracts/echidna/OUSDEchidna.sol

Lines covered: 7 / 7 (100.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import "../token/OUSD.sol";

contract OUSDEchidna is OUSD {
    constructor() OUSD() {
        // The Yield Delegation rewrite (#2298) left Governable without a
        // constructor, so the governor slot is zero and the harness could
        // never call initialize() (onlyGovernor). Make the deploying harness
        // the governor so the suite is runnable again.
        _setGovernor(msg.sender);
    }

    function _isNonRebasingAccountEchidna(address _account)
        public
        returns (bool)
    {
        _autoMigrate(_account);
        return alternativeCreditsPerToken[_account] > 0;
    }
}


41.0% contracts/contracts/governance/Governable.sol

Lines covered: 10 / 24 (41.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title Base for contracts that are managed by the Origin Protocol's Governor.
 * @dev Copy of the openzeppelin Ownable.sol contract with nomenclature change
 *      from owner to governor and renounce methods removed. Does not use
 *      Context.sol like Ownable.sol does for simplification.
 * @author Origin Protocol Inc
 */
abstract contract Governable {
    // Storage position of the owner and pendingOwner of the contract
    // keccak256("OUSD.governor");
    bytes32 private constant governorPosition =
        0x7bea13895fa79d2831e0a9e28edede30099005a50d652d8957cf8a607ee6ca4a;

    // keccak256("OUSD.pending.governor");
    bytes32 private constant pendingGovernorPosition =
        0x44c4d30b2eaad5130ad70c3ba6972730566f3e6359ab83e800d905c61b1c51db;

    // keccak256("OUSD.reentry.status");
    bytes32 private constant reentryStatusPosition =
        0x53bf423e48ed90e97d02ab0ebab13b2a235a6bfbe9c321847d5c175333ac4535;

    // See OpenZeppelin ReentrancyGuard implementation
    uint256 constant _NOT_ENTERED = 1;
    uint256 constant _ENTERED = 2;

    event PendingGovernorshipTransfer(
        address indexed previousGovernor,
        address indexed newGovernor
    );

    event GovernorshipTransferred(
        address indexed previousGovernor,
        address indexed newGovernor
    );

    /**
     * @notice Returns the address of the current Governor.
     */
    function governor() public view returns (address) {
        return _governor();
    }

    /**
     * @dev Returns the address of the current Governor.
     */
    function _governor() internal view returns (address governorOut) {
        bytes32 position = governorPosition;
        // solhint-disable-next-line no-inline-assembly
        assembly {
            governorOut := sload(position)
        }
    }

    /**
     * @dev Returns the address of the pending Governor.
     */
    function _pendingGovernor()
        internal
        view
        returns (address pendingGovernor)
    {
        bytes32 position = pendingGovernorPosition;
        // solhint-disable-next-line no-inline-assembly
        assembly {
            pendingGovernor := sload(position)
        }
    }

    /**
     * @dev Throws if called by any account other than the Governor.
     */
    modifier onlyGovernor() {
        require(isGovernor(), "Caller is not the Governor");
        _;
    }

    /**
     * @notice Returns true if the caller is the current Governor.
     */
    function isGovernor() public view returns (bool) {
        return msg.sender == _governor();
    }

    function _setGovernor(address newGovernor) internal {
        emit GovernorshipTransferred(_governor(), newGovernor);

        bytes32 position = governorPosition;
        // solhint-disable-next-line no-inline-assembly
        assembly {
            sstore(position, newGovernor)
        }
    }

    /**
     * @dev Prevents a contract from calling itself, directly or indirectly.
     * Calling a `nonReentrant` function from another `nonReentrant`
     * function is not supported. It is possible to prevent this from happening
     * by making the `nonReentrant` function external, and make it call a
     * `private` function that does the actual work.
     */
    modifier nonReentrant() {
        bytes32 position = reentryStatusPosition;
        uint256 _reentry_status;
        // solhint-disable-next-line no-inline-assembly
        assembly {
            _reentry_status := sload(position)
        }

        // On the first call to nonReentrant, _notEntered will be true
        require(_reentry_status != _ENTERED, "Reentrant call");

        // Any calls to nonReentrant after this point will fail
        // solhint-disable-next-line no-inline-assembly
        assembly {
            sstore(position, _ENTERED)
        }

        _;

        // By storing the original value once again, a refund is triggered (see
        // https://eips.ethereum.org/EIPS/eip-2200)
        // solhint-disable-next-line no-inline-assembly
        assembly {
            sstore(position, _NOT_ENTERED)
        }
    }

    function _setPendingGovernor(address newGovernor) internal {
        bytes32 position = pendingGovernorPosition;
        // solhint-disable-next-line no-inline-assembly
        assembly {
            sstore(position, newGovernor)
        }
    }

    /**
     * @notice Transfers Governance of the contract to a new account (`newGovernor`).
     * Can only be called by the current Governor. Must be claimed for this to complete
     * @param _newGovernor Address of the new Governor
     */
    function transferGovernance(address _newGovernor) external onlyGovernor {
        _setPendingGovernor(_newGovernor);
        emit PendingGovernorshipTransfer(_governor(), _newGovernor);
    }

    /**
     * @notice Claim Governance of the contract to a new account (`newGovernor`).
     * Can only be called by the new Governor.
     */
    function claimGovernance() external {
        require(
            msg.sender == _pendingGovernor(),
            "Only the pending Governor can complete the claim"
        );
        _changeGovernor(msg.sender);
    }

    /**
     * @dev Change Governance of the contract to a new account (`newGovernor`).
     * @param _newGovernor Address of the new Governor
     */
    function _changeGovernor(address _newGovernor) internal {
        require(_newGovernor != address(0), "New Governor is address(0)");
        _setGovernor(_newGovernor);
    }
}


0.0% contracts/contracts/interfaces/IBasicToken.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

interface IBasicToken {
    function symbol() external view returns (string memory);

    function decimals() external view returns (uint8);
}


0.0% contracts/contracts/interfaces/IStrategy.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title Platform interface to integrate with lending platform like Compound, AAVE etc.
 */
interface IStrategy {
    /**
     * @dev Deposit the given asset to platform
     * @param _asset asset address
     * @param _amount Amount to deposit
     */
    function deposit(address _asset, uint256 _amount) external;

    /**
     * @dev Deposit the entire balance of all supported assets in the Strategy
     *      to the platform
     */
    function depositAll() external;

    /**
     * @dev Withdraw given asset from Lending platform
     */
    function withdraw(
        address _recipient,
        address _asset,
        uint256 _amount
    ) external;

    /**
     * @dev Liquidate all assets in strategy and return them to Vault.
     */
    function withdrawAll() external;

    /**
     * @dev Returns the current balance of the given asset.
     */
    function checkBalance(address _asset)
        external
        view
        returns (uint256 balance);

    /**
     * @dev Returns bool indicating whether strategy supports asset.
     */
    function supportsAsset(address _asset) external view returns (bool);

    /**
     * @dev Collect reward tokens from the Strategy.
     */
    function collectRewardTokens() external;

    /**
     * @dev The address array of the reward tokens for the Strategy.
     */
    function getRewardTokenAddresses() external view returns (address[] memory);

    function harvesterAddress() external view returns (address);

    function transferToken(address token, uint256 amount) external;

    function setRewardTokenAddresses(address[] calldata _rewardTokenAddresses)
        external;
}


0.0% contracts/contracts/interfaces/IVault.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import { VaultStorage } from "../vault/VaultStorage.sol";

interface IVault {
    // slither-disable-start constable-states

    event AssetAllocated(address _asset, address _strategy, uint256 _amount);
    event StrategyApproved(address _addr);
    event StrategyRemoved(address _addr);
    event Mint(address _addr, uint256 _value);
    event Redeem(address _addr, uint256 _value);
    event CapitalPaused();
    event CapitalUnpaused();
    event DefaultStrategyUpdated(address _strategy);
    event RebasePaused();
    event RebaseUnpaused();
    event VaultBufferUpdated(uint256 _vaultBuffer);
    event AllocateThresholdUpdated(uint256 _threshold);
    event StrategistUpdated(address _address);
    event MaxSupplyDiffChanged(uint256 maxSupplyDiff);
    event YieldDistribution(address _to, uint256 _yield, uint256 _fee);
    event TrusteeFeeBpsChanged(uint256 _basis);
    event TrusteeAddressChanged(address _address);
    event StrategyAddedToMintWhitelist(address indexed strategy);
    event StrategyRemovedFromMintWhitelist(address indexed strategy);
    event RebasePerSecondMaxChanged(uint256 rebaseRatePerSecond);
    event DripDurationChanged(uint256 dripDuration);
    event WithdrawalRequested(
        address indexed _withdrawer,
        uint256 indexed _requestId,
        uint256 _amount,
        uint256 _queued
    );
    event WithdrawalClaimed(
        address indexed _withdrawer,
        uint256 indexed _requestId,
        uint256 _amount
    );
    event WithdrawalClaimable(uint256 _claimable, uint256 _newClaimable);
    event WithdrawalClaimDelayUpdated(uint256 _newDelay);

    // Governable.sol
    function transferGovernance(address _newGovernor) external;

    function claimGovernance() external;

    function governor() external view returns (address);

    // VaultAdmin.sol
    function setVaultBuffer(uint256 _vaultBuffer) external;

    function vaultBuffer() external view returns (uint256);

    function setAutoAllocateThreshold(uint256 _threshold) external;

    function autoAllocateThreshold() external view returns (uint256);

    function setStrategistAddr(address _address) external;

    function strategistAddr() external view returns (address);

    function setOperatorAddr(address _operator) external;

    function operatorAddr() external view returns (address);

    function setMaxSupplyDiff(uint256 _maxSupplyDiff) external;

    function maxSupplyDiff() external view returns (uint256);

    function setTrusteeAddress(address _address) external;

    function trusteeAddress() external view returns (address);

    function setTrusteeFeeBps(uint256 _basis) external;

    function trusteeFeeBps() external view returns (uint256);

    function approveStrategy(address _addr) external;

    function removeStrategy(address _addr) external;

    function setDefaultStrategy(address _strategy) external;

    function defaultStrategy() external view returns (address);

    function pauseRebase() external;

    function unpauseRebase() external;

    function rebasePaused() external view returns (bool);

    function pauseCapital() external;

    function unpauseCapital() external;

    function capitalPaused() external view returns (bool);

    function transferToken(address _asset, uint256 _amount) external;

    function withdrawAllFromStrategy(address _strategyAddr) external;

    function withdrawAllFromStrategies() external;

    function withdrawFromStrategy(
        address _strategyFromAddress,
        address[] calldata _assets,
        uint256[] calldata _amounts
    ) external;

    function depositToStrategy(
        address _strategyToAddress,
        address[] calldata _assets,
        uint256[] calldata _amounts
    ) external;

    // VaultCore.sol
    function mint(uint256 _amount) external;

    function mintForStrategy(uint256 _amount) external;

    function burnForStrategy(uint256 _amount) external;

    function allocate() external;

    function rebase() external;

    function totalValue() external view returns (uint256 value);

    function checkBalance(address _asset) external view returns (uint256);

    function getAssetCount() external view returns (uint256);

    function getAllAssets() external view returns (address[] memory);

    function getStrategyCount() external view returns (uint256);

    function getAllStrategies() external view returns (address[] memory);

    function strategies(address _addr)
        external
        view
        returns (VaultStorage.Strategy memory);

    /// @notice Deprecated: use `asset()` instead.
    function isSupportedAsset(address _asset) external view returns (bool);

    function asset() external view returns (address);

    function oToken() external view returns (address);

    function initialize(address) external;

    function addWithdrawalQueueLiquidity() external;

    function requestWithdrawal(uint256 _amount)
        external
        returns (uint256 requestId, uint256 queued);

    function claimWithdrawal(uint256 requestId)
        external
        returns (uint256 amount);

    function claimWithdrawals(uint256[] memory requestIds)
        external
        returns (uint256[] memory amounts, uint256 totalAmount);

    function withdrawalQueueMetadata()
        external
        view
        returns (VaultStorage.WithdrawalQueueMetadata memory);

    function withdrawalRequests(uint256 requestId)
        external
        view
        returns (VaultStorage.WithdrawalRequest memory);

    function addStrategyToMintWhitelist(address strategyAddr) external;

    function removeStrategyFromMintWhitelist(address strategyAddr) external;

    function isMintWhitelistedStrategy(address strategyAddr)
        external
        view
        returns (bool);

    function withdrawalClaimDelay() external view returns (uint256);

    function setWithdrawalClaimDelay(uint256 newDelay) external;

    function lastRebase() external view returns (uint64);

    function dripDuration() external view returns (uint64);

    function setDripDuration(uint256 _dripDuration) external;

    function rebasePerSecondMax() external view returns (uint64);

    function setRebaseRateMax(uint256 yearlyApr) external;

    function rebasePerSecondTarget() external view returns (uint64);

    function previewYield() external view returns (uint256 yield);

    // slither-disable-end constable-states
}


63.0% contracts/contracts/token/OUSD.sol

Lines covered: 181 / 284 (63.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title OUSD Token Contract
 * @dev ERC20 compatible contract for OUSD
 * @dev Implements an elastic supply
 * @author Origin Protocol Inc
 */
import { IVault } from "../interfaces/IVault.sol";
import { Governable } from "../governance/Governable.sol";
import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";

contract OUSD is Governable {
    using SafeCast for int256;
    using SafeCast for uint256;

    /// @dev Event triggered when the supply changes
    /// @param totalSupply Updated token total supply
    /// @param rebasingCredits Updated token rebasing credits
    /// @param rebasingCreditsPerToken Updated token rebasing credits per token
    event TotalSupplyUpdatedHighres(
        uint256 totalSupply,
        uint256 rebasingCredits,
        uint256 rebasingCreditsPerToken
    );
    /// @dev Event triggered when an account opts in for rebasing
    /// @param account Address of the account
    event AccountRebasingEnabled(address account);
    /// @dev Event triggered when an account opts out of rebasing
    /// @param account Address of the account
    event AccountRebasingDisabled(address account);
    /// @dev Emitted when `value` tokens are moved from one account `from` to
    ///      another `to`.
    /// @param from Address of the account tokens are moved from
    /// @param to Address of the account tokens are moved to
    /// @param value Amount of tokens transferred
    event Transfer(address indexed from, address indexed to, uint256 value);
    /// @dev Emitted when the allowance of a `spender` for an `owner` is set by
    ///      a call to {approve}. `value` is the new allowance.
    /// @param owner Address of the owner approving allowance
    /// @param spender Address of the spender allowance is granted to
    /// @param value Amount of tokens spender can transfer
    event Approval(
        address indexed owner,
        address indexed spender,
        uint256 value
    );
    /// @dev Yield resulting from {changeSupply} that a `source` account would
    ///      receive is directed to `target` account.
    /// @param source Address of the source forwarding the yield
    /// @param target Address of the target receiving the yield
    event YieldDelegated(address source, address target);
    /// @dev Yield delegation from `source` account to the `target` account is
    ///      suspended.
    /// @param source Address of the source suspending yield forwarding
    /// @param target Address of the target no longer receiving yield from `source`
    ///        account
    event YieldUndelegated(address source, address target);

    enum RebaseOptions {
        NotSet,
        StdNonRebasing,
        StdRebasing,
        YieldDelegationSource,
        YieldDelegationTarget
    }

    uint256[154] private _gap; // Slots to align with deployed contract
    uint256 private constant MAX_SUPPLY = type(uint128).max;
    /// @dev The amount of tokens in existence
    uint256 public totalSupply;
    mapping(address => mapping(address => uint256)) private allowances;
    /// @dev The vault with privileges to execute {mint}, {burn}
    ///     and {changeSupply}
    address public vaultAddress;
    mapping(address => uint256) internal creditBalances;
    // the 2 storage variables below need trailing underscores to not name collide with public functions
    uint256 private rebasingCredits_; // Sum of all rebasing credits (creditBalances for rebasing accounts)
    uint256 private rebasingCreditsPerToken_;
    /// @dev The amount of tokens that are not rebasing - receiving yield
    uint256 public nonRebasingSupply;
    mapping(address => uint256) internal alternativeCreditsPerToken;
    /// @dev A map of all addresses and their respective RebaseOptions
    mapping(address => RebaseOptions) public rebaseState;
    mapping(address => uint256) private __deprecated_isUpgraded;
    /// @dev A map of addresses that have yields forwarded to. This is an
    ///      inverse mapping of {yieldFrom}
    /// Key Account forwarding yield
    /// Value Account receiving yield
    mapping(address => address) public yieldTo;
    /// @dev A map of addresses that are receiving the yield. This is an
    ///      inverse mapping of {yieldTo}
    /// Key Account receiving yield
    /// Value Account forwarding yield
    mapping(address => address) public yieldFrom;

    uint256 private constant RESOLUTION_INCREASE = 1e9;
    uint256[34] private __gap; // including below gap totals up to 200

    /// @dev Verifies that the caller is the Governor or Strategist.
    modifier onlyGovernorOrStrategist() {
        require(
            isGovernor() || msg.sender == IVault(vaultAddress).strategistAddr(),
            "Caller is not the Strategist or Governor"
        );
        _;
    }

    /// @dev Initializes the contract and sets necessary variables.
    /// @param _vaultAddress Address of the vault contract
    /// @param _initialCreditsPerToken The starting rebasing credits per token.
    function initialize(address _vaultAddress, uint256 _initialCreditsPerToken)
        external
        onlyGovernor
    {
        require(_vaultAddress != address(0), "Zero vault address");
        require(vaultAddress == address(0), "Already initialized");

        rebasingCreditsPerToken_ = _initialCreditsPerToken;
        vaultAddress = _vaultAddress;
    }

    /// @dev Returns the symbol of the token, a shorter version
    ///      of the name.
    function symbol() external pure virtual returns (string memory) {
        return "OUSD";
    }

    /// @dev Returns the name of the token.
    function name() external pure virtual returns (string memory) {
        return "Origin Dollar";
    }

    /// @dev Returns the number of decimals used to get its user representation.
    function decimals() external pure virtual returns (uint8) {
        return 18;
    }

    /**
     * @dev Verifies that the caller is the Vault contract
     */
    modifier onlyVault() {
        require(vaultAddress == msg.sender, "Caller is not the Vault");
        _;
    }

    /**
     * @return High resolution rebasingCreditsPerToken
     */
    function rebasingCreditsPerTokenHighres() external view returns (uint256) {
        return rebasingCreditsPerToken_;
    }

    /**
     * @return Low resolution rebasingCreditsPerToken
     */
    function rebasingCreditsPerToken() external view returns (uint256) {
        return rebasingCreditsPerToken_ / RESOLUTION_INCREASE;
    }

    /**
     * @return High resolution total number of rebasing credits
     */
    function rebasingCreditsHighres() external view returns (uint256) {
        return rebasingCredits_;
    }

    /**
     * @return Low resolution total number of rebasing credits
     */
    function rebasingCredits() external view returns (uint256) {
        return rebasingCredits_ / RESOLUTION_INCREASE;
    }

    /**
     * @notice Gets the balance of the specified address.
     * @param _account Address to query the balance of.
     * @return A uint256 representing the amount of base units owned by the
     *         specified address.
     */
    function balanceOf(address _account) public view returns (uint256) {
        RebaseOptions state = rebaseState[_account];
        if (state == RebaseOptions.YieldDelegationSource) {
            // Saves a slot read when transferring to or from a yield delegating source
            // since we know creditBalances equals the balance.
            return creditBalances[_account];
        }
        uint256 baseBalance = (creditBalances[_account] * 1e18) /
            _creditsPerToken(_account);
        if (state == RebaseOptions.YieldDelegationTarget) {
            // creditBalances of yieldFrom accounts equals token balances
            return baseBalance - creditBalances[yieldFrom[_account]];
        }
        return baseBalance;
    }

    /**
     * @notice Gets the credits balance of the specified address.
     * @dev Backwards compatible with old low res credits per token.
     * @param _account The address to query the balance of.
     * @return (uint256, uint256) Credit balance and credits per token of the
     *         address
     */
    function creditsBalanceOf(address _account)
        external
        view
        returns (uint256, uint256)
    {
        uint256 cpt = _creditsPerToken(_account);
        if (cpt == 1e27) {
            // For a period before the resolution upgrade, we created all new
            // contract accounts at high resolution. Since they are not changing
            // as a result of this upgrade, we will return their true values
            return (creditBalances[_account], cpt);
        } else {
            return (
                creditBalances[_account] / RESOLUTION_INCREASE,
                cpt / RESOLUTION_INCREASE
            );
        }
    }

    /**
     * @notice Gets the credits balance of the specified address.
     * @param _account The address to query the balance of.
     * @return (uint256, uint256, bool) Credit balance, credits per token of the
     *         address, and isUpgraded
     */
    function creditsBalanceOfHighres(address _account)
        external
        view
        returns (
            uint256,
            uint256,
            bool
        )
    {
        return (
            creditBalances[_account],
            _creditsPerToken(_account),
            true // all accounts have their resolution "upgraded"
        );
    }

    // Backwards compatible view
    function nonRebasingCreditsPerToken(address _account)
        external
        view
        returns (uint256)
    {
        return alternativeCreditsPerToken[_account];
    }

    /**
     * @notice Transfer tokens to a specified address.
     * @param _to the address to transfer to.
     * @param _value the amount to be transferred.
     * @return true on success.
     */
    function transfer(address _to, uint256 _value) external returns (bool) {
        require(_to != address(0), "Transfer to zero address");

        _executeTransfer(msg.sender, _to, _value);

        emit Transfer(msg.sender, _to, _value);
        return true;
    }

    /**
     * @notice Transfer tokens from one address to another.
     * @param _from The address you want to send tokens from.
     * @param _to The address you want to transfer to.
     * @param _value The amount of tokens to be transferred.
     * @return true on success.
     */
    function transferFrom(
        address _from,
        address _to,
        uint256 _value
    ) external returns (bool) {
        require(_to != address(0), "Transfer to zero address");
        uint256 userAllowance = allowances[_from][msg.sender];
        require(_value <= userAllowance, "Allowance exceeded");

        unchecked {
            allowances[_from][msg.sender] = userAllowance - _value;
        }

        _executeTransfer(_from, _to, _value);

        emit Transfer(_from, _to, _value);
        return true;
    }

    function _executeTransfer(
        address _from,
        address _to,
        uint256 _value
    ) internal {
        (
            int256 fromRebasingCreditsDiff,
            int256 fromNonRebasingSupplyDiff
        ) = _adjustAccount(_from, -_value.toInt256());
        (
            int256 toRebasingCreditsDiff,
            int256 toNonRebasingSupplyDiff
        ) = _adjustAccount(_to, _value.toInt256());

        _adjustGlobals(
            fromRebasingCreditsDiff + toRebasingCreditsDiff,
            fromNonRebasingSupplyDiff + toNonRebasingSupplyDiff
        );
    }

    function _adjustAccount(address _account, int256 _balanceChange)
        internal
        returns (int256 rebasingCreditsDiff, int256 nonRebasingSupplyDiff)
    {
        RebaseOptions state = rebaseState[_account];
        int256 currentBalance = balanceOf(_account).toInt256();
        if (currentBalance + _balanceChange < 0) {
            revert("Transfer amount exceeds balance");
        }
        uint256 newBalance = (currentBalance + _balanceChange).toUint256();

        if (state == RebaseOptions.YieldDelegationSource) {
            address target = yieldTo[_account];
            uint256 targetOldBalance = balanceOf(target);
            uint256 targetNewCredits = _balanceToRebasingCredits(
                targetOldBalance + newBalance
            );
            rebasingCreditsDiff =
                targetNewCredits.toInt256() -
                creditBalances[target].toInt256();

            creditBalances[_account] = newBalance;
            creditBalances[target] = targetNewCredits;
        } else if (state == RebaseOptions.YieldDelegationTarget) {
            uint256 newCredits = _balanceToRebasingCredits(
                newBalance + creditBalances[yieldFrom[_account]]
            );
            rebasingCreditsDiff =
                newCredits.toInt256() -
                creditBalances[_account].toInt256();
            creditBalances[_account] = newCredits;
        } else {
            _autoMigrate(_account);
            uint256 alternativeCreditsPerTokenMem = alternativeCreditsPerToken[
                _account
            ];
            if (alternativeCreditsPerTokenMem > 0) {
                nonRebasingSupplyDiff = _balanceChange;
                if (alternativeCreditsPerTokenMem != 1e18) {
                    alternativeCreditsPerToken[_account] = 1e18;
                }
                creditBalances[_account] = newBalance;
            } else {
                uint256 newCredits = _balanceToRebasingCredits(newBalance);
                rebasingCreditsDiff =
                    newCredits.toInt256() -
                    creditBalances[_account].toInt256();
                creditBalances[_account] = newCredits;
            }
        }
    }

    function _adjustGlobals(
        int256 _rebasingCreditsDiff,
        int256 _nonRebasingSupplyDiff
    ) internal {
        if (_rebasingCreditsDiff != 0) {
            rebasingCredits_ = (rebasingCredits_.toInt256() +
                _rebasingCreditsDiff).toUint256();
        }
        if (_nonRebasingSupplyDiff != 0) {
            nonRebasingSupply = (nonRebasingSupply.toInt256() +
                _nonRebasingSupplyDiff).toUint256();
        }
    }

    /**
     * @notice Function to check the amount of tokens that _owner has allowed
     *      to `_spender`.
     * @param _owner The address which owns the funds.
     * @param _spender The address which will spend the funds.
     * @return The number of tokens still available for the _spender.
     */
    function allowance(address _owner, address _spender)
        external
        view
        returns (uint256)
    {
        return allowances[_owner][_spender];
    }

    /**
     * @notice Approve the passed address to spend the specified amount of
     *      tokens on behalf of msg.sender.
     * @param _spender The address which will spend the funds.
     * @param _value The amount of tokens to be spent.
     * @return true on success.
     */
    function approve(address _spender, uint256 _value) external returns (bool) {
        allowances[msg.sender][_spender] = _value;
        emit Approval(msg.sender, _spender, _value);
        return true;
    }

    /**
     * @notice Creates `_amount` tokens and assigns them to `_account`,
     *     increasing the total supply.
     */
    function mint(address _account, uint256 _amount) external onlyVault {
        require(_account != address(0), "Mint to the zero address");

        // Account
        (
            int256 toRebasingCreditsDiff,
            int256 toNonRebasingSupplyDiff
        ) = _adjustAccount(_account, _amount.toInt256());
        // Globals
        _adjustGlobals(toRebasingCreditsDiff, toNonRebasingSupplyDiff);
        totalSupply = totalSupply + _amount;

        require(totalSupply < MAX_SUPPLY, "Max supply");
        emit Transfer(address(0), _account, _amount);
    }

    /**
     * @notice Destroys `_amount` tokens from `_account`,
     *     reducing the total supply.
     */
    function burn(address _account, uint256 _amount) external onlyVault {
        require(_account != address(0), "Burn from the zero address");
        if (_amount == 0) {
            return;
        }

        // Account
        (
            int256 toRebasingCreditsDiff,
            int256 toNonRebasingSupplyDiff
        ) = _adjustAccount(_account, -_amount.toInt256());
        // Globals
        _adjustGlobals(toRebasingCreditsDiff, toNonRebasingSupplyDiff);
        totalSupply = totalSupply - _amount;

        emit Transfer(_account, address(0), _amount);
    }

    /**
     * @dev Get the credits per token for an account. Returns a fixed amount
     *      if the account is non-rebasing.
     * @param _account Address of the account.
     */
    function _creditsPerToken(address _account)
        internal
        view
        returns (uint256)
    {
        uint256 alternativeCreditsPerTokenMem = alternativeCreditsPerToken[
            _account
        ];
        if (alternativeCreditsPerTokenMem != 0) {
            return alternativeCreditsPerTokenMem;
        } else {
            return rebasingCreditsPerToken_;
        }
    }

    /**
     * @dev Auto migrate contracts to be non rebasing,
     *     unless they have opted into yield.
     * @param _account Address of the account.
     */
    function _autoMigrate(address _account) internal {
        uint256 codeLen = _account.code.length;
        bool isEOA = (codeLen == 0) ||
            (codeLen == 23 && bytes3(_account.code) == 0xef0100);
        // In previous code versions, contracts would not have had their
        // rebaseState[_account] set to RebaseOptions.NonRebasing when migrated
        // therefore we check the actual accounting used on the account as well.
        if (
            (!isEOA) &&
            rebaseState[_account] == RebaseOptions.NotSet &&
            alternativeCreditsPerToken[_account] == 0
        ) {
            _rebaseOptOut(_account);
        }
    }

    /**
     * @dev Calculates credits from contract's global rebasingCreditsPerToken_, and
     *      also balance that corresponds to those credits. The latter is important
     *      when adjusting the contract's global nonRebasingSupply to circumvent any
     *      possible rounding errors.
     *
     * @param _balance Balance of the account.
     */
    function _balanceToRebasingCredits(uint256 _balance)
        internal
        view
        returns (uint256 rebasingCredits)
    {
        // Rounds up, because we need to ensure that accounts always have
        // at least the balance that they should have.
        // Note this should always be used on an absolute account value,
        // not on a possibly negative diff, because then the rounding would be wrong.
        return ((_balance) * rebasingCreditsPerToken_ + 1e18 - 1) / 1e18;
    }

    /**
     * @notice The calling account will start receiving yield after a successful call.
     * @param _account Address of the account.
     */
    function governanceRebaseOptIn(address _account) external onlyGovernor {
        require(_account != address(0), "Zero address not allowed");
        _rebaseOptIn(_account);
    }

    /**
     * @notice The calling account will start receiving yield after a successful call.
     */
    function rebaseOptIn() external {
        _rebaseOptIn(msg.sender);
    }

    function _rebaseOptIn(address _account) internal {
        uint256 balance = balanceOf(_account);

        // prettier-ignore
        require(
            alternativeCreditsPerToken[_account] > 0 ||
                // Accounts may explicitly `rebaseOptIn` regardless of
                // accounting if they have a 0 balance.
                creditBalances[_account] == 0
            ,
            "Account must be non-rebasing"
        );
        RebaseOptions state = rebaseState[_account];
        // prettier-ignore
        require(
            state == RebaseOptions.StdNonRebasing ||
                state == RebaseOptions.NotSet,
            "Only standard non-rebasing accounts can opt in"
        );

        uint256 newCredits = _balanceToRebasingCredits(balance);

        // Account
        rebaseState[_account] = RebaseOptions.StdRebasing;
        alternativeCreditsPerToken[_account] = 0;
        creditBalances[_account] = newCredits;
        // Globals
        _adjustGlobals(newCredits.toInt256(), -balance.toInt256());

        emit AccountRebasingEnabled(_account);
    }

    /**
     * @notice The calling account will no longer receive yield
     */
    function rebaseOptOut() external {
        _rebaseOptOut(msg.sender);
    }

    function _rebaseOptOut(address _account) internal {
        require(
            alternativeCreditsPerToken[_account] == 0,
            "Account must be rebasing"
        );
        RebaseOptions state = rebaseState[_account];
        require(
            state == RebaseOptions.StdRebasing || state == RebaseOptions.NotSet,
            "Only standard rebasing accounts can opt out"
        );

        uint256 oldCredits = creditBalances[_account];
        uint256 balance = balanceOf(_account);

        // Account
        rebaseState[_account] = RebaseOptions.StdNonRebasing;
        alternativeCreditsPerToken[_account] = 1e18;
        creditBalances[_account] = balance;
        // Globals
        _adjustGlobals(-oldCredits.toInt256(), balance.toInt256());

        emit AccountRebasingDisabled(_account);
    }

    /**
     * @notice Distribute yield to users. This changes the exchange rate
     *  between "credits" and OUSD tokens to change rebasing user's balances.
     * @param _newTotalSupply New total supply of OUSD.
     */
    function changeSupply(uint256 _newTotalSupply) external onlyVault {
        require(totalSupply > 0, "Cannot increase 0 supply");

        if (totalSupply == _newTotalSupply) {
            emit TotalSupplyUpdatedHighres(
                totalSupply,
                rebasingCredits_,
                rebasingCreditsPerToken_
            );
            return;
        }

        totalSupply = _newTotalSupply > MAX_SUPPLY
            ? MAX_SUPPLY
            : _newTotalSupply;

        uint256 rebasingSupply = totalSupply - nonRebasingSupply;
        // round up in the favour of the protocol
        rebasingCreditsPerToken_ =
            (rebasingCredits_ * 1e18 + rebasingSupply - 1) /
            rebasingSupply;

        require(rebasingCreditsPerToken_ > 0, "Invalid change in supply");

        emit TotalSupplyUpdatedHighres(
            totalSupply,
            rebasingCredits_,
            rebasingCreditsPerToken_
        );
    }

    /*
     * @notice Send the yield from one account to another account.
     *         Each account keeps its own balances.
     */
    function delegateYield(address _from, address _to)
        external
        onlyGovernorOrStrategist
    {
        require(_from != address(0), "Zero from address not allowed");
        require(_to != address(0), "Zero to address not allowed");

        require(_from != _to, "Cannot delegate to self");
        require(
            yieldFrom[_to] == address(0) &&
                yieldTo[_to] == address(0) &&
                yieldFrom[_from] == address(0) &&
                yieldTo[_from] == address(0),
            "Blocked by existing yield delegation"
        );
        RebaseOptions stateFrom = rebaseState[_from];
        RebaseOptions stateTo = rebaseState[_to];

        require(
            stateFrom == RebaseOptions.NotSet ||
                stateFrom == RebaseOptions.StdNonRebasing ||
                stateFrom == RebaseOptions.StdRebasing,
            "Invalid rebaseState from"
        );

        require(
            stateTo == RebaseOptions.NotSet ||
                stateTo == RebaseOptions.StdNonRebasing ||
                stateTo == RebaseOptions.StdRebasing,
            "Invalid rebaseState to"
        );

        if (alternativeCreditsPerToken[_from] == 0) {
            _rebaseOptOut(_from);
        }
        if (alternativeCreditsPerToken[_to] > 0) {
            _rebaseOptIn(_to);
        }

        uint256 fromBalance = balanceOf(_from);
        uint256 toBalance = balanceOf(_to);
        uint256 oldToCredits = creditBalances[_to];
        uint256 newToCredits = _balanceToRebasingCredits(
            fromBalance + toBalance
        );

        // Set up the bidirectional links
        yieldTo[_from] = _to;
        yieldFrom[_to] = _from;

        // Local
        rebaseState[_from] = RebaseOptions.YieldDelegationSource;
        alternativeCreditsPerToken[_from] = 1e18;
        creditBalances[_from] = fromBalance;
        rebaseState[_to] = RebaseOptions.YieldDelegationTarget;
        creditBalances[_to] = newToCredits;

        // Global
        int256 creditsChange = newToCredits.toInt256() -
            oldToCredits.toInt256();
        _adjustGlobals(creditsChange, -(fromBalance).toInt256());
        emit YieldDelegated(_from, _to);
    }

    /*
     * @notice Stop sending the yield from one account to another account.
     */
    function undelegateYield(address _from) external onlyGovernorOrStrategist {
        // Require a delegation, which will also ensure a valid delegation
        require(yieldTo[_from] != address(0), "Zero address not allowed");

        address to = yieldTo[_from];
        uint256 fromBalance = balanceOf(_from);
        uint256 toBalance = balanceOf(to);
        uint256 oldToCredits = creditBalances[to];
        uint256 newToCredits = _balanceToRebasingCredits(toBalance);

        // Remove the bidirectional links
        yieldFrom[to] = address(0);
        yieldTo[_from] = address(0);

        // Local
        rebaseState[_from] = RebaseOptions.StdNonRebasing;
        // alternativeCreditsPerToken[from] already 1e18 from `delegateYield()`
        creditBalances[_from] = fromBalance;
        rebaseState[to] = RebaseOptions.StdRebasing;
        // alternativeCreditsPerToken[to] already 0 from `delegateYield()`
        creditBalances[to] = newToCredits;

        // Global
        int256 creditsChange = newToCredits.toInt256() -
            oldToCredits.toInt256();
        _adjustGlobals(creditsChange, fromBalance.toInt256());
        emit YieldUndelegated(_from, to);
    }
}


0.0% contracts/contracts/utils/Helpers.sol

Lines covered: 0 / 1 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import { IBasicToken } from "../interfaces/IBasicToken.sol";

library Helpers {
    /**
     * @notice Fetch the `symbol()` from an ERC20 token
     * @dev Grabs the `symbol()` from a contract
     * @param _token Address of the ERC20 token
     * @return string Symbol of the ERC20 token
     */
    function getSymbol(address _token) internal view returns (string memory) {
        string memory symbol = IBasicToken(_token).symbol();
        return symbol;
    }

    /**
     * @notice Fetch the `decimals()` from an ERC20 token
     * @dev Grabs the `decimals()` from a contract and fails if
     *      the decimal value does not live within a certain range
     * @param _token Address of the ERC20 token
     * @return uint256 Decimals of the ERC20 token
     */
    function getDecimals(address _token) internal view returns (uint256) {
        uint256 decimals = IBasicToken(_token).decimals();
        require(
            decimals >= 4 && decimals <= 18,
            "Token must have sufficient decimal places"
        );

        return decimals;
    }
}


0.0% contracts/contracts/utils/Initializable.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title Base contract any contracts that need to initialize state after deployment.
 * @author Origin Protocol Inc
 */
abstract contract Initializable {
    /**
     * @dev Indicates that the contract has been initialized.
     */
    bool private initialized;

    /**
     * @dev Indicates that the contract is in the process of being initialized.
     */
    bool private initializing;

    /**
     * @dev Modifier to protect an initializer function from being invoked twice.
     */
    modifier initializer() {
        require(
            initializing || !initialized,
            "Initializable: contract is already initialized"
        );

        bool isTopLevelCall = !initializing;
        if (isTopLevelCall) {
            initializing = true;
            initialized = true;
        }

        _;

        if (isTopLevelCall) {
            initializing = false;
        }
    }

    uint256[50] private ______gap;
}


83.0% contracts/contracts/utils/StableMath.sol

Lines covered: 5 / 6 (83.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import { SafeMath } from "@openzeppelin/contracts/utils/math/SafeMath.sol";

// Based on StableMath from Stability Labs Pty. Ltd.
// https://github.com/mstable/mStable-contracts/blob/master/contracts/shared/StableMath.sol

library StableMath {
    using SafeMath for uint256;

    /**
     * @dev Scaling unit for use in specific calculations,
     * where 1 * 10**18, or 1e18 represents a unit '1'
     */
    uint256 private constant FULL_SCALE = 1e18;

    /***************************************
                    Helpers
    ****************************************/

    /**
     * @dev Adjust the scale of an integer
     * @param to Decimals to scale to
     * @param from Decimals to scale from
     */
    function scaleBy(
        uint256 x,
        uint256 to,
        uint256 from
    ) internal pure returns (uint256) {
        if (to > from) {
            x = x.mul(10**(to - from));
        } else if (to < from) {
            // slither-disable-next-line divide-before-multiply
            x = x.div(10**(from - to));
        }
        return x;
    }

    /***************************************
               Precise Arithmetic
    ****************************************/

    /**
     * @dev Multiplies two precise units, and then truncates by the full scale
     * @param x Left hand input to multiplication
     * @param y Right hand input to multiplication
     * @return Result after multiplying the two inputs and then dividing by the shared
     *         scale unit
     */
    function mulTruncate(uint256 x, uint256 y) internal pure returns (uint256) {
        return mulTruncateScale(x, y, FULL_SCALE);
    }

    /**
     * @dev Multiplies two precise units, and then truncates by the given scale. For example,
     * when calculating 90% of 10e18, (10e18 * 9e17) / 1e18 = (9e36) / 1e18 = 9e18
     * @param x Left hand input to multiplication
     * @param y Right hand input to multiplication
     * @param scale Scale unit
     * @return Result after multiplying the two inputs and then dividing by the shared
     *         scale unit
     */
    function mulTruncateScale(
        uint256 x,
        uint256 y,
        uint256 scale
    ) internal pure returns (uint256) {
        // e.g. assume scale = fullScale
        // z = 10e18 * 9e17 = 9e36
        uint256 z = x.mul(y);
        // return 9e36 / 1e18 = 9e18
        return z.div(scale);
    }

    /**
     * @dev Multiplies two precise units, and then truncates by the full scale, rounding up the result
     * @param x Left hand input to multiplication
     * @param y Right hand input to multiplication
     * @return Result after multiplying the two inputs and then dividing by the shared
     *          scale unit, rounded up to the closest base unit.
     */
    function mulTruncateCeil(uint256 x, uint256 y)
        internal
        pure
        returns (uint256)
    {
        // e.g. 8e17 * 17268172638 = 138145381104e17
        uint256 scaled = x.mul(y);
        // e.g. 138145381104e17 + 9.99...e17 = 138145381113.99...e17
        uint256 ceil = scaled.add(FULL_SCALE.sub(1));
        // e.g. 13814538111.399...e18 / 1e18 = 13814538111
        return ceil.div(FULL_SCALE);
    }

    /**
     * @dev Precisely divides two units, by first scaling the left hand operand. Useful
     *      for finding percentage weightings, i.e. 8e18/10e18 = 80% (or 8e17)
     * @param x Left hand input to division
     * @param y Right hand input to division
     * @return Result after multiplying the left operand by the scale, and
     *         executing the division on the right hand input.
     */
    function divPrecisely(uint256 x, uint256 y)
        internal
        pure
        returns (uint256)
    {
        // e.g. 8e18 * 1e18 = 8e36
        uint256 z = x.mul(FULL_SCALE);
        // e.g. 8e36 / 10e18 = 8e17
        return z.div(y);
    }
}


0.0% contracts/contracts/vault/VaultStorage.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

/**
 * @title OToken VaultStorage contract
 * @notice The VaultStorage contract defines the storage for the Vault contracts
 * @author Origin Protocol Inc
 */

import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { Address } from "@openzeppelin/contracts/utils/Address.sol";

import { IStrategy } from "../interfaces/IStrategy.sol";
import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import { Governable } from "../governance/Governable.sol";
import { OUSD } from "../token/OUSD.sol";
import { Initializable } from "../utils/Initializable.sol";
import "../utils/Helpers.sol";

abstract contract VaultStorage is Initializable, Governable {
    using SafeERC20 for IERC20;

    event AssetAllocated(address _asset, address _strategy, uint256 _amount);
    event StrategyApproved(address _addr);
    event StrategyRemoved(address _addr);
    event Mint(address _addr, uint256 _value);
    event Redeem(address _addr, uint256 _value);
    event CapitalPaused();
    event CapitalUnpaused();
    event DefaultStrategyUpdated(address _strategy);
    event RebasePaused();
    event RebaseUnpaused();
    event VaultBufferUpdated(uint256 _vaultBuffer);
    event AllocateThresholdUpdated(uint256 _threshold);
    event StrategistUpdated(address _address);
    event MaxSupplyDiffChanged(uint256 maxSupplyDiff);
    event YieldDistribution(address _to, uint256 _yield, uint256 _fee);
    event TrusteeFeeBpsChanged(uint256 _basis);
    event TrusteeAddressChanged(address _address);
    event StrategyAddedToMintWhitelist(address indexed strategy);
    event StrategyRemovedFromMintWhitelist(address indexed strategy);
    event RebasePerSecondMaxChanged(uint256 rebaseRatePerSecond);
    event DripDurationChanged(uint256 dripDuration);
    event OperatorUpdated(address newOperator);
    event WithdrawalRequested(
        address indexed _withdrawer,
        uint256 indexed _requestId,
        uint256 _amount,
        uint256 _queued
    );
    event WithdrawalClaimed(
        address indexed _withdrawer,
        uint256 indexed _requestId,
        uint256 _amount
    );
    event WithdrawalClaimable(uint256 _claimable, uint256 _newClaimable);
    event WithdrawalClaimDelayUpdated(uint256 _newDelay);

    // Since we are proxy, all state should be uninitalized.
    // Since this storage contract does not have logic directly on it
    // we should not be checking for to see if these variables can be constant.
    // slither-disable-start uninitialized-state
    // slither-disable-start constable-states

    /// @dev mapping of supported vault assets to their configuration
    uint256 private _deprecated_assets;
    /// @dev list of all assets supported by the vault.
    address[] private _deprecated_allAssets;

    // Strategies approved for use by the Vault
    struct Strategy {
        bool isSupported;
        uint256 _deprecated; // Deprecated storage slot
    }
    /// @dev mapping of strategy contracts to their configuration
    mapping(address => Strategy) public strategies;
    /// @dev list of all vault strategies
    address[] internal allStrategies;

    /// @notice Address of the Oracle price provider contract
    address private _deprecated_priceProvider;
    /// @notice pause rebasing if true
    bool public rebasePaused;
    /// @notice pause operations that change the OToken supply.
    /// eg mint, redeem, allocate, mint/burn for strategy
    bool public capitalPaused;
    /// @notice Redemption fee in basis points. eg 50 = 0.5%
    uint256 private _deprecated_redeemFeeBps;
    /// @notice Percentage of assets to keep in Vault to handle (most) withdrawals. 100% = 1e18.
    uint256 public vaultBuffer;
    /// @notice OToken mints over this amount automatically allocate funds. 18 decimals.
    uint256 public autoAllocateThreshold;
    /// @dev Deprecated. Was the auto-rebase trigger threshold for mint/redeem.
    ///      Storage slot retained for proxy compatibility; no longer read or written.
    uint256 internal __deprecatedRebaseThreshold;

    /// @dev Address of the OToken token. eg OUSD or OETH.
    OUSD public oToken;

    /// @dev Address of the contract responsible for post rebase syncs with AMMs
    address private _deprecated_rebaseHooksAddr = address(0);

    /// @dev Deprecated: Address of Uniswap
    address private _deprecated_uniswapAddr = address(0);

    /// @notice Address of the Strategist
    address public strategistAddr = address(0);

    /// @notice Mapping of asset address to the Strategy that they should automatically
    // be allocated to
    uint256 private _deprecated_assetDefaultStrategies;

    /// @notice Max difference between total supply and total value of assets. 18 decimals.
    uint256 public maxSupplyDiff;

    /// @notice Trustee contract that can collect a percentage of yield
    address public trusteeAddress;

    /// @notice Amount of yield collected in basis points. eg 2000 = 20%
    uint256 public trusteeFeeBps;

    /// @dev Deprecated: Tokens that should be swapped for stablecoins
    address[] private _deprecated_swapTokens;

    /// @notice Metapool strategy that is allowed to mint/burn OTokens without changing collateral

    address private _deprecated_ousdMetaStrategy;

    /// @notice How much OTokens are currently minted by the strategy
    int256 private _deprecated_netOusdMintedForStrategy;

    /// @notice How much net total OTokens are allowed to be minted by all strategies
    uint256 private _deprecated_netOusdMintForStrategyThreshold;

    uint256 private _deprecated_swapConfig;

    // List of strategies that can mint oTokens directly
    // Used in OETHBaseVaultCore
    mapping(address => bool) public isMintWhitelistedStrategy;

    /// @notice Address of the Dripper contract that streams harvested rewards to the Vault
    /// @dev The vault is proxied so needs to be set with setDripper against the proxy contract.
    address private _deprecated_dripper;

    /// Withdrawal Queue Storage /////

    struct WithdrawalQueueMetadata {
        // cumulative total of all withdrawal requests included the ones that have already been claimed
        uint128 queued;
        // cumulative total of all the requests that can be claimed including the ones that have already been claimed
        uint128 claimable;
        // total of all the requests that have been claimed
        uint128 claimed;
        // index of the next withdrawal request starting at 0
        uint128 nextWithdrawalIndex;
    }

    /// @notice Global metadata for the withdrawal queue including:
    /// queued - cumulative total of all withdrawal requests included the ones that have already been claimed
    /// claimable - cumulative total of all the requests that can be claimed including the ones already claimed
    /// claimed - total of all the requests that have been claimed
    /// nextWithdrawalIndex - index of the next withdrawal request starting at 0
    WithdrawalQueueMetadata public withdrawalQueueMetadata;

    struct WithdrawalRequest {
        address withdrawer;
        bool claimed;
        uint40 timestamp; // timestamp of the withdrawal request
        // Amount of oTokens to redeem. eg OETH
        uint128 amount;
        // cumulative total of all withdrawal requests including this one.
        // this request can be claimed when this queued amount is less than or equal to the queue's claimable amount.
        uint128 queued;
    }

    /// @notice Mapping of withdrawal request indices to the user withdrawal request data
    mapping(uint256 => WithdrawalRequest) public withdrawalRequests;

    /// @notice Sets a minimum delay that is required to elapse between
    ///     requesting async withdrawals and claiming the request.
    ///     When set to 0 async withdrawals are disabled.
    uint256 public withdrawalClaimDelay;

    /// @notice Time in seconds that the vault last rebased yield.
    uint64 public lastRebase;

    /// @notice Automatic rebase yield calculations. In seconds. Set to 0 or 1 to disable.
    uint64 public dripDuration;

    /// @notice max rebase percentage per second
    ///   Can be used to set maximum yield of the protocol,
    ///   spreading out yield over time
    uint64 public rebasePerSecondMax;

    /// @notice target rebase rate limit, based on past rates and funds available.
    uint64 public rebasePerSecondTarget;

    uint256 internal constant MAX_REBASE = 0.02 ether;
    uint256 internal constant MAX_REBASE_PER_SECOND =
        uint256(0.05 ether) / 1 days;

    /// @notice Default strategy for asset
    address public defaultStrategy;

    /// @notice Address authorized to call `rebase()` directly. The Governor
    ///         and Strategist are always allowed in addition to this address.
    address public operatorAddr;

    // For future use
    uint256[41] private __gap;

    /// @notice Index of WETH asset in allAssets array
    /// Legacy OETHVaultCore code, relocated here for vault consistency.
    uint256 private _deprecated_wethAssetIndex;

    /// @dev Address of the asset (eg. WETH or USDC)
    address public immutable asset;
    uint8 internal immutable assetDecimals;

    // slither-disable-end constable-states
    // slither-disable-end uninitialized-state

    constructor(address _asset) {
        uint8 _decimals = IERC20Metadata(_asset).decimals();
        require(_decimals <= 18, "invalid asset decimals");
        asset = _asset;
        assetDecimals = _decimals;
    }

    /// @notice Deprecated: use `oToken()` instead.
    function oUSD() external view returns (OUSD) {
        return oToken;
    }
}


0.0% lib/openzeppelin-contracts/contracts/token/ERC20/IERC20.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/IERC20.sol)

pragma solidity ^0.8.0;

/**
 * @dev Interface of the ERC20 standard as defined in the EIP.
 */
interface IERC20 {
    /**
     * @dev Returns the amount of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

    /**
     * @dev Returns the amount of tokens owned by `account`.
     */
    function balanceOf(address account) external view returns (uint256);

    /**
     * @dev Moves `amount` tokens from the caller's account to `recipient`.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transfer(address recipient, uint256 amount) external returns (bool);

    /**
     * @dev Returns the remaining number of tokens that `spender` will be
     * allowed to spend on behalf of `owner` through {transferFrom}. This is
     * zero by default.
     *
     * This value changes when {approve} or {transferFrom} are called.
     */
    function allowance(address owner, address spender) external view returns (uint256);

    /**
     * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * IMPORTANT: Beware that changing an allowance with this method brings the risk
     * that someone may use both the old and the new allowance by unfortunate
     * transaction ordering. One possible solution to mitigate this race
     * condition is to first reduce the spender's allowance to 0 and set the
     * desired value afterwards:
     * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
     *
     * Emits an {Approval} event.
     */
    function approve(address spender, uint256 amount) external returns (bool);

    /**
     * @dev Moves `amount` tokens from `sender` to `recipient` using the
     * allowance mechanism. `amount` is then deducted from the caller's
     * allowance.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(
        address sender,
        address recipient,
        uint256 amount
    ) external returns (bool);

    /**
     * @dev Emitted when `value` tokens are moved from one account (`from`) to
     * another (`to`).
     *
     * Note that `value` may be zero.
     */
    event Transfer(address indexed from, address indexed to, uint256 value);

    /**
     * @dev Emitted when the allowance of a `spender` for an `owner` is set by
     * a call to {approve}. `value` is the new allowance.
     */
    event Approval(address indexed owner, address indexed spender, uint256 value);
}


0.0% lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol

Lines covered: 0 / 0 (0.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)

pragma solidity ^0.8.0;

import "../IERC20.sol";

/**
 * @dev Interface for the optional metadata functions from the ERC20 standard.
 *
 * _Available since v4.1._
 */
interface IERC20Metadata is IERC20 {
    /**
     * @dev Returns the name of the token.
     */
    function name() external view returns (string memory);

    /**
     * @dev Returns the symbol of the token.
     */
    function symbol() external view returns (string memory);

    /**
     * @dev Returns the decimals places of the token.
     */
    function decimals() external view returns (uint8);
}


0.0% lib/openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol

Lines covered: 0 / 1 (0.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)

pragma solidity ^0.8.0;

import "../IERC20.sol";
import "../../../utils/Address.sol";

/**
 * @title SafeERC20
 * @dev Wrappers around ERC20 operations that throw on failure (when the token
 * contract returns false). Tokens that return no value (and instead revert or
 * throw on failure) are also supported, non-reverting calls are assumed to be
 * successful.
 * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
 * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
 */
library SafeERC20 {
    using Address for address;

    function safeTransfer(
        IERC20 token,
        address to,
        uint256 value
    ) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
    }

    function safeTransferFrom(
        IERC20 token,
        address from,
        address to,
        uint256 value
    ) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
    }

    /**
     * @dev Deprecated. This function has issues similar to the ones found in
     * {IERC20-approve}, and its usage is discouraged.
     *
     * Whenever possible, use {safeIncreaseAllowance} and
     * {safeDecreaseAllowance} instead.
     */
    function safeApprove(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        // safeApprove should only be called when setting an initial allowance,
        // or when resetting it to zero. To increase and decrease it, use
        // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
        require(
            (value == 0) || (token.allowance(address(this), spender) == 0),
            "SafeERC20: approve from non-zero to non-zero allowance"
        );
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
    }

    function safeIncreaseAllowance(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        uint256 newAllowance = token.allowance(address(this), spender) + value;
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
    }

    function safeDecreaseAllowance(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        unchecked {
            uint256 oldAllowance = token.allowance(address(this), spender);
            require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
            uint256 newAllowance = oldAllowance - value;
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
        }
    }

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     */
    function _callOptionalReturn(IERC20 token, bytes memory data) private {
        // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
        // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
        // the target address contains contract code and also asserts for success in the low-level call.

        bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
        if (returndata.length > 0) {
            // Return data is optional
            require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
        }
    }
}


0.0% lib/openzeppelin-contracts/contracts/utils/Address.sol

Lines covered: 0 / 1 (0.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Address.sol)

pragma solidity ^0.8.0;

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev Returns true if `account` is a contract.
     *
     * [IMPORTANT]
     * ====
     * It is unsafe to assume that an address for which this function returns
     * false is an externally-owned account (EOA) and not a contract.
     *
     * Among others, `isContract` will return false for the following
     * types of addresses:
     *
     *  - an externally-owned account
     *  - a contract in construction
     *  - an address where a contract will be created
     *  - an address where a contract lived, but was destroyed
     * ====
     */
    function isContract(address account) internal view returns (bool) {
        // This method relies on extcodesize, which returns 0 for contracts in
        // construction, since the code is only stored at the end of the
        // constructor execution.

        uint256 size;
        assembly {
            size := extcodesize(account)
        }
        return size > 0;
    }

    /**
     * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
     * `recipient`, forwarding all available gas and reverting on errors.
     *
     * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
     * of certain opcodes, possibly making contracts go over the 2300 gas limit
     * imposed by `transfer`, making them unable to receive funds via
     * `transfer`. {sendValue} removes this limitation.
     *
     * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
     *
     * IMPORTANT: because control is transferred to `recipient`, care must be
     * taken to not create reentrancy vulnerabilities. Consider using
     * {ReentrancyGuard} or the
     * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
     */
    function sendValue(address payable recipient, uint256 amount) internal {
        require(address(this).balance >= amount, "Address: insufficient balance");

        (bool success, ) = recipient.call{value: amount}("");
        require(success, "Address: unable to send value, recipient may have reverted");
    }

    /**
     * @dev Performs a Solidity function call using a low level `call`. A
     * plain `call` is an unsafe replacement for a function call: use this
     * function instead.
     *
     * If `target` reverts with a revert reason, it is bubbled up by this
     * function (like regular Solidity function calls).
     *
     * Returns the raw returned data. To convert to the expected return value,
     * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
     *
     * Requirements:
     *
     * - `target` must be a contract.
     * - calling `target` with `data` must not revert.
     *
     * _Available since v3.1._
     */
    function functionCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionCall(target, data, "Address: low-level call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
     * `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but also transferring `value` wei to `target`.
     *
     * Requirements:
     *
     * - the calling contract must have an ETH balance of at least `value`.
     * - the called Solidity function must be `payable`.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
    }

    /**
     * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
     * with `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value,
        string memory errorMessage
    ) internal returns (bytes memory) {
        require(address(this).balance >= value, "Address: insufficient balance for call");
        require(isContract(target), "Address: call to non-contract");

        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
        return functionStaticCall(target, data, "Address: low-level static call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        require(isContract(target), "Address: static call to non-contract");

        (bool success, bytes memory returndata) = target.staticcall(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionDelegateCall(target, data, "Address: low-level delegate call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        require(isContract(target), "Address: delegate call to non-contract");

        (bool success, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
     * revert reason using the provided one.
     *
     * _Available since v4.3._
     */
    function verifyCallResult(
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal pure returns (bytes memory) {
        if (success) {
            return returndata;
        } else {
            // Look for revert reason and bubble it up if present
            if (returndata.length > 0) {
                // The easiest way to bubble the revert reason is using memory via assembly

                assembly {
                    let returndata_size := mload(returndata)
                    revert(add(32, returndata), returndata_size)
                }
            } else {
                revert(errorMessage);
            }
        }
    }
}


83.0% lib/openzeppelin-contracts/contracts/utils/math/SafeCast.sol

Lines covered: 5 / 6 (83.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/math/SafeCast.sol)

pragma solidity ^0.8.0;

/**
 * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow
 * checks.
 *
 * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
 * easily result in undesired exploitation or bugs, since developers usually
 * assume that overflows raise errors. `SafeCast` restores this intuition by
 * reverting the transaction when such an operation overflows.
 *
 * Using this library instead of the unchecked operations eliminates an entire
 * class of bugs, so it's recommended to use it always.
 *
 * Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing
 * all math on `uint256` and `int256` and then downcasting.
 */
library SafeCast {
    /**
     * @dev Returns the downcasted uint224 from uint256, reverting on
     * overflow (when the input is greater than largest uint224).
     *
     * Counterpart to Solidity's `uint224` operator.
     *
     * Requirements:
     *
     * - input must fit into 224 bits
     */
    function toUint224(uint256 value) internal pure returns (uint224) {
        require(value <= type(uint224).max, "SafeCast: value doesn't fit in 224 bits");
        return uint224(value);
    }

    /**
     * @dev Returns the downcasted uint128 from uint256, reverting on
     * overflow (when the input is greater than largest uint128).
     *
     * Counterpart to Solidity's `uint128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     */
    function toUint128(uint256 value) internal pure returns (uint128) {
        require(value <= type(uint128).max, "SafeCast: value doesn't fit in 128 bits");
        return uint128(value);
    }

    /**
     * @dev Returns the downcasted uint96 from uint256, reverting on
     * overflow (when the input is greater than largest uint96).
     *
     * Counterpart to Solidity's `uint96` operator.
     *
     * Requirements:
     *
     * - input must fit into 96 bits
     */
    function toUint96(uint256 value) internal pure returns (uint96) {
        require(value <= type(uint96).max, "SafeCast: value doesn't fit in 96 bits");
        return uint96(value);
    }

    /**
     * @dev Returns the downcasted uint64 from uint256, reverting on
     * overflow (when the input is greater than largest uint64).
     *
     * Counterpart to Solidity's `uint64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     */
    function toUint64(uint256 value) internal pure returns (uint64) {
        require(value <= type(uint64).max, "SafeCast: value doesn't fit in 64 bits");
        return uint64(value);
    }

    /**
     * @dev Returns the downcasted uint32 from uint256, reverting on
     * overflow (when the input is greater than largest uint32).
     *
     * Counterpart to Solidity's `uint32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     */
    function toUint32(uint256 value) internal pure returns (uint32) {
        require(value <= type(uint32).max, "SafeCast: value doesn't fit in 32 bits");
        return uint32(value);
    }

    /**
     * @dev Returns the downcasted uint16 from uint256, reverting on
     * overflow (when the input is greater than largest uint16).
     *
     * Counterpart to Solidity's `uint16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     */
    function toUint16(uint256 value) internal pure returns (uint16) {
        require(value <= type(uint16).max, "SafeCast: value doesn't fit in 16 bits");
        return uint16(value);
    }

    /**
     * @dev Returns the downcasted uint8 from uint256, reverting on
     * overflow (when the input is greater than largest uint8).
     *
     * Counterpart to Solidity's `uint8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits.
     */
    function toUint8(uint256 value) internal pure returns (uint8) {
        require(value <= type(uint8).max, "SafeCast: value doesn't fit in 8 bits");
        return uint8(value);
    }

    /**
     * @dev Converts a signed int256 into an unsigned uint256.
     *
     * Requirements:
     *
     * - input must be greater than or equal to 0.
     */
    function toUint256(int256 value) internal pure returns (uint256) {
        require(value >= 0, "SafeCast: value must be positive");
        return uint256(value);
    }

    /**
     * @dev Returns the downcasted int128 from int256, reverting on
     * overflow (when the input is less than smallest int128 or
     * greater than largest int128).
     *
     * Counterpart to Solidity's `int128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     *
     * _Available since v3.1._
     */
    function toInt128(int256 value) internal pure returns (int128) {
        require(value >= type(int128).min && value <= type(int128).max, "SafeCast: value doesn't fit in 128 bits");
        return int128(value);
    }

    /**
     * @dev Returns the downcasted int64 from int256, reverting on
     * overflow (when the input is less than smallest int64 or
     * greater than largest int64).
     *
     * Counterpart to Solidity's `int64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     *
     * _Available since v3.1._
     */
    function toInt64(int256 value) internal pure returns (int64) {
        require(value >= type(int64).min && value <= type(int64).max, "SafeCast: value doesn't fit in 64 bits");
        return int64(value);
    }

    /**
     * @dev Returns the downcasted int32 from int256, reverting on
     * overflow (when the input is less than smallest int32 or
     * greater than largest int32).
     *
     * Counterpart to Solidity's `int32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     *
     * _Available since v3.1._
     */
    function toInt32(int256 value) internal pure returns (int32) {
        require(value >= type(int32).min && value <= type(int32).max, "SafeCast: value doesn't fit in 32 bits");
        return int32(value);
    }

    /**
     * @dev Returns the downcasted int16 from int256, reverting on
     * overflow (when the input is less than smallest int16 or
     * greater than largest int16).
     *
     * Counterpart to Solidity's `int16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     *
     * _Available since v3.1._
     */
    function toInt16(int256 value) internal pure returns (int16) {
        require(value >= type(int16).min && value <= type(int16).max, "SafeCast: value doesn't fit in 16 bits");
        return int16(value);
    }

    /**
     * @dev Returns the downcasted int8 from int256, reverting on
     * overflow (when the input is less than smallest int8 or
     * greater than largest int8).
     *
     * Counterpart to Solidity's `int8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits.
     *
     * _Available since v3.1._
     */
    function toInt8(int256 value) internal pure returns (int8) {
        require(value >= type(int8).min && value <= type(int8).max, "SafeCast: value doesn't fit in 8 bits");
        return int8(value);
    }

    /**
     * @dev Converts an unsigned uint256 into a signed int256.
     *
     * Requirements:
     *
     * - input must be less than or equal to maxInt256.
     */
    function toInt256(uint256 value) internal pure returns (int256) {
        // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
        require(value <= uint256(type(int256).max), "SafeCast: value doesn't fit in an int256");
        return int256(value);
    }
}


80.0% lib/openzeppelin-contracts/contracts/utils/math/SafeMath.sol

Lines covered: 4 / 5 (80.0%)

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/math/SafeMath.sol)

pragma solidity ^0.8.0;

// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.

/**
 * @dev Wrappers over Solidity's arithmetic operations.
 *
 * NOTE: `SafeMath` is generally not needed starting with Solidity 0.8, since the compiler
 * now has built in overflow checking.
 */
library SafeMath {
    /**
     * @dev Returns the addition of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            uint256 c = a + b;
            if (c < a) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the substraction of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b > a) return (false, 0);
            return (true, a - b);
        }
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
            // benefit is lost if 'b' is also tested.
            // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
            if (a == 0) return (true, 0);
            uint256 c = a * b;
            if (c / a != b) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the division of two unsigned integers, with a division by zero flag.
     *
     * _Available since v3.4._
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a / b);
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
     *
     * _Available since v3.4._
     */
    function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a % b);
        }
    }

    /**
     * @dev Returns the addition of two unsigned integers, reverting on
     * overflow.
     *
     * Counterpart to Solidity's `+` operator.
     *
     * Requirements:
     *
     * - Addition cannot overflow.
     */
    function add(uint256 a, uint256 b) internal pure returns (uint256) {
        return a + b;
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, reverting on
     * overflow (when the result is negative).
     *
     * Counterpart to Solidity's `-` operator.
     *
     * Requirements:
     *
     * - Subtraction cannot overflow.
     */
    function sub(uint256 a, uint256 b) internal pure returns (uint256) {
        return a - b;
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, reverting on
     * overflow.
     *
     * Counterpart to Solidity's `*` operator.
     *
     * Requirements:
     *
     * - Multiplication cannot overflow.
     */
    function mul(uint256 a, uint256 b) internal pure returns (uint256) {
        return a * b;
    }

    /**
     * @dev Returns the integer division of two unsigned integers, reverting on
     * division by zero. The result is rounded towards zero.
     *
     * Counterpart to Solidity's `/` operator.
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function div(uint256 a, uint256 b) internal pure returns (uint256) {
        return a / b;
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
     * reverting when dividing by zero.
     *
     * Counterpart to Solidity's `%` operator. This function uses a `revert`
     * opcode (which leaves remaining gas untouched) while Solidity uses an
     * invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function mod(uint256 a, uint256 b) internal pure returns (uint256) {
        return a % b;
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
     * overflow (when the result is negative).
     *
     * CAUTION: This function is deprecated because it requires allocating memory for the error
     * message unnecessarily. For custom revert reasons use {trySub}.
     *
     * Counterpart to Solidity's `-` operator.
     *
     * Requirements:
     *
     * - Subtraction cannot overflow.
     */
    function sub(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b <= a, errorMessage);
            return a - b;
        }
    }

    /**
     * @dev Returns the integer division of two unsigned integers, reverting with custom message on
     * division by zero. The result is rounded towards zero.
     *
     * Counterpart to Solidity's `/` operator. Note: this function uses a
     * `revert` opcode (which leaves remaining gas untouched) while Solidity
     * uses an invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function div(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b > 0, errorMessage);
            return a / b;
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
     * reverting with custom message when dividing by zero.
     *
     * CAUTION: This function is deprecated because it requires allocating memory for the error
     * message unnecessarily. For custom revert reasons use {tryMod}.
     *
     * Counterpart to Solidity's `%` operator. This function uses a `revert`
     * opcode (which leaves remaining gas untouched) while Solidity uses an
     * invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function mod(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b > 0, errorMessage);
            return a % b;
        }
    }
}


100.0% test/recon/CryticTester.sol

Lines covered: 1 / 1 (100.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import {Properties} from "./Properties.sol";

// echidna test/recon/CryticTester.sol --contract CryticTester --config echidna.yaml
contract CryticTester is Properties {}


88.0% test/recon/Properties.sol

Lines covered: 8 / 9 (88.0%)

// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;

import {Echidna} from "../../contracts/contracts/echidna/Echidna.sol";

/// @notice scfuzzbench adaptation layer: canary checks on top of the
/// upstream OUSD Echidna suite. Assertion failures are surfaced the same
/// way for Echidna, Medusa, Foundry, and Recon (AssertionFailed event +
/// assert), and dedup to the emitting function name across fuzzers.
abstract contract Properties is Echidna {
    string internal constant ASSERTION_CANARY = "!!! canary assertion";
    string internal constant INVARIANT_CANARY_GLOBAL_INVARIANT_FAILURE = "Canary invariant";

    event AssertionFailed(string reason);

    function t(bool b, string memory reason) internal {
        if (!b) {
            emit AssertionFailed(reason);
            assert(false);
        }
    }

    function invariant_canary() public returns (bool) {
        t(false, INVARIANT_CANARY_GLOBAL_INVARIANT_FAILURE);
        return true;
    }

    function assert_canary_ASSERTION_CANARY(uint256 entropy) public {
        t(entropy > 0, ASSERTION_CANARY);
    }
}


1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	library Debugger {
5	event Debug(string debugString);
6	event Debug(string description, string data);
7	event Debug(string prefix, string description, string data);
8	event Debug(string description, bytes32 data);
9	event Debug(string prefix, string description, bytes32 data);
10	event Debug(string description, uint256 data);
11	event Debug(string prefix, string description, uint256 data);
12	event Debug(string description, int256 data);
13	event Debug(string prefix, string description, int256 data);
14	event Debug(string description, address data);
15	event Debug(string prefix, string description, address data);
16	event Debug(string description, bool data);
17	event Debug(string prefix, string description, bool data);
18
19	function log(string memory debugString) internal {
20	emit Debug(debugString);
21	}
22
23	function log(string memory description, string memory data) internal {
24	emit Debug(description, data);
25	}
26
27	function log(
28	string memory prefix,
29	string memory description,
30	string memory data
31	) internal {
32	emit Debug(prefix, description, data);
33	}
34
35	function log(string memory description, bytes32 data) internal {
36	emit Debug(description, data);
37	}
38
39	function log(
40	string memory prefix,
41	string memory description,
42	bytes32 data
43	) internal {
44	emit Debug(prefix, description, data);
45	}
46
47	function log(string memory description, uint256 data) internal {
48	emit Debug(description, data);
49	}
50
51	function log(
52	string memory prefix,
53	string memory description,
54	uint256 data
55	) internal {
56	emit Debug(prefix, description, data);
57	}
58
59	function log(string memory description, int256 data) internal {
60	emit Debug(description, data);
61	}
62
63	function log(
64	string memory prefix,
65	string memory description,
66	int256 data
67	) internal {
68	emit Debug(prefix, description, data);
69	}
70
71	function log(string memory description, address data) internal {
72	emit Debug(description, data);
73	}
74
75	function log(
76	string memory prefix,
77	string memory description,
78	address data
79	) internal {
80	emit Debug(prefix, description, data);
81	}
82
83	function log(string memory description, bool data) internal {
84	emit Debug(description, data);
85	}
86
87	function log(
88	string memory prefix,
89	string memory description,
90	bool data
91	) internal {
92	emit Debug(prefix, description, data);
93	}
94	}
95

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import "./EchidnaTestApproval.sol";
5
6	/**
7	* @title Echidna test contract for OUSD
8	* @notice Target contract to be tested, containing all mixins
9	* @author Rappie
10	*/
11	contract Echidna is EchidnaTestApproval {
12
13	}
14

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	/**
5	* @title Top-level mixin for configuring the desired fuzzing setup
6	* @author Rappie
7	*/
8	contract EchidnaConfig {
9	address internal constant ADDRESS_VAULT = address(0x10000);
10	address internal constant ADDRESS_OUTSIDER_USER = address(0x20000);
11
12	address internal constant ADDRESS_USER0 = address(0x30000);
13	address internal constant ADDRESS_USER1 = address(0x40000);
14
15	// Will be set in EchidnaSetup constructor
16	address internal ADDRESS_OUTSIDER_CONTRACT;
17	address internal ADDRESS_CONTRACT0;
18	address internal ADDRESS_CONTRACT1;
19
20	// Toggle known issues
21	//
22	// This can be used to skip tests that are known to fail. This is useful
23	// when debugging a specific issue, but should be disabled when running
24	// the full test suite.
25	//
26	// True => skip tests that are known to fail
27	// False => run all tests
28	//
29	bool internal constant TOGGLE_KNOWN_ISSUES = false;
30
31	// Toggle known issues within limits
32	//
33	// Same as TOGGLE_KNOWN_ISSUES, but also skip tests that are known to fail
34	// within limits set by the variables below.
35	//
36	bool internal constant TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS = false;
37
38	// Starting balance
39	//
40	// Gives OUSD a non-zero starting supply, which can be useful to ignore
41	// certain edge cases.
42	//
43	// The starting balance is given to outsider accounts that are not used as
44	// accounts while fuzzing.
45	//
46	bool internal constant TOGGLE_STARTING_BALANCE = true;
47	uint256 internal constant STARTING_BALANCE = 1_000_000e18;
48
49	// Change supply
50	//
51	// Set a limit to the amount of change per rebase, which can be useful to
52	// ignore certain edge cases.
53	//
54	// True => limit the amount of change to a percentage of total supply
55	// False => no limit
56	//
57	bool internal constant TOGGLE_CHANGESUPPLY_LIMIT = true;
58	uint256 internal constant CHANGESUPPLY_DIVISOR = 10; // 10% of total supply
59
60	// Mint limit
61	//
62	// Set a limit the amount minted per mint, which can be useful to
63	// ignore certain edge cases.
64	//
65	// True => limit the amount of minted tokens
66	// False => no limit
67	//
68	bool internal constant TOGGLE_MINT_LIMIT = true;
69	uint256 internal constant MINT_MODULO = 1_000_000_000_000e18;
70
71	// Known rounding errors
72	uint256 internal constant TRANSFER_ROUNDING_ERROR = 1e18 - 1;
73	uint256 internal constant OPT_IN_ROUNDING_ERROR = 1e18 - 1;
74	uint256 internal constant MINT_ROUNDING_ERROR = 1e18 - 1;
75
76	/**
77	* @notice Modifier to skip tests that are known to fail
78	* @dev see TOGGLE_KNOWN_ISSUES for more information
79	*/
80	modifier hasKnownIssue() {
81	if (TOGGLE_KNOWN_ISSUES) return;
82	_;
83	}
84
85	/**
86	* @notice Modifier to skip tests that are known to fail within limits
87	* @dev see TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS for more information
88	*/
89	modifier hasKnownIssueWithinLimits() {
90	if (TOGGLE_KNOWN_ISSUES_WITHIN_LIMITS) return;
91	_;
92	}
93
94	/**
95	* @notice Translate an account ID to an address
96	* @param accountId The ID of the account
97	* @return account The address of the account
98	*/
99	function getAccount(uint8 accountId)
100	internal
101	view
102	returns (address account)
103	{
104	accountId = accountId / 64;
105	if (accountId == 0) return account = ADDRESS_USER0;
106	if (accountId == 1) return account = ADDRESS_USER1;
107	if (accountId == 2) return account = ADDRESS_CONTRACT0;
108	if (accountId == 3) return account = ADDRESS_CONTRACT1;
109	require(false, "Unknown account ID");
110	}
111	}
112

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import { Address } from "@openzeppelin/contracts/utils/Address.sol";
5
6	import "./EchidnaHelper.sol";
7	import "./Debugger.sol";
8
9	import "../token/OUSD.sol";
10
11	/**
12	* @title Room for random debugging functions
13	* @author Rappie
14	*/
15	contract EchidnaDebug is EchidnaHelper {
16	function debugOUSD() public pure {
17	// assert(ousd.balanceOf(ADDRESS_USER0) == 1000);
18	// assert(ousd.rebaseState(ADDRESS_USER0) != OUSD.RebaseOptions.OptIn);
19	// assert(Address.isContract(ADDRESS_CONTRACT0));
20	// Debugger.log("nonRebasingSupply", ousd.nonRebasingSupply());
21	// assert(false);
22	}
23	}
24

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import "./EchidnaSetup.sol";
5	import "./Debugger.sol";
6
7	/**
8	* @title Mixin containing helper functions
9	* @author Rappie
10	*/
11	contract EchidnaHelper is EchidnaSetup {
12	/**
13	* @notice Mint tokens to an account
14	* @param toAcc Account to mint to
15	* @param amount Amount to mint
16	* @return Amount minted (in case of capped mint with modulo)
17	*/
18	function mint(uint8 toAcc, uint256 amount) public returns (uint256) {
19	address to = getAccount(toAcc);
20
21	if (TOGGLE_MINT_LIMIT) {
22	amount = amount % MINT_MODULO;
23	}
24
25	hevm.prank(ADDRESS_VAULT);
26	ousd.mint(to, amount);
27
28	return amount;
29	}
30
31	/**
32	* @notice Burn tokens from an account
33	* @param fromAcc Account to burn from
34	* @param amount Amount to burn
35	*/
36	function burn(uint8 fromAcc, uint256 amount) public {
37	address from = getAccount(fromAcc);
38	hevm.prank(ADDRESS_VAULT);
39	ousd.burn(from, amount);
40	}
41
42	/**
43	* @notice Change the total supply of OUSD (rebase)
44	* @param amount New total supply
45	*/
46	function changeSupply(uint256 amount) public {
47	if (TOGGLE_CHANGESUPPLY_LIMIT) {
48	amount =
49	ousd.totalSupply() +
50	(amount % (ousd.totalSupply() / CHANGESUPPLY_DIVISOR));
51	}
52
53	hevm.prank(ADDRESS_VAULT);
54	ousd.changeSupply(amount);
55	}
56
57	/**
58	* @notice Transfer tokens between accounts
59	* @param fromAcc Account to transfer from
60	* @param toAcc Account to transfer to
61	* @param amount Amount to transfer
62	*/
63	function transfer(
64	uint8 fromAcc,
65	uint8 toAcc,
66	uint256 amount
67	) public {
68	address from = getAccount(fromAcc);
69	address to = getAccount(toAcc);
70	hevm.prank(from);
71	// slither-disable-next-line unchecked-transfer
72	ousd.transfer(to, amount);
73	}
74
75	/**
76	* @notice Transfer approved tokens between accounts
77	* @param authorizedAcc Account that is authorized to transfer
78	* @param fromAcc Account to transfer from
79	* @param toAcc Account to transfer to
80	* @param amount Amount to transfer
81	*/
82	function transferFrom(
83	uint8 authorizedAcc,
84	uint8 fromAcc,
85	uint8 toAcc,
86	uint256 amount
87	) public {
88	address authorized = getAccount(authorizedAcc);
89	address from = getAccount(fromAcc);
90	address to = getAccount(toAcc);
91	hevm.prank(authorized);
92	// slither-disable-next-line unchecked-transfer
93	ousd.transferFrom(from, to, amount);
94	}
95
96	/**
97	* @notice Opt in to rebasing
98	* @param targetAcc Account to opt in
99	*/
100	function optIn(uint8 targetAcc) public {
101	address target = getAccount(targetAcc);
102	hevm.prank(target);
103	ousd.rebaseOptIn();
104	}
105
106	/**
107	* @notice Opt out of rebasing
108	* @param targetAcc Account to opt out
109	*/
110	function optOut(uint8 targetAcc) public {
111	address target = getAccount(targetAcc);
112	hevm.prank(target);
113	ousd.rebaseOptOut();
114	}
115
116	/**
117	* @notice Approve an account to spend OUSD
118	* @param ownerAcc Account that owns the OUSD
119	* @param spenderAcc Account that is approved to spend the OUSD
120	* @param amount Amount to approve
121	*/
122	function approve(
123	uint8 ownerAcc,
124	uint8 spenderAcc,
125	uint256 amount
126	) public {
127	address owner = getAccount(ownerAcc);
128	address spender = getAccount(spenderAcc);
129	hevm.prank(owner);
130	// slither-disable-next-line unused-return
131	ousd.approve(spender, amount);
132	}
133
134	/**
135	* @notice Get the sum of all OUSD balances
136	* @return total Total balance
137	*/
138	function getTotalBalance() public view returns (uint256 total) {
139	total += ousd.balanceOf(ADDRESS_VAULT);
140	total += ousd.balanceOf(ADDRESS_OUTSIDER_USER);
141	total += ousd.balanceOf(ADDRESS_OUTSIDER_CONTRACT);
142	total += ousd.balanceOf(ADDRESS_USER0);
143	total += ousd.balanceOf(ADDRESS_USER1);
144	total += ousd.balanceOf(ADDRESS_CONTRACT0);
145	total += ousd.balanceOf(ADDRESS_CONTRACT1);
146	}
147
148	/**
149	* @notice Get the sum of all non-rebasing OUSD balances
150	* @return total Total balance
151	*/
152	function getTotalNonRebasingBalance() public returns (uint256 total) {
153	total += ousd._isNonRebasingAccountEchidna(ADDRESS_VAULT)
154	? ousd.balanceOf(ADDRESS_VAULT)
155	: 0;
156	total += ousd._isNonRebasingAccountEchidna(ADDRESS_OUTSIDER_USER)
157	? ousd.balanceOf(ADDRESS_OUTSIDER_USER)
158	: 0;
159	total += ousd._isNonRebasingAccountEchidna(ADDRESS_OUTSIDER_CONTRACT)
160	? ousd.balanceOf(ADDRESS_OUTSIDER_CONTRACT)
161	: 0;
162	total += ousd._isNonRebasingAccountEchidna(ADDRESS_USER0)
163	? ousd.balanceOf(ADDRESS_USER0)
164	: 0;
165	total += ousd._isNonRebasingAccountEchidna(ADDRESS_USER1)
166	? ousd.balanceOf(ADDRESS_USER1)
167	: 0;
168	total += ousd._isNonRebasingAccountEchidna(ADDRESS_CONTRACT0)
169	? ousd.balanceOf(ADDRESS_CONTRACT0)
170	: 0;
171	total += ousd._isNonRebasingAccountEchidna(ADDRESS_CONTRACT1)
172	? ousd.balanceOf(ADDRESS_CONTRACT1)
173	: 0;
174	}
175	}
176

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import "./IHevm.sol";
5	import "./EchidnaConfig.sol";
6	import "./OUSDEchidna.sol";
7
8	contract Dummy {}
9
10	/**
11	* @title Mixin for setup and deployment
12	* @author Rappie
13	*/
14	contract EchidnaSetup is EchidnaConfig {
15	IHevm hevm = IHevm(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
16	OUSDEchidna ousd = new OUSDEchidna();
17
18	/**
19	* @notice Deploy the OUSD contract and set up initial state
20	*/
21	constructor() {
22	ousd.initialize(ADDRESS_VAULT, 1e18);
23
24	// Deploy dummny contracts as users
25	Dummy outsider = new Dummy();
26	ADDRESS_OUTSIDER_CONTRACT = address(outsider);
27	Dummy dummy0 = new Dummy();
28	ADDRESS_CONTRACT0 = address(dummy0);
29	Dummy dummy1 = new Dummy();
30	ADDRESS_CONTRACT1 = address(dummy1);
31
32	// Start out with a reasonable amount of OUSD
33	if (TOGGLE_STARTING_BALANCE) {
34	// Rebasing tokens
35	hevm.prank(ADDRESS_VAULT);
36	ousd.mint(ADDRESS_OUTSIDER_USER, STARTING_BALANCE / 2);
37
38	// Non-rebasing tokens
39	hevm.prank(ADDRESS_VAULT);
40	ousd.mint(ADDRESS_OUTSIDER_CONTRACT, STARTING_BALANCE / 2);
41	}
42	}
43	}
44

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import "./EchidnaDebug.sol";
5	import "./EchidnaTestSupply.sol";
6
7	/**
8	* @title Mixin for testing accounting functions
9	* @author Rappie
10	*/
11	contract EchidnaTestAccounting is EchidnaTestSupply {
12	/**
13	* @notice After opting in, balance should not increase. (Ok to lose rounding funds doing this)
14	* @param targetAcc Account to opt in
15	*/
16	function testOptInBalance(uint8 targetAcc) public {
17	address target = getAccount(targetAcc);
18
19	uint256 balanceBefore = ousd.balanceOf(target);
20	optIn(targetAcc);
21	uint256 balanceAfter = ousd.balanceOf(target);
22
23	assert(balanceAfter <= balanceBefore);
24	}
25
26	/**
27	* @notice After opting out, balance should remain the same
28	* @param targetAcc Account to opt out
29	*/
30	function testOptOutBalance(uint8 targetAcc) public {
31	address target = getAccount(targetAcc);
32
33	uint256 balanceBefore = ousd.balanceOf(target);
34	optOut(targetAcc);
35	uint256 balanceAfter = ousd.balanceOf(target);
36
37	assert(balanceAfter == balanceBefore);
38	}
39
40	/**
41	* @notice Account balance should remain the same after opting in minus rounding error
42	* @param targetAcc Account to opt in
43	*/
44	function testOptInBalanceRounding(uint8 targetAcc) public {
45	address target = getAccount(targetAcc);
46
47	uint256 balanceBefore = ousd.balanceOf(target);
48	optIn(targetAcc);
49	uint256 balanceAfter = ousd.balanceOf(target);
50
51	int256 delta = int256(balanceAfter) - int256(balanceBefore);
52	Debugger.log("delta", delta);
53
54	// slither-disable-next-line tautology
55	assert(-1 * delta >= 0);
56	assert(-1 * delta <= int256(OPT_IN_ROUNDING_ERROR));
57	}
58
59	/**
60	* @notice After opting in, total supply should remain the same
61	* @param targetAcc Account to opt in
62	*/
63	function testOptInTotalSupply(uint8 targetAcc) public {
64	uint256 totalSupplyBefore = ousd.totalSupply();
65	optIn(targetAcc);
66	uint256 totalSupplyAfter = ousd.totalSupply();
67
68	assert(totalSupplyAfter == totalSupplyBefore);
69	}
70
71	/**
72	* @notice After opting out, total supply should remain the same
73	* @param targetAcc Account to opt out
74	*/
75	function testOptOutTotalSupply(uint8 targetAcc) public {
76	uint256 totalSupplyBefore = ousd.totalSupply();
77	optOut(targetAcc);
78	uint256 totalSupplyAfter = ousd.totalSupply();
79
80	assert(totalSupplyAfter == totalSupplyBefore);
81	}
82
83	/**
84	* @notice Account balance should remain the same when a smart contract auto converts
85	* @param targetAcc Account to auto convert
86	*/
87	function testAutoConvertBalance(uint8 targetAcc) public {
88	address target = getAccount(targetAcc);
89
90	uint256 balanceBefore = ousd.balanceOf(target);
91	// slither-disable-next-line unused-return
92	ousd._isNonRebasingAccountEchidna(target);
93	uint256 balanceAfter = ousd.balanceOf(target);
94
95	assert(balanceAfter == balanceBefore);
96	}
97
98	/**
99	* @notice The `balanceOf` function should never revert
100	* @param targetAcc Account to check balance of
101	*/
102	function testBalanceOfShouldNotRevert(uint8 targetAcc) public {
103	address target = getAccount(targetAcc);
104
105	// slither-disable-next-line unused-return
106	try ousd.balanceOf(target) {
107	assert(true);
108	} catch {
109	assert(false);
110	}
111	}
112	}
113

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import "./EchidnaTestMintBurn.sol";
5	import "./Debugger.sol";
6
7	/**
8	* @title Mixin for testing approval related functions
9	* @author Rappie
10	*/
11	contract EchidnaTestApproval is EchidnaTestMintBurn {
12	/**
13	* @notice Performing `transferFrom` with an amount inside the allowance should not revert
14	* @param authorizedAcc The account that is authorized to transfer
15	* @param fromAcc The account that is transferring
16	* @param toAcc The account that is receiving
17	* @param amount The amount to transfer
18	*/
19	function testTransferFromShouldNotRevert(
20	uint8 authorizedAcc,
21	uint8 fromAcc,
22	uint8 toAcc,
23	uint256 amount
24	) public {
25	address authorized = getAccount(authorizedAcc);
26	address from = getAccount(fromAcc);
27	address to = getAccount(toAcc);
28
29	require(amount <= ousd.balanceOf(from));
30	require(amount <= ousd.allowance(from, authorized));
31
32	hevm.prank(authorized);
33	// slither-disable-next-line unchecked-transfer
34	try ousd.transferFrom(from, to, amount) {
35	// pass
36	} catch {
37	assert(false);
38	}
39	}
40
41	/**
42	* @notice Performing `transferFrom` with an amount outside the allowance should revert
43	* @param authorizedAcc The account that is authorized to transfer
44	* @param fromAcc The account that is transferring
45	* @param toAcc The account that is receiving
46	* @param amount The amount to transfer
47	*/
48	function testTransferFromShouldRevert(
49	uint8 authorizedAcc,
50	uint8 fromAcc,
51	uint8 toAcc,
52	uint256 amount
53	) public {
54	address authorized = getAccount(authorizedAcc);
55	address from = getAccount(fromAcc);
56	address to = getAccount(toAcc);
57
58	require(amount > 0);
59	require(
60	!(amount <= ousd.balanceOf(from) &&
61	amount <= ousd.allowance(from, authorized))
62	);
63
64	hevm.prank(authorized);
65	// slither-disable-next-line unchecked-transfer
66	try ousd.transferFrom(from, to, amount) {
67	assert(false);
68	} catch {
69	// pass
70	}
71	}
72
73	/**
74	* @notice Approving an amount should update the allowance and overwrite any previous allowance
75	* @param ownerAcc The account that is approving
76	* @param spenderAcc The account that is being approved
77	* @param amount The amount to approve
78	*/
79	function testApprove(
80	uint8 ownerAcc,
81	uint8 spenderAcc,
82	uint256 amount
83	) public {
84	address owner = getAccount(ownerAcc);
85	address spender = getAccount(spenderAcc);
86
87	approve(ownerAcc, spenderAcc, amount);
88	uint256 allowanceAfter1 = ousd.allowance(owner, spender);
89
90	assert(allowanceAfter1 == amount);
91
92	approve(ownerAcc, spenderAcc, amount / 2);
93	uint256 allowanceAfter2 = ousd.allowance(owner, spender);
94
95	assert(allowanceAfter2 == amount / 2);
96	}
97	}
98

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	// https://github.com/ethereum/hevm/blob/main/doc/src/controlling-the-unit-testing-environment.md#cheat-codes
5
6	interface IHevm {
7	function warp(uint256 x) external;
8
9	function roll(uint256 x) external;
10
11	function store(
12	address c,
13	bytes32 loc,
14	bytes32 val
15	) external;
16
17	function load(address c, bytes32 loc) external returns (bytes32 val);
18
19	function sign(uint256 sk, bytes32 digest)
20	external
21	returns (
22	uint8 v,
23	bytes32 r,
24	bytes32 s
25	);
26
27	function addr(uint256 sk) external returns (address addr);
28
29	function ffi(string[] calldata) external returns (bytes memory);
30
31	function prank(address sender) external;
32	}
33

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	/**
5	* @title Base for contracts that are managed by the Origin Protocol's Governor.
6	* @dev Copy of the openzeppelin Ownable.sol contract with nomenclature change
7	* from owner to governor and renounce methods removed. Does not use
8	* Context.sol like Ownable.sol does for simplification.
9	* @author Origin Protocol Inc
10	*/
11	abstract contract Governable {
12	// Storage position of the owner and pendingOwner of the contract
13	// keccak256("OUSD.governor");
14	bytes32 private constant governorPosition =
15	0x7bea13895fa79d2831e0a9e28edede30099005a50d652d8957cf8a607ee6ca4a;
16
17	// keccak256("OUSD.pending.governor");
18	bytes32 private constant pendingGovernorPosition =
19	0x44c4d30b2eaad5130ad70c3ba6972730566f3e6359ab83e800d905c61b1c51db;
20
21	// keccak256("OUSD.reentry.status");
22	bytes32 private constant reentryStatusPosition =
23	0x53bf423e48ed90e97d02ab0ebab13b2a235a6bfbe9c321847d5c175333ac4535;
24
25	// See OpenZeppelin ReentrancyGuard implementation
26	uint256 constant _NOT_ENTERED = 1;
27	uint256 constant _ENTERED = 2;
28
29	event PendingGovernorshipTransfer(
30	address indexed previousGovernor,
31	address indexed newGovernor
32	);
33
34	event GovernorshipTransferred(
35	address indexed previousGovernor,
36	address indexed newGovernor
37	);
38
39	/**
40	* @notice Returns the address of the current Governor.
41	*/
42	function governor() public view returns (address) {
43	return _governor();
44	}
45
46	/**
47	* @dev Returns the address of the current Governor.
48	*/
49	function _governor() internal view returns (address governorOut) {
50	bytes32 position = governorPosition;
51	// solhint-disable-next-line no-inline-assembly
52	assembly {
53	governorOut := sload(position)
54	}
55	}
56
57	/**
58	* @dev Returns the address of the pending Governor.
59	*/
60	function _pendingGovernor()
61	internal
62	view
63	returns (address pendingGovernor)
64	{
65	bytes32 position = pendingGovernorPosition;
66	// solhint-disable-next-line no-inline-assembly
67	assembly {
68	pendingGovernor := sload(position)
69	}
70	}
71
72	/**
73	* @dev Throws if called by any account other than the Governor.
74	*/
75	modifier onlyGovernor() {
76	require(isGovernor(), "Caller is not the Governor");
77	_;
78	}
79
80	/**
81	* @notice Returns true if the caller is the current Governor.
82	*/
83	function isGovernor() public view returns (bool) {
84	return msg.sender == _governor();
85	}
86
87	function _setGovernor(address newGovernor) internal {
88	emit GovernorshipTransferred(_governor(), newGovernor);
89
90	bytes32 position = governorPosition;
91	// solhint-disable-next-line no-inline-assembly
92	assembly {
93	sstore(position, newGovernor)
94	}
95	}
96
97	/**
98	* @dev Prevents a contract from calling itself, directly or indirectly.
99	* Calling a `nonReentrant` function from another `nonReentrant`
100	* function is not supported. It is possible to prevent this from happening
101	* by making the `nonReentrant` function external, and make it call a
102	* `private` function that does the actual work.
103	*/
104	modifier nonReentrant() {
105	bytes32 position = reentryStatusPosition;
106	uint256 _reentry_status;
107	// solhint-disable-next-line no-inline-assembly
108	assembly {
109	_reentry_status := sload(position)
110	}
111
112	// On the first call to nonReentrant, _notEntered will be true
113	require(_reentry_status != _ENTERED, "Reentrant call");
114
115	// Any calls to nonReentrant after this point will fail
116	// solhint-disable-next-line no-inline-assembly
117	assembly {
118	sstore(position, _ENTERED)
119	}
120
121	_;
122
123	// By storing the original value once again, a refund is triggered (see
124	// https://eips.ethereum.org/EIPS/eip-2200)
125	// solhint-disable-next-line no-inline-assembly
126	assembly {
127	sstore(position, _NOT_ENTERED)
128	}
129	}
130
131	function _setPendingGovernor(address newGovernor) internal {
132	bytes32 position = pendingGovernorPosition;
133	// solhint-disable-next-line no-inline-assembly
134	assembly {
135	sstore(position, newGovernor)
136	}
137	}
138
139	/**
140	* @notice Transfers Governance of the contract to a new account (`newGovernor`).
141	* Can only be called by the current Governor. Must be claimed for this to complete
142	* @param _newGovernor Address of the new Governor
143	*/
144	function transferGovernance(address _newGovernor) external onlyGovernor {
145	_setPendingGovernor(_newGovernor);
146	emit PendingGovernorshipTransfer(_governor(), _newGovernor);
147	}
148
149	/**
150	* @notice Claim Governance of the contract to a new account (`newGovernor`).
151	* Can only be called by the new Governor.
152	*/
153	function claimGovernance() external {
154	require(
155	msg.sender == _pendingGovernor(),
156	"Only the pending Governor can complete the claim"
157	);
158	_changeGovernor(msg.sender);
159	}
160
161	/**
162	* @dev Change Governance of the contract to a new account (`newGovernor`).
163	* @param _newGovernor Address of the new Governor
164	*/
165	function _changeGovernor(address _newGovernor) internal {
166	require(_newGovernor != address(0), "New Governor is address(0)");
167	_setGovernor(_newGovernor);
168	}
169	}
170

1	// SPDX-License-Identifier: MIT
2	pragma solidity ^0.8.0;
3
4	interface IBasicToken {
5	function symbol() external view returns (string memory);
6
7	function decimals() external view returns (uint8);
8	}
9

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	/**
5	* @title Platform interface to integrate with lending platform like Compound, AAVE etc.
6	*/
7	interface IStrategy {
8	/**
9	* @dev Deposit the given asset to platform
10	* @param _asset asset address
11	* @param _amount Amount to deposit
12	*/
13	function deposit(address _asset, uint256 _amount) external;
14
15	/**
16	* @dev Deposit the entire balance of all supported assets in the Strategy
17	* to the platform
18	*/
19	function depositAll() external;
20
21	/**
22	* @dev Withdraw given asset from Lending platform
23	*/
24	function withdraw(
25	address _recipient,
26	address _asset,
27	uint256 _amount
28	) external;
29
30	/**
31	* @dev Liquidate all assets in strategy and return them to Vault.
32	*/
33	function withdrawAll() external;
34
35	/**
36	* @dev Returns the current balance of the given asset.
37	*/
38	function checkBalance(address _asset)
39	external
40	view
41	returns (uint256 balance);
42
43	/**
44	* @dev Returns bool indicating whether strategy supports asset.
45	*/
46	function supportsAsset(address _asset) external view returns (bool);
47
48	/**
49	* @dev Collect reward tokens from the Strategy.
50	*/
51	function collectRewardTokens() external;
52
53	/**
54	* @dev The address array of the reward tokens for the Strategy.
55	*/
56	function getRewardTokenAddresses() external view returns (address[] memory);
57
58	function harvesterAddress() external view returns (address);
59
60	function transferToken(address token, uint256 amount) external;
61
62	function setRewardTokenAddresses(address[] calldata _rewardTokenAddresses)
63	external;
64	}
65

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import { VaultStorage } from "../vault/VaultStorage.sol";
5
6	interface IVault {
7	// slither-disable-start constable-states
8
9	event AssetAllocated(address _asset, address _strategy, uint256 _amount);
10	event StrategyApproved(address _addr);
11	event StrategyRemoved(address _addr);
12	event Mint(address _addr, uint256 _value);
13	event Redeem(address _addr, uint256 _value);
14	event CapitalPaused();
15	event CapitalUnpaused();
16	event DefaultStrategyUpdated(address _strategy);
17	event RebasePaused();
18	event RebaseUnpaused();
19	event VaultBufferUpdated(uint256 _vaultBuffer);
20	event AllocateThresholdUpdated(uint256 _threshold);
21	event StrategistUpdated(address _address);
22	event MaxSupplyDiffChanged(uint256 maxSupplyDiff);
23	event YieldDistribution(address _to, uint256 _yield, uint256 _fee);
24	event TrusteeFeeBpsChanged(uint256 _basis);
25	event TrusteeAddressChanged(address _address);
26	event StrategyAddedToMintWhitelist(address indexed strategy);
27	event StrategyRemovedFromMintWhitelist(address indexed strategy);
28	event RebasePerSecondMaxChanged(uint256 rebaseRatePerSecond);
29	event DripDurationChanged(uint256 dripDuration);
30	event WithdrawalRequested(
31	address indexed _withdrawer,
32	uint256 indexed _requestId,
33	uint256 _amount,
34	uint256 _queued
35	);
36	event WithdrawalClaimed(
37	address indexed _withdrawer,
38	uint256 indexed _requestId,
39	uint256 _amount
40	);
41	event WithdrawalClaimable(uint256 _claimable, uint256 _newClaimable);
42	event WithdrawalClaimDelayUpdated(uint256 _newDelay);
43
44	// Governable.sol
45	function transferGovernance(address _newGovernor) external;
46
47	function claimGovernance() external;
48
49	function governor() external view returns (address);
50
51	// VaultAdmin.sol
52	function setVaultBuffer(uint256 _vaultBuffer) external;
53
54	function vaultBuffer() external view returns (uint256);
55
56	function setAutoAllocateThreshold(uint256 _threshold) external;
57
58	function autoAllocateThreshold() external view returns (uint256);
59
60	function setStrategistAddr(address _address) external;
61
62	function strategistAddr() external view returns (address);
63
64	function setOperatorAddr(address _operator) external;
65
66	function operatorAddr() external view returns (address);
67
68	function setMaxSupplyDiff(uint256 _maxSupplyDiff) external;
69
70	function maxSupplyDiff() external view returns (uint256);
71
72	function setTrusteeAddress(address _address) external;
73
74	function trusteeAddress() external view returns (address);
75
76	function setTrusteeFeeBps(uint256 _basis) external;
77
78	function trusteeFeeBps() external view returns (uint256);
79
80	function approveStrategy(address _addr) external;
81
82	function removeStrategy(address _addr) external;
83
84	function setDefaultStrategy(address _strategy) external;
85
86	function defaultStrategy() external view returns (address);
87
88	function pauseRebase() external;
89
90	function unpauseRebase() external;
91
92	function rebasePaused() external view returns (bool);
93
94	function pauseCapital() external;
95
96	function unpauseCapital() external;
97
98	function capitalPaused() external view returns (bool);
99
100	function transferToken(address _asset, uint256 _amount) external;
101
102	function withdrawAllFromStrategy(address _strategyAddr) external;
103
104	function withdrawAllFromStrategies() external;
105
106	function withdrawFromStrategy(
107	address _strategyFromAddress,
108	address[] calldata _assets,
109	uint256[] calldata _amounts
110	) external;
111
112	function depositToStrategy(
113	address _strategyToAddress,
114	address[] calldata _assets,
115	uint256[] calldata _amounts
116	) external;
117
118	// VaultCore.sol
119	function mint(uint256 _amount) external;
120
121	function mintForStrategy(uint256 _amount) external;
122
123	function burnForStrategy(uint256 _amount) external;
124
125	function allocate() external;
126
127	function rebase() external;
128
129	function totalValue() external view returns (uint256 value);
130
131	function checkBalance(address _asset) external view returns (uint256);
132
133	function getAssetCount() external view returns (uint256);
134
135	function getAllAssets() external view returns (address[] memory);
136
137	function getStrategyCount() external view returns (uint256);
138
139	function getAllStrategies() external view returns (address[] memory);
140
141	function strategies(address _addr)
142	external
143	view
144	returns (VaultStorage.Strategy memory);
145
146	/// @notice Deprecated: use `asset()` instead.
147	function isSupportedAsset(address _asset) external view returns (bool);
148
149	function asset() external view returns (address);
150
151	function oToken() external view returns (address);
152
153	function initialize(address) external;
154
155	function addWithdrawalQueueLiquidity() external;
156
157	function requestWithdrawal(uint256 _amount)
158	external
159	returns (uint256 requestId, uint256 queued);
160
161	function claimWithdrawal(uint256 requestId)
162	external
163	returns (uint256 amount);
164
165	function claimWithdrawals(uint256[] memory requestIds)
166	external
167	returns (uint256[] memory amounts, uint256 totalAmount);
168
169	function withdrawalQueueMetadata()
170	external
171	view
172	returns (VaultStorage.WithdrawalQueueMetadata memory);
173
174	function withdrawalRequests(uint256 requestId)
175	external
176	view
177	returns (VaultStorage.WithdrawalRequest memory);
178
179	function addStrategyToMintWhitelist(address strategyAddr) external;
180
181	function removeStrategyFromMintWhitelist(address strategyAddr) external;
182
183	function isMintWhitelistedStrategy(address strategyAddr)
184	external
185	view
186	returns (bool);
187
188	function withdrawalClaimDelay() external view returns (uint256);
189
190	function setWithdrawalClaimDelay(uint256 newDelay) external;
191
192	function lastRebase() external view returns (uint64);
193
194	function dripDuration() external view returns (uint64);
195
196	function setDripDuration(uint256 _dripDuration) external;
197
198	function rebasePerSecondMax() external view returns (uint64);
199
200	function setRebaseRateMax(uint256 yearlyApr) external;
201
202	function rebasePerSecondTarget() external view returns (uint64);
203
204	function previewYield() external view returns (uint256 yield);
205
206	// slither-disable-end constable-states
207	}
208

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import { IBasicToken } from "../interfaces/IBasicToken.sol";
5
6	library Helpers {
7	/**
8	* @notice Fetch the `symbol()` from an ERC20 token
9	* @dev Grabs the `symbol()` from a contract
10	* @param _token Address of the ERC20 token
11	* @return string Symbol of the ERC20 token
12	*/
13	function getSymbol(address _token) internal view returns (string memory) {
14	string memory symbol = IBasicToken(_token).symbol();
15	return symbol;
16	}
17
18	/**
19	* @notice Fetch the `decimals()` from an ERC20 token
20	* @dev Grabs the `decimals()` from a contract and fails if
21	* the decimal value does not live within a certain range
22	* @param _token Address of the ERC20 token
23	* @return uint256 Decimals of the ERC20 token
24	*/
25	function getDecimals(address _token) internal view returns (uint256) {
26	uint256 decimals = IBasicToken(_token).decimals();
27	require(
28	decimals >= 4 && decimals <= 18,
29	"Token must have sufficient decimal places"
30	);
31
32	return decimals;
33	}
34	}
35

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	/**
5	* @title Base contract any contracts that need to initialize state after deployment.
6	* @author Origin Protocol Inc
7	*/
8	abstract contract Initializable {
9	/**
10	* @dev Indicates that the contract has been initialized.
11	*/
12	bool private initialized;
13
14	/**
15	* @dev Indicates that the contract is in the process of being initialized.
16	*/
17	bool private initializing;
18
19	/**
20	* @dev Modifier to protect an initializer function from being invoked twice.
21	*/
22	modifier initializer() {
23	require(
24	initializing \|\| !initialized,
25	"Initializable: contract is already initialized"
26	);
27
28	bool isTopLevelCall = !initializing;
29	if (isTopLevelCall) {
30	initializing = true;
31	initialized = true;
32	}
33
34	_;
35
36	if (isTopLevelCall) {
37	initializing = false;
38	}
39	}
40
41	uint256[50] private ______gap;
42	}
43

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import { SafeMath } from "@openzeppelin/contracts/utils/math/SafeMath.sol";
5
6	// Based on StableMath from Stability Labs Pty. Ltd.
7	// https://github.com/mstable/mStable-contracts/blob/master/contracts/shared/StableMath.sol
8
9	library StableMath {
10	using SafeMath for uint256;
11
12	/**
13	* @dev Scaling unit for use in specific calculations,
14	* where 1 * 10**18, or 1e18 represents a unit '1'
15	*/
16	uint256 private constant FULL_SCALE = 1e18;
17
18	/***************************************
19	Helpers
20	****************************************/
21
22	/**
23	* @dev Adjust the scale of an integer
24	* @param to Decimals to scale to
25	* @param from Decimals to scale from
26	*/
27	function scaleBy(
28	uint256 x,
29	uint256 to,
30	uint256 from
31	) internal pure returns (uint256) {
32	if (to > from) {
33	x = x.mul(10**(to - from));
34	} else if (to < from) {
35	// slither-disable-next-line divide-before-multiply
36	x = x.div(10**(from - to));
37	}
38	return x;
39	}
40
41	/***************************************
42	Precise Arithmetic
43	****************************************/
44
45	/**
46	* @dev Multiplies two precise units, and then truncates by the full scale
47	* @param x Left hand input to multiplication
48	* @param y Right hand input to multiplication
49	* @return Result after multiplying the two inputs and then dividing by the shared
50	* scale unit
51	*/
52	function mulTruncate(uint256 x, uint256 y) internal pure returns (uint256) {
53	return mulTruncateScale(x, y, FULL_SCALE);
54	}
55
56	/**
57	* @dev Multiplies two precise units, and then truncates by the given scale. For example,
58	* when calculating 90% of 10e18, (10e18 * 9e17) / 1e18 = (9e36) / 1e18 = 9e18
59	* @param x Left hand input to multiplication
60	* @param y Right hand input to multiplication
61	* @param scale Scale unit
62	* @return Result after multiplying the two inputs and then dividing by the shared
63	* scale unit
64	*/
65	function mulTruncateScale(
66	uint256 x,
67	uint256 y,
68	uint256 scale
69	) internal pure returns (uint256) {
70	// e.g. assume scale = fullScale
71	// z = 10e18 * 9e17 = 9e36
72	uint256 z = x.mul(y);
73	// return 9e36 / 1e18 = 9e18
74	return z.div(scale);
75	}
76
77	/**
78	* @dev Multiplies two precise units, and then truncates by the full scale, rounding up the result
79	* @param x Left hand input to multiplication
80	* @param y Right hand input to multiplication
81	* @return Result after multiplying the two inputs and then dividing by the shared
82	* scale unit, rounded up to the closest base unit.
83	*/
84	function mulTruncateCeil(uint256 x, uint256 y)
85	internal
86	pure
87	returns (uint256)
88	{
89	// e.g. 8e17 * 17268172638 = 138145381104e17
90	uint256 scaled = x.mul(y);
91	// e.g. 138145381104e17 + 9.99...e17 = 138145381113.99...e17
92	uint256 ceil = scaled.add(FULL_SCALE.sub(1));
93	// e.g. 13814538111.399...e18 / 1e18 = 13814538111
94	return ceil.div(FULL_SCALE);
95	}
96
97	/**
98	* @dev Precisely divides two units, by first scaling the left hand operand. Useful
99	* for finding percentage weightings, i.e. 8e18/10e18 = 80% (or 8e17)
100	* @param x Left hand input to division
101	* @param y Right hand input to division
102	* @return Result after multiplying the left operand by the scale, and
103	* executing the division on the right hand input.
104	*/
105	function divPrecisely(uint256 x, uint256 y)
106	internal
107	pure
108	returns (uint256)
109	{
110	// e.g. 8e18 * 1e18 = 8e36
111	uint256 z = x.mul(FULL_SCALE);
112	// e.g. 8e36 / 10e18 = 8e17
113	return z.div(y);
114	}
115	}
116

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	/**
5	* @title OToken VaultStorage contract
6	* @notice The VaultStorage contract defines the storage for the Vault contracts
7	* @author Origin Protocol Inc
8	*/
9
10	import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
11	import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
12	import { Address } from "@openzeppelin/contracts/utils/Address.sol";
13
14	import { IStrategy } from "../interfaces/IStrategy.sol";
15	import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
16	import { Governable } from "../governance/Governable.sol";
17	import { OUSD } from "../token/OUSD.sol";
18	import { Initializable } from "../utils/Initializable.sol";
19	import "../utils/Helpers.sol";
20
21	abstract contract VaultStorage is Initializable, Governable {
22	using SafeERC20 for IERC20;
23
24	event AssetAllocated(address _asset, address _strategy, uint256 _amount);
25	event StrategyApproved(address _addr);
26	event StrategyRemoved(address _addr);
27	event Mint(address _addr, uint256 _value);
28	event Redeem(address _addr, uint256 _value);
29	event CapitalPaused();
30	event CapitalUnpaused();
31	event DefaultStrategyUpdated(address _strategy);
32	event RebasePaused();
33	event RebaseUnpaused();
34	event VaultBufferUpdated(uint256 _vaultBuffer);
35	event AllocateThresholdUpdated(uint256 _threshold);
36	event StrategistUpdated(address _address);
37	event MaxSupplyDiffChanged(uint256 maxSupplyDiff);
38	event YieldDistribution(address _to, uint256 _yield, uint256 _fee);
39	event TrusteeFeeBpsChanged(uint256 _basis);
40	event TrusteeAddressChanged(address _address);
41	event StrategyAddedToMintWhitelist(address indexed strategy);
42	event StrategyRemovedFromMintWhitelist(address indexed strategy);
43	event RebasePerSecondMaxChanged(uint256 rebaseRatePerSecond);
44	event DripDurationChanged(uint256 dripDuration);
45	event OperatorUpdated(address newOperator);
46	event WithdrawalRequested(
47	address indexed _withdrawer,
48	uint256 indexed _requestId,
49	uint256 _amount,
50	uint256 _queued
51	);
52	event WithdrawalClaimed(
53	address indexed _withdrawer,
54	uint256 indexed _requestId,
55	uint256 _amount
56	);
57	event WithdrawalClaimable(uint256 _claimable, uint256 _newClaimable);
58	event WithdrawalClaimDelayUpdated(uint256 _newDelay);
59
60	// Since we are proxy, all state should be uninitalized.
61	// Since this storage contract does not have logic directly on it
62	// we should not be checking for to see if these variables can be constant.
63	// slither-disable-start uninitialized-state
64	// slither-disable-start constable-states
65
66	/// @dev mapping of supported vault assets to their configuration
67	uint256 private _deprecated_assets;
68	/// @dev list of all assets supported by the vault.
69	address[] private _deprecated_allAssets;
70
71	// Strategies approved for use by the Vault
72	struct Strategy {
73	bool isSupported;
74	uint256 _deprecated; // Deprecated storage slot
75	}
76	/// @dev mapping of strategy contracts to their configuration
77	mapping(address => Strategy) public strategies;
78	/// @dev list of all vault strategies
79	address[] internal allStrategies;
80
81	/// @notice Address of the Oracle price provider contract
82	address private _deprecated_priceProvider;
83	/// @notice pause rebasing if true
84	bool public rebasePaused;
85	/// @notice pause operations that change the OToken supply.
86	/// eg mint, redeem, allocate, mint/burn for strategy
87	bool public capitalPaused;
88	/// @notice Redemption fee in basis points. eg 50 = 0.5%
89	uint256 private _deprecated_redeemFeeBps;
90	/// @notice Percentage of assets to keep in Vault to handle (most) withdrawals. 100% = 1e18.
91	uint256 public vaultBuffer;
92	/// @notice OToken mints over this amount automatically allocate funds. 18 decimals.
93	uint256 public autoAllocateThreshold;
94	/// @dev Deprecated. Was the auto-rebase trigger threshold for mint/redeem.
95	/// Storage slot retained for proxy compatibility; no longer read or written.
96	uint256 internal __deprecatedRebaseThreshold;
97
98	/// @dev Address of the OToken token. eg OUSD or OETH.
99	OUSD public oToken;
100
101	/// @dev Address of the contract responsible for post rebase syncs with AMMs
102	address private _deprecated_rebaseHooksAddr = address(0);
103
104	/// @dev Deprecated: Address of Uniswap
105	address private _deprecated_uniswapAddr = address(0);
106
107	/// @notice Address of the Strategist
108	address public strategistAddr = address(0);
109
110	/// @notice Mapping of asset address to the Strategy that they should automatically
111	// be allocated to
112	uint256 private _deprecated_assetDefaultStrategies;
113
114	/// @notice Max difference between total supply and total value of assets. 18 decimals.
115	uint256 public maxSupplyDiff;
116
117	/// @notice Trustee contract that can collect a percentage of yield
118	address public trusteeAddress;
119
120	/// @notice Amount of yield collected in basis points. eg 2000 = 20%
121	uint256 public trusteeFeeBps;
122
123	/// @dev Deprecated: Tokens that should be swapped for stablecoins
124	address[] private _deprecated_swapTokens;
125
126	/// @notice Metapool strategy that is allowed to mint/burn OTokens without changing collateral
127
128	address private _deprecated_ousdMetaStrategy;
129
130	/// @notice How much OTokens are currently minted by the strategy
131	int256 private _deprecated_netOusdMintedForStrategy;
132
133	/// @notice How much net total OTokens are allowed to be minted by all strategies
134	uint256 private _deprecated_netOusdMintForStrategyThreshold;
135
136	uint256 private _deprecated_swapConfig;
137
138	// List of strategies that can mint oTokens directly
139	// Used in OETHBaseVaultCore
140	mapping(address => bool) public isMintWhitelistedStrategy;
141
142	/// @notice Address of the Dripper contract that streams harvested rewards to the Vault
143	/// @dev The vault is proxied so needs to be set with setDripper against the proxy contract.
144	address private _deprecated_dripper;
145
146	/// Withdrawal Queue Storage /////
147
148	struct WithdrawalQueueMetadata {
149	// cumulative total of all withdrawal requests included the ones that have already been claimed
150	uint128 queued;
151	// cumulative total of all the requests that can be claimed including the ones that have already been claimed
152	uint128 claimable;
153	// total of all the requests that have been claimed
154	uint128 claimed;
155	// index of the next withdrawal request starting at 0
156	uint128 nextWithdrawalIndex;
157	}
158
159	/// @notice Global metadata for the withdrawal queue including:
160	/// queued - cumulative total of all withdrawal requests included the ones that have already been claimed
161	/// claimable - cumulative total of all the requests that can be claimed including the ones already claimed
162	/// claimed - total of all the requests that have been claimed
163	/// nextWithdrawalIndex - index of the next withdrawal request starting at 0
164	WithdrawalQueueMetadata public withdrawalQueueMetadata;
165
166	struct WithdrawalRequest {
167	address withdrawer;
168	bool claimed;
169	uint40 timestamp; // timestamp of the withdrawal request
170	// Amount of oTokens to redeem. eg OETH
171	uint128 amount;
172	// cumulative total of all withdrawal requests including this one.
173	// this request can be claimed when this queued amount is less than or equal to the queue's claimable amount.
174	uint128 queued;
175	}
176
177	/// @notice Mapping of withdrawal request indices to the user withdrawal request data
178	mapping(uint256 => WithdrawalRequest) public withdrawalRequests;
179
180	/// @notice Sets a minimum delay that is required to elapse between
181	/// requesting async withdrawals and claiming the request.
182	/// When set to 0 async withdrawals are disabled.
183	uint256 public withdrawalClaimDelay;
184
185	/// @notice Time in seconds that the vault last rebased yield.
186	uint64 public lastRebase;
187
188	/// @notice Automatic rebase yield calculations. In seconds. Set to 0 or 1 to disable.
189	uint64 public dripDuration;
190
191	/// @notice max rebase percentage per second
192	/// Can be used to set maximum yield of the protocol,
193	/// spreading out yield over time
194	uint64 public rebasePerSecondMax;
195
196	/// @notice target rebase rate limit, based on past rates and funds available.
197	uint64 public rebasePerSecondTarget;
198
199	uint256 internal constant MAX_REBASE = 0.02 ether;
200	uint256 internal constant MAX_REBASE_PER_SECOND =
201	uint256(0.05 ether) / 1 days;
202
203	/// @notice Default strategy for asset
204	address public defaultStrategy;
205
206	/// @notice Address authorized to call `rebase()` directly. The Governor
207	/// and Strategist are always allowed in addition to this address.
208	address public operatorAddr;
209
210	// For future use
211	uint256[41] private __gap;
212
213	/// @notice Index of WETH asset in allAssets array
214	/// Legacy OETHVaultCore code, relocated here for vault consistency.
215	uint256 private _deprecated_wethAssetIndex;
216
217	/// @dev Address of the asset (eg. WETH or USDC)
218	address public immutable asset;
219	uint8 internal immutable assetDecimals;
220
221	// slither-disable-end constable-states
222	// slither-disable-end uninitialized-state
223
224	constructor(address _asset) {
225	uint8 _decimals = IERC20Metadata(_asset).decimals();
226	require(_decimals <= 18, "invalid asset decimals");
227	asset = _asset;
228	assetDecimals = _decimals;
229	}
230
231	/// @notice Deprecated: use `oToken()` instead.
232	function oUSD() external view returns (OUSD) {
233	return oToken;
234	}
235	}
236

1	// SPDX-License-Identifier: MIT
2	// OpenZeppelin Contracts v4.4.1 (token/ERC20/IERC20.sol)
3
4	pragma solidity ^0.8.0;
5
6	/**
7	* @dev Interface of the ERC20 standard as defined in the EIP.
8	*/
9	interface IERC20 {
10	/**
11	* @dev Returns the amount of tokens in existence.
12	*/
13	function totalSupply() external view returns (uint256);
14
15	/**
16	* @dev Returns the amount of tokens owned by `account`.
17	*/
18	function balanceOf(address account) external view returns (uint256);
19
20	/**
21	* @dev Moves `amount` tokens from the caller's account to `recipient`.
22	*
23	* Returns a boolean value indicating whether the operation succeeded.
24	*
25	* Emits a {Transfer} event.
26	*/
27	function transfer(address recipient, uint256 amount) external returns (bool);
28
29	/**
30	* @dev Returns the remaining number of tokens that `spender` will be
31	* allowed to spend on behalf of `owner` through {transferFrom}. This is
32	* zero by default.
33	*
34	* This value changes when {approve} or {transferFrom} are called.
35	*/
36	function allowance(address owner, address spender) external view returns (uint256);
37
38	/**
39	* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
40	*
41	* Returns a boolean value indicating whether the operation succeeded.
42	*
43	* IMPORTANT: Beware that changing an allowance with this method brings the risk
44	* that someone may use both the old and the new allowance by unfortunate
45	* transaction ordering. One possible solution to mitigate this race
46	* condition is to first reduce the spender's allowance to 0 and set the
47	* desired value afterwards:
48	* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
49	*
50	* Emits an {Approval} event.
51	*/
52	function approve(address spender, uint256 amount) external returns (bool);
53
54	/**
55	* @dev Moves `amount` tokens from `sender` to `recipient` using the
56	* allowance mechanism. `amount` is then deducted from the caller's
57	* allowance.
58	*
59	* Returns a boolean value indicating whether the operation succeeded.
60	*
61	* Emits a {Transfer} event.
62	*/
63	function transferFrom(
64	address sender,
65	address recipient,
66	uint256 amount
67	) external returns (bool);
68
69	/**
70	* @dev Emitted when `value` tokens are moved from one account (`from`) to
71	* another (`to`).
72	*
73	* Note that `value` may be zero.
74	*/
75	event Transfer(address indexed from, address indexed to, uint256 value);
76
77	/**
78	* @dev Emitted when the allowance of a `spender` for an `owner` is set by
79	* a call to {approve}. `value` is the new allowance.
80	*/
81	event Approval(address indexed owner, address indexed spender, uint256 value);
82	}
83

1	// SPDX-License-Identifier: MIT
2	// OpenZeppelin Contracts v4.4.1 (utils/Address.sol)
3
4	pragma solidity ^0.8.0;
5
6	/**
7	* @dev Collection of functions related to the address type
8	*/
9	library Address {
10	/**
11	* @dev Returns true if `account` is a contract.
12	*
13	* [IMPORTANT]
14	* ====
15	* It is unsafe to assume that an address for which this function returns
16	* false is an externally-owned account (EOA) and not a contract.
17	*
18	* Among others, `isContract` will return false for the following
19	* types of addresses:
20	*
21	* - an externally-owned account
22	* - a contract in construction
23	* - an address where a contract will be created
24	* - an address where a contract lived, but was destroyed
25	* ====
26	*/
27	function isContract(address account) internal view returns (bool) {
28	// This method relies on extcodesize, which returns 0 for contracts in
29	// construction, since the code is only stored at the end of the
30	// constructor execution.
31
32	uint256 size;
33	assembly {
34	size := extcodesize(account)
35	}
36	return size > 0;
37	}
38
39	/**
40	* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
41	* `recipient`, forwarding all available gas and reverting on errors.
42	*
43	* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
44	* of certain opcodes, possibly making contracts go over the 2300 gas limit
45	* imposed by `transfer`, making them unable to receive funds via
46	* `transfer`. {sendValue} removes this limitation.
47	*
48	* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
49	*
50	* IMPORTANT: because control is transferred to `recipient`, care must be
51	* taken to not create reentrancy vulnerabilities. Consider using
52	* {ReentrancyGuard} or the
53	* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
54	*/
55	function sendValue(address payable recipient, uint256 amount) internal {
56	require(address(this).balance >= amount, "Address: insufficient balance");
57
58	(bool success, ) = recipient.call{value: amount}("");
59	require(success, "Address: unable to send value, recipient may have reverted");
60	}
61
62	/**
63	* @dev Performs a Solidity function call using a low level `call`. A
64	* plain `call` is an unsafe replacement for a function call: use this
65	* function instead.
66	*
67	* If `target` reverts with a revert reason, it is bubbled up by this
68	* function (like regular Solidity function calls).
69	*
70	* Returns the raw returned data. To convert to the expected return value,
71	* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
72	*
73	* Requirements:
74	*
75	* - `target` must be a contract.
76	* - calling `target` with `data` must not revert.
77	*
78	* _Available since v3.1._
79	*/
80	function functionCall(address target, bytes memory data) internal returns (bytes memory) {
81	return functionCall(target, data, "Address: low-level call failed");
82	}
83
84	/**
85	* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
86	* `errorMessage` as a fallback revert reason when `target` reverts.
87	*
88	* _Available since v3.1._
89	*/
90	function functionCall(
91	address target,
92	bytes memory data,
93	string memory errorMessage
94	) internal returns (bytes memory) {
95	return functionCallWithValue(target, data, 0, errorMessage);
96	}
97
98	/**
99	* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
100	* but also transferring `value` wei to `target`.
101	*
102	* Requirements:
103	*
104	* - the calling contract must have an ETH balance of at least `value`.
105	* - the called Solidity function must be `payable`.
106	*
107	* _Available since v3.1._
108	*/
109	function functionCallWithValue(
110	address target,
111	bytes memory data,
112	uint256 value
113	) internal returns (bytes memory) {
114	return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
115	}
116
117	/**
118	* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
119	* with `errorMessage` as a fallback revert reason when `target` reverts.
120	*
121	* _Available since v3.1._
122	*/
123	function functionCallWithValue(
124	address target,
125	bytes memory data,
126	uint256 value,
127	string memory errorMessage
128	) internal returns (bytes memory) {
129	require(address(this).balance >= value, "Address: insufficient balance for call");
130	require(isContract(target), "Address: call to non-contract");
131
132	(bool success, bytes memory returndata) = target.call{value: value}(data);
133	return verifyCallResult(success, returndata, errorMessage);
134	}
135
136	/**
137	* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
138	* but performing a static call.
139	*
140	* _Available since v3.3._
141	*/
142	function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
143	return functionStaticCall(target, data, "Address: low-level static call failed");
144	}
145
146	/**
147	* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
148	* but performing a static call.
149	*
150	* _Available since v3.3._
151	*/
152	function functionStaticCall(
153	address target,
154	bytes memory data,
155	string memory errorMessage
156	) internal view returns (bytes memory) {
157	require(isContract(target), "Address: static call to non-contract");
158
159	(bool success, bytes memory returndata) = target.staticcall(data);
160	return verifyCallResult(success, returndata, errorMessage);
161	}
162
163	/**
164	* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
165	* but performing a delegate call.
166	*
167	* _Available since v3.4._
168	*/
169	function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
170	return functionDelegateCall(target, data, "Address: low-level delegate call failed");
171	}
172
173	/**
174	* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
175	* but performing a delegate call.
176	*
177	* _Available since v3.4._
178	*/
179	function functionDelegateCall(
180	address target,
181	bytes memory data,
182	string memory errorMessage
183	) internal returns (bytes memory) {
184	require(isContract(target), "Address: delegate call to non-contract");
185
186	(bool success, bytes memory returndata) = target.delegatecall(data);
187	return verifyCallResult(success, returndata, errorMessage);
188	}
189
190	/**
191	* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
192	* revert reason using the provided one.
193	*
194	* _Available since v4.3._
195	*/
196	function verifyCallResult(
197	bool success,
198	bytes memory returndata,
199	string memory errorMessage
200	) internal pure returns (bytes memory) {
201	if (success) {
202	return returndata;
203	} else {
204	// Look for revert reason and bubble it up if present
205	if (returndata.length > 0) {
206	// The easiest way to bubble the revert reason is using memory via assembly
207
208	assembly {
209	let returndata_size := mload(returndata)
210	revert(add(32, returndata), returndata_size)
211	}
212	} else {
213	revert(errorMessage);
214	}
215	}
216	}
217	}
218

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import {Properties} from "./Properties.sol";
5
6	// echidna test/recon/CryticTester.sol --contract CryticTester --config echidna.yaml
7	contract CryticTester is Properties {}
8

1	// SPDX-License-Identifier: BUSL-1.1
2	pragma solidity ^0.8.0;
3
4	import {Echidna} from "../../contracts/contracts/echidna/Echidna.sol";
5
6	/// @notice scfuzzbench adaptation layer: canary checks on top of the
7	/// upstream OUSD Echidna suite. Assertion failures are surfaced the same
8	/// way for Echidna, Medusa, Foundry, and Recon (AssertionFailed event +
9	/// assert), and dedup to the emitting function name across fuzzers.
10	abstract contract Properties is Echidna {
11	string internal constant ASSERTION_CANARY = "!!! canary assertion";
12	string internal constant INVARIANT_CANARY_GLOBAL_INVARIANT_FAILURE = "Canary invariant";
13
14	event AssertionFailed(string reason);
15
16	function t(bool b, string memory reason) internal {
17	if (!b) {
18	emit AssertionFailed(reason);
19	assert(false);
20	}
21	}
22
23	function invariant_canary() public returns (bool) {
24	t(false, INVARIANT_CANARY_GLOBAL_INVARIANT_FAILURE);
25	return true;
26	}
27
28	function assert_canary_ASSERTION_CANARY(uint256 entropy) public {
29	t(entropy > 0, ASSERTION_CANARY);
30	}
31	}
32