Contract Source Code (Solidity Standard Json-Input format)Audit Report

IDE

• Blockscan IDE
• 🤖 Code ReaderBeta

More Options

• Similar
• Submit Audit
• Compare

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

import { SafeERC20, IERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import { PRBMathCastingUint128 as CastingUint128 } from "@prb/math/src/casting/Uint128.sol";
import { PRBMathCastingUint40 as CastingUint40 } from "@prb/math/src/casting/Uint40.sol";
import { SD59x18 } from "@prb/math/src/SD59x18.sol";
import { VestingLockup } from "./abstracts/VestingLockup.sol";
import { IVestingLockup } from "./interfaces/IVestingLockup.sol";
import { IUnseenVesting } from "./interfaces/IUnseenVesting.sol";
import { IUnseenVestingNFTDescriptor } from "./interfaces/IUnseenVestingNFTDescriptor.sol";
import { Errors } from "./libraries/Errors.sol";
import { Helpers } from "./libraries/Helpers.sol";
import { Lockup } from "./types/DataTypes.sol";
import { ReentrancyGuard } from "solady/src/utils/ReentrancyGuard.sol";

/*

$$$$$$$\            $$\         $$\            $$$$$$\    $$\                     $$\ $$\                     
$$  __$$\           $$ |        $$ |          $$  __$$\   $$ |                    $$ |\__|                    
$$ |  $$ | $$$$$$\  $$ |  $$\ $$$$$$\         $$ /  \__|$$$$$$\   $$\   $$\  $$$$$$$ |$$\  $$$$$$\   $$$$$$$\ 
$$$$$$$  |$$  __$$\ $$ | $$  |\_$$  _|        \$$$$$$\  \_$$  _|  $$ |  $$ |$$  __$$ |$$ |$$  __$$\ $$  _____|
$$  __$$< $$$$$$$$ |$$$$$$  /   $$ |           \____$$\   $$ |    $$ |  $$ |$$ /  $$ |$$ |$$ /  $$ |\$$$$$$\  
$$ |  $$ |$$   ____|$$  _$$<    $$ |$$\       $$\   $$ |  $$ |$$\ $$ |  $$ |$$ |  $$ |$$ |$$ |  $$ | \____$$\ 
$$ |  $$ |\$$$$$$$\ $$ | \$$\   \$$$$  |      \$$$$$$  |  \$$$$  |\$$$$$$  |\$$$$$$$ |$$ |\$$$$$$  |$$$$$$$  |
\__|  \__| \_______|\__|  \__|   \____/        \______/    \____/  \______/  \_______|\__| \______/ \_______/   

*/

/**
 * @title  UnseenVesting
 * @author decapitator (0xdecapitator.eth)
 * @notice Manages UNCN vesting securely.
 *         Ensures fair, scheduled distribution to recipients.
 */
contract UnseenVesting is ReentrancyGuard, IUnseenVesting, VestingLockup {
    using CastingUint128 for uint128;
    using CastingUint40 for uint40;
    using SafeERC20 for IERC20;

    // Defines the number of milestones in the token
    // release schedule, such as lockup, cliff, and
    // linear release segments.
    uint256 public immutable override MAX_SEGMENT_COUNT;

    // Unseen uncn token contract.
    IERC20 public immutable override UNCN;

    // Unseen vesting schedules mapped by ids.
    mapping(uint256 id => Lockup.Schedule schedule) private _schedules;

    /**
     * @dev Deploys Unseen Vesting contract.
     * @param initialOwner The address of the initial contract owner.
     * @param initialNFTDescriptor The address of the NFT descriptor contract.
     * @param maxSegmentCount The maximum number of segments allowed in a schedule.
     */
    constructor(
        address initialOwner,
        IUnseenVestingNFTDescriptor initialNFTDescriptor,
        uint256 maxSegmentCount,
        address uncn
    )
        payable
        ERC721("UNSEEN VESTING", "UNCN-VESTING")
        VestingLockup(initialOwner, initialNFTDescriptor)
    {
        if (maxSegmentCount < 4) {
            revert Errors.SegmentCountMismatch();
        }

        MAX_SEGMENT_COUNT = maxSegmentCount;

        nextScheduleId = 1;

        if (uncn == address(0)) revert Errors.UNCNIsZeroAddress();

        UNCN = IERC20(uncn);
    }

    /**
     * @dev Retrieves the deposited amount associated with a schedule.
     * @param scheduleId The ID of the schedule.
     * @return depositedAmount The amount deposited in the schedule.
     */
    function getDepositedAmount(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (uint128 depositedAmount)
    {
        depositedAmount = _schedules[scheduleId].amounts.deposited;
    }

    /**
     * @dev Retrieves the end time of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return endTime The end time of the schedule.
     */
    function getEndTime(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (uint40 endTime) {
        endTime = _schedules[scheduleId].endTime;
    }

    /**
     * @dev Retrieves the range (start and end times) of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return range The range of the schedule.
     */
    function getRange(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (Lockup.Range memory range)
    {
        range = Lockup.Range({
            start: _schedules[scheduleId].startTime,
            end: _schedules[scheduleId].endTime
        });
    }

    /**
     * @dev Retrieves the refunded amount associated with a schedule.
     * @param scheduleId The ID of the schedule.
     * @return refundedAmount The amount refunded in the schedule.
     */
    function getRefundedAmount(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (uint128 refundedAmount)
    {
        refundedAmount = _schedules[scheduleId].amounts.refunded;
    }

    /**
     * @dev Retrieves the segments of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return segments The segments of the schedule.
     */
    function getSegments(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (Lockup.Segment[] memory segments)
    {
        segments = _schedules[scheduleId].segments;
    }

    /**
     * @dev Retrieves the sender address associated with a schedule.
     * @param scheduleId The ID of the schedule.
     * @return sender The address of the sender.
     */
    function getSender(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (address sender) {
        sender = _schedules[scheduleId].sender;
    }

    /**
     * @dev Retrieves the start time of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return startTime The start time of the schedule.
     */
    function getStartTime(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (uint40 startTime) {
        startTime = _schedules[scheduleId].startTime;
    }

    /**
     * @dev Retrieves the full details of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return schedule The schedule details.
     */
    function getSchedule(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (Lockup.Schedule memory schedule)
    {
        schedule = _schedules[scheduleId];

        // Settled schedules cannot be canceled.
        if (_statusOf(scheduleId) == Lockup.Status.SETTLED) {
            schedule.isCancelable = false;
        }
    }

    /**
     * @dev Retrieves the amount withdrawn from a schedule.
     * @param scheduleId The ID of the schedule.
     * @return withdrawnAmount The amount withdrawn from the schedule.
     */
    function getWithdrawnAmount(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (uint128 withdrawnAmount)
    {
        withdrawnAmount = _schedules[scheduleId].amounts.withdrawn;
    }

    /**
     * @dev Checks if a schedule is cancelable.
     * @param scheduleId The ID of the schedule.
     * @return result True if the schedule is cancelable; otherwise, false.
     */
    function isCancelable(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (bool result) {
        if (_statusOf(scheduleId) != Lockup.Status.SETTLED) {
            result = _schedules[scheduleId].isCancelable;
        }
    }

    /**
     * @dev Checks if a schedule is transferable.
     * @param scheduleId The ID of the schedule.
     * @return result True if the schedule is transferable; otherwise, false.
     */
    function isTransferable(
        uint256 scheduleId
    )
        public
        view
        override(IVestingLockup, VestingLockup)
        notNull(scheduleId)
        returns (bool result)
    {
        result = _schedules[scheduleId].isTransferable;
    }

    /**
     * @dev Checks if a schedule is depleted.
     * @param scheduleId The ID of the schedule.
     * @return result True if the schedule is depleted; otherwise, false.
     */
    function isDepleted(
        uint256 scheduleId
    )
        public
        view
        override(IVestingLockup, VestingLockup)
        notNull(scheduleId)
        returns (bool result)
    {
        result = _schedules[scheduleId].isDepleted;
    }

    /**
     * @dev Checks if an NFT ID corresponds to a schedule.
     * @param scheduleId The ID of the schedule.
     * @return result True if the NFT ID corresponds to a schedule; otherwise, false.
     */
    function isSchedule(
        uint256 scheduleId
    )
        public
        view
        override(IVestingLockup, VestingLockup)
        returns (bool result)
    {
        result = _schedules[scheduleId].isSchedule;
    }

    /**
     * @dev Retrieves the refundable amount from a schedule.
     * @param scheduleId The ID of the schedule.
     * @return refundableAmount The refundable amount from the schedule.
     */
    function refundableAmountOf(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (uint128 refundableAmount)
    {
        // These checks are needed because {_calculateVestedAmount} does not look up the schedule's status. Note that
        // checking for `isCancelable` also checks if the schedule `wasCanceled` thanks to the protocol invariant that
        // canceled schedules are not cancelable anymore.
        if (
            _schedules[scheduleId].isCancelable &&
            !_schedules[scheduleId].isDepleted
        ) {
            refundableAmount =
                _schedules[scheduleId].amounts.deposited -
                _calculateVestedAmount(scheduleId);
        }
        // Otherwise, the result is implicitly zero.
    }

    /**
     * @dev Retrieves the status of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return status The status of the schedule.
     */
    function statusOf(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (Lockup.Status status)
    {
        status = _statusOf(scheduleId);
    }

    /**
     * @dev Retrieves the vested amount from a schedule.
     * @param scheduleId The ID of the schedule.
     * @return vestedAmount The vested amount from the schedule.
     */
    function vestedAmountOf(
        uint256 scheduleId
    )
        public
        view
        override(IVestingLockup, IUnseenVesting)
        notNull(scheduleId)
        returns (uint128 vestedAmount)
    {
        vestedAmount = _vestedAmountOf(scheduleId);
    }

    /**
     * @dev Checks if a schedule was canceled.
     * @param scheduleId The ID of the schedule.
     * @return result True if the schedule was canceled; otherwise, false.
     */
    function wasCanceled(
        uint256 scheduleId
    )
        public
        view
        override(IVestingLockup, VestingLockup)
        notNull(scheduleId)
        returns (bool result)
    {
        result = _schedules[scheduleId].wasCanceled;
    }

    /**
     * @dev Batch creates schedules with the specified parameters.
     * @param schedulesParams The parameters for creating the schedules.
     * @return scheduleIds The IDs of the newly created schedules.
     */
    function createMultiSchedules(
        Lockup.CreateSchedule[] calldata schedulesParams
    )
        external
        override
        noDelegateCall
        nonReentrant
        onlyOwner
        returns (uint256[] memory scheduleIds)
    {
        // Check that the schedules count is not zero.
        uint256 schedulesCount = schedulesParams.length;
        if (schedulesCount == 0) {
            revert Errors.BatchSizeZero();
        }

        // Create a schedule for each element in the parameter array.
        scheduleIds = new uint256[](schedulesCount);
        for (uint256 i; i < schedulesCount; ) {
            scheduleIds[i] = _createSchedule(schedulesParams[i]);
            unchecked {
                ++i;
            }
        }
    }

    /**
     * @dev Creates a new schedule with the specified parameters.
     * @param params The parameters for creating the schedule.
     * @return scheduleId The ID of the newly created schedule.
     */
    function createSchedule(
        Lockup.CreateSchedule calldata params
    )
        external
        override
        noDelegateCall
        nonReentrant
        onlyOwner
        returns (uint256 scheduleId)
    {
        // Checks, Effects and Interactions: create the schedule.
        scheduleId = _createSchedule(params);
    }

    /**
     * @dev Calculates the vested amount without looking up the schedule's status.
     * @param scheduleId The ID of the schedule.
     * @return The vested amount.
     */
    function _calculateVestedAmount(
        uint256 scheduleId
    ) internal view returns (uint128) {
        // If the start time is in the future, return zero.
        uint40 currentTime = uint40(block.timestamp);
        if (_schedules[scheduleId].startTime >= currentTime) {
            return 0;
        }

        // If the end time is not in the future, return the deposited amount.
        uint40 endTime = _schedules[scheduleId].endTime;
        if (endTime <= currentTime) {
            return _schedules[scheduleId].amounts.deposited;
        }

        if (_schedules[scheduleId].segments.length > 1) {
            // If there is more than one segment, it may be necessary to iterate over all of them.
            return _calculateVestedAmountForMultipleSegments(scheduleId);
        } else {
            // Otherwise, there is only one segment, and the calculation is simpler.
            return _calculateVestedAmountForOneSegment(scheduleId);
        }
    }

    /**
     * @dev Calculates the vested amount for a schedule with multiple segments.
     * @param scheduleId The ID of the schedule.
     * @notice 1. Normalization to 18 decimals is not needed because there is no
     *            mix of amounts with different decimals.
     *         2. The schedule's start time must be in the past so that the
     *            calculations below do not overflow.
     *         3. The schedule's end time must be in the future so that the loop
     *            below does not panic with an "index out of bounds" error.
     * @return The vested amount.
     */
    function _calculateVestedAmountForMultipleSegments(
        uint256 scheduleId
    ) internal view returns (uint128) {
        unchecked {
            uint40 currentTime = uint40(block.timestamp);
            Lockup.Schedule memory schedule = _schedules[scheduleId];

            // Sum the amounts in all segments that precede the current time.
            uint128 previousSegmentAmounts;
            uint40 currentSegmentMilestone = schedule.segments[0].milestone;
            uint256 index = 0;
            while (currentSegmentMilestone < currentTime) {
                previousSegmentAmounts += schedule.segments[index].amount;
                index++;
                currentSegmentMilestone = schedule.segments[index].milestone;
            }

            // After exiting the loop, the current segment is at `index`.
            SD59x18 currentSegmentAmount = schedule
                .segments[index]
                .amount
                .intoSD59x18();
            SD59x18 currentSegmentExponent = schedule
                .segments[index]
                .exponent
                .intoSD59x18();
            currentSegmentMilestone = schedule.segments[index].milestone;

            uint40 previousMilestone;
            if (index > 0) {
                // When the current segment's index is greater than or equal to 1, it implies that the segment is not
                // the first. In this case, use the previous segment's milestone.
                previousMilestone = schedule.segments[index - 1].milestone;
            } else {
                // Otherwise, the current segment is the first, so use the start time as the previous milestone.
                previousMilestone = schedule.startTime;
            }

            // Calculate how much time has passed since the segment started, and the total time of the segment.
            SD59x18 elapsedSegmentTime = (currentTime - previousMilestone)
                .intoSD59x18();
            SD59x18 totalSegmentTime = (currentSegmentMilestone -
                previousMilestone).intoSD59x18();

            // Divide the elapsed segment time by the total duration of the segment.
            SD59x18 elapsedSegmentTimePercentage = elapsedSegmentTime.div(
                totalSegmentTime
            );

            // Calculate the vested amount using the special formula.
            SD59x18 multiplier = elapsedSegmentTimePercentage.pow(
                currentSegmentExponent
            );
            SD59x18 segmentVestedAmount = multiplier.mul(currentSegmentAmount);

            // Although the segment vested amount should never exceed the total segment amount, this condition is
            // checked without asserting to avoid locking funds in case of a bug. If this situation occurs, the
            // amount vested in the segment is considered zero (except for past withdrawals), and the segment is
            // effectively voided.
            if (segmentVestedAmount.gt(currentSegmentAmount)) {
                return
                    previousSegmentAmounts > schedule.amounts.withdrawn
                        ? previousSegmentAmounts
                        : schedule.amounts.withdrawn;
            }

            // Calculate the total vested amount by adding the previous segment amounts and the amount vested in
            // the current segment. Casting to uint128 is safe due to the if statement above.
            return
                previousSegmentAmounts +
                uint128(segmentVestedAmount.intoUint256());
        }
    }

    /**
     * @dev Calculates the vested amount for a schedule with one segment.
     * @param scheduleId The ID of the schedule.
     * @return The vested amount.
     */
    function _calculateVestedAmountForOneSegment(
        uint256 scheduleId
    ) internal view returns (uint128) {
        unchecked {
            // Calculate how much time has passed since the schedule started, and the schedule's total duration.
            SD59x18 elapsedTime = (uint40(block.timestamp) -
                _schedules[scheduleId].startTime).intoSD59x18();
            SD59x18 totalTime = (_schedules[scheduleId].endTime -
                _schedules[scheduleId].startTime).intoSD59x18();

            // Divide the elapsed time by the schedule's total duration.
            SD59x18 elapsedTimePercentage = elapsedTime.div(totalTime);

            // Cast the schedule parameters to SD59x18.
            SD59x18 exponent = _schedules[scheduleId]
                .segments[0]
                .exponent
                .intoSD59x18();
            SD59x18 depositedAmount = _schedules[scheduleId]
                .amounts
                .deposited
                .intoSD59x18();

            // Calculate the vested amount using the special formula.
            SD59x18 multiplier = elapsedTimePercentage.pow(exponent);
            SD59x18 vestedAmount = multiplier.mul(depositedAmount);

            // Although the vested amount should never exceed the deposited amount, this condition is checked
            // without asserting to avoid locking funds in case of a bug. If this situation occurs, the withdrawn
            // amount is considered to be the vested amount, and the schedule is effectively frozen.
            if (vestedAmount.gt(depositedAmount)) {
                return _schedules[scheduleId].amounts.withdrawn;
            }

            // Cast the vested amount to uint128. This is safe due to the check above.
            return uint128(vestedAmount.intoUint256());
        }
    }

    /**
     * @dev Checks if the caller is the sender of the schedule.
     * @param scheduleId The ID of the schedule.
     * @return True if the caller is the sender; otherwise, false.
     */
    function _isCallerScheduleSender(
        uint256 scheduleId
    ) internal view override returns (bool) {
        return msg.sender == _schedules[scheduleId].sender;
    }

    /**
     * @dev Checks whether `msg.sender` is the schedule's recipient or an approved third party.
     * @param scheduleId The ID of the schedule.
     * @return True if the caller is approved.
     */
    function _isCallerScheduleRecipientOrApproved(
        uint256 scheduleId
    ) internal view override returns (bool) {
        address recipient = _ownerOf(scheduleId);
        return
            msg.sender == recipient ||
            isApprovedForAll({ owner: recipient, operator: msg.sender }) ||
            getApproved(scheduleId) == msg.sender;
    }

    /**
     * @dev Retrieves the status of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return The status of the schedule.
     */
    function _statusOf(
        uint256 scheduleId
    ) internal view override returns (Lockup.Status) {
        if (_schedules[scheduleId].isDepleted) {
            return Lockup.Status.DEPLETED;
        } else if (_schedules[scheduleId].wasCanceled) {
            return Lockup.Status.CANCELED;
        }

        if (block.timestamp < _schedules[scheduleId].startTime) {
            return Lockup.Status.PENDING;
        }

        if (
            _calculateVestedAmount(scheduleId) <
            _schedules[scheduleId].amounts.deposited
        ) {
            return Lockup.Status.ONGOING;
        } else {
            return Lockup.Status.SETTLED;
        }
    }

    /**
     * @dev Retrieves the vested amount of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return The vested amount.
     */
    function _vestedAmountOf(
        uint256 scheduleId
    ) internal view returns (uint128) {
        Lockup.Amounts memory amounts = _schedules[scheduleId].amounts;

        if (_schedules[scheduleId].isDepleted) {
            return amounts.withdrawn;
        } else if (_schedules[scheduleId].wasCanceled) {
            return amounts.deposited - amounts.refunded;
        }

        return _calculateVestedAmount(scheduleId);
    }

    /**
     * @dev Retrieves the withdrawable amount of a schedule.
     * @param scheduleId The ID of the schedule.
     * @return The withdrawable amount.
     */
    function _withdrawableAmountOf(
        uint256 scheduleId
    ) internal view override returns (uint128) {
        return
            _vestedAmountOf(scheduleId) -
            _schedules[scheduleId].amounts.withdrawn;
    }

    /**
     * @dev Retrieves the withdrawable amount of a schedule.
     * @param scheduleId The ID of the schedule.
     */
    function _cancel(uint256 scheduleId) internal override {
        // Calculate the vested amount.
        uint128 vestedAmount = _calculateVestedAmount(scheduleId);

        // Retrieve the amounts from storage.
        Lockup.Amounts memory amounts = _schedules[scheduleId].amounts;

        // Checks: the schedule is not settled.
        if (vestedAmount >= amounts.deposited) {
            revert Errors.ScheduleSettled(scheduleId);
        }

        // Checks: the schedule is cancelable.
        if (!_schedules[scheduleId].isCancelable) {
            revert Errors.ScheduleNotCancelable(scheduleId);
        }

        // Calculate the sender's and the recipient's amount.
        uint128 senderAmount = amounts.deposited - vestedAmount;
        uint128 recipientAmount = vestedAmount - amounts.withdrawn;

        // Effects: mark the schedule as canceled.
        _schedules[scheduleId].wasCanceled = true;

        // Effects: make the schedule not cancelable anymore, because a schedule can only be canceled once.
        _schedules[scheduleId].isCancelable = false;

        // Effects: If there are no uncn left for the recipient to withdraw, mark the schedule as depleted.
        if (recipientAmount == 0) {
            _schedules[scheduleId].isDepleted = true;
        }

        // Effects: set the refunded amount.
        _schedules[scheduleId].amounts.refunded = senderAmount;

        // Retrieve the sender and the recipient from storage.
        address sender = _schedules[scheduleId].sender;
        address recipient = _ownerOf(scheduleId);

        // Interactions: refund the sender.
        UNCN.safeTransfer({ to: sender, value: senderAmount });

        // Log the cancellation.
        emit IVestingLockup.CancelLockupSchedule(
            scheduleId,
            sender,
            recipient,
            senderAmount,
            recipientAmount
        );

        // Emits an ERC-4906 event to trigger an update of the NFT metadata.
        emit MetadataUpdate({ _tokenId: scheduleId });
    }

    /**
     * @dev Creates a new schedule.
     * @param params Parameters for creating the schedule.
     * @return scheduleId The ID of the created schedule.
     */
    function _createSchedule(
        Lockup.CreateSchedule memory params
    ) internal returns (uint256 scheduleId) {
        // Checks: validate the user-provided parameters.
        Helpers.checkCreateSchedule(
            params.totalAmount,
            params.segments,
            MAX_SEGMENT_COUNT,
            params.startTime
        );

        // Load the schedule id in a variable.
        scheduleId = nextScheduleId;

        // Effects: create the schedule.
        Lockup.Schedule storage schedule = _schedules[scheduleId];
        schedule.amounts.deposited = params.totalAmount;
        schedule.isCancelable = params.cancelable;
        schedule.isTransferable = params.transferable;
        schedule.isSchedule = true;
        schedule.sender = params.sender;

        unchecked {
            // The segment count cannot be zero at this point.
            uint256 segmentCount = params.segments.length;
            schedule.endTime = params.segments[segmentCount - 1].milestone;
            schedule.startTime = params.startTime;

            for (uint256 i; i < segmentCount; ) {
                schedule.segments.push(params.segments[i]);

                ++i;
            }

            // Effects: bump the next schedule id.
            nextScheduleId++;
        }

        // Effects: mint the NFT to the recipient.
        _safeMint({ to: params.recipient, tokenId: scheduleId });

        // Interactions: transfer the deposit.
        unchecked {
            UNCN.safeTransferFrom({
                from: msg.sender,
                to: address(this),
                value: params.totalAmount
            });
        }

        // Log the newly created schedule.
        emit IUnseenVesting.CreateSchedule({
            scheduleId: scheduleId,
            funder: msg.sender,
            sender: params.sender,
            recipient: params.recipient,
            amounts: params.totalAmount,
            cancelable: params.cancelable,
            transferable: params.transferable,
            segments: params.segments,
            range: Lockup.Range({
                start: schedule.startTime,
                end: schedule.endTime
            })
        });
    }

    /**
     * @dev Renounces a schedule by making it not cancelable.
     * @param scheduleId The ID of the schedule to renounce.
     */
    function _renounce(uint256 scheduleId) internal override {
        // Checks: the schedule is cancelable.
        if (!_schedules[scheduleId].isCancelable) {
            revert Errors.ScheduleNotCancelable(scheduleId);
        }

        // Effects: renounce the schedule by making it not cancelable.
        _schedules[scheduleId].isCancelable = false;
    }

    /**
     * @dev Withdraws funds from a schedule.
     * @param scheduleId The ID of the schedule to withdraw from.
     * @param to The address to withdraw to.
     * @param amount The amount to withdraw.
     */
    function _withdraw(
        uint256 scheduleId,
        address to,
        uint128 amount
    ) internal override {
        // Effects: update the withdrawn amount.
        _schedules[scheduleId].amounts.withdrawn =
            _schedules[scheduleId].amounts.withdrawn +
            amount;

        // Retrieve the amounts from storage.
        Lockup.Amounts memory amounts = _schedules[scheduleId].amounts;

        // Using ">=" instead of "==" for additional safety reasons. In the event of an unforeseen increase in the
        // withdrawn amount, the schedule will still be marked as depleted.
        if (amounts.withdrawn >= amounts.deposited - amounts.refunded) {
            // Effects: mark the schedule as depleted.
            _schedules[scheduleId].isDepleted = true;

            // Effects: make the schedule not cancelable anymore, because a depleted schedule cannot be canceled.
            _schedules[scheduleId].isCancelable = false;
        }

        // Interactions: perform the UNCN {ERC-20} transfer.
        UNCN.safeTransfer({ to: to, value: amount });

        // Log the withdrawal.
        emit IVestingLockup.WithdrawFromLockupSchedule(scheduleId, to, amount);
    }
}

/*

$$\   $$\                                                   
$$ |  $$ |                                                  
$$ |  $$ |$$$$$$$\   $$$$$$$\  $$$$$$\   $$$$$$\  $$$$$$$\  
$$ |  $$ |$$  __$$\ $$  _____|$$  __$$\ $$  __$$\ $$  __$$\ 
$$ |  $$ |$$ |  $$ |\$$$$$$\  $$$$$$$$ |$$$$$$$$ |$$ |  $$ |
$$ |  $$ |$$ |  $$ | \____$$\ $$   ____|$$   ____|$$ |  $$ |
\$$$$$$  |$$ |  $$ |$$$$$$$  |\$$$$$$$\ \$$$$$$$\ $$ |  $$ |
 \______/ \__|  \__|\_______/  \_______| \_______|\__|  \__|   

*/

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;

/**
 * @dev Standard ERC20 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens.
 */
interface IERC20Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC20InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC20InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     * @param allowance Amount of tokens a `spender` is allowed to operate with.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC20InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `spender` to be approved. Used in approvals.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC20InvalidSpender(address spender);
}

/**
 * @dev Standard ERC721 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens.
 */
interface IERC721Errors {
    /**
     * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-20.
     * Used in balance queries.
     * @param owner Address of the current owner of a token.
     */
    error ERC721InvalidOwner(address owner);

    /**
     * @dev Indicates a `tokenId` whose `owner` is the zero address.
     * @param tokenId Identifier number of a token.
     */
    error ERC721NonexistentToken(uint256 tokenId);

    /**
     * @dev Indicates an error related to the ownership over a particular token. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param tokenId Identifier number of a token.
     * @param owner Address of the current owner of a token.
     */
    error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC721InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC721InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param tokenId Identifier number of a token.
     */
    error ERC721InsufficientApproval(address operator, uint256 tokenId);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC721InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC721InvalidOperator(address operator);
}

/**
 * @dev Standard ERC1155 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 tokens.
 */
interface IERC1155Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     * @param tokenId Identifier number of a token.
     */
    error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC1155InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC1155InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param owner Address of the current owner of a token.
     */
    error ERC1155MissingApprovalForAll(address operator, address owner);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC1155InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC1155InvalidOperator(address operator);

    /**
     * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
     * Used in batch transfers.
     * @param idsLength Length of the array of token identifiers
     * @param valuesLength Length of the array of token amounts
     */
    error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)

pragma solidity ^0.8.20;

import {IERC165} from "../utils/introspection/IERC165.sol";

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC4906.sol)

pragma solidity ^0.8.20;

import {IERC165} from "./IERC165.sol";
import {IERC721} from "./IERC721.sol";

/// @title EIP-721 Metadata Update Extension
interface IERC4906 is IERC165, IERC721 {
    /// @dev This event emits when the metadata of a token is changed.
    /// So that the third-party platforms such as NFT market could
    /// timely update the images and related attributes of the NFT.
    event MetadataUpdate(uint256 _tokenId);

    /// @dev This event emits when the metadata of a range of tokens is changed.
    /// So that the third-party platforms such as NFT market could
    /// timely update the images and related attributes of the NFTs.
    event BatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC721.sol)

pragma solidity ^0.8.20;

import {IERC721} from "../token/ERC721/IERC721.sol";

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)

pragma solidity ^0.8.20;

/**
 * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
 * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
 *
 * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
 * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
 * need to send a transaction, and thus is not required to hold Ether at all.
 *
 * ==== Security Considerations
 *
 * There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
 * expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
 * considered as an intention to spend the allowance in any specific way. The second is that because permits have
 * built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
 * take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
 * generally recommended is:
 *
 * ```solidity
 * function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
 *     try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
 *     doThing(..., value);
 * }
 *
 * function doThing(..., uint256 value) public {
 *     token.safeTransferFrom(msg.sender, address(this), value);
 *     ...
 * }
 * ```
 *
 * Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
 * `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
 * {SafeERC20-safeTransferFrom}).
 *
 * Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
 * contracts should have entry points that don't rely on permit.
 */
interface IERC20Permit {
    /**
     * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
     * given ``owner``'s signed approval.
     *
     * IMPORTANT: The same issues {IERC20-approve} has related to transaction
     * ordering also apply here.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     * - `deadline` must be a timestamp in the future.
     * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
     * over the EIP712-formatted function arguments.
     * - the signature must use ``owner``'s current nonce (see {nonces}).
     *
     * For more information on the signature format, see the
     * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
     * section].
     *
     * CAUTION: See Security Considerations above.
     */
    function permit(
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) external;

    /**
     * @dev Returns the current nonce for `owner`. This value must be
     * included whenever a signature is generated for {permit}.
     *
     * Every successful call to {permit} increases ``owner``'s nonce by one. This
     * prevents a signature from being used multiple times.
     */
    function nonces(address owner) external view returns (uint256);

    /**
     * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
     */
    // solhint-disable-next-line func-name-mixedcase
    function DOMAIN_SEPARATOR() external view returns (bytes32);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)

pragma solidity ^0.8.20;

/**
 * @dev Interface of the ERC20 standard as defined in the EIP.
 */
interface IERC20 {
    /**
     * @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);

    /**
     * @dev Returns the value of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)

pragma solidity ^0.8.20;

import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";

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

    /**
     * @dev An operation with an ERC20 token failed.
     */
    error SafeERC20FailedOperation(address token);

    /**
     * @dev Indicates a failed `decreaseAllowance` request.
     */
    error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);

    /**
     * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
     * non-reverting calls are assumed to be successful.
     */
    function safeTransfer(IERC20 token, address to, uint256 value) internal {
        _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
    }

    /**
     * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
     * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
     */
    function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
        _callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
    }

    /**
     * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful.
     */
    function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
        uint256 oldAllowance = token.allowance(address(this), spender);
        forceApprove(token, spender, oldAllowance + value);
    }

    /**
     * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
     * value, non-reverting calls are assumed to be successful.
     */
    function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
        unchecked {
            uint256 currentAllowance = token.allowance(address(this), spender);
            if (currentAllowance < requestedDecrease) {
                revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
            }
            forceApprove(token, spender, currentAllowance - requestedDecrease);
        }
    }

    /**
     * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
     * to be set to zero before setting it to a non-zero value, such as USDT.
     */
    function forceApprove(IERC20 token, address spender, uint256 value) internal {
        bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));

        if (!_callOptionalReturnBool(token, approvalCall)) {
            _callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
            _callOptionalReturn(token, approvalCall);
        }
    }

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

        bytes memory returndata = address(token).functionCall(data);
        if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     *
     * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
     */
    function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
        // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
        // we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
        // and not revert is the subcall reverts.

        (bool success, bytes memory returndata) = address(token).call(data);
        return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/ERC721.sol)

pragma solidity ^0.8.20;

import {IERC721} from "./IERC721.sol";
import {IERC721Receiver} from "./IERC721Receiver.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.sol";

/**
 * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
 * the Metadata extension, but not including the Enumerable extension, which is available separately as
 * {ERC721Enumerable}.
 */
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
    using Strings for uint256;

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

    mapping(uint256 tokenId => address) private _owners;

    mapping(address owner => uint256) private _balances;

    mapping(uint256 tokenId => address) private _tokenApprovals;

    mapping(address owner => mapping(address operator => bool)) private _operatorApprovals;

    /**
     * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
        return
            interfaceId == type(IERC721).interfaceId ||
            interfaceId == type(IERC721Metadata).interfaceId ||
            super.supportsInterface(interfaceId);
    }

    /**
     * @dev See {IERC721-balanceOf}.
     */
    function balanceOf(address owner) public view virtual returns (uint256) {
        if (owner == address(0)) {
            revert ERC721InvalidOwner(address(0));
        }
        return _balances[owner];
    }

    /**
     * @dev See {IERC721-ownerOf}.
     */
    function ownerOf(uint256 tokenId) public view virtual returns (address) {
        return _requireOwned(tokenId);
    }

    /**
     * @dev See {IERC721Metadata-name}.
     */
    function name() public view virtual returns (string memory) {
        return _name;
    }

    /**
     * @dev See {IERC721Metadata-symbol}.
     */
    function symbol() public view virtual returns (string memory) {
        return _symbol;
    }

    /**
     * @dev See {IERC721Metadata-tokenURI}.
     */
    function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
        _requireOwned(tokenId);

        string memory baseURI = _baseURI();
        return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenId.toString()) : "";
    }

    /**
     * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
     * token will be the concatenation of the `baseURI` and the `tokenId`. Empty
     * by default, can be overridden in child contracts.
     */
    function _baseURI() internal view virtual returns (string memory) {
        return "";
    }

    /**
     * @dev See {IERC721-approve}.
     */
    function approve(address to, uint256 tokenId) public virtual {
        _approve(to, tokenId, _msgSender());
    }

    /**
     * @dev See {IERC721-getApproved}.
     */
    function getApproved(uint256 tokenId) public view virtual returns (address) {
        _requireOwned(tokenId);

        return _getApproved(tokenId);
    }

    /**
     * @dev See {IERC721-setApprovalForAll}.
     */
    function setApprovalForAll(address operator, bool approved) public virtual {
        _setApprovalForAll(_msgSender(), operator, approved);
    }

    /**
     * @dev See {IERC721-isApprovedForAll}.
     */
    function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
        return _operatorApprovals[owner][operator];
    }

    /**
     * @dev See {IERC721-transferFrom}.
     */
    function transferFrom(address from, address to, uint256 tokenId) public virtual {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        // Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
        // (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
        address previousOwner = _update(to, tokenId, _msgSender());
        if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId) public {
        safeTransferFrom(from, to, tokenId, "");
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
        transferFrom(from, to, tokenId);
        _checkOnERC721Received(from, to, tokenId, data);
    }

    /**
     * @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
     *
     * IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
     * core ERC721 logic MUST be matched with the use of {_increaseBalance} to keep balances
     * consistent with ownership. The invariant to preserve is that for any address `a` the value returned by
     * `balanceOf(a)` must be equal to the number of tokens such that `_ownerOf(tokenId)` is `a`.
     */
    function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
        return _owners[tokenId];
    }

    /**
     * @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
     */
    function _getApproved(uint256 tokenId) internal view virtual returns (address) {
        return _tokenApprovals[tokenId];
    }

    /**
     * @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
     * particular (ignoring whether it is owned by `owner`).
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
        return
            spender != address(0) &&
            (owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
    }

    /**
     * @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
     * Reverts if `spender` does not have approval from the provided `owner` for the given token or for all its assets
     * the `spender` for the specific `tokenId`.
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
        if (!_isAuthorized(owner, spender, tokenId)) {
            if (owner == address(0)) {
                revert ERC721NonexistentToken(tokenId);
            } else {
                revert ERC721InsufficientApproval(spender, tokenId);
            }
        }
    }

    /**
     * @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
     *
     * NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
     * a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
     *
     * WARNING: Increasing an account's balance using this function tends to be paired with an override of the
     * {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
     * remain consistent with one another.
     */
    function _increaseBalance(address account, uint128 value) internal virtual {
        unchecked {
            _balances[account] += value;
        }
    }

    /**
     * @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
     * (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that
     * `auth` is either the owner of the token, or approved to operate on the token (by the owner).
     *
     * Emits a {Transfer} event.
     *
     * NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
     */
    function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
        address from = _ownerOf(tokenId);

        // Perform (optional) operator check
        if (auth != address(0)) {
            _checkAuthorized(from, auth, tokenId);
        }

        // Execute the update
        if (from != address(0)) {
            // Clear approval. No need to re-authorize or emit the Approval event
            _approve(address(0), tokenId, address(0), false);

            unchecked {
                _balances[from] -= 1;
            }
        }

        if (to != address(0)) {
            unchecked {
                _balances[to] += 1;
            }
        }

        _owners[tokenId] = to;

        emit Transfer(from, to, tokenId);

        return from;
    }

    /**
     * @dev Mints `tokenId` and transfers it to `to`.
     *
     * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - `to` cannot be the zero address.
     *
     * Emits a {Transfer} event.
     */
    function _mint(address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner != address(0)) {
            revert ERC721InvalidSender(address(0));
        }
    }

    /**
     * @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeMint(address to, uint256 tokenId) internal {
        _safeMint(to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
        _mint(to, tokenId);
        _checkOnERC721Received(address(0), to, tokenId, data);
    }

    /**
     * @dev Destroys `tokenId`.
     * The approval is cleared when the token is burned.
     * This is an internal function that does not check if the sender is authorized to operate on the token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     *
     * Emits a {Transfer} event.
     */
    function _burn(uint256 tokenId) internal {
        address previousOwner = _update(address(0), tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
    }

    /**
     * @dev Transfers `tokenId` from `from` to `to`.
     *  As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     *
     * Emits a {Transfer} event.
     */
    function _transfer(address from, address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        } else if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
     * are aware of the ERC721 standard to prevent tokens from being forever locked.
     *
     * `data` is additional data, it has no specified format and it is sent in call to `to`.
     *
     * This internal function is like {safeTransferFrom} in the sense that it invokes
     * {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
     * implement alternative mechanisms to perform token transfer, such as signature-based.
     *
     * Requirements:
     *
     * - `tokenId` token must exist and be owned by `from`.
     * - `to` cannot be the zero address.
     * - `from` cannot be the zero address.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeTransfer(address from, address to, uint256 tokenId) internal {
        _safeTransfer(from, to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
        _transfer(from, to, tokenId);
        _checkOnERC721Received(from, to, tokenId, data);
    }

    /**
     * @dev Approve `to` to operate on `tokenId`
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
     * either the owner of the token, or approved to operate on all tokens held by this owner.
     *
     * Emits an {Approval} event.
     *
     * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
     */
    function _approve(address to, uint256 tokenId, address auth) internal {
        _approve(to, tokenId, auth, true);
    }

    /**
     * @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
     * emitted in the context of transfers.
     */
    function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
        // Avoid reading the owner unless necessary
        if (emitEvent || auth != address(0)) {
            address owner = _requireOwned(tokenId);

            // We do not use _isAuthorized because single-token approvals should not be able to call approve
            if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
                revert ERC721InvalidApprover(auth);
            }

            if (emitEvent) {
                emit Approval(owner, to, tokenId);
            }
        }

        _tokenApprovals[tokenId] = to;
    }

    /**
     * @dev Approve `operator` to operate on all of `owner` tokens
     *
     * Requirements:
     * - operator can't be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
        if (operator == address(0)) {
            revert ERC721InvalidOperator(operator);
        }
        _operatorApprovals[owner][operator] = approved;
        emit ApprovalForAll(owner, operator, approved);
    }

    /**
     * @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
     * Returns the owner.
     *
     * Overrides to ownership logic should be done to {_ownerOf}.
     */
    function _requireOwned(uint256 tokenId) internal view returns (address) {
        address owner = _ownerOf(tokenId);
        if (owner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
        return owner;
    }

    /**
     * @dev Private function to invoke {IERC721Receiver-onERC721Received} on a target address. This will revert if the
     * recipient doesn't accept the token transfer. The call is not executed if the target address is not a contract.
     *
     * @param from address representing the previous owner of the given token ID
     * @param to target address that will receive the tokens
     * @param tokenId uint256 ID of the token to be transferred
     * @param data bytes optional data to send along with the call
     */
    function _checkOnERC721Received(address from, address to, uint256 tokenId, bytes memory data) private {
        if (to.code.length > 0) {
            try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
                if (retval != IERC721Receiver.onERC721Received.selector) {
                    revert ERC721InvalidReceiver(to);
                }
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    revert ERC721InvalidReceiver(to);
                } else {
                    /// @solidity memory-safe-assembly
                    assembly {
                        revert(add(32, reason), mload(reason))
                    }
                }
            }
        }
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Metadata.sol)

pragma solidity ^0.8.20;

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

/**
 * @title ERC-721 Non-Fungible Token Standard, optional metadata extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721Metadata is IERC721 {
    /**
     * @dev Returns the token collection name.
     */
    function name() external view returns (string memory);

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

    /**
     * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
     */
    function tokenURI(uint256 tokenId) external view returns (string memory);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721.sol)

pragma solidity ^0.8.20;

import {IERC165} from "../../utils/introspection/IERC165.sol";

/**
 * @dev Required interface of an ERC721 compliant contract.
 */
interface IERC721 is IERC165 {
    /**
     * @dev Emitted when `tokenId` token is transferred from `from` to `to`.
     */
    event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
     */
    event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
     */
    event ApprovalForAll(address indexed owner, address indexed operator, bool approved);

    /**
     * @dev Returns the number of tokens in ``owner``'s account.
     */
    function balanceOf(address owner) external view returns (uint256 balance);

    /**
     * @dev Returns the owner of the `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function ownerOf(uint256 tokenId) external view returns (address owner);

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
     * are aware of the ERC721 protocol to prevent tokens from being forever locked.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
     *   {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Transfers `tokenId` token from `from` to `to`.
     *
     * WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
     * or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
     * understand this adds an external call which potentially creates a reentrancy vulnerability.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Gives permission to `to` to transfer `tokenId` token to another account.
     * The approval is cleared when the token is transferred.
     *
     * Only a single account can be approved at a time, so approving the zero address clears previous approvals.
     *
     * Requirements:
     *
     * - The caller must own the token or be an approved operator.
     * - `tokenId` must exist.
     *
     * Emits an {Approval} event.
     */
    function approve(address to, uint256 tokenId) external;

    /**
     * @dev Approve or remove `operator` as an operator for the caller.
     * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
     *
     * Requirements:
     *
     * - The `operator` cannot be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function setApprovalForAll(address operator, bool approved) external;

    /**
     * @dev Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId) external view returns (address operator);

    /**
     * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
     *
     * See {setApprovalForAll}
     */
    function isApprovedForAll(address owner, address operator) external view returns (bool);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721Receiver.sol)

pragma solidity ^0.8.20;

/**
 * @title ERC721 token receiver interface
 * @dev Interface for any contract that wants to support safeTransfers
 * from ERC721 asset contracts.
 */
interface IERC721Receiver {
    /**
     * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
     * by `operator` from `from`, this function is called.
     *
     * It must return its Solidity selector to confirm the token transfer.
     * If any other value is returned or the interface is not implemented by the recipient, the transfer will be
     * reverted.
     *
     * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)

pragma solidity ^0.8.20;

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev The ETH balance of the account is not enough to perform the operation.
     */
    error AddressInsufficientBalance(address account);

    /**
     * @dev There's no code at `target` (it is not a contract).
     */
    error AddressEmptyCode(address target);

    /**
     * @dev A call to an address target failed. The target may have reverted.
     */
    error FailedInnerCall();

    /**
     * @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://consensys.net/diligence/blog/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.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
     */
    function sendValue(address payable recipient, uint256 amount) internal {
        if (address(this).balance < amount) {
            revert AddressInsufficientBalance(address(this));
        }

        (bool success, ) = recipient.call{value: amount}("");
        if (!success) {
            revert FailedInnerCall();
        }
    }

    /**
     * @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 or custom error, it is bubbled
     * up by this function (like regular Solidity function calls). However, if
     * the call reverted with no returned reason, this function reverts with a
     * {FailedInnerCall} error.
     *
     * 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.
     */
    function functionCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0);
    }

    /**
     * @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`.
     */
    function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
        if (address(this).balance < value) {
            revert AddressInsufficientBalance(address(this));
        }
        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a static call.
     */
    function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
        (bool success, bytes memory returndata) = target.staticcall(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a delegate call.
     */
    function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
        (bool success, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
     * was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an
     * unsuccessful call.
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata
    ) internal view returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            // only check if target is a contract if the call was successful and the return data is empty
            // otherwise we already know that it was a contract
            if (returndata.length == 0 && target.code.length == 0) {
                revert AddressEmptyCode(target);
            }
            return returndata;
        }
    }

    /**
     * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
     * revert reason or with a default {FailedInnerCall} error.
     */
    function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            return returndata;
        }
    }

    /**
     * @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
     */
    function _revert(bytes memory returndata) private pure {
        // 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
            /// @solidity memory-safe-assembly
            assembly {
                let returndata_size := mload(returndata)
                revert(add(32, returndata), returndata_size)
            }
        } else {
            revert FailedInnerCall();
        }
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)

pragma solidity ^0.8.20;

/**
 * @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 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) {
        return msg.sender;
    }

    function _msgData() internal view virtual returns (bytes calldata) {
        return msg.data;
    }

    function _contextSuffixLength() internal view virtual returns (uint256) {
        return 0;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/ERC165.sol)

pragma solidity ^0.8.20;

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

/**
 * @dev Implementation of the {IERC165} interface.
 *
 * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
 * for the additional interface id that will be supported. For example:
 *
 * ```solidity
 * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
 *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
 * }
 * ```
 */
abstract contract ERC165 is IERC165 {
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
        return interfaceId == type(IERC165).interfaceId;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)

pragma solidity ^0.8.20;

/**
 * @dev Interface of the ERC165 standard, as defined in the
 * https://eips.ethereum.org/EIPS/eip-165[EIP].
 *
 * Implementers can declare support of contract interfaces, which can then be
 * queried by others ({ERC165Checker}).
 *
 * For an implementation, see {ERC165}.
 */
interface IERC165 {
    /**
     * @dev Returns true if this contract implements the interface defined by
     * `interfaceId`. See the corresponding
     * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30 000 gas.
     */
    function supportsInterface(bytes4 interfaceId) external view returns (bool);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/Math.sol)

pragma solidity ^0.8.20;

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library Math {
    /**
     * @dev Muldiv operation overflow.
     */
    error MathOverflowedMulDiv();

    enum Rounding {
        Floor, // Toward negative infinity
        Ceil, // Toward positive infinity
        Trunc, // Toward zero
        Expand // Away from zero
    }

    /**
     * @dev Returns the addition of two unsigned integers, with an overflow flag.
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            uint256 c = a + b;
            if (c < a) return (false, 0);
            return (true, c);
        }
    }

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

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

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

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

    /**
     * @dev Returns the largest of two numbers.
     */
    function max(uint256 a, uint256 b) internal pure returns (uint256) {
        return a > b ? a : b;
    }

    /**
     * @dev Returns the smallest of two numbers.
     */
    function min(uint256 a, uint256 b) internal pure returns (uint256) {
        return a < b ? a : b;
    }

    /**
     * @dev Returns the average of two numbers. The result is rounded towards
     * zero.
     */
    function average(uint256 a, uint256 b) internal pure returns (uint256) {
        // (a + b) / 2 can overflow.
        return (a & b) + (a ^ b) / 2;
    }

    /**
     * @dev Returns the ceiling of the division of two numbers.
     *
     * This differs from standard division with `/` in that it rounds towards infinity instead
     * of rounding towards zero.
     */
    function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
        if (b == 0) {
            // Guarantee the same behavior as in a regular Solidity division.
            return a / b;
        }

        // (a + b - 1) / b can overflow on addition, so we distribute.
        return a == 0 ? 0 : (a - 1) / b + 1;
    }

    /**
     * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
     * denominator == 0.
     * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
     * Uniswap Labs also under MIT license.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
        unchecked {
            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
            // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
            // variables such that product = prod1 * 2^256 + prod0.
            uint256 prod0 = x * y; // Least significant 256 bits of the product
            uint256 prod1; // Most significant 256 bits of the product
            assembly {
                let mm := mulmod(x, y, not(0))
                prod1 := sub(sub(mm, prod0), lt(mm, prod0))
            }

            // Handle non-overflow cases, 256 by 256 division.
            if (prod1 == 0) {
                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
                // The surrounding unchecked block does not change this fact.
                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
                return prod0 / denominator;
            }

            // Make sure the result is less than 2^256. Also prevents denominator == 0.
            if (denominator <= prod1) {
                revert MathOverflowedMulDiv();
            }

            ///////////////////////////////////////////////
            // 512 by 256 division.
            ///////////////////////////////////////////////

            // Make division exact by subtracting the remainder from [prod1 prod0].
            uint256 remainder;
            assembly {
                // Compute remainder using mulmod.
                remainder := mulmod(x, y, denominator)

                // Subtract 256 bit number from 512 bit number.
                prod1 := sub(prod1, gt(remainder, prod0))
                prod0 := sub(prod0, remainder)
            }

            // Factor powers of two out of denominator and compute largest power of two divisor of denominator.
            // Always >= 1. See https://cs.stackexchange.com/q/138556/92363.

            uint256 twos = denominator & (0 - denominator);
            assembly {
                // Divide denominator by twos.
                denominator := div(denominator, twos)

                // Divide [prod1 prod0] by twos.
                prod0 := div(prod0, twos)

                // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
                twos := add(div(sub(0, twos), twos), 1)
            }

            // Shift in bits from prod1 into prod0.
            prod0 |= prod1 * twos;

            // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
            // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
            // four bits. That is, denominator * inv = 1 mod 2^4.
            uint256 inverse = (3 * denominator) ^ 2;

            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
            // works in modular arithmetic, doubling the correct bits in each step.
            inverse *= 2 - denominator * inverse; // inverse mod 2^8
            inverse *= 2 - denominator * inverse; // inverse mod 2^16
            inverse *= 2 - denominator * inverse; // inverse mod 2^32
            inverse *= 2 - denominator * inverse; // inverse mod 2^64
            inverse *= 2 - denominator * inverse; // inverse mod 2^128
            inverse *= 2 - denominator * inverse; // inverse mod 2^256

            // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
            // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
            // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
            // is no longer required.
            result = prod0 * inverse;
            return result;
        }
    }

    /**
     * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
        uint256 result = mulDiv(x, y, denominator);
        if (unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0) {
            result += 1;
        }
        return result;
    }

    /**
     * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
     * towards zero.
     *
     * Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
     */
    function sqrt(uint256 a) internal pure returns (uint256) {
        if (a == 0) {
            return 0;
        }

        // For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
        //
        // We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
        // `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
        //
        // This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
        // → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
        // → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
        //
        // Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
        uint256 result = 1 << (log2(a) >> 1);

        // At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
        // since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
        // every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
        // into the expected uint128 result.
        unchecked {
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            return min(result, a / result);
        }
    }

    /**
     * @notice Calculates sqrt(a), following the selected rounding direction.
     */
    function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = sqrt(a);
            return result + (unsignedRoundsUp(rounding) && result * result < a ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 2 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log2(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >> 128 > 0) {
                value >>= 128;
                result += 128;
            }
            if (value >> 64 > 0) {
                value >>= 64;
                result += 64;
            }
            if (value >> 32 > 0) {
                value >>= 32;
                result += 32;
            }
            if (value >> 16 > 0) {
                value >>= 16;
                result += 16;
            }
            if (value >> 8 > 0) {
                value >>= 8;
                result += 8;
            }
            if (value >> 4 > 0) {
                value >>= 4;
                result += 4;
            }
            if (value >> 2 > 0) {
                value >>= 2;
                result += 2;
            }
            if (value >> 1 > 0) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 2, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log2(value);
            return result + (unsignedRoundsUp(rounding) && 1 << result < value ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 10 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log10(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >= 10 ** 64) {
                value /= 10 ** 64;
                result += 64;
            }
            if (value >= 10 ** 32) {
                value /= 10 ** 32;
                result += 32;
            }
            if (value >= 10 ** 16) {
                value /= 10 ** 16;
                result += 16;
            }
            if (value >= 10 ** 8) {
                value /= 10 ** 8;
                result += 8;
            }
            if (value >= 10 ** 4) {
                value /= 10 ** 4;
                result += 4;
            }
            if (value >= 10 ** 2) {
                value /= 10 ** 2;
                result += 2;
            }
            if (value >= 10 ** 1) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 10, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log10(value);
            return result + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 256 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     *
     * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
     */
    function log256(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >> 128 > 0) {
                value >>= 128;
                result += 16;
            }
            if (value >> 64 > 0) {
                value >>= 64;
                result += 8;
            }
            if (value >> 32 > 0) {
                value >>= 32;
                result += 4;
            }
            if (value >> 16 > 0) {
                value >>= 16;
                result += 2;
            }
            if (value >> 8 > 0) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 256, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log256(value);
            return result + (unsignedRoundsUp(rounding) && 1 << (result << 3) < value ? 1 : 0);
        }
    }

    /**
     * @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
     */
    function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
        return uint8(rounding) % 2 == 1;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/SignedMath.sol)

pragma solidity ^0.8.20;

/**
 * @dev Standard signed math utilities missing in the Solidity language.
 */
library SignedMath {
    /**
     * @dev Returns the largest of two signed numbers.
     */
    function max(int256 a, int256 b) internal pure returns (int256) {
        return a > b ? a : b;
    }

    /**
     * @dev Returns the smallest of two signed numbers.
     */
    function min(int256 a, int256 b) internal pure returns (int256) {
        return a < b ? a : b;
    }

    /**
     * @dev Returns the average of two signed numbers without overflow.
     * The result is rounded towards zero.
     */
    function average(int256 a, int256 b) internal pure returns (int256) {
        // Formula from the book "Hacker's Delight"
        int256 x = (a & b) + ((a ^ b) >> 1);
        return x + (int256(uint256(x) >> 255) & (a ^ b));
    }

    /**
     * @dev Returns the absolute unsigned value of a signed value.
     */
    function abs(int256 n) internal pure returns (uint256) {
        unchecked {
            // must be unchecked in order to support `n = type(int256).min`
            return uint256(n >= 0 ? n : -n);
        }
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Strings.sol)

pragma solidity ^0.8.20;

import {Math} from "./math/Math.sol";
import {SignedMath} from "./math/SignedMath.sol";

/**
 * @dev String operations.
 */
library Strings {
    bytes16 private constant HEX_DIGITS = "0123456789abcdef";
    uint8 private constant ADDRESS_LENGTH = 20;

    /**
     * @dev The `value` string doesn't fit in the specified `length`.
     */
    error StringsInsufficientHexLength(uint256 value, uint256 length);

    /**
     * @dev Converts a `uint256` to its ASCII `string` decimal representation.
     */
    function toString(uint256 value) internal pure returns (string memory) {
        unchecked {
            uint256 length = Math.log10(value) + 1;
            string memory buffer = new string(length);
            uint256 ptr;
            /// @solidity memory-safe-assembly
            assembly {
                ptr := add(buffer, add(32, length))
            }
            while (true) {
                ptr--;
                /// @solidity memory-safe-assembly
                assembly {
                    mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
                }
                value /= 10;
                if (value == 0) break;
            }
            return buffer;
        }
    }

    /**
     * @dev Converts a `int256` to its ASCII `string` decimal representation.
     */
    function toStringSigned(int256 value) internal pure returns (string memory) {
        return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) internal pure returns (string memory) {
        unchecked {
            return toHexString(value, Math.log256(value) + 1);
        }
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
     */
    function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
        uint256 localValue = value;
        bytes memory buffer = new bytes(2 * length + 2);
        buffer[0] = "0";
        buffer[1] = "x";
        for (uint256 i = 2 * length + 1; i > 1; --i) {
            buffer[i] = HEX_DIGITS[localValue & 0xf];
            localValue >>= 4;
        }
        if (localValue != 0) {
            revert StringsInsufficientHexLength(value, length);
        }
        return string(buffer);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
     * representation.
     */
    function toHexString(address addr) internal pure returns (string memory) {
        return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
    }

    /**
     * @dev Returns true if the two strings are equal.
     */
    function equal(string memory a, string memory b) internal pure returns (bool) {
        return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { uMAX_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { uMAX_UD2x18 } from "../ud2x18/Constants.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";

/// @notice Thrown when trying to cast a uint128 that doesn't fit in SD1x18.
error PRBMath_IntoSD1x18_Overflow(uint128 x);

/// @notice Thrown when trying to cast a uint128 that doesn't fit in UD2x18.
error PRBMath_IntoUD2x18_Overflow(uint128 x);

/// @title PRBMathCastingUint128
/// @notice Casting utilities for uint128.
library PRBMathCastingUint128 {
    /// @notice Casts a uint128 number to SD1x18.
    /// @dev Requirements:
    /// - x must be less than or equal to `MAX_SD1x18`.
    function intoSD1x18(uint128 x) internal pure returns (SD1x18 result) {
        if (x > uint256(int256(uMAX_SD1x18))) {
            revert PRBMath_IntoSD1x18_Overflow(x);
        }
        result = SD1x18.wrap(int64(uint64(x)));
    }

    /// @notice Casts a uint128 number to SD59x18.
    /// @dev There is no overflow check because the domain of uint128 is a subset of SD59x18.
    function intoSD59x18(uint128 x) internal pure returns (SD59x18 result) {
        result = SD59x18.wrap(int256(uint256(x)));
    }

    /// @notice Casts a uint128 number to UD2x18.
    /// @dev Requirements:
    /// - x must be less than or equal to `MAX_SD1x18`.
    function intoUD2x18(uint128 x) internal pure returns (UD2x18 result) {
        if (x > uint64(uMAX_UD2x18)) {
            revert PRBMath_IntoUD2x18_Overflow(x);
        }
        result = UD2x18.wrap(uint64(x));
    }

    /// @notice Casts a uint128 number to UD60x18.
    /// @dev There is no overflow check because the domain of uint128 is a subset of UD60x18.
    function intoUD60x18(uint128 x) internal pure returns (UD60x18 result) {
        result = UD60x18.wrap(uint256(x));
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { SD1x18 } from "../sd1x18/ValueType.sol";
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";

/// @title PRBMathCastingUint40
/// @notice Casting utilities for uint40.
library PRBMathCastingUint40 {
    /// @notice Casts a uint40 number into SD1x18.
    /// @dev There is no overflow check because the domain of uint40 is a subset of SD1x18.
    function intoSD1x18(uint40 x) internal pure returns (SD1x18 result) {
        result = SD1x18.wrap(int64(uint64(x)));
    }

    /// @notice Casts a uint40 number into SD59x18.
    /// @dev There is no overflow check because the domain of uint40 is a subset of SD59x18.
    function intoSD59x18(uint40 x) internal pure returns (SD59x18 result) {
        result = SD59x18.wrap(int256(uint256(x)));
    }

    /// @notice Casts a uint40 number into UD2x18.
    /// @dev There is no overflow check because the domain of uint40 is a subset of UD2x18.
    function intoUD2x18(uint40 x) internal pure returns (UD2x18 result) {
        result = UD2x18.wrap(uint64(x));
    }

    /// @notice Casts a uint40 number into UD60x18.
    /// @dev There is no overflow check because the domain of uint40 is a subset of UD60x18.
    function intoUD60x18(uint40 x) internal pure returns (UD60x18 result) {
        result = UD60x18.wrap(uint256(x));
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

// Common.sol
//
// Common mathematical functions used in both SD59x18 and UD60x18. Note that these global functions do not
// always operate with SD59x18 and UD60x18 numbers.

/*//////////////////////////////////////////////////////////////////////////
                                CUSTOM ERRORS
//////////////////////////////////////////////////////////////////////////*/

/// @notice Thrown when the resultant value in {mulDiv} overflows uint256.
error PRBMath_MulDiv_Overflow(uint256 x, uint256 y, uint256 denominator);

/// @notice Thrown when the resultant value in {mulDiv18} overflows uint256.
error PRBMath_MulDiv18_Overflow(uint256 x, uint256 y);

/// @notice Thrown when one of the inputs passed to {mulDivSigned} is `type(int256).min`.
error PRBMath_MulDivSigned_InputTooSmall();

/// @notice Thrown when the resultant value in {mulDivSigned} overflows int256.
error PRBMath_MulDivSigned_Overflow(int256 x, int256 y);

/*//////////////////////////////////////////////////////////////////////////
                                    CONSTANTS
//////////////////////////////////////////////////////////////////////////*/

/// @dev The maximum value a uint128 number can have.
uint128 constant MAX_UINT128 = type(uint128).max;

/// @dev The maximum value a uint40 number can have.
uint40 constant MAX_UINT40 = type(uint40).max;

/// @dev The unit number, which the decimal precision of the fixed-point types.
uint256 constant UNIT = 1e18;

/// @dev The unit number inverted mod 2^256.
uint256 constant UNIT_INVERSE = 78156646155174841979727994598816262306175212592076161876661_508869554232690281;

/// @dev The the largest power of two that divides the decimal value of `UNIT`. The logarithm of this value is the least significant
/// bit in the binary representation of `UNIT`.
uint256 constant UNIT_LPOTD = 262144;

/*//////////////////////////////////////////////////////////////////////////
                                    FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

/// @notice Calculates the binary exponent of x using the binary fraction method.
/// @dev Has to use 192.64-bit fixed-point numbers. See https://ethereum.stackexchange.com/a/96594/24693.
/// @param x The exponent as an unsigned 192.64-bit fixed-point number.
/// @return result The result as an unsigned 60.18-decimal fixed-point number.
/// @custom:smtchecker abstract-function-nondet
function exp2(uint256 x) pure returns (uint256 result) {
    unchecked {
        // Start from 0.5 in the 192.64-bit fixed-point format.
        result = 0x800000000000000000000000000000000000000000000000;

        // The following logic multiplies the result by $\sqrt{2^{-i}}$ when the bit at position i is 1. Key points:
        //
        // 1. Intermediate results will not overflow, as the starting point is 2^191 and all magic factors are under 2^65.
        // 2. The rationale for organizing the if statements into groups of 8 is gas savings. If the result of performing
        // a bitwise AND operation between x and any value in the array [0x80; 0x40; 0x20; 0x10; 0x08; 0x04; 0x02; 0x01] is 1,
        // we know that `x & 0xFF` is also 1.
        if (x & 0xFF00000000000000 > 0) {
            if (x & 0x8000000000000000 > 0) {
                result = (result * 0x16A09E667F3BCC909) >> 64;
            }
            if (x & 0x4000000000000000 > 0) {
                result = (result * 0x1306FE0A31B7152DF) >> 64;
            }
            if (x & 0x2000000000000000 > 0) {
                result = (result * 0x1172B83C7D517ADCE) >> 64;
            }
            if (x & 0x1000000000000000 > 0) {
                result = (result * 0x10B5586CF9890F62A) >> 64;
            }
            if (x & 0x800000000000000 > 0) {
                result = (result * 0x1059B0D31585743AE) >> 64;
            }
            if (x & 0x400000000000000 > 0) {
                result = (result * 0x102C9A3E778060EE7) >> 64;
            }
            if (x & 0x200000000000000 > 0) {
                result = (result * 0x10163DA9FB33356D8) >> 64;
            }
            if (x & 0x100000000000000 > 0) {
                result = (result * 0x100B1AFA5ABCBED61) >> 64;
            }
        }

        if (x & 0xFF000000000000 > 0) {
            if (x & 0x80000000000000 > 0) {
                result = (result * 0x10058C86DA1C09EA2) >> 64;
            }
            if (x & 0x40000000000000 > 0) {
                result = (result * 0x1002C605E2E8CEC50) >> 64;
            }
            if (x & 0x20000000000000 > 0) {
                result = (result * 0x100162F3904051FA1) >> 64;
            }
            if (x & 0x10000000000000 > 0) {
                result = (result * 0x1000B175EFFDC76BA) >> 64;
            }
            if (x & 0x8000000000000 > 0) {
                result = (result * 0x100058BA01FB9F96D) >> 64;
            }
            if (x & 0x4000000000000 > 0) {
                result = (result * 0x10002C5CC37DA9492) >> 64;
            }
            if (x & 0x2000000000000 > 0) {
                result = (result * 0x1000162E525EE0547) >> 64;
            }
            if (x & 0x1000000000000 > 0) {
                result = (result * 0x10000B17255775C04) >> 64;
            }
        }

        if (x & 0xFF0000000000 > 0) {
            if (x & 0x800000000000 > 0) {
                result = (result * 0x1000058B91B5BC9AE) >> 64;
            }
            if (x & 0x400000000000 > 0) {
                result = (result * 0x100002C5C89D5EC6D) >> 64;
            }
            if (x & 0x200000000000 > 0) {
                result = (result * 0x10000162E43F4F831) >> 64;
            }
            if (x & 0x100000000000 > 0) {
                result = (result * 0x100000B1721BCFC9A) >> 64;
            }
            if (x & 0x80000000000 > 0) {
                result = (result * 0x10000058B90CF1E6E) >> 64;
            }
            if (x & 0x40000000000 > 0) {
                result = (result * 0x1000002C5C863B73F) >> 64;
            }
            if (x & 0x20000000000 > 0) {
                result = (result * 0x100000162E430E5A2) >> 64;
            }
            if (x & 0x10000000000 > 0) {
                result = (result * 0x1000000B172183551) >> 64;
            }
        }

        if (x & 0xFF00000000 > 0) {
            if (x & 0x8000000000 > 0) {
                result = (result * 0x100000058B90C0B49) >> 64;
            }
            if (x & 0x4000000000 > 0) {
                result = (result * 0x10000002C5C8601CC) >> 64;
            }
            if (x & 0x2000000000 > 0) {
                result = (result * 0x1000000162E42FFF0) >> 64;
            }
            if (x & 0x1000000000 > 0) {
                result = (result * 0x10000000B17217FBB) >> 64;
            }
            if (x & 0x800000000 > 0) {
                result = (result * 0x1000000058B90BFCE) >> 64;
            }
            if (x & 0x400000000 > 0) {
                result = (result * 0x100000002C5C85FE3) >> 64;
            }
            if (x & 0x200000000 > 0) {
                result = (result * 0x10000000162E42FF1) >> 64;
            }
            if (x & 0x100000000 > 0) {
                result = (result * 0x100000000B17217F8) >> 64;
            }
        }

        if (x & 0xFF000000 > 0) {
            if (x & 0x80000000 > 0) {
                result = (result * 0x10000000058B90BFC) >> 64;
            }
            if (x & 0x40000000 > 0) {
                result = (result * 0x1000000002C5C85FE) >> 64;
            }
            if (x & 0x20000000 > 0) {
                result = (result * 0x100000000162E42FF) >> 64;
            }
            if (x & 0x10000000 > 0) {
                result = (result * 0x1000000000B17217F) >> 64;
            }
            if (x & 0x8000000 > 0) {
                result = (result * 0x100000000058B90C0) >> 64;
            }
            if (x & 0x4000000 > 0) {
                result = (result * 0x10000000002C5C860) >> 64;
            }
            if (x & 0x2000000 > 0) {
                result = (result * 0x1000000000162E430) >> 64;
            }
            if (x & 0x1000000 > 0) {
                result = (result * 0x10000000000B17218) >> 64;
            }
        }

        if (x & 0xFF0000 > 0) {
            if (x & 0x800000 > 0) {
                result = (result * 0x1000000000058B90C) >> 64;
            }
            if (x & 0x400000 > 0) {
                result = (result * 0x100000000002C5C86) >> 64;
            }
            if (x & 0x200000 > 0) {
                result = (result * 0x10000000000162E43) >> 64;
            }
            if (x & 0x100000 > 0) {
                result = (result * 0x100000000000B1721) >> 64;
            }
            if (x & 0x80000 > 0) {
                result = (result * 0x10000000000058B91) >> 64;
            }
            if (x & 0x40000 > 0) {
                result = (result * 0x1000000000002C5C8) >> 64;
            }
            if (x & 0x20000 > 0) {
                result = (result * 0x100000000000162E4) >> 64;
            }
            if (x & 0x10000 > 0) {
                result = (result * 0x1000000000000B172) >> 64;
            }
        }

        if (x & 0xFF00 > 0) {
            if (x & 0x8000 > 0) {
                result = (result * 0x100000000000058B9) >> 64;
            }
            if (x & 0x4000 > 0) {
                result = (result * 0x10000000000002C5D) >> 64;
            }
            if (x & 0x2000 > 0) {
                result = (result * 0x1000000000000162E) >> 64;
            }
            if (x & 0x1000 > 0) {
                result = (result * 0x10000000000000B17) >> 64;
            }
            if (x & 0x800 > 0) {
                result = (result * 0x1000000000000058C) >> 64;
            }
            if (x & 0x400 > 0) {
                result = (result * 0x100000000000002C6) >> 64;
            }
            if (x & 0x200 > 0) {
                result = (result * 0x10000000000000163) >> 64;
            }
            if (x & 0x100 > 0) {
                result = (result * 0x100000000000000B1) >> 64;
            }
        }

        if (x & 0xFF > 0) {
            if (x & 0x80 > 0) {
                result = (result * 0x10000000000000059) >> 64;
            }
            if (x & 0x40 > 0) {
                result = (result * 0x1000000000000002C) >> 64;
            }
            if (x & 0x20 > 0) {
                result = (result * 0x10000000000000016) >> 64;
            }
            if (x & 0x10 > 0) {
                result = (result * 0x1000000000000000B) >> 64;
            }
            if (x & 0x8 > 0) {
                result = (result * 0x10000000000000006) >> 64;
            }
            if (x & 0x4 > 0) {
                result = (result * 0x10000000000000003) >> 64;
            }
            if (x & 0x2 > 0) {
                result = (result * 0x10000000000000001) >> 64;
            }
            if (x & 0x1 > 0) {
                result = (result * 0x10000000000000001) >> 64;
            }
        }

        // In the code snippet below, two operations are executed simultaneously:
        //
        // 1. The result is multiplied by $(2^n + 1)$, where $2^n$ represents the integer part, and the additional 1
        // accounts for the initial guess of 0.5. This is achieved by subtracting from 191 instead of 192.
        // 2. The result is then converted to an unsigned 60.18-decimal fixed-point format.
        //
        // The underlying logic is based on the relationship $2^{191-ip} = 2^{ip} / 2^{191}$, where $ip$ denotes the,
        // integer part, $2^n$.
        result *= UNIT;
        result >>= (191 - (x >> 64));
    }
}

/// @notice Finds the zero-based index of the first 1 in the binary representation of x.
///
/// @dev See the note on "msb" in this Wikipedia article: https://en.wikipedia.org/wiki/Find_first_set
///
/// Each step in this implementation is equivalent to this high-level code:
///
/// ```solidity
/// if (x >= 2 ** 128) {
///     x >>= 128;
///     result += 128;
/// }
/// ```
///
/// Where 128 is replaced with each respective power of two factor. See the full high-level implementation here:
/// https://gist.github.com/PaulRBerg/f932f8693f2733e30c4d479e8e980948
///
/// The Yul instructions used below are:
///
/// - "gt" is "greater than"
/// - "or" is the OR bitwise operator
/// - "shl" is "shift left"
/// - "shr" is "shift right"
///
/// @param x The uint256 number for which to find the index of the most significant bit.
/// @return result The index of the most significant bit as a uint256.
/// @custom:smtchecker abstract-function-nondet
function msb(uint256 x) pure returns (uint256 result) {
    // 2^128
    assembly ("memory-safe") {
        let factor := shl(7, gt(x, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^64
    assembly ("memory-safe") {
        let factor := shl(6, gt(x, 0xFFFFFFFFFFFFFFFF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^32
    assembly ("memory-safe") {
        let factor := shl(5, gt(x, 0xFFFFFFFF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^16
    assembly ("memory-safe") {
        let factor := shl(4, gt(x, 0xFFFF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^8
    assembly ("memory-safe") {
        let factor := shl(3, gt(x, 0xFF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^4
    assembly ("memory-safe") {
        let factor := shl(2, gt(x, 0xF))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^2
    assembly ("memory-safe") {
        let factor := shl(1, gt(x, 0x3))
        x := shr(factor, x)
        result := or(result, factor)
    }
    // 2^1
    // No need to shift x any more.
    assembly ("memory-safe") {
        let factor := gt(x, 0x1)
        result := or(result, factor)
    }
}

/// @notice Calculates x*y÷denominator with 512-bit precision.
///
/// @dev Credits to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - The denominator must not be zero.
/// - The result must fit in uint256.
///
/// @param x The multiplicand as a uint256.
/// @param y The multiplier as a uint256.
/// @param denominator The divisor as a uint256.
/// @return result The result as a uint256.
/// @custom:smtchecker abstract-function-nondet
function mulDiv(uint256 x, uint256 y, uint256 denominator) pure returns (uint256 result) {
    // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
    // use the Chinese Remainder Theorem to reconstruct the 512-bit result. The result is stored in two 256
    // variables such that product = prod1 * 2^256 + prod0.
    uint256 prod0; // Least significant 256 bits of the product
    uint256 prod1; // Most significant 256 bits of the product
    assembly ("memory-safe") {
        let mm := mulmod(x, y, not(0))
        prod0 := mul(x, y)
        prod1 := sub(sub(mm, prod0), lt(mm, prod0))
    }

    // Handle non-overflow cases, 256 by 256 division.
    if (prod1 == 0) {
        unchecked {
            return prod0 / denominator;
        }
    }

    // Make sure the result is less than 2^256. Also prevents denominator == 0.
    if (prod1 >= denominator) {
        revert PRBMath_MulDiv_Overflow(x, y, denominator);
    }

    ////////////////////////////////////////////////////////////////////////////
    // 512 by 256 division
    ////////////////////////////////////////////////////////////////////////////

    // Make division exact by subtracting the remainder from [prod1 prod0].
    uint256 remainder;
    assembly ("memory-safe") {
        // Compute remainder using the mulmod Yul instruction.
        remainder := mulmod(x, y, denominator)

        // Subtract 256 bit number from 512-bit number.
        prod1 := sub(prod1, gt(remainder, prod0))
        prod0 := sub(prod0, remainder)
    }

    unchecked {
        // Calculate the largest power of two divisor of the denominator using the unary operator ~. This operation cannot overflow
        // because the denominator cannot be zero at this point in the function execution. The result is always >= 1.
        // For more detail, see https://cs.stackexchange.com/q/138556/92363.
        uint256 lpotdod = denominator & (~denominator + 1);
        uint256 flippedLpotdod;

        assembly ("memory-safe") {
            // Factor powers of two out of denominator.
            denominator := div(denominator, lpotdod)

            // Divide [prod1 prod0] by lpotdod.
            prod0 := div(prod0, lpotdod)

            // Get the flipped value `2^256 / lpotdod`. If the `lpotdod` is zero, the flipped value is one.
            // `sub(0, lpotdod)` produces the two's complement version of `lpotdod`, which is equivalent to flipping all the bits.
            // However, `div` interprets this value as an unsigned value: https://ethereum.stackexchange.com/q/147168/24693
            flippedLpotdod := add(div(sub(0, lpotdod), lpotdod), 1)
        }

        // Shift in bits from prod1 into prod0.
        prod0 |= prod1 * flippedLpotdod;

        // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
        // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
        // four bits. That is, denominator * inv = 1 mod 2^4.
        uint256 inverse = (3 * denominator) ^ 2;

        // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
        // in modular arithmetic, doubling the correct bits in each step.
        inverse *= 2 - denominator * inverse; // inverse mod 2^8
        inverse *= 2 - denominator * inverse; // inverse mod 2^16
        inverse *= 2 - denominator * inverse; // inverse mod 2^32
        inverse *= 2 - denominator * inverse; // inverse mod 2^64
        inverse *= 2 - denominator * inverse; // inverse mod 2^128
        inverse *= 2 - denominator * inverse; // inverse mod 2^256

        // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
        // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
        // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
        // is no longer required.
        result = prod0 * inverse;
    }
}

/// @notice Calculates x*y÷1e18 with 512-bit precision.
///
/// @dev A variant of {mulDiv} with constant folding, i.e. in which the denominator is hard coded to 1e18.
///
/// Notes:
/// - The body is purposely left uncommented; to understand how this works, see the documentation in {mulDiv}.
/// - The result is rounded toward zero.
/// - We take as an axiom that the result cannot be `MAX_UINT256` when x and y solve the following system of equations:
///
/// $$
/// \begin{cases}
///     x * y = MAX\_UINT256 * UNIT \\
///     (x * y) \% UNIT \geq \frac{UNIT}{2}
/// \end{cases}
/// $$
///
/// Requirements:
/// - Refer to the requirements in {mulDiv}.
/// - The result must fit in uint256.
///
/// @param x The multiplicand as an unsigned 60.18-decimal fixed-point number.
/// @param y The multiplier as an unsigned 60.18-decimal fixed-point number.
/// @return result The result as an unsigned 60.18-decimal fixed-point number.
/// @custom:smtchecker abstract-function-nondet
function mulDiv18(uint256 x, uint256 y) pure returns (uint256 result) {
    uint256 prod0;
    uint256 prod1;
    assembly ("memory-safe") {
        let mm := mulmod(x, y, not(0))
        prod0 := mul(x, y)
        prod1 := sub(sub(mm, prod0), lt(mm, prod0))
    }

    if (prod1 == 0) {
        unchecked {
            return prod0 / UNIT;
        }
    }

    if (prod1 >= UNIT) {
        revert PRBMath_MulDiv18_Overflow(x, y);
    }

    uint256 remainder;
    assembly ("memory-safe") {
        remainder := mulmod(x, y, UNIT)
        result :=
            mul(
                or(
                    div(sub(prod0, remainder), UNIT_LPOTD),
                    mul(sub(prod1, gt(remainder, prod0)), add(div(sub(0, UNIT_LPOTD), UNIT_LPOTD), 1))
                ),
                UNIT_INVERSE
            )
    }
}

/// @notice Calculates x*y÷denominator with 512-bit precision.
///
/// @dev This is an extension of {mulDiv} for signed numbers, which works by computing the signs and the absolute values separately.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - Refer to the requirements in {mulDiv}.
/// - None of the inputs can be `type(int256).min`.
/// - The result must fit in int256.
///
/// @param x The multiplicand as an int256.
/// @param y The multiplier as an int256.
/// @param denominator The divisor as an int256.
/// @return result The result as an int256.
/// @custom:smtchecker abstract-function-nondet
function mulDivSigned(int256 x, int256 y, int256 denominator) pure returns (int256 result) {
    if (x == type(int256).min || y == type(int256).min || denominator == type(int256).min) {
        revert PRBMath_MulDivSigned_InputTooSmall();
    }

    // Get hold of the absolute values of x, y and the denominator.
    uint256 xAbs;
    uint256 yAbs;
    uint256 dAbs;
    unchecked {
        xAbs = x < 0 ? uint256(-x) : uint256(x);
        yAbs = y < 0 ? uint256(-y) : uint256(y);
        dAbs = denominator < 0 ? uint256(-denominator) : uint256(denominator);
    }

    // Compute the absolute value of x*y÷denominator. The result must fit in int256.
    uint256 resultAbs = mulDiv(xAbs, yAbs, dAbs);
    if (resultAbs > uint256(type(int256).max)) {
        revert PRBMath_MulDivSigned_Overflow(x, y);
    }

    // Get the signs of x, y and the denominator.
    uint256 sx;
    uint256 sy;
    uint256 sd;
    assembly ("memory-safe") {
        // "sgt" is the "signed greater than" assembly instruction and "sub(0,1)" is -1 in two's complement.
        sx := sgt(x, sub(0, 1))
        sy := sgt(y, sub(0, 1))
        sd := sgt(denominator, sub(0, 1))
    }

    // XOR over sx, sy and sd. What this does is to check whether there are 1 or 3 negative signs in the inputs.
    // If there are, the result should be negative. Otherwise, it should be positive.
    unchecked {
        result = sx ^ sy ^ sd == 0 ? -int256(resultAbs) : int256(resultAbs);
    }
}

/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - If x is not a perfect square, the result is rounded down.
/// - Credits to OpenZeppelin for the explanations in comments below.
///
/// @param x The uint256 number for which to calculate the square root.
/// @return result The result as a uint256.
/// @custom:smtchecker abstract-function-nondet
function sqrt(uint256 x) pure returns (uint256 result) {
    if (x == 0) {
        return 0;
    }

    // For our first guess, we calculate the biggest power of 2 which is smaller than the square root of x.
    //
    // We know that the "msb" (most significant bit) of x is a power of 2 such that we have:
    //
    // $$
    // msb(x) <= x <= 2*msb(x)$
    // $$
    //
    // We write $msb(x)$ as $2^k$, and we get:
    //
    // $$
    // k = log_2(x)
    // $$
    //
    // Thus, we can write the initial inequality as:
    //
    // $$
    // 2^{log_2(x)} <= x <= 2*2^{log_2(x)+1} \\
    // sqrt(2^k) <= sqrt(x) < sqrt(2^{k+1}) \\
    // 2^{k/2} <= sqrt(x) < 2^{(k+1)/2} <= 2^{(k/2)+1}
    // $$
    //
    // Consequently, $2^{log_2(x) /2} is a good first approximation of sqrt(x) with at least one correct bit.
    uint256 xAux = uint256(x);
    result = 1;
    if (xAux >= 2 ** 128) {
        xAux >>= 128;
        result <<= 64;
    }
    if (xAux >= 2 ** 64) {
        xAux >>= 64;
        result <<= 32;
    }
    if (xAux >= 2 ** 32) {
        xAux >>= 32;
        result <<= 16;
    }
    if (xAux >= 2 ** 16) {
        xAux >>= 16;
        result <<= 8;
    }
    if (xAux >= 2 ** 8) {
        xAux >>= 8;
        result <<= 4;
    }
    if (xAux >= 2 ** 4) {
        xAux >>= 4;
        result <<= 2;
    }
    if (xAux >= 2 ** 2) {
        result <<= 1;
    }

    // At this point, `result` is an estimation with at least one bit of precision. We know the true value has at
    // most 128 bits, since it is the square root of a uint256. Newton's method converges quadratically (precision
    // doubles at every iteration). We thus need at most 7 iteration to turn our partial result with one bit of
    // precision into the expected uint128 result.
    unchecked {
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;
        result = (result + x / result) >> 1;

        // If x is not a perfect square, round the result toward zero.
        uint256 roundedResult = x / result;
        if (result >= roundedResult) {
            result = roundedResult;
        }
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "../Common.sol" as Common;
import "./Errors.sol" as CastingErrors;
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { SD1x18 } from "./ValueType.sol";

/// @notice Casts an SD1x18 number into SD59x18.
/// @dev There is no overflow check because the domain of SD1x18 is a subset of SD59x18.
function intoSD59x18(SD1x18 x) pure returns (SD59x18 result) {
    result = SD59x18.wrap(int256(SD1x18.unwrap(x)));
}

/// @notice Casts an SD1x18 number into UD2x18.
/// - x must be positive.
function intoUD2x18(SD1x18 x) pure returns (UD2x18 result) {
    int64 xInt = SD1x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD1x18_ToUD2x18_Underflow(x);
    }
    result = UD2x18.wrap(uint64(xInt));
}

/// @notice Casts an SD1x18 number into UD60x18.
/// @dev Requirements:
/// - x must be positive.
function intoUD60x18(SD1x18 x) pure returns (UD60x18 result) {
    int64 xInt = SD1x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD1x18_ToUD60x18_Underflow(x);
    }
    result = UD60x18.wrap(uint64(xInt));
}

/// @notice Casts an SD1x18 number into uint256.
/// @dev Requirements:
/// - x must be positive.
function intoUint256(SD1x18 x) pure returns (uint256 result) {
    int64 xInt = SD1x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD1x18_ToUint256_Underflow(x);
    }
    result = uint256(uint64(xInt));
}

/// @notice Casts an SD1x18 number into uint128.
/// @dev Requirements:
/// - x must be positive.
function intoUint128(SD1x18 x) pure returns (uint128 result) {
    int64 xInt = SD1x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD1x18_ToUint128_Underflow(x);
    }
    result = uint128(uint64(xInt));
}

/// @notice Casts an SD1x18 number into uint40.
/// @dev Requirements:
/// - x must be positive.
/// - x must be less than or equal to `MAX_UINT40`.
function intoUint40(SD1x18 x) pure returns (uint40 result) {
    int64 xInt = SD1x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD1x18_ToUint40_Underflow(x);
    }
    if (xInt > int64(uint64(Common.MAX_UINT40))) {
        revert CastingErrors.PRBMath_SD1x18_ToUint40_Overflow(x);
    }
    result = uint40(uint64(xInt));
}

/// @notice Alias for {wrap}.
function sd1x18(int64 x) pure returns (SD1x18 result) {
    result = SD1x18.wrap(x);
}

/// @notice Unwraps an SD1x18 number into int64.
function unwrap(SD1x18 x) pure returns (int64 result) {
    result = SD1x18.unwrap(x);
}

/// @notice Wraps an int64 number into SD1x18.
function wrap(int64 x) pure returns (SD1x18 result) {
    result = SD1x18.wrap(x);
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { SD1x18 } from "./ValueType.sol";

/// @dev Euler's number as an SD1x18 number.
SD1x18 constant E = SD1x18.wrap(2_718281828459045235);

/// @dev The maximum value an SD1x18 number can have.
int64 constant uMAX_SD1x18 = 9_223372036854775807;
SD1x18 constant MAX_SD1x18 = SD1x18.wrap(uMAX_SD1x18);

/// @dev The maximum value an SD1x18 number can have.
int64 constant uMIN_SD1x18 = -9_223372036854775808;
SD1x18 constant MIN_SD1x18 = SD1x18.wrap(uMIN_SD1x18);

/// @dev PI as an SD1x18 number.
SD1x18 constant PI = SD1x18.wrap(3_141592653589793238);

/// @dev The unit number, which gives the decimal precision of SD1x18.
SD1x18 constant UNIT = SD1x18.wrap(1e18);
int64 constant uUNIT = 1e18;

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { SD1x18 } from "./ValueType.sol";

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in UD2x18.
error PRBMath_SD1x18_ToUD2x18_Underflow(SD1x18 x);

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in UD60x18.
error PRBMath_SD1x18_ToUD60x18_Underflow(SD1x18 x);

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in uint128.
error PRBMath_SD1x18_ToUint128_Underflow(SD1x18 x);

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in uint256.
error PRBMath_SD1x18_ToUint256_Underflow(SD1x18 x);

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in uint40.
error PRBMath_SD1x18_ToUint40_Overflow(SD1x18 x);

/// @notice Thrown when trying to cast a SD1x18 number that doesn't fit in uint40.
error PRBMath_SD1x18_ToUint40_Underflow(SD1x18 x);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Casting.sol" as Casting;

/// @notice The signed 1.18-decimal fixed-point number representation, which can have up to 1 digit and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type int64. This is useful when end users want to use int64 to save gas, e.g. with tight variable packing in contract
/// storage.
type SD1x18 is int64;

/*//////////////////////////////////////////////////////////////////////////
                                    CASTING
//////////////////////////////////////////////////////////////////////////*/

using {
    Casting.intoSD59x18,
    Casting.intoUD2x18,
    Casting.intoUD60x18,
    Casting.intoUint256,
    Casting.intoUint128,
    Casting.intoUint40,
    Casting.unwrap
} for SD1x18 global;

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

/*

██████╗ ██████╗ ██████╗ ███╗   ███╗ █████╗ ████████╗██╗  ██╗
██╔══██╗██╔══██╗██╔══██╗████╗ ████║██╔══██╗╚══██╔══╝██║  ██║
██████╔╝██████╔╝██████╔╝██╔████╔██║███████║   ██║   ███████║
██╔═══╝ ██╔══██╗██╔══██╗██║╚██╔╝██║██╔══██║   ██║   ██╔══██║
██║     ██║  ██║██████╔╝██║ ╚═╝ ██║██║  ██║   ██║   ██║  ██║
╚═╝     ╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝

███████╗██████╗ ███████╗ █████╗ ██╗  ██╗ ██╗ █████╗
██╔════╝██╔══██╗██╔════╝██╔══██╗╚██╗██╔╝███║██╔══██╗
███████╗██║  ██║███████╗╚██████║ ╚███╔╝ ╚██║╚█████╔╝
╚════██║██║  ██║╚════██║ ╚═══██║ ██╔██╗  ██║██╔══██╗
███████║██████╔╝███████║ █████╔╝██╔╝ ██╗ ██║╚█████╔╝
╚══════╝╚═════╝ ╚══════╝ ╚════╝ ╚═╝  ╚═╝ ╚═╝ ╚════╝

*/

import "./sd59x18/Casting.sol";
import "./sd59x18/Constants.sol";
import "./sd59x18/Conversions.sol";
import "./sd59x18/Errors.sol";
import "./sd59x18/Helpers.sol";
import "./sd59x18/Math.sol";
import "./sd59x18/ValueType.sol";

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Errors.sol" as CastingErrors;
import { MAX_UINT128, MAX_UINT40 } from "../Common.sol";
import { uMAX_SD1x18, uMIN_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { uMAX_UD2x18 } from "../ud2x18/Constants.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { SD59x18 } from "./ValueType.sol";

/// @notice Casts an SD59x18 number into int256.
/// @dev This is basically a functional alias for {unwrap}.
function intoInt256(SD59x18 x) pure returns (int256 result) {
    result = SD59x18.unwrap(x);
}

/// @notice Casts an SD59x18 number into SD1x18.
/// @dev Requirements:
/// - x must be greater than or equal to `uMIN_SD1x18`.
/// - x must be less than or equal to `uMAX_SD1x18`.
function intoSD1x18(SD59x18 x) pure returns (SD1x18 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < uMIN_SD1x18) {
        revert CastingErrors.PRBMath_SD59x18_IntoSD1x18_Underflow(x);
    }
    if (xInt > uMAX_SD1x18) {
        revert CastingErrors.PRBMath_SD59x18_IntoSD1x18_Overflow(x);
    }
    result = SD1x18.wrap(int64(xInt));
}

/// @notice Casts an SD59x18 number into UD2x18.
/// @dev Requirements:
/// - x must be positive.
/// - x must be less than or equal to `uMAX_UD2x18`.
function intoUD2x18(SD59x18 x) pure returns (UD2x18 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD59x18_IntoUD2x18_Underflow(x);
    }
    if (xInt > int256(uint256(uMAX_UD2x18))) {
        revert CastingErrors.PRBMath_SD59x18_IntoUD2x18_Overflow(x);
    }
    result = UD2x18.wrap(uint64(uint256(xInt)));
}

/// @notice Casts an SD59x18 number into UD60x18.
/// @dev Requirements:
/// - x must be positive.
function intoUD60x18(SD59x18 x) pure returns (UD60x18 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD59x18_IntoUD60x18_Underflow(x);
    }
    result = UD60x18.wrap(uint256(xInt));
}

/// @notice Casts an SD59x18 number into uint256.
/// @dev Requirements:
/// - x must be positive.
function intoUint256(SD59x18 x) pure returns (uint256 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD59x18_IntoUint256_Underflow(x);
    }
    result = uint256(xInt);
}

/// @notice Casts an SD59x18 number into uint128.
/// @dev Requirements:
/// - x must be positive.
/// - x must be less than or equal to `uMAX_UINT128`.
function intoUint128(SD59x18 x) pure returns (uint128 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD59x18_IntoUint128_Underflow(x);
    }
    if (xInt > int256(uint256(MAX_UINT128))) {
        revert CastingErrors.PRBMath_SD59x18_IntoUint128_Overflow(x);
    }
    result = uint128(uint256(xInt));
}

/// @notice Casts an SD59x18 number into uint40.
/// @dev Requirements:
/// - x must be positive.
/// - x must be less than or equal to `MAX_UINT40`.
function intoUint40(SD59x18 x) pure returns (uint40 result) {
    int256 xInt = SD59x18.unwrap(x);
    if (xInt < 0) {
        revert CastingErrors.PRBMath_SD59x18_IntoUint40_Underflow(x);
    }
    if (xInt > int256(uint256(MAX_UINT40))) {
        revert CastingErrors.PRBMath_SD59x18_IntoUint40_Overflow(x);
    }
    result = uint40(uint256(xInt));
}

/// @notice Alias for {wrap}.
function sd(int256 x) pure returns (SD59x18 result) {
    result = SD59x18.wrap(x);
}

/// @notice Alias for {wrap}.
function sd59x18(int256 x) pure returns (SD59x18 result) {
    result = SD59x18.wrap(x);
}

/// @notice Unwraps an SD59x18 number into int256.
function unwrap(SD59x18 x) pure returns (int256 result) {
    result = SD59x18.unwrap(x);
}

/// @notice Wraps an int256 number into SD59x18.
function wrap(int256 x) pure returns (SD59x18 result) {
    result = SD59x18.wrap(x);
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { SD59x18 } from "./ValueType.sol";

// NOTICE: the "u" prefix stands for "unwrapped".

/// @dev Euler's number as an SD59x18 number.
SD59x18 constant E = SD59x18.wrap(2_718281828459045235);

/// @dev The maximum input permitted in {exp}.
int256 constant uEXP_MAX_INPUT = 133_084258667509499440;
SD59x18 constant EXP_MAX_INPUT = SD59x18.wrap(uEXP_MAX_INPUT);

/// @dev Any value less than this returns 0 in {exp}.
int256 constant uEXP_MIN_THRESHOLD = -41_446531673892822322;
SD59x18 constant EXP_MIN_THRESHOLD = SD59x18.wrap(uEXP_MIN_THRESHOLD);

/// @dev The maximum input permitted in {exp2}.
int256 constant uEXP2_MAX_INPUT = 192e18 - 1;
SD59x18 constant EXP2_MAX_INPUT = SD59x18.wrap(uEXP2_MAX_INPUT);

/// @dev Any value less than this returns 0 in {exp2}.
int256 constant uEXP2_MIN_THRESHOLD = -59_794705707972522261;
SD59x18 constant EXP2_MIN_THRESHOLD = SD59x18.wrap(uEXP2_MIN_THRESHOLD);

/// @dev Half the UNIT number.
int256 constant uHALF_UNIT = 0.5e18;
SD59x18 constant HALF_UNIT = SD59x18.wrap(uHALF_UNIT);

/// @dev $log_2(10)$ as an SD59x18 number.
int256 constant uLOG2_10 = 3_321928094887362347;
SD59x18 constant LOG2_10 = SD59x18.wrap(uLOG2_10);

/// @dev $log_2(e)$ as an SD59x18 number.
int256 constant uLOG2_E = 1_442695040888963407;
SD59x18 constant LOG2_E = SD59x18.wrap(uLOG2_E);

/// @dev The maximum value an SD59x18 number can have.
int256 constant uMAX_SD59x18 = 57896044618658097711785492504343953926634992332820282019728_792003956564819967;
SD59x18 constant MAX_SD59x18 = SD59x18.wrap(uMAX_SD59x18);

/// @dev The maximum whole value an SD59x18 number can have.
int256 constant uMAX_WHOLE_SD59x18 = 57896044618658097711785492504343953926634992332820282019728_000000000000000000;
SD59x18 constant MAX_WHOLE_SD59x18 = SD59x18.wrap(uMAX_WHOLE_SD59x18);

/// @dev The minimum value an SD59x18 number can have.
int256 constant uMIN_SD59x18 = -57896044618658097711785492504343953926634992332820282019728_792003956564819968;
SD59x18 constant MIN_SD59x18 = SD59x18.wrap(uMIN_SD59x18);

/// @dev The minimum whole value an SD59x18 number can have.
int256 constant uMIN_WHOLE_SD59x18 = -57896044618658097711785492504343953926634992332820282019728_000000000000000000;
SD59x18 constant MIN_WHOLE_SD59x18 = SD59x18.wrap(uMIN_WHOLE_SD59x18);

/// @dev PI as an SD59x18 number.
SD59x18 constant PI = SD59x18.wrap(3_141592653589793238);

/// @dev The unit number, which gives the decimal precision of SD59x18.
int256 constant uUNIT = 1e18;
SD59x18 constant UNIT = SD59x18.wrap(1e18);

/// @dev The unit number squared.
int256 constant uUNIT_SQUARED = 1e36;
SD59x18 constant UNIT_SQUARED = SD59x18.wrap(uUNIT_SQUARED);

/// @dev Zero as an SD59x18 number.
SD59x18 constant ZERO = SD59x18.wrap(0);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { uMAX_SD59x18, uMIN_SD59x18, uUNIT } from "./Constants.sol";
import { PRBMath_SD59x18_Convert_Overflow, PRBMath_SD59x18_Convert_Underflow } from "./Errors.sol";
import { SD59x18 } from "./ValueType.sol";

/// @notice Converts a simple integer to SD59x18 by multiplying it by `UNIT`.
///
/// @dev Requirements:
/// - x must be greater than or equal to `MIN_SD59x18 / UNIT`.
/// - x must be less than or equal to `MAX_SD59x18 / UNIT`.
///
/// @param x The basic integer to convert.
/// @param result The same number converted to SD59x18.
function convert(int256 x) pure returns (SD59x18 result) {
    if (x < uMIN_SD59x18 / uUNIT) {
        revert PRBMath_SD59x18_Convert_Underflow(x);
    }
    if (x > uMAX_SD59x18 / uUNIT) {
        revert PRBMath_SD59x18_Convert_Overflow(x);
    }
    unchecked {
        result = SD59x18.wrap(x * uUNIT);
    }
}

/// @notice Converts an SD59x18 number to a simple integer by dividing it by `UNIT`.
/// @dev The result is rounded toward zero.
/// @param x The SD59x18 number to convert.
/// @return result The same number as a simple integer.
function convert(SD59x18 x) pure returns (int256 result) {
    result = SD59x18.unwrap(x) / uUNIT;
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { SD59x18 } from "./ValueType.sol";

/// @notice Thrown when taking the absolute value of `MIN_SD59x18`.
error PRBMath_SD59x18_Abs_MinSD59x18();

/// @notice Thrown when ceiling a number overflows SD59x18.
error PRBMath_SD59x18_Ceil_Overflow(SD59x18 x);

/// @notice Thrown when converting a basic integer to the fixed-point format overflows SD59x18.
error PRBMath_SD59x18_Convert_Overflow(int256 x);

/// @notice Thrown when converting a basic integer to the fixed-point format underflows SD59x18.
error PRBMath_SD59x18_Convert_Underflow(int256 x);

/// @notice Thrown when dividing two numbers and one of them is `MIN_SD59x18`.
error PRBMath_SD59x18_Div_InputTooSmall();

/// @notice Thrown when dividing two numbers and one of the intermediary unsigned results overflows SD59x18.
error PRBMath_SD59x18_Div_Overflow(SD59x18 x, SD59x18 y);

/// @notice Thrown when taking the natural exponent of a base greater than 133_084258667509499441.
error PRBMath_SD59x18_Exp_InputTooBig(SD59x18 x);

/// @notice Thrown when taking the binary exponent of a base greater than 192e18.
error PRBMath_SD59x18_Exp2_InputTooBig(SD59x18 x);

/// @notice Thrown when flooring a number underflows SD59x18.
error PRBMath_SD59x18_Floor_Underflow(SD59x18 x);

/// @notice Thrown when taking the geometric mean of two numbers and their product is negative.
error PRBMath_SD59x18_Gm_NegativeProduct(SD59x18 x, SD59x18 y);

/// @notice Thrown when taking the geometric mean of two numbers and multiplying them overflows SD59x18.
error PRBMath_SD59x18_Gm_Overflow(SD59x18 x, SD59x18 y);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD1x18.
error PRBMath_SD59x18_IntoSD1x18_Overflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD1x18.
error PRBMath_SD59x18_IntoSD1x18_Underflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD2x18.
error PRBMath_SD59x18_IntoUD2x18_Overflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD2x18.
error PRBMath_SD59x18_IntoUD2x18_Underflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD60x18.
error PRBMath_SD59x18_IntoUD60x18_Underflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint128.
error PRBMath_SD59x18_IntoUint128_Overflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint128.
error PRBMath_SD59x18_IntoUint128_Underflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint256.
error PRBMath_SD59x18_IntoUint256_Underflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint40.
error PRBMath_SD59x18_IntoUint40_Overflow(SD59x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint40.
error PRBMath_SD59x18_IntoUint40_Underflow(SD59x18 x);

/// @notice Thrown when taking the logarithm of a number less than or equal to zero.
error PRBMath_SD59x18_Log_InputTooSmall(SD59x18 x);

/// @notice Thrown when multiplying two numbers and one of the inputs is `MIN_SD59x18`.
error PRBMath_SD59x18_Mul_InputTooSmall();

/// @notice Thrown when multiplying two numbers and the intermediary absolute result overflows SD59x18.
error PRBMath_SD59x18_Mul_Overflow(SD59x18 x, SD59x18 y);

/// @notice Thrown when raising a number to a power and the intermediary absolute result overflows SD59x18.
error PRBMath_SD59x18_Powu_Overflow(SD59x18 x, uint256 y);

/// @notice Thrown when taking the square root of a negative number.
error PRBMath_SD59x18_Sqrt_NegativeInput(SD59x18 x);

/// @notice Thrown when the calculating the square root overflows SD59x18.
error PRBMath_SD59x18_Sqrt_Overflow(SD59x18 x);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { wrap } from "./Casting.sol";
import { SD59x18 } from "./ValueType.sol";

/// @notice Implements the checked addition operation (+) in the SD59x18 type.
function add(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    return wrap(x.unwrap() + y.unwrap());
}

/// @notice Implements the AND (&) bitwise operation in the SD59x18 type.
function and(SD59x18 x, int256 bits) pure returns (SD59x18 result) {
    return wrap(x.unwrap() & bits);
}

/// @notice Implements the AND (&) bitwise operation in the SD59x18 type.
function and2(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    return wrap(x.unwrap() & y.unwrap());
}

/// @notice Implements the equal (=) operation in the SD59x18 type.
function eq(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() == y.unwrap();
}

/// @notice Implements the greater than operation (>) in the SD59x18 type.
function gt(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() > y.unwrap();
}

/// @notice Implements the greater than or equal to operation (>=) in the SD59x18 type.
function gte(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() >= y.unwrap();
}

/// @notice Implements a zero comparison check function in the SD59x18 type.
function isZero(SD59x18 x) pure returns (bool result) {
    result = x.unwrap() == 0;
}

/// @notice Implements the left shift operation (<<) in the SD59x18 type.
function lshift(SD59x18 x, uint256 bits) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() << bits);
}

/// @notice Implements the lower than operation (<) in the SD59x18 type.
function lt(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() < y.unwrap();
}

/// @notice Implements the lower than or equal to operation (<=) in the SD59x18 type.
function lte(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() <= y.unwrap();
}

/// @notice Implements the unchecked modulo operation (%) in the SD59x18 type.
function mod(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() % y.unwrap());
}

/// @notice Implements the not equal operation (!=) in the SD59x18 type.
function neq(SD59x18 x, SD59x18 y) pure returns (bool result) {
    result = x.unwrap() != y.unwrap();
}

/// @notice Implements the NOT (~) bitwise operation in the SD59x18 type.
function not(SD59x18 x) pure returns (SD59x18 result) {
    result = wrap(~x.unwrap());
}

/// @notice Implements the OR (|) bitwise operation in the SD59x18 type.
function or(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() | y.unwrap());
}

/// @notice Implements the right shift operation (>>) in the SD59x18 type.
function rshift(SD59x18 x, uint256 bits) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() >> bits);
}

/// @notice Implements the checked subtraction operation (-) in the SD59x18 type.
function sub(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() - y.unwrap());
}

/// @notice Implements the checked unary minus operation (-) in the SD59x18 type.
function unary(SD59x18 x) pure returns (SD59x18 result) {
    result = wrap(-x.unwrap());
}

/// @notice Implements the unchecked addition operation (+) in the SD59x18 type.
function uncheckedAdd(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    unchecked {
        result = wrap(x.unwrap() + y.unwrap());
    }
}

/// @notice Implements the unchecked subtraction operation (-) in the SD59x18 type.
function uncheckedSub(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    unchecked {
        result = wrap(x.unwrap() - y.unwrap());
    }
}

/// @notice Implements the unchecked unary minus operation (-) in the SD59x18 type.
function uncheckedUnary(SD59x18 x) pure returns (SD59x18 result) {
    unchecked {
        result = wrap(-x.unwrap());
    }
}

/// @notice Implements the XOR (^) bitwise operation in the SD59x18 type.
function xor(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() ^ y.unwrap());
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import {
    uEXP_MAX_INPUT,
    uEXP2_MAX_INPUT,
    uEXP_MIN_THRESHOLD,
    uEXP2_MIN_THRESHOLD,
    uHALF_UNIT,
    uLOG2_10,
    uLOG2_E,
    uMAX_SD59x18,
    uMAX_WHOLE_SD59x18,
    uMIN_SD59x18,
    uMIN_WHOLE_SD59x18,
    UNIT,
    uUNIT,
    uUNIT_SQUARED,
    ZERO
} from "./Constants.sol";
import { wrap } from "./Helpers.sol";
import { SD59x18 } from "./ValueType.sol";

/// @notice Calculates the absolute value of x.
///
/// @dev Requirements:
/// - x must be greater than `MIN_SD59x18`.
///
/// @param x The SD59x18 number for which to calculate the absolute value.
/// @param result The absolute value of x as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function abs(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt == uMIN_SD59x18) {
        revert Errors.PRBMath_SD59x18_Abs_MinSD59x18();
    }
    result = xInt < 0 ? wrap(-xInt) : x;
}

/// @notice Calculates the arithmetic average of x and y.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// @param x The first operand as an SD59x18 number.
/// @param y The second operand as an SD59x18 number.
/// @return result The arithmetic average as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function avg(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    int256 yInt = y.unwrap();

    unchecked {
        // This operation is equivalent to `x / 2 +  y / 2`, and it can never overflow.
        int256 sum = (xInt >> 1) + (yInt >> 1);

        if (sum < 0) {
            // If at least one of x and y is odd, add 1 to the result, because shifting negative numbers to the right
            // rounds toward negative infinity. The right part is equivalent to `sum + (x % 2 == 1 || y % 2 == 1)`.
            assembly ("memory-safe") {
                result := add(sum, and(or(xInt, yInt), 1))
            }
        } else {
            // Add 1 if both x and y are odd to account for the double 0.5 remainder truncated after shifting.
            result = wrap(sum + (xInt & yInt & 1));
        }
    }
}

/// @notice Yields the smallest whole number greater than or equal to x.
///
/// @dev Optimized for fractional value inputs, because every whole value has (1e18 - 1) fractional counterparts.
/// See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x must be less than or equal to `MAX_WHOLE_SD59x18`.
///
/// @param x The SD59x18 number to ceil.
/// @param result The smallest whole number greater than or equal to x, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function ceil(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt > uMAX_WHOLE_SD59x18) {
        revert Errors.PRBMath_SD59x18_Ceil_Overflow(x);
    }

    int256 remainder = xInt % uUNIT;
    if (remainder == 0) {
        result = x;
    } else {
        unchecked {
            // Solidity uses C fmod style, which returns a modulus with the same sign as x.
            int256 resultInt = xInt - remainder;
            if (xInt > 0) {
                resultInt += uUNIT;
            }
            result = wrap(resultInt);
        }
    }
}

/// @notice Divides two SD59x18 numbers, returning a new SD59x18 number.
///
/// @dev This is an extension of {Common.mulDiv} for signed numbers, which works by computing the signs and the absolute
/// values separately.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
/// - The result is rounded toward zero.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
/// - None of the inputs can be `MIN_SD59x18`.
/// - The denominator must not be zero.
/// - The result must fit in SD59x18.
///
/// @param x The numerator as an SD59x18 number.
/// @param y The denominator as an SD59x18 number.
/// @param result The quotient as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function div(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    int256 yInt = y.unwrap();
    if (xInt == uMIN_SD59x18 || yInt == uMIN_SD59x18) {
        revert Errors.PRBMath_SD59x18_Div_InputTooSmall();
    }

    // Get hold of the absolute values of x and y.
    uint256 xAbs;
    uint256 yAbs;
    unchecked {
        xAbs = xInt < 0 ? uint256(-xInt) : uint256(xInt);
        yAbs = yInt < 0 ? uint256(-yInt) : uint256(yInt);
    }

    // Compute the absolute value (x*UNIT÷y). The resulting value must fit in SD59x18.
    uint256 resultAbs = Common.mulDiv(xAbs, uint256(uUNIT), yAbs);
    if (resultAbs > uint256(uMAX_SD59x18)) {
        revert Errors.PRBMath_SD59x18_Div_Overflow(x, y);
    }

    // Check if x and y have the same sign using two's complement representation. The left-most bit represents the sign (1 for
    // negative, 0 for positive or zero).
    bool sameSign = (xInt ^ yInt) > -1;

    // If the inputs have the same sign, the result should be positive. Otherwise, it should be negative.
    unchecked {
        result = wrap(sameSign ? int256(resultAbs) : -int256(resultAbs));
    }
}

/// @notice Calculates the natural exponent of x using the following formula:
///
/// $$
/// e^x = 2^{x * log_2{e}}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {exp2}.
///
/// Requirements:
/// - Refer to the requirements in {exp2}.
/// - x must be less than 133_084258667509499441.
///
/// @param x The exponent as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();

    // Any input less than the threshold returns zero.
    // This check also prevents an overflow for very small numbers.
    if (xInt < uEXP_MIN_THRESHOLD) {
        return ZERO;
    }

    // This check prevents values greater than 192e18 from being passed to {exp2}.
    if (xInt > uEXP_MAX_INPUT) {
        revert Errors.PRBMath_SD59x18_Exp_InputTooBig(x);
    }

    unchecked {
        // Inline the fixed-point multiplication to save gas.
        int256 doubleUnitProduct = xInt * uLOG2_E;
        result = exp2(wrap(doubleUnitProduct / uUNIT));
    }
}

/// @notice Calculates the binary exponent of x using the binary fraction method using the following formula:
///
/// $$
/// 2^{-x} = \frac{1}{2^x}
/// $$
///
/// @dev See https://ethereum.stackexchange.com/q/79903/24693.
///
/// Notes:
/// - If x is less than -59_794705707972522261, the result is zero.
///
/// Requirements:
/// - x must be less than 192e18.
/// - The result must fit in SD59x18.
///
/// @param x The exponent as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp2(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt < 0) {
        // The inverse of any number less than the threshold is truncated to zero.
        if (xInt < uEXP2_MIN_THRESHOLD) {
            return ZERO;
        }

        unchecked {
            // Inline the fixed-point inversion to save gas.
            result = wrap(uUNIT_SQUARED / exp2(wrap(-xInt)).unwrap());
        }
    } else {
        // Numbers greater than or equal to 192e18 don't fit in the 192.64-bit format.
        if (xInt > uEXP2_MAX_INPUT) {
            revert Errors.PRBMath_SD59x18_Exp2_InputTooBig(x);
        }

        unchecked {
            // Convert x to the 192.64-bit fixed-point format.
            uint256 x_192x64 = uint256((xInt << 64) / uUNIT);

            // It is safe to cast the result to int256 due to the checks above.
            result = wrap(int256(Common.exp2(x_192x64)));
        }
    }
}

/// @notice Yields the greatest whole number less than or equal to x.
///
/// @dev Optimized for fractional value inputs, because for every whole value there are (1e18 - 1) fractional
/// counterparts. See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x must be greater than or equal to `MIN_WHOLE_SD59x18`.
///
/// @param x The SD59x18 number to floor.
/// @param result The greatest whole number less than or equal to x, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function floor(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt < uMIN_WHOLE_SD59x18) {
        revert Errors.PRBMath_SD59x18_Floor_Underflow(x);
    }

    int256 remainder = xInt % uUNIT;
    if (remainder == 0) {
        result = x;
    } else {
        unchecked {
            // Solidity uses C fmod style, which returns a modulus with the same sign as x.
            int256 resultInt = xInt - remainder;
            if (xInt < 0) {
                resultInt -= uUNIT;
            }
            result = wrap(resultInt);
        }
    }
}

/// @notice Yields the excess beyond the floor of x for positive numbers and the part of the number to the right.
/// of the radix point for negative numbers.
/// @dev Based on the odd function definition. https://en.wikipedia.org/wiki/Fractional_part
/// @param x The SD59x18 number to get the fractional part of.
/// @param result The fractional part of x as an SD59x18 number.
function frac(SD59x18 x) pure returns (SD59x18 result) {
    result = wrap(x.unwrap() % uUNIT);
}

/// @notice Calculates the geometric mean of x and y, i.e. $\sqrt{x * y}$.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x * y must fit in SD59x18.
/// - x * y must not be negative, since complex numbers are not supported.
///
/// @param x The first operand as an SD59x18 number.
/// @param y The second operand as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function gm(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    int256 yInt = y.unwrap();
    if (xInt == 0 || yInt == 0) {
        return ZERO;
    }

    unchecked {
        // Equivalent to `xy / x != y`. Checking for overflow this way is faster than letting Solidity do it.
        int256 xyInt = xInt * yInt;
        if (xyInt / xInt != yInt) {
            revert Errors.PRBMath_SD59x18_Gm_Overflow(x, y);
        }

        // The product must not be negative, since complex numbers are not supported.
        if (xyInt < 0) {
            revert Errors.PRBMath_SD59x18_Gm_NegativeProduct(x, y);
        }

        // We don't need to multiply the result by `UNIT` here because the x*y product picked up a factor of `UNIT`
        // during multiplication. See the comments in {Common.sqrt}.
        uint256 resultUint = Common.sqrt(uint256(xyInt));
        result = wrap(int256(resultUint));
    }
}

/// @notice Calculates the inverse of x.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x must not be zero.
///
/// @param x The SD59x18 number for which to calculate the inverse.
/// @return result The inverse as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function inv(SD59x18 x) pure returns (SD59x18 result) {
    result = wrap(uUNIT_SQUARED / x.unwrap());
}

/// @notice Calculates the natural logarithm of x using the following formula:
///
/// $$
/// ln{x} = log_2{x} / log_2{e}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
/// - The precision isn't sufficiently fine-grained to return exactly `UNIT` when the input is `E`.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The SD59x18 number for which to calculate the natural logarithm.
/// @return result The natural logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function ln(SD59x18 x) pure returns (SD59x18 result) {
    // Inline the fixed-point multiplication to save gas. This is overflow-safe because the maximum value that
    // {log2} can return is ~195_205294292027477728.
    result = wrap(log2(x).unwrap() * uUNIT / uLOG2_E);
}

/// @notice Calculates the common logarithm of x using the following formula:
///
/// $$
/// log_{10}{x} = log_2{x} / log_2{10}
/// $$
///
/// However, if x is an exact power of ten, a hard coded value is returned.
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The SD59x18 number for which to calculate the common logarithm.
/// @return result The common logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function log10(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt < 0) {
        revert Errors.PRBMath_SD59x18_Log_InputTooSmall(x);
    }

    // Note that the `mul` in this block is the standard multiplication operation, not {SD59x18.mul}.
    // prettier-ignore
    assembly ("memory-safe") {
        switch x
        case 1 { result := mul(uUNIT, sub(0, 18)) }
        case 10 { result := mul(uUNIT, sub(1, 18)) }
        case 100 { result := mul(uUNIT, sub(2, 18)) }
        case 1000 { result := mul(uUNIT, sub(3, 18)) }
        case 10000 { result := mul(uUNIT, sub(4, 18)) }
        case 100000 { result := mul(uUNIT, sub(5, 18)) }
        case 1000000 { result := mul(uUNIT, sub(6, 18)) }
        case 10000000 { result := mul(uUNIT, sub(7, 18)) }
        case 100000000 { result := mul(uUNIT, sub(8, 18)) }
        case 1000000000 { result := mul(uUNIT, sub(9, 18)) }
        case 10000000000 { result := mul(uUNIT, sub(10, 18)) }
        case 100000000000 { result := mul(uUNIT, sub(11, 18)) }
        case 1000000000000 { result := mul(uUNIT, sub(12, 18)) }
        case 10000000000000 { result := mul(uUNIT, sub(13, 18)) }
        case 100000000000000 { result := mul(uUNIT, sub(14, 18)) }
        case 1000000000000000 { result := mul(uUNIT, sub(15, 18)) }
        case 10000000000000000 { result := mul(uUNIT, sub(16, 18)) }
        case 100000000000000000 { result := mul(uUNIT, sub(17, 18)) }
        case 1000000000000000000 { result := 0 }
        case 10000000000000000000 { result := uUNIT }
        case 100000000000000000000 { result := mul(uUNIT, 2) }
        case 1000000000000000000000 { result := mul(uUNIT, 3) }
        case 10000000000000000000000 { result := mul(uUNIT, 4) }
        case 100000000000000000000000 { result := mul(uUNIT, 5) }
        case 1000000000000000000000000 { result := mul(uUNIT, 6) }
        case 10000000000000000000000000 { result := mul(uUNIT, 7) }
        case 100000000000000000000000000 { result := mul(uUNIT, 8) }
        case 1000000000000000000000000000 { result := mul(uUNIT, 9) }
        case 10000000000000000000000000000 { result := mul(uUNIT, 10) }
        case 100000000000000000000000000000 { result := mul(uUNIT, 11) }
        case 1000000000000000000000000000000 { result := mul(uUNIT, 12) }
        case 10000000000000000000000000000000 { result := mul(uUNIT, 13) }
        case 100000000000000000000000000000000 { result := mul(uUNIT, 14) }
        case 1000000000000000000000000000000000 { result := mul(uUNIT, 15) }
        case 10000000000000000000000000000000000 { result := mul(uUNIT, 16) }
        case 100000000000000000000000000000000000 { result := mul(uUNIT, 17) }
        case 1000000000000000000000000000000000000 { result := mul(uUNIT, 18) }
        case 10000000000000000000000000000000000000 { result := mul(uUNIT, 19) }
        case 100000000000000000000000000000000000000 { result := mul(uUNIT, 20) }
        case 1000000000000000000000000000000000000000 { result := mul(uUNIT, 21) }
        case 10000000000000000000000000000000000000000 { result := mul(uUNIT, 22) }
        case 100000000000000000000000000000000000000000 { result := mul(uUNIT, 23) }
        case 1000000000000000000000000000000000000000000 { result := mul(uUNIT, 24) }
        case 10000000000000000000000000000000000000000000 { result := mul(uUNIT, 25) }
        case 100000000000000000000000000000000000000000000 { result := mul(uUNIT, 26) }
        case 1000000000000000000000000000000000000000000000 { result := mul(uUNIT, 27) }
        case 10000000000000000000000000000000000000000000000 { result := mul(uUNIT, 28) }
        case 100000000000000000000000000000000000000000000000 { result := mul(uUNIT, 29) }
        case 1000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 30) }
        case 10000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 31) }
        case 100000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 32) }
        case 1000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 33) }
        case 10000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 34) }
        case 100000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 35) }
        case 1000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 36) }
        case 10000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 37) }
        case 100000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 38) }
        case 1000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 39) }
        case 10000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 40) }
        case 100000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 41) }
        case 1000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 42) }
        case 10000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 43) }
        case 100000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 44) }
        case 1000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 45) }
        case 10000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 46) }
        case 100000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 47) }
        case 1000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 48) }
        case 10000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 49) }
        case 100000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 50) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 51) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 52) }
        case 100000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 53) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 54) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 55) }
        case 100000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 56) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 57) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 58) }
        default { result := uMAX_SD59x18 }
    }

    if (result.unwrap() == uMAX_SD59x18) {
        unchecked {
            // Inline the fixed-point division to save gas.
            result = wrap(log2(x).unwrap() * uUNIT / uLOG2_10);
        }
    }
}

/// @notice Calculates the binary logarithm of x using the iterative approximation algorithm:
///
/// $$
/// log_2{x} = n + log_2{y}, \text{ where } y = x*2^{-n}, \ y \in [1, 2)
/// $$
///
/// For $0 \leq x \lt 1$, the input is inverted:
///
/// $$
/// log_2{x} = -log_2{\frac{1}{x}}
/// $$
///
/// @dev See https://en.wikipedia.org/wiki/Binary_logarithm#Iterative_approximation.
///
/// Notes:
/// - Due to the lossy precision of the iterative approximation, the results are not perfectly accurate to the last decimal.
///
/// Requirements:
/// - x must be greater than zero.
///
/// @param x The SD59x18 number for which to calculate the binary logarithm.
/// @return result The binary logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function log2(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt <= 0) {
        revert Errors.PRBMath_SD59x18_Log_InputTooSmall(x);
    }

    unchecked {
        int256 sign;
        if (xInt >= uUNIT) {
            sign = 1;
        } else {
            sign = -1;
            // Inline the fixed-point inversion to save gas.
            xInt = uUNIT_SQUARED / xInt;
        }

        // Calculate the integer part of the logarithm.
        uint256 n = Common.msb(uint256(xInt / uUNIT));

        // This is the integer part of the logarithm as an SD59x18 number. The operation can't overflow
        // because n is at most 255, `UNIT` is 1e18, and the sign is either 1 or -1.
        int256 resultInt = int256(n) * uUNIT;

        // Calculate $y = x * 2^{-n}$.
        int256 y = xInt >> n;

        // If y is the unit number, the fractional part is zero.
        if (y == uUNIT) {
            return wrap(resultInt * sign);
        }

        // Calculate the fractional part via the iterative approximation.
        // The `delta >>= 1` part is equivalent to `delta /= 2`, but shifting bits is more gas efficient.
        int256 DOUBLE_UNIT = 2e18;
        for (int256 delta = uHALF_UNIT; delta > 0; delta >>= 1) {
            y = (y * y) / uUNIT;

            // Is y^2 >= 2e18 and so in the range [2e18, 4e18)?
            if (y >= DOUBLE_UNIT) {
                // Add the 2^{-m} factor to the logarithm.
                resultInt = resultInt + delta;

                // Halve y, which corresponds to z/2 in the Wikipedia article.
                y >>= 1;
            }
        }
        resultInt *= sign;
        result = wrap(resultInt);
    }
}

/// @notice Multiplies two SD59x18 numbers together, returning a new SD59x18 number.
///
/// @dev Notes:
/// - Refer to the notes in {Common.mulDiv18}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv18}.
/// - None of the inputs can be `MIN_SD59x18`.
/// - The result must fit in SD59x18.
///
/// @param x The multiplicand as an SD59x18 number.
/// @param y The multiplier as an SD59x18 number.
/// @return result The product as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function mul(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    int256 yInt = y.unwrap();
    if (xInt == uMIN_SD59x18 || yInt == uMIN_SD59x18) {
        revert Errors.PRBMath_SD59x18_Mul_InputTooSmall();
    }

    // Get hold of the absolute values of x and y.
    uint256 xAbs;
    uint256 yAbs;
    unchecked {
        xAbs = xInt < 0 ? uint256(-xInt) : uint256(xInt);
        yAbs = yInt < 0 ? uint256(-yInt) : uint256(yInt);
    }

    // Compute the absolute value (x*y÷UNIT). The resulting value must fit in SD59x18.
    uint256 resultAbs = Common.mulDiv18(xAbs, yAbs);
    if (resultAbs > uint256(uMAX_SD59x18)) {
        revert Errors.PRBMath_SD59x18_Mul_Overflow(x, y);
    }

    // Check if x and y have the same sign using two's complement representation. The left-most bit represents the sign (1 for
    // negative, 0 for positive or zero).
    bool sameSign = (xInt ^ yInt) > -1;

    // If the inputs have the same sign, the result should be positive. Otherwise, it should be negative.
    unchecked {
        result = wrap(sameSign ? int256(resultAbs) : -int256(resultAbs));
    }
}

/// @notice Raises x to the power of y using the following formula:
///
/// $$
/// x^y = 2^{log_2{x} * y}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {exp2}, {log2}, and {mul}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - Refer to the requirements in {exp2}, {log2}, and {mul}.
///
/// @param x The base as an SD59x18 number.
/// @param y Exponent to raise x to, as an SD59x18 number
/// @return result x raised to power y, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function pow(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    int256 yInt = y.unwrap();

    // If both x and y are zero, the result is `UNIT`. If just x is zero, the result is always zero.
    if (xInt == 0) {
        return yInt == 0 ? UNIT : ZERO;
    }
    // If x is `UNIT`, the result is always `UNIT`.
    else if (xInt == uUNIT) {
        return UNIT;
    }

    // If y is zero, the result is always `UNIT`.
    if (yInt == 0) {
        return UNIT;
    }
    // If y is `UNIT`, the result is always x.
    else if (yInt == uUNIT) {
        return x;
    }

    // Calculate the result using the formula.
    result = exp2(mul(log2(x), y));
}

/// @notice Raises x (an SD59x18 number) to the power y (an unsigned basic integer) using the well-known
/// algorithm "exponentiation by squaring".
///
/// @dev See https://en.wikipedia.org/wiki/Exponentiation_by_squaring.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv18}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - Refer to the requirements in {abs} and {Common.mulDiv18}.
/// - The result must fit in SD59x18.
///
/// @param x The base as an SD59x18 number.
/// @param y The exponent as a uint256.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function powu(SD59x18 x, uint256 y) pure returns (SD59x18 result) {
    uint256 xAbs = uint256(abs(x).unwrap());

    // Calculate the first iteration of the loop in advance.
    uint256 resultAbs = y & 1 > 0 ? xAbs : uint256(uUNIT);

    // Equivalent to `for(y /= 2; y > 0; y /= 2)`.
    uint256 yAux = y;
    for (yAux >>= 1; yAux > 0; yAux >>= 1) {
        xAbs = Common.mulDiv18(xAbs, xAbs);

        // Equivalent to `y % 2 == 1`.
        if (yAux & 1 > 0) {
            resultAbs = Common.mulDiv18(resultAbs, xAbs);
        }
    }

    // The result must fit in SD59x18.
    if (resultAbs > uint256(uMAX_SD59x18)) {
        revert Errors.PRBMath_SD59x18_Powu_Overflow(x, y);
    }

    unchecked {
        // Is the base negative and the exponent odd? If yes, the result should be negative.
        int256 resultInt = int256(resultAbs);
        bool isNegative = x.unwrap() < 0 && y & 1 == 1;
        if (isNegative) {
            resultInt = -resultInt;
        }
        result = wrap(resultInt);
    }
}

/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - Only the positive root is returned.
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x cannot be negative, since complex numbers are not supported.
/// - x must be less than `MAX_SD59x18 / UNIT`.
///
/// @param x The SD59x18 number for which to calculate the square root.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function sqrt(SD59x18 x) pure returns (SD59x18 result) {
    int256 xInt = x.unwrap();
    if (xInt < 0) {
        revert Errors.PRBMath_SD59x18_Sqrt_NegativeInput(x);
    }
    if (xInt > uMAX_SD59x18 / uUNIT) {
        revert Errors.PRBMath_SD59x18_Sqrt_Overflow(x);
    }

    unchecked {
        // Multiply x by `UNIT` to account for the factor of `UNIT` picked up when multiplying two SD59x18 numbers.
        // In this case, the two numbers are both the square root.
        uint256 resultUint = Common.sqrt(uint256(xInt * uUNIT));
        result = wrap(int256(resultUint));
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Casting.sol" as Casting;
import "./Helpers.sol" as Helpers;
import "./Math.sol" as Math;

/// @notice The signed 59.18-decimal fixed-point number representation, which can have up to 59 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type int256.
type SD59x18 is int256;

/*//////////////////////////////////////////////////////////////////////////
                                    CASTING
//////////////////////////////////////////////////////////////////////////*/

using {
    Casting.intoInt256,
    Casting.intoSD1x18,
    Casting.intoUD2x18,
    Casting.intoUD60x18,
    Casting.intoUint256,
    Casting.intoUint128,
    Casting.intoUint40,
    Casting.unwrap
} for SD59x18 global;

/*//////////////////////////////////////////////////////////////////////////
                            MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

using {
    Math.abs,
    Math.avg,
    Math.ceil,
    Math.div,
    Math.exp,
    Math.exp2,
    Math.floor,
    Math.frac,
    Math.gm,
    Math.inv,
    Math.log10,
    Math.log2,
    Math.ln,
    Math.mul,
    Math.pow,
    Math.powu,
    Math.sqrt
} for SD59x18 global;

/*//////////////////////////////////////////////////////////////////////////
                                HELPER FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

using {
    Helpers.add,
    Helpers.and,
    Helpers.eq,
    Helpers.gt,
    Helpers.gte,
    Helpers.isZero,
    Helpers.lshift,
    Helpers.lt,
    Helpers.lte,
    Helpers.mod,
    Helpers.neq,
    Helpers.not,
    Helpers.or,
    Helpers.rshift,
    Helpers.sub,
    Helpers.uncheckedAdd,
    Helpers.uncheckedSub,
    Helpers.uncheckedUnary,
    Helpers.xor
} for SD59x18 global;

/*//////////////////////////////////////////////////////////////////////////
                                    OPERATORS
//////////////////////////////////////////////////////////////////////////*/

// The global "using for" directive makes it possible to use these operators on the SD59x18 type.
using {
    Helpers.add as +,
    Helpers.and2 as &,
    Math.div as /,
    Helpers.eq as ==,
    Helpers.gt as >,
    Helpers.gte as >=,
    Helpers.lt as <,
    Helpers.lte as <=,
    Helpers.mod as %,
    Math.mul as *,
    Helpers.neq as !=,
    Helpers.not as ~,
    Helpers.or as |,
    Helpers.sub as -,
    Helpers.unary as -,
    Helpers.xor as ^
} for SD59x18 global;

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

/*

██████╗ ██████╗ ██████╗ ███╗   ███╗ █████╗ ████████╗██╗  ██╗
██╔══██╗██╔══██╗██╔══██╗████╗ ████║██╔══██╗╚══██╔══╝██║  ██║
██████╔╝██████╔╝██████╔╝██╔████╔██║███████║   ██║   ███████║
██╔═══╝ ██╔══██╗██╔══██╗██║╚██╔╝██║██╔══██║   ██║   ██╔══██║
██║     ██║  ██║██████╔╝██║ ╚═╝ ██║██║  ██║   ██║   ██║  ██║
╚═╝     ╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝

██╗   ██╗██████╗ ██████╗ ██╗  ██╗ ██╗ █████╗
██║   ██║██╔══██╗╚════██╗╚██╗██╔╝███║██╔══██╗
██║   ██║██║  ██║ █████╔╝ ╚███╔╝ ╚██║╚█████╔╝
██║   ██║██║  ██║██╔═══╝  ██╔██╗  ██║██╔══██╗
╚██████╔╝██████╔╝███████╗██╔╝ ██╗ ██║╚█████╔╝
 ╚═════╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝ ╚═╝ ╚════╝

*/

import "./ud2x18/Casting.sol";
import "./ud2x18/Constants.sol";
import "./ud2x18/Errors.sol";
import "./ud2x18/ValueType.sol";

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import { uMAX_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { UD2x18 } from "./ValueType.sol";

/// @notice Casts a UD2x18 number into SD1x18.
/// - x must be less than or equal to `uMAX_SD1x18`.
function intoSD1x18(UD2x18 x) pure returns (SD1x18 result) {
    uint64 xUint = UD2x18.unwrap(x);
    if (xUint > uint64(uMAX_SD1x18)) {
        revert Errors.PRBMath_UD2x18_IntoSD1x18_Overflow(x);
    }
    result = SD1x18.wrap(int64(xUint));
}

/// @notice Casts a UD2x18 number into SD59x18.
/// @dev There is no overflow check because the domain of UD2x18 is a subset of SD59x18.
function intoSD59x18(UD2x18 x) pure returns (SD59x18 result) {
    result = SD59x18.wrap(int256(uint256(UD2x18.unwrap(x))));
}

/// @notice Casts a UD2x18 number into UD60x18.
/// @dev There is no overflow check because the domain of UD2x18 is a subset of UD60x18.
function intoUD60x18(UD2x18 x) pure returns (UD60x18 result) {
    result = UD60x18.wrap(UD2x18.unwrap(x));
}

/// @notice Casts a UD2x18 number into uint128.
/// @dev There is no overflow check because the domain of UD2x18 is a subset of uint128.
function intoUint128(UD2x18 x) pure returns (uint128 result) {
    result = uint128(UD2x18.unwrap(x));
}

/// @notice Casts a UD2x18 number into uint256.
/// @dev There is no overflow check because the domain of UD2x18 is a subset of uint256.
function intoUint256(UD2x18 x) pure returns (uint256 result) {
    result = uint256(UD2x18.unwrap(x));
}

/// @notice Casts a UD2x18 number into uint40.
/// @dev Requirements:
/// - x must be less than or equal to `MAX_UINT40`.
function intoUint40(UD2x18 x) pure returns (uint40 result) {
    uint64 xUint = UD2x18.unwrap(x);
    if (xUint > uint64(Common.MAX_UINT40)) {
        revert Errors.PRBMath_UD2x18_IntoUint40_Overflow(x);
    }
    result = uint40(xUint);
}

/// @notice Alias for {wrap}.
function ud2x18(uint64 x) pure returns (UD2x18 result) {
    result = UD2x18.wrap(x);
}

/// @notice Unwrap a UD2x18 number into uint64.
function unwrap(UD2x18 x) pure returns (uint64 result) {
    result = UD2x18.unwrap(x);
}

/// @notice Wraps a uint64 number into UD2x18.
function wrap(uint64 x) pure returns (UD2x18 result) {
    result = UD2x18.wrap(x);
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { UD2x18 } from "./ValueType.sol";

/// @dev Euler's number as a UD2x18 number.
UD2x18 constant E = UD2x18.wrap(2_718281828459045235);

/// @dev The maximum value a UD2x18 number can have.
uint64 constant uMAX_UD2x18 = 18_446744073709551615;
UD2x18 constant MAX_UD2x18 = UD2x18.wrap(uMAX_UD2x18);

/// @dev PI as a UD2x18 number.
UD2x18 constant PI = UD2x18.wrap(3_141592653589793238);

/// @dev The unit number, which gives the decimal precision of UD2x18.
UD2x18 constant UNIT = UD2x18.wrap(1e18);
uint64 constant uUNIT = 1e18;

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { UD2x18 } from "./ValueType.sol";

/// @notice Thrown when trying to cast a UD2x18 number that doesn't fit in SD1x18.
error PRBMath_UD2x18_IntoSD1x18_Overflow(UD2x18 x);

/// @notice Thrown when trying to cast a UD2x18 number that doesn't fit in uint40.
error PRBMath_UD2x18_IntoUint40_Overflow(UD2x18 x);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Casting.sol" as Casting;

/// @notice The unsigned 2.18-decimal fixed-point number representation, which can have up to 2 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type uint64. This is useful when end users want to use uint64 to save gas, e.g. with tight variable packing in contract
/// storage.
type UD2x18 is uint64;

/*//////////////////////////////////////////////////////////////////////////
                                    CASTING
//////////////////////////////////////////////////////////////////////////*/

using {
    Casting.intoSD1x18,
    Casting.intoSD59x18,
    Casting.intoUD60x18,
    Casting.intoUint256,
    Casting.intoUint128,
    Casting.intoUint40,
    Casting.unwrap
} for UD2x18 global;

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

/*

██████╗ ██████╗ ██████╗ ███╗   ███╗ █████╗ ████████╗██╗  ██╗
██╔══██╗██╔══██╗██╔══██╗████╗ ████║██╔══██╗╚══██╔══╝██║  ██║
██████╔╝██████╔╝██████╔╝██╔████╔██║███████║   ██║   ███████║
██╔═══╝ ██╔══██╗██╔══██╗██║╚██╔╝██║██╔══██║   ██║   ██╔══██║
██║     ██║  ██║██████╔╝██║ ╚═╝ ██║██║  ██║   ██║   ██║  ██║
╚═╝     ╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝

██╗   ██╗██████╗  ██████╗  ██████╗ ██╗  ██╗ ██╗ █████╗
██║   ██║██╔══██╗██╔════╝ ██╔═████╗╚██╗██╔╝███║██╔══██╗
██║   ██║██║  ██║███████╗ ██║██╔██║ ╚███╔╝ ╚██║╚█████╔╝
██║   ██║██║  ██║██╔═══██╗████╔╝██║ ██╔██╗  ██║██╔══██╗
╚██████╔╝██████╔╝╚██████╔╝╚██████╔╝██╔╝ ██╗ ██║╚█████╔╝
 ╚═════╝ ╚═════╝  ╚═════╝  ╚═════╝ ╚═╝  ╚═╝ ╚═╝ ╚════╝

*/

import "./ud60x18/Casting.sol";
import "./ud60x18/Constants.sol";
import "./ud60x18/Conversions.sol";
import "./ud60x18/Errors.sol";
import "./ud60x18/Helpers.sol";
import "./ud60x18/Math.sol";
import "./ud60x18/ValueType.sol";

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Errors.sol" as CastingErrors;
import { MAX_UINT128, MAX_UINT40 } from "../Common.sol";
import { uMAX_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { uMAX_SD59x18 } from "../sd59x18/Constants.sol";
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { uMAX_UD2x18 } from "../ud2x18/Constants.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD60x18 } from "./ValueType.sol";

/// @notice Casts a UD60x18 number into SD1x18.
/// @dev Requirements:
/// - x must be less than or equal to `uMAX_SD1x18`.
function intoSD1x18(UD60x18 x) pure returns (SD1x18 result) {
    uint256 xUint = UD60x18.unwrap(x);
    if (xUint > uint256(int256(uMAX_SD1x18))) {
        revert CastingErrors.PRBMath_UD60x18_IntoSD1x18_Overflow(x);
    }
    result = SD1x18.wrap(int64(uint64(xUint)));
}

/// @notice Casts a UD60x18 number into UD2x18.
/// @dev Requirements:
/// - x must be less than or equal to `uMAX_UD2x18`.
function intoUD2x18(UD60x18 x) pure returns (UD2x18 result) {
    uint256 xUint = UD60x18.unwrap(x);
    if (xUint > uMAX_UD2x18) {
        revert CastingErrors.PRBMath_UD60x18_IntoUD2x18_Overflow(x);
    }
    result = UD2x18.wrap(uint64(xUint));
}

/// @notice Casts a UD60x18 number into SD59x18.
/// @dev Requirements:
/// - x must be less than or equal to `uMAX_SD59x18`.
function intoSD59x18(UD60x18 x) pure returns (SD59x18 result) {
    uint256 xUint = UD60x18.unwrap(x);
    if (xUint > uint256(uMAX_SD59x18)) {
        revert CastingErrors.PRBMath_UD60x18_IntoSD59x18_Overflow(x);
    }
    result = SD59x18.wrap(int256(xUint));
}

/// @notice Casts a UD60x18 number into uint128.
/// @dev This is basically an alias for {unwrap}.
function intoUint256(UD60x18 x) pure returns (uint256 result) {
    result = UD60x18.unwrap(x);
}

/// @notice Casts a UD60x18 number into uint128.
/// @dev Requirements:
/// - x must be less than or equal to `MAX_UINT128`.
function intoUint128(UD60x18 x) pure returns (uint128 result) {
    uint256 xUint = UD60x18.unwrap(x);
    if (xUint > MAX_UINT128) {
        revert CastingErrors.PRBMath_UD60x18_IntoUint128_Overflow(x);
    }
    result = uint128(xUint);
}

/// @notice Casts a UD60x18 number into uint40.
/// @dev Requirements:
/// - x must be less than or equal to `MAX_UINT40`.
function intoUint40(UD60x18 x) pure returns (uint40 result) {
    uint256 xUint = UD60x18.unwrap(x);
    if (xUint > MAX_UINT40) {
        revert CastingErrors.PRBMath_UD60x18_IntoUint40_Overflow(x);
    }
    result = uint40(xUint);
}

/// @notice Alias for {wrap}.
function ud(uint256 x) pure returns (UD60x18 result) {
    result = UD60x18.wrap(x);
}

/// @notice Alias for {wrap}.
function ud60x18(uint256 x) pure returns (UD60x18 result) {
    result = UD60x18.wrap(x);
}

/// @notice Unwraps a UD60x18 number into uint256.
function unwrap(UD60x18 x) pure returns (uint256 result) {
    result = UD60x18.unwrap(x);
}

/// @notice Wraps a uint256 number into the UD60x18 value type.
function wrap(uint256 x) pure returns (UD60x18 result) {
    result = UD60x18.wrap(x);
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { UD60x18 } from "./ValueType.sol";

// NOTICE: the "u" prefix stands for "unwrapped".

/// @dev Euler's number as a UD60x18 number.
UD60x18 constant E = UD60x18.wrap(2_718281828459045235);

/// @dev The maximum input permitted in {exp}.
uint256 constant uEXP_MAX_INPUT = 133_084258667509499440;
UD60x18 constant EXP_MAX_INPUT = UD60x18.wrap(uEXP_MAX_INPUT);

/// @dev The maximum input permitted in {exp2}.
uint256 constant uEXP2_MAX_INPUT = 192e18 - 1;
UD60x18 constant EXP2_MAX_INPUT = UD60x18.wrap(uEXP2_MAX_INPUT);

/// @dev Half the UNIT number.
uint256 constant uHALF_UNIT = 0.5e18;
UD60x18 constant HALF_UNIT = UD60x18.wrap(uHALF_UNIT);

/// @dev $log_2(10)$ as a UD60x18 number.
uint256 constant uLOG2_10 = 3_321928094887362347;
UD60x18 constant LOG2_10 = UD60x18.wrap(uLOG2_10);

/// @dev $log_2(e)$ as a UD60x18 number.
uint256 constant uLOG2_E = 1_442695040888963407;
UD60x18 constant LOG2_E = UD60x18.wrap(uLOG2_E);

/// @dev The maximum value a UD60x18 number can have.
uint256 constant uMAX_UD60x18 = 115792089237316195423570985008687907853269984665640564039457_584007913129639935;
UD60x18 constant MAX_UD60x18 = UD60x18.wrap(uMAX_UD60x18);

/// @dev The maximum whole value a UD60x18 number can have.
uint256 constant uMAX_WHOLE_UD60x18 = 115792089237316195423570985008687907853269984665640564039457_000000000000000000;
UD60x18 constant MAX_WHOLE_UD60x18 = UD60x18.wrap(uMAX_WHOLE_UD60x18);

/// @dev PI as a UD60x18 number.
UD60x18 constant PI = UD60x18.wrap(3_141592653589793238);

/// @dev The unit number, which gives the decimal precision of UD60x18.
uint256 constant uUNIT = 1e18;
UD60x18 constant UNIT = UD60x18.wrap(uUNIT);

/// @dev The unit number squared.
uint256 constant uUNIT_SQUARED = 1e36;
UD60x18 constant UNIT_SQUARED = UD60x18.wrap(uUNIT_SQUARED);

/// @dev Zero as a UD60x18 number.
UD60x18 constant ZERO = UD60x18.wrap(0);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { uMAX_UD60x18, uUNIT } from "./Constants.sol";
import { PRBMath_UD60x18_Convert_Overflow } from "./Errors.sol";
import { UD60x18 } from "./ValueType.sol";

/// @notice Converts a UD60x18 number to a simple integer by dividing it by `UNIT`.
/// @dev The result is rounded toward zero.
/// @param x The UD60x18 number to convert.
/// @return result The same number in basic integer form.
function convert(UD60x18 x) pure returns (uint256 result) {
    result = UD60x18.unwrap(x) / uUNIT;
}

/// @notice Converts a simple integer to UD60x18 by multiplying it by `UNIT`.
///
/// @dev Requirements:
/// - x must be less than or equal to `MAX_UD60x18 / UNIT`.
///
/// @param x The basic integer to convert.
/// @param result The same number converted to UD60x18.
function convert(uint256 x) pure returns (UD60x18 result) {
    if (x > uMAX_UD60x18 / uUNIT) {
        revert PRBMath_UD60x18_Convert_Overflow(x);
    }
    unchecked {
        result = UD60x18.wrap(x * uUNIT);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { UD60x18 } from "./ValueType.sol";

/// @notice Thrown when ceiling a number overflows UD60x18.
error PRBMath_UD60x18_Ceil_Overflow(UD60x18 x);

/// @notice Thrown when converting a basic integer to the fixed-point format overflows UD60x18.
error PRBMath_UD60x18_Convert_Overflow(uint256 x);

/// @notice Thrown when taking the natural exponent of a base greater than 133_084258667509499441.
error PRBMath_UD60x18_Exp_InputTooBig(UD60x18 x);

/// @notice Thrown when taking the binary exponent of a base greater than 192e18.
error PRBMath_UD60x18_Exp2_InputTooBig(UD60x18 x);

/// @notice Thrown when taking the geometric mean of two numbers and multiplying them overflows UD60x18.
error PRBMath_UD60x18_Gm_Overflow(UD60x18 x, UD60x18 y);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD1x18.
error PRBMath_UD60x18_IntoSD1x18_Overflow(UD60x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD59x18.
error PRBMath_UD60x18_IntoSD59x18_Overflow(UD60x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD2x18.
error PRBMath_UD60x18_IntoUD2x18_Overflow(UD60x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint128.
error PRBMath_UD60x18_IntoUint128_Overflow(UD60x18 x);

/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint40.
error PRBMath_UD60x18_IntoUint40_Overflow(UD60x18 x);

/// @notice Thrown when taking the logarithm of a number less than 1.
error PRBMath_UD60x18_Log_InputTooSmall(UD60x18 x);

/// @notice Thrown when calculating the square root overflows UD60x18.
error PRBMath_UD60x18_Sqrt_Overflow(UD60x18 x);

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import { wrap } from "./Casting.sol";
import { UD60x18 } from "./ValueType.sol";

/// @notice Implements the checked addition operation (+) in the UD60x18 type.
function add(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() + y.unwrap());
}

/// @notice Implements the AND (&) bitwise operation in the UD60x18 type.
function and(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() & bits);
}

/// @notice Implements the AND (&) bitwise operation in the UD60x18 type.
function and2(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() & y.unwrap());
}

/// @notice Implements the equal operation (==) in the UD60x18 type.
function eq(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() == y.unwrap();
}

/// @notice Implements the greater than operation (>) in the UD60x18 type.
function gt(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() > y.unwrap();
}

/// @notice Implements the greater than or equal to operation (>=) in the UD60x18 type.
function gte(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() >= y.unwrap();
}

/// @notice Implements a zero comparison check function in the UD60x18 type.
function isZero(UD60x18 x) pure returns (bool result) {
    // This wouldn't work if x could be negative.
    result = x.unwrap() == 0;
}

/// @notice Implements the left shift operation (<<) in the UD60x18 type.
function lshift(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() << bits);
}

/// @notice Implements the lower than operation (<) in the UD60x18 type.
function lt(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() < y.unwrap();
}

/// @notice Implements the lower than or equal to operation (<=) in the UD60x18 type.
function lte(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() <= y.unwrap();
}

/// @notice Implements the checked modulo operation (%) in the UD60x18 type.
function mod(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() % y.unwrap());
}

/// @notice Implements the not equal operation (!=) in the UD60x18 type.
function neq(UD60x18 x, UD60x18 y) pure returns (bool result) {
    result = x.unwrap() != y.unwrap();
}

/// @notice Implements the NOT (~) bitwise operation in the UD60x18 type.
function not(UD60x18 x) pure returns (UD60x18 result) {
    result = wrap(~x.unwrap());
}

/// @notice Implements the OR (|) bitwise operation in the UD60x18 type.
function or(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() | y.unwrap());
}

/// @notice Implements the right shift operation (>>) in the UD60x18 type.
function rshift(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() >> bits);
}

/// @notice Implements the checked subtraction operation (-) in the UD60x18 type.
function sub(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() - y.unwrap());
}

/// @notice Implements the unchecked addition operation (+) in the UD60x18 type.
function uncheckedAdd(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    unchecked {
        result = wrap(x.unwrap() + y.unwrap());
    }
}

/// @notice Implements the unchecked subtraction operation (-) in the UD60x18 type.
function uncheckedSub(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    unchecked {
        result = wrap(x.unwrap() - y.unwrap());
    }
}

/// @notice Implements the XOR (^) bitwise operation in the UD60x18 type.
function xor(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(x.unwrap() ^ y.unwrap());
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import { wrap } from "./Casting.sol";
import {
    uEXP_MAX_INPUT,
    uEXP2_MAX_INPUT,
    uHALF_UNIT,
    uLOG2_10,
    uLOG2_E,
    uMAX_UD60x18,
    uMAX_WHOLE_UD60x18,
    UNIT,
    uUNIT,
    uUNIT_SQUARED,
    ZERO
} from "./Constants.sol";
import { UD60x18 } from "./ValueType.sol";

/*//////////////////////////////////////////////////////////////////////////
                            MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

/// @notice Calculates the arithmetic average of x and y using the following formula:
///
/// $$
/// avg(x, y) = (x & y) + ((xUint ^ yUint) / 2)
/// $$
///
/// In English, this is what this formula does:
///
/// 1. AND x and y.
/// 2. Calculate half of XOR x and y.
/// 3. Add the two results together.
///
/// This technique is known as SWAR, which stands for "SIMD within a register". You can read more about it here:
/// https://devblogs.microsoft.com/oldnewthing/20220207-00/?p=106223
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// @param x The first operand as a UD60x18 number.
/// @param y The second operand as a UD60x18 number.
/// @return result The arithmetic average as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function avg(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();
    uint256 yUint = y.unwrap();
    unchecked {
        result = wrap((xUint & yUint) + ((xUint ^ yUint) >> 1));
    }
}

/// @notice Yields the smallest whole number greater than or equal to x.
///
/// @dev This is optimized for fractional value inputs, because for every whole value there are (1e18 - 1) fractional
/// counterparts. See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x must be less than or equal to `MAX_WHOLE_UD60x18`.
///
/// @param x The UD60x18 number to ceil.
/// @param result The smallest whole number greater than or equal to x, as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function ceil(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();
    if (xUint > uMAX_WHOLE_UD60x18) {
        revert Errors.PRBMath_UD60x18_Ceil_Overflow(x);
    }

    assembly ("memory-safe") {
        // Equivalent to `x % UNIT`.
        let remainder := mod(x, uUNIT)

        // Equivalent to `UNIT - remainder`.
        let delta := sub(uUNIT, remainder)

        // Equivalent to `x + remainder > 0 ? delta : 0`.
        result := add(x, mul(delta, gt(remainder, 0)))
    }
}

/// @notice Divides two UD60x18 numbers, returning a new UD60x18 number.
///
/// @dev Uses {Common.mulDiv} to enable overflow-safe multiplication and division.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
///
/// @param x The numerator as a UD60x18 number.
/// @param y The denominator as a UD60x18 number.
/// @param result The quotient as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function div(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(Common.mulDiv(x.unwrap(), uUNIT, y.unwrap()));
}

/// @notice Calculates the natural exponent of x using the following formula:
///
/// $$
/// e^x = 2^{x * log_2{e}}
/// $$
///
/// @dev Requirements:
/// - x must be less than 133_084258667509499441.
///
/// @param x The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();

    // This check prevents values greater than 192e18 from being passed to {exp2}.
    if (xUint > uEXP_MAX_INPUT) {
        revert Errors.PRBMath_UD60x18_Exp_InputTooBig(x);
    }

    unchecked {
        // Inline the fixed-point multiplication to save gas.
        uint256 doubleUnitProduct = xUint * uLOG2_E;
        result = exp2(wrap(doubleUnitProduct / uUNIT));
    }
}

/// @notice Calculates the binary exponent of x using the binary fraction method.
///
/// @dev See https://ethereum.stackexchange.com/q/79903/24693
///
/// Requirements:
/// - x must be less than 192e18.
/// - The result must fit in UD60x18.
///
/// @param x The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp2(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();

    // Numbers greater than or equal to 192e18 don't fit in the 192.64-bit format.
    if (xUint > uEXP2_MAX_INPUT) {
        revert Errors.PRBMath_UD60x18_Exp2_InputTooBig(x);
    }

    // Convert x to the 192.64-bit fixed-point format.
    uint256 x_192x64 = (xUint << 64) / uUNIT;

    // Pass x to the {Common.exp2} function, which uses the 192.64-bit fixed-point number representation.
    result = wrap(Common.exp2(x_192x64));
}

/// @notice Yields the greatest whole number less than or equal to x.
/// @dev Optimized for fractional value inputs, because every whole value has (1e18 - 1) fractional counterparts.
/// See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
/// @param x The UD60x18 number to floor.
/// @param result The greatest whole number less than or equal to x, as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function floor(UD60x18 x) pure returns (UD60x18 result) {
    assembly ("memory-safe") {
        // Equivalent to `x % UNIT`.
        let remainder := mod(x, uUNIT)

        // Equivalent to `x - remainder > 0 ? remainder : 0)`.
        result := sub(x, mul(remainder, gt(remainder, 0)))
    }
}

/// @notice Yields the excess beyond the floor of x using the odd function definition.
/// @dev See https://en.wikipedia.org/wiki/Fractional_part.
/// @param x The UD60x18 number to get the fractional part of.
/// @param result The fractional part of x as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function frac(UD60x18 x) pure returns (UD60x18 result) {
    assembly ("memory-safe") {
        result := mod(x, uUNIT)
    }
}

/// @notice Calculates the geometric mean of x and y, i.e. $\sqrt{x * y}$, rounding down.
///
/// @dev Requirements:
/// - x * y must fit in UD60x18.
///
/// @param x The first operand as a UD60x18 number.
/// @param y The second operand as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function gm(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();
    uint256 yUint = y.unwrap();
    if (xUint == 0 || yUint == 0) {
        return ZERO;
    }

    unchecked {
        // Checking for overflow this way is faster than letting Solidity do it.
        uint256 xyUint = xUint * yUint;
        if (xyUint / xUint != yUint) {
            revert Errors.PRBMath_UD60x18_Gm_Overflow(x, y);
        }

        // We don't need to multiply the result by `UNIT` here because the x*y product picked up a factor of `UNIT`
        // during multiplication. See the comments in {Common.sqrt}.
        result = wrap(Common.sqrt(xyUint));
    }
}

/// @notice Calculates the inverse of x.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x must not be zero.
///
/// @param x The UD60x18 number for which to calculate the inverse.
/// @return result The inverse as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function inv(UD60x18 x) pure returns (UD60x18 result) {
    unchecked {
        result = wrap(uUNIT_SQUARED / x.unwrap());
    }
}

/// @notice Calculates the natural logarithm of x using the following formula:
///
/// $$
/// ln{x} = log_2{x} / log_2{e}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
/// - The precision isn't sufficiently fine-grained to return exactly `UNIT` when the input is `E`.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The UD60x18 number for which to calculate the natural logarithm.
/// @return result The natural logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function ln(UD60x18 x) pure returns (UD60x18 result) {
    unchecked {
        // Inline the fixed-point multiplication to save gas. This is overflow-safe because the maximum value that
        // {log2} can return is ~196_205294292027477728.
        result = wrap(log2(x).unwrap() * uUNIT / uLOG2_E);
    }
}

/// @notice Calculates the common logarithm of x using the following formula:
///
/// $$
/// log_{10}{x} = log_2{x} / log_2{10}
/// $$
///
/// However, if x is an exact power of ten, a hard coded value is returned.
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The UD60x18 number for which to calculate the common logarithm.
/// @return result The common logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function log10(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();
    if (xUint < uUNIT) {
        revert Errors.PRBMath_UD60x18_Log_InputTooSmall(x);
    }

    // Note that the `mul` in this assembly block is the standard multiplication operation, not {UD60x18.mul}.
    // prettier-ignore
    assembly ("memory-safe") {
        switch x
        case 1 { result := mul(uUNIT, sub(0, 18)) }
        case 10 { result := mul(uUNIT, sub(1, 18)) }
        case 100 { result := mul(uUNIT, sub(2, 18)) }
        case 1000 { result := mul(uUNIT, sub(3, 18)) }
        case 10000 { result := mul(uUNIT, sub(4, 18)) }
        case 100000 { result := mul(uUNIT, sub(5, 18)) }
        case 1000000 { result := mul(uUNIT, sub(6, 18)) }
        case 10000000 { result := mul(uUNIT, sub(7, 18)) }
        case 100000000 { result := mul(uUNIT, sub(8, 18)) }
        case 1000000000 { result := mul(uUNIT, sub(9, 18)) }
        case 10000000000 { result := mul(uUNIT, sub(10, 18)) }
        case 100000000000 { result := mul(uUNIT, sub(11, 18)) }
        case 1000000000000 { result := mul(uUNIT, sub(12, 18)) }
        case 10000000000000 { result := mul(uUNIT, sub(13, 18)) }
        case 100000000000000 { result := mul(uUNIT, sub(14, 18)) }
        case 1000000000000000 { result := mul(uUNIT, sub(15, 18)) }
        case 10000000000000000 { result := mul(uUNIT, sub(16, 18)) }
        case 100000000000000000 { result := mul(uUNIT, sub(17, 18)) }
        case 1000000000000000000 { result := 0 }
        case 10000000000000000000 { result := uUNIT }
        case 100000000000000000000 { result := mul(uUNIT, 2) }
        case 1000000000000000000000 { result := mul(uUNIT, 3) }
        case 10000000000000000000000 { result := mul(uUNIT, 4) }
        case 100000000000000000000000 { result := mul(uUNIT, 5) }
        case 1000000000000000000000000 { result := mul(uUNIT, 6) }
        case 10000000000000000000000000 { result := mul(uUNIT, 7) }
        case 100000000000000000000000000 { result := mul(uUNIT, 8) }
        case 1000000000000000000000000000 { result := mul(uUNIT, 9) }
        case 10000000000000000000000000000 { result := mul(uUNIT, 10) }
        case 100000000000000000000000000000 { result := mul(uUNIT, 11) }
        case 1000000000000000000000000000000 { result := mul(uUNIT, 12) }
        case 10000000000000000000000000000000 { result := mul(uUNIT, 13) }
        case 100000000000000000000000000000000 { result := mul(uUNIT, 14) }
        case 1000000000000000000000000000000000 { result := mul(uUNIT, 15) }
        case 10000000000000000000000000000000000 { result := mul(uUNIT, 16) }
        case 100000000000000000000000000000000000 { result := mul(uUNIT, 17) }
        case 1000000000000000000000000000000000000 { result := mul(uUNIT, 18) }
        case 10000000000000000000000000000000000000 { result := mul(uUNIT, 19) }
        case 100000000000000000000000000000000000000 { result := mul(uUNIT, 20) }
        case 1000000000000000000000000000000000000000 { result := mul(uUNIT, 21) }
        case 10000000000000000000000000000000000000000 { result := mul(uUNIT, 22) }
        case 100000000000000000000000000000000000000000 { result := mul(uUNIT, 23) }
        case 1000000000000000000000000000000000000000000 { result := mul(uUNIT, 24) }
        case 10000000000000000000000000000000000000000000 { result := mul(uUNIT, 25) }
        case 100000000000000000000000000000000000000000000 { result := mul(uUNIT, 26) }
        case 1000000000000000000000000000000000000000000000 { result := mul(uUNIT, 27) }
        case 10000000000000000000000000000000000000000000000 { result := mul(uUNIT, 28) }
        case 100000000000000000000000000000000000000000000000 { result := mul(uUNIT, 29) }
        case 1000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 30) }
        case 10000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 31) }
        case 100000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 32) }
        case 1000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 33) }
        case 10000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 34) }
        case 100000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 35) }
        case 1000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 36) }
        case 10000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 37) }
        case 100000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 38) }
        case 1000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 39) }
        case 10000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 40) }
        case 100000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 41) }
        case 1000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 42) }
        case 10000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 43) }
        case 100000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 44) }
        case 1000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 45) }
        case 10000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 46) }
        case 100000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 47) }
        case 1000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 48) }
        case 10000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 49) }
        case 100000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 50) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 51) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 52) }
        case 100000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 53) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 54) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 55) }
        case 100000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 56) }
        case 1000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 57) }
        case 10000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 58) }
        case 100000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 59) }
        default { result := uMAX_UD60x18 }
    }

    if (result.unwrap() == uMAX_UD60x18) {
        unchecked {
            // Inline the fixed-point division to save gas.
            result = wrap(log2(x).unwrap() * uUNIT / uLOG2_10);
        }
    }
}

/// @notice Calculates the binary logarithm of x using the iterative approximation algorithm:
///
/// $$
/// log_2{x} = n + log_2{y}, \text{ where } y = x*2^{-n}, \ y \in [1, 2)
/// $$
///
/// For $0 \leq x \lt 1$, the input is inverted:
///
/// $$
/// log_2{x} = -log_2{\frac{1}{x}}
/// $$
///
/// @dev See https://en.wikipedia.org/wiki/Binary_logarithm#Iterative_approximation
///
/// Notes:
/// - Due to the lossy precision of the iterative approximation, the results are not perfectly accurate to the last decimal.
///
/// Requirements:
/// - x must be greater than zero.
///
/// @param x The UD60x18 number for which to calculate the binary logarithm.
/// @return result The binary logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function log2(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();

    if (xUint < uUNIT) {
        revert Errors.PRBMath_UD60x18_Log_InputTooSmall(x);
    }

    unchecked {
        // Calculate the integer part of the logarithm.
        uint256 n = Common.msb(xUint / uUNIT);

        // This is the integer part of the logarithm as a UD60x18 number. The operation can't overflow because n
        // n is at most 255 and UNIT is 1e18.
        uint256 resultUint = n * uUNIT;

        // Calculate $y = x * 2^{-n}$.
        uint256 y = xUint >> n;

        // If y is the unit number, the fractional part is zero.
        if (y == uUNIT) {
            return wrap(resultUint);
        }

        // Calculate the fractional part via the iterative approximation.
        // The `delta >>= 1` part is equivalent to `delta /= 2`, but shifting bits is more gas efficient.
        uint256 DOUBLE_UNIT = 2e18;
        for (uint256 delta = uHALF_UNIT; delta > 0; delta >>= 1) {
            y = (y * y) / uUNIT;

            // Is y^2 >= 2e18 and so in the range [2e18, 4e18)?
            if (y >= DOUBLE_UNIT) {
                // Add the 2^{-m} factor to the logarithm.
                resultUint += delta;

                // Halve y, which corresponds to z/2 in the Wikipedia article.
                y >>= 1;
            }
        }
        result = wrap(resultUint);
    }
}

/// @notice Multiplies two UD60x18 numbers together, returning a new UD60x18 number.
///
/// @dev Uses {Common.mulDiv} to enable overflow-safe multiplication and division.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
///
/// @dev See the documentation in {Common.mulDiv18}.
/// @param x The multiplicand as a UD60x18 number.
/// @param y The multiplier as a UD60x18 number.
/// @return result The product as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function mul(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    result = wrap(Common.mulDiv18(x.unwrap(), y.unwrap()));
}

/// @notice Raises x to the power of y.
///
/// For $1 \leq x \leq \infty$, the following standard formula is used:
///
/// $$
/// x^y = 2^{log_2{x} * y}
/// $$
///
/// For $0 \leq x \lt 1$, since the unsigned {log2} is undefined, an equivalent formula is used:
///
/// $$
/// i = \frac{1}{x}
/// w = 2^{log_2{i} * y}
/// x^y = \frac{1}{w}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2} and {mul}.
/// - Returns `UNIT` for 0^0.
/// - It may not perform well with very small values of x. Consider using SD59x18 as an alternative.
///
/// Requirements:
/// - Refer to the requirements in {exp2}, {log2}, and {mul}.
///
/// @param x The base as a UD60x18 number.
/// @param y The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function pow(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();
    uint256 yUint = y.unwrap();

    // If both x and y are zero, the result is `UNIT`. If just x is zero, the result is always zero.
    if (xUint == 0) {
        return yUint == 0 ? UNIT : ZERO;
    }
    // If x is `UNIT`, the result is always `UNIT`.
    else if (xUint == uUNIT) {
        return UNIT;
    }

    // If y is zero, the result is always `UNIT`.
    if (yUint == 0) {
        return UNIT;
    }
    // If y is `UNIT`, the result is always x.
    else if (yUint == uUNIT) {
        return x;
    }

    // If x is greater than `UNIT`, use the standard formula.
    if (xUint > uUNIT) {
        result = exp2(mul(log2(x), y));
    }
    // Conversely, if x is less than `UNIT`, use the equivalent formula.
    else {
        UD60x18 i = wrap(uUNIT_SQUARED / xUint);
        UD60x18 w = exp2(mul(log2(i), y));
        result = wrap(uUNIT_SQUARED / w.unwrap());
    }
}

/// @notice Raises x (a UD60x18 number) to the power y (an unsigned basic integer) using the well-known
/// algorithm "exponentiation by squaring".
///
/// @dev See https://en.wikipedia.org/wiki/Exponentiation_by_squaring.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv18}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - The result must fit in UD60x18.
///
/// @param x The base as a UD60x18 number.
/// @param y The exponent as a uint256.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function powu(UD60x18 x, uint256 y) pure returns (UD60x18 result) {
    // Calculate the first iteration of the loop in advance.
    uint256 xUint = x.unwrap();
    uint256 resultUint = y & 1 > 0 ? xUint : uUNIT;

    // Equivalent to `for(y /= 2; y > 0; y /= 2)`.
    for (y >>= 1; y > 0; y >>= 1) {
        xUint = Common.mulDiv18(xUint, xUint);

        // Equivalent to `y % 2 == 1`.
        if (y & 1 > 0) {
            resultUint = Common.mulDiv18(resultUint, xUint);
        }
    }
    result = wrap(resultUint);
}

/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x must be less than `MAX_UD60x18 / UNIT`.
///
/// @param x The UD60x18 number for which to calculate the square root.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function sqrt(UD60x18 x) pure returns (UD60x18 result) {
    uint256 xUint = x.unwrap();

    unchecked {
        if (xUint > uMAX_UD60x18 / uUNIT) {
            revert Errors.PRBMath_UD60x18_Sqrt_Overflow(x);
        }
        // Multiply x by `UNIT` to account for the factor of `UNIT` picked up when multiplying two UD60x18 numbers.
        // In this case, the two numbers are both the square root.
        result = wrap(Common.sqrt(xUint * uUNIT));
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;

import "./Casting.sol" as Casting;
import "./Helpers.sol" as Helpers;
import "./Math.sol" as Math;

/// @notice The unsigned 60.18-decimal fixed-point number representation, which can have up to 60 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the Solidity type uint256.
/// @dev The value type is defined here so it can be imported in all other files.
type UD60x18 is uint256;

/*//////////////////////////////////////////////////////////////////////////
                                    CASTING
//////////////////////////////////////////////////////////////////////////*/

using {
    Casting.intoSD1x18,
    Casting.intoUD2x18,
    Casting.intoSD59x18,
    Casting.intoUint128,
    Casting.intoUint256,
    Casting.intoUint40,
    Casting.unwrap
} for UD60x18 global;

/*//////////////////////////////////////////////////////////////////////////
                            MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

// The global "using for" directive makes the functions in this library callable on the UD60x18 type.
using {
    Math.avg,
    Math.ceil,
    Math.div,
    Math.exp,
    Math.exp2,
    Math.floor,
    Math.frac,
    Math.gm,
    Math.inv,
    Math.ln,
    Math.log10,
    Math.log2,
    Math.mul,
    Math.pow,
    Math.powu,
    Math.sqrt
} for UD60x18 global;

/*//////////////////////////////////////////////////////////////////////////
                                HELPER FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

// The global "using for" directive makes the functions in this library callable on the UD60x18 type.
using {
    Helpers.add,
    Helpers.and,
    Helpers.eq,
    Helpers.gt,
    Helpers.gte,
    Helpers.isZero,
    Helpers.lshift,
    Helpers.lt,
    Helpers.lte,
    Helpers.mod,
    Helpers.neq,
    Helpers.not,
    Helpers.or,
    Helpers.rshift,
    Helpers.sub,
    Helpers.uncheckedAdd,
    Helpers.uncheckedSub,
    Helpers.xor
} for UD60x18 global;

/*//////////////////////////////////////////////////////////////////////////
                                    OPERATORS
//////////////////////////////////////////////////////////////////////////*/

// The global "using for" directive makes it possible to use these operators on the UD60x18 type.
using {
    Helpers.add as +,
    Helpers.and2 as &,
    Math.div as /,
    Helpers.eq as ==,
    Helpers.gt as >,
    Helpers.gte as >=,
    Helpers.lt as <,
    Helpers.lte as <=,
    Helpers.or as |,
    Helpers.mod as %,
    Math.mul as *,
    Helpers.neq as !=,
    Helpers.not as ~,
    Helpers.sub as -,
    Helpers.xor as ^
} for UD60x18 global;

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

import { IERC4906, IERC165 } from "@openzeppelin/contracts/interfaces/IERC4906.sol";
import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import { Ownable } from "solady/src/auth/Ownable.sol";
import { IVestingLockup, IERC721Metadata } from "../interfaces/IVestingLockup.sol";
import { IUnseenVestingNFTDescriptor } from "../interfaces/IUnseenVestingNFTDescriptor.sol";
import { Errors } from "../libraries/Errors.sol";
import { Lockup } from "../types/DataTypes.sol";

/**
 * @title  VestingLockup
 * @author decapitator (0xdecapitator.eth)
 * @notice Manages the creation and interaction of
 *         UnseenVesting schedules as ERC-721 (NFTs).
 *         It also provides functionality to cancel,
 *         withdraw from, and transfer these lockups.
 */
abstract contract VestingLockup is IERC4906, IVestingLockup, ERC721, Ownable {
    // The address of the original contract that was deployed.
    address private immutable ORIGINAL;

    // The next schedule id.
    uint256 public override nextScheduleId;

    /// @dev Contract that generates the non-fungible token URI.
    IUnseenVestingNFTDescriptor internal _nftDescriptor;

    /**
     * @notice Prevents delegate calls.
     */
    modifier noDelegateCall() {
        _preventDelegateCall();
        _;
    }

    /**
     * @notice Initializes the VestingLockup contract.
     * @param initialOwner The address of the initial contract owner.
     * @param initialNFTDescriptor The address of the initial
     *                             NFT descriptor.
     */
    constructor(
        address initialOwner,
        IUnseenVestingNFTDescriptor initialNFTDescriptor
    ) payable {
        ORIGINAL = address(this);

        if (address(initialNFTDescriptor) == address(0)) {
            revert Errors.NFTDescriptorIsZeroAddress();
        }

        _nftDescriptor = initialNFTDescriptor;

        if (initialOwner == address(0)) revert NewOwnerIsZeroAddress();

        _initializeOwner(initialOwner);
    }

    /**
     * @notice Checks that `scheduleId` does not reference
     *         a null schedule.
     * @param scheduleId The schedule id to check.
     */
    modifier notNull(uint256 scheduleId) {
        if (!isSchedule(scheduleId)) {
            revert Errors.Null(scheduleId);
        }
        _;
    }

    /**
     * @notice Retrieves the recipient of the schedule.
     * @param scheduleId The schedule id for the query.
     * @return recipient The address of the recipient.
     */
    function getRecipient(
        uint256 scheduleId
    ) external view override returns (address recipient) {
        _requireOwned({ tokenId: scheduleId });
        recipient = _ownerOf(scheduleId);
    }

    /**
     * @notice Checks if the schedule is cold (settled, canceled,
     *         or depleted).
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule is cold, false otherwise.
     */
    function isCold(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (bool result) {
        Lockup.Status status = _statusOf(scheduleId);
        result =
            status == Lockup.Status.SETTLED ||
            status == Lockup.Status.CANCELED ||
            status == Lockup.Status.DEPLETED;
    }

    /**
     * @notice Checks if the schedule is depleted.
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule is depleted,
     *                false otherwise.
     */
    function isDepleted(
        uint256 scheduleId
    ) public view virtual override returns (bool result);

    /**
     * @notice Checks if the schedule exists.
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule exists, false otherwise.
     */
    function isSchedule(
        uint256 scheduleId
    ) public view virtual override returns (bool result);

    /**
     * @notice Checks if the schedule is warm (pending or ongoing).
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule is warm, false otherwise.
     */
    function isWarm(
        uint256 scheduleId
    ) external view override notNull(scheduleId) returns (bool result) {
        Lockup.Status status = _statusOf(scheduleId);
        result =
            status == Lockup.Status.PENDING ||
            status == Lockup.Status.ONGOING;
    }

    /**
     * @notice Retrieves the URI for the given schedule.
     * @param scheduleId The schedule id for the query.
     * @return uri The URI string.
     */
    function tokenURI(
        uint256 scheduleId
    )
        public
        view
        override(IERC721Metadata, ERC721)
        returns (string memory uri)
    {
        _requireOwned({ tokenId: scheduleId });
        uri = _nftDescriptor.tokenURI({
            unseenVesting: address(this),
            scheduleId: scheduleId
        });
    }

    /**
     * @notice Checks if the schedule was canceled.
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule was canceled,
     *                false otherwise.
     */
    function wasCanceled(
        uint256 scheduleId
    ) public view virtual override returns (bool result);

    /**
     * @notice Retrieves the withdrawable amount from the schedule.
     * @param scheduleId The schedule id for the query.
     * @return withdrawableAmount The amount that can be withdrawn.
     */
    function withdrawableAmountOf(
        uint256 scheduleId
    )
        external
        view
        override
        notNull(scheduleId)
        returns (uint128 withdrawableAmount)
    {
        withdrawableAmount = _withdrawableAmountOf(scheduleId);
    }

    /**
     * @notice Checks if the schedule is transferable.
     * @param scheduleId The schedule id for the query.
     * @return result True if the schedule is transferable,
     *                false otherwise.
     */
    function isTransferable(
        uint256 scheduleId
    ) public view virtual returns (bool);

    /**
     * @notice Burns the NFT associated with the schedule.
     * @param scheduleId The id of the schedule NFT to burn.
     */
    function burn(uint256 scheduleId) external override noDelegateCall {
        if (!isDepleted(scheduleId)) {
            revert Errors.ScheduleNotDepleted(scheduleId);
        }

        if (!_isCallerScheduleRecipientOrApproved(scheduleId)) {
            revert Errors.Vesting_Unauthorized(scheduleId, msg.sender);
        }

        _burn({ tokenId: scheduleId });
    }

    /**
     * @notice Cancels the schedule and refunds any remaining
     *         uncn tokens to the sender.
     * @param scheduleId The id of the schedule to cancel.
     */
    function cancel(uint256 scheduleId) public override noDelegateCall {
        if (isDepleted(scheduleId)) {
            revert Errors.ScheduleDepleted(scheduleId);
        } else if (wasCanceled(scheduleId)) {
            revert Errors.ScheduleCanceled(scheduleId);
        }

        if (!_isCallerScheduleSender(scheduleId)) {
            revert Errors.Vesting_Unauthorized(scheduleId, msg.sender);
        }

        _cancel(scheduleId);
    }

    /**
     * @notice Cancels multiple schedules and refunds any remaining
     *         uncn tokens to the sender.
     * @param scheduleIds The ids of the schedules to cancel.
     */
    function cancelMultiple(
        uint256[] calldata scheduleIds
    ) external override noDelegateCall {
        uint256 count = scheduleIds.length;
        for (uint256 i; i < count; ) {
            cancel(scheduleIds[i]);
            unchecked {
                ++i;
            }
        }
    }

    /**
     * @notice Renounces the right of the schedule's sender to
     *         cancel the schedule.
     * @param scheduleId The id of the schedule to renounce.
     */
    function renounce(
        uint256 scheduleId
    ) external override noDelegateCall notNull(scheduleId) {
        Lockup.Status status = _statusOf(scheduleId);
        if (status == Lockup.Status.DEPLETED) {
            revert Errors.ScheduleDepleted(scheduleId);
        } else if (status == Lockup.Status.CANCELED) {
            revert Errors.ScheduleCanceled(scheduleId);
        } else if (status == Lockup.Status.SETTLED) {
            revert Errors.ScheduleSettled(scheduleId);
        }

        if (!_isCallerScheduleSender(scheduleId)) {
            revert Errors.Vesting_Unauthorized(scheduleId, msg.sender);
        }

        _renounce(scheduleId);
        emit IVestingLockup.RenounceLockupSchedule(scheduleId);

        emit MetadataUpdate({ _tokenId: scheduleId });
    }

    /**
     * @notice Sets a new NFT descriptor contract, which produces
     *         the URI describing the Unseen vesting schedule NFTs.
     * @param newNFTDescriptor The address of the new NFT descriptor contract.
     */
    function setNFTDescriptor(
        IUnseenVestingNFTDescriptor newNFTDescriptor
    ) external override onlyOwner {
        IUnseenVestingNFTDescriptor oldNftDescriptor = _nftDescriptor;
        _nftDescriptor = newNFTDescriptor;

        emit IVestingLockup.SetNFTDescriptor({
            admin: msg.sender,
            oldNFTDescriptor: oldNftDescriptor,
            newNFTDescriptor: newNFTDescriptor
        });

        emit BatchMetadataUpdate({
            _fromTokenId: 1,
            _toTokenId: nextScheduleId - 1
        });
    }

    /**
     * @notice Withdraws the provided amount of uncn tokens from the
     *         schedule to the `to` address.
     * @param scheduleId The id of the schedule to withdraw from.
     * @param to The address receiving the withdrawn uncn tokens.
     * @param amount The amount to withdraw, denoted in units of
     *               uncn's decimals.
     */
    function withdraw(
        uint256 scheduleId,
        address to,
        uint128 amount
    ) public override noDelegateCall {
        if (isDepleted(scheduleId)) {
            revert Errors.ScheduleDepleted(scheduleId);
        }

        if (to == address(0)) {
            revert Errors.WithdrawToZeroAddress();
        }

        if (amount == 0) {
            revert Errors.WithdrawAmountZero(scheduleId);
        }

        bool isCallerScheduleSender = _isCallerScheduleSender(scheduleId);

        if (
            !isCallerScheduleSender &&
            !_isCallerScheduleRecipientOrApproved(scheduleId)
        ) {
            revert Errors.Vesting_Unauthorized(scheduleId, msg.sender);
        }

        address recipient = _ownerOf(scheduleId);

        if (isCallerScheduleSender && to != recipient) {
            revert Errors.InvalidSenderWithdrawal(scheduleId, msg.sender, to);
        }

        uint128 withdrawableAmount = _withdrawableAmountOf(scheduleId);
        if (amount > withdrawableAmount) {
            revert Errors.Overdraw(scheduleId, amount, withdrawableAmount);
        }

        _withdraw(scheduleId, to, amount);

        emit MetadataUpdate({ _tokenId: scheduleId });
    }

    /**
     * @notice Withdraws the maximum withdrawable amount from the
     *         schedule to the provided address `to`.
     * @param scheduleId The id of the schedule to withdraw from.
     * @param to The address receiving the withdrawn uncn tokens.
     */
    function withdrawMax(uint256 scheduleId, address to) external override {
        withdraw({
            scheduleId: scheduleId,
            to: to,
            amount: _withdrawableAmountOf(scheduleId)
        });
    }

    /**
     * @notice Withdraws the maximum withdrawable amount from the
     *         schedule to the current recipient, and transfers the
     *         NFT to `newRecipient`.
     * @param scheduleId The id of the schedule NFT to transfer.
     * @param newRecipient The address of the new owner of the schedule
     *                     NFT.
     */
    function withdrawMaxAndTransfer(
        uint256 scheduleId,
        address newRecipient
    ) external override noDelegateCall notNull(scheduleId) {
        address currentRecipient = _ownerOf(scheduleId);
        if (msg.sender != currentRecipient) {
            revert Errors.Vesting_Unauthorized(scheduleId, msg.sender);
        }

        uint128 withdrawableAmount = _withdrawableAmountOf(scheduleId);
        if (withdrawableAmount > 0) {
            withdraw({
                scheduleId: scheduleId,
                to: currentRecipient,
                amount: withdrawableAmount
            });
        }

        _transfer({
            from: currentRecipient,
            to: newRecipient,
            tokenId: scheduleId
        });
    }

    /**
     * @notice Withdraws uncn tokens from schedules to the provided
     *         address `to`.
     * @param scheduleIds The ids of the schedules to withdraw from.
     * @param to The address receiving the withdrawn uncn tokens.
     * @param amounts The amounts to withdraw, denoted in units of
     *                uncn's decimals.
     */
    function withdrawMultiple(
        uint256[] calldata scheduleIds,
        address to,
        uint128[] calldata amounts
    ) external override noDelegateCall {
        uint256 scheduleIdsCount = scheduleIds.length;
        uint256 amountsCount = amounts.length;
        if (scheduleIdsCount != amountsCount) {
            revert Errors.WithdrawArrayCountsNotEqual(
                scheduleIdsCount,
                amountsCount
            );
        }

        for (uint256 i; i < scheduleIdsCount; ) {
            withdraw(scheduleIds[i], to, amounts[i]);
            unchecked {
                ++i;
            }
        }
    }

    /**
     * @dev This function checks whether the current call is a
     *      delegate call, and reverts if it is.
     */
    function _preventDelegateCall() private view {
        if (address(this) != ORIGINAL) {
            revert Errors.DelegateCall();
        }
    }

    /// @notice Overrides the {ERC-721._update} function to check that the schedule is transferable, and emits an
    /// ERC-4906 event.
    /// @dev There are two cases when the transferable flag is ignored:
    /// - If the current owner is 0, then the update is a mint and is allowed.
    /// - If `to` is 0, then the update is a burn and is also allowed.
    /// @param to The address of the new recipient of the schedule.
    /// @param scheduleId ID of the schedule to update.
    /// @param auth Optional parameter. If the value is not zero, the overridden implementation will check that
    /// `auth` is either the recipient of the schedule, or an approved third party.
    /// @return The original recipient of the `schedule` before the update.
    function _update(
        address to,
        uint256 scheduleId,
        address auth
    ) internal override returns (address) {
        address from = _ownerOf(scheduleId);

        if (
            from != address(0) &&
            to != address(0) &&
            !isTransferable(scheduleId)
        ) {
            revert Errors.NotTransferable(scheduleId);
        }

        // Emit an ERC-4906 event to trigger an update of the NFT metadata.
        emit MetadataUpdate({ _tokenId: scheduleId });

        return super._update(to, scheduleId, auth);
    }

    /**
     * @notice Returns whether the interface is supported.
     *
     * @param interfaceId The interface id to check against.
     */
    function supportsInterface(
        bytes4 interfaceId
    ) public view virtual override(IERC165, ERC721) returns (bool) {
        return
            interfaceId == bytes4(0x49064906) ||
            super.supportsInterface(interfaceId);
    }

    /**
     * @notice Checks whether `msg.sender` is the schedule's sender.
     * @param scheduleId The schedule id for the query.
     * @return True if `msg.sender` is the schedule's sender, false otherwise.
     */
    function _isCallerScheduleSender(
        uint256 scheduleId
    ) internal view virtual returns (bool);

    /**
     * @dev Checks if the caller is the sender of the schedule.
     * @param scheduleId The ID of the schedule.
     * @return True if the caller is approved.
     */
    function _isCallerScheduleRecipientOrApproved(
        uint256 scheduleId
    ) internal view virtual returns (bool);

    /**
     * @notice Retrieves the schedule's status without performing a
     *         null check.
     * @param scheduleId The schedule id for the query.
     * @return The status of the schedule.
     */
    function _statusOf(
        uint256 scheduleId
    ) internal view virtual returns (Lockup.Status);

    /**
     * @notice Calculates the amount that can be withdrawn from
     *         the schedule.
     * @param scheduleId The schedule id for the query.
     * @return The withdrawable amount.
     */
    function _withdrawableAmountOf(
        uint256 scheduleId
    ) internal view virtual returns (uint128);

    /**
     * @notice Cancels the schedule.
     * @param scheduleId The id of the schedule to cancel.
     */
    function _cancel(uint256 scheduleId) internal virtual;

    /**
     * @notice Renounces the right of the schedule's sender to cancel
     *         the schedule.
     * @param scheduleId The id of the schedule to renounce.
     */
    function _renounce(uint256 scheduleId) internal virtual;

    /**
     * @notice Withdraws uncn tokens from the schedule.
     * @param scheduleId The id of the schedule to withdraw from.
     * @param to The address receiving the withdrawn uncn tokens.
     * @param amount The amount to withdraw, denoted in units of
     *               uncn's decimals.
     */
    function _withdraw(
        uint256 scheduleId,
        address to,
        uint128 amount
    ) internal virtual;
}

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

import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { Lockup } from "../types/DataTypes.sol";
import { IVestingLockup } from "./IVestingLockup.sol";

/**
 * @title  IUnseenVesting
 * @author decapitator (0xdecapitator.eth)
 * @notice Creates and manages dynamic vesting schedules.
 */
interface IUnseenVesting is IVestingLockup {
    /**
     * @notice Emitted when a schedule is created.
     * @param scheduleId   The id of the newly created schedule.
     * @param funder       The address which has funded the schedule.
     * @param sender       The address from which to deposit uncn tokens,
     *                     who will have the ability to cancel the schedule.
     * @param recipient    The address toward which to vest the tokens.
     * @param amounts      The deposit amount, denoted in units of uncn's
     *                     decimals.
     * @param cancelable   Boolean indicating whether the schedule will be
     *                     cancelable or not.
     * @param transferable Boolean indicating whether the schedule NFT is
     *                     transferable or not.
     * @param segments     The segments the protocol uses to compose the
     *                     custom vesting curve.
     * @param range        Struct containing (i) the schedule's start time
     *                     and (ii) end time, both as Unix timestamps.
     */
    event CreateSchedule(
        uint256 scheduleId,
        address funder,
        address indexed sender,
        address indexed recipient,
        uint256 amounts,
        bool cancelable,
        bool transferable,
        Lockup.Segment[] segments,
        Lockup.Range range
    );

    /**
     * @notice The maximum number of segments allowed in a schedule.
     * @dev This is initialized at construction time and cannot be changed later.
     */
    function MAX_SEGMENT_COUNT() external view returns (uint256);

    /**
     * @notice Retrieves the schedule's range, which is a struct
     *         containing (i) the schedule's start time and (ii)
     *         end time, both as Unix timestamps.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId The schedule id for the query.
     */
    function getRange(
        uint256 scheduleId
    ) external view returns (Lockup.Range memory range);

    /**
     * @notice Retrieves the segments the protocol uses to compose
     *         the custom vesting curve.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId The schedule id for the query.
     */
    function getSegments(
        uint256 scheduleId
    ) external view returns (Lockup.Segment[] memory segments);

    /**
     * @notice Retrieves the schedule entity.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId The schedule id for the query.
     */
    function getSchedule(
        uint256 scheduleId
    ) external view returns (Lockup.Schedule memory schedule);

    /**
     * @notice Calculates the amount vested to the recipient,
     *         denoted in units of uncn's decimals.
     *         When the schedule is warm, the vesting function is:
     *         f(x) = x^{exp} * csa + \Sigma(esa)
     *         Where:
     *         - $x$ is the elapsed time divided by the total time
     *           in the current segment.
     *         - $exp$ is the current segment exponent.
     *         - $csa$ is the current segment amount.
     *         - $\Sigma(esa)$ is the sum of all elapsed segments' amounts.
     *         Upon cancellation of the schedule, the amount vested is calculated
     *         as the difference between the deposited amount and the refunded amount.
     *         Ultimately, when the schedule becomes depleted, the vested amount
     *         is equivalent to the total amount withdrawn.
     *
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId The schedule id for the query.
     */
    function vestedAmountOf(
        uint256 scheduleId
    ) external view returns (uint128 vestedAmount);

    /**
     * @notice Creates a schedule with the provided segment milestones,
     *         implying the end time from the last milestone.
     *         The schedule is funded by `msg.sender` and is wrapped
     *         in an ERC-721 NFT.
     *         Notes:
     *         - As long as the segment milestones are arranged in ascending
     *           order, it is not an error for some of them to be in the past.
     *         Requirements:
     *         - Must not be delegate called.
     *         -`params.totalAmount` must be greater than zero.
     *         -`params.segments` must have at least one segment,
     *           but not more than `MAX_SEGMENT_COUNT`.
     *         -`params.startTime` must be less than the first segment's milestone.
     *         - The segment milestones must be arranged in ascending order.
     *         - The last segment milestone (i.e. the schedule's end time)
     *           must be in the future.
     *         - The sum of the segment amounts must equal the deposit amount.
     *         -`params.recipient` must not be the zero address.
     *         -`msg.sender` must have allowed this contract to spend at
     *           least `params.totalAmount` of uncn tokens.
     *
     * @dev    Emits a {Transfer} and {CreateSchedule} event.
     * @param  params Struct encapsulating the function parameters,
     *         which are documented in {DataTypes}.
     * @return scheduleId The id of the newly created schedule.
     */
    function createSchedule(
        Lockup.CreateSchedule calldata params
    ) external returns (uint256 scheduleId);

    /**
     * @notice Batch Create schedules using createMultiSchedules.
     *         Requirements::
     *         - There must be at least one element in `schedulesParams`.
     *         - All requirements from {IUnseenVesting.createSchedule}
     *           must be met for each schedule.
     * @param  schedulesParams An array of structs, each encapsulating
     *         a subset of the parameters of
     *         {UnseenVesting.createMultiSchedules}.
     * @return scheduleIds The ids of the newly created schedules.
     */
    function createMultiSchedules(
        Lockup.CreateSchedule[] calldata schedulesParams
    ) external returns (uint256[] memory scheduleIds);
}

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

/**
 * @title  IUnseenVestingNFTDescriptor
 * @author decapitator (0xdecapitator.eth)
 * @notice This contract generates the URI describing
 *         Unseen vesting schedules NFTs.
 */
interface IUnseenVestingNFTDescriptor {
    /**
     * @notice Produces the URI describing a particular
     *         schedule NFT.
     * @param unseenVesting The address of the UnseenVesting
     *                      contract the schedule was created in.
     * @param scheduleId    The id of the schedule for which to
     *                      produce a description.
     * @return uri The URI of the ERC721-compliant metadata.
     */
    function tokenURI(
        address unseenVesting,
        uint256 scheduleId
    ) external view returns (string memory uri);
}

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

import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
import { Lockup } from "../types/DataTypes.sol";
import { IUnseenVestingNFTDescriptor } from "./IUnseenVestingNFTDescriptor.sol";

/**
 * @title  IVestingLockup
 * @author decapitator (0xdecapitator.eth)
 * @notice Interface for Vesting Lockup Contract
 */
interface IVestingLockup is IERC721Metadata {
    /**
     * @notice Emitted when a schedule is canceled.
     * @param  scheduleId       The id of the schedule.
     * @param  sender           The address of the schedule's sender.
     * @param  recipient        The address of the schedule's recipient.
     * @param  senderAmount     The amount of uncn refunded to the schedule's
     *                          sender, denoted in units of uncn's decimals.
     * @param  recipientAmount  The amount of uncn left for the schedule's
     *                          recipient to withdraw, denoted in units of
     *                          uncn's decimals.
     */
    event CancelLockupSchedule(
        uint256 scheduleId,
        address indexed sender,
        address indexed recipient,
        uint128 senderAmount,
        uint128 recipientAmount
    );

    /**
     * @notice Emitted when a sender gives up the right to cancel a schedule.
     * @param  scheduleId  The id of the schedule.
     */
    event RenounceLockupSchedule(uint256 indexed scheduleId);

    /**
     * @notice Emitted when the admin sets a new NFT descriptor contract.
     * @param  admin             The address of the current contract admin.
     * @param  oldNFTDescriptor  The address of the old NFT descriptor contract.
     * @param  newNFTDescriptor  The address of the new NFT descriptor contract.
     */
    event SetNFTDescriptor(
        address indexed admin,
        IUnseenVestingNFTDescriptor oldNFTDescriptor,
        IUnseenVestingNFTDescriptor newNFTDescriptor
    );

    /**
     * @notice Emitted when uncn tokens are withdrawn from a schedule.
     * @param  scheduleId  The id of the schedule.
     * @param  to          The address that has received the withdrawn uncn
     *                     tokens.
     * @param  amount      The amount of uncn tokens withdrawn, denoted in units
     *                     of uncn's decimals.
     */
    event WithdrawFromLockupSchedule(
        uint256 indexed scheduleId,
        address indexed to,
        uint128 amount
    );

    /**
     * @notice Retrieves Unseen vested token.
     * @return The IERC20 instance of the Unseen vested token.
     */
    function UNCN() external view returns (IERC20);

    /**
     * @notice Retrieves the amount deposited in the schedule, denoted in units
     *         of uncn's decimals.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return depositedAmount The amount deposited.
     */
    function getDepositedAmount(
        uint256 scheduleId
    ) external view returns (uint128 depositedAmount);

    /**
     * @notice Retrieves the schedule's end time, which is a Unix timestamp.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return endTime The end time.
     */
    function getEndTime(
        uint256 scheduleId
    ) external view returns (uint40 endTime);

    /**
     * @notice Retrieves the schedule's recipient.
     * @dev    Reverts if the NFT has been burned.
     * @param  scheduleId  The schedule id for the query.
     * @return recipient The recipient address.
     */
    function getRecipient(
        uint256 scheduleId
    ) external view returns (address recipient);

    /**
     * @notice Retrieves the amount refunded to the sender after a cancellation,
     *         denoted in units of uncn's decimals. This amount is always zero
     *         unless the schedule was canceled.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return refundedAmount The refunded amount.
     */
    function getRefundedAmount(
        uint256 scheduleId
    ) external view returns (uint128 refundedAmount);

    /**
     * @notice Retrieves the schedule's sender.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return sender The sender address.
     */
    function getSender(
        uint256 scheduleId
    ) external view returns (address sender);

    /**
     * @notice Retrieves the schedule's start time, which is a Unix timestamp.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return startTime The start time.
     */
    function getStartTime(
        uint256 scheduleId
    ) external view returns (uint40 startTime);

    /**
     * @notice Retrieves the amount withdrawn from the schedule, denoted in
     *         units of uncn's decimals.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return withdrawnAmount The withdrawn amount.
     */
    function getWithdrawnAmount(
        uint256 scheduleId
    ) external view returns (uint128 withdrawnAmount);

    /**
     * @notice Retrieves a flag indicating whether the schedule can be canceled.
     *         When the schedule is cold, this flag is always `false`.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The cancelable flag.
     */
    function isCancelable(
        uint256 scheduleId
    ) external view returns (bool result);

    /**
     * @notice Retrieves a flag indicating whether the schedule is cold, i.e.
     *         settled, canceled, or depleted.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The cold flag.
     */
    function isCold(uint256 scheduleId) external view returns (bool result);

    /**
     * @notice Retrieves a flag indicating whether the schedule is depleted.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The depleted flag.
     */
    function isDepleted(uint256 scheduleId) external view returns (bool result);

    /**
     * @notice Retrieves a flag indicating whether the schedule exists.
     * @dev    Does not revert if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The exists flag.
     */
    function isSchedule(uint256 scheduleId) external view returns (bool result);

    /**
     * @notice Retrieves a flag indicating whether the schedule NFT can be
     *         transferred.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The transferable flag.
     */
    function isTransferable(
        uint256 scheduleId
    ) external view returns (bool result);

    /**
     * @notice Retrieves a flag indicating whether the schedule is warm, i.e.
     *         either pending or vesting.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The warm flag.
     */
    function isWarm(uint256 scheduleId) external view returns (bool result);

    /**
     * @notice Counter for schedule ids, used in the create functions.
     * @return The next schedule id.
     */
    function nextScheduleId() external view returns (uint256);

    /**
     * @notice Calculates the amount that the sender would be refunded if the
     *         schedule were canceled, denoted in units of uncn's decimals.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return refundableAmount The refundable amount.
     */
    function refundableAmountOf(
        uint256 scheduleId
    ) external view returns (uint128 refundableAmount);

    /**
     * @notice Retrieves the schedule's status.
     * @param  scheduleId  The schedule id for the query.
     * @return status The schedule status.
     */
    function statusOf(
        uint256 scheduleId
    ) external view returns (Lockup.Status status);

    /**
     * @notice Calculates the amount vested to the recipient, denoted in units
     *         of uncn's decimals.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return vestedAmount The vested amount.
     */
    function vestedAmountOf(
        uint256 scheduleId
    ) external view returns (uint128 vestedAmount);

    /**
     * @notice Retrieves a flag indicating whether the schedule was canceled.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return result The canceled flag.
     */
    function wasCanceled(
        uint256 scheduleId
    ) external view returns (bool result);

    /**
     * @notice Calculates the amount that the recipient can withdraw from the
     *         schedule, denoted in units of uncn's decimals.
     * @dev    Reverts if `scheduleId` references a null schedule.
     * @param  scheduleId  The schedule id for the query.
     * @return withdrawableAmount The withdrawable amount.
     */
    function withdrawableAmountOf(
        uint256 scheduleId
    ) external view returns (uint128 withdrawableAmount);

    /**
     * @notice Burns the NFT associated with the schedule.
     * @dev    Emits a {Transfer} event.
     *         Requirements:
     *         - Must not be delegate called.
     *         - `scheduleId` must reference a depleted schedule.
     *         - The NFT must exist.
     *         - `msg.sender` must be either the NFT owner or an approved third
     *           party.
     * @param  scheduleId  The id of the schedule NFT to burn.
     */
    function burn(uint256 scheduleId) external;

    /**
     * @notice Cancels the schedule and refunds any remaining uncn tokens to the
     *         sender.
     * @dev    Emits a {Transfer}, {CancelLockupSchedule}, and {MetadataUpdate}
     *         event.
     *         Notes:
     *         - If there any uncn tokens left for the recipient to withdraw,
     *           the schedule is marked as canceled. Otherwise, the schedule is
     *           marked as depleted.
     *         - This function attempts to invoke a hook on the recipient, if
     *           the resolved address is a contract.
     *         Requirements:
     *         - Must not be delegate called.
     *         - The schedule must be warm and cancelable.
     *         - `msg.sender` must be the schedule's sender.
     * @param  scheduleId  The id of the schedule to cancel.
     */
    function cancel(uint256 scheduleId) external;

    /**
     * @notice Cancels multiple schedules and refunds any remaining uncn tokens
     *         to the sender.
     * @dev    Emits multiple {Transfer}, {CancelLockupSchedule}, and
     *         {MetadataUpdate} events.
     *         Notes:
     *         - Refer to the notes in {cancel}.
     *         Requirements:
     *         - All requirements from {cancel} must be met for each schedule.
     * @param  scheduleIds  The ids of the schedules to cancel.
     */
    function cancelMultiple(uint256[] calldata scheduleIds) external;

    /**
     * @notice Removes the right of the schedule's sender to cancel the
     *         schedule.
     * @dev    Emits a {RenounceLockupSchedule} and {MetadataUpdate} event.
     *         Notes:
     *         - This is an irreversible operation.
     *         - This function attempts to invoke a hook on the schedule's
     *           recipient, provided that the recipient is a contract.
     *         Requirements:
     *         - Must not be delegate called.
     *         - `scheduleId` must reference a warm schedule.
     *         - `msg.sender` must be the schedule's sender.
     *         - The schedule must be cancelable.
     * @param  scheduleId  The id of the schedule to renounce.
     */
    function renounce(uint256 scheduleId) external;

    /**
     * @notice Sets a new NFT descriptor contract, which produces the URI
     *         describing the Unseen vesting schedule NFTs.
     * @dev    Emits a {SetNFTDescriptor} and {BatchMetadataUpdate} event.
     *         Notes:
     *         - Does not revert if the NFT descriptor is the same.
     *         Requirements:
     *         - `msg.sender` must be the contract admin.
     * @param  newNFTDescriptor  The address of the new NFT descriptor contract.
     */
    function setNFTDescriptor(
        IUnseenVestingNFTDescriptor newNFTDescriptor
    ) external;

    /**
     * @notice Withdraws the provided amount of uncn tokens from the schedule to
     *         the `to` address.
     * @dev    Emits a {Transfer}, {WithdrawFromLockupSchedule}, and
     *         {MetadataUpdate} event.
     *         Notes:
     *         - This function attempts to invoke a hook on the schedule's
     *           recipient, provided that the recipient is a contract and
     *           `msg.sender` is either the sender or an approved operator.
     *         Requirements:
     *         - Must not be delegate called.
     *         - `scheduleId` must not reference a null or depleted schedule.
     *         - `msg.sender` must be the schedule's sender, the schedule's
     *           recipient or an approved third party.
     *         - `to` must be the recipient if `msg.sender` is the schedule's
     *           sender.
     *         - `to` must not be the zero address.
     *         - `amount` must be greater than zero and must not exceed the
     *           withdrawable amount.
     * @param  scheduleId  The id of the schedule to withdraw from.
     * @param  to          The address receiving the withdrawn uncn tokens.
     * @param  amount      The amount to withdraw, denoted in units of uncn's
     *                     decimals.
     */
    function withdraw(uint256 scheduleId, address to, uint128 amount) external;

    /**
     * @notice Withdraws the maximum withdrawable amount from the schedule to
     *         the provided address `to`.
     * @dev    Emits a {Transfer}, {WithdrawFromLockupSchedule}, and
     *         {MetadataUpdate} event.
     *         Notes:
     *         - Refer to the notes in {withdraw}.
     *         Requirements:
     *         - Refer to the requirements in {withdraw}.
     * @param  scheduleId  The id of the schedule to withdraw from.
     * @param  to          The address receiving the withdrawn uncn tokens.
     */
    function withdrawMax(uint256 scheduleId, address to) external;

    /**
     * @notice Withdraws the maximum withdrawable amount from the schedule to
     *         the current recipient, and transfers the NFT to `newRecipient`.
     * @dev    Emits a {WithdrawFromLockupSchedule} and a {Transfer} event.
     *         Notes:
     *         - If the withdrawable amount is zero, the withdrawal is skipped.
     *         - Refer to the notes in {withdraw}.
     *         Requirements:
     *         - `msg.sender` must be the schedule's recipient.
     *         - Refer to the requirements in {withdraw}.
     *         - Refer to the requirements in {IERC721.transferFrom}.
     * @param  scheduleId      The id of the schedule NFT to transfer.
     * @param  newRecipient    The address of the new owner of the schedule NFT.
     */
    function withdrawMaxAndTransfer(
        uint256 scheduleId,
        address newRecipient
    ) external;

    /**
     * @notice Withdraws uncn tokens from schedules to the provided address `to`.
     * @dev    Emits multiple {Transfer}, {WithdrawFromLockupSchedule}, and
     *         {MetadataUpdate} events.
     *         Notes:
     *         - This function attempts to call a hook on the recipient of each
     *           schedule, unless `msg.sender` is the recipient.
     *         Requirements:
     *         - All requirements from {withdraw} must be met for each schedule.
     *         - There must be an equal number of `scheduleIds` and `amounts`.
     * @param  scheduleIds  The ids of the schedules to withdraw from.
     * @param  to           The address receiving the withdrawn uncn tokens.
     * @param  amounts      The amounts to withdraw, denoted in units of uncn's
     *                      decimals.
     */
    function withdrawMultiple(
        uint256[] calldata scheduleIds,
        address to,
        uint128[] calldata amounts
    ) external;
}

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

import { UD60x18 } from "@prb/math/src/UD60x18.sol";

/**
 * @title  Errors
 * @notice Library containing all custom errors
 *         the protocol may revert with.
 */
library Errors {
    /**
     * @notice Thrown when trying to delegate call
     *         to a function that disallows delegate calls.
     */
    error DelegateCall();

    /**
     * @notice Thrown when trying to create a schedule with a
     *         zero deposit amount.
     */
    error DepositAmountZero();

    /**
     * @notice Thrown when trying to create a schedule with
     *         an end time not in the future.
     */
    error EndTimeNotInTheFuture(uint40 currentTime, uint40 endTime);

    /**
     * @notice Thrown when the schedule's sender tries
     *         to withdraw to an address other than the recipient's.
     */
    error InvalidSenderWithdrawal(
        uint256 scheduleId,
        address sender,
        address to
    );

    /**
     * @notice Thrown when trying to transfer schedule NFT
     *         when transferability is disabled.
     */
    error NotTransferable(uint256 tokenId);

    /**
     * @notice Thrown when the id references a null schedule.
     */
    error Null(uint256 scheduleId);

    /**
     * @notice Thrown when trying to withdraw an amount
     *         greater than the withdrawable amount.
     */
    error Overdraw(
        uint256 scheduleId,
        uint128 amount,
        uint128 withdrawableAmount
    );

    /**
     * @notice Thrown when trying to cancel or renounce
     *         a canceled schedule.
     */
    error ScheduleCanceled(uint256 scheduleId);

    /**
     * @notice Thrown when trying to cancel, renounce,
     *         or withdraw from a depleted schedule.
     */
    error ScheduleDepleted(uint256 scheduleId);

    /**
     * @notice Thrown when trying to cancel or renounce
     *         a schedule that is not cancelable.
     */
    error ScheduleNotCancelable(uint256 scheduleId);

    /**
     * @notice Thrown when trying to burn a schedule that is not depleted.
     */
    error ScheduleNotDepleted(uint256 scheduleId);

    /**
     * @notice Thrown when trying to cancel or renounce a settled schedule.
     */
    error ScheduleSettled(uint256 scheduleId);

    /**
     * @notice Thrown when `msg.sender` lacks authorization to perform an action.
     */
    error Vesting_Unauthorized(uint256 scheduleId, address caller);

    /**
     * @notice Thrown when trying to withdraw zero uncn tokens from a schedule.
     */
    error WithdrawAmountZero(uint256 scheduleId);

    /**
     * @notice Thrown when trying to withdraw from multiple
     *         schedules and the number of schedule ids does
     *         not match the number of withdraw amounts.
     */
    error WithdrawArrayCountsNotEqual(
        uint256 scheduleIdsCount,
        uint256 amountsCount
    );

    /**
     * @notice Thrown when trying to withdraw to the zero address.
     */
    error WithdrawToZeroAddress();

    /**
     * @notice Thrown when trying to create a schedule with a
     *         deposit amount not equal to the sum of the
     *         segment amounts.
     */
    error DepositAmountNotEqualToSegmentAmountsSum(
        uint128 depositAmount,
        uint128 segmentAmountsSum
    );

    /**
     * @notice Thrown when trying to create a schedule with
     *         more segments than the maximum allowed.
     */
    error SegmentCountTooHigh(uint256 count);

    /**
     * @notice Thrown when trying to create a schedule with no segments.
     */
    error SegmentCountMismatch();

    /**
     * @notice Thrown when trying to create a schedule with
     *         unordered segment milestones.
     */
    error SegmentMilestonesNotOrdered(
        uint256 index,
        uint40 previousMilestone,
        uint40 currentMilestone
    );

    /**
     * @notice Thrown when trying to create a schedule with
     *         a start time not strictly less than the first
     *         segment milestone.
     */
    error StartTimeNotLessThanFirstSegmentMilestone(
        uint40 startTime,
        uint40 firstSegmentMilestone
    );

    /**
     * @notice Thrown when NFTDescriptor address is zero.
     */
    error NFTDescriptorIsZeroAddress();

    /**
     * @notice Thrown when the batch size for creating schedules is zero.
     */
    error BatchSizeZero();

    /**
     * @notice Thrown when uncn token address is zero.
     */
    error UNCNIsZeroAddress();
}

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

import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
import { Lockup } from "../types/DataTypes.sol";
import { Errors } from "./Errors.sol";

/// @title Helpers
/// @notice Library with helper functions needed across the UnseenVesting contracts.
library Helpers {
    /// @dev Checks the parameters of the {UnseenVesting-_createSchedule} function.
    function checkCreateSchedule(
        uint128 depositAmount,
        Lockup.Segment[] memory segments,
        uint256 maxSegmentCount,
        uint40 startTime
    ) internal view {
        // Checks: the deposit amount is not zero.
        if (depositAmount == 0) {
            revert Errors.DepositAmountZero();
        }

        // Checks: the segment count is not zero.
        uint256 segmentCount = segments.length;
        if (segmentCount == 0) {
            revert Errors.SegmentCountMismatch();
        }

        // Checks: the segment count is not greater than the maximum allowed.
        if (segmentCount > maxSegmentCount) {
            revert Errors.SegmentCountTooHigh(segmentCount);
        }

        // Checks: requirements of segments variables.
        _checkSegments(segments, depositAmount, startTime);
    }

    /// @dev Checks that:
    ///
    /// 1. The first milestone is strictly greater than the start time.
    /// 2. The milestones are ordered chronologically.
    /// 3. There are no duplicate milestones.
    /// 4. The deposit amount is equal to the sum of all segment amounts.
    function _checkSegments(
        Lockup.Segment[] memory segments,
        uint128 depositAmount,
        uint40 startTime
    ) private view {
        // Checks: the start time is strictly less than the first segment milestone.
        if (startTime >= segments[0].milestone) {
            revert Errors.StartTimeNotLessThanFirstSegmentMilestone(
                startTime,
                segments[0].milestone
            );
        }

        // Pre-declare the variables needed in the for loop.
        uint128 segmentAmountsSum;
        uint40 currentMilestone;
        uint40 previousMilestone;

        // Iterate over the segments to:
        //
        // 1. Calculate the sum of all segment amounts.
        // 2. Check that the milestones are ordered.
        uint256 count = segments.length;
        for (uint256 i; i < count; ) {
            // Add the current segment amount to the sum.
            segmentAmountsSum += segments[i].amount;

            // Checks: the current milestone is strictly greater than the previous milestone.
            currentMilestone = segments[i].milestone;
            if (currentMilestone <= previousMilestone) {
                revert Errors.SegmentMilestonesNotOrdered(
                    i,
                    previousMilestone,
                    currentMilestone
                );
            }

            // Make the current milestone the previous milestone of the next loop iteration.
            previousMilestone = currentMilestone;

            // Increment the loop iterator.
            unchecked {
                ++i;
            }
        }

        // Checks: the last milestone is in the future.
        // When the loop exits, the current milestone is the last milestone, i.e. the schedule's end time.
        uint40 currentTime = uint40(block.timestamp);
        if (currentTime >= currentMilestone) {
            revert Errors.EndTimeNotInTheFuture(currentTime, currentMilestone);
        }

        // Checks: the deposit amount is equal to the segment amounts sum.
        if (depositAmount != segmentAmountsSum) {
            revert Errors.DepositAmountNotEqualToSegmentAmountsSum(
                depositAmount,
                segmentAmountsSum
            );
        }
    }
}

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

import { UD2x18 } from "@prb/math/src/UD2x18.sol";

/**
 * @dev Structs used in UnseenVesting.
 */
library Lockup {
    /**
     * @dev Struct encapsulating the deposit, withdrawn,
     *      and refunded amounts, all denoted in units
     *      of uncn's decimals.
     */
    struct Amounts {
        // Initial amount deposited in the schedule, net of fees.
        uint128 deposited;
        // Cumulative amount withdrawn from the schedule.
        uint128 withdrawn;
        // Amount refunded to the sender. Unless the schedule was canceled, this is always zero.
        uint128 refunded;
    }

    /**
     * @dev Enum representing the different statuses of a schedule.
     */
    enum Status {
        PENDING, // Schedule created but not started; tokens are in a pending state.
        ONGOING, // Active schedule where tokens are currently being vested.
        SETTLED, // All tokens have been vested; recipient is due to withdraw them.
        CANCELED, // Canceled schedule; remaining tokens await recipient's withdrawal.
        DEPLETED // Depleted schedule; all tokens have been withdrawn and/or refunded.
    }

    /**
     * @dev Struct encapsulating the parameters for {UnseenVesting.createSchedule}
     *      function.
     */
    struct CreateSchedule {
        // Address creating the schedule, with the ability to cancel it.
        address sender;
        // Unix timestamp indicating the schedule's start.
        uint40 startTime;
        // Indicates if the schedule is cancelable.
        bool cancelable;
        // Address receiving uncn tokens.
        address recipient;
        // Indicates if the schedule NFT is transferable.
        bool transferable;
        // Total amount of uncn tokens to be paid.
        uint128 totalAmount;
        // Segments used to compose the custom vesting curve.
        Segment[] segments;
    }

    /**
     * @dev Struct encapsulating the time range.
     */
    struct Range {
        // Unix timestamp indicating the schedule's start.
        uint40 start;
        // Unix timestamp indicating the schedule's end.
        uint40 end;
    }

    /**
     * @dev Segment struct used in the Lockup Dynamic schedule.
     */
    struct Segment {
        // Amount of tokens to be vested in this segment, denoted in units of uncn's decimals.
        uint128 amount;
        // Exponent of this segment, denoted as a fixed-point number.
        UD2x18 exponent;
        // Unix timestamp indicating this segment's end.
        uint40 milestone;
    }

    /**
     * @dev Vesting Schedule.
     */
    struct Schedule {
        // Address creating the schedule, with the ability to cancel it.
        address sender;
        // Unix timestamp indicating the schedule's start.
        uint40 startTime;
        // Unix timestamp indicating the schedule's end.
        uint40 endTime;
        // Boolean indicating if the schedule is cancelable.
        bool isCancelable;
        // Boolean indicating if the schedule was canceled.
        bool wasCanceled;
        // Boolean indicating if the schedule is depleted.
        bool isDepleted;
        // Boolean indicating if the struct entity exists.
        bool isSchedule;
        // Boolean indicating if the schedule NFT is transferable.
        bool isTransferable;
        // Struct containing the deposit, withdrawn, and refunded amounts, all denoted in units of uncn's decimals.
        Amounts amounts;
        // Segments used to compose the custom vesting curve.
        Segment[] segments;
    }
}

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

/// @notice Simple single owner authorization mixin.
/// @author Solady (https://github.com/vectorized/solady/blob/main/src/auth/Ownable.sol)
///
/// @dev Note:
/// This implementation does NOT auto-initialize the owner to `msg.sender`.
/// You MUST call the `_initializeOwner` in the constructor / initializer.
///
/// While the ownable portion follows
/// [EIP-173](https://eips.ethereum.org/EIPS/eip-173) for compatibility,
/// the nomenclature for the 2-step ownership handover may be unique to this codebase.
abstract contract Ownable {
    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                       CUSTOM ERRORS                        */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev The caller is not authorized to call the function.
    error Unauthorized();

    /// @dev The `newOwner` cannot be the zero address.
    error NewOwnerIsZeroAddress();

    /// @dev The `pendingOwner` does not have a valid handover request.
    error NoHandoverRequest();

    /// @dev Cannot double-initialize.
    error AlreadyInitialized();

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                           EVENTS                           */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev The ownership is transferred from `oldOwner` to `newOwner`.
    /// This event is intentionally kept the same as OpenZeppelin's Ownable to be
    /// compatible with indexers and [EIP-173](https://eips.ethereum.org/EIPS/eip-173),
    /// despite it not being as lightweight as a single argument event.
    event OwnershipTransferred(address indexed oldOwner, address indexed newOwner);

    /// @dev An ownership handover to `pendingOwner` has been requested.
    event OwnershipHandoverRequested(address indexed pendingOwner);

    /// @dev The ownership handover to `pendingOwner` has been canceled.
    event OwnershipHandoverCanceled(address indexed pendingOwner);

    /// @dev `keccak256(bytes("OwnershipTransferred(address,address)"))`.
    uint256 private constant _OWNERSHIP_TRANSFERRED_EVENT_SIGNATURE =
        0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0;

    /// @dev `keccak256(bytes("OwnershipHandoverRequested(address)"))`.
    uint256 private constant _OWNERSHIP_HANDOVER_REQUESTED_EVENT_SIGNATURE =
        0xdbf36a107da19e49527a7176a1babf963b4b0ff8cde35ee35d6cd8f1f9ac7e1d;

    /// @dev `keccak256(bytes("OwnershipHandoverCanceled(address)"))`.
    uint256 private constant _OWNERSHIP_HANDOVER_CANCELED_EVENT_SIGNATURE =
        0xfa7b8eab7da67f412cc9575ed43464468f9bfbae89d1675917346ca6d8fe3c92;

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                          STORAGE                           */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev The owner slot is given by:
    /// `bytes32(~uint256(uint32(bytes4(keccak256("_OWNER_SLOT_NOT")))))`.
    /// It is intentionally chosen to be a high value
    /// to avoid collision with lower slots.
    /// The choice of manual storage layout is to enable compatibility
    /// with both regular and upgradeable contracts.
    bytes32 internal constant _OWNER_SLOT =
        0xffffffffffffffffffffffffffffffffffffffffffffffffffffffff74873927;

    /// The ownership handover slot of `newOwner` is given by:
    /// ```
    ///     mstore(0x00, or(shl(96, user), _HANDOVER_SLOT_SEED))
    ///     let handoverSlot := keccak256(0x00, 0x20)
    /// ```
    /// It stores the expiry timestamp of the two-step ownership handover.
    uint256 private constant _HANDOVER_SLOT_SEED = 0x389a75e1;

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                     INTERNAL FUNCTIONS                     */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Override to return true to make `_initializeOwner` prevent double-initialization.
    function _guardInitializeOwner() internal pure virtual returns (bool guard) {}

    /// @dev Initializes the owner directly without authorization guard.
    /// This function must be called upon initialization,
    /// regardless of whether the contract is upgradeable or not.
    /// This is to enable generalization to both regular and upgradeable contracts,
    /// and to save gas in case the initial owner is not the caller.
    /// For performance reasons, this function will not check if there
    /// is an existing owner.
    function _initializeOwner(address newOwner) internal virtual {
        if (_guardInitializeOwner()) {
            /// @solidity memory-safe-assembly
            assembly {
                let ownerSlot := _OWNER_SLOT
                if sload(ownerSlot) {
                    mstore(0x00, 0x0dc149f0) // `AlreadyInitialized()`.
                    revert(0x1c, 0x04)
                }
                // Clean the upper 96 bits.
                newOwner := shr(96, shl(96, newOwner))
                // Store the new value.
                sstore(ownerSlot, or(newOwner, shl(255, iszero(newOwner))))
                // Emit the {OwnershipTransferred} event.
                log3(0, 0, _OWNERSHIP_TRANSFERRED_EVENT_SIGNATURE, 0, newOwner)
            }
        } else {
            /// @solidity memory-safe-assembly
            assembly {
                // Clean the upper 96 bits.
                newOwner := shr(96, shl(96, newOwner))
                // Store the new value.
                sstore(_OWNER_SLOT, newOwner)
                // Emit the {OwnershipTransferred} event.
                log3(0, 0, _OWNERSHIP_TRANSFERRED_EVENT_SIGNATURE, 0, newOwner)
            }
        }
    }

    /// @dev Sets the owner directly without authorization guard.
    function _setOwner(address newOwner) internal virtual {
        if (_guardInitializeOwner()) {
            /// @solidity memory-safe-assembly
            assembly {
                let ownerSlot := _OWNER_SLOT
                // Clean the upper 96 bits.
                newOwner := shr(96, shl(96, newOwner))
                // Emit the {OwnershipTransferred} event.
                log3(0, 0, _OWNERSHIP_TRANSFERRED_EVENT_SIGNATURE, sload(ownerSlot), newOwner)
                // Store the new value.
                sstore(ownerSlot, or(newOwner, shl(255, iszero(newOwner))))
            }
        } else {
            /// @solidity memory-safe-assembly
            assembly {
                let ownerSlot := _OWNER_SLOT
                // Clean the upper 96 bits.
                newOwner := shr(96, shl(96, newOwner))
                // Emit the {OwnershipTransferred} event.
                log3(0, 0, _OWNERSHIP_TRANSFERRED_EVENT_SIGNATURE, sload(ownerSlot), newOwner)
                // Store the new value.
                sstore(ownerSlot, newOwner)
            }
        }
    }

    /// @dev Throws if the sender is not the owner.
    function _checkOwner() internal view virtual {
        /// @solidity memory-safe-assembly
        assembly {
            // If the caller is not the stored owner, revert.
            if iszero(eq(caller(), sload(_OWNER_SLOT))) {
                mstore(0x00, 0x82b42900) // `Unauthorized()`.
                revert(0x1c, 0x04)
            }
        }
    }

    /// @dev Returns how long a two-step ownership handover is valid for in seconds.
    /// Override to return a different value if needed.
    /// Made internal to conserve bytecode. Wrap it in a public function if needed.
    function _ownershipHandoverValidFor() internal view virtual returns (uint64) {
        return 48 * 3600;
    }

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                  PUBLIC UPDATE FUNCTIONS                   */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Allows the owner to transfer the ownership to `newOwner`.
    function transferOwnership(address newOwner) public payable virtual onlyOwner {
        /// @solidity memory-safe-assembly
        assembly {
            if iszero(shl(96, newOwner)) {
                mstore(0x00, 0x7448fbae) // `NewOwnerIsZeroAddress()`.
                revert(0x1c, 0x04)
            }
        }
        _setOwner(newOwner);
    }

    /// @dev Allows the owner to renounce their ownership.
    function renounceOwnership() public payable virtual onlyOwner {
        _setOwner(address(0));
    }

    /// @dev Request a two-step ownership handover to the caller.
    /// The request will automatically expire in 48 hours (172800 seconds) by default.
    function requestOwnershipHandover() public payable virtual {
        unchecked {
            uint256 expires = block.timestamp + _ownershipHandoverValidFor();
            /// @solidity memory-safe-assembly
            assembly {
                // Compute and set the handover slot to `expires`.
                mstore(0x0c, _HANDOVER_SLOT_SEED)
                mstore(0x00, caller())
                sstore(keccak256(0x0c, 0x20), expires)
                // Emit the {OwnershipHandoverRequested} event.
                log2(0, 0, _OWNERSHIP_HANDOVER_REQUESTED_EVENT_SIGNATURE, caller())
            }
        }
    }

    /// @dev Cancels the two-step ownership handover to the caller, if any.
    function cancelOwnershipHandover() public payable virtual {
        /// @solidity memory-safe-assembly
        assembly {
            // Compute and set the handover slot to 0.
            mstore(0x0c, _HANDOVER_SLOT_SEED)
            mstore(0x00, caller())
            sstore(keccak256(0x0c, 0x20), 0)
            // Emit the {OwnershipHandoverCanceled} event.
            log2(0, 0, _OWNERSHIP_HANDOVER_CANCELED_EVENT_SIGNATURE, caller())
        }
    }

    /// @dev Allows the owner to complete the two-step ownership handover to `pendingOwner`.
    /// Reverts if there is no existing ownership handover requested by `pendingOwner`.
    function completeOwnershipHandover(address pendingOwner) public payable virtual onlyOwner {
        /// @solidity memory-safe-assembly
        assembly {
            // Compute and set the handover slot to 0.
            mstore(0x0c, _HANDOVER_SLOT_SEED)
            mstore(0x00, pendingOwner)
            let handoverSlot := keccak256(0x0c, 0x20)
            // If the handover does not exist, or has expired.
            if gt(timestamp(), sload(handoverSlot)) {
                mstore(0x00, 0x6f5e8818) // `NoHandoverRequest()`.
                revert(0x1c, 0x04)
            }
            // Set the handover slot to 0.
            sstore(handoverSlot, 0)
        }
        _setOwner(pendingOwner);
    }

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                   PUBLIC READ FUNCTIONS                    */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Returns the owner of the contract.
    function owner() public view virtual returns (address result) {
        /// @solidity memory-safe-assembly
        assembly {
            result := sload(_OWNER_SLOT)
        }
    }

    /// @dev Returns the expiry timestamp for the two-step ownership handover to `pendingOwner`.
    function ownershipHandoverExpiresAt(address pendingOwner)
        public
        view
        virtual
        returns (uint256 result)
    {
        /// @solidity memory-safe-assembly
        assembly {
            // Compute the handover slot.
            mstore(0x0c, _HANDOVER_SLOT_SEED)
            mstore(0x00, pendingOwner)
            // Load the handover slot.
            result := sload(keccak256(0x0c, 0x20))
        }
    }

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                         MODIFIERS                          */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Marks a function as only callable by the owner.
    modifier onlyOwner() virtual {
        _checkOwner();
        _;
    }
}

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

/// @notice Reentrancy guard mixin.
/// @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/ReentrancyGuard.sol)
abstract contract ReentrancyGuard {
    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                       CUSTOM ERRORS                        */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Unauthorized reentrant call.
    error Reentrancy();

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                          STORAGE                           */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Equivalent to: `uint72(bytes9(keccak256("_REENTRANCY_GUARD_SLOT")))`.
    /// 9 bytes is large enough to avoid collisions with lower slots,
    /// but not too large to result in excessive bytecode bloat.
    uint256 private constant _REENTRANCY_GUARD_SLOT = 0x929eee149b4bd21268;

    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
    /*                      REENTRANCY GUARD                      */
    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

    /// @dev Guards a function from reentrancy.
    modifier nonReentrant() virtual {
        /// @solidity memory-safe-assembly
        assembly {
            if eq(sload(_REENTRANCY_GUARD_SLOT), address()) {
                mstore(0x00, 0xab143c06) // `Reentrancy()`.
                revert(0x1c, 0x04)
            }
            sstore(_REENTRANCY_GUARD_SLOT, address())
        }
        _;
        /// @solidity memory-safe-assembly
        assembly {
            sstore(_REENTRANCY_GUARD_SLOT, codesize())
        }
    }

    /// @dev Guards a view function from read-only reentrancy.
    modifier nonReadReentrant() virtual {
        /// @solidity memory-safe-assembly
        assembly {
            if eq(sload(_REENTRANCY_GUARD_SLOT), address()) {
                mstore(0x00, 0xab143c06) // `Reentrancy()`.
                revert(0x1c, 0x04)
            }
        }
        _;
    }
}

{
  "viaIR": true,
  "optimizer": {
    "enabled": true,
    "runs": 200
  },
  "evmVersion": "paris",
  "outputSelection": {
    "*": {
      "*": [
        "evm.bytecode",
        "evm.deployedBytecode",
        "devdoc",
        "userdoc",
        "metadata",
        "abi"
      ]
    }
  },
  "metadata": {
    "useLiteralContent": true
  },
  "libraries": {}
}

• Certik - Aug 6th, 2024 - Security Audit Report

[{"inputs":[{"internalType":"address","name":"initialOwner","type":"address"},{"internalType":"contract IUnseenVestingNFTDescriptor","name":"initialNFTDescriptor","type":"address"},{"internalType":"uint256","name":"maxSegmentCount","type":"uint256"},{"internalType":"address","name":"uncn","type":"address"}],"stateMutability":"payable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"AddressInsufficientBalance","type":"error"},{"inputs":[],"name":"AlreadyInitialized","type":"error"},{"inputs":[],"name":"BatchSizeZero","type":"error"},{"inputs":[],"name":"DelegateCall","type":"error"},{"inputs":[{"internalType":"uint128","name":"depositAmount","type":"uint128"},{"internalType":"uint128","name":"segmentAmountsSum","type":"uint128"}],"name":"DepositAmountNotEqualToSegmentAmountsSum","type":"error"},{"inputs":[],"name":"DepositAmountZero","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"address","name":"owner","type":"address"}],"name":"ERC721IncorrectOwner","type":"error"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ERC721InsufficientApproval","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC721InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"operator","type":"address"}],"name":"ERC721InvalidOperator","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"ERC721InvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC721InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC721InvalidSender","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ERC721NonexistentToken","type":"error"},{"inputs":[{"internalType":"uint40","name":"currentTime","type":"uint40"},{"internalType":"uint40","name":"endTime","type":"uint40"}],"name":"EndTimeNotInTheFuture","type":"error"},{"inputs":[],"name":"FailedInnerCall","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"to","type":"address"}],"name":"InvalidSenderWithdrawal","type":"error"},{"inputs":[],"name":"NFTDescriptorIsZeroAddress","type":"error"},{"inputs":[],"name":"NewOwnerIsZeroAddress","type":"error"},{"inputs":[],"name":"NoHandoverRequest","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"NotTransferable","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"Null","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint128","name":"withdrawableAmount","type":"uint128"}],"name":"Overdraw","type":"error"},{"inputs":[{"internalType":"uint256","name":"x","type":"uint256"},{"internalType":"uint256","name":"y","type":"uint256"}],"name":"PRBMath_MulDiv18_Overflow","type":"error"},{"inputs":[{"internalType":"uint256","name":"x","type":"uint256"},{"internalType":"uint256","name":"y","type":"uint256"},{"internalType":"uint256","name":"denominator","type":"uint256"}],"name":"PRBMath_MulDiv_Overflow","type":"error"},{"inputs":[],"name":"PRBMath_SD59x18_Div_InputTooSmall","type":"error"},{"inputs":[{"internalType":"SD59x18","name":"x","type":"int256"},{"internalType":"SD59x18","name":"y","type":"int256"}],"name":"PRBMath_SD59x18_Div_Overflow","type":"error"},{"inputs":[{"internalType":"SD59x18","name":"x","type":"int256"}],"name":"PRBMath_SD59x18_Exp2_InputTooBig","type":"error"},{"inputs":[{"internalType":"SD59x18","name":"x","type":"int256"}],"name":"PRBMath_SD59x18_IntoUint256_Underflow","type":"error"},{"inputs":[{"internalType":"SD59x18","name":"x","type":"int256"}],"name":"PRBMath_SD59x18_Log_InputTooSmall","type":"error"},{"inputs":[],"name":"PRBMath_SD59x18_Mul_InputTooSmall","type":"error"},{"inputs":[{"internalType":"SD59x18","name":"x","type":"int256"},{"internalType":"SD59x18","name":"y","type":"int256"}],"name":"PRBMath_SD59x18_Mul_Overflow","type":"error"},{"inputs":[],"name":"Reentrancy","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"ScheduleCanceled","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"ScheduleDepleted","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"ScheduleNotCancelable","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"ScheduleNotDepleted","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"ScheduleSettled","type":"error"},{"inputs":[],"name":"SegmentCountMismatch","type":"error"},{"inputs":[{"internalType":"uint256","name":"count","type":"uint256"}],"name":"SegmentCountTooHigh","type":"error"},{"inputs":[{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint40","name":"previousMilestone","type":"uint40"},{"internalType":"uint40","name":"currentMilestone","type":"uint40"}],"name":"SegmentMilestonesNotOrdered","type":"error"},{"inputs":[{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"uint40","name":"firstSegmentMilestone","type":"uint40"}],"name":"StartTimeNotLessThanFirstSegmentMilestone","type":"error"},{"inputs":[],"name":"UNCNIsZeroAddress","type":"error"},{"inputs":[],"name":"Unauthorized","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"address","name":"caller","type":"address"}],"name":"Vesting_Unauthorized","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"WithdrawAmountZero","type":"error"},{"inputs":[{"internalType":"uint256","name":"scheduleIdsCount","type":"uint256"},{"internalType":"uint256","name":"amountsCount","type":"uint256"}],"name":"WithdrawArrayCountsNotEqual","type":"error"},{"inputs":[],"name":"WithdrawToZeroAddress","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"approved","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_fromTokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"_toTokenId","type":"uint256"}],"name":"BatchMetadataUpdate","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"scheduleId","type":"uint256"},{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint128","name":"senderAmount","type":"uint128"},{"indexed":false,"internalType":"uint128","name":"recipientAmount","type":"uint128"}],"name":"CancelLockupSchedule","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"scheduleId","type":"uint256"},{"indexed":false,"internalType":"address","name":"funder","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint256","name":"amounts","type":"uint256"},{"indexed":false,"internalType":"bool","name":"cancelable","type":"bool"},{"indexed":false,"internalType":"bool","name":"transferable","type":"bool"},{"components":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"UD2x18","name":"exponent","type":"uint64"},{"internalType":"uint40","name":"milestone","type":"uint40"}],"indexed":false,"internalType":"struct Lockup.Segment[]","name":"segments","type":"tuple[]"},{"components":[{"internalType":"uint40","name":"start","type":"uint40"},{"internalType":"uint40","name":"end","type":"uint40"}],"indexed":false,"internalType":"struct Lockup.Range","name":"range","type":"tuple"}],"name":"CreateSchedule","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"MetadataUpdate","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"pendingOwner","type":"address"}],"name":"OwnershipHandoverCanceled","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"pendingOwner","type":"address"}],"name":"OwnershipHandoverRequested","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"oldOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"RenounceLockupSchedule","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"admin","type":"address"},{"indexed":false,"internalType":"contract IUnseenVestingNFTDescriptor","name":"oldNFTDescriptor","type":"address"},{"indexed":false,"internalType":"contract IUnseenVestingNFTDescriptor","name":"newNFTDescriptor","type":"address"}],"name":"SetNFTDescriptor","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"scheduleId","type":"uint256"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint128","name":"amount","type":"uint128"}],"name":"WithdrawFromLockupSchedule","type":"event"},{"inputs":[],"name":"MAX_SEGMENT_COUNT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UNCN","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"cancel","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"scheduleIds","type":"uint256[]"}],"name":"cancelMultiple","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"cancelOwnershipHandover","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"pendingOwner","type":"address"}],"name":"completeOwnershipHandover","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"bool","name":"cancelable","type":"bool"},{"internalType":"address","name":"recipient","type":"address"},{"internalType":"bool","name":"transferable","type":"bool"},{"internalType":"uint128","name":"totalAmount","type":"uint128"},{"components":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"UD2x18","name":"exponent","type":"uint64"},{"internalType":"uint40","name":"milestone","type":"uint40"}],"internalType":"struct Lockup.Segment[]","name":"segments","type":"tuple[]"}],"internalType":"struct Lockup.CreateSchedule[]","name":"schedulesParams","type":"tuple[]"}],"name":"createMultiSchedules","outputs":[{"internalType":"uint256[]","name":"scheduleIds","type":"uint256[]"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"bool","name":"cancelable","type":"bool"},{"internalType":"address","name":"recipient","type":"address"},{"internalType":"bool","name":"transferable","type":"bool"},{"internalType":"uint128","name":"totalAmount","type":"uint128"},{"components":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"UD2x18","name":"exponent","type":"uint64"},{"internalType":"uint40","name":"milestone","type":"uint40"}],"internalType":"struct Lockup.Segment[]","name":"segments","type":"tuple[]"}],"internalType":"struct Lockup.CreateSchedule","name":"params","type":"tuple"}],"name":"createSchedule","outputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getDepositedAmount","outputs":[{"internalType":"uint128","name":"depositedAmount","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getEndTime","outputs":[{"internalType":"uint40","name":"endTime","type":"uint40"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getRange","outputs":[{"components":[{"internalType":"uint40","name":"start","type":"uint40"},{"internalType":"uint40","name":"end","type":"uint40"}],"internalType":"struct Lockup.Range","name":"range","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getRecipient","outputs":[{"internalType":"address","name":"recipient","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getRefundedAmount","outputs":[{"internalType":"uint128","name":"refundedAmount","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getSchedule","outputs":[{"components":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"uint40","name":"endTime","type":"uint40"},{"internalType":"bool","name":"isCancelable","type":"bool"},{"internalType":"bool","name":"wasCanceled","type":"bool"},{"internalType":"bool","name":"isDepleted","type":"bool"},{"internalType":"bool","name":"isSchedule","type":"bool"},{"internalType":"bool","name":"isTransferable","type":"bool"},{"components":[{"internalType":"uint128","name":"deposited","type":"uint128"},{"internalType":"uint128","name":"withdrawn","type":"uint128"},{"internalType":"uint128","name":"refunded","type":"uint128"}],"internalType":"struct Lockup.Amounts","name":"amounts","type":"tuple"},{"components":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"UD2x18","name":"exponent","type":"uint64"},{"internalType":"uint40","name":"milestone","type":"uint40"}],"internalType":"struct Lockup.Segment[]","name":"segments","type":"tuple[]"}],"internalType":"struct Lockup.Schedule","name":"schedule","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getSegments","outputs":[{"components":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"UD2x18","name":"exponent","type":"uint64"},{"internalType":"uint40","name":"milestone","type":"uint40"}],"internalType":"struct Lockup.Segment[]","name":"segments","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getSender","outputs":[{"internalType":"address","name":"sender","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getStartTime","outputs":[{"internalType":"uint40","name":"startTime","type":"uint40"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"getWithdrawnAmount","outputs":[{"internalType":"uint128","name":"withdrawnAmount","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isCancelable","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isCold","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isDepleted","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isSchedule","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isTransferable","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"isWarm","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"nextScheduleId","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"result","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"pendingOwner","type":"address"}],"name":"ownershipHandoverExpiresAt","outputs":[{"internalType":"uint256","name":"result","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"refundableAmountOf","outputs":[{"internalType":"uint128","name":"refundableAmount","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"renounce","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"requestOwnershipHandover","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract IUnseenVestingNFTDescriptor","name":"newNFTDescriptor","type":"address"}],"name":"setNFTDescriptor","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"statusOf","outputs":[{"internalType":"enum Lockup.Status","name":"status","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"uri","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"vestedAmountOf","outputs":[{"internalType":"uint128","name":"vestedAmount","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"wasCanceled","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"address","name":"to","type":"address"}],"name":"withdrawMax","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"},{"internalType":"address","name":"newRecipient","type":"address"}],"name":"withdrawMaxAndTransfer","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"scheduleIds","type":"uint256[]"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint128[]","name":"amounts","type":"uint128[]"}],"name":"withdrawMultiple","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"scheduleId","type":"uint256"}],"name":"withdrawableAmountOf","outputs":[{"internalType":"uint128","name":"withdrawableAmount","type":"uint128"}],"stateMutability":"view","type":"function"}]

60e0604052614f49608081380391826100178161047f565b93849283398101031261047a5761002d816104a4565b60208201516001600160a01b03811692919083900361047a576100576060604084015193016104a4565b92610062604061047f565b600e81526d554e5345454e2056455354494e4760901b6020820152610087604061047f565b600c81526b554e434e2d56455354494e4760a01b6020820152815190916001600160401b03821161037a5760005490600182811c92168015610470575b602083101461035a5781601f849311610401575b50602090601f831160011461039b57600092610390575b50508160011b916000199060031b1c1916176000555b8051906001600160401b03821161037a5760015490600182811c92168015610370575b602083101461035a5781601f8493116102ea575b50602090601f831160011461028257600092610277575b50508160011b916000199060031b1c1916176001555b30608052801561026657600780546001600160a01b0319169190911790556001600160a01b031680156102555780638b78c6d8195560007f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08180a3600481106102445760a05260016006556001600160a01b031680156102335760c052604051614a9090816104b9823960805181612f9a015260a051818181611175015261315e015260c0518181816112ff015281816118f801528181611daa01528181612b3201526133c00152f35b6367f6aa1160e01b60005260046000fd5b63ac5eb09360e01b60005260046000fd5b633a247dd760e11b60005260046000fd5b630201c48960e61b60005260046000fd5b015190503880610153565b600160009081528281209350601f198516905b8181106102d257509084600195949392106102b9575b505050811b01600155610169565b015160001960f88460031b161c191690553880806102ab565b92936020600181928786015181550195019301610295565b60016000529091507fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c81019160208510610350575b90601f859493920160051c01905b818110610341575061013c565b60008155849350600101610334565b9091508190610326565b634e487b7160e01b600052602260045260246000fd5b91607f1691610128565b634e487b7160e01b600052604160045260246000fd5b0151905038806100ef565b60008080528281209350601f198516905b8181106103e957509084600195949392106103d0575b505050811b01600055610105565b015160001960f88460031b161c191690553880806103c2565b929360206001819287860151815501950193016103ac565b600080529091507f290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563601f840160051c81019160208510610466575b90601f859493920160051c01905b81811061045757506100d8565b6000815584935060010161044a565b909150819061043c565b91607f16916100c4565b600080fd5b6040519190601f01601f191682016001600160401b0381118382101761037a57604052565b51906001600160a01b038216820361047a5756fe608080604052600436101561001357600080fd5b60003560e01c90816301ffc9a7146121d35750806306fdde0314612118578063081812fc146120fa578063095ea7b31461200b5780630f038d4114611fed5780631400ecec14611f305780631c1cdd4c14611ec457806323b872dd14611ead5780632569296214611e615780633a568f6b14611e2e57806340e58ee514611bfb578063425d30dd14611bdd57806342842e0e14611bad57806342966c6814611a2d5780634744a6e7146119eb5780634857501f1461196f57806354d1f13d146119275780635dcb6a03146118e25780636352211e146118b25780636d0cee751461187457806370a082311461181e578063715018a6146117d25780637cad6cd1146116fd5780637de6b1db1461159f5780638659c270146112c25780638da5cb5b146112955780638f69b993146111f15780639067b677146111985780639188ec841461115d57806395d89b41146110515780639faeb28614610fcd578063a22cb46514610f2c578063a2ffb89714610e58578063a80fc07114610dfd578063ac7a0a1414610cac578063ad35efd414610c43578063b256456914610c25578063b637b86514610bbf578063b88d4fde14610b2c578063b971302a14610ad5578063bc2be1be14610a7c578063c156a11d14610954578063c5ca93a714610707578063c87b56dd146105ed578063cc364f481461054a578063d4dbd20b146104ef578063d511609f1461049a578063d975dfed14610433578063e985e9c5146103d8578063ea5ead19146103aa578063f04e283e1461035a578063f2fde38b1461031e578063f590c176146102f6578063fdd46d60146102b45763fee81cf41461027c57600080fd5b346102af5760203660031901126102af576102956122a0565b63389a75e1600c52600052602080600c2054604051908152f35b600080fd5b346102af5760603660031901126102af576102cd6122b6565b6044356001600160801b03811681036102af576102f4916102ec612f98565b600435612c48565b005b346102af5760203660031901126102af57602061031460043561299a565b6040519015158152f35b60203660031901126102af576103326122a0565b61033a6130cd565b8060601b1561034c576102f4906130ea565b637448fbae6000526004601cfd5b60203660031901126102af5761036e6122a0565b6103766130cd565b63389a75e1600c52806000526020600c20908154421161039c5760006102f492556130ea565b636f5e88186000526004601cfd5b346102af5760403660031901126102af576102f46004356103c96122b6565b6103d282613883565b916129d1565b346102af5760403660031901126102af576103f16122a0565b6103f96122b6565b9060018060a01b0316600052600560205260406000209060018060a01b0316600052602052602060ff604060002054166040519015158152f35b346102af5760203660031901126102af5760043561046581600052600860205260ff60016040600020015460081c1690565b1561048657610475602091613883565b6001600160801b0360405191168152f35b633ba03f1160e11b60005260045260246000fd5b346102af5760203660031901126102af576004356104cc81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602060026040600020015460801c604051908152f35b346102af5760203660031901126102af5760043561052181600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260206001600160801b0360036040600020015416604051908152f35b346102af5760203660031901126102af576004356000602060405161056e816123c6565b828152015261059181600052600860205260ff60016040600020015460081c1690565b1561048657600090815260086020526040908190205481519064ffffffffff60c882901c81169160a01c166105c5836123c6565b825260208201526105eb8251809264ffffffffff60208092828151168552015116910152565bf35b346102af5760203660031901126102af57610647600060043561060f81612cfa565b5060075460405163e9dc637560e01b81523060048201526024810192909252909283916001600160a01b031690829081906044820190565b03915afa9081156106fb57600091610674575b604051602080825281906106709082018561227b565b0390f35b3d8083833e610683818361242e565b8101906020818303126106f3578051906001600160401b0382116106f7570181601f820112156106f3578051926106b98461244f565b926106c7604051948561242e565b848452602085840101116106f05750610670926106ea9160208085019101612258565b9061065a565b80fd5b8280fd5b8380fd5b6040513d6000823e3d90fd5b346102af5760203660031901126102af57600435606061012060405161072c81612412565b60008152600060208201526000604082015260008382015260006080820152600060a0820152600060c0820152600060e082015260405161076c816123f7565b60008152600060208201526000604082015261010082015201526000906107a781600052600860205260ff60016040600020015460081c1690565b156109425760ff9080835260086020526040832060e0604051938480936107cd82612412565b80549060018060a01b0382168352602083019864ffffffffff8360a01c168a52604084019064ffffffffff8460c81c168252600261087a61086c600460608901968a8960f01c161515885260808a019860f81c151589528a60018201549c8b60a08f9d019c8d8482161515905260c082019e8f9160081c1615159052019c60101c1615158c52610100610861868301612968565b9d019c8d52016128df565b9a6101208d019b8c52612db9565b61088381612357565b1461093a575b50604051998a9960208b52600160a01b6001900390511660208b01525164ffffffffff1660408a01525164ffffffffff166060890152511515608088015251151560a087015251151560c086015251151560e08501525115156101008401525180516001600160801b031661012084015260208101516001600160801b0316610140840152604001516001600160801b031661016083015251610180820161018090526101a0820161067091612361565b82528a610889565b633ba03f1160e11b8252600452602490fd5b346102af5760403660031901126102af576004356109706122b6565b90610979612f98565b61099781600052600860205260ff60016040600020015460081c1690565b15610486576000818152600260205260409020546001600160a01b03169133839003610a5f576109c682613883565b6001600160801b038116610a4e575b506001600160a01b03811615610a38576001600160a01b03906109f9908390612e55565b169182610a155750637e27328960e01b60005260045260246000fd5b808303610a1e57005b6364283d7b60e01b60005260045260245260445260646000fd5b633250574960e11b600052600060045260246000fd5b610a599084846129d1565b836109d5565b5063021b128760e61b600090815260049190915233602452604490fd5b346102af5760203660031901126102af57600435610aae81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602064ffffffffff60406000205460a01c16604051908152f35b346102af5760203660031901126102af57600435610b0781600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602060018060a01b0360406000205416604051908152f35b346102af5760803660031901126102af57610b456122a0565b610b4d6122b6565b90604435606435926001600160401b0384116102af57366023850112156102af57836004013592610b7d8461244f565b93610b8b604051958661242e565b80855236602482880101116102af5760208160009260246102f499018389013786010152610bba8383836124c3565b613783565b346102af5760203660031901126102af57600435610bf181600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052610670610c1160046040600020016128df565b604051918291602083526020830190612361565b346102af5760203660031901126102af5760206103146004356128a2565b346102af5760203660031901126102af57600435610c7581600052600860205260ff60016040600020015460081c1690565b1561048657610c8390612db9565b6040516005821015610c96576020918152f35b634e487b7160e01b600052602160045260246000fd5b346102af5760203660031901126102af576004356001600160401b0381116102af57610cdc90369060040161231a565b610ce4612f98565b3068929eee149b4bd212685414610def573068929eee149b4bd2126855610d096130cd565b8015610dde57610d188161271b565b610d25604051918261242e565b818152610d318261271b565b6020820190601f19013682373684900360de19019060005b84811015610d8d5760008160051b87013590848212156106f0575090610d7c610d7760019336908a01612732565b613128565b610d86828761288e565b5201610d49565b81843868929eee149b4bd21268556040519182916020830190602084525180915260408301919060005b818110610dc5575050500390f35b8251845285945060209384019390920191600101610db7565b6301960e9560e11b60005260046000fd5b63ab143c066000526004601cfd5b346102af5760203660031901126102af57600435610e2f81600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260206001600160801b0360026040600020015416604051908152f35b346102af5760603660031901126102af576004356001600160401b0381116102af57610e8890369060040161231a565b610e906122b6565b916044356001600160401b0381116102af57610eb090369060040161231a565b929091610ebb612f98565b838203610f135760005b828110610ece57005b610ed98184846126e3565b3590610ee68187876126e3565b35916001600160801b03831683036102af5760019288610f0d92610f08612f98565b612c48565b01610ec5565b8382630516dbf160e01b60005260045260245260446000fd5b346102af5760403660031901126102af57610f456122a0565b602435908115158092036102af576001600160a01b0316908115610fb857336000526005602052604060002082600052602052604060002060ff1981541660ff83161790556040519081527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3160203392a3005b50630b61174360e31b60005260045260246000fd5b346102af5760203660031901126102af576004356001600160401b0381116102af5760e060031982360301126102af57611005612f98565b3068929eee149b4bd212685414610def5761103d610d776020923068929eee149b4bd21268556110336130cd565b3690600401612732565b3868929eee149b4bd2126855604051908152f35b346102af5760003660031901126102af5760405160006001548060011c90600181168015611153575b60208310811461113f5782855290811561111b57506001146110bb575b610670836110a78185038261242e565b60405191829160208352602083019061227b565b91905060016000527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6916000905b808210611101575090915081016020016110a7611097565b9192600181602092548385880101520191019092916110e9565b60ff191660208086019190915291151560051b840190910191506110a79050611097565b634e487b7160e01b84526022600452602484fd5b91607f169161107a565b346102af5760003660031901126102af5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346102af5760203660031901126102af576004356111ca81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602064ffffffffff60406000205460c81c16604051908152f35b346102af5760203660031901126102af5760043561122381600052600860205260ff60016040600020015460081c1690565b1561048657611233600091612db9565b90600582101590816112745760028314918215611288575b821561125f575b6020836040519015158152f35b90915061127457506004602091148280611252565b634e487b7160e01b81526021600452602490fd5b506003831491508061124b565b346102af5760003660031901126102af57638b78c6d819546040516001600160a01b039091168152602090f35b346102af5760203660031901126102af576004356001600160401b0381116102af576112f290369060040161231a565b6112fa612f98565b6000917f0000000000000000000000000000000000000000000000000000000000000000915b80841061132957005b6113348482846126e3565b359361133e612f98565b611347856126a9565b1561136257846364a3f71f60e01b6000526024906004526000fd5b9091929361136f8161299a565b61158a576000818152600860205260409020546001600160a01b0316330361156e5761139a81612d1d565b8160005260086020526113b36002604060002001612968565b906001600160801b038251166001600160801b03821610156115595782600052600860205260ff60406000205460f01c1615611544576001939282611423836001600160801b036020611419819783600080516020614a3b8339815191529a51166124a3565b94015116906124a3565b826000526008845260406000208760f81b888060f81b038254161790558260005260088452604060002060ff60f01b1981541690556001600160801b03811615611526575b826000526008845260036040600020016001600160801b0383166001600160801b031982541617905582600052600884527fad0bb1d9ef26042c0654adf72a00b903ce4bf8b3c2245bfff55a90dd69ad774b878060a01b0360406000205416918460005260028652888060a01b0360406000205416936114f38d856001600160801b03841691613bb7565b604080518781526001600160801b0392831660208201529290911690820152606090a3604051908152a101929190611320565b8260005260088452866040600020018760ff19825416179055611468565b82637df978f560e11b60005260045260246000fd5b82631f3f436f60e11b60005260045260246000fd5b63021b128760e61b600090815260049190915233602452604490fd5b63ee2853e960e01b6000526024906004526000fd5b346102af5760203660031901126102af576004356115bb612f98565b6115d981600052600860205260ff60016040600020015460081c1690565b15610486576115e781612db9565b6115f081612357565b6004810361160d57506364a3f71f60e01b60005260045260246000fd5b61161681612357565b60038103611633575063ee2853e960e01b60005260045260246000fd5b60029061163f81612357565b146116e9576000818152600860205260409020546001600160a01b0316330361156e5780600052600860205260ff60406000205460f01c16156116d557602081600080516020614a3b8339815191529260005260088252604060002060ff60f01b19815416905560405190807f837f61b272b894b646e7b8d4aa72e0534b81594c34fadb09620a774478e94273600080a28152a1005b637df978f560e11b60005260045260246000fd5b631f3f436f60e11b60005260045260246000fd5b346102af5760203660031901126102af576004356001600160a01b038116908190036102af5761172b6130cd565b60075490806001600160601b0360a01b8316176007556040519160018060a01b0316825260208201527fa2548bd4b805e907c1558a47b5858324fe8bb4a2e1ddfca647eecbf65610eebc60403392a260065460001981019081116117bc5760407f6bd5c950a8d8df17f772f5af37cb3655737899cbf903264b9795592da439661c91815190600182526020820152a1005b634e487b7160e01b600052601160045260246000fd5b60003660031901126102af576117e66130cd565b6000638b78c6d819547f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a36000638b78c6d81955005b346102af5760203660031901126102af576001600160a01b0361183f6122a0565b16801561185e5760005260036020526020604060002054604051908152f35b6322718ad960e21b600052600060045260246000fd5b346102af5760203660031901126102af5760043561189181612cfa565b506000526002602052602060018060a01b0360406000205416604051908152f35b346102af5760203660031901126102af5760206118d0600435612cfa565b6040516001600160a01b039091168152f35b346102af5760003660031901126102af576040517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b60003660031901126102af5763389a75e1600c523360005260006020600c2055337ffa7b8eab7da67f412cc9575ed43464468f9bfbae89d1675917346ca6d8fe3c92600080a2005b346102af5760203660031901126102af576004356119a181600052600860205260ff60016040600020015460081c1690565b156104865760006119b182612db9565b6005811015610c96576002036119cf575b6020906040519015158152f35b506000526008602052602060ff60406000205460f01c166119c2565b346102af5760203660031901126102af57600435611a1d81600052600860205260ff60016040600020015460081c1690565b1561048657610475602091613048565b346102af5760203660031901126102af57600435611a49612f98565b611a52816126a9565b15611b9957611a6081612fdb565b15611b81576000818152600260205260408120546001600160a01b0316151580611b7a575b80611b6a575b611b5857600080516020614a3b8339815191526020604051848152a1818152600260205260408120546001600160a01b031680159183908315611b23575b81815260026020526040812080546001600160a01b0319169055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8280a450611b0f57005b637e27328960e01b60005260045260246000fd5b600082815260046020526040902080546001600160a01b03191690558281526003602052604081208054600019019055611ac9565b6024916319ef672160e11b8252600452fd5b50611b74826128a2565b15611a8b565b5080611a85565b63021b128760e61b6000526004523360245260446000fd5b636c6b2bb560e11b60005260045260246000fd5b346102af576102f4611bbe366122e0565b9060405192611bce60208561242e565b60008452610bba8383836124c3565b346102af5760203660031901126102af5760206103146004356126a9565b346102af5760203660031901126102af57600435611c17612f98565b611c20816126a9565b15611c39576364a3f71f60e01b60005260045260246000fd5b611c428161299a565b611e1a576000818152600860205260409020546001600160a01b03163303611b8157611c6d81612d1d565b816000526008602052611c866002604060002001612968565b906001600160801b038251166001600160801b03821610156115595782600052600860205260ff60406000205460f01c1615611544579181611ce9846001600160801b036020611419600080516020614a3b8339815191529883839951166124a3565b60008381526008808652604080832080546001600160f81b0316600160f81b1790558583529086529020805460ff60f01b191690556001600160801b03811615611dfa575b60008381526008808652604080832060030180546001600160801b0319166001600160801b03871690811790915586845291875280832054868452600288529220546001600160a01b03908116949216927fad0bb1d9ef26042c0654adf72a00b903ce4bf8b3c2245bfff55a90dd69ad774b929091611dce90857f0000000000000000000000000000000000000000000000000000000000000000613bb7565b604080518781526001600160801b0392831660208201529290911690820152606090a3604051908152a1005b82600052600884526001604060002001600160ff19825416179055611d2e565b63ee2853e960e01b60005260045260246000fd5b346102af5760203660031901126102af576020610314600435600052600860205260ff60016040600020015460081c1690565b60003660031901126102af5763389a75e1600c52336000526202a30042016020600c2055337fdbf36a107da19e49527a7176a1babf963b4b0ff8cde35ee35d6cd8f1f9ac7e1d600080a2005b346102af576102f4611ebe366122e0565b916124c3565b346102af5760203660031901126102af57600435611ef681600052600860205260ff60016040600020015460081c1690565b1561048657611f0490612db9565b6005811015610c96578060209115908115611f25575b506040519015158152f35b600191501482611f1a565b346102af5760203660031901126102af57600435611f6281600052600860205260ff60016040600020015460081c1690565b1561048657602090600090806000526008835260ff60406000205460f01c1680611fd2575b611f9e575b506001600160801b0360405191168152f35b611fcc91508060005260088352611fc66001600160801b036002604060002001541691612d1d565b906124a3565b82611f8c565b50806000526008835260ff6001604060002001541615611f87565b346102af5760003660031901126102af576020600654604051908152f35b346102af5760403660031901126102af576120246122a0565b60243561203081612cfa565b331515806120e7575b806120b9575b6120a45781906001600160a01b0384811691167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925600080a4600090815260046020526040902080546001600160a01b0319166001600160a01b03909216919091179055005b63a9fbf51f60e01b6000523360045260246000fd5b506001600160a01b038116600090815260056020908152604080832033845290915290205460ff161561203f565b506001600160a01b038116331415612039565b346102af5760203660031901126102af5760206118d060043561247e565b346102af5760003660031901126102af57604051600080548060011c906001811680156121c9575b60208310811461113f5782855290811561111b575060011461216c57610670836110a78185038261242e565b60008080527f290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563939250905b8082106121af575090915081016020016110a7611097565b919260018160209254838588010152019101909291612197565b91607f1691612140565b346102af5760203660031901126102af576004359063ffffffff60e01b82168092036102af57602091632483248360e11b8114908115612215575b5015158152f35b6380ac58cd60e01b811491508115612247575b8115612236575b508361220e565b6301ffc9a760e01b1490508361222f565b635b5e139f60e01b81149150612228565b60005b83811061226b5750506000910152565b818101518382015260200161225b565b9060209161229481518092818552858086019101612258565b601f01601f1916010190565b600435906001600160a01b03821682036102af57565b602435906001600160a01b03821682036102af57565b35906001600160a01b03821682036102af57565b60609060031901126102af576004356001600160a01b03811681036102af57906024356001600160a01b03811681036102af579060443590565b9181601f840112156102af578235916001600160401b0383116102af576020808501948460051b0101116102af57565b359081151582036102af57565b60051115610c9657565b906020808351928381520192019060005b81811061237f5750505090565b9091926020606060019264ffffffffff604088516001600160801b0381511684526001600160401b0386820151168685015201511660408201520194019101919091612372565b604081019081106001600160401b038211176123e157604052565b634e487b7160e01b600052604160045260246000fd5b606081019081106001600160401b038211176123e157604052565b61014081019081106001600160401b038211176123e157604052565b90601f801991011681019081106001600160401b038211176123e157604052565b6001600160401b0381116123e157601f01601f191660200190565b35906001600160801b03821682036102af57565b61248781612cfa565b506000908152600460205260409020546001600160a01b031690565b906001600160801b03809116911603906001600160801b0382116117bc57565b6001600160a01b0390911691908215610a38576000828152600260205260408120549093906001600160a01b03161515806126a1575b80612691575b61267d578290600080516020614a3b8339815191526020604051848152a1818552600260205260408520546001600160a01b0316948590331515806125e5575b507fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef90826125b0575b83815260036020526040812060018154019055848152600260205260408120846001600160601b0360a01b82541617905580a46001600160a01b0316808303610a1e57505050565b600085815260046020526040902080546001600160a01b03191690558281526003602052604081208054600019019055612568565b91509192508061262e575b156125ff57908484923861253f565b83908561261857602491637e27328960e01b8252600452fd5b60449163177e802f60e01b825233600452602452fd5b50338514801561265c575b806125f05750838152600460205260408120546001600160a01b031633146125f0565b5084815260056020908152604080832033845290915281205460ff16612639565b6319ef672160e11b84526004839052602484fd5b5061269b836128a2565b156124ff565b5060016124f9565b6126c781600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260ff6001604060002001541690565b91908110156126f35760051b0190565b634e487b7160e01b600052603260045260246000fd5b359064ffffffffff821682036102af57565b6001600160401b0381116123e15760051b60200190565b919060e0838203126102af5760405160e081018181106001600160401b038211176123e1576040528093612765816122cc565b825261277360208201612709565b60208301526127846040820161234a565b6040830152612795606082016122cc565b60608301526127a66080820161234a565b60808301526127b760a0820161246a565b60a083015260c0810135906001600160401b0382116102af570182601f820112156102af578035906127e88261271b565b936127f6604051958661242e565b828552602060608187019402830101918183116102af57602001925b828410612823575050505060c00152565b6060848303126102af576040519061283a826123f7565b6128438561246a565b82526020850135906001600160401b03821682036102af578260209283606095015261287160408801612709565b6040820152815201930192612812565b8051156126f35760200190565b80518210156126f35760209160051b010190565b6128c081600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260ff60016040600020015460101c1690565b9081546128eb8161271b565b926128f9604051948561242e565b818452602084019060005260206000206000915b83831061291a5750505050565b60016020819260405161292c816123f7565b64ffffffffff86546001600160801b03811683526001600160401b038160801c168584015260c01c16604082015281520192019201919061290d565b90604051612975816123f7565b60406001600160801b03600183958054838116865260801c6020860152015416910152565b6129b881600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260406000205460f81c90565b916129da612f98565b6129e3836126a9565b612c33576001600160a01b038216918215612c22576001600160801b038216918215612c0d576000858152600860205260409020546001600160a01b03163314801580612bfd575b612be2576000868152600260205260409020546001600160a01b031681612bd7575b50612bba576001600160801b03612a6386613883565b16808411612b9e5750937f0a4004630d32942c3f8d777d520452a61faabe0184388287bbccb8838a8139fc602084612b568496839896612ac5600080516020614a3b8339815191529b886000526008875260026040600020015460801c6138ab565b87600052600886526002604060002001906001600160801b0382549181199060801b1691161790558660005260088552612b056002604060002001612968565b6001600160801b03612b28818884015116928260408183511692015116906124a3565b161115612b66575b7f0000000000000000000000000000000000000000000000000000000000000000613bb7565b604051908152a3604051908152a1565b86600052600885526001604060002001600160ff198254161790558660005260088552604060002060ff60f01b198154169055612b30565b83866335a2ef3d60e01b60005260045260245260445260646000fd5b83856309c91a4560e41b6000526004523360245260445260646000fd5b905084141538612a4d565b63021b128760e61b6000908152600487905233602452604490fd5b50612c0786612fdb565b15612a2b565b8463ed32664f60e01b60005260045260246000fd5b6308c956f960e41b60005260046000fd5b826364a3f71f60e01b60005260045260246000fd5b91612c52836126a9565b612c33576001600160a01b038216918215612c22576001600160801b038216918215612c0d576000858152600860205260409020546001600160a01b03163314801580612cea575b612cd1576000868152600260205260409020546001600160a01b031681612bd75750612bba576001600160801b03612a6386613883565b8563021b128760e61b6000526004523360245260446000fd5b50612cf486612fdb565b15612c9a565b6000818152600260205260409020546001600160a01b0316908115611b0f575090565b64ffffffffff42168160005260086020528064ffffffffff60406000205460a01c161015612db25781600052600860205264ffffffffff60406000205460c81c161115612d9557806000526008602052600160046040600020015411600014612d8c57612d89906139ac565b90565b612d89906138cb565b60005260086020526001600160801b036002604060002001541690565b5050600090565b80600052600860205260ff60016040600020015416600014612ddb5750600490565b80600052600860205260406000205460f81c612e4f5780600052600860205264ffffffffff60406000205460a01c164210612e4957612e1981612d1d565b9060005260086020526001600160801b038060026040600020015416911610600014612e4457600190565b600290565b50600090565b50600390565b6000828152600260205260409020549091906001600160a01b0316151580612f86575b80612f76575b612f6257600080516020614a3b8339815191526020604051838152a16000818152600260205260409020546001600160a01b03169182612f2b575b6001600160a01b031680612f11575b8160005260026020526040600020816001600160601b0360a01b825416179055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef600080a490565b806000526003602052604060002060018154019055612ec8565b600082815260046020526040902080546001600160a01b031916905582600052600360205260406000206000198154019055612eb9565b6319ef672160e11b60005260045260246000fd5b50612f80816128a2565b15612e7e565b506001600160a01b0382161515612e78565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03163003612fca57565b63a1c0d6e560e01b60005260046000fd5b80600052600260205260018060a01b036040600020541690813314918215613023575b508115613009575090565b3391506001600160a01b039061301e9061247e565b161490565b600090815260056020908152604080832033845290915290205460ff16915038612ffe565b8060005260086020526130616002604060002001612968565b9080600052600860205260ff6001604060002001541660001461308f5750602001516001600160801b031690565b9081600052600860205260406000205460f81c6130b05750612d8990612d1d565b612d8991506001600160801b0360408183511692015116906124a3565b638b78c6d8195433036130dc57565b6382b429006000526004601cfd5b60018060a01b031680638b78c6d819547f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a3638b78c6d81955565b60a08101916001600160801b038351169260c08301805194602085019564ffffffffff87511682156137425781518015613731577f0000000000000000000000000000000000000000000000000000000000000000811161371d575064ffffffffff604061319584612881565b510151168110156136f15750600090600090600081516000905b80821061367e575050505064ffffffffff804216911690818110156136675750506001600160801b0316908181036136505750506006546000818152600860205260409081902084516002820180546001600160801b0319166001600160801b03929092169190911790558187018051825460808a01805160018601805462ffff00191691151560101b62ff000016919091176101001790558a517fff00ffffffffffffffffffff000000000000000000000000000000000000000090921692151560f01b60ff60f01b16929092176001600160a01b039190911617835585518051919a9599959294919291906132ab9060001985019061288e565b5101518354915169ffffffffffffffffffff60a01b1990921660c89190911b64ffffffffff60c81b161760a09190911b64ffffffffff60a01b16178255600482019060005b8181106135a257505050600160065401600655606083019360018060a01b0385511698602094604051613323878261242e565b600081528b15610a38576001600160a01b0361333f8c8e612e55565b1661358c578b3b61347e575b50899a50926134799261345b926001600160801b038a9b9c97966133e4827f090e953737b41f6b24cd059ba4f9d20af08602f83128a96c87db57ff63acfeb39c9d5116604051906323b872dd60e01b8d8301523360248301523060448301526064820152606481526133be60848261242e565b7f0000000000000000000000000000000000000000000000000000000000000000613dc5565b60018060a01b039051169a60018060a01b039051169b51169551151590511515915192549564ffffffffff6040519761341c896123c6565b818160a01c16895260c81c16898801526040519889988952339089015260408801526060870152608086015261010060a0860152610100850190612361565b9160c084019064ffffffffff60208092828151168552015116910152565b0390a3565b866134c2918d8d60009a9e9d9c9b9a604051809681958294630a85bd0160e11b8452336004850152846024850152604484015260806064840152608483019061227b565b03925af1809160009161354a575b5090613500578b8b6134e0613753565b805191826134fd5783633250574960e11b60005260045260246000fd5b01fd5b630a85bd0160e19c929394959697999b989a9c1b9063ffffffff60e01b160361353657508998979695949392919061347961334b565b633250574960e11b60005260045260246000fd5b8c81813d8311613585575b61355f818361242e565b810103126135815751906001600160e01b0319821682036106f05750386134d0565b5080fd5b503d613555565b6339e3563760e11b600052600060045260246000fd5b6135ad81885161288e565b518354680100000000000000008110156123e1576001810185556000855482101561363c57858152602090819020835192018054918401516040909401516001600160e81b03199092166001600160801b03939093169290921760809390931b67ffffffffffffffff60801b169290921760c09290921b64ffffffffff60c01b169190911790556001016132f0565b634e487b7160e01b81526032600452602490fd5b633e4e031d60e11b60005260045260245260446000fd5b63479b196360e11b60005260045260245260446000fd5b91935091936136a2906001600160801b03613699858861288e565b515116906138ab565b9364ffffffffff8060406136b6868561288e565b510151169416808511156136d45750600184930191929190926131af565b84908463c9c5434160e01b60005260045260245260445260646000fd5b64ffffffffff604061370284612881565b510151169062c400dd60e21b60005260045260245260446000fd5b636ee72dd960e01b60005260045260246000fd5b63ac5eb09360e01b60005260046000fd5b635d66204960e11b60005260046000fd5b3d1561377e573d906137648261244f565b91613772604051938461242e565b82523d6000602084013e565b606090565b9291813b613792575b50505050565b604051630a85bd0160e11b81523360048201526001600160a01b03948516602482015260448101919091526080606482015292169190602090829081906137dd90608483019061227b565b03816000865af18091600091613840575b509061381f57506137fd613753565b8051908161381a5782633250574960e11b60005260045260246000fd5b602001fd5b6001600160e01b03191663757a42ff60e11b0161353657503880808061378c565b6020813d60201161387b575b816138596020938361242e565b810103126135815751906001600160e01b0319821682036106f05750386137ee565b3d915061384c565b612d899061389081613048565b90600052600860205260026040600020015460801c906124a3565b906001600160801b03809116911601906001600160801b0382116117bc57565b6000818152600860205260409020546139039064ffffffffff60a082901c811660c89290921c81168290038116914282160316613bfa565b908060005260086020526004604060002001600090805415613998576020826001600160401b03926139629452205460801c169282600052600860205261395d6001600160801b0360026040600020015416948592613c99565b613d0d565b91821361397f575061397b6001600160801b0391613da6565b1690565b9050600052600860205260026040600020015460801c90565b634e487b7160e01b82526032600452602482fd5b64ffffffffff42169060005260086020526040600020604051916139cf83612412565b81549060018060a01b0382168452602084019164ffffffffff8160a01c16835264ffffffffff8160c81c16604086015260ff8160f01c161515606086015260f81c1515608085015260ff6001840154818116151560a0870152818160081c16151560c087015260101c16151560e0850152610120613a636004613a5460028701612968565b956101008801968752016128df565b94019084825264ffffffffff6040613a7c600097612881565b51015116928164ffffffffff6000955b1610613b785782613b19859364ffffffffff61395d94816001600160801b03613abb829c9b613b1e9b5161288e565b5151169a886001600160401b036020613ad68f9c8b5161288e565b5101511697826040613ae984845161288e565b51015116948215613b6c5750604091613b08915190600019019061288e565b5101511680925b0316920316613bfa565b613c99565b918213613b3f5750906001600160801b03613b398193613da6565b16011690565b6001600160801b03915060209051015116806001600160801b03831611600014613b67575090565b905090565b91505051168092613b0f565b92946001600160801b0360019181613b9189875161288e565b51511601169501928164ffffffffff806040613bae88885161288e565b51015116613a8c565b60405163a9059cbb60e01b60208201526001600160a01b03929092166024830152604480830193909352918152613bf891613bf360648361242e565b613dc5565b565b600160ff1b81148015613c8c575b613c7b576000811215613c7257613c30816000035b6000841215613c6b578360000390613e3c565b916001600160ff1b038311613c535760001991181315613c4d5790565b60000390565b9063d49c26b360e01b60005260045260245260446000fd5b8390613e3c565b613c3081613c1d565b6309fe2b4560e41b60005260046000fd5b50600160ff1b8214613c08565b80613cb45750613caf57670de0b6b3a764000090565b600090565b90670de0b6b3a76400008214613cff5780613cd7575050670de0b6b3a764000090565b670de0b6b3a76400008114613cfb57613cf69061395d612d8993613f2f565b614071565b5090565b5050670de0b6b3a764000090565b600160ff1b81148015613d99575b613d88576000811215613d7f57613d43816000035b6000841215613d78578360000390614941565b916001600160ff1b038311613d605760001991181315613c4d5790565b9063120b5b4360e01b60005260045260245260446000fd5b8390614941565b613d4381613d30565b63a6070c2560e01b60005260046000fd5b50600160ff1b8214613d1b565b60008112613db15790565b632463f3d560e01b60005260045260246000fd5b600080613dee9260018060a01b03169360208151910182865af1613de7613753565b90836149d9565b8051908115159182613e18575b5050613e045750565b635274afe760e01b60005260045260246000fd5b81925090602091810103126102af57602001518015908115036102af573880613dfb565b600019670de0b6b3a7640000820991670de0b6b3a7640000820291828085109403938085039414613ef25781841015613ecf57670de0b6b3a764000082910960018219018216809204600281600302188082026002030280820260020302808202600203028082026002030280820260020302809102600203029360018380600003040190848311900302920304170290565b630c740aef60e31b600052600452670de0b6b3a764000060245260445260646000fd5b5091508115613eff570490565b634e487b7160e01b600052601260045260246000fd5b8015613eff576ec097ce7bc90715b34b9f10000000000590565b80600081131561405d57670de0b6b3a7640000811261403c57506001905b670de0b6b3a764000081056001600160801b03811160071b90811c6001600160401b03811160061b90811c63ffffffff811160051b90811c61ffff811160041b90811c9060ff821160031b91821c92600f841160021b93841c94600160038711811b96871c119617171717171717670de0b6b3a7640000810291811d90670de0b6b3a7640000821461402957506706f05b59d3b20000905b60008213613ff35750500290565b80670de0b6b3a764000091020590671bc16d674ec8000082121561401b575b60011d90613fe5565b809192019160011d90614012565b9050670de0b6b3a7640000929150020290565b60001991508015613eff576ec097ce7bc90715b34b9f100000000005613f4d565b63059b101b60e01b60005260045260246000fd5b60008112156140a05768033dd1780914b97114198112612e495761409790600003614071565b612d8990613f15565b680a688906bd8affffff811361492e57670de0b6b3a76400009060401b05600160bf1b67ff000000000000008216614805575b670de0b6b3a76400009066ff00000000000083166146f5575b65ff000000000083166145ed575b64ff0000000083166144ed575b63ff00000083166143f5575b62ff00008316614305575b61ff00831661421d575b60ff831661413d575b029060401c60bf031c90565b6080831661420a575b604083166141f7575b602083166141e4575b601083166141d1575b600883166141be575b600483166141ab575b60028316614198575b600183161561413157680100000000000000010260401c614131565b680100000000000000010260401c61417c565b680100000000000000030260401c614173565b680100000000000000060260401c61416a565b6801000000000000000b0260401c614161565b680100000000000000160260401c614158565b6801000000000000002c0260401c61414f565b680100000000000000590260401c614146565b61800083166142f2575b61400083166142df575b61200083166142cc575b61100083166142b9575b61080083166142a6575b6104008316614293575b6102008316614280575b61010083161561412857680100000000000000b10260401c614128565b680100000000000001630260401c614263565b680100000000000002c60260401c614259565b6801000000000000058c0260401c61424f565b68010000000000000b170260401c614245565b6801000000000000162e0260401c61423b565b68010000000000002c5d0260401c614231565b680100000000000058b90260401c614227565b6280000083166143e2575b6240000083166143cf575b6220000083166143bc575b6210000083166143a9575b620800008316614396575b620400008316614383575b620200008316614370575b6201000083161561411e576801000000000000b1720260401c61411e565b680100000000000162e40260401c614352565b6801000000000002c5c80260401c614347565b68010000000000058b910260401c61433c565b680100000000000b17210260401c614331565b68010000000000162e430260401c614326565b680100000000002c5c860260401c61431b565b6801000000000058b90c0260401c614310565b638000000083166144da575b634000000083166144c7575b632000000083166144b4575b631000000083166144a1575b6308000000831661448e575b6304000000831661447b575b63020000008316614468575b63010000008316156141135768010000000000b172180260401c614113565b6801000000000162e4300260401c614449565b68010000000002c5c8600260401c61443d565b680100000000058b90c00260401c614431565b6801000000000b17217f0260401c614425565b680100000000162e42ff0260401c614419565b6801000000002c5c85fe0260401c61440d565b68010000000058b90bfc0260401c614401565b64800000000083166145da575b64400000000083166145c7575b64200000000083166145b4575b64100000000083166145a1575b640800000000831661458e575b640400000000831661457b575b6402000000008316614568575b64010000000083161561410757680100000000b17217f80260401c614107565b68010000000162e42ff10260401c614548565b680100000002c5c85fe30260401c61453b565b6801000000058b90bfce0260401c61452e565b68010000000b17217fbb0260401c614521565b6801000000162e42fff00260401c614514565b68010000002c5c8601cc0260401c614507565b680100000058b90c0b490260401c6144fa565b6580000000000083166146e2575b6540000000000083166146cf575b6520000000000083166146bc575b6510000000000083166146a9575b650800000000008316614696575b650400000000008316614683575b650200000000008316614670575b650100000000008316156140fa576801000000b1721835510260401c6140fa565b680100000162e430e5a20260401c61464f565b6801000002c5c863b73f0260401c614641565b68010000058b90cf1e6e0260401c614633565b680100000b1721bcfc9a0260401c614625565b68010000162e43f4f8310260401c614617565b680100002c5c89d5ec6d0260401c614609565b6801000058b91b5bc9ae0260401c6145fb565b668000000000000083166147f2575b664000000000000083166147df575b662000000000000083166147cc575b661000000000000083166147b9575b660800000000000083166147a6575b66040000000000008316614793575b66020000000000008316614780575b66010000000000008316156140ec5768010000b17255775c040260401c6140ec565b6801000162e525ee05470260401c61475e565b68010002c5cc37da94920260401c61474f565b680100058ba01fb9f96d0260401c614740565b6801000b175effdc76ba0260401c614731565b680100162f3904051fa10260401c614722565b6801002c605e2e8cec500260401c614713565b68010058c86da1c09ea20260401c614704565b678000000000000000821661491b575b670de0b6b3a7640000906740000000000000008316614908575b67200000000000000083166148f5575b67100000000000000083166148e2575b67080000000000000083166148cf575b67040000000000000083166148bc575b67020000000000000083166148a9575b6701000000000000008316614896575b90506140d3565b680100b1afa5abcbed610260401c61488f565b68010163da9fb33356d80260401c61487f565b680102c9a3e778060ee70260401c61486f565b6801059b0d31585743ae0260401c61485f565b68010b5586cf9890f62a0260401c61484f565b6801172b83c7d517adce0260401c61483f565b6801306fe0a31b7152df0260401c61482f565b5068016a09e667f3bcc909607f1b614815565b626c1a0560e31b60005260045260246000fd5b909190600019838209838202918280831092039180830392146149c857670de0b6b3a76400008210156149af577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b8490635173648d60e01b60005260045260245260446000fd5b5050670de0b6b3a764000090049150565b906149ff57508051156149ee57805190602001fd5b630a12f52160e11b60005260046000fd5b81511580614a31575b614a10575090565b639996b31560e01b60009081526001600160a01b0391909116600452602490fd5b50803b15614a0856fef8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce7a2646970667358221220f759c5f5fe74b188105d699977b6207c5efeec1b76320c3373be1daf7fed71bb64736f6c634300081a00330000000000000000000000008870cd5aed8a586929a11468ddb38d8a1370d509000000000000000000000000e083d24bb84b2fcb8a9c6783e1302591595d383a000000000000000000000000000000000000000000000000000000000000012c000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f

0x608080604052600436101561001357600080fd5b60003560e01c90816301ffc9a7146121d35750806306fdde0314612118578063081812fc146120fa578063095ea7b31461200b5780630f038d4114611fed5780631400ecec14611f305780631c1cdd4c14611ec457806323b872dd14611ead5780632569296214611e615780633a568f6b14611e2e57806340e58ee514611bfb578063425d30dd14611bdd57806342842e0e14611bad57806342966c6814611a2d5780634744a6e7146119eb5780634857501f1461196f57806354d1f13d146119275780635dcb6a03146118e25780636352211e146118b25780636d0cee751461187457806370a082311461181e578063715018a6146117d25780637cad6cd1146116fd5780637de6b1db1461159f5780638659c270146112c25780638da5cb5b146112955780638f69b993146111f15780639067b677146111985780639188ec841461115d57806395d89b41146110515780639faeb28614610fcd578063a22cb46514610f2c578063a2ffb89714610e58578063a80fc07114610dfd578063ac7a0a1414610cac578063ad35efd414610c43578063b256456914610c25578063b637b86514610bbf578063b88d4fde14610b2c578063b971302a14610ad5578063bc2be1be14610a7c578063c156a11d14610954578063c5ca93a714610707578063c87b56dd146105ed578063cc364f481461054a578063d4dbd20b146104ef578063d511609f1461049a578063d975dfed14610433578063e985e9c5146103d8578063ea5ead19146103aa578063f04e283e1461035a578063f2fde38b1461031e578063f590c176146102f6578063fdd46d60146102b45763fee81cf41461027c57600080fd5b346102af5760203660031901126102af576102956122a0565b63389a75e1600c52600052602080600c2054604051908152f35b600080fd5b346102af5760603660031901126102af576102cd6122b6565b6044356001600160801b03811681036102af576102f4916102ec612f98565b600435612c48565b005b346102af5760203660031901126102af57602061031460043561299a565b6040519015158152f35b60203660031901126102af576103326122a0565b61033a6130cd565b8060601b1561034c576102f4906130ea565b637448fbae6000526004601cfd5b60203660031901126102af5761036e6122a0565b6103766130cd565b63389a75e1600c52806000526020600c20908154421161039c5760006102f492556130ea565b636f5e88186000526004601cfd5b346102af5760403660031901126102af576102f46004356103c96122b6565b6103d282613883565b916129d1565b346102af5760403660031901126102af576103f16122a0565b6103f96122b6565b9060018060a01b0316600052600560205260406000209060018060a01b0316600052602052602060ff604060002054166040519015158152f35b346102af5760203660031901126102af5760043561046581600052600860205260ff60016040600020015460081c1690565b1561048657610475602091613883565b6001600160801b0360405191168152f35b633ba03f1160e11b60005260045260246000fd5b346102af5760203660031901126102af576004356104cc81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602060026040600020015460801c604051908152f35b346102af5760203660031901126102af5760043561052181600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260206001600160801b0360036040600020015416604051908152f35b346102af5760203660031901126102af576004356000602060405161056e816123c6565b828152015261059181600052600860205260ff60016040600020015460081c1690565b1561048657600090815260086020526040908190205481519064ffffffffff60c882901c81169160a01c166105c5836123c6565b825260208201526105eb8251809264ffffffffff60208092828151168552015116910152565bf35b346102af5760203660031901126102af57610647600060043561060f81612cfa565b5060075460405163e9dc637560e01b81523060048201526024810192909252909283916001600160a01b031690829081906044820190565b03915afa9081156106fb57600091610674575b604051602080825281906106709082018561227b565b0390f35b3d8083833e610683818361242e565b8101906020818303126106f3578051906001600160401b0382116106f7570181601f820112156106f3578051926106b98461244f565b926106c7604051948561242e565b848452602085840101116106f05750610670926106ea9160208085019101612258565b9061065a565b80fd5b8280fd5b8380fd5b6040513d6000823e3d90fd5b346102af5760203660031901126102af57600435606061012060405161072c81612412565b60008152600060208201526000604082015260008382015260006080820152600060a0820152600060c0820152600060e082015260405161076c816123f7565b60008152600060208201526000604082015261010082015201526000906107a781600052600860205260ff60016040600020015460081c1690565b156109425760ff9080835260086020526040832060e0604051938480936107cd82612412565b80549060018060a01b0382168352602083019864ffffffffff8360a01c168a52604084019064ffffffffff8460c81c168252600261087a61086c600460608901968a8960f01c161515885260808a019860f81c151589528a60018201549c8b60a08f9d019c8d8482161515905260c082019e8f9160081c1615159052019c60101c1615158c52610100610861868301612968565b9d019c8d52016128df565b9a6101208d019b8c52612db9565b61088381612357565b1461093a575b50604051998a9960208b52600160a01b6001900390511660208b01525164ffffffffff1660408a01525164ffffffffff166060890152511515608088015251151560a087015251151560c086015251151560e08501525115156101008401525180516001600160801b031661012084015260208101516001600160801b0316610140840152604001516001600160801b031661016083015251610180820161018090526101a0820161067091612361565b82528a610889565b633ba03f1160e11b8252600452602490fd5b346102af5760403660031901126102af576004356109706122b6565b90610979612f98565b61099781600052600860205260ff60016040600020015460081c1690565b15610486576000818152600260205260409020546001600160a01b03169133839003610a5f576109c682613883565b6001600160801b038116610a4e575b506001600160a01b03811615610a38576001600160a01b03906109f9908390612e55565b169182610a155750637e27328960e01b60005260045260246000fd5b808303610a1e57005b6364283d7b60e01b60005260045260245260445260646000fd5b633250574960e11b600052600060045260246000fd5b610a599084846129d1565b836109d5565b5063021b128760e61b600090815260049190915233602452604490fd5b346102af5760203660031901126102af57600435610aae81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602064ffffffffff60406000205460a01c16604051908152f35b346102af5760203660031901126102af57600435610b0781600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602060018060a01b0360406000205416604051908152f35b346102af5760803660031901126102af57610b456122a0565b610b4d6122b6565b90604435606435926001600160401b0384116102af57366023850112156102af57836004013592610b7d8461244f565b93610b8b604051958661242e565b80855236602482880101116102af5760208160009260246102f499018389013786010152610bba8383836124c3565b613783565b346102af5760203660031901126102af57600435610bf181600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052610670610c1160046040600020016128df565b604051918291602083526020830190612361565b346102af5760203660031901126102af5760206103146004356128a2565b346102af5760203660031901126102af57600435610c7581600052600860205260ff60016040600020015460081c1690565b1561048657610c8390612db9565b6040516005821015610c96576020918152f35b634e487b7160e01b600052602160045260246000fd5b346102af5760203660031901126102af576004356001600160401b0381116102af57610cdc90369060040161231a565b610ce4612f98565b3068929eee149b4bd212685414610def573068929eee149b4bd2126855610d096130cd565b8015610dde57610d188161271b565b610d25604051918261242e565b818152610d318261271b565b6020820190601f19013682373684900360de19019060005b84811015610d8d5760008160051b87013590848212156106f0575090610d7c610d7760019336908a01612732565b613128565b610d86828761288e565b5201610d49565b81843868929eee149b4bd21268556040519182916020830190602084525180915260408301919060005b818110610dc5575050500390f35b8251845285945060209384019390920191600101610db7565b6301960e9560e11b60005260046000fd5b63ab143c066000526004601cfd5b346102af5760203660031901126102af57600435610e2f81600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260206001600160801b0360026040600020015416604051908152f35b346102af5760603660031901126102af576004356001600160401b0381116102af57610e8890369060040161231a565b610e906122b6565b916044356001600160401b0381116102af57610eb090369060040161231a565b929091610ebb612f98565b838203610f135760005b828110610ece57005b610ed98184846126e3565b3590610ee68187876126e3565b35916001600160801b03831683036102af5760019288610f0d92610f08612f98565b612c48565b01610ec5565b8382630516dbf160e01b60005260045260245260446000fd5b346102af5760403660031901126102af57610f456122a0565b602435908115158092036102af576001600160a01b0316908115610fb857336000526005602052604060002082600052602052604060002060ff1981541660ff83161790556040519081527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3160203392a3005b50630b61174360e31b60005260045260246000fd5b346102af5760203660031901126102af576004356001600160401b0381116102af5760e060031982360301126102af57611005612f98565b3068929eee149b4bd212685414610def5761103d610d776020923068929eee149b4bd21268556110336130cd565b3690600401612732565b3868929eee149b4bd2126855604051908152f35b346102af5760003660031901126102af5760405160006001548060011c90600181168015611153575b60208310811461113f5782855290811561111b57506001146110bb575b610670836110a78185038261242e565b60405191829160208352602083019061227b565b91905060016000527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6916000905b808210611101575090915081016020016110a7611097565b9192600181602092548385880101520191019092916110e9565b60ff191660208086019190915291151560051b840190910191506110a79050611097565b634e487b7160e01b84526022600452602484fd5b91607f169161107a565b346102af5760003660031901126102af5760206040517f000000000000000000000000000000000000000000000000000000000000012c8152f35b346102af5760203660031901126102af576004356111ca81600052600860205260ff60016040600020015460081c1690565b15610486576000526008602052602064ffffffffff60406000205460c81c16604051908152f35b346102af5760203660031901126102af5760043561122381600052600860205260ff60016040600020015460081c1690565b1561048657611233600091612db9565b90600582101590816112745760028314918215611288575b821561125f575b6020836040519015158152f35b90915061127457506004602091148280611252565b634e487b7160e01b81526021600452602490fd5b506003831491508061124b565b346102af5760003660031901126102af57638b78c6d819546040516001600160a01b039091168152602090f35b346102af5760203660031901126102af576004356001600160401b0381116102af576112f290369060040161231a565b6112fa612f98565b6000917f000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f915b80841061132957005b6113348482846126e3565b359361133e612f98565b611347856126a9565b1561136257846364a3f71f60e01b6000526024906004526000fd5b9091929361136f8161299a565b61158a576000818152600860205260409020546001600160a01b0316330361156e5761139a81612d1d565b8160005260086020526113b36002604060002001612968565b906001600160801b038251166001600160801b03821610156115595782600052600860205260ff60406000205460f01c1615611544576001939282611423836001600160801b036020611419819783600080516020614a3b8339815191529a51166124a3565b94015116906124a3565b826000526008845260406000208760f81b888060f81b038254161790558260005260088452604060002060ff60f01b1981541690556001600160801b03811615611526575b826000526008845260036040600020016001600160801b0383166001600160801b031982541617905582600052600884527fad0bb1d9ef26042c0654adf72a00b903ce4bf8b3c2245bfff55a90dd69ad774b878060a01b0360406000205416918460005260028652888060a01b0360406000205416936114f38d856001600160801b03841691613bb7565b604080518781526001600160801b0392831660208201529290911690820152606090a3604051908152a101929190611320565b8260005260088452866040600020018760ff19825416179055611468565b82637df978f560e11b60005260045260246000fd5b82631f3f436f60e11b60005260045260246000fd5b63021b128760e61b600090815260049190915233602452604490fd5b63ee2853e960e01b6000526024906004526000fd5b346102af5760203660031901126102af576004356115bb612f98565b6115d981600052600860205260ff60016040600020015460081c1690565b15610486576115e781612db9565b6115f081612357565b6004810361160d57506364a3f71f60e01b60005260045260246000fd5b61161681612357565b60038103611633575063ee2853e960e01b60005260045260246000fd5b60029061163f81612357565b146116e9576000818152600860205260409020546001600160a01b0316330361156e5780600052600860205260ff60406000205460f01c16156116d557602081600080516020614a3b8339815191529260005260088252604060002060ff60f01b19815416905560405190807f837f61b272b894b646e7b8d4aa72e0534b81594c34fadb09620a774478e94273600080a28152a1005b637df978f560e11b60005260045260246000fd5b631f3f436f60e11b60005260045260246000fd5b346102af5760203660031901126102af576004356001600160a01b038116908190036102af5761172b6130cd565b60075490806001600160601b0360a01b8316176007556040519160018060a01b0316825260208201527fa2548bd4b805e907c1558a47b5858324fe8bb4a2e1ddfca647eecbf65610eebc60403392a260065460001981019081116117bc5760407f6bd5c950a8d8df17f772f5af37cb3655737899cbf903264b9795592da439661c91815190600182526020820152a1005b634e487b7160e01b600052601160045260246000fd5b60003660031901126102af576117e66130cd565b6000638b78c6d819547f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a36000638b78c6d81955005b346102af5760203660031901126102af576001600160a01b0361183f6122a0565b16801561185e5760005260036020526020604060002054604051908152f35b6322718ad960e21b600052600060045260246000fd5b346102af5760203660031901126102af5760043561189181612cfa565b506000526002602052602060018060a01b0360406000205416604051908152f35b346102af5760203660031901126102af5760206118d0600435612cfa565b6040516001600160a01b039091168152f35b346102af5760003660031901126102af576040517f000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f6001600160a01b03168152602090f35b60003660031901126102af5763389a75e1600c523360005260006020600c2055337ffa7b8eab7da67f412cc9575ed43464468f9bfbae89d1675917346ca6d8fe3c92600080a2005b346102af5760203660031901126102af576004356119a181600052600860205260ff60016040600020015460081c1690565b156104865760006119b182612db9565b6005811015610c96576002036119cf575b6020906040519015158152f35b506000526008602052602060ff60406000205460f01c166119c2565b346102af5760203660031901126102af57600435611a1d81600052600860205260ff60016040600020015460081c1690565b1561048657610475602091613048565b346102af5760203660031901126102af57600435611a49612f98565b611a52816126a9565b15611b9957611a6081612fdb565b15611b81576000818152600260205260408120546001600160a01b0316151580611b7a575b80611b6a575b611b5857600080516020614a3b8339815191526020604051848152a1818152600260205260408120546001600160a01b031680159183908315611b23575b81815260026020526040812080546001600160a01b0319169055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8280a450611b0f57005b637e27328960e01b60005260045260246000fd5b600082815260046020526040902080546001600160a01b03191690558281526003602052604081208054600019019055611ac9565b6024916319ef672160e11b8252600452fd5b50611b74826128a2565b15611a8b565b5080611a85565b63021b128760e61b6000526004523360245260446000fd5b636c6b2bb560e11b60005260045260246000fd5b346102af576102f4611bbe366122e0565b9060405192611bce60208561242e565b60008452610bba8383836124c3565b346102af5760203660031901126102af5760206103146004356126a9565b346102af5760203660031901126102af57600435611c17612f98565b611c20816126a9565b15611c39576364a3f71f60e01b60005260045260246000fd5b611c428161299a565b611e1a576000818152600860205260409020546001600160a01b03163303611b8157611c6d81612d1d565b816000526008602052611c866002604060002001612968565b906001600160801b038251166001600160801b03821610156115595782600052600860205260ff60406000205460f01c1615611544579181611ce9846001600160801b036020611419600080516020614a3b8339815191529883839951166124a3565b60008381526008808652604080832080546001600160f81b0316600160f81b1790558583529086529020805460ff60f01b191690556001600160801b03811615611dfa575b60008381526008808652604080832060030180546001600160801b0319166001600160801b03871690811790915586845291875280832054868452600288529220546001600160a01b03908116949216927fad0bb1d9ef26042c0654adf72a00b903ce4bf8b3c2245bfff55a90dd69ad774b929091611dce90857f000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f613bb7565b604080518781526001600160801b0392831660208201529290911690820152606090a3604051908152a1005b82600052600884526001604060002001600160ff19825416179055611d2e565b63ee2853e960e01b60005260045260246000fd5b346102af5760203660031901126102af576020610314600435600052600860205260ff60016040600020015460081c1690565b60003660031901126102af5763389a75e1600c52336000526202a30042016020600c2055337fdbf36a107da19e49527a7176a1babf963b4b0ff8cde35ee35d6cd8f1f9ac7e1d600080a2005b346102af576102f4611ebe366122e0565b916124c3565b346102af5760203660031901126102af57600435611ef681600052600860205260ff60016040600020015460081c1690565b1561048657611f0490612db9565b6005811015610c96578060209115908115611f25575b506040519015158152f35b600191501482611f1a565b346102af5760203660031901126102af57600435611f6281600052600860205260ff60016040600020015460081c1690565b1561048657602090600090806000526008835260ff60406000205460f01c1680611fd2575b611f9e575b506001600160801b0360405191168152f35b611fcc91508060005260088352611fc66001600160801b036002604060002001541691612d1d565b906124a3565b82611f8c565b50806000526008835260ff6001604060002001541615611f87565b346102af5760003660031901126102af576020600654604051908152f35b346102af5760403660031901126102af576120246122a0565b60243561203081612cfa565b331515806120e7575b806120b9575b6120a45781906001600160a01b0384811691167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925600080a4600090815260046020526040902080546001600160a01b0319166001600160a01b03909216919091179055005b63a9fbf51f60e01b6000523360045260246000fd5b506001600160a01b038116600090815260056020908152604080832033845290915290205460ff161561203f565b506001600160a01b038116331415612039565b346102af5760203660031901126102af5760206118d060043561247e565b346102af5760003660031901126102af57604051600080548060011c906001811680156121c9575b60208310811461113f5782855290811561111b575060011461216c57610670836110a78185038261242e565b60008080527f290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563939250905b8082106121af575090915081016020016110a7611097565b919260018160209254838588010152019101909291612197565b91607f1691612140565b346102af5760203660031901126102af576004359063ffffffff60e01b82168092036102af57602091632483248360e11b8114908115612215575b5015158152f35b6380ac58cd60e01b811491508115612247575b8115612236575b508361220e565b6301ffc9a760e01b1490508361222f565b635b5e139f60e01b81149150612228565b60005b83811061226b5750506000910152565b818101518382015260200161225b565b9060209161229481518092818552858086019101612258565b601f01601f1916010190565b600435906001600160a01b03821682036102af57565b602435906001600160a01b03821682036102af57565b35906001600160a01b03821682036102af57565b60609060031901126102af576004356001600160a01b03811681036102af57906024356001600160a01b03811681036102af579060443590565b9181601f840112156102af578235916001600160401b0383116102af576020808501948460051b0101116102af57565b359081151582036102af57565b60051115610c9657565b906020808351928381520192019060005b81811061237f5750505090565b9091926020606060019264ffffffffff604088516001600160801b0381511684526001600160401b0386820151168685015201511660408201520194019101919091612372565b604081019081106001600160401b038211176123e157604052565b634e487b7160e01b600052604160045260246000fd5b606081019081106001600160401b038211176123e157604052565b61014081019081106001600160401b038211176123e157604052565b90601f801991011681019081106001600160401b038211176123e157604052565b6001600160401b0381116123e157601f01601f191660200190565b35906001600160801b03821682036102af57565b61248781612cfa565b506000908152600460205260409020546001600160a01b031690565b906001600160801b03809116911603906001600160801b0382116117bc57565b6001600160a01b0390911691908215610a38576000828152600260205260408120549093906001600160a01b03161515806126a1575b80612691575b61267d578290600080516020614a3b8339815191526020604051848152a1818552600260205260408520546001600160a01b0316948590331515806125e5575b507fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef90826125b0575b83815260036020526040812060018154019055848152600260205260408120846001600160601b0360a01b82541617905580a46001600160a01b0316808303610a1e57505050565b600085815260046020526040902080546001600160a01b03191690558281526003602052604081208054600019019055612568565b91509192508061262e575b156125ff57908484923861253f565b83908561261857602491637e27328960e01b8252600452fd5b60449163177e802f60e01b825233600452602452fd5b50338514801561265c575b806125f05750838152600460205260408120546001600160a01b031633146125f0565b5084815260056020908152604080832033845290915281205460ff16612639565b6319ef672160e11b84526004839052602484fd5b5061269b836128a2565b156124ff565b5060016124f9565b6126c781600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260ff6001604060002001541690565b91908110156126f35760051b0190565b634e487b7160e01b600052603260045260246000fd5b359064ffffffffff821682036102af57565b6001600160401b0381116123e15760051b60200190565b919060e0838203126102af5760405160e081018181106001600160401b038211176123e1576040528093612765816122cc565b825261277360208201612709565b60208301526127846040820161234a565b6040830152612795606082016122cc565b60608301526127a66080820161234a565b60808301526127b760a0820161246a565b60a083015260c0810135906001600160401b0382116102af570182601f820112156102af578035906127e88261271b565b936127f6604051958661242e565b828552602060608187019402830101918183116102af57602001925b828410612823575050505060c00152565b6060848303126102af576040519061283a826123f7565b6128438561246a565b82526020850135906001600160401b03821682036102af578260209283606095015261287160408801612709565b6040820152815201930192612812565b8051156126f35760200190565b80518210156126f35760209160051b010190565b6128c081600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260ff60016040600020015460101c1690565b9081546128eb8161271b565b926128f9604051948561242e565b818452602084019060005260206000206000915b83831061291a5750505050565b60016020819260405161292c816123f7565b64ffffffffff86546001600160801b03811683526001600160401b038160801c168584015260c01c16604082015281520192019201919061290d565b90604051612975816123f7565b60406001600160801b03600183958054838116865260801c6020860152015416910152565b6129b881600052600860205260ff60016040600020015460081c1690565b1561048657600052600860205260406000205460f81c90565b916129da612f98565b6129e3836126a9565b612c33576001600160a01b038216918215612c22576001600160801b038216918215612c0d576000858152600860205260409020546001600160a01b03163314801580612bfd575b612be2576000868152600260205260409020546001600160a01b031681612bd7575b50612bba576001600160801b03612a6386613883565b16808411612b9e5750937f0a4004630d32942c3f8d777d520452a61faabe0184388287bbccb8838a8139fc602084612b568496839896612ac5600080516020614a3b8339815191529b886000526008875260026040600020015460801c6138ab565b87600052600886526002604060002001906001600160801b0382549181199060801b1691161790558660005260088552612b056002604060002001612968565b6001600160801b03612b28818884015116928260408183511692015116906124a3565b161115612b66575b7f000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f613bb7565b604051908152a3604051908152a1565b86600052600885526001604060002001600160ff198254161790558660005260088552604060002060ff60f01b198154169055612b30565b83866335a2ef3d60e01b60005260045260245260445260646000fd5b83856309c91a4560e41b6000526004523360245260445260646000fd5b905084141538612a4d565b63021b128760e61b6000908152600487905233602452604490fd5b50612c0786612fdb565b15612a2b565b8463ed32664f60e01b60005260045260246000fd5b6308c956f960e41b60005260046000fd5b826364a3f71f60e01b60005260045260246000fd5b91612c52836126a9565b612c33576001600160a01b038216918215612c22576001600160801b038216918215612c0d576000858152600860205260409020546001600160a01b03163314801580612cea575b612cd1576000868152600260205260409020546001600160a01b031681612bd75750612bba576001600160801b03612a6386613883565b8563021b128760e61b6000526004523360245260446000fd5b50612cf486612fdb565b15612c9a565b6000818152600260205260409020546001600160a01b0316908115611b0f575090565b64ffffffffff42168160005260086020528064ffffffffff60406000205460a01c161015612db25781600052600860205264ffffffffff60406000205460c81c161115612d9557806000526008602052600160046040600020015411600014612d8c57612d89906139ac565b90565b612d89906138cb565b60005260086020526001600160801b036002604060002001541690565b5050600090565b80600052600860205260ff60016040600020015416600014612ddb5750600490565b80600052600860205260406000205460f81c612e4f5780600052600860205264ffffffffff60406000205460a01c164210612e4957612e1981612d1d565b9060005260086020526001600160801b038060026040600020015416911610600014612e4457600190565b600290565b50600090565b50600390565b6000828152600260205260409020549091906001600160a01b0316151580612f86575b80612f76575b612f6257600080516020614a3b8339815191526020604051838152a16000818152600260205260409020546001600160a01b03169182612f2b575b6001600160a01b031680612f11575b8160005260026020526040600020816001600160601b0360a01b825416179055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef600080a490565b806000526003602052604060002060018154019055612ec8565b600082815260046020526040902080546001600160a01b031916905582600052600360205260406000206000198154019055612eb9565b6319ef672160e11b60005260045260246000fd5b50612f80816128a2565b15612e7e565b506001600160a01b0382161515612e78565b7f00000000000000000000000015075c6cf31f6d515efa6074d1546b5c378f72d96001600160a01b03163003612fca57565b63a1c0d6e560e01b60005260046000fd5b80600052600260205260018060a01b036040600020541690813314918215613023575b508115613009575090565b3391506001600160a01b039061301e9061247e565b161490565b600090815260056020908152604080832033845290915290205460ff16915038612ffe565b8060005260086020526130616002604060002001612968565b9080600052600860205260ff6001604060002001541660001461308f5750602001516001600160801b031690565b9081600052600860205260406000205460f81c6130b05750612d8990612d1d565b612d8991506001600160801b0360408183511692015116906124a3565b638b78c6d8195433036130dc57565b6382b429006000526004601cfd5b60018060a01b031680638b78c6d819547f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0600080a3638b78c6d81955565b60a08101916001600160801b038351169260c08301805194602085019564ffffffffff87511682156137425781518015613731577f000000000000000000000000000000000000000000000000000000000000012c811161371d575064ffffffffff604061319584612881565b510151168110156136f15750600090600090600081516000905b80821061367e575050505064ffffffffff804216911690818110156136675750506001600160801b0316908181036136505750506006546000818152600860205260409081902084516002820180546001600160801b0319166001600160801b03929092169190911790558187018051825460808a01805160018601805462ffff00191691151560101b62ff000016919091176101001790558a517fff00ffffffffffffffffffff000000000000000000000000000000000000000090921692151560f01b60ff60f01b16929092176001600160a01b039190911617835585518051919a9599959294919291906132ab9060001985019061288e565b5101518354915169ffffffffffffffffffff60a01b1990921660c89190911b64ffffffffff60c81b161760a09190911b64ffffffffff60a01b16178255600482019060005b8181106135a257505050600160065401600655606083019360018060a01b0385511698602094604051613323878261242e565b600081528b15610a38576001600160a01b0361333f8c8e612e55565b1661358c578b3b61347e575b50899a50926134799261345b926001600160801b038a9b9c97966133e4827f090e953737b41f6b24cd059ba4f9d20af08602f83128a96c87db57ff63acfeb39c9d5116604051906323b872dd60e01b8d8301523360248301523060448301526064820152606481526133be60848261242e565b7f000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f613dc5565b60018060a01b039051169a60018060a01b039051169b51169551151590511515915192549564ffffffffff6040519761341c896123c6565b818160a01c16895260c81c16898801526040519889988952339089015260408801526060870152608086015261010060a0860152610100850190612361565b9160c084019064ffffffffff60208092828151168552015116910152565b0390a3565b866134c2918d8d60009a9e9d9c9b9a604051809681958294630a85bd0160e11b8452336004850152846024850152604484015260806064840152608483019061227b565b03925af1809160009161354a575b5090613500578b8b6134e0613753565b805191826134fd5783633250574960e11b60005260045260246000fd5b01fd5b630a85bd0160e19c929394959697999b989a9c1b9063ffffffff60e01b160361353657508998979695949392919061347961334b565b633250574960e11b60005260045260246000fd5b8c81813d8311613585575b61355f818361242e565b810103126135815751906001600160e01b0319821682036106f05750386134d0565b5080fd5b503d613555565b6339e3563760e11b600052600060045260246000fd5b6135ad81885161288e565b518354680100000000000000008110156123e1576001810185556000855482101561363c57858152602090819020835192018054918401516040909401516001600160e81b03199092166001600160801b03939093169290921760809390931b67ffffffffffffffff60801b169290921760c09290921b64ffffffffff60c01b169190911790556001016132f0565b634e487b7160e01b81526032600452602490fd5b633e4e031d60e11b60005260045260245260446000fd5b63479b196360e11b60005260045260245260446000fd5b91935091936136a2906001600160801b03613699858861288e565b515116906138ab565b9364ffffffffff8060406136b6868561288e565b510151169416808511156136d45750600184930191929190926131af565b84908463c9c5434160e01b60005260045260245260445260646000fd5b64ffffffffff604061370284612881565b510151169062c400dd60e21b60005260045260245260446000fd5b636ee72dd960e01b60005260045260246000fd5b63ac5eb09360e01b60005260046000fd5b635d66204960e11b60005260046000fd5b3d1561377e573d906137648261244f565b91613772604051938461242e565b82523d6000602084013e565b606090565b9291813b613792575b50505050565b604051630a85bd0160e11b81523360048201526001600160a01b03948516602482015260448101919091526080606482015292169190602090829081906137dd90608483019061227b565b03816000865af18091600091613840575b509061381f57506137fd613753565b8051908161381a5782633250574960e11b60005260045260246000fd5b602001fd5b6001600160e01b03191663757a42ff60e11b0161353657503880808061378c565b6020813d60201161387b575b816138596020938361242e565b810103126135815751906001600160e01b0319821682036106f05750386137ee565b3d915061384c565b612d899061389081613048565b90600052600860205260026040600020015460801c906124a3565b906001600160801b03809116911601906001600160801b0382116117bc57565b6000818152600860205260409020546139039064ffffffffff60a082901c811660c89290921c81168290038116914282160316613bfa565b908060005260086020526004604060002001600090805415613998576020826001600160401b03926139629452205460801c169282600052600860205261395d6001600160801b0360026040600020015416948592613c99565b613d0d565b91821361397f575061397b6001600160801b0391613da6565b1690565b9050600052600860205260026040600020015460801c90565b634e487b7160e01b82526032600452602482fd5b64ffffffffff42169060005260086020526040600020604051916139cf83612412565b81549060018060a01b0382168452602084019164ffffffffff8160a01c16835264ffffffffff8160c81c16604086015260ff8160f01c161515606086015260f81c1515608085015260ff6001840154818116151560a0870152818160081c16151560c087015260101c16151560e0850152610120613a636004613a5460028701612968565b956101008801968752016128df565b94019084825264ffffffffff6040613a7c600097612881565b51015116928164ffffffffff6000955b1610613b785782613b19859364ffffffffff61395d94816001600160801b03613abb829c9b613b1e9b5161288e565b5151169a886001600160401b036020613ad68f9c8b5161288e565b5101511697826040613ae984845161288e565b51015116948215613b6c5750604091613b08915190600019019061288e565b5101511680925b0316920316613bfa565b613c99565b918213613b3f5750906001600160801b03613b398193613da6565b16011690565b6001600160801b03915060209051015116806001600160801b03831611600014613b67575090565b905090565b91505051168092613b0f565b92946001600160801b0360019181613b9189875161288e565b51511601169501928164ffffffffff806040613bae88885161288e565b51015116613a8c565b60405163a9059cbb60e01b60208201526001600160a01b03929092166024830152604480830193909352918152613bf891613bf360648361242e565b613dc5565b565b600160ff1b81148015613c8c575b613c7b576000811215613c7257613c30816000035b6000841215613c6b578360000390613e3c565b916001600160ff1b038311613c535760001991181315613c4d5790565b60000390565b9063d49c26b360e01b60005260045260245260446000fd5b8390613e3c565b613c3081613c1d565b6309fe2b4560e41b60005260046000fd5b50600160ff1b8214613c08565b80613cb45750613caf57670de0b6b3a764000090565b600090565b90670de0b6b3a76400008214613cff5780613cd7575050670de0b6b3a764000090565b670de0b6b3a76400008114613cfb57613cf69061395d612d8993613f2f565b614071565b5090565b5050670de0b6b3a764000090565b600160ff1b81148015613d99575b613d88576000811215613d7f57613d43816000035b6000841215613d78578360000390614941565b916001600160ff1b038311613d605760001991181315613c4d5790565b9063120b5b4360e01b60005260045260245260446000fd5b8390614941565b613d4381613d30565b63a6070c2560e01b60005260046000fd5b50600160ff1b8214613d1b565b60008112613db15790565b632463f3d560e01b60005260045260246000fd5b600080613dee9260018060a01b03169360208151910182865af1613de7613753565b90836149d9565b8051908115159182613e18575b5050613e045750565b635274afe760e01b60005260045260246000fd5b81925090602091810103126102af57602001518015908115036102af573880613dfb565b600019670de0b6b3a7640000820991670de0b6b3a7640000820291828085109403938085039414613ef25781841015613ecf57670de0b6b3a764000082910960018219018216809204600281600302188082026002030280820260020302808202600203028082026002030280820260020302809102600203029360018380600003040190848311900302920304170290565b630c740aef60e31b600052600452670de0b6b3a764000060245260445260646000fd5b5091508115613eff570490565b634e487b7160e01b600052601260045260246000fd5b8015613eff576ec097ce7bc90715b34b9f10000000000590565b80600081131561405d57670de0b6b3a7640000811261403c57506001905b670de0b6b3a764000081056001600160801b03811160071b90811c6001600160401b03811160061b90811c63ffffffff811160051b90811c61ffff811160041b90811c9060ff821160031b91821c92600f841160021b93841c94600160038711811b96871c119617171717171717670de0b6b3a7640000810291811d90670de0b6b3a7640000821461402957506706f05b59d3b20000905b60008213613ff35750500290565b80670de0b6b3a764000091020590671bc16d674ec8000082121561401b575b60011d90613fe5565b809192019160011d90614012565b9050670de0b6b3a7640000929150020290565b60001991508015613eff576ec097ce7bc90715b34b9f100000000005613f4d565b63059b101b60e01b60005260045260246000fd5b60008112156140a05768033dd1780914b97114198112612e495761409790600003614071565b612d8990613f15565b680a688906bd8affffff811361492e57670de0b6b3a76400009060401b05600160bf1b67ff000000000000008216614805575b670de0b6b3a76400009066ff00000000000083166146f5575b65ff000000000083166145ed575b64ff0000000083166144ed575b63ff00000083166143f5575b62ff00008316614305575b61ff00831661421d575b60ff831661413d575b029060401c60bf031c90565b6080831661420a575b604083166141f7575b602083166141e4575b601083166141d1575b600883166141be575b600483166141ab575b60028316614198575b600183161561413157680100000000000000010260401c614131565b680100000000000000010260401c61417c565b680100000000000000030260401c614173565b680100000000000000060260401c61416a565b6801000000000000000b0260401c614161565b680100000000000000160260401c614158565b6801000000000000002c0260401c61414f565b680100000000000000590260401c614146565b61800083166142f2575b61400083166142df575b61200083166142cc575b61100083166142b9575b61080083166142a6575b6104008316614293575b6102008316614280575b61010083161561412857680100000000000000b10260401c614128565b680100000000000001630260401c614263565b680100000000000002c60260401c614259565b6801000000000000058c0260401c61424f565b68010000000000000b170260401c614245565b6801000000000000162e0260401c61423b565b68010000000000002c5d0260401c614231565b680100000000000058b90260401c614227565b6280000083166143e2575b6240000083166143cf575b6220000083166143bc575b6210000083166143a9575b620800008316614396575b620400008316614383575b620200008316614370575b6201000083161561411e576801000000000000b1720260401c61411e565b680100000000000162e40260401c614352565b6801000000000002c5c80260401c614347565b68010000000000058b910260401c61433c565b680100000000000b17210260401c614331565b68010000000000162e430260401c614326565b680100000000002c5c860260401c61431b565b6801000000000058b90c0260401c614310565b638000000083166144da575b634000000083166144c7575b632000000083166144b4575b631000000083166144a1575b6308000000831661448e575b6304000000831661447b575b63020000008316614468575b63010000008316156141135768010000000000b172180260401c614113565b6801000000000162e4300260401c614449565b68010000000002c5c8600260401c61443d565b680100000000058b90c00260401c614431565b6801000000000b17217f0260401c614425565b680100000000162e42ff0260401c614419565b6801000000002c5c85fe0260401c61440d565b68010000000058b90bfc0260401c614401565b64800000000083166145da575b64400000000083166145c7575b64200000000083166145b4575b64100000000083166145a1575b640800000000831661458e575b640400000000831661457b575b6402000000008316614568575b64010000000083161561410757680100000000b17217f80260401c614107565b68010000000162e42ff10260401c614548565b680100000002c5c85fe30260401c61453b565b6801000000058b90bfce0260401c61452e565b68010000000b17217fbb0260401c614521565b6801000000162e42fff00260401c614514565b68010000002c5c8601cc0260401c614507565b680100000058b90c0b490260401c6144fa565b6580000000000083166146e2575b6540000000000083166146cf575b6520000000000083166146bc575b6510000000000083166146a9575b650800000000008316614696575b650400000000008316614683575b650200000000008316614670575b650100000000008316156140fa576801000000b1721835510260401c6140fa565b680100000162e430e5a20260401c61464f565b6801000002c5c863b73f0260401c614641565b68010000058b90cf1e6e0260401c614633565b680100000b1721bcfc9a0260401c614625565b68010000162e43f4f8310260401c614617565b680100002c5c89d5ec6d0260401c614609565b6801000058b91b5bc9ae0260401c6145fb565b668000000000000083166147f2575b664000000000000083166147df575b662000000000000083166147cc575b661000000000000083166147b9575b660800000000000083166147a6575b66040000000000008316614793575b66020000000000008316614780575b66010000000000008316156140ec5768010000b17255775c040260401c6140ec565b6801000162e525ee05470260401c61475e565b68010002c5cc37da94920260401c61474f565b680100058ba01fb9f96d0260401c614740565b6801000b175effdc76ba0260401c614731565b680100162f3904051fa10260401c614722565b6801002c605e2e8cec500260401c614713565b68010058c86da1c09ea20260401c614704565b678000000000000000821661491b575b670de0b6b3a7640000906740000000000000008316614908575b67200000000000000083166148f5575b67100000000000000083166148e2575b67080000000000000083166148cf575b67040000000000000083166148bc575b67020000000000000083166148a9575b6701000000000000008316614896575b90506140d3565b680100b1afa5abcbed610260401c61488f565b68010163da9fb33356d80260401c61487f565b680102c9a3e778060ee70260401c61486f565b6801059b0d31585743ae0260401c61485f565b68010b5586cf9890f62a0260401c61484f565b6801172b83c7d517adce0260401c61483f565b6801306fe0a31b7152df0260401c61482f565b5068016a09e667f3bcc909607f1b614815565b626c1a0560e31b60005260045260246000fd5b909190600019838209838202918280831092039180830392146149c857670de0b6b3a76400008210156149af577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b8490635173648d60e01b60005260045260245260446000fd5b5050670de0b6b3a764000090049150565b906149ff57508051156149ee57805190602001fd5b630a12f52160e11b60005260046000fd5b81511580614a31575b614a10575090565b639996b31560e01b60009081526001600160a01b0391909116600452602490fd5b50803b15614a0856fef8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce7a2646970667358221220f759c5f5fe74b188105d699977b6207c5efeec1b76320c3373be1daf7fed71bb64736f6c634300081a0033

0000000000000000000000008870cd5aed8a586929a11468ddb38d8a1370d509000000000000000000000000e083d24bb84b2fcb8a9c6783e1302591595d383a000000000000000000000000000000000000000000000000000000000000012c000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f

-----Decoded View---------------
Arg [0] : initialOwner (address): 0x8870cD5AED8A586929a11468DdB38d8A1370D509
Arg [1] : initialNFTDescriptor (address): 0xe083d24BB84b2Fcb8A9c6783E1302591595d383a
Arg [2] : maxSegmentCount (uint256): 300
Arg [3] : uncn (address): 0xf2B028ED5977F136982FDfa429814cf19f09693F

-----Encoded View---------------
4 Constructor Arguments found :
Arg [0] : 0000000000000000000000008870cd5aed8a586929a11468ddb38d8a1370d509
Arg [1] : 000000000000000000000000e083d24bb84b2fcb8a9c6783e1302591595d383a
Arg [2] : 000000000000000000000000000000000000000000000000000000000000012c
Arg [3] : 000000000000000000000000f2b028ed5977f136982fdfa429814cf19f09693f