ETH Price: $1,964.54 (-0.82%)

Transaction Decoder

Block:
14638657 at Apr-23-2022 03:14:40 AM +UTC
Transaction Fee:
0.001627156255835968 ETH $3.20
Gas Used:
49,192 Gas / 33.077660104 Gwei

Emitted Events:

391 CustomBond.BondRedeemed( recipient=[Sender] 0x9c0d1f4a029c46265831d120dee9cdc72f0ab3c3, payout=87472078084519548116, remaining=0 )
392 AlchemixToken.Transfer( from=[Receiver] CustomBond, to=[Sender] 0x9c0d1f4a029c46265831d120dee9cdc72f0ab3c3, value=87472078084519548116 )

Account State Difference:

  Address   Before After State Difference Code
(2Miners: PPLNS)
6,794.550431134783296972 Eth6,794.550504922783296972 Eth0.000073788
0x1e5b7412...810984B6e
(Alchemix Finance: Olympus Pro ALCX LP Bond)
0x9c0D1F4a...72F0aB3C3
0.650107553038428778 Eth
Nonce: 161
0.64848039678259281 Eth
Nonce: 162
0.001627156255835968
0xdBdb4d16...97F90c8DF

Execution Trace

CustomBond.redeem( _depositor=0x9c0D1F4a029c46265831D120DeE9CDc72F0aB3C3 ) => ( 87472078084519548116 )
  • AlchemixToken.transfer( recipient=0x9c0D1F4a029c46265831D120DeE9CDc72F0aB3C3, amount=87472078084519548116 ) => ( True )
    File 1 of 2: CustomBond
    // File contracts/libraries/SafeMath.sol
    
    // SPDX-License-Identifier: AGPL-3.0-or-later
    pragma solidity 0.7.5;
    
    
    library SafeMath {
    
        function add(uint256 a, uint256 b) internal pure returns (uint256) {
            uint256 c = a + b;
            require(c >= a, "SafeMath: addition overflow");
    
            return c;
        }
    
        function sub(uint256 a, uint256 b) internal pure returns (uint256) {
            return sub(a, b, "SafeMath: subtraction overflow");
        }
    
        function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
            require(b <= a, errorMessage);
            uint256 c = a - b;
    
            return c;
        }
    
        function mul(uint256 a, uint256 b) internal pure returns (uint256) {
            if (a == 0) {
                return 0;
            }
    
            uint256 c = a * b;
            require(c / a == b, "SafeMath: multiplication overflow");
    
            return c;
        }
    
        function div(uint256 a, uint256 b) internal pure returns (uint256) {
            return div(a, b, "SafeMath: division by zero");
        }
    
        function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
            require(b > 0, errorMessage);
            uint256 c = a / b;
            return c;
        }
    
        function mod(uint256 a, uint256 b) internal pure returns (uint256) {
            return mod(a, b, "SafeMath: modulo by zero");
        }
    
        function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
            require(b != 0, errorMessage);
            return a % b;
        }
    
        function sqrrt(uint256 a) internal pure returns (uint c) {
            if (a > 3) {
                c = a;
                uint b = add( div( a, 2), 1 );
                while (b < c) {
                    c = b;
                    b = div( add( div( a, b ), b), 2 );
                }
            } else if (a != 0) {
                c = 1;
            }
        }
    }
    
    
    // File contracts/libraries/Address.sol
    
    pragma solidity 0.7.5;
    
    
    library Address {
    
        function isContract(address account) internal view returns (bool) {
    
            uint256 size;
            // solhint-disable-next-line no-inline-assembly
            assembly { size := extcodesize(account) }
            return size > 0;
        }
    
        function sendValue(address payable recipient, uint256 amount) internal {
            require(address(this).balance >= amount, "Address: insufficient balance");
    
            // solhint-disable-next-line avoid-low-level-calls, avoid-call-value
            (bool success, ) = recipient.call{ value: amount }("");
            require(success, "Address: unable to send value, recipient may have reverted");
        }
    
        function functionCall(address target, bytes memory data) internal returns (bytes memory) {
          return functionCall(target, data, "Address: low-level call failed");
        }
    
        function functionCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) {
            return _functionCallWithValue(target, data, 0, errorMessage);
        }
    
        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");
        }
    
        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");
    
            // solhint-disable-next-line avoid-low-level-calls
            (bool success, bytes memory returndata) = target.call{ value: value }(data);
            return _verifyCallResult(success, returndata, errorMessage);
        }
    
        function _functionCallWithValue(address target, bytes memory data, uint256 weiValue, string memory errorMessage) private returns (bytes memory) {
            require(isContract(target), "Address: call to non-contract");
    
            // solhint-disable-next-line avoid-low-level-calls
            (bool success, bytes memory returndata) = target.call{ value: weiValue }(data);
            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
    
                    // solhint-disable-next-line no-inline-assembly
                    assembly {
                        let returndata_size := mload(returndata)
                        revert(add(32, returndata), returndata_size)
                    }
                } else {
                    revert(errorMessage);
                }
            }
        }
    
        function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
            return functionStaticCall(target, data, "Address: low-level static call failed");
        }
    
        function functionStaticCall(address target, bytes memory data, string memory errorMessage) internal view returns (bytes memory) {
            require(isContract(target), "Address: static call to non-contract");
    
            // solhint-disable-next-line avoid-low-level-calls
            (bool success, bytes memory returndata) = target.staticcall(data);
            return _verifyCallResult(success, returndata, errorMessage);
        }
    
        function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
            return functionDelegateCall(target, data, "Address: low-level delegate call failed");
        }
    
        function functionDelegateCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) {
            require(isContract(target), "Address: delegate call to non-contract");
    
            // solhint-disable-next-line avoid-low-level-calls
            (bool success, bytes memory returndata) = target.delegatecall(data);
            return _verifyCallResult(success, returndata, errorMessage);
        }
    
        function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) {
            if (success) {
                return returndata;
            } else {
                if (returndata.length > 0) {
    
                    assembly {
                        let returndata_size := mload(returndata)
                        revert(add(32, returndata), returndata_size)
                    }
                } else {
                    revert(errorMessage);
                }
            }
        }
    
        function addressToString(address _address) internal pure returns(string memory) {
            bytes32 _bytes = bytes32(uint256(_address));
            bytes memory HEX = "0123456789abcdef";
            bytes memory _addr = new bytes(42);
    
            _addr[0] = '0';
            _addr[1] = 'x';
    
            for(uint256 i = 0; i < 20; i++) {
                _addr[2+i*2] = HEX[uint8(_bytes[i + 12] >> 4)];
                _addr[3+i*2] = HEX[uint8(_bytes[i + 12] & 0x0f)];
            }
    
            return string(_addr);
    
        }
    }
    
    
    // File contracts/interfaces/IERC20.sol
    
    pragma solidity 0.7.5;
    
    interface IERC20 {
        function decimals() external view returns (uint8);
    
        function totalSupply() external view returns (uint256);
    
        function balanceOf(address account) external view returns (uint256);
    
        function transfer(address recipient, uint256 amount) external returns (bool);
    
        function allowance(address owner, address spender) external view returns (uint256);
    
        function approve(address spender, uint256 amount) external returns (bool);
    
        function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
    
        event Transfer(address indexed from, address indexed to, uint256 value);
    
        event Approval(address indexed owner, address indexed spender, uint256 value);
    }
    
    
    // File contracts/libraries/SafeERC20.sol
    
    pragma solidity 0.7.5;
    
    
    library SafeERC20 {
        using SafeMath for uint256;
        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));
        }
    
        function safeApprove(IERC20 token, address spender, uint256 value) internal {
    
            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).add(value);
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
        }
    
        function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
            uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero");
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
        }
    
        function _callOptionalReturn(IERC20 token, bytes memory data) private {
    
            bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
            if (returndata.length > 0) { // Return data is optional
                // solhint-disable-next-line max-line-length
                require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
            }
        }
    }
    
    
    // File contracts/libraries/FullMath.sol
    
    pragma solidity 0.7.5;
    
    library FullMath {
        function fullMul(uint256 x, uint256 y) private pure returns (uint256 l, uint256 h) {
            uint256 mm = mulmod(x, y, uint256(-1));
            l = x * y;
            h = mm - l;
            if (mm < l) h -= 1;
        }
    
        function fullDiv(
            uint256 l,
            uint256 h,
            uint256 d
        ) private pure returns (uint256) {
            uint256 pow2 = d & -d;
            d /= pow2;
            l /= pow2;
            l += h * ((-pow2) / pow2 + 1);
            uint256 r = 1;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            r *= 2 - d * r;
            return l * r;
        }
    
        function mulDiv(
            uint256 x,
            uint256 y,
            uint256 d
        ) internal pure returns (uint256) {
            (uint256 l, uint256 h) = fullMul(x, y);
            uint256 mm = mulmod(x, y, d);
            if (mm > l) h -= 1;
            l -= mm;
            require(h < d, 'FullMath::mulDiv: overflow');
            return fullDiv(l, h, d);
        }
    }
    
    
    // File contracts/libraries/FixedPoint.sol
    
    pragma solidity 0.7.5;
    
    library Babylonian {
    
        function sqrt(uint256 x) internal pure returns (uint256) {
            if (x == 0) return 0;
    
            uint256 xx = x;
            uint256 r = 1;
            if (xx >= 0x100000000000000000000000000000000) {
                xx >>= 128;
                r <<= 64;
            }
            if (xx >= 0x10000000000000000) {
                xx >>= 64;
                r <<= 32;
            }
            if (xx >= 0x100000000) {
                xx >>= 32;
                r <<= 16;
            }
            if (xx >= 0x10000) {
                xx >>= 16;
                r <<= 8;
            }
            if (xx >= 0x100) {
                xx >>= 8;
                r <<= 4;
            }
            if (xx >= 0x10) {
                xx >>= 4;
                r <<= 2;
            }
            if (xx >= 0x8) {
                r <<= 1;
            }
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1;
            r = (r + x / r) >> 1; // Seven iterations should be enough
            uint256 r1 = x / r;
            return (r < r1 ? r : r1);
        }
    }
    
    library BitMath {
    
        function mostSignificantBit(uint256 x) internal pure returns (uint8 r) {
            require(x > 0, 'BitMath::mostSignificantBit: zero');
    
            if (x >= 0x100000000000000000000000000000000) {
                x >>= 128;
                r += 128;
            }
            if (x >= 0x10000000000000000) {
                x >>= 64;
                r += 64;
            }
            if (x >= 0x100000000) {
                x >>= 32;
                r += 32;
            }
            if (x >= 0x10000) {
                x >>= 16;
                r += 16;
            }
            if (x >= 0x100) {
                x >>= 8;
                r += 8;
            }
            if (x >= 0x10) {
                x >>= 4;
                r += 4;
            }
            if (x >= 0x4) {
                x >>= 2;
                r += 2;
            }
            if (x >= 0x2) r += 1;
        }
    }
    
    
    library FixedPoint {
    
        struct uq112x112 {
            uint224 _x;
        }
    
        struct uq144x112 {
            uint256 _x;
        }
    
        uint8 private constant RESOLUTION = 112;
        uint256 private constant Q112 = 0x10000000000000000000000000000;
        uint256 private constant Q224 = 0x100000000000000000000000000000000000000000000000000000000;
        uint256 private constant LOWER_MASK = 0xffffffffffffffffffffffffffff; // decimal of UQ*x112 (lower 112 bits)
    
        function decode(uq112x112 memory self) internal pure returns (uint112) {
            return uint112(self._x >> RESOLUTION);
        }
    
        function decode112with18(uq112x112 memory self) internal pure returns (uint) {
    
            return uint(self._x) / 5192296858534827;
        }
    
        function fraction(uint256 numerator, uint256 denominator) internal pure returns (uq112x112 memory) {
            require(denominator > 0, 'FixedPoint::fraction: division by zero');
            if (numerator == 0) return FixedPoint.uq112x112(0);
    
            if (numerator <= uint144(-1)) {
                uint256 result = (numerator << RESOLUTION) / denominator;
                require(result <= uint224(-1), 'FixedPoint::fraction: overflow');
                return uq112x112(uint224(result));
            } else {
                uint256 result = FullMath.mulDiv(numerator, Q112, denominator);
                require(result <= uint224(-1), 'FixedPoint::fraction: overflow');
                return uq112x112(uint224(result));
            }
        }
        
        // square root of a UQ112x112
        // lossy between 0/1 and 40 bits
        function sqrt(uq112x112 memory self) internal pure returns (uq112x112 memory) {
            if (self._x <= uint144(-1)) {
                return uq112x112(uint224(Babylonian.sqrt(uint256(self._x) << 112)));
            }
    
            uint8 safeShiftBits = 255 - BitMath.mostSignificantBit(self._x);
            safeShiftBits -= safeShiftBits % 2;
            return uq112x112(uint224(Babylonian.sqrt(uint256(self._x) << safeShiftBits) << ((112 - safeShiftBits) / 2)));
        }
    }
    
    
    // File contracts/interfaces/ITreasury.sol
    
    pragma solidity 0.7.5;
    
    interface ITreasury {
        function deposit(address _principleTokenAddress, uint _amountPrincipleToken, uint _amountPayoutToken) external;
        function valueOfToken( address _principleTokenAddress, uint _amount ) external view returns ( uint value_ );
    }
    
    
    // File contracts/types/Ownable.sol
    
    pragma solidity 0.7.5;
    
    contract Ownable {
    
        address public policy;
    
        constructor () {
            policy = msg.sender;
        }
    
        modifier onlyPolicy() {
            require( policy == msg.sender, "Ownable: caller is not the owner" );
            _;
        }
        
        function transferManagment(address _newOwner) external onlyPolicy() {
            require( _newOwner != address(0) );
            policy = _newOwner;
        }
    }
    
    
    // File contracts/OlympusProCustomBond.sol
    
    pragma solidity 0.7.5;
    
    
    
    
    contract CustomBond is Ownable {
        using FixedPoint for *;
        using SafeERC20 for IERC20;
        using SafeMath for uint;
        
        /* ======== EVENTS ======== */
    
        event BondCreated( uint deposit, uint payout, uint expires );
        event BondRedeemed( address recipient, uint payout, uint remaining );
        event BondPriceChanged( uint internalPrice, uint debtRatio );
        event ControlVariableAdjustment( uint initialBCV, uint newBCV, uint adjustment, bool addition );
        
        
         /* ======== STATE VARIABLES ======== */
        
        IERC20 immutable payoutToken; // token paid for principal
        IERC20 immutable principalToken; // inflow token
        ITreasury immutable customTreasury; // pays for and receives principal
        address immutable olympusDAO;
        address olympusTreasury; // receives fee
    
        uint public totalPrincipalBonded;
        uint public totalPayoutGiven;
        
        Terms public terms; // stores terms for new bonds
        Adjust public adjustment; // stores adjustment to BCV data
        FeeTiers[] private feeTiers; // stores fee tiers
    
        mapping( address => Bond ) public bondInfo; // stores bond information for depositors
    
        uint public totalDebt; // total value of outstanding bonds; used for pricing
        uint public lastDecay; // reference block for debt decay
    
        address immutable subsidyRouter; // pays subsidy in OHM to custom treasury
        uint payoutSinceLastSubsidy; // principal accrued since subsidy paid
        
        /* ======== STRUCTS ======== */
    
        struct FeeTiers {
            uint tierCeilings; // principal bonded till next tier
            uint fees; // in ten-thousandths (i.e. 33300 = 3.33%)
        }
    
        // Info for creating new bonds
        struct Terms {
            uint controlVariable; // scaling variable for price
            uint vestingTerm; // in blocks
            uint minimumPrice; // vs principal value
            uint maxPayout; // in thousandths of a %. i.e. 500 = 0.5%
            uint maxDebt; // payout token decimal debt ratio, max % total supply created as debt
        }
    
        // Info for bond holder
        struct Bond {
            uint payout; // payout token remaining to be paid
            uint vesting; // Blocks left to vest
            uint lastBlock; // Last interaction
            uint truePricePaid; // Price paid (principal tokens per payout token) in ten-millionths - 4000000 = 0.4
        }
    
        // Info for incremental adjustments to control variable 
        struct Adjust {
            bool add; // addition or subtraction
            uint rate; // increment
            uint target; // BCV when adjustment finished
            uint buffer; // minimum length (in blocks) between adjustments
            uint lastBlock; // block when last adjustment made
        }
        
        /* ======== CONSTRUCTOR ======== */
    
        constructor(
            address _customTreasury, 
            address _payoutToken, 
            address _principalToken, 
            address _olympusTreasury,
            address _subsidyRouter, 
            address _initialOwner, 
            address _olympusDAO,
            uint[] memory _tierCeilings, 
            uint[] memory _fees
        ) {
            require( _customTreasury != address(0) );
            customTreasury = ITreasury( _customTreasury );
            require( _payoutToken != address(0) );
            payoutToken = IERC20( _payoutToken );
            require( _principalToken != address(0) );
            principalToken = IERC20( _principalToken );
            require( _olympusTreasury != address(0) );
            olympusTreasury = _olympusTreasury;
            require( _subsidyRouter != address(0) );
            subsidyRouter = _subsidyRouter;
            require( _initialOwner != address(0) );
            policy = _initialOwner;
            require( _olympusDAO != address(0) );
            olympusDAO = _olympusDAO;
            require(_tierCeilings.length == _fees.length, "tier length and fee length not the same");
    
            for(uint i; i < _tierCeilings.length; i++) {
                feeTiers.push( FeeTiers({
                    tierCeilings: _tierCeilings[i],
                    fees: _fees[i]
                }));
            }
        }
    
        /* ======== INITIALIZATION ======== */
        
        /**
         *  @notice initializes bond parameters
         *  @param _controlVariable uint
         *  @param _vestingTerm uint
         *  @param _minimumPrice uint
         *  @param _maxPayout uint
         *  @param _maxDebt uint
         *  @param _initialDebt uint
         */
        function initializeBond( 
            uint _controlVariable, 
            uint _vestingTerm,
            uint _minimumPrice,
            uint _maxPayout,
            uint _maxDebt,
            uint _initialDebt
        ) external onlyPolicy() {
            require( currentDebt() == 0, "Debt must be 0 for initialization" );
            terms = Terms ({
                controlVariable: _controlVariable,
                vestingTerm: _vestingTerm,
                minimumPrice: _minimumPrice,
                maxPayout: _maxPayout,
                maxDebt: _maxDebt
            });
            totalDebt = _initialDebt;
            lastDecay = block.number;
        }
        
        
        /* ======== POLICY FUNCTIONS ======== */
    
        enum PARAMETER { VESTING, PAYOUT, DEBT }
        /**
         *  @notice set parameters for new bonds
         *  @param _parameter PARAMETER
         *  @param _input uint
         */
        function setBondTerms ( PARAMETER _parameter, uint _input ) external onlyPolicy() {
            if ( _parameter == PARAMETER.VESTING ) { // 0
                require( _input >= 10000, "Vesting must be longer than 36 hours" );
                terms.vestingTerm = _input;
            } else if ( _parameter == PARAMETER.PAYOUT ) { // 1
                require( _input <= 1000, "Payout cannot be above 1 percent" );
                terms.maxPayout = _input;
            } else if ( _parameter == PARAMETER.DEBT ) { // 2
                terms.maxDebt = _input;
            }
        }
    
        /**
         *  @notice set control variable adjustment
         *  @param _addition bool
         *  @param _increment uint
         *  @param _target uint
         *  @param _buffer uint
         */
        function setAdjustment ( 
            bool _addition,
            uint _increment, 
            uint _target,
            uint _buffer 
        ) external onlyPolicy() {
            require( _increment <= terms.controlVariable.mul( 30 ).div( 1000 ), "Increment too large" );
    
            adjustment = Adjust({
                add: _addition,
                rate: _increment,
                target: _target,
                buffer: _buffer,
                lastBlock: block.number
            });
        }
    
        /**
         *  @notice change address of Olympus Treasury
         *  @param _olympusTreasury uint
         */
        function changeOlympusTreasury(address _olympusTreasury) external {
            require( msg.sender == olympusDAO, "Only Olympus DAO" );
            olympusTreasury = _olympusTreasury;
        }
    
        /**
         *  @notice subsidy controller checks payouts since last subsidy and resets counter
         *  @return payoutSinceLastSubsidy_ uint
         */
        function paySubsidy() external returns ( uint payoutSinceLastSubsidy_ ) {
            require( msg.sender == subsidyRouter, "Only subsidy controller" );
    
            payoutSinceLastSubsidy_ = payoutSinceLastSubsidy;
            payoutSinceLastSubsidy = 0;
        }
        
        /* ======== USER FUNCTIONS ======== */
        
        /**
         *  @notice deposit bond
         *  @param _amount uint
         *  @param _maxPrice uint
         *  @param _depositor address
         *  @return uint
         */
        function deposit(uint _amount, uint _maxPrice, address _depositor) external returns (uint) {
            require( _depositor != address(0), "Invalid address" );
    
            decayDebt();
            require( totalDebt <= terms.maxDebt, "Max capacity reached" );
            
            uint nativePrice = trueBondPrice();
    
            require( _maxPrice >= nativePrice, "Slippage limit: more than max price" ); // slippage protection
    
            uint value = customTreasury.valueOfToken( address(principalToken), _amount );
            uint payout = _payoutFor( value ); // payout to bonder is computed
    
            require( payout >= 10 ** payoutToken.decimals() / 100, "Bond too small" ); // must be > 0.01 payout token ( underflow protection )
            require( payout <= maxPayout(), "Bond too large"); // size protection because there is no slippage
    
            // profits are calculated
            uint fee = payout.mul( currentOlympusFee() ).div( 1e6 );
    
            /**
                principal is transferred in
                approved and
                deposited into the treasury, returning (_amount - profit) payout token
             */
            principalToken.safeTransferFrom( msg.sender, address(this), _amount );
            principalToken.approve( address(customTreasury), _amount );
            customTreasury.deposit( address(principalToken), _amount, payout );
            
            if ( fee != 0 ) { // fee is transferred to dao 
                payoutToken.transfer(olympusTreasury, fee);
            }
            
            // total debt is increased
            totalDebt = totalDebt.add( value );
                    
            // depositor info is stored
            bondInfo[ _depositor ] = Bond({ 
                payout: bondInfo[ _depositor ].payout.add( payout.sub(fee) ),
                vesting: terms.vestingTerm,
                lastBlock: block.number,
                truePricePaid: trueBondPrice()
            });
    
            // indexed events are emitted
            emit BondCreated( _amount, payout, block.number.add( terms.vestingTerm ) );
            emit BondPriceChanged( _bondPrice(), debtRatio() );
    
            totalPrincipalBonded = totalPrincipalBonded.add(_amount); // total bonded increased
            totalPayoutGiven = totalPayoutGiven.add(payout); // total payout increased
            payoutSinceLastSubsidy = payoutSinceLastSubsidy.add( payout ); // subsidy counter increased
    
            adjust(); // control variable is adjusted
            return payout; 
        }
        
        /** 
         *  @notice redeem bond for user
         *  @return uint
         */ 
        function redeem(address _depositor) external returns (uint) {
            Bond memory info = bondInfo[ _depositor ];
            uint percentVested = percentVestedFor( _depositor ); // (blocks since last interaction / vesting term remaining)
    
            if ( percentVested >= 10000 ) { // if fully vested
                delete bondInfo[ _depositor ]; // delete user info
                emit BondRedeemed( _depositor, info.payout, 0 ); // emit bond data
                payoutToken.transfer( _depositor, info.payout );
                return info.payout;
    
            } else { // if unfinished
                // calculate payout vested
                uint payout = info.payout.mul( percentVested ).div( 10000 );
    
                // store updated deposit info
                bondInfo[ _depositor ] = Bond({
                    payout: info.payout.sub( payout ),
                    vesting: info.vesting.sub( block.number.sub( info.lastBlock ) ),
                    lastBlock: block.number,
                    truePricePaid: info.truePricePaid
                });
    
                emit BondRedeemed( _depositor, payout, bondInfo[ _depositor ].payout );
                payoutToken.transfer( _depositor, payout );
                return payout;
            }
            
        }
        
        /* ======== INTERNAL HELPER FUNCTIONS ======== */
    
        /**
         *  @notice makes incremental adjustment to control variable
         */
        function adjust() internal {
            uint blockCanAdjust = adjustment.lastBlock.add( adjustment.buffer );
            if( adjustment.rate != 0 && block.number >= blockCanAdjust ) {
                uint initial = terms.controlVariable;
                if ( adjustment.add ) {
                    terms.controlVariable = terms.controlVariable.add( adjustment.rate );
                    if ( terms.controlVariable >= adjustment.target ) {
                        adjustment.rate = 0;
                    }
                } else {
                    terms.controlVariable = terms.controlVariable.sub( adjustment.rate );
                    if ( terms.controlVariable <= adjustment.target ) {
                        adjustment.rate = 0;
                    }
                }
                adjustment.lastBlock = block.number;
                emit ControlVariableAdjustment( initial, terms.controlVariable, adjustment.rate, adjustment.add );
            }
        }
    
        /**
         *  @notice reduce total debt
         */
        function decayDebt() internal {
            totalDebt = totalDebt.sub( debtDecay() );
            lastDecay = block.number;
        }
    
        /**
         *  @notice calculate current bond price and remove floor if above
         *  @return price_ uint
         */
        function _bondPrice() internal returns ( uint price_ ) {
            price_ = terms.controlVariable.mul( debtRatio() ).div( 10 ** (uint256(payoutToken.decimals()).sub(5)) );
            if ( price_ < terms.minimumPrice ) {
                price_ = terms.minimumPrice;        
            } else if ( terms.minimumPrice != 0 ) {
                terms.minimumPrice = 0;
            }
        }
    
    
        /* ======== VIEW FUNCTIONS ======== */
    
        /**
         *  @notice calculate current bond premium
         *  @return price_ uint
         */
        function bondPrice() public view returns ( uint price_ ) {        
            price_ = terms.controlVariable.mul( debtRatio() ).div( 10 ** (uint256(payoutToken.decimals()).sub(5)) );
            if ( price_ < terms.minimumPrice ) {
                price_ = terms.minimumPrice;
            }
        }
    
        /**
         *  @notice calculate true bond price a user pays
         *  @return price_ uint
         */
        function trueBondPrice() public view returns ( uint price_ ) {
            price_ = bondPrice().add(bondPrice().mul( currentOlympusFee() ).div( 1e6 ) );
        }
    
        /**
         *  @notice determine maximum bond size
         *  @return uint
         */
        function maxPayout() public view returns ( uint ) {
            return payoutToken.totalSupply().mul( terms.maxPayout ).div( 100000 );
        }
    
        /**
         *  @notice calculate total interest due for new bond
         *  @param _value uint
         *  @return uint
         */
        function _payoutFor( uint _value ) internal view returns ( uint ) {
            return FixedPoint.fraction( _value, bondPrice() ).decode112with18().div( 1e11 );
        }
    
        /**
         *  @notice calculate user's interest due for new bond, accounting for Olympus Fee
         *  @param _value uint
         *  @return uint
         */
        function payoutFor( uint _value ) external view returns ( uint ) {
            uint total = FixedPoint.fraction( _value, bondPrice() ).decode112with18().div( 1e11 );
            return total.sub(total.mul( currentOlympusFee() ).div( 1e6 ));
        }
    
        /**
         *  @notice calculate current ratio of debt to payout token supply
         *  @notice protocols using Olympus Pro should be careful when quickly adding large %s to total supply
         *  @return debtRatio_ uint
         */
        function debtRatio() public view returns ( uint debtRatio_ ) {   
            debtRatio_ = FixedPoint.fraction( 
                currentDebt().mul( 10 ** payoutToken.decimals() ), 
                payoutToken.totalSupply()
            ).decode112with18().div( 1e18 );
        }
    
        /**
         *  @notice calculate debt factoring in decay
         *  @return uint
         */
        function currentDebt() public view returns ( uint ) {
            return totalDebt.sub( debtDecay() );
        }
    
        /**
         *  @notice amount to decay total debt by
         *  @return decay_ uint
         */
        function debtDecay() public view returns ( uint decay_ ) {
            uint blocksSinceLast = block.number.sub( lastDecay );
            decay_ = totalDebt.mul( blocksSinceLast ).div( terms.vestingTerm );
            if ( decay_ > totalDebt ) {
                decay_ = totalDebt;
            }
        }
    
    
        /**
         *  @notice calculate how far into vesting a depositor is
         *  @param _depositor address
         *  @return percentVested_ uint
         */
        function percentVestedFor( address _depositor ) public view returns ( uint percentVested_ ) {
            Bond memory bond = bondInfo[ _depositor ];
            uint blocksSinceLast = block.number.sub( bond.lastBlock );
            uint vesting = bond.vesting;
    
            if ( vesting > 0 ) {
                percentVested_ = blocksSinceLast.mul( 10000 ).div( vesting );
            } else {
                percentVested_ = 0;
            }
        }
    
        /**
         *  @notice calculate amount of payout token available for claim by depositor
         *  @param _depositor address
         *  @return pendingPayout_ uint
         */
        function pendingPayoutFor( address _depositor ) external view returns ( uint pendingPayout_ ) {
            uint percentVested = percentVestedFor( _depositor );
            uint payout = bondInfo[ _depositor ].payout;
    
            if ( percentVested >= 10000 ) {
                pendingPayout_ = payout;
            } else {
                pendingPayout_ = payout.mul( percentVested ).div( 10000 );
            }
        }
    
        /**
         *  @notice current fee Olympus takes of each bond
         *  @return currentFee_ uint
         */
        function currentOlympusFee() public view returns( uint currentFee_ ) {
            uint tierLength = feeTiers.length;
            for(uint i; i < tierLength; i++) {
                if(totalPrincipalBonded < feeTiers[i].tierCeilings || i == tierLength - 1 ) {
                    return feeTiers[i].fees;
                }
            }
        }
        
    }

    File 2 of 2: AlchemixToken
    // SPDX-License-Identifier: GPL-3.0
    pragma solidity ^0.6.12;
    pragma experimental ABIEncoderV2;
    import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
    import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
    import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
    import {IDetailedERC20} from "./interfaces/IDetailedERC20.sol";
    /// @title AlchemixToken
    ///
    /// @dev This is the contract for the Alchemix governance token.
    ///
    /// Initially, the contract deployer is given both the admin and minter role. This allows them to pre-mine tokens,
    /// transfer admin to a timelock contract, and lastly, grant the staking pools the minter role. After this is done,
    /// the deployer must revoke their admin role and minter role.
    contract AlchemixToken is AccessControl, ERC20("Alchemix", "ALCX") {
      /// @dev The identifier of the role which maintains other roles.
      bytes32 public constant ADMIN_ROLE = keccak256("ADMIN");
      /// @dev The identifier of the role which allows accounts to mint tokens.
      bytes32 public constant MINTER_ROLE = keccak256("MINTER");
      constructor() public {
        _setupRole(ADMIN_ROLE, msg.sender);
        _setupRole(MINTER_ROLE, msg.sender);
        _setRoleAdmin(MINTER_ROLE, ADMIN_ROLE);
        _setRoleAdmin(ADMIN_ROLE, ADMIN_ROLE);
      }
      /// @dev A modifier which checks that the caller has the minter role.
      modifier onlyMinter() {
        require(hasRole(MINTER_ROLE, msg.sender), "AlchemixToken: only minter");
        _;
      }
      /// @dev Mints tokens to a recipient.
      ///
      /// This function reverts if the caller does not have the minter role.
      ///
      /// @param _recipient the account to mint tokens to.
      /// @param _amount    the amount of tokens to mint.
      function mint(address _recipient, uint256 _amount) external onlyMinter {
        _mint(_recipient, _amount);
      }
    }// SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    import "../utils/EnumerableSet.sol";
    import "../utils/Address.sol";
    import "../GSN/Context.sol";
    /**
     * @dev Contract module that allows children to implement role-based access
     * control mechanisms.
     *
     * Roles are referred to by their `bytes32` identifier. These should be exposed
     * in the external API and be unique. The best way to achieve this is by
     * using `public constant` hash digests:
     *
     * ```
     * bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
     * ```
     *
     * Roles can be used to represent a set of permissions. To restrict access to a
     * function call, use {hasRole}:
     *
     * ```
     * function foo() public {
     *     require(hasRole(MY_ROLE, msg.sender));
     *     ...
     * }
     * ```
     *
     * Roles can be granted and revoked dynamically via the {grantRole} and
     * {revokeRole} functions. Each role has an associated admin role, and only
     * accounts that have a role's admin role can call {grantRole} and {revokeRole}.
     *
     * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
     * that only accounts with this role will be able to grant or revoke other
     * roles. More complex role relationships can be created by using
     * {_setRoleAdmin}.
     *
     * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
     * grant and revoke this role. Extra precautions should be taken to secure
     * accounts that have been granted it.
     */
    abstract contract AccessControl is Context {
        using EnumerableSet for EnumerableSet.AddressSet;
        using Address for address;
        struct RoleData {
            EnumerableSet.AddressSet members;
            bytes32 adminRole;
        }
        mapping (bytes32 => RoleData) private _roles;
        bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
        /**
         * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
         *
         * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
         * {RoleAdminChanged} not being emitted signaling this.
         *
         * _Available since v3.1._
         */
        event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
        /**
         * @dev Emitted when `account` is granted `role`.
         *
         * `sender` is the account that originated the contract call, an admin role
         * bearer except when using {_setupRole}.
         */
        event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
        /**
         * @dev Emitted when `account` is revoked `role`.
         *
         * `sender` is the account that originated the contract call:
         *   - if using `revokeRole`, it is the admin role bearer
         *   - if using `renounceRole`, it is the role bearer (i.e. `account`)
         */
        event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
        /**
         * @dev Returns `true` if `account` has been granted `role`.
         */
        function hasRole(bytes32 role, address account) public view returns (bool) {
            return _roles[role].members.contains(account);
        }
        /**
         * @dev Returns the number of accounts that have `role`. Can be used
         * together with {getRoleMember} to enumerate all bearers of a role.
         */
        function getRoleMemberCount(bytes32 role) public view returns (uint256) {
            return _roles[role].members.length();
        }
        /**
         * @dev Returns one of the accounts that have `role`. `index` must be a
         * value between 0 and {getRoleMemberCount}, non-inclusive.
         *
         * Role bearers are not sorted in any particular way, and their ordering may
         * change at any point.
         *
         * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
         * you perform all queries on the same block. See the following
         * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
         * for more information.
         */
        function getRoleMember(bytes32 role, uint256 index) public view returns (address) {
            return _roles[role].members.at(index);
        }
        /**
         * @dev Returns the admin role that controls `role`. See {grantRole} and
         * {revokeRole}.
         *
         * To change a role's admin, use {_setRoleAdmin}.
         */
        function getRoleAdmin(bytes32 role) public view returns (bytes32) {
            return _roles[role].adminRole;
        }
        /**
         * @dev Grants `role` to `account`.
         *
         * If `account` had not been already granted `role`, emits a {RoleGranted}
         * event.
         *
         * Requirements:
         *
         * - the caller must have ``role``'s admin role.
         */
        function grantRole(bytes32 role, address account) public virtual {
            require(hasRole(_roles[role].adminRole, _msgSender()), "AccessControl: sender must be an admin to grant");
            _grantRole(role, account);
        }
        /**
         * @dev Revokes `role` from `account`.
         *
         * If `account` had been granted `role`, emits a {RoleRevoked} event.
         *
         * Requirements:
         *
         * - the caller must have ``role``'s admin role.
         */
        function revokeRole(bytes32 role, address account) public virtual {
            require(hasRole(_roles[role].adminRole, _msgSender()), "AccessControl: sender must be an admin to revoke");
            _revokeRole(role, account);
        }
        /**
         * @dev Revokes `role` from the calling account.
         *
         * Roles are often managed via {grantRole} and {revokeRole}: this function's
         * purpose is to provide a mechanism for accounts to lose their privileges
         * if they are compromised (such as when a trusted device is misplaced).
         *
         * If the calling account had been granted `role`, emits a {RoleRevoked}
         * event.
         *
         * Requirements:
         *
         * - the caller must be `account`.
         */
        function renounceRole(bytes32 role, address account) public virtual {
            require(account == _msgSender(), "AccessControl: can only renounce roles for self");
            _revokeRole(role, account);
        }
        /**
         * @dev Grants `role` to `account`.
         *
         * If `account` had not been already granted `role`, emits a {RoleGranted}
         * event. Note that unlike {grantRole}, this function doesn't perform any
         * checks on the calling account.
         *
         * [WARNING]
         * ====
         * This function should only be called from the constructor when setting
         * up the initial roles for the system.
         *
         * Using this function in any other way is effectively circumventing the admin
         * system imposed by {AccessControl}.
         * ====
         */
        function _setupRole(bytes32 role, address account) internal virtual {
            _grantRole(role, account);
        }
        /**
         * @dev Sets `adminRole` as ``role``'s admin role.
         *
         * Emits a {RoleAdminChanged} event.
         */
        function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
            emit RoleAdminChanged(role, _roles[role].adminRole, adminRole);
            _roles[role].adminRole = adminRole;
        }
        function _grantRole(bytes32 role, address account) private {
            if (_roles[role].members.add(account)) {
                emit RoleGranted(role, account, _msgSender());
            }
        }
        function _revokeRole(bytes32 role, address account) private {
            if (_roles[role].members.remove(account)) {
                emit RoleRevoked(role, account, _msgSender());
            }
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    import "../../GSN/Context.sol";
    import "./IERC20.sol";
    import "../../math/SafeMath.sol";
    /**
     * @dev Implementation of the {IERC20} interface.
     *
     * This implementation is agnostic to the way tokens are created. This means
     * that a supply mechanism has to be added in a derived contract using {_mint}.
     * For a generic mechanism see {ERC20PresetMinterPauser}.
     *
     * TIP: For a detailed writeup see our guide
     * https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
     * to implement supply mechanisms].
     *
     * We have followed general OpenZeppelin guidelines: functions revert instead
     * of returning `false` on failure. This behavior is nonetheless conventional
     * and does not conflict with the expectations of ERC20 applications.
     *
     * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
     * This allows applications to reconstruct the allowance for all accounts just
     * by listening to said events. Other implementations of the EIP may not emit
     * these events, as it isn't required by the specification.
     *
     * Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
     * functions have been added to mitigate the well-known issues around setting
     * allowances. See {IERC20-approve}.
     */
    contract ERC20 is Context, IERC20 {
        using SafeMath for uint256;
        mapping (address => uint256) private _balances;
        mapping (address => mapping (address => uint256)) private _allowances;
        uint256 private _totalSupply;
        string private _name;
        string private _symbol;
        uint8 private _decimals;
        /**
         * @dev Sets the values for {name} and {symbol}, initializes {decimals} with
         * a default value of 18.
         *
         * To select a different value for {decimals}, use {_setupDecimals}.
         *
         * All three of these values are immutable: they can only be set once during
         * construction.
         */
        constructor (string memory name_, string memory symbol_) public {
            _name = name_;
            _symbol = symbol_;
            _decimals = 18;
        }
        /**
         * @dev Returns the name of the token.
         */
        function name() public view returns (string memory) {
            return _name;
        }
        /**
         * @dev Returns the symbol of the token, usually a shorter version of the
         * name.
         */
        function symbol() public view returns (string memory) {
            return _symbol;
        }
        /**
         * @dev Returns the number of decimals used to get its user representation.
         * For example, if `decimals` equals `2`, a balance of `505` tokens should
         * be displayed to a user as `5,05` (`505 / 10 ** 2`).
         *
         * Tokens usually opt for a value of 18, imitating the relationship between
         * Ether and Wei. This is the value {ERC20} uses, unless {_setupDecimals} is
         * called.
         *
         * NOTE: This information is only used for _display_ purposes: it in
         * no way affects any of the arithmetic of the contract, including
         * {IERC20-balanceOf} and {IERC20-transfer}.
         */
        function decimals() public view returns (uint8) {
            return _decimals;
        }
        /**
         * @dev See {IERC20-totalSupply}.
         */
        function totalSupply() public view override returns (uint256) {
            return _totalSupply;
        }
        /**
         * @dev See {IERC20-balanceOf}.
         */
        function balanceOf(address account) public view override returns (uint256) {
            return _balances[account];
        }
        /**
         * @dev See {IERC20-transfer}.
         *
         * Requirements:
         *
         * - `recipient` cannot be the zero address.
         * - the caller must have a balance of at least `amount`.
         */
        function transfer(address recipient, uint256 amount) public virtual override returns (bool) {
            _transfer(_msgSender(), recipient, amount);
            return true;
        }
        /**
         * @dev See {IERC20-allowance}.
         */
        function allowance(address owner, address spender) public view virtual override returns (uint256) {
            return _allowances[owner][spender];
        }
        /**
         * @dev See {IERC20-approve}.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         */
        function approve(address spender, uint256 amount) public virtual override returns (bool) {
            _approve(_msgSender(), spender, amount);
            return true;
        }
        /**
         * @dev See {IERC20-transferFrom}.
         *
         * Emits an {Approval} event indicating the updated allowance. This is not
         * required by the EIP. See the note at the beginning of {ERC20}.
         *
         * Requirements:
         *
         * - `sender` and `recipient` cannot be the zero address.
         * - `sender` must have a balance of at least `amount`.
         * - the caller must have allowance for ``sender``'s tokens of at least
         * `amount`.
         */
        function transferFrom(address sender, address recipient, uint256 amount) public virtual override returns (bool) {
            _transfer(sender, recipient, amount);
            _approve(sender, _msgSender(), _allowances[sender][_msgSender()].sub(amount, "ERC20: transfer amount exceeds allowance"));
            return true;
        }
        /**
         * @dev Atomically increases the allowance granted to `spender` by the caller.
         *
         * This is an alternative to {approve} that can be used as a mitigation for
         * problems described in {IERC20-approve}.
         *
         * Emits an {Approval} event indicating the updated allowance.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         */
        function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
            _approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(addedValue));
            return true;
        }
        /**
         * @dev Atomically decreases the allowance granted to `spender` by the caller.
         *
         * This is an alternative to {approve} that can be used as a mitigation for
         * problems described in {IERC20-approve}.
         *
         * Emits an {Approval} event indicating the updated allowance.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         * - `spender` must have allowance for the caller of at least
         * `subtractedValue`.
         */
        function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
            _approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue, "ERC20: decreased allowance below zero"));
            return true;
        }
        /**
         * @dev Moves tokens `amount` from `sender` to `recipient`.
         *
         * This is internal function is equivalent to {transfer}, and can be used to
         * e.g. implement automatic token fees, slashing mechanisms, etc.
         *
         * Emits a {Transfer} event.
         *
         * Requirements:
         *
         * - `sender` cannot be the zero address.
         * - `recipient` cannot be the zero address.
         * - `sender` must have a balance of at least `amount`.
         */
        function _transfer(address sender, address recipient, uint256 amount) internal virtual {
            require(sender != address(0), "ERC20: transfer from the zero address");
            require(recipient != address(0), "ERC20: transfer to the zero address");
            _beforeTokenTransfer(sender, recipient, amount);
            _balances[sender] = _balances[sender].sub(amount, "ERC20: transfer amount exceeds balance");
            _balances[recipient] = _balances[recipient].add(amount);
            emit Transfer(sender, recipient, amount);
        }
        /** @dev Creates `amount` tokens and assigns them to `account`, increasing
         * the total supply.
         *
         * Emits a {Transfer} event with `from` set to the zero address.
         *
         * Requirements:
         *
         * - `to` cannot be the zero address.
         */
        function _mint(address account, uint256 amount) internal virtual {
            require(account != address(0), "ERC20: mint to the zero address");
            _beforeTokenTransfer(address(0), account, amount);
            _totalSupply = _totalSupply.add(amount);
            _balances[account] = _balances[account].add(amount);
            emit Transfer(address(0), account, amount);
        }
        /**
         * @dev Destroys `amount` tokens from `account`, reducing the
         * total supply.
         *
         * Emits a {Transfer} event with `to` set to the zero address.
         *
         * Requirements:
         *
         * - `account` cannot be the zero address.
         * - `account` must have at least `amount` tokens.
         */
        function _burn(address account, uint256 amount) internal virtual {
            require(account != address(0), "ERC20: burn from the zero address");
            _beforeTokenTransfer(account, address(0), amount);
            _balances[account] = _balances[account].sub(amount, "ERC20: burn amount exceeds balance");
            _totalSupply = _totalSupply.sub(amount);
            emit Transfer(account, address(0), amount);
        }
        /**
         * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
         *
         * This internal function is equivalent to `approve`, and can be used to
         * e.g. set automatic allowances for certain subsystems, etc.
         *
         * Emits an {Approval} event.
         *
         * Requirements:
         *
         * - `owner` cannot be the zero address.
         * - `spender` cannot be the zero address.
         */
        function _approve(address owner, address spender, uint256 amount) internal virtual {
            require(owner != address(0), "ERC20: approve from the zero address");
            require(spender != address(0), "ERC20: approve to the zero address");
            _allowances[owner][spender] = amount;
            emit Approval(owner, spender, amount);
        }
        /**
         * @dev Sets {decimals} to a value other than the default one of 18.
         *
         * WARNING: This function should only be called from the constructor. Most
         * applications that interact with token contracts will not expect
         * {decimals} to ever change, and may work incorrectly if it does.
         */
        function _setupDecimals(uint8 decimals_) internal {
            _decimals = decimals_;
        }
        /**
         * @dev Hook that is called before any transfer of tokens. This includes
         * minting and burning.
         *
         * Calling conditions:
         *
         * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
         * will be to transferred to `to`.
         * - when `from` is zero, `amount` tokens will be minted for `to`.
         * - when `to` is zero, `amount` of ``from``'s tokens will be burned.
         * - `from` and `to` are never both zero.
         *
         * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
         */
        function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual { }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    import "../GSN/Context.sol";
    /**
     * @dev Contract module which provides a basic access control mechanism, where
     * there is an account (an owner) that can be granted exclusive access to
     * specific functions.
     *
     * By default, the owner account will be the one that deploys the contract. This
     * can later be changed with {transferOwnership}.
     *
     * This module is used through inheritance. It will make available the modifier
     * `onlyOwner`, which can be applied to your functions to restrict their use to
     * the owner.
     */
    abstract contract Ownable is Context {
        address private _owner;
        event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
        /**
         * @dev Initializes the contract setting the deployer as the initial owner.
         */
        constructor () internal {
            address msgSender = _msgSender();
            _owner = msgSender;
            emit OwnershipTransferred(address(0), msgSender);
        }
        /**
         * @dev Returns the address of the current owner.
         */
        function owner() public view returns (address) {
            return _owner;
        }
        /**
         * @dev Throws if called by any account other than the owner.
         */
        modifier onlyOwner() {
            require(_owner == _msgSender(), "Ownable: caller is not the owner");
            _;
        }
        /**
         * @dev Leaves the contract without owner. It will not be possible to call
         * `onlyOwner` functions anymore. Can only be called by the current owner.
         *
         * NOTE: Renouncing ownership will leave the contract without an owner,
         * thereby removing any functionality that is only available to the owner.
         */
        function renounceOwnership() public virtual onlyOwner {
            emit OwnershipTransferred(_owner, address(0));
            _owner = address(0);
        }
        /**
         * @dev Transfers ownership of the contract to a new account (`newOwner`).
         * Can only be called by the current owner.
         */
        function transferOwnership(address newOwner) public virtual onlyOwner {
            require(newOwner != address(0), "Ownable: new owner is the zero address");
            emit OwnershipTransferred(_owner, newOwner);
            _owner = newOwner;
        }
    }
    // SPDX-License-Identifier: GPL-3.0
    pragma solidity ^0.6.12;
    import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
    interface IDetailedERC20 is IERC20 {
      function name() external returns (string memory);
      function symbol() external returns (string memory);
      function decimals() external returns (uint8);
    }// SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    /**
     * @dev Library for managing
     * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
     * types.
     *
     * Sets have the following properties:
     *
     * - Elements are added, removed, and checked for existence in constant time
     * (O(1)).
     * - Elements are enumerated in O(n). No guarantees are made on the ordering.
     *
     * ```
     * contract Example {
     *     // Add the library methods
     *     using EnumerableSet for EnumerableSet.AddressSet;
     *
     *     // Declare a set state variable
     *     EnumerableSet.AddressSet private mySet;
     * }
     * ```
     *
     * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
     * and `uint256` (`UintSet`) are supported.
     */
    library EnumerableSet {
        // To implement this library for multiple types with as little code
        // repetition as possible, we write it in terms of a generic Set type with
        // bytes32 values.
        // The Set implementation uses private functions, and user-facing
        // implementations (such as AddressSet) are just wrappers around the
        // underlying Set.
        // This means that we can only create new EnumerableSets for types that fit
        // in bytes32.
        struct Set {
            // Storage of set values
            bytes32[] _values;
            // Position of the value in the `values` array, plus 1 because index 0
            // means a value is not in the set.
            mapping (bytes32 => uint256) _indexes;
        }
        /**
         * @dev Add a value to a set. O(1).
         *
         * Returns true if the value was added to the set, that is if it was not
         * already present.
         */
        function _add(Set storage set, bytes32 value) private returns (bool) {
            if (!_contains(set, value)) {
                set._values.push(value);
                // The value is stored at length-1, but we add 1 to all indexes
                // and use 0 as a sentinel value
                set._indexes[value] = set._values.length;
                return true;
            } else {
                return false;
            }
        }
        /**
         * @dev Removes a value from a set. O(1).
         *
         * Returns true if the value was removed from the set, that is if it was
         * present.
         */
        function _remove(Set storage set, bytes32 value) private returns (bool) {
            // We read and store the value's index to prevent multiple reads from the same storage slot
            uint256 valueIndex = set._indexes[value];
            if (valueIndex != 0) { // Equivalent to contains(set, value)
                // To delete an element from the _values array in O(1), we swap the element to delete with the last one in
                // the array, and then remove the last element (sometimes called as 'swap and pop').
                // This modifies the order of the array, as noted in {at}.
                uint256 toDeleteIndex = valueIndex - 1;
                uint256 lastIndex = set._values.length - 1;
                // When the value to delete is the last one, the swap operation is unnecessary. However, since this occurs
                // so rarely, we still do the swap anyway to avoid the gas cost of adding an 'if' statement.
                bytes32 lastvalue = set._values[lastIndex];
                // Move the last value to the index where the value to delete is
                set._values[toDeleteIndex] = lastvalue;
                // Update the index for the moved value
                set._indexes[lastvalue] = toDeleteIndex + 1; // All indexes are 1-based
                // Delete the slot where the moved value was stored
                set._values.pop();
                // Delete the index for the deleted slot
                delete set._indexes[value];
                return true;
            } else {
                return false;
            }
        }
        /**
         * @dev Returns true if the value is in the set. O(1).
         */
        function _contains(Set storage set, bytes32 value) private view returns (bool) {
            return set._indexes[value] != 0;
        }
        /**
         * @dev Returns the number of values on the set. O(1).
         */
        function _length(Set storage set) private view returns (uint256) {
            return set._values.length;
        }
       /**
        * @dev Returns the value stored at position `index` in the set. O(1).
        *
        * Note that there are no guarantees on the ordering of values inside the
        * array, and it may change when more values are added or removed.
        *
        * Requirements:
        *
        * - `index` must be strictly less than {length}.
        */
        function _at(Set storage set, uint256 index) private view returns (bytes32) {
            require(set._values.length > index, "EnumerableSet: index out of bounds");
            return set._values[index];
        }
        // Bytes32Set
        struct Bytes32Set {
            Set _inner;
        }
        /**
         * @dev Add a value to a set. O(1).
         *
         * Returns true if the value was added to the set, that is if it was not
         * already present.
         */
        function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
            return _add(set._inner, value);
        }
        /**
         * @dev Removes a value from a set. O(1).
         *
         * Returns true if the value was removed from the set, that is if it was
         * present.
         */
        function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
            return _remove(set._inner, value);
        }
        /**
         * @dev Returns true if the value is in the set. O(1).
         */
        function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
            return _contains(set._inner, value);
        }
        /**
         * @dev Returns the number of values in the set. O(1).
         */
        function length(Bytes32Set storage set) internal view returns (uint256) {
            return _length(set._inner);
        }
       /**
        * @dev Returns the value stored at position `index` in the set. O(1).
        *
        * Note that there are no guarantees on the ordering of values inside the
        * array, and it may change when more values are added or removed.
        *
        * Requirements:
        *
        * - `index` must be strictly less than {length}.
        */
        function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
            return _at(set._inner, index);
        }
        // AddressSet
        struct AddressSet {
            Set _inner;
        }
        /**
         * @dev Add a value to a set. O(1).
         *
         * Returns true if the value was added to the set, that is if it was not
         * already present.
         */
        function add(AddressSet storage set, address value) internal returns (bool) {
            return _add(set._inner, bytes32(uint256(value)));
        }
        /**
         * @dev Removes a value from a set. O(1).
         *
         * Returns true if the value was removed from the set, that is if it was
         * present.
         */
        function remove(AddressSet storage set, address value) internal returns (bool) {
            return _remove(set._inner, bytes32(uint256(value)));
        }
        /**
         * @dev Returns true if the value is in the set. O(1).
         */
        function contains(AddressSet storage set, address value) internal view returns (bool) {
            return _contains(set._inner, bytes32(uint256(value)));
        }
        /**
         * @dev Returns the number of values in the set. O(1).
         */
        function length(AddressSet storage set) internal view returns (uint256) {
            return _length(set._inner);
        }
       /**
        * @dev Returns the value stored at position `index` in the set. O(1).
        *
        * Note that there are no guarantees on the ordering of values inside the
        * array, and it may change when more values are added or removed.
        *
        * Requirements:
        *
        * - `index` must be strictly less than {length}.
        */
        function at(AddressSet storage set, uint256 index) internal view returns (address) {
            return address(uint256(_at(set._inner, index)));
        }
        // UintSet
        struct UintSet {
            Set _inner;
        }
        /**
         * @dev Add a value to a set. O(1).
         *
         * Returns true if the value was added to the set, that is if it was not
         * already present.
         */
        function add(UintSet storage set, uint256 value) internal returns (bool) {
            return _add(set._inner, bytes32(value));
        }
        /**
         * @dev Removes a value from a set. O(1).
         *
         * Returns true if the value was removed from the set, that is if it was
         * present.
         */
        function remove(UintSet storage set, uint256 value) internal returns (bool) {
            return _remove(set._inner, bytes32(value));
        }
        /**
         * @dev Returns true if the value is in the set. O(1).
         */
        function contains(UintSet storage set, uint256 value) internal view returns (bool) {
            return _contains(set._inner, bytes32(value));
        }
        /**
         * @dev Returns the number of values on the set. O(1).
         */
        function length(UintSet storage set) internal view returns (uint256) {
            return _length(set._inner);
        }
       /**
        * @dev Returns the value stored at position `index` in the set. O(1).
        *
        * Note that there are no guarantees on the ordering of values inside the
        * array, and it may change when more values are added or removed.
        *
        * Requirements:
        *
        * - `index` must be strictly less than {length}.
        */
        function at(UintSet storage set, uint256 index) internal view returns (uint256) {
            return uint256(_at(set._inner, index));
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.2 <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;
            // solhint-disable-next-line no-inline-assembly
            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");
            // solhint-disable-next-line avoid-low-level-calls, avoid-call-value
            (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");
            // solhint-disable-next-line avoid-low-level-calls
            (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");
            // solhint-disable-next-line avoid-low-level-calls
            (bool success, bytes memory returndata) = target.staticcall(data);
            return _verifyCallResult(success, returndata, errorMessage);
        }
        function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private 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
                    // solhint-disable-next-line no-inline-assembly
                    assembly {
                        let returndata_size := mload(returndata)
                        revert(add(32, returndata), returndata_size)
                    }
                } else {
                    revert(errorMessage);
                }
            }
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    /*
     * @dev Provides information about the current execution context, including the
     * sender of the transaction and its data. While these are generally available
     * via msg.sender and msg.data, they should not be accessed in such a direct
     * manner, since when dealing with GSN meta-transactions the account sending and
     * paying for execution may not be the actual sender (as far as an application
     * is concerned).
     *
     * This contract is only required for intermediate, library-like contracts.
     */
    abstract contract Context {
        function _msgSender() internal view virtual returns (address payable) {
            return msg.sender;
        }
        function _msgData() internal view virtual returns (bytes memory) {
            this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
            return msg.data;
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <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);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.6.0 <0.8.0;
    /**
     * @dev Wrappers over Solidity's arithmetic operations with added overflow
     * checks.
     *
     * Arithmetic operations in Solidity wrap on overflow. This can easily result
     * in bugs, because programmers usually assume that an overflow raises an
     * error, which is the standard behavior in high level programming languages.
     * `SafeMath` restores this intuition by reverting the transaction when 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.
     */
    library SafeMath {
        /**
         * @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) {
            uint256 c = a + b;
            require(c >= a, "SafeMath: addition overflow");
            return c;
        }
        /**
         * @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 sub(a, b, "SafeMath: subtraction overflow");
        }
        /**
         * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
         * overflow (when the result is negative).
         *
         * Counterpart to Solidity's `-` operator.
         *
         * Requirements:
         *
         * - Subtraction cannot overflow.
         */
        function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
            require(b <= a, errorMessage);
            uint256 c = a - b;
            return c;
        }
        /**
         * @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) {
            // 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 0;
            }
            uint256 c = a * b;
            require(c / a == b, "SafeMath: multiplication overflow");
            return c;
        }
        /**
         * @dev Returns the integer division of two unsigned integers. Reverts 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) internal pure returns (uint256) {
            return div(a, b, "SafeMath: division by zero");
        }
        /**
         * @dev Returns the integer division of two unsigned integers. Reverts 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) {
            require(b > 0, errorMessage);
            uint256 c = a / b;
            // assert(a == b * c + a % b); // There is no case in which this doesn't hold
            return c;
        }
        /**
         * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
         * Reverts 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 mod(a, b, "SafeMath: modulo by zero");
        }
        /**
         * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
         * Reverts with custom message 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, string memory errorMessage) internal pure returns (uint256) {
            require(b != 0, errorMessage);
            return a % b;
        }
    }