{
    "Function": "slitherConstructorConstantVariables",
    "File": "contracts/collateral/OverlayV1OVLCollateral.sol",
    "Parent Contracts": [
        "node_modules/@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol",
        "node_modules/@openzeppelin/contracts/token/ERC1155/ERC1155.sol",
        "node_modules/@openzeppelin/contracts/interfaces/draft-IERC6093.sol",
        "node_modules/@openzeppelin/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol",
        "node_modules/@openzeppelin/contracts/token/ERC1155/IERC1155.sol",
        "node_modules/@openzeppelin/contracts/utils/introspection/ERC165.sol",
        "node_modules/@openzeppelin/contracts/utils/introspection/IERC165.sol",
        "node_modules/@openzeppelin/contracts/utils/Context.sol"
    ],
    "High-Level Calls": [],
    "Internal Calls": [
        "keccak256(bytes)"
    ],
    "Library Calls": [],
    "Low-Level Calls": [],
    "Code": "contract OverlayV1OVLCollateral is ERC1155Supply {\n\n    event log(string k, uint v);\n    event log_addr(string k, address v);\n\n    using Position for Position.Info;\n    using FixedPoint for uint256;\n\n    bytes32 constant private GOVERNOR = keccak256(\"GOVERNOR\");\n\n    mapping (address => mapping(uint => uint)) internal currentBlockPositionsLong;\n    mapping (address => mapping(uint => uint)) internal currentBlockPositionsShort;\n    mapping (address => MarketInfo) public marketInfo;\n    struct MarketInfo {\n        uint marginMaintenance;\n        uint marginRewardRate;\n        uint maxLeverage;\n    }\n\n    Position.Info[] public positions;\n\n    IOverlayV1Mothership public immutable mothership;\n    IOverlayTokenNew immutable public ovl;\n\n    uint256 public fees;\n    uint256 public liquidations;\n\n    event Build(\n        address market,\n        uint256 positionId,\n        uint256 oi,\n        uint256 debt\n    );\n\n    event Unwind(\n        address market,\n        uint256 positionId,\n        uint256 oi,\n        uint256 debt\n    );\n\n    event Liquidate(\n        uint256 positionId,\n        uint256 oi,\n        uint256 reward,\n        address rewarded\n    );\n\n    event Update(\n        uint feesCollected,\n        uint feesBurned,\n        uint liquidationsCollected,\n        uint liquidationsBurned\n    );\n\n    modifier onlyGovernor () {\n        require(mothership.hasRole(GOVERNOR, msg.sender), \"OVLV1:!governor\");\n        _;\n    }\n\n    constructor (\n        string memory _uri,\n        address _mothership\n    ) ERC1155(_uri) {\n\n        mothership = IOverlayV1Mothership(_mothership);\n\n        ovl = IOverlayV1Mothership(_mothership).ovl();\n\n        positions.push(Position.Info({\n            market: address(0),\n            isLong: false,\n            leverage: 0,\n            pricePoint: 0,\n            oiShares: 0,\n            debt: 0,\n            cost: 0\n        }));\n\n    }\n\n    function setMarketInfo (\n        address _market,\n        uint _marginMaintenance,\n        uint _marginRewardRate,\n        uint _maxLeverage\n    ) external onlyGovernor {\n\n        marketInfo[_market].marginMaintenance = _marginMaintenance;\n        marketInfo[_market].marginRewardRate = _marginRewardRate;\n        marketInfo[_market].maxLeverage = _maxLeverage;\n\n    }\n\n    function marginMaintenance(\n        address _market\n    ) external view returns (\n        uint marginMaintenance_\n    ) {\n\n        marginMaintenance_ = marketInfo[_market].marginMaintenance;\n\n    }\n\n    function maxLeverage(\n        address _market\n    ) external view returns (\n        uint maxLeverage_\n    ) {\n\n        maxLeverage_ = marketInfo[_market].maxLeverage;\n\n    }\n\n    function marginRewardRate(\n        address _market\n    ) external view returns (\n        uint marginRewardRate_\n    ) {\n\n        marginRewardRate_ = marketInfo[_market].marginRewardRate;\n\n    }\n\n\n    /// @notice Disburses fees\n    function disburse () public {\n\n        (   uint256 _marginBurnRate,\n            uint256 _feeBurnRate,\n            address _feeTo ) = mothership.getUpdateParams();\n\n        uint _feeForward = fees;\n        uint _feeBurn = _feeForward.mulUp(_feeBurnRate);\n        _feeForward = _feeForward - _feeBurn;\n\n        uint _liqForward = liquidations;\n        uint _liqBurn = _liqForward.mulUp(_marginBurnRate);\n        _liqForward -= _liqBurn;\n\n        fees = 0;\n        liquidations = 0;\n\n        emit Update(\n            _feeForward,\n            _feeBurn,\n            _liqForward,\n            _liqBurn\n        );\n\n        ovl.burn(address(this), _feeBurn + _liqBurn);\n        ovl.transfer(_feeTo, _feeForward + _liqForward);\n\n    }\n\n    function getCurrentBlockPositionId (\n        address _market,\n        bool _isLong,\n        uint _leverage,\n        uint _pricePointNext\n    ) internal returns (\n        uint positionId_\n    ) {\n\n        mapping(uint=>uint) storage _currentBlockPositions = _isLong\n            ? currentBlockPositionsLong[_market]\n            : currentBlockPositionsShort[_market];\n\n        positionId_ = _currentBlockPositions[_leverage];\n\n        Position.Info storage position = positions[positionId_];\n\n        if (position.pricePoint < _pricePointNext) {\n\n            positions.push(Position.Info({\n                market: _market,\n                isLong: _isLong,\n                leverage: _leverage,\n                pricePoint: _pricePointNext,\n                oiShares: 0,\n                debt: 0,\n                cost: 0\n            }));\n\n            positionId_ = positions.length - 1;\n\n            _currentBlockPositions[_leverage] = positionId_;\n\n        }\n\n    }\n\n\n    /// @notice Build a position on Overlay with OVL collateral\n    /// @dev This interacts with an Overlay Market to register oi and hold \n    /// positions on behalf of users.\n    /// @param _market The address of the desired market to interact with.\n    /// @param _collateral The amount of OVL to use as collateral in the position.\n    /// @param _leverage The amount of leverage to use in the position\n    /// @param _isLong Whether to take out a position on the long or short side.\n    /// @param _oiMinimum Minimum acceptable amount of OI after impact and fees.\n    /// @return positionId_ Id of the built position for on chain convenience.\n    function build (\n        address _market,\n        uint256 _collateral,\n        uint256 _leverage,\n        bool _isLong,\n        uint256 _oiMinimum\n    ) external returns (\n        uint positionId_\n    ) {\n\n        require(mothership.marketActive(_market), \"OVLV1:!market\");\n        require(_leverage <= marketInfo[_market].maxLeverage, \"OVLV1:lev>max\");\n\n        (   uint _oiAdjusted,\n            uint _collateralAdjusted,\n            uint _debtAdjusted,\n            uint _fee,\n            uint _impact,\n            uint _pricePointNext ) = IOverlayV1Market(_market)\n                .enterOI(\n                    _isLong,\n                    _collateral,\n                    _leverage\n                );\n\n        require(_oiAdjusted >= _oiMinimum, \"OVLV1:oi<min\");\n\n        uint _positionId = getCurrentBlockPositionId(\n            _market,\n            _isLong,\n            _leverage,\n            _pricePointNext\n        );\n\n        Position.Info storage pos = positions[_positionId];\n\n        pos.oiShares += _oiAdjusted;\n        pos.cost += _collateralAdjusted;\n        pos.debt += _debtAdjusted;\n\n        fees += _fee;\n\n        emit Build(_market, _positionId, _oiAdjusted, _debtAdjusted);\n\n        ovl.transferFromBurn(msg.sender, address(this), _collateralAdjusted + _fee, _impact);\n\n        // ovl.burn(msg.sender, _impact);\n\n        _mint(msg.sender, _positionId, _oiAdjusted, \"\"); // WARNING: last b/c erc1155 callback\n\n        positionId_ = _positionId;\n\n    }\n\n    /// @notice Unwinds shares of an existing position.\n    /// @dev Interacts with a market contract to realize the PnL on a position.\n    /// @param _positionId Id of the position to be unwound.\n    /// @param _shares Number of shars to unwind from the position.\n    function unwind (\n        uint256 _positionId,\n        uint256 _shares\n    ) external {\n\n        require( 0 < _shares && _shares <= balanceOf(msg.sender, _positionId), \"OVLV1:!shares\");\n\n        Position.Info storage pos = positions[_positionId];\n\n        require(0 < pos.oiShares, \"OVLV1:liquidated\");\n\n        {\n\n        (   uint _oi,\n            uint _oiShares,\n            uint _priceFrame ) = IOverlayV1Market(pos.market)\n                .exitData(\n                    pos.isLong,\n                    pos.pricePoint\n                );\n\n        uint _totalPosShares = totalSupply(_positionId);\n\n        uint _userOiShares = _shares;\n        uint _userNotional = _shares * pos.notional(_oi, _oiShares, _priceFrame) / _totalPosShares;\n        uint _userDebt = _shares * pos.debt / _totalPosShares;\n        uint _userCost = _shares * pos.cost / _totalPosShares;\n        uint _userOi = _shares * pos.oi(_oi, _oiShares) / _totalPosShares;\n\n        emit Unwind(pos.market, _positionId, _userOi, _userDebt);\n\n        // TODO: think through edge case of underwater position ... and fee adjustments ...\n        uint _feeAmount = _userNotional.mulUp(mothership.fee());\n\n        uint _userValueAdjusted = _userNotional - _feeAmount;\n        if (_userValueAdjusted > _userDebt) _userValueAdjusted -= _userDebt;\n        else _userValueAdjusted = 0;\n\n        fees += _feeAmount; // adds to fee pot, which is transferred on update\n\n        pos.debt -= _userDebt;\n        pos.cost -= _userCost;\n        pos.oiShares -= _userOiShares;\n\n        // ovl.transfer(msg.sender, _userCost);\n\n        // mint/burn excess PnL = valueAdjusted - cost\n        if (_userCost < _userValueAdjusted) {\n\n            ovl.transferMint(\n                msg.sender, \n                _userCost, \n                _userValueAdjusted - _userCost\n            );\n\n        } else {\n\n            ovl.transferBurn(\n                msg.sender, \n                _userValueAdjusted, \n                _userCost - _userValueAdjusted\n            );\n\n        }\n\n\n        IOverlayV1Market(pos.market).exitOI(\n            pos.isLong,\n            _userOi,\n            _userOiShares,\n            _userCost < _userValueAdjusted ? _userValueAdjusted - _userCost : 0,\n            _userCost < _userValueAdjusted ? 0 : _userCost - _userValueAdjusted\n        );\n\n        }\n\n        _burn(msg.sender, _positionId, _shares);\n\n    }\n\n    /// @notice Liquidates an existing position.\n    /// @dev Interacts with an Overlay Market to exit all open interest\n    /// associated with a liquidatable positoin.\n    /// @param _positionId ID of the position being liquidated.\n    /// @param _rewardsTo Address to send liquidation reward to.\n    function liquidate (\n        uint256 _positionId,\n        address _rewardsTo\n    ) external {\n\n        Position.Info storage pos = positions[_positionId];\n\n        require(0 < pos.oiShares, \"OVLV1:liquidated\");\n\n        bool _isLong = pos.isLong;\n\n        (   uint _oi,\n            uint _oiShares,\n            uint _priceFrame ) = IOverlayV1Market(pos.market)\n                .exitData(\n                    _isLong,\n                    pos.pricePoint\n                );\n\n        MarketInfo memory _marketInfo = marketInfo[pos.market];\n\n        require(pos.isLiquidatable(\n            _oi,\n            _oiShares,\n            _priceFrame,\n            _marketInfo.marginMaintenance\n        ), \"OVLV1:!liquidatable\");\n\n        uint _value = pos.value(_oi, _oiShares, _priceFrame);\n\n        IOverlayV1Market(pos.market).exitOI(\n            _isLong,\n            pos.oi(_oi, _oiShares),\n            pos.oiShares,\n            0,\n            pos.cost - _value\n        );\n\n        // TODO: which is better on gas\n        pos.oiShares = 0;\n        pos.debt = 0;\n        // positions[positionId].oiShares = 0;\n\n        uint _toReward = _value.mulUp(_marketInfo.marginRewardRate);\n\n        liquidations += _value - _toReward;\n\n        emit Liquidate(\n            _positionId,\n            _oi,\n            _toReward,\n            _rewardsTo\n        );\n\n        // ovl.burn(address(this), pos.cost - _value);\n        ovl.transferBurn(_rewardsTo, _toReward, pos.cost - _value);\n\n    }\n\n\n    /// @notice Retrieves required information from market contract \n    /// to calculate position value with.\n    /// @dev Gets price frame, total open interest and \n    /// total open interest shares from an Overlay market.\n    /// @param _positionId ID of position to determine value of.\n    /// @return value_ Value of the position\n    function value (\n        uint _positionId\n    ) public view returns (\n        uint256 value_\n    ) {\n\n        Position.Info storage pos = positions[_positionId];\n\n        IOverlayV1Market _market = IOverlayV1Market(pos.market);\n\n        (   uint _oi,\n            uint _oiShares,\n            uint _priceFrame ) = _market\n            .positionInfo(\n                pos.isLong,\n                pos.pricePoint\n            );\n\n        value_ = pos.value(\n            _oi,\n            _oiShares,\n            _priceFrame\n        );\n\n    }\n\n}"
}