ETH Price: $2,422.14 (+7.18%)

Transaction Decoder

Block:
19286904 at Feb-23-2024 01:05:11 AM +UTC
Transaction Fee:
0.002677347828073296 ETH $6.48
Gas Used:
68,922 Gas / 38.846055368 Gwei

Emitted Events:

451 PrismaToken.Approval( owner=PrismaVault, spender=[Receiver] AllocationVesting, value=65748944266858719983720052 )
452 PrismaToken.Transfer( from=PrismaVault, to=[Sender] 0x02e86d06a4a50a3fc68817adcea4d93580db3977, value=3487484737484737484738 )

Account State Difference:

  Address   Before After State Difference Code
0x02e86d06...580db3977
1.826892385456490069 Eth
Nonce: 379
1.824215037628416773 Eth
Nonce: 380
0.002677347828073296
0xC72bc1a8...B40436A0f
0xdA47862a...b95afd71C
(Flashbots: Builder)
0.131250769845252586 Eth0.131250838767252586 Eth0.000000068922

Execution Trace

AllocationVesting.claim( account=0x02e86d06A4A50a3fC68817ADCEa4d93580db3977 )
  • PrismaToken.transferFrom( from=0x06bDF212C290473dCACea9793890C5024c7Eb02c, to=0x02e86d06A4A50a3fC68817ADCEa4d93580db3977, amount=3487484737484737484738 ) => ( True )
    File 1 of 3: AllocationVesting
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    import { IERC20 } from "IERC20.sol";
    import { DelegatedOps } from "DelegatedOps.sol";
    import { ITokenLocker } from "ITokenLocker.sol";
    /**
     * @title Vesting contract for team and investors
     * @author PrismaFi
     * @notice Vesting contract which allows transfer of future vesting claims
     */
    contract AllocationVesting is DelegatedOps {
        error NothingToClaim();
        error CannotLock();
        error WrongMaxTotalPreclaimPct();
        error PreclaimTooLarge();
        error AllocationsMismatch();
        error ZeroTotalAllocation();
        error ZeroAllocation();
        error ZeroNumberOfWeeks();
        error DuplicateAllocation();
        error InsufficientPoints();
        error LockedAllocation();
        error SelfTransfer();
        error IncompatibleVestingPeriod(uint256 numberOfWeeksFrom, uint256 numberOfWeeksTo);
        struct AllocationSplit {
            address recipient;
            uint24 points;
            uint8 numberOfWeeks;
        }
        struct AllocationState {
            uint24 points;
            uint8 numberOfWeeks;
            uint128 claimed;
            uint96 preclaimed;
        }
        // This number should allow a good precision in allocation fractions
        uint256 private immutable totalPoints;
        // Users allocations
        mapping(address => AllocationState) public allocations;
        // max percentage of one's vest that can be preclaimed in total
        uint256 public immutable maxTotalPreclaimPct;
        // Total allocation expressed in tokens
        uint256 public immutable totalAllocation;
        IERC20 public immutable vestingToken;
        address public immutable vault;
        ITokenLocker public immutable tokenLocker;
        uint256 public immutable lockToTokenRatio;
        // Vesting timeline starting timestamp
        uint256 public immutable vestingStart;
        constructor(
            IERC20 vestingToken_,
            ITokenLocker tokenLocker_,
            uint256 totalAllocation_,
            address vault_,
            uint256 maxTotalPreclaimPct_,
            uint256 vestingStart_,
            AllocationSplit[] memory allocationSplits
        ) {
            if (totalAllocation_ == 0) revert ZeroTotalAllocation();
            if (maxTotalPreclaimPct_ > 20) revert WrongMaxTotalPreclaimPct();
            vault = vault_;
            tokenLocker = tokenLocker_;
            vestingToken = vestingToken_;
            totalAllocation = totalAllocation_;
            lockToTokenRatio = tokenLocker_.lockToTokenRatio();
            maxTotalPreclaimPct = maxTotalPreclaimPct_;
            vestingStart = vestingStart_;
            uint256 loopEnd = allocationSplits.length;
            uint256 total;
            for (uint256 i; i < loopEnd; ) {
                address recipient = allocationSplits[i].recipient;
                uint8 numberOfWeeks = allocationSplits[i].numberOfWeeks;
                uint256 points = allocationSplits[i].points;
                if (points == 0) revert ZeroAllocation();
                if (numberOfWeeks == 0) revert ZeroNumberOfWeeks();
                if (allocations[recipient].numberOfWeeks > 0) revert DuplicateAllocation();
                total += points;
                allocations[recipient].points = uint24(points);
                allocations[recipient].numberOfWeeks = numberOfWeeks;
                unchecked {
                    ++i;
                }
            }
            totalPoints = total;
        }
        /**
         * @notice Claims accrued tokens for initiator and transfers a number of allocation points to a recipient
         * @dev Can be delegated
         * @param from Initiator
         * @param to Recipient
         * @param points Number of points to transfer
         */
        function transferPoints(address from, address to, uint256 points) external callerOrDelegated(from) {
            if (from == to) revert SelfTransfer();
            AllocationState memory fromAllocation = allocations[from];
            AllocationState memory toAllocation = allocations[to];
            uint8 numberOfWeeksFrom = fromAllocation.numberOfWeeks;
            uint8 numberOfWeeksTo = toAllocation.numberOfWeeks;
            uint256 pointsFrom = fromAllocation.points;
            if (numberOfWeeksTo != 0 && numberOfWeeksTo != numberOfWeeksFrom)
                revert IncompatibleVestingPeriod(numberOfWeeksFrom, numberOfWeeksTo);
            uint256 totalVested = _vestedAt(block.timestamp, pointsFrom, numberOfWeeksFrom);
            if (totalVested < fromAllocation.claimed) revert LockedAllocation();
            if (points == 0) revert ZeroAllocation();
            if (pointsFrom < points) revert InsufficientPoints();
            // We claim one last time before transfer
            uint256 claimed = _claim(from, pointsFrom, fromAllocation.claimed, numberOfWeeksFrom);
            // Passive balance to transfer
            uint128 claimedAdjustment = uint128((claimed * points) / fromAllocation.points);
            allocations[from].points = uint24(pointsFrom - points);
            // we can't use fromAllocation.claimed since the storage value was modified by the _claim() call
            allocations[from].claimed = allocations[from].claimed - claimedAdjustment;
            allocations[to].points = toAllocation.points + uint24(points);
            allocations[to].claimed = toAllocation.claimed + claimedAdjustment;
            // Transfer preclaimed pro-rata to avoid limit gaming
            uint256 preclaimedToTransfer = (fromAllocation.preclaimed * points) / pointsFrom;
            allocations[to].preclaimed = uint96(toAllocation.preclaimed + preclaimedToTransfer);
            allocations[from].preclaimed = uint96(fromAllocation.preclaimed - preclaimedToTransfer);
            if (numberOfWeeksTo == 0) {
                allocations[to].numberOfWeeks = numberOfWeeksFrom;
            }
        }
        /**
         * @notice Lock future claimable tokens tokens
         * @dev Can be delegated
         * @param account Account to lock for
         * @param amount Amount to preclaim
         */
        function lockFutureClaims(address account, uint256 amount) external callerOrDelegated(account) {
            lockFutureClaimsWithReceiver(account, account, amount);
        }
        /**
         * @notice Lock future claimable tokens tokens
         * @dev Can be delegated
         * @param account Account to lock for
         * @param receiver Receiver of the lock
         * @param amount Amount to preclaim. If 0 the maximum allowed will be locked
         */
        function lockFutureClaimsWithReceiver(
            address account,
            address receiver,
            uint256 amount
        ) public callerOrDelegated(account) {
            AllocationState memory allocation = allocations[account];
            if (allocation.points == 0 || vestingStart == 0) revert CannotLock();
            uint256 claimedUpdated = allocation.claimed;
            if (_claimableAt(block.timestamp, allocation.points, allocation.claimed, allocation.numberOfWeeks) > 0) {
                claimedUpdated = _claim(account, allocation.points, allocation.claimed, allocation.numberOfWeeks);
            }
            uint256 userAllocation = (allocation.points * totalAllocation) / totalPoints;
            uint256 _unclaimed = userAllocation - claimedUpdated;
            uint256 preclaimed = allocation.preclaimed;
            uint256 maxTotalPreclaim = (maxTotalPreclaimPct * userAllocation) / 100;
            uint256 leftToPreclaim = maxTotalPreclaim - preclaimed;
            if (amount == 0) amount = leftToPreclaim > _unclaimed ? _unclaimed : leftToPreclaim;
            else if (preclaimed + amount > maxTotalPreclaim || amount > _unclaimed) revert PreclaimTooLarge();
            amount = (amount / lockToTokenRatio) * lockToTokenRatio; // truncating the dust
            allocations[account].claimed = uint128(claimedUpdated + amount);
            allocations[account].preclaimed = uint96(preclaimed + amount);
            vestingToken.transferFrom(vault, address(this), amount);
            tokenLocker.lock(receiver, amount / lockToTokenRatio, 52);
        }
        /**
         *
         * @notice Claims accrued tokens
         * @dev Can be delegated
         * @param account Account to claim for
         */
        function claim(address account) external callerOrDelegated(account) {
            AllocationState memory allocation = allocations[account];
            _claim(account, allocation.points, allocation.claimed, allocation.numberOfWeeks);
        }
        // This function exists to avoid reloading the AllocationState struct in memory
        function _claim(
            address account,
            uint256 points,
            uint256 claimed,
            uint256 numberOfWeeks
        ) private returns (uint256 claimedUpdated) {
            if (points == 0) revert NothingToClaim();
            uint256 claimable = _claimableAt(block.timestamp, points, claimed, numberOfWeeks);
            if (claimable == 0) revert NothingToClaim();
            claimedUpdated = claimed + claimable;
            allocations[account].claimed = uint128(claimedUpdated);
            // We send to delegate for possible zaps
            vestingToken.transferFrom(vault, msg.sender, claimable);
        }
        /**
         * @notice Calculates number of tokens claimable by the user at the current block
         * @param account Account to calculate for
         * @return claimable Accrued tokens
         */
        function claimableNow(address account) external view returns (uint256 claimable) {
            AllocationState memory allocation = allocations[account];
            claimable = _claimableAt(block.timestamp, allocation.points, allocation.claimed, allocation.numberOfWeeks);
        }
        function _claimableAt(
            uint256 when,
            uint256 points,
            uint256 claimed,
            uint256 numberOfWeeks
        ) private view returns (uint256) {
            uint256 totalVested = _vestedAt(when, points, numberOfWeeks);
            return totalVested > claimed ? totalVested - claimed : 0;
        }
        function _vestedAt(uint256 when, uint256 points, uint256 numberOfWeeks) private view returns (uint256 vested) {
            if (vestingStart == 0 || numberOfWeeks == 0) return 0;
            uint256 vestingWeeks = numberOfWeeks * 1 weeks;
            uint256 vestingEnd = vestingStart + vestingWeeks;
            uint256 endTime = when >= vestingEnd ? vestingEnd : when;
            uint256 timeSinceStart = endTime - vestingStart;
            vested = (totalAllocation * timeSinceStart * points) / (totalPoints * vestingWeeks);
        }
        /**
         * @notice Calculates the total number of tokens left unclaimed by the user including unvested ones
         * @param account Account to calculate for
         * @return Unclaimed tokens
         */
        function unclaimed(address account) external view returns (uint256) {
            AllocationState memory allocation = allocations[account];
            uint256 accountAllocation = (totalAllocation * allocation.points) / totalPoints;
            return accountAllocation - allocation.claimed;
        }
        /**
         * @notice Calculates the total number of tokens left to preclaim
         * @param account Account to calculate for
         * @return Preclaimable tokens
         */
        function preclaimable(address account) external view returns (uint256) {
            AllocationState memory allocation = allocations[account];
            if (allocation.points == 0 || vestingStart == 0) return 0;
            uint256 userAllocation = (allocation.points * totalAllocation) / totalPoints;
            uint256 preclaimed = allocation.preclaimed;
            uint256 maxTotalPreclaim = (maxTotalPreclaimPct * userAllocation) / 100;
            return maxTotalPreclaim - preclaimed;
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
    pragma solidity ^0.8.0;
    /**
     * @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 amount of tokens in existence.
         */
        function totalSupply() external view returns (uint256);
        /**
         * @dev Returns the amount of tokens owned by `account`.
         */
        function balanceOf(address account) external view returns (uint256);
        /**
         * @dev Moves `amount` tokens from the caller's account to `to`.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transfer(address to, uint256 amount) external returns (bool);
        /**
         * @dev Returns the remaining number of tokens that `spender` will be
         * allowed to spend on behalf of `owner` through {transferFrom}. This is
         * zero by default.
         *
         * This value changes when {approve} or {transferFrom} are called.
         */
        function allowance(address owner, address spender) external view returns (uint256);
        /**
         * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * IMPORTANT: Beware that changing an allowance with this method brings the risk
         * that someone may use both the old and the new allowance by unfortunate
         * transaction ordering. One possible solution to mitigate this race
         * condition is to first reduce the spender's allowance to 0 and set the
         * desired value afterwards:
         * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
         *
         * Emits an {Approval} event.
         */
        function approve(address spender, uint256 amount) external returns (bool);
        /**
         * @dev Moves `amount` tokens from `from` to `to` using the
         * allowance mechanism. `amount` is then deducted from the caller's
         * allowance.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transferFrom(
            address from,
            address to,
            uint256 amount
        ) external returns (bool);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    /**
        @title Prisma Delegated Operations
        @notice Allows delegation to specific contract functionality. Useful for creating
                wrapper contracts to bundle multiple interactions into a single call.
                Functions that supports delegation should include an `account` input allowing
                the delegated caller to indicate who they are calling on behalf of. In executing
                the call, all internal state updates should be applied for `account` and all
                value transfers should occur to or from the caller.
                For example: a delegated call to `openTrove` should transfer collateral
                from the caller, create the debt position for `account`, and send newly
                minted tokens to the caller.
     */
    contract DelegatedOps {
        mapping(address owner => mapping(address caller => bool isApproved)) public isApprovedDelegate;
        modifier callerOrDelegated(address _account) {
            require(msg.sender == _account || isApprovedDelegate[_account][msg.sender], "Delegate not approved");
            _;
        }
        function setDelegateApproval(address _delegate, bool _isApproved) external {
            isApprovedDelegate[msg.sender][_delegate] = _isApproved;
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface ITokenLocker {
        struct LockData {
            uint256 amount;
            uint256 weeksToUnlock;
        }
        struct ExtendLockData {
            uint256 amount;
            uint256 currentWeeks;
            uint256 newWeeks;
        }
        event LockCreated(address indexed account, uint256 amount, uint256 _weeks);
        event LockExtended(address indexed account, uint256 amount, uint256 _weeks, uint256 newWeeks);
        event LocksCreated(address indexed account, LockData[] newLocks);
        event LocksExtended(address indexed account, ExtendLockData[] locks);
        event LocksFrozen(address indexed account, uint256 amount);
        event LocksUnfrozen(address indexed account, uint256 amount);
        event LocksWithdrawn(address indexed account, uint256 withdrawn, uint256 penalty);
        function extendLock(uint256 _amount, uint256 _weeks, uint256 _newWeeks) external returns (bool);
        function extendMany(ExtendLockData[] calldata newExtendLocks) external returns (bool);
        function freeze() external;
        function getAccountWeightWrite(address account) external returns (uint256);
        function getTotalWeightWrite() external returns (uint256);
        function lock(address _account, uint256 _amount, uint256 _weeks) external returns (bool);
        function lockMany(address _account, LockData[] calldata newLocks) external returns (bool);
        function setPenaltyWithdrawalsEnabled(bool _enabled) external returns (bool);
        function unfreeze(bool keepIncentivesVote) external;
        function withdrawExpiredLocks(uint256 _weeks) external returns (bool);
        function withdrawWithPenalty(uint256 amountToWithdraw) external returns (uint256);
        function MAX_LOCK_WEEKS() external view returns (uint256);
        function PRISMA_CORE() external view returns (address);
        function getAccountActiveLocks(
            address account,
            uint256 minWeeks
        ) external view returns (LockData[] memory lockData, uint256 frozenAmount);
        function getAccountBalances(address account) external view returns (uint256 locked, uint256 unlocked);
        function getAccountWeight(address account) external view returns (uint256);
        function getAccountWeightAt(address account, uint256 week) external view returns (uint256);
        function getTotalWeight() external view returns (uint256);
        function getTotalWeightAt(uint256 week) external view returns (uint256);
        function getWeek() external view returns (uint256 week);
        function getWithdrawWithPenaltyAmounts(
            address account,
            uint256 amountToWithdraw
        ) external view returns (uint256 amountWithdrawn, uint256 penaltyAmountPaid);
        function guardian() external view returns (address);
        function incentiveVoter() external view returns (address);
        function lockToTokenRatio() external view returns (uint256);
        function lockToken() external view returns (address);
        function owner() external view returns (address);
        function penaltyWithdrawalsEnabled() external view returns (bool);
        function prismaCore() external view returns (address);
        function totalDecayRate() external view returns (uint32);
        function totalUpdatedWeek() external view returns (uint16);
    }
    

    File 2 of 3: PrismaToken
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    import "IERC2612.sol";
    import { OFT, IERC20, ERC20 } from "OFT.sol";
    /**
        @title Prisma Governance Token
        @notice Given as an incentive for users of the protocol. Can be locked in `TokenLocker`
                to receive lock weight, which gives governance power within the Prisma DAO.
     */
    contract PrismaToken is OFT, IERC2612 {
        // --- ERC20 Data ---
        string internal constant _NAME = "Prisma Governance Token";
        string internal constant _SYMBOL = "PRISMA";
        string public constant version = "1";
        // --- EIP 2612 Data ---
        // keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)");
        bytes32 public constant permitTypeHash = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9;
        // keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
        bytes32 private constant _TYPE_HASH = 0x8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f;
        // Cache the domain separator as an immutable value, but also store the chain id that it
        // corresponds to, in order to invalidate the cached domain separator if the chain id changes.
        bytes32 private immutable _CACHED_DOMAIN_SEPARATOR;
        uint256 private immutable _CACHED_CHAIN_ID;
        bytes32 private immutable _HASHED_NAME;
        bytes32 private immutable _HASHED_VERSION;
        address public immutable locker;
        address public immutable vault;
        uint256 public maxTotalSupply;
        mapping(address => uint256) private _nonces;
        // --- Functions ---
        constructor(address _vault, address _layerZeroEndpoint, address _locker) OFT(_NAME, _SYMBOL, _layerZeroEndpoint) {
            bytes32 hashedName = keccak256(bytes(_NAME));
            bytes32 hashedVersion = keccak256(bytes(version));
            _HASHED_NAME = hashedName;
            _HASHED_VERSION = hashedVersion;
            _CACHED_CHAIN_ID = block.chainid;
            _CACHED_DOMAIN_SEPARATOR = _buildDomainSeparator(_TYPE_HASH, hashedName, hashedVersion);
            locker = _locker;
            vault = _vault;
        }
        function mintToVault(uint256 _totalSupply) external returns (bool) {
            require(msg.sender == vault);
            require(maxTotalSupply == 0);
            _mint(vault, _totalSupply);
            maxTotalSupply = _totalSupply;
            return true;
        }
        // --- EIP 2612 functionality ---
        function domainSeparator() public view override returns (bytes32) {
            if (block.chainid == _CACHED_CHAIN_ID) {
                return _CACHED_DOMAIN_SEPARATOR;
            } else {
                return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION);
            }
        }
        function permit(
            address owner,
            address spender,
            uint256 amount,
            uint256 deadline,
            uint8 v,
            bytes32 r,
            bytes32 s
        ) external override {
            require(deadline >= block.timestamp, "PRISMA: expired deadline");
            bytes32 digest = keccak256(
                abi.encodePacked(
                    "\\x19\\x01",
                    domainSeparator(),
                    keccak256(abi.encode(permitTypeHash, owner, spender, amount, _nonces[owner]++, deadline))
                )
            );
            address recoveredAddress = ecrecover(digest, v, r, s);
            require(recoveredAddress == owner, "PRISMA: invalid signature");
            _approve(owner, spender, amount);
        }
        function nonces(address owner) external view override returns (uint256) {
            // FOR EIP 2612
            return _nonces[owner];
        }
        function transferToLocker(address sender, uint256 amount) external returns (bool) {
            require(msg.sender == locker, "Not locker");
            _transfer(sender, locker, amount);
            return true;
        }
        // --- Internal operations ---
        function _buildDomainSeparator(bytes32 typeHash, bytes32 name_, bytes32 version_) private view returns (bytes32) {
            return keccak256(abi.encode(typeHash, name_, version_, block.chainid, address(this)));
        }
        function _beforeTokenTransfer(address, address to, uint256) internal virtual override {
            require(to != address(this), "ERC20: transfer to the token address");
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    /**
     * @dev Interface of the ERC2612 standard as defined in the EIP.
     *
     * Adds the {permit} method, which can be used to change one's
     * {IERC20-allowance} without having to send a transaction, by signing a
     * message. This allows users to spend tokens without having to hold Ether.
     *
     * See https://eips.ethereum.org/EIPS/eip-2612.
     *
     * Code adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/pull/2237/
     */
    interface IERC2612 {
        /**
         * @dev Sets `amount` 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:
         *
         * - `owner` cannot be the zero address.
         * - `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].
         */
        function permit(
            address owner,
            address spender,
            uint256 amount,
            uint256 deadline,
            uint8 v,
            bytes32 r,
            bytes32 s
        ) external;
        /**
         * @dev Returns the current ERC2612 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.
         *
         * `owner` can limit the time a Permit is valid for by setting `deadline` to
         * a value in the near future. The deadline argument can be set to uint(-1) to
         * create Permits that effectively never expire.
         */
        function nonces(address owner) external view returns (uint256);
        function version() external view returns (string memory);
        function permitTypeHash() external view returns (bytes32);
        function domainSeparator() external view returns (bytes32);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    import "ERC20.sol";
    import "IERC165.sol";
    import "IOFT.sol";
    import "OFTCore.sol";
    // override decimal() function is needed
    contract OFT is OFTCore, ERC20, IOFT {
        constructor(string memory _name, string memory _symbol, address _lzEndpoint) ERC20(_name, _symbol) OFTCore(_lzEndpoint) {}
        function supportsInterface(bytes4 interfaceId) public view virtual override(OFTCore, IERC165) returns (bool) {
            return interfaceId == type(IOFT).interfaceId || interfaceId == type(IERC20).interfaceId || super.supportsInterface(interfaceId);
        }
        function token() public view virtual override returns (address) {
            return address(this);
        }
        function circulatingSupply() public view virtual override returns (uint) {
            return totalSupply();
        }
        function _debitFrom(address _from, uint16, bytes memory, uint _amount) internal virtual override returns(uint) {
            address spender = _msgSender();
            if (_from != spender) _spendAllowance(_from, spender, _amount);
            _burn(_from, _amount);
            return _amount;
        }
        function _creditTo(uint16, address _toAddress, uint _amount) internal virtual override returns(uint) {
            _mint(_toAddress, _amount);
            return _amount;
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)
    pragma solidity ^0.8.0;
    import "IERC20.sol";
    import "IERC20Metadata.sol";
    import "Context.sol";
    /**
     * @dev Implementation of the {IERC20} interface.
     *
     * This implementation is agnostic to the way tokens are created. This means
     * that a supply mechanism has to be added in a derived contract using {_mint}.
     * For a generic mechanism see {ERC20PresetMinterPauser}.
     *
     * TIP: For a detailed writeup see our guide
     * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
     * to implement supply mechanisms].
     *
     * We have followed general OpenZeppelin Contracts guidelines: functions revert
     * instead returning `false` on failure. This behavior is nonetheless
     * conventional and does not conflict with the expectations of ERC20
     * applications.
     *
     * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
     * This allows applications to reconstruct the allowance for all accounts just
     * by listening to said events. Other implementations of the EIP may not emit
     * these events, as it isn't required by the specification.
     *
     * Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
     * functions have been added to mitigate the well-known issues around setting
     * allowances. See {IERC20-approve}.
     */
    contract ERC20 is Context, IERC20, IERC20Metadata {
        mapping(address => uint256) private _balances;
        mapping(address => mapping(address => uint256)) private _allowances;
        uint256 private _totalSupply;
        string private _name;
        string private _symbol;
        /**
         * @dev Sets the values for {name} and {symbol}.
         *
         * The default value of {decimals} is 18. To select a different value for
         * {decimals} you should overload it.
         *
         * All two of these values are immutable: they can only be set once during
         * construction.
         */
        constructor(string memory name_, string memory symbol_) {
            _name = name_;
            _symbol = symbol_;
        }
        /**
         * @dev Returns the name of the token.
         */
        function name() public view virtual override returns (string memory) {
            return _name;
        }
        /**
         * @dev Returns the symbol of the token, usually a shorter version of the
         * name.
         */
        function symbol() public view virtual override returns (string memory) {
            return _symbol;
        }
        /**
         * @dev Returns the number of decimals used to get its user representation.
         * For example, if `decimals` equals `2`, a balance of `505` tokens should
         * be displayed to a user as `5.05` (`505 / 10 ** 2`).
         *
         * Tokens usually opt for a value of 18, imitating the relationship between
         * Ether and Wei. This is the value {ERC20} uses, unless this function is
         * overridden;
         *
         * NOTE: This information is only used for _display_ purposes: it in
         * no way affects any of the arithmetic of the contract, including
         * {IERC20-balanceOf} and {IERC20-transfer}.
         */
        function decimals() public view virtual override returns (uint8) {
            return 18;
        }
        /**
         * @dev See {IERC20-totalSupply}.
         */
        function totalSupply() public view virtual override returns (uint256) {
            return _totalSupply;
        }
        /**
         * @dev See {IERC20-balanceOf}.
         */
        function balanceOf(address account) public view virtual override returns (uint256) {
            return _balances[account];
        }
        /**
         * @dev See {IERC20-transfer}.
         *
         * Requirements:
         *
         * - `to` cannot be the zero address.
         * - the caller must have a balance of at least `amount`.
         */
        function transfer(address to, uint256 amount) public virtual override returns (bool) {
            address owner = _msgSender();
            _transfer(owner, to, amount);
            return true;
        }
        /**
         * @dev See {IERC20-allowance}.
         */
        function allowance(address owner, address spender) public view virtual override returns (uint256) {
            return _allowances[owner][spender];
        }
        /**
         * @dev See {IERC20-approve}.
         *
         * NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
         * `transferFrom`. This is semantically equivalent to an infinite approval.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         */
        function approve(address spender, uint256 amount) public virtual override returns (bool) {
            address owner = _msgSender();
            _approve(owner, spender, amount);
            return true;
        }
        /**
         * @dev See {IERC20-transferFrom}.
         *
         * Emits an {Approval} event indicating the updated allowance. This is not
         * required by the EIP. See the note at the beginning of {ERC20}.
         *
         * NOTE: Does not update the allowance if the current allowance
         * is the maximum `uint256`.
         *
         * Requirements:
         *
         * - `from` and `to` cannot be the zero address.
         * - `from` must have a balance of at least `amount`.
         * - the caller must have allowance for ``from``'s tokens of at least
         * `amount`.
         */
        function transferFrom(
            address from,
            address to,
            uint256 amount
        ) public virtual override returns (bool) {
            address spender = _msgSender();
            _spendAllowance(from, spender, amount);
            _transfer(from, to, amount);
            return true;
        }
        /**
         * @dev Atomically increases the allowance granted to `spender` by the caller.
         *
         * This is an alternative to {approve} that can be used as a mitigation for
         * problems described in {IERC20-approve}.
         *
         * Emits an {Approval} event indicating the updated allowance.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         */
        function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
            address owner = _msgSender();
            _approve(owner, spender, allowance(owner, spender) + addedValue);
            return true;
        }
        /**
         * @dev Atomically decreases the allowance granted to `spender` by the caller.
         *
         * This is an alternative to {approve} that can be used as a mitigation for
         * problems described in {IERC20-approve}.
         *
         * Emits an {Approval} event indicating the updated allowance.
         *
         * Requirements:
         *
         * - `spender` cannot be the zero address.
         * - `spender` must have allowance for the caller of at least
         * `subtractedValue`.
         */
        function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
            address owner = _msgSender();
            uint256 currentAllowance = allowance(owner, spender);
            require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
            unchecked {
                _approve(owner, spender, currentAllowance - subtractedValue);
            }
            return true;
        }
        /**
         * @dev Moves `amount` of tokens from `from` to `to`.
         *
         * This internal function is equivalent to {transfer}, and can be used to
         * e.g. implement automatic token fees, slashing mechanisms, etc.
         *
         * Emits a {Transfer} event.
         *
         * Requirements:
         *
         * - `from` cannot be the zero address.
         * - `to` cannot be the zero address.
         * - `from` must have a balance of at least `amount`.
         */
        function _transfer(
            address from,
            address to,
            uint256 amount
        ) internal virtual {
            require(from != address(0), "ERC20: transfer from the zero address");
            require(to != address(0), "ERC20: transfer to the zero address");
            _beforeTokenTransfer(from, to, amount);
            uint256 fromBalance = _balances[from];
            require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
            unchecked {
                _balances[from] = fromBalance - amount;
                // Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by
                // decrementing then incrementing.
                _balances[to] += amount;
            }
            emit Transfer(from, to, amount);
            _afterTokenTransfer(from, to, amount);
        }
        /** @dev Creates `amount` tokens and assigns them to `account`, increasing
         * the total supply.
         *
         * Emits a {Transfer} event with `from` set to the zero address.
         *
         * Requirements:
         *
         * - `account` cannot be the zero address.
         */
        function _mint(address account, uint256 amount) internal virtual {
            require(account != address(0), "ERC20: mint to the zero address");
            _beforeTokenTransfer(address(0), account, amount);
            _totalSupply += amount;
            unchecked {
                // Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.
                _balances[account] += amount;
            }
            emit Transfer(address(0), account, amount);
            _afterTokenTransfer(address(0), account, amount);
        }
        /**
         * @dev Destroys `amount` tokens from `account`, reducing the
         * total supply.
         *
         * Emits a {Transfer} event with `to` set to the zero address.
         *
         * Requirements:
         *
         * - `account` cannot be the zero address.
         * - `account` must have at least `amount` tokens.
         */
        function _burn(address account, uint256 amount) internal virtual {
            require(account != address(0), "ERC20: burn from the zero address");
            _beforeTokenTransfer(account, address(0), amount);
            uint256 accountBalance = _balances[account];
            require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
            unchecked {
                _balances[account] = accountBalance - amount;
                // Overflow not possible: amount <= accountBalance <= totalSupply.
                _totalSupply -= amount;
            }
            emit Transfer(account, address(0), amount);
            _afterTokenTransfer(account, address(0), amount);
        }
        /**
         * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
         *
         * This internal function is equivalent to `approve`, and can be used to
         * e.g. set automatic allowances for certain subsystems, etc.
         *
         * Emits an {Approval} event.
         *
         * Requirements:
         *
         * - `owner` cannot be the zero address.
         * - `spender` cannot be the zero address.
         */
        function _approve(
            address owner,
            address spender,
            uint256 amount
        ) internal virtual {
            require(owner != address(0), "ERC20: approve from the zero address");
            require(spender != address(0), "ERC20: approve to the zero address");
            _allowances[owner][spender] = amount;
            emit Approval(owner, spender, amount);
        }
        /**
         * @dev Updates `owner` s allowance for `spender` based on spent `amount`.
         *
         * Does not update the allowance amount in case of infinite allowance.
         * Revert if not enough allowance is available.
         *
         * Might emit an {Approval} event.
         */
        function _spendAllowance(
            address owner,
            address spender,
            uint256 amount
        ) internal virtual {
            uint256 currentAllowance = allowance(owner, spender);
            if (currentAllowance != type(uint256).max) {
                require(currentAllowance >= amount, "ERC20: insufficient allowance");
                unchecked {
                    _approve(owner, spender, currentAllowance - amount);
                }
            }
        }
        /**
         * @dev Hook that is called before any transfer of tokens. This includes
         * minting and burning.
         *
         * Calling conditions:
         *
         * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
         * will be transferred to `to`.
         * - when `from` is zero, `amount` tokens will be minted for `to`.
         * - when `to` is zero, `amount` of ``from``'s tokens will be burned.
         * - `from` and `to` are never both zero.
         *
         * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
         */
        function _beforeTokenTransfer(
            address from,
            address to,
            uint256 amount
        ) internal virtual {}
        /**
         * @dev Hook that is called after any transfer of tokens. This includes
         * minting and burning.
         *
         * Calling conditions:
         *
         * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
         * has been transferred to `to`.
         * - when `from` is zero, `amount` tokens have been minted for `to`.
         * - when `to` is zero, `amount` of ``from``'s tokens have been burned.
         * - `from` and `to` are never both zero.
         *
         * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
         */
        function _afterTokenTransfer(
            address from,
            address to,
            uint256 amount
        ) internal virtual {}
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
    pragma solidity ^0.8.0;
    /**
     * @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 amount of tokens in existence.
         */
        function totalSupply() external view returns (uint256);
        /**
         * @dev Returns the amount of tokens owned by `account`.
         */
        function balanceOf(address account) external view returns (uint256);
        /**
         * @dev Moves `amount` tokens from the caller's account to `to`.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transfer(address to, uint256 amount) external returns (bool);
        /**
         * @dev Returns the remaining number of tokens that `spender` will be
         * allowed to spend on behalf of `owner` through {transferFrom}. This is
         * zero by default.
         *
         * This value changes when {approve} or {transferFrom} are called.
         */
        function allowance(address owner, address spender) external view returns (uint256);
        /**
         * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * IMPORTANT: Beware that changing an allowance with this method brings the risk
         * that someone may use both the old and the new allowance by unfortunate
         * transaction ordering. One possible solution to mitigate this race
         * condition is to first reduce the spender's allowance to 0 and set the
         * desired value afterwards:
         * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
         *
         * Emits an {Approval} event.
         */
        function approve(address spender, uint256 amount) external returns (bool);
        /**
         * @dev Moves `amount` tokens from `from` to `to` using the
         * allowance mechanism. `amount` is then deducted from the caller's
         * allowance.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transferFrom(
            address from,
            address to,
            uint256 amount
        ) external returns (bool);
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
    pragma solidity ^0.8.0;
    import "IERC20.sol";
    /**
     * @dev Interface for the optional metadata functions from the ERC20 standard.
     *
     * _Available since v4.1._
     */
    interface IERC20Metadata is IERC20 {
        /**
         * @dev Returns the name of the token.
         */
        function name() external view returns (string memory);
        /**
         * @dev Returns the symbol of the token.
         */
        function symbol() external view returns (string memory);
        /**
         * @dev Returns the decimals places of the token.
         */
        function decimals() external view returns (uint8);
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
    pragma solidity ^0.8.0;
    /**
     * @dev Provides information about the current execution context, including the
     * sender of the transaction and its data. While these are generally available
     * via msg.sender and msg.data, they should not be accessed in such a direct
     * manner, since when dealing with 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;
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
    pragma solidity ^0.8.0;
    /**
     * @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
    pragma solidity >=0.5.0;
    import "IOFTCore.sol";
    import "IERC20.sol";
    /**
     * @dev Interface of the OFT standard
     */
    interface IOFT is IOFTCore, IERC20 {
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.5.0;
    import "IERC165.sol";
    /**
     * @dev Interface of the IOFT core standard
     */
    interface IOFTCore is IERC165 {
        /**
         * @dev estimate send token `_tokenId` to (`_dstChainId`, `_toAddress`)
         * _dstChainId - L0 defined chain id to send tokens too
         * _toAddress - dynamic bytes array which contains the address to whom you are sending tokens to on the dstChain
         * _amount - amount of the tokens to transfer
         * _useZro - indicates to use zro to pay L0 fees
         * _adapterParam - flexible bytes array to indicate messaging adapter services in L0
         */
        function estimateSendFee(uint16 _dstChainId, bytes calldata _toAddress, uint _amount, bool _useZro, bytes calldata _adapterParams) external view returns (uint nativeFee, uint zroFee);
        /**
         * @dev send `_amount` amount of token to (`_dstChainId`, `_toAddress`) from `_from`
         * `_from` the owner of token
         * `_dstChainId` the destination chain identifier
         * `_toAddress` can be any size depending on the `dstChainId`.
         * `_amount` the quantity of tokens in wei
         * `_refundAddress` the address LayerZero refunds if too much message fee is sent
         * `_zroPaymentAddress` set to address(0x0) if not paying in ZRO (LayerZero Token)
         * `_adapterParams` is a flexible bytes array to indicate messaging adapter services
         */
        function sendFrom(address _from, uint16 _dstChainId, bytes calldata _toAddress, uint _amount, address payable _refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) external payable;
        /**
         * @dev returns the circulating amount of tokens on current chain
         */
        function circulatingSupply() external view returns (uint);
        /**
         * @dev returns the address of the ERC20 token
         */
        function token() external view returns (address);
        /**
         * @dev Emitted when `_amount` tokens are moved from the `_sender` to (`_dstChainId`, `_toAddress`)
         * `_nonce` is the outbound nonce
         */
        event SendToChain(uint16 indexed _dstChainId, address indexed _from, bytes _toAddress, uint _amount);
        /**
         * @dev Emitted when `_amount` tokens are received from `_srcChainId` into the `_toAddress` on the local chain.
         * `_nonce` is the inbound nonce.
         */
        event ReceiveFromChain(uint16 indexed _srcChainId, address indexed _to, uint _amount);
        event SetUseCustomAdapterParams(bool _useCustomAdapterParams);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    import "NonblockingLzApp.sol";
    import "IOFTCore.sol";
    import "ERC165.sol";
    abstract contract OFTCore is NonblockingLzApp, ERC165, IOFTCore {
        using BytesLib for bytes;
        uint public constant NO_EXTRA_GAS = 0;
        // packet type
        uint16 public constant PT_SEND = 0;
        bool public useCustomAdapterParams;
        constructor(address _lzEndpoint) NonblockingLzApp(_lzEndpoint) {}
        function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
            return interfaceId == type(IOFTCore).interfaceId || super.supportsInterface(interfaceId);
        }
        function estimateSendFee(uint16 _dstChainId, bytes calldata _toAddress, uint _amount, bool _useZro, bytes calldata _adapterParams) public view virtual override returns (uint nativeFee, uint zroFee) {
            // mock the payload for sendFrom()
            bytes memory payload = abi.encode(PT_SEND, _toAddress, _amount);
            return lzEndpoint.estimateFees(_dstChainId, address(this), payload, _useZro, _adapterParams);
        }
        function sendFrom(address _from, uint16 _dstChainId, bytes calldata _toAddress, uint _amount, address payable _refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) public payable virtual override {
            _send(_from, _dstChainId, _toAddress, _amount, _refundAddress, _zroPaymentAddress, _adapterParams);
        }
        function setUseCustomAdapterParams(bool _useCustomAdapterParams) public virtual onlyOwner {
            useCustomAdapterParams = _useCustomAdapterParams;
            emit SetUseCustomAdapterParams(_useCustomAdapterParams);
        }
        function _nonblockingLzReceive(uint16 _srcChainId, bytes memory _srcAddress, uint64 _nonce, bytes memory _payload) internal virtual override {
            uint16 packetType;
            assembly {
                packetType := mload(add(_payload, 32))
            }
            if (packetType == PT_SEND) {
                _sendAck(_srcChainId, _srcAddress, _nonce, _payload);
            } else {
                revert("OFTCore: unknown packet type");
            }
        }
        function _send(address _from, uint16 _dstChainId, bytes memory _toAddress, uint _amount, address payable _refundAddress, address _zroPaymentAddress, bytes memory _adapterParams) internal virtual {
            _checkAdapterParams(_dstChainId, PT_SEND, _adapterParams, NO_EXTRA_GAS);
            uint amount = _debitFrom(_from, _dstChainId, _toAddress, _amount);
            bytes memory lzPayload = abi.encode(PT_SEND, _toAddress, amount);
            _lzSend(_dstChainId, lzPayload, _refundAddress, _zroPaymentAddress, _adapterParams, msg.value);
            emit SendToChain(_dstChainId, _from, _toAddress, amount);
        }
        function _sendAck(uint16 _srcChainId, bytes memory, uint64, bytes memory _payload) internal virtual {
            (, bytes memory toAddressBytes, uint amount) = abi.decode(_payload, (uint16, bytes, uint));
            address to = toAddressBytes.toAddress(0);
            amount = _creditTo(_srcChainId, to, amount);
            emit ReceiveFromChain(_srcChainId, to, amount);
        }
        function _checkAdapterParams(uint16 _dstChainId, uint16 _pkType, bytes memory _adapterParams, uint _extraGas) internal virtual {
            if (useCustomAdapterParams) {
                _checkGasLimit(_dstChainId, _pkType, _adapterParams, _extraGas);
            } else {
                require(_adapterParams.length == 0, "OFTCore: _adapterParams must be empty.");
            }
        }
        function _debitFrom(address _from, uint16 _dstChainId, bytes memory _toAddress, uint _amount) internal virtual returns(uint);
        function _creditTo(uint16 _srcChainId, address _toAddress, uint _amount) internal virtual returns(uint);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    import "LzApp.sol";
    import "ExcessivelySafeCall.sol";
    /*
     * the default LayerZero messaging behaviour is blocking, i.e. any failed message will block the channel
     * this abstract class try-catch all fail messages and store locally for future retry. hence, non-blocking
     * NOTE: if the srcAddress is not configured properly, it will still block the message pathway from (srcChainId, srcAddress)
     */
    abstract contract NonblockingLzApp is LzApp {
        using ExcessivelySafeCall for address;
        constructor(address _endpoint) LzApp(_endpoint) {}
        mapping(uint16 => mapping(bytes => mapping(uint64 => bytes32))) public failedMessages;
        event MessageFailed(uint16 _srcChainId, bytes _srcAddress, uint64 _nonce, bytes _payload, bytes _reason);
        event RetryMessageSuccess(uint16 _srcChainId, bytes _srcAddress, uint64 _nonce, bytes32 _payloadHash);
        // overriding the virtual function in LzReceiver
        function _blockingLzReceive(uint16 _srcChainId, bytes memory _srcAddress, uint64 _nonce, bytes memory _payload) internal virtual override {
            (bool success, bytes memory reason) = address(this).excessivelySafeCall(gasleft(), 150, abi.encodeWithSelector(this.nonblockingLzReceive.selector, _srcChainId, _srcAddress, _nonce, _payload));
            // try-catch all errors/exceptions
            if (!success) {
                _storeFailedMessage(_srcChainId, _srcAddress, _nonce, _payload, reason);
            }
        }
        function _storeFailedMessage(uint16 _srcChainId, bytes memory _srcAddress, uint64 _nonce, bytes memory _payload, bytes memory _reason) internal virtual {
            failedMessages[_srcChainId][_srcAddress][_nonce] = keccak256(_payload);
            emit MessageFailed(_srcChainId, _srcAddress, _nonce, _payload, _reason);
        }
        function nonblockingLzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) public virtual {
            // only internal transaction
            require(_msgSender() == address(this), "NonblockingLzApp: caller must be LzApp");
            _nonblockingLzReceive(_srcChainId, _srcAddress, _nonce, _payload);
        }
        //@notice override this function
        function _nonblockingLzReceive(uint16 _srcChainId, bytes memory _srcAddress, uint64 _nonce, bytes memory _payload) internal virtual;
        function retryMessage(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) public payable virtual {
            // assert there is message to retry
            bytes32 payloadHash = failedMessages[_srcChainId][_srcAddress][_nonce];
            require(payloadHash != bytes32(0), "NonblockingLzApp: no stored message");
            require(keccak256(_payload) == payloadHash, "NonblockingLzApp: invalid payload");
            // clear the stored message
            failedMessages[_srcChainId][_srcAddress][_nonce] = bytes32(0);
            // execute the message. revert if it fails again
            _nonblockingLzReceive(_srcChainId, _srcAddress, _nonce, _payload);
            emit RetryMessageSuccess(_srcChainId, _srcAddress, _nonce, payloadHash);
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    import "Ownable.sol";
    import "ILayerZeroReceiver.sol";
    import "ILayerZeroUserApplicationConfig.sol";
    import "ILayerZeroEndpoint.sol";
    import "BytesLib.sol";
    /*
     * a generic LzReceiver implementation
     */
    abstract contract LzApp is Ownable, ILayerZeroReceiver, ILayerZeroUserApplicationConfig {
        using BytesLib for bytes;
        // ua can not send payload larger than this by default, but it can be changed by the ua owner
        uint constant public DEFAULT_PAYLOAD_SIZE_LIMIT = 10000;
        ILayerZeroEndpoint public immutable lzEndpoint;
        mapping(uint16 => bytes) public trustedRemoteLookup;
        mapping(uint16 => mapping(uint16 => uint)) public minDstGasLookup;
        mapping(uint16 => uint) public payloadSizeLimitLookup;
        address public precrime;
        event SetPrecrime(address precrime);
        event SetTrustedRemote(uint16 _remoteChainId, bytes _path);
        event SetTrustedRemoteAddress(uint16 _remoteChainId, bytes _remoteAddress);
        event SetMinDstGas(uint16 _dstChainId, uint16 _type, uint _minDstGas);
        constructor(address _endpoint) {
            lzEndpoint = ILayerZeroEndpoint(_endpoint);
        }
        function lzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) public virtual override {
            // lzReceive must be called by the endpoint for security
            require(_msgSender() == address(lzEndpoint), "LzApp: invalid endpoint caller");
            bytes memory trustedRemote = trustedRemoteLookup[_srcChainId];
            // if will still block the message pathway from (srcChainId, srcAddress). should not receive message from untrusted remote.
            require(_srcAddress.length == trustedRemote.length && trustedRemote.length > 0 && keccak256(_srcAddress) == keccak256(trustedRemote), "LzApp: invalid source sending contract");
            _blockingLzReceive(_srcChainId, _srcAddress, _nonce, _payload);
        }
        // abstract function - the default behaviour of LayerZero is blocking. See: NonblockingLzApp if you dont need to enforce ordered messaging
        function _blockingLzReceive(uint16 _srcChainId, bytes memory _srcAddress, uint64 _nonce, bytes memory _payload) internal virtual;
        function _lzSend(uint16 _dstChainId, bytes memory _payload, address payable _refundAddress, address _zroPaymentAddress, bytes memory _adapterParams, uint _nativeFee) internal virtual {
            bytes memory trustedRemote = trustedRemoteLookup[_dstChainId];
            require(trustedRemote.length != 0, "LzApp: destination chain is not a trusted source");
            _checkPayloadSize(_dstChainId, _payload.length);
            lzEndpoint.send{value: _nativeFee}(_dstChainId, trustedRemote, _payload, _refundAddress, _zroPaymentAddress, _adapterParams);
        }
        function _checkGasLimit(uint16 _dstChainId, uint16 _type, bytes memory _adapterParams, uint _extraGas) internal view virtual {
            uint providedGasLimit = _getGasLimit(_adapterParams);
            uint minGasLimit = minDstGasLookup[_dstChainId][_type] + _extraGas;
            require(minGasLimit > 0, "LzApp: minGasLimit not set");
            require(providedGasLimit >= minGasLimit, "LzApp: gas limit is too low");
        }
        function _getGasLimit(bytes memory _adapterParams) internal pure virtual returns (uint gasLimit) {
            require(_adapterParams.length >= 34, "LzApp: invalid adapterParams");
            assembly {
                gasLimit := mload(add(_adapterParams, 34))
            }
        }
        function _checkPayloadSize(uint16 _dstChainId, uint _payloadSize) internal view virtual {
            uint payloadSizeLimit = payloadSizeLimitLookup[_dstChainId];
            if (payloadSizeLimit == 0) { // use default if not set
                payloadSizeLimit = DEFAULT_PAYLOAD_SIZE_LIMIT;
            }
            require(_payloadSize <= payloadSizeLimit, "LzApp: payload size is too large");
        }
        //---------------------------UserApplication config----------------------------------------
        function getConfig(uint16 _version, uint16 _chainId, address, uint _configType) external view returns (bytes memory) {
            return lzEndpoint.getConfig(_version, _chainId, address(this), _configType);
        }
        // generic config for LayerZero user Application
        function setConfig(uint16 _version, uint16 _chainId, uint _configType, bytes calldata _config) external override onlyOwner {
            lzEndpoint.setConfig(_version, _chainId, _configType, _config);
        }
        function setSendVersion(uint16 _version) external override onlyOwner {
            lzEndpoint.setSendVersion(_version);
        }
        function setReceiveVersion(uint16 _version) external override onlyOwner {
            lzEndpoint.setReceiveVersion(_version);
        }
        function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external override onlyOwner {
            lzEndpoint.forceResumeReceive(_srcChainId, _srcAddress);
        }
        // _path = abi.encodePacked(remoteAddress, localAddress)
        // this function set the trusted path for the cross-chain communication
        function setTrustedRemote(uint16 _srcChainId, bytes calldata _path) external onlyOwner {
            trustedRemoteLookup[_srcChainId] = _path;
            emit SetTrustedRemote(_srcChainId, _path);
        }
        function setTrustedRemoteAddress(uint16 _remoteChainId, bytes calldata _remoteAddress) external onlyOwner {
            trustedRemoteLookup[_remoteChainId] = abi.encodePacked(_remoteAddress, address(this));
            emit SetTrustedRemoteAddress(_remoteChainId, _remoteAddress);
        }
        function getTrustedRemoteAddress(uint16 _remoteChainId) external view returns (bytes memory) {
            bytes memory path = trustedRemoteLookup[_remoteChainId];
            require(path.length != 0, "LzApp: no trusted path record");
            return path.slice(0, path.length - 20); // the last 20 bytes should be address(this)
        }
        function setPrecrime(address _precrime) external onlyOwner {
            precrime = _precrime;
            emit SetPrecrime(_precrime);
        }
        function setMinDstGas(uint16 _dstChainId, uint16 _packetType, uint _minGas) external onlyOwner {
            require(_minGas > 0, "LzApp: invalid minGas");
            minDstGasLookup[_dstChainId][_packetType] = _minGas;
            emit SetMinDstGas(_dstChainId, _packetType, _minGas);
        }
        // if the size is 0, it means default size limit
        function setPayloadSizeLimit(uint16 _dstChainId, uint _size) external onlyOwner {
            payloadSizeLimitLookup[_dstChainId] = _size;
        }
        //--------------------------- VIEW FUNCTION ----------------------------------------
        function isTrustedRemote(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (bool) {
            bytes memory trustedSource = trustedRemoteLookup[_srcChainId];
            return keccak256(trustedSource) == keccak256(_srcAddress);
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
    pragma solidity ^0.8.0;
    import "Context.sol";
    /**
     * @dev Contract module which provides a basic access control mechanism, where
     * there is an account (an owner) that can be granted exclusive access to
     * specific functions.
     *
     * By default, the owner account will be the one that deploys the contract. This
     * can later be changed with {transferOwnership}.
     *
     * This module is used through inheritance. It will make available the modifier
     * `onlyOwner`, which can be applied to your functions to restrict their use to
     * the owner.
     */
    abstract contract Ownable is Context {
        address private _owner;
        event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
        /**
         * @dev Initializes the contract setting the deployer as the initial owner.
         */
        constructor() {
            _transferOwnership(_msgSender());
        }
        /**
         * @dev Throws if called by any account other than the owner.
         */
        modifier onlyOwner() {
            _checkOwner();
            _;
        }
        /**
         * @dev Returns the address of the current owner.
         */
        function owner() public view virtual returns (address) {
            return _owner;
        }
        /**
         * @dev Throws if the sender is not the owner.
         */
        function _checkOwner() internal view virtual {
            require(owner() == _msgSender(), "Ownable: caller is not the owner");
        }
        /**
         * @dev Leaves the contract without owner. It will not be possible to call
         * `onlyOwner` functions anymore. Can only be called by the current owner.
         *
         * NOTE: Renouncing ownership will leave the contract without an owner,
         * thereby removing any functionality that is only available to the owner.
         */
        function renounceOwnership() public virtual onlyOwner {
            _transferOwnership(address(0));
        }
        /**
         * @dev Transfers ownership of the contract to a new account (`newOwner`).
         * Can only be called by the current owner.
         */
        function transferOwnership(address newOwner) public virtual onlyOwner {
            require(newOwner != address(0), "Ownable: new owner is the zero address");
            _transferOwnership(newOwner);
        }
        /**
         * @dev Transfers ownership of the contract to a new account (`newOwner`).
         * Internal function without access restriction.
         */
        function _transferOwnership(address newOwner) internal virtual {
            address oldOwner = _owner;
            _owner = newOwner;
            emit OwnershipTransferred(oldOwner, newOwner);
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.5.0;
    interface ILayerZeroReceiver {
        // @notice LayerZero endpoint will invoke this function to deliver the message on the destination
        // @param _srcChainId - the source endpoint identifier
        // @param _srcAddress - the source sending contract address from the source chain
        // @param _nonce - the ordered message nonce
        // @param _payload - the signed payload is the UA bytes has encoded to be sent
        function lzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) external;
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.5.0;
    interface ILayerZeroUserApplicationConfig {
        // @notice set the configuration of the LayerZero messaging library of the specified version
        // @param _version - messaging library version
        // @param _chainId - the chainId for the pending config change
        // @param _configType - type of configuration. every messaging library has its own convention.
        // @param _config - configuration in the bytes. can encode arbitrary content.
        function setConfig(uint16 _version, uint16 _chainId, uint _configType, bytes calldata _config) external;
        // @notice set the send() LayerZero messaging library version to _version
        // @param _version - new messaging library version
        function setSendVersion(uint16 _version) external;
        // @notice set the lzReceive() LayerZero messaging library version to _version
        // @param _version - new messaging library version
        function setReceiveVersion(uint16 _version) external;
        // @notice Only when the UA needs to resume the message flow in blocking mode and clear the stored payload
        // @param _srcChainId - the chainId of the source chain
        // @param _srcAddress - the contract address of the source contract at the source chain
        function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external;
    }
    // SPDX-License-Identifier: MIT
    pragma solidity >=0.5.0;
    import "ILayerZeroUserApplicationConfig.sol";
    interface ILayerZeroEndpoint is ILayerZeroUserApplicationConfig {
        // @notice send a LayerZero message to the specified address at a LayerZero endpoint.
        // @param _dstChainId - the destination chain identifier
        // @param _destination - the address on destination chain (in bytes). address length/format may vary by chains
        // @param _payload - a custom bytes payload to send to the destination contract
        // @param _refundAddress - if the source transaction is cheaper than the amount of value passed, refund the additional amount to this address
        // @param _zroPaymentAddress - the address of the ZRO token holder who would pay for the transaction
        // @param _adapterParams - parameters for custom functionality. e.g. receive airdropped native gas from the relayer on destination
        function send(uint16 _dstChainId, bytes calldata _destination, bytes calldata _payload, address payable _refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) external payable;
        // @notice used by the messaging library to publish verified payload
        // @param _srcChainId - the source chain identifier
        // @param _srcAddress - the source contract (as bytes) at the source chain
        // @param _dstAddress - the address on destination chain
        // @param _nonce - the unbound message ordering nonce
        // @param _gasLimit - the gas limit for external contract execution
        // @param _payload - verified payload to send to the destination contract
        function receivePayload(uint16 _srcChainId, bytes calldata _srcAddress, address _dstAddress, uint64 _nonce, uint _gasLimit, bytes calldata _payload) external;
        // @notice get the inboundNonce of a lzApp from a source chain which could be EVM or non-EVM chain
        // @param _srcChainId - the source chain identifier
        // @param _srcAddress - the source chain contract address
        function getInboundNonce(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (uint64);
        // @notice get the outboundNonce from this source chain which, consequently, is always an EVM
        // @param _srcAddress - the source chain contract address
        function getOutboundNonce(uint16 _dstChainId, address _srcAddress) external view returns (uint64);
        // @notice gets a quote in source native gas, for the amount that send() requires to pay for message delivery
        // @param _dstChainId - the destination chain identifier
        // @param _userApplication - the user app address on this EVM chain
        // @param _payload - the custom message to send over LayerZero
        // @param _payInZRO - if false, user app pays the protocol fee in native token
        // @param _adapterParam - parameters for the adapter service, e.g. send some dust native token to dstChain
        function estimateFees(uint16 _dstChainId, address _userApplication, bytes calldata _payload, bool _payInZRO, bytes calldata _adapterParam) external view returns (uint nativeFee, uint zroFee);
        // @notice get this Endpoint's immutable source identifier
        function getChainId() external view returns (uint16);
        // @notice the interface to retry failed message on this Endpoint destination
        // @param _srcChainId - the source chain identifier
        // @param _srcAddress - the source chain contract address
        // @param _payload - the payload to be retried
        function retryPayload(uint16 _srcChainId, bytes calldata _srcAddress, bytes calldata _payload) external;
        // @notice query if any STORED payload (message blocking) at the endpoint.
        // @param _srcChainId - the source chain identifier
        // @param _srcAddress - the source chain contract address
        function hasStoredPayload(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (bool);
        // @notice query if the _libraryAddress is valid for sending msgs.
        // @param _userApplication - the user app address on this EVM chain
        function getSendLibraryAddress(address _userApplication) external view returns (address);
        // @notice query if the _libraryAddress is valid for receiving msgs.
        // @param _userApplication - the user app address on this EVM chain
        function getReceiveLibraryAddress(address _userApplication) external view returns (address);
        // @notice query if the non-reentrancy guard for send() is on
        // @return true if the guard is on. false otherwise
        function isSendingPayload() external view returns (bool);
        // @notice query if the non-reentrancy guard for receive() is on
        // @return true if the guard is on. false otherwise
        function isReceivingPayload() external view returns (bool);
        // @notice get the configuration of the LayerZero messaging library of the specified version
        // @param _version - messaging library version
        // @param _chainId - the chainId for the pending config change
        // @param _userApplication - the contract address of the user application
        // @param _configType - type of configuration. every messaging library has its own convention.
        function getConfig(uint16 _version, uint16 _chainId, address _userApplication, uint _configType) external view returns (bytes memory);
        // @notice get the send() LayerZero messaging library version
        // @param _userApplication - the contract address of the user application
        function getSendVersion(address _userApplication) external view returns (uint16);
        // @notice get the lzReceive() LayerZero messaging library version
        // @param _userApplication - the contract address of the user application
        function getReceiveVersion(address _userApplication) external view returns (uint16);
    }
    // SPDX-License-Identifier: Unlicense
    /*
     * @title Solidity Bytes Arrays Utils
     * @author Gonçalo Sá <[email protected]>
     *
     * @dev Bytes tightly packed arrays utility library for ethereum contracts written in Solidity.
     *      The library lets you concatenate, slice and type cast bytes arrays both in memory and storage.
     */
    pragma solidity >=0.8.0 <0.9.0;
    library BytesLib {
        function concat(
            bytes memory _preBytes,
            bytes memory _postBytes
        )
        internal
        pure
        returns (bytes memory)
        {
            bytes memory tempBytes;
            assembly {
            // Get a location of some free memory and store it in tempBytes as
            // Solidity does for memory variables.
                tempBytes := mload(0x40)
            // Store the length of the first bytes array at the beginning of
            // the memory for tempBytes.
                let length := mload(_preBytes)
                mstore(tempBytes, length)
            // Maintain a memory counter for the current write location in the
            // temp bytes array by adding the 32 bytes for the array length to
            // the starting location.
                let mc := add(tempBytes, 0x20)
            // Stop copying when the memory counter reaches the length of the
            // first bytes array.
                let end := add(mc, length)
                for {
                // Initialize a copy counter to the start of the _preBytes data,
                // 32 bytes into its memory.
                    let cc := add(_preBytes, 0x20)
                } lt(mc, end) {
                // Increase both counters by 32 bytes each iteration.
                    mc := add(mc, 0x20)
                    cc := add(cc, 0x20)
                } {
                // Write the _preBytes data into the tempBytes memory 32 bytes
                // at a time.
                    mstore(mc, mload(cc))
                }
            // Add the length of _postBytes to the current length of tempBytes
            // and store it as the new length in the first 32 bytes of the
            // tempBytes memory.
                length := mload(_postBytes)
                mstore(tempBytes, add(length, mload(tempBytes)))
            // Move the memory counter back from a multiple of 0x20 to the
            // actual end of the _preBytes data.
                mc := end
            // Stop copying when the memory counter reaches the new combined
            // length of the arrays.
                end := add(mc, length)
                for {
                    let cc := add(_postBytes, 0x20)
                } lt(mc, end) {
                    mc := add(mc, 0x20)
                    cc := add(cc, 0x20)
                } {
                    mstore(mc, mload(cc))
                }
            // Update the free-memory pointer by padding our last write location
            // to 32 bytes: add 31 bytes to the end of tempBytes to move to the
            // next 32 byte block, then round down to the nearest multiple of
            // 32. If the sum of the length of the two arrays is zero then add
            // one before rounding down to leave a blank 32 bytes (the length block with 0).
                mstore(0x40, and(
                add(add(end, iszero(add(length, mload(_preBytes)))), 31),
                not(31) // Round down to the nearest 32 bytes.
                ))
            }
            return tempBytes;
        }
        function concatStorage(bytes storage _preBytes, bytes memory _postBytes) internal {
            assembly {
            // Read the first 32 bytes of _preBytes storage, which is the length
            // of the array. (We don't need to use the offset into the slot
            // because arrays use the entire slot.)
                let fslot := sload(_preBytes.slot)
            // Arrays of 31 bytes or less have an even value in their slot,
            // while longer arrays have an odd value. The actual length is
            // the slot divided by two for odd values, and the lowest order
            // byte divided by two for even values.
            // If the slot is even, bitwise and the slot with 255 and divide by
            // two to get the length. If the slot is odd, bitwise and the slot
            // with -1 and divide by two.
                let slength := div(and(fslot, sub(mul(0x100, iszero(and(fslot, 1))), 1)), 2)
                let mlength := mload(_postBytes)
                let newlength := add(slength, mlength)
            // slength can contain both the length and contents of the array
            // if length < 32 bytes so let's prepare for that
            // v. http://solidity.readthedocs.io/en/latest/miscellaneous.html#layout-of-state-variables-in-storage
                switch add(lt(slength, 32), lt(newlength, 32))
                case 2 {
                // Since the new array still fits in the slot, we just need to
                // update the contents of the slot.
                // uint256(bytes_storage) = uint256(bytes_storage) + uint256(bytes_memory) + new_length
                    sstore(
                    _preBytes.slot,
                    // all the modifications to the slot are inside this
                    // next block
                    add(
                    // we can just add to the slot contents because the
                    // bytes we want to change are the LSBs
                    fslot,
                    add(
                    mul(
                    div(
                    // load the bytes from memory
                    mload(add(_postBytes, 0x20)),
                    // zero all bytes to the right
                    exp(0x100, sub(32, mlength))
                    ),
                    // and now shift left the number of bytes to
                    // leave space for the length in the slot
                    exp(0x100, sub(32, newlength))
                    ),
                    // increase length by the double of the memory
                    // bytes length
                    mul(mlength, 2)
                    )
                    )
                    )
                }
                case 1 {
                // The stored value fits in the slot, but the combined value
                // will exceed it.
                // get the keccak hash to get the contents of the array
                    mstore(0x0, _preBytes.slot)
                    let sc := add(keccak256(0x0, 0x20), div(slength, 32))
                // save new length
                    sstore(_preBytes.slot, add(mul(newlength, 2), 1))
                // The contents of the _postBytes array start 32 bytes into
                // the structure. Our first read should obtain the `submod`
                // bytes that can fit into the unused space in the last word
                // of the stored array. To get this, we read 32 bytes starting
                // from `submod`, so the data we read overlaps with the array
                // contents by `submod` bytes. Masking the lowest-order
                // `submod` bytes allows us to add that value directly to the
                // stored value.
                    let submod := sub(32, slength)
                    let mc := add(_postBytes, submod)
                    let end := add(_postBytes, mlength)
                    let mask := sub(exp(0x100, submod), 1)
                    sstore(
                    sc,
                    add(
                    and(
                    fslot,
                    0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00
                    ),
                    and(mload(mc), mask)
                    )
                    )
                    for {
                        mc := add(mc, 0x20)
                        sc := add(sc, 1)
                    } lt(mc, end) {
                        sc := add(sc, 1)
                        mc := add(mc, 0x20)
                    } {
                        sstore(sc, mload(mc))
                    }
                    mask := exp(0x100, sub(mc, end))
                    sstore(sc, mul(div(mload(mc), mask), mask))
                }
                default {
                // get the keccak hash to get the contents of the array
                    mstore(0x0, _preBytes.slot)
                // Start copying to the last used word of the stored array.
                    let sc := add(keccak256(0x0, 0x20), div(slength, 32))
                // save new length
                    sstore(_preBytes.slot, add(mul(newlength, 2), 1))
                // Copy over the first `submod` bytes of the new data as in
                // case 1 above.
                    let slengthmod := mod(slength, 32)
                    let mlengthmod := mod(mlength, 32)
                    let submod := sub(32, slengthmod)
                    let mc := add(_postBytes, submod)
                    let end := add(_postBytes, mlength)
                    let mask := sub(exp(0x100, submod), 1)
                    sstore(sc, add(sload(sc), and(mload(mc), mask)))
                    for {
                        sc := add(sc, 1)
                        mc := add(mc, 0x20)
                    } lt(mc, end) {
                        sc := add(sc, 1)
                        mc := add(mc, 0x20)
                    } {
                        sstore(sc, mload(mc))
                    }
                    mask := exp(0x100, sub(mc, end))
                    sstore(sc, mul(div(mload(mc), mask), mask))
                }
            }
        }
        function slice(
            bytes memory _bytes,
            uint256 _start,
            uint256 _length
        )
        internal
        pure
        returns (bytes memory)
        {
            require(_length + 31 >= _length, "slice_overflow");
            require(_bytes.length >= _start + _length, "slice_outOfBounds");
            bytes memory tempBytes;
            assembly {
                switch iszero(_length)
                case 0 {
                // Get a location of some free memory and store it in tempBytes as
                // Solidity does for memory variables.
                    tempBytes := mload(0x40)
                // The first word of the slice result is potentially a partial
                // word read from the original array. To read it, we calculate
                // the length of that partial word and start copying that many
                // bytes into the array. The first word we copy will start with
                // data we don't care about, but the last `lengthmod` bytes will
                // land at the beginning of the contents of the new array. When
                // we're done copying, we overwrite the full first word with
                // the actual length of the slice.
                    let lengthmod := and(_length, 31)
                // The multiplication in the next line is necessary
                // because when slicing multiples of 32 bytes (lengthmod == 0)
                // the following copy loop was copying the origin's length
                // and then ending prematurely not copying everything it should.
                    let mc := add(add(tempBytes, lengthmod), mul(0x20, iszero(lengthmod)))
                    let end := add(mc, _length)
                    for {
                    // The multiplication in the next line has the same exact purpose
                    // as the one above.
                        let cc := add(add(add(_bytes, lengthmod), mul(0x20, iszero(lengthmod))), _start)
                    } lt(mc, end) {
                        mc := add(mc, 0x20)
                        cc := add(cc, 0x20)
                    } {
                        mstore(mc, mload(cc))
                    }
                    mstore(tempBytes, _length)
                //update free-memory pointer
                //allocating the array padded to 32 bytes like the compiler does now
                    mstore(0x40, and(add(mc, 31), not(31)))
                }
                //if we want a zero-length slice let's just return a zero-length array
                default {
                    tempBytes := mload(0x40)
                //zero out the 32 bytes slice we are about to return
                //we need to do it because Solidity does not garbage collect
                    mstore(tempBytes, 0)
                    mstore(0x40, add(tempBytes, 0x20))
                }
            }
            return tempBytes;
        }
        function toAddress(bytes memory _bytes, uint256 _start) internal pure returns (address) {
            require(_bytes.length >= _start + 20, "toAddress_outOfBounds");
            address tempAddress;
            assembly {
                tempAddress := div(mload(add(add(_bytes, 0x20), _start)), 0x1000000000000000000000000)
            }
            return tempAddress;
        }
        function toUint8(bytes memory _bytes, uint256 _start) internal pure returns (uint8) {
            require(_bytes.length >= _start + 1 , "toUint8_outOfBounds");
            uint8 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x1), _start))
            }
            return tempUint;
        }
        function toUint16(bytes memory _bytes, uint256 _start) internal pure returns (uint16) {
            require(_bytes.length >= _start + 2, "toUint16_outOfBounds");
            uint16 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x2), _start))
            }
            return tempUint;
        }
        function toUint32(bytes memory _bytes, uint256 _start) internal pure returns (uint32) {
            require(_bytes.length >= _start + 4, "toUint32_outOfBounds");
            uint32 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x4), _start))
            }
            return tempUint;
        }
        function toUint64(bytes memory _bytes, uint256 _start) internal pure returns (uint64) {
            require(_bytes.length >= _start + 8, "toUint64_outOfBounds");
            uint64 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x8), _start))
            }
            return tempUint;
        }
        function toUint96(bytes memory _bytes, uint256 _start) internal pure returns (uint96) {
            require(_bytes.length >= _start + 12, "toUint96_outOfBounds");
            uint96 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0xc), _start))
            }
            return tempUint;
        }
        function toUint128(bytes memory _bytes, uint256 _start) internal pure returns (uint128) {
            require(_bytes.length >= _start + 16, "toUint128_outOfBounds");
            uint128 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x10), _start))
            }
            return tempUint;
        }
        function toUint256(bytes memory _bytes, uint256 _start) internal pure returns (uint256) {
            require(_bytes.length >= _start + 32, "toUint256_outOfBounds");
            uint256 tempUint;
            assembly {
                tempUint := mload(add(add(_bytes, 0x20), _start))
            }
            return tempUint;
        }
        function toBytes32(bytes memory _bytes, uint256 _start) internal pure returns (bytes32) {
            require(_bytes.length >= _start + 32, "toBytes32_outOfBounds");
            bytes32 tempBytes32;
            assembly {
                tempBytes32 := mload(add(add(_bytes, 0x20), _start))
            }
            return tempBytes32;
        }
        function equal(bytes memory _preBytes, bytes memory _postBytes) internal pure returns (bool) {
            bool success = true;
            assembly {
                let length := mload(_preBytes)
            // if lengths don't match the arrays are not equal
                switch eq(length, mload(_postBytes))
                case 1 {
                // cb is a circuit breaker in the for loop since there's
                //  no said feature for inline assembly loops
                // cb = 1 - don't breaker
                // cb = 0 - break
                    let cb := 1
                    let mc := add(_preBytes, 0x20)
                    let end := add(mc, length)
                    for {
                        let cc := add(_postBytes, 0x20)
                    // the next line is the loop condition:
                    // while(uint256(mc < end) + cb == 2)
                    } eq(add(lt(mc, end), cb), 2) {
                        mc := add(mc, 0x20)
                        cc := add(cc, 0x20)
                    } {
                    // if any of these checks fails then arrays are not equal
                        if iszero(eq(mload(mc), mload(cc))) {
                        // unsuccess:
                            success := 0
                            cb := 0
                        }
                    }
                }
                default {
                // unsuccess:
                    success := 0
                }
            }
            return success;
        }
        function equalStorage(
            bytes storage _preBytes,
            bytes memory _postBytes
        )
        internal
        view
        returns (bool)
        {
            bool success = true;
            assembly {
            // we know _preBytes_offset is 0
                let fslot := sload(_preBytes.slot)
            // Decode the length of the stored array like in concatStorage().
                let slength := div(and(fslot, sub(mul(0x100, iszero(and(fslot, 1))), 1)), 2)
                let mlength := mload(_postBytes)
            // if lengths don't match the arrays are not equal
                switch eq(slength, mlength)
                case 1 {
                // slength can contain both the length and contents of the array
                // if length < 32 bytes so let's prepare for that
                // v. http://solidity.readthedocs.io/en/latest/miscellaneous.html#layout-of-state-variables-in-storage
                    if iszero(iszero(slength)) {
                        switch lt(slength, 32)
                        case 1 {
                        // blank the last byte which is the length
                            fslot := mul(div(fslot, 0x100), 0x100)
                            if iszero(eq(fslot, mload(add(_postBytes, 0x20)))) {
                            // unsuccess:
                                success := 0
                            }
                        }
                        default {
                        // cb is a circuit breaker in the for loop since there's
                        //  no said feature for inline assembly loops
                        // cb = 1 - don't breaker
                        // cb = 0 - break
                            let cb := 1
                        // get the keccak hash to get the contents of the array
                            mstore(0x0, _preBytes.slot)
                            let sc := keccak256(0x0, 0x20)
                            let mc := add(_postBytes, 0x20)
                            let end := add(mc, mlength)
                        // the next line is the loop condition:
                        // while(uint256(mc < end) + cb == 2)
                            for {} eq(add(lt(mc, end), cb), 2) {
                                sc := add(sc, 1)
                                mc := add(mc, 0x20)
                            } {
                                if iszero(eq(sload(sc), mload(mc))) {
                                // unsuccess:
                                    success := 0
                                    cb := 0
                                }
                            }
                        }
                    }
                }
                default {
                // unsuccess:
                    success := 0
                }
            }
            return success;
        }
    }
    // SPDX-License-Identifier: MIT OR Apache-2.0
    pragma solidity >=0.7.6;
    library ExcessivelySafeCall {
        uint256 constant LOW_28_MASK =
        0x00000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff;
        /// @notice Use when you _really_ really _really_ don't trust the called
        /// contract. This prevents the called contract from causing reversion of
        /// the caller in as many ways as we can.
        /// @dev The main difference between this and a solidity low-level call is
        /// that we limit the number of bytes that the callee can cause to be
        /// copied to caller memory. This prevents stupid things like malicious
        /// contracts returning 10,000,000 bytes causing a local OOG when copying
        /// to memory.
        /// @param _target The address to call
        /// @param _gas The amount of gas to forward to the remote contract
        /// @param _maxCopy The maximum number of bytes of returndata to copy
        /// to memory.
        /// @param _calldata The data to send to the remote contract
        /// @return success and returndata, as `.call()`. Returndata is capped to
        /// `_maxCopy` bytes.
        function excessivelySafeCall(
            address _target,
            uint256 _gas,
            uint16 _maxCopy,
            bytes memory _calldata
        ) internal returns (bool, bytes memory) {
            // set up for assembly call
            uint256 _toCopy;
            bool _success;
            bytes memory _returnData = new bytes(_maxCopy);
            // dispatch message to recipient
            // by assembly calling "handle" function
            // we call via assembly to avoid memcopying a very large returndata
            // returned by a malicious contract
            assembly {
                _success := call(
                _gas, // gas
                _target, // recipient
                0, // ether value
                add(_calldata, 0x20), // inloc
                mload(_calldata), // inlen
                0, // outloc
                0 // outlen
                )
            // limit our copy to 256 bytes
                _toCopy := returndatasize()
                if gt(_toCopy, _maxCopy) {
                    _toCopy := _maxCopy
                }
            // Store the length of the copied bytes
                mstore(_returnData, _toCopy)
            // copy the bytes from returndata[0:_toCopy]
                returndatacopy(add(_returnData, 0x20), 0, _toCopy)
            }
            return (_success, _returnData);
        }
        /// @notice Use when you _really_ really _really_ don't trust the called
        /// contract. This prevents the called contract from causing reversion of
        /// the caller in as many ways as we can.
        /// @dev The main difference between this and a solidity low-level call is
        /// that we limit the number of bytes that the callee can cause to be
        /// copied to caller memory. This prevents stupid things like malicious
        /// contracts returning 10,000,000 bytes causing a local OOG when copying
        /// to memory.
        /// @param _target The address to call
        /// @param _gas The amount of gas to forward to the remote contract
        /// @param _maxCopy The maximum number of bytes of returndata to copy
        /// to memory.
        /// @param _calldata The data to send to the remote contract
        /// @return success and returndata, as `.call()`. Returndata is capped to
        /// `_maxCopy` bytes.
        function excessivelySafeStaticCall(
            address _target,
            uint256 _gas,
            uint16 _maxCopy,
            bytes memory _calldata
        ) internal view returns (bool, bytes memory) {
            // set up for assembly call
            uint256 _toCopy;
            bool _success;
            bytes memory _returnData = new bytes(_maxCopy);
            // dispatch message to recipient
            // by assembly calling "handle" function
            // we call via assembly to avoid memcopying a very large returndata
            // returned by a malicious contract
            assembly {
                _success := staticcall(
                _gas, // gas
                _target, // recipient
                add(_calldata, 0x20), // inloc
                mload(_calldata), // inlen
                0, // outloc
                0 // outlen
                )
            // limit our copy to 256 bytes
                _toCopy := returndatasize()
                if gt(_toCopy, _maxCopy) {
                    _toCopy := _maxCopy
                }
            // Store the length of the copied bytes
                mstore(_returnData, _toCopy)
            // copy the bytes from returndata[0:_toCopy]
                returndatacopy(add(_returnData, 0x20), 0, _toCopy)
            }
            return (_success, _returnData);
        }
        /**
         * @notice Swaps function selectors in encoded contract calls
         * @dev Allows reuse of encoded calldata for functions with identical
         * argument types but different names. It simply swaps out the first 4 bytes
         * for the new selector. This function modifies memory in place, and should
         * only be used with caution.
         * @param _newSelector The new 4-byte selector
         * @param _buf The encoded contract args
         */
        function swapSelector(bytes4 _newSelector, bytes memory _buf)
        internal
        pure
        {
            require(_buf.length >= 4);
            uint256 _mask = LOW_28_MASK;
            assembly {
            // load the first word of
                let _word := mload(add(_buf, 0x20))
            // mask out the top 4 bytes
            // /x
                _word := and(_word, _mask)
                _word := or(_newSelector, _word)
                mstore(add(_buf, 0x20), _word)
            }
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
    pragma solidity ^0.8.0;
    import "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);
     * }
     * ```
     *
     * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
     */
    abstract contract ERC165 is IERC165 {
        /**
         * @dev See {IERC165-supportsInterface}.
         */
        function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
            return interfaceId == type(IERC165).interfaceId;
        }
    }
    

    File 3 of 3: PrismaVault
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    import "SafeERC20.sol";
    import "Address.sol";
    import "PrismaOwnable.sol";
    import "SystemStart.sol";
    import "IPrismaToken.sol";
    import "IEmissionSchedule.sol";
    import "IIncentiveVoting.sol";
    import "ITokenLocker.sol";
    import "IBoostDelegate.sol";
    import "IBoostCalculator.sol";
    interface IEmissionReceiver {
        function notifyRegisteredId(uint256[] memory assignedIds) external returns (bool);
    }
    interface IRewards {
        function vaultClaimReward(address claimant, address receiver) external returns (uint256);
        function claimableReward(address account) external view returns (uint256);
    }
    /**
        @title Prisma Vault
        @notice The total supply of PRISMA is initially minted to this contract.
                The token balance held here can be considered "uncirculating". The
                vault gradually releases tokens to registered emissions receivers
                as determined by `EmissionSchedule` and `BoostCalculator`.
     */
    contract PrismaVault is PrismaOwnable, SystemStart {
        using Address for address;
        using SafeERC20 for IERC20;
        IPrismaToken public immutable prismaToken;
        ITokenLocker public immutable locker;
        IIncentiveVoting public immutable voter;
        address public immutable deploymentManager;
        uint256 immutable lockToTokenRatio;
        IEmissionSchedule public emissionSchedule;
        IBoostCalculator public boostCalculator;
        // `prismaToken` balance within the treasury that is not yet allocated.
        // Starts as `prismaToken.totalSupply()` and decreases over time.
        uint128 public unallocatedTotal;
        // most recent week that `unallocatedTotal` was reduced by a call to
        // `emissionSchedule.getTotalWeeklyEmissions`
        uint64 public totalUpdateWeek;
        // number of weeks that PRISMA is locked for when transferred using
        // `transferAllocatedTokens`. updated weekly by the emission schedule.
        uint64 public lockWeeks;
        // id -> receiver data
        uint16[65535] public receiverUpdatedWeek;
        // id -> address of receiver
        // not bi-directional, one receiver can have multiple ids
        mapping(uint256 => Receiver) public idToReceiver;
        // week -> total amount of tokens to be released in that week
        uint128[65535] public weeklyEmissions;
        // receiver -> remaining tokens which have been allocated but not yet distributed
        mapping(address => uint256) public allocated;
        // account -> week -> PRISMA amount claimed in that week (used for calculating boost)
        mapping(address => uint128[65535]) accountWeeklyEarned;
        // pending rewards for an address (dust after locking, fees from delegation)
        mapping(address => uint256) private storedPendingReward;
        mapping(address => Delegation) public boostDelegation;
        struct Receiver {
            address account;
            bool isActive;
        }
        struct Delegation {
            bool isEnabled;
            uint16 feePct;
            IBoostDelegate callback;
        }
        struct InitialAllowance {
            address receiver;
            uint256 amount;
        }
        event NewReceiverRegistered(address receiver, uint256 id);
        event ReceiverIsActiveStatusModified(uint256 indexed id, bool isActive);
        event UnallocatedSupplyReduced(uint256 reducedAmount, uint256 unallocatedTotal);
        event UnallocatedSupplyIncreased(uint256 increasedAmount, uint256 unallocatedTotal);
        event IncreasedAllocation(address indexed receiver, uint256 increasedAmount);
        event EmissionScheduleSet(address emissionScheduler);
        event BoostCalculatorSet(address boostCalculator);
        event BoostDelegationSet(address indexed boostDelegate, bool isEnabled, uint256 feePct, address callback);
        constructor(
            address _prismaCore,
            IPrismaToken _token,
            ITokenLocker _locker,
            IIncentiveVoting _voter,
            address _stabilityPool,
            address _manager
        ) PrismaOwnable(_prismaCore) SystemStart(_prismaCore) {
            prismaToken = _token;
            locker = _locker;
            voter = _voter;
            lockToTokenRatio = _locker.lockToTokenRatio();
            deploymentManager = _manager;
            // ensure the stability pool is registered with receiver ID 0
            _voter.registerNewReceiver();
            idToReceiver[0] = Receiver({ account: _stabilityPool, isActive: true });
            emit NewReceiverRegistered(_stabilityPool, 0);
        }
        function setInitialParameters(
            IEmissionSchedule _emissionSchedule,
            IBoostCalculator _boostCalculator,
            uint256 totalSupply,
            uint64 initialLockWeeks,
            uint128[] memory _fixedInitialAmounts,
            InitialAllowance[] memory initialAllowances
        ) external {
            require(msg.sender == deploymentManager, "!deploymentManager");
            emissionSchedule = _emissionSchedule;
            boostCalculator = _boostCalculator;
            // mint totalSupply to vault - this reverts after the first call
            prismaToken.mintToVault(totalSupply);
            // set initial fixed weekly emissions
            uint256 totalAllocated;
            uint256 length = _fixedInitialAmounts.length;
            uint256 offset = getWeek() + 1;
            for (uint256 i = 0; i < length; i++) {
                uint128 amount = _fixedInitialAmounts[i];
                weeklyEmissions[i + offset] = amount;
                totalAllocated += amount;
            }
            // set initial transfer allowances for airdrops, vests, bribes
            length = initialAllowances.length;
            for (uint256 i = 0; i < length; i++) {
                uint256 amount = initialAllowances[i].amount;
                address receiver = initialAllowances[i].receiver;
                totalAllocated += amount;
                // initial allocations are given as approvals
                prismaToken.increaseAllowance(receiver, amount);
            }
            unallocatedTotal = uint128(totalSupply - totalAllocated);
            totalUpdateWeek = uint64(_fixedInitialAmounts.length + offset - 1);
            lockWeeks = initialLockWeeks;
            emit EmissionScheduleSet(address(_emissionSchedule));
            emit BoostCalculatorSet(address(_boostCalculator));
            emit UnallocatedSupplyReduced(totalAllocated, unallocatedTotal);
        }
        /**
            @notice Register a new emission receiver
            @dev Once this function is called, the receiver ID is immediately
                 eligible for votes within `IncentiveVoting`
            @param receiver Address of the receiver
            @param count Number of IDs to assign to the receiver
         */
        function registerReceiver(address receiver, uint256 count) external onlyOwner returns (bool) {
            uint256[] memory assignedIds = new uint256[](count);
            uint16 week = uint16(getWeek());
            for (uint256 i = 0; i < count; i++) {
                uint256 id = voter.registerNewReceiver();
                assignedIds[i] = id;
                receiverUpdatedWeek[id] = week;
                idToReceiver[id] = Receiver({ account: receiver, isActive: true });
                emit NewReceiverRegistered(receiver, id);
            }
            // notify the receiver contract of the newly registered ID
            // also serves as a sanity check to ensure the contract is capable of receiving emissions
            IEmissionReceiver(receiver).notifyRegisteredId(assignedIds);
            return true;
        }
        /**
            @notice Modify the active status of an existing receiver
            @dev Emissions directed to an inactive receiver are instead returned to
                 the unallocated supply. This way potential emissions are not lost
                 due to old emissions votes pointing at a receiver that was phased out.
            @param id ID of the receiver to modify the isActive status for
            @param isActive is this receiver eligible to receive emissions?
         */
        function setReceiverIsActive(uint256 id, bool isActive) external onlyOwner returns (bool) {
            Receiver memory receiver = idToReceiver[id];
            require(receiver.account != address(0), "ID not set");
            receiver.isActive = isActive;
            idToReceiver[id] = receiver;
            emit ReceiverIsActiveStatusModified(id, isActive);
            return true;
        }
        /**
            @notice Set the `emissionSchedule` contract
            @dev Callable only by the owner (the DAO admin voter, to change the emission schedule).
                 The new schedule is applied from the start of the next epoch.
         */
        function setEmissionSchedule(IEmissionSchedule _emissionSchedule) external onlyOwner returns (bool) {
            _allocateTotalWeekly(emissionSchedule, getWeek());
            emissionSchedule = _emissionSchedule;
            emit EmissionScheduleSet(address(_emissionSchedule));
            return true;
        }
        function setBoostCalculator(IBoostCalculator _boostCalculator) external onlyOwner returns (bool) {
            boostCalculator = _boostCalculator;
            emit BoostCalculatorSet(address(_boostCalculator));
            return true;
        }
        /**
            @notice Transfer tokens out of the vault
         */
        function transferTokens(IERC20 token, address receiver, uint256 amount) external onlyOwner returns (bool) {
            if (address(token) == address(prismaToken)) {
                require(receiver != address(this), "Self transfer denied");
                uint256 unallocated = unallocatedTotal - amount;
                unallocatedTotal = uint128(unallocated);
                emit UnallocatedSupplyReduced(amount, unallocated);
            }
            token.safeTransfer(receiver, amount);
            return true;
        }
        /**
            @notice Receive PRISMA tokens and add them to the unallocated supply
         */
        function increaseUnallocatedSupply(uint256 amount) external returns (bool) {
            prismaToken.transferFrom(msg.sender, address(this), amount);
            uint256 unallocated = unallocatedTotal + amount;
            unallocatedTotal = uint128(unallocated);
            emit UnallocatedSupplyIncreased(amount, unallocated);
            return true;
        }
        function _allocateTotalWeekly(IEmissionSchedule _emissionSchedule, uint256 currentWeek) internal {
            uint256 week = totalUpdateWeek;
            if (week >= currentWeek) return;
            if (address(_emissionSchedule) == address(0)) {
                totalUpdateWeek = uint64(currentWeek);
                return;
            }
            uint256 lock;
            uint256 weeklyAmount;
            uint256 unallocated = unallocatedTotal;
            while (week < currentWeek) {
                ++week;
                (weeklyAmount, lock) = _emissionSchedule.getTotalWeeklyEmissions(week, unallocated);
                weeklyEmissions[week] = uint128(weeklyAmount);
                unallocated = unallocated - weeklyAmount;
                emit UnallocatedSupplyReduced(weeklyAmount, unallocated);
            }
            unallocatedTotal = uint128(unallocated);
            totalUpdateWeek = uint64(currentWeek);
            lockWeeks = uint64(lock);
        }
        /**
            @notice Allocate additional `prismaToken` allowance to an emission reciever
                    based on the emission schedule
            @param id Receiver ID. The caller must be the receiver mapped to this ID.
            @return uint256 Additional `prismaToken` allowance for the receiver. The receiver
                            accesses the tokens using `Vault.transferAllocatedTokens`
         */
        function allocateNewEmissions(uint256 id) external returns (uint256) {
            Receiver memory receiver = idToReceiver[id];
            require(receiver.account == msg.sender, "Receiver not registered");
            uint256 week = receiverUpdatedWeek[id];
            uint256 currentWeek = getWeek();
            if (week == currentWeek) return 0;
            IEmissionSchedule _emissionSchedule = emissionSchedule;
            _allocateTotalWeekly(_emissionSchedule, currentWeek);
            if (address(_emissionSchedule) == address(0)) {
                receiverUpdatedWeek[id] = uint16(currentWeek);
                return 0;
            }
            uint256 amount;
            while (week < currentWeek) {
                ++week;
                amount = amount + _emissionSchedule.getReceiverWeeklyEmissions(id, week, weeklyEmissions[week]);
            }
            receiverUpdatedWeek[id] = uint16(currentWeek);
            if (receiver.isActive) {
                allocated[msg.sender] = allocated[msg.sender] + amount;
                emit IncreasedAllocation(msg.sender, amount);
                return amount;
            } else {
                // if receiver is not active, return allocation to the unallocated supply
                uint256 unallocated = unallocatedTotal + amount;
                unallocatedTotal = uint128(unallocated);
                emit UnallocatedSupplyIncreased(amount, unallocated);
                return 0;
            }
        }
        /**
            @notice Transfer `prismaToken` tokens previously allocated to the caller
            @dev Callable only by registered receiver contracts which were previously
                 allocated tokens using `allocateNewEmissions`.
            @param claimant Address that is claiming the tokens
            @param receiver Address to transfer tokens to
            @param amount Desired amount of tokens to transfer. This value always assumes max boost.
            @return bool success
         */
        function transferAllocatedTokens(address claimant, address receiver, uint256 amount) external returns (bool) {
            if (amount > 0) {
                allocated[msg.sender] -= amount;
                _transferAllocated(0, claimant, receiver, address(0), amount);
            }
            return true;
        }
        /**
            @notice Claim earned tokens from multiple reward contracts, optionally with delegated boost
            @param receiver Address to transfer tokens to. Any earned 3rd-party rewards
                            are also sent to this address.
            @param boostDelegate Address to delegate boost from during this claim. Set as
                                 `address(0)` to use the boost of the claimer.
            @param rewardContracts Array of addresses of registered receiver contracts where
                                   the caller has pending rewards to claim.
            @param maxFeePct Maximum fee percent to pay to delegate, as a whole number out of 10000
            @return bool success
         */
        function batchClaimRewards(
            address receiver,
            address boostDelegate,
            IRewards[] calldata rewardContracts,
            uint256 maxFeePct
        ) external returns (bool) {
            require(maxFeePct <= 10000, "Invalid maxFeePct");
            uint256 total;
            uint256 length = rewardContracts.length;
            for (uint256 i = 0; i < length; i++) {
                uint256 amount = rewardContracts[i].vaultClaimReward(msg.sender, receiver);
                allocated[address(rewardContracts[i])] -= amount;
                total += amount;
            }
            _transferAllocated(maxFeePct, msg.sender, receiver, boostDelegate, total);
            return true;
        }
        /**
            @notice Claim tokens earned from boost delegation fees
            @param receiver Address to transfer the tokens to
            @return bool Success
         */
        function claimBoostDelegationFees(address receiver) external returns (bool) {
            uint256 amount = storedPendingReward[msg.sender];
            require(amount >= lockToTokenRatio, "Nothing to claim");
            _transferOrLock(msg.sender, receiver, amount);
            return true;
        }
        function _transferAllocated(
            uint256 maxFeePct,
            address account,
            address receiver,
            address boostDelegate,
            uint256 amount
        ) internal {
            if (amount > 0) {
                uint256 week = getWeek();
                uint256 totalWeekly = weeklyEmissions[week];
                address claimant = boostDelegate == address(0) ? account : boostDelegate;
                uint256 previousAmount = accountWeeklyEarned[claimant][week];
                // if boost delegation is active, get the fee and optional callback address
                uint256 fee;
                IBoostDelegate delegateCallback;
                if (boostDelegate != address(0)) {
                    Delegation memory data = boostDelegation[boostDelegate];
                    delegateCallback = data.callback;
                    require(data.isEnabled, "Invalid delegate");
                    if (data.feePct == type(uint16).max) {
                        fee = delegateCallback.getFeePct(account, receiver, amount, previousAmount, totalWeekly);
                        require(fee <= 10000, "Invalid delegate fee");
                    } else fee = data.feePct;
                    require(fee <= maxFeePct, "fee exceeds maxFeePct");
                }
                // calculate adjusted amount with actual boost applied
                uint256 adjustedAmount = boostCalculator.getBoostedAmountWrite(
                    claimant,
                    amount,
                    previousAmount,
                    totalWeekly
                );
                {
                    // remaining tokens from unboosted claims are added to the unallocated total
                    // context avoids stack-too-deep
                    uint256 boostUnclaimed = amount - adjustedAmount;
                    if (boostUnclaimed > 0) {
                        uint256 unallocated = unallocatedTotal + boostUnclaimed;
                        unallocatedTotal = uint128(unallocated);
                        emit UnallocatedSupplyIncreased(boostUnclaimed, unallocated);
                    }
                }
                accountWeeklyEarned[claimant][week] = uint128(previousAmount + amount);
                // apply boost delegation fee
                if (fee != 0) {
                    fee = (adjustedAmount * fee) / 10000;
                    adjustedAmount -= fee;
                }
                // add `storedPendingReward` to `adjustedAmount`
                // this happens after any boost modifiers or delegation fees, since
                // these effects were already applied to the stored value
                adjustedAmount += storedPendingReward[account];
                _transferOrLock(account, receiver, adjustedAmount);
                // apply delegate fee and optionally perform callback
                if (fee != 0) storedPendingReward[boostDelegate] += fee;
                if (address(delegateCallback) != address(0)) {
                    require(
                        delegateCallback.delegatedBoostCallback(
                            account,
                            receiver,
                            amount,
                            adjustedAmount,
                            fee,
                            previousAmount,
                            totalWeekly
                        ),
                        "Delegate callback rejected"
                    );
                }
            }
        }
        function _transferOrLock(address claimant, address receiver, uint256 amount) internal {
            uint256 _lockWeeks = lockWeeks;
            if (_lockWeeks == 0) {
                storedPendingReward[claimant] = 0;
                prismaToken.transfer(receiver, amount);
            } else {
                // lock for receiver and store remaining balance in `storedPendingReward`
                uint256 lockAmount = amount / lockToTokenRatio;
                storedPendingReward[claimant] = amount - lockAmount * lockToTokenRatio;
                if (lockAmount > 0) locker.lock(receiver, lockAmount, _lockWeeks);
            }
        }
        /**
            @notice Claimable PRISMA amount for `account` in `rewardContract` after applying boost
            @dev Returns (0, 0) if the boost delegate is invalid, or the delgate's callback fee
                 function is incorrectly configured.
            @param account Address claiming rewards
            @param boostDelegate Address to delegate boost from when claiming. Set as
                                 `address(0)` to use the boost of the claimer.
            @param rewardContract Address of the contract where rewards are being claimed
            @return adjustedAmount Amount received after boost, prior to paying delegate fee
            @return feeToDelegate Fee amount paid to `boostDelegate`
         */
        function claimableRewardAfterBoost(
            address account,
            address receiver,
            address boostDelegate,
            IRewards rewardContract
        ) external view returns (uint256 adjustedAmount, uint256 feeToDelegate) {
            uint256 amount = rewardContract.claimableReward(account);
            uint256 week = getWeek();
            uint256 totalWeekly = weeklyEmissions[week];
            address claimant = boostDelegate == address(0) ? account : boostDelegate;
            uint256 previousAmount = accountWeeklyEarned[claimant][week];
            uint256 fee;
            if (boostDelegate != address(0)) {
                Delegation memory data = boostDelegation[boostDelegate];
                if (!data.isEnabled) return (0, 0);
                fee = data.feePct;
                if (fee == type(uint16).max) {
                    try data.callback.getFeePct(claimant, receiver, amount, previousAmount, totalWeekly) returns (
                        uint256 _fee
                    ) {
                        fee = _fee;
                    } catch {
                        return (0, 0);
                    }
                }
                if (fee > 10000) return (0, 0);
            }
            adjustedAmount = boostCalculator.getBoostedAmount(claimant, amount, previousAmount, totalWeekly);
            fee = (adjustedAmount * fee) / 10000;
            return (adjustedAmount, fee);
        }
        /**
            @notice Enable or disable boost delegation, and set boost delegation parameters
            @param isEnabled is boost delegation enabled?
            @param feePct Fee % charged when claims are made that delegate to the caller's boost.
                          Given as a whole number out of 10000. If set to type(uint16).max, the fee
                          is set by calling `IBoostDelegate(callback).getFeePct` prior to each claim.
            @param callback Optional contract address to receive a callback each time a claim is
                            made which delegates to the caller's boost.
         */
        function setBoostDelegationParams(bool isEnabled, uint256 feePct, address callback) external returns (bool) {
            if (isEnabled) {
                require(feePct <= 10000 || feePct == type(uint16).max, "Invalid feePct");
                if (callback != address(0) || feePct == type(uint16).max) {
                    require(callback.isContract(), "Callback must be a contract");
                }
                boostDelegation[msg.sender] = Delegation({
                    isEnabled: true,
                    feePct: uint16(feePct),
                    callback: IBoostDelegate(callback)
                });
            } else {
                delete boostDelegation[msg.sender];
            }
            emit BoostDelegationSet(msg.sender, isEnabled, feePct, callback);
            return true;
        }
        /**
            @notice Get the remaining claimable amounts this week that will receive boost
            @param claimant address to query boost amounts for
            @return maxBoosted remaining claimable amount that will receive max boost
            @return boosted remaining claimable amount that will receive some amount of boost (including max boost)
         */
        function getClaimableWithBoost(address claimant) external view returns (uint256 maxBoosted, uint256 boosted) {
            uint256 week = getWeek();
            uint256 totalWeekly = weeklyEmissions[week];
            uint256 previousAmount = accountWeeklyEarned[claimant][week];
            return boostCalculator.getClaimableWithBoost(claimant, previousAmount, totalWeekly);
        }
        /**
            @notice Get the claimable amount that `claimant` has earned boost delegation fees
         */
        function claimableBoostDelegationFees(address claimant) external view returns (uint256 amount) {
            amount = storedPendingReward[claimant];
            // only return values `>= lockToTokenRatio` so we do not report "dust" stored for normal users
            return amount >= lockToTokenRatio ? amount : 0;
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
    pragma solidity ^0.8.0;
    import "IERC20.sol";
    import "draft-IERC20Permit.sol";
    import "Address.sol";
    /**
     * @title SafeERC20
     * @dev Wrappers around ERC20 operations that throw on failure (when the token
     * contract returns false). Tokens that return no value (and instead revert or
     * throw on failure) are also supported, non-reverting calls are assumed to be
     * successful.
     * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
     * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
     */
    library SafeERC20 {
        using Address for address;
        function safeTransfer(
            IERC20 token,
            address to,
            uint256 value
        ) internal {
            _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
        }
        function safeTransferFrom(
            IERC20 token,
            address from,
            address to,
            uint256 value
        ) internal {
            _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
        }
        /**
         * @dev Deprecated. This function has issues similar to the ones found in
         * {IERC20-approve}, and its usage is discouraged.
         *
         * Whenever possible, use {safeIncreaseAllowance} and
         * {safeDecreaseAllowance} instead.
         */
        function safeApprove(
            IERC20 token,
            address spender,
            uint256 value
        ) internal {
            // safeApprove should only be called when setting an initial allowance,
            // or when resetting it to zero. To increase and decrease it, use
            // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
            require(
                (value == 0) || (token.allowance(address(this), spender) == 0),
                "SafeERC20: approve from non-zero to non-zero allowance"
            );
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
        }
        function safeIncreaseAllowance(
            IERC20 token,
            address spender,
            uint256 value
        ) internal {
            uint256 newAllowance = token.allowance(address(this), spender) + value;
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
        }
        function safeDecreaseAllowance(
            IERC20 token,
            address spender,
            uint256 value
        ) internal {
            unchecked {
                uint256 oldAllowance = token.allowance(address(this), spender);
                require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
                uint256 newAllowance = oldAllowance - value;
                _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
            }
        }
        function safePermit(
            IERC20Permit token,
            address owner,
            address spender,
            uint256 value,
            uint256 deadline,
            uint8 v,
            bytes32 r,
            bytes32 s
        ) internal {
            uint256 nonceBefore = token.nonces(owner);
            token.permit(owner, spender, value, deadline, v, r, s);
            uint256 nonceAfter = token.nonces(owner);
            require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
        }
        /**
         * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
         * on the return value: the return value is optional (but if data is returned, it must not be false).
         * @param token The token targeted by the call.
         * @param data The call data (encoded using abi.encode or one of its variants).
         */
        function _callOptionalReturn(IERC20 token, bytes memory data) private {
            // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
            // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
            // the target address contains contract code and also asserts for success in the low-level call.
            bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
            if (returndata.length > 0) {
                // Return data is optional
                require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
            }
        }
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
    pragma solidity ^0.8.0;
    /**
     * @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 amount of tokens in existence.
         */
        function totalSupply() external view returns (uint256);
        /**
         * @dev Returns the amount of tokens owned by `account`.
         */
        function balanceOf(address account) external view returns (uint256);
        /**
         * @dev Moves `amount` tokens from the caller's account to `to`.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transfer(address to, uint256 amount) external returns (bool);
        /**
         * @dev Returns the remaining number of tokens that `spender` will be
         * allowed to spend on behalf of `owner` through {transferFrom}. This is
         * zero by default.
         *
         * This value changes when {approve} or {transferFrom} are called.
         */
        function allowance(address owner, address spender) external view returns (uint256);
        /**
         * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * IMPORTANT: Beware that changing an allowance with this method brings the risk
         * that someone may use both the old and the new allowance by unfortunate
         * transaction ordering. One possible solution to mitigate this race
         * condition is to first reduce the spender's allowance to 0 and set the
         * desired value afterwards:
         * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
         *
         * Emits an {Approval} event.
         */
        function approve(address spender, uint256 amount) external returns (bool);
        /**
         * @dev Moves `amount` tokens from `from` to `to` using the
         * allowance mechanism. `amount` is then deducted from the caller's
         * allowance.
         *
         * Returns a boolean value indicating whether the operation succeeded.
         *
         * Emits a {Transfer} event.
         */
        function transferFrom(
            address from,
            address to,
            uint256 amount
        ) external returns (bool);
    }
    // SPDX-License-Identifier: MIT
    // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
    pragma solidity ^0.8.0;
    /**
     * @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.
     */
    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].
         */
        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 v4.8.0) (utils/Address.sol)
    pragma solidity ^0.8.1;
    /**
     * @dev Collection of functions related to the address type
     */
    library Address {
        /**
         * @dev Returns true if `account` is a contract.
         *
         * [IMPORTANT]
         * ====
         * It is unsafe to assume that an address for which this function returns
         * false is an externally-owned account (EOA) and not a contract.
         *
         * Among others, `isContract` will return false for the following
         * types of addresses:
         *
         *  - an externally-owned account
         *  - a contract in construction
         *  - an address where a contract will be created
         *  - an address where a contract lived, but was destroyed
         * ====
         *
         * [IMPORTANT]
         * ====
         * You shouldn't rely on `isContract` to protect against flash loan attacks!
         *
         * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
         * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
         * constructor.
         * ====
         */
        function isContract(address account) internal view returns (bool) {
            // This method relies on extcodesize/address.code.length, which returns 0
            // for contracts in construction, since the code is only stored at the end
            // of the constructor execution.
            return account.code.length > 0;
        }
        /**
         * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
         * `recipient`, forwarding all available gas and reverting on errors.
         *
         * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
         * of certain opcodes, possibly making contracts go over the 2300 gas limit
         * imposed by `transfer`, making them unable to receive funds via
         * `transfer`. {sendValue} removes this limitation.
         *
         * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
         *
         * IMPORTANT: because control is transferred to `recipient`, care must be
         * taken to not create reentrancy vulnerabilities. Consider using
         * {ReentrancyGuard} or the
         * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
         */
        function sendValue(address payable recipient, uint256 amount) internal {
            require(address(this).balance >= amount, "Address: insufficient balance");
            (bool success, ) = recipient.call{value: amount}("");
            require(success, "Address: unable to send value, recipient may have reverted");
        }
        /**
         * @dev Performs a Solidity function call using a low level `call`. A
         * plain `call` is an unsafe replacement for a function call: use this
         * function instead.
         *
         * If `target` reverts with a revert reason, it is bubbled up by this
         * function (like regular Solidity function calls).
         *
         * Returns the raw returned data. To convert to the expected return value,
         * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
         *
         * Requirements:
         *
         * - `target` must be a contract.
         * - calling `target` with `data` must not revert.
         *
         * _Available since v3.1._
         */
        function functionCall(address target, bytes memory data) internal returns (bytes memory) {
            return functionCallWithValue(target, data, 0, "Address: low-level call failed");
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
         * `errorMessage` as a fallback revert reason when `target` reverts.
         *
         * _Available since v3.1._
         */
        function functionCall(
            address target,
            bytes memory data,
            string memory errorMessage
        ) internal returns (bytes memory) {
            return functionCallWithValue(target, data, 0, errorMessage);
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
         * but also transferring `value` wei to `target`.
         *
         * Requirements:
         *
         * - the calling contract must have an ETH balance of at least `value`.
         * - the called Solidity function must be `payable`.
         *
         * _Available since v3.1._
         */
        function functionCallWithValue(
            address target,
            bytes memory data,
            uint256 value
        ) internal returns (bytes memory) {
            return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
        }
        /**
         * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
         * with `errorMessage` as a fallback revert reason when `target` reverts.
         *
         * _Available since v3.1._
         */
        function functionCallWithValue(
            address target,
            bytes memory data,
            uint256 value,
            string memory errorMessage
        ) internal returns (bytes memory) {
            require(address(this).balance >= value, "Address: insufficient balance for call");
            (bool success, bytes memory returndata) = target.call{value: value}(data);
            return verifyCallResultFromTarget(target, success, returndata, errorMessage);
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
         * but performing a static call.
         *
         * _Available since v3.3._
         */
        function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
            return functionStaticCall(target, data, "Address: low-level static call failed");
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
         * but performing a static call.
         *
         * _Available since v3.3._
         */
        function functionStaticCall(
            address target,
            bytes memory data,
            string memory errorMessage
        ) internal view returns (bytes memory) {
            (bool success, bytes memory returndata) = target.staticcall(data);
            return verifyCallResultFromTarget(target, success, returndata, errorMessage);
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
         * but performing a delegate call.
         *
         * _Available since v3.4._
         */
        function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
            return functionDelegateCall(target, data, "Address: low-level delegate call failed");
        }
        /**
         * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
         * but performing a delegate call.
         *
         * _Available since v3.4._
         */
        function functionDelegateCall(
            address target,
            bytes memory data,
            string memory errorMessage
        ) internal returns (bytes memory) {
            (bool success, bytes memory returndata) = target.delegatecall(data);
            return verifyCallResultFromTarget(target, success, returndata, errorMessage);
        }
        /**
         * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
         * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
         *
         * _Available since v4.8._
         */
        function verifyCallResultFromTarget(
            address target,
            bool success,
            bytes memory returndata,
            string memory errorMessage
        ) internal view returns (bytes memory) {
            if (success) {
                if (returndata.length == 0) {
                    // only check isContract if the call was successful and the return data is empty
                    // otherwise we already know that it was a contract
                    require(isContract(target), "Address: call to non-contract");
                }
                return returndata;
            } else {
                _revert(returndata, errorMessage);
            }
        }
        /**
         * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
         * revert reason or using the provided one.
         *
         * _Available since v4.3._
         */
        function verifyCallResult(
            bool success,
            bytes memory returndata,
            string memory errorMessage
        ) internal pure returns (bytes memory) {
            if (success) {
                return returndata;
            } else {
                _revert(returndata, errorMessage);
            }
        }
        function _revert(bytes memory returndata, string memory errorMessage) 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(errorMessage);
            }
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    import "IPrismaCore.sol";
    /**
        @title Prisma Ownable
        @notice Contracts inheriting `PrismaOwnable` have the same owner as `PrismaCore`.
                The ownership cannot be independently modified or renounced.
     */
    contract PrismaOwnable {
        IPrismaCore public immutable PRISMA_CORE;
        constructor(address _prismaCore) {
            PRISMA_CORE = IPrismaCore(_prismaCore);
        }
        modifier onlyOwner() {
            require(msg.sender == PRISMA_CORE.owner(), "Only owner");
            _;
        }
        function owner() public view returns (address) {
            return PRISMA_CORE.owner();
        }
        function guardian() public view returns (address) {
            return PRISMA_CORE.guardian();
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface IPrismaCore {
        event FeeReceiverSet(address feeReceiver);
        event GuardianSet(address guardian);
        event NewOwnerAccepted(address oldOwner, address owner);
        event NewOwnerCommitted(address owner, address pendingOwner, uint256 deadline);
        event NewOwnerRevoked(address owner, address revokedOwner);
        event Paused();
        event PriceFeedSet(address priceFeed);
        event Unpaused();
        function acceptTransferOwnership() external;
        function commitTransferOwnership(address newOwner) external;
        function revokeTransferOwnership() external;
        function setFeeReceiver(address _feeReceiver) external;
        function setGuardian(address _guardian) external;
        function setPaused(bool _paused) external;
        function setPriceFeed(address _priceFeed) external;
        function OWNERSHIP_TRANSFER_DELAY() external view returns (uint256);
        function feeReceiver() external view returns (address);
        function guardian() external view returns (address);
        function owner() external view returns (address);
        function ownershipTransferDeadline() external view returns (uint256);
        function paused() external view returns (bool);
        function pendingOwner() external view returns (address);
        function priceFeed() external view returns (address);
        function startTime() external view returns (uint256);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    import "IPrismaCore.sol";
    /**
        @title Prisma System Start Time
        @dev Provides a unified `startTime` and `getWeek`, used for emissions.
     */
    contract SystemStart {
        uint256 immutable startTime;
        constructor(address prismaCore) {
            startTime = IPrismaCore(prismaCore).startTime();
        }
        function getWeek() public view returns (uint256 week) {
            return (block.timestamp - startTime) / 1 weeks;
        }
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface IPrismaToken {
        event Approval(address indexed owner, address indexed spender, uint256 value);
        event MessageFailed(uint16 _srcChainId, bytes _srcAddress, uint64 _nonce, bytes _payload, bytes _reason);
        event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
        event ReceiveFromChain(uint16 indexed _srcChainId, address indexed _to, uint256 _amount);
        event RetryMessageSuccess(uint16 _srcChainId, bytes _srcAddress, uint64 _nonce, bytes32 _payloadHash);
        event SendToChain(uint16 indexed _dstChainId, address indexed _from, bytes _toAddress, uint256 _amount);
        event SetMinDstGas(uint16 _dstChainId, uint16 _type, uint256 _minDstGas);
        event SetPrecrime(address precrime);
        event SetTrustedRemote(uint16 _remoteChainId, bytes _path);
        event SetTrustedRemoteAddress(uint16 _remoteChainId, bytes _remoteAddress);
        event SetUseCustomAdapterParams(bool _useCustomAdapterParams);
        event Transfer(address indexed from, address indexed to, uint256 value);
        function approve(address spender, uint256 amount) external returns (bool);
        function decreaseAllowance(address spender, uint256 subtractedValue) external returns (bool);
        function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external;
        function increaseAllowance(address spender, uint256 addedValue) external returns (bool);
        function lzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) external;
        function mintToVault(uint256 _totalSupply) external returns (bool);
        function nonblockingLzReceive(
            uint16 _srcChainId,
            bytes calldata _srcAddress,
            uint64 _nonce,
            bytes calldata _payload
        ) external;
        function permit(
            address owner,
            address spender,
            uint256 amount,
            uint256 deadline,
            uint8 v,
            bytes32 r,
            bytes32 s
        ) external;
        function renounceOwnership() external;
        function setConfig(uint16 _version, uint16 _chainId, uint256 _configType, bytes calldata _config) external;
        function setMinDstGas(uint16 _dstChainId, uint16 _packetType, uint256 _minGas) external;
        function setPayloadSizeLimit(uint16 _dstChainId, uint256 _size) external;
        function setPrecrime(address _precrime) external;
        function setReceiveVersion(uint16 _version) external;
        function setSendVersion(uint16 _version) external;
        function setTrustedRemote(uint16 _srcChainId, bytes calldata _path) external;
        function setTrustedRemoteAddress(uint16 _remoteChainId, bytes calldata _remoteAddress) external;
        function setUseCustomAdapterParams(bool _useCustomAdapterParams) external;
        function transfer(address to, uint256 amount) external returns (bool);
        function transferFrom(address from, address to, uint256 amount) external returns (bool);
        function transferOwnership(address newOwner) external;
        function transferToLocker(address sender, uint256 amount) external returns (bool);
        function retryMessage(
            uint16 _srcChainId,
            bytes calldata _srcAddress,
            uint64 _nonce,
            bytes calldata _payload
        ) external payable;
        function sendFrom(
            address _from,
            uint16 _dstChainId,
            bytes calldata _toAddress,
            uint256 _amount,
            address _refundAddress,
            address _zroPaymentAddress,
            bytes calldata _adapterParams
        ) external payable;
        function DEFAULT_PAYLOAD_SIZE_LIMIT() external view returns (uint256);
        function NO_EXTRA_GAS() external view returns (uint256);
        function PT_SEND() external view returns (uint16);
        function allowance(address owner, address spender) external view returns (uint256);
        function balanceOf(address account) external view returns (uint256);
        function circulatingSupply() external view returns (uint256);
        function decimals() external view returns (uint8);
        function domainSeparator() external view returns (bytes32);
        function estimateSendFee(
            uint16 _dstChainId,
            bytes calldata _toAddress,
            uint256 _amount,
            bool _useZro,
            bytes calldata _adapterParams
        ) external view returns (uint256 nativeFee, uint256 zroFee);
        function failedMessages(uint16, bytes calldata, uint64) external view returns (bytes32);
        function getConfig(
            uint16 _version,
            uint16 _chainId,
            address,
            uint256 _configType
        ) external view returns (bytes memory);
        function getTrustedRemoteAddress(uint16 _remoteChainId) external view returns (bytes memory);
        function isTrustedRemote(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (bool);
        function locker() external view returns (address);
        function lzEndpoint() external view returns (address);
        function maxTotalSupply() external view returns (uint256);
        function minDstGasLookup(uint16, uint16) external view returns (uint256);
        function name() external view returns (string memory);
        function nonces(address owner) external view returns (uint256);
        function owner() external view returns (address);
        function payloadSizeLimitLookup(uint16) external view returns (uint256);
        function permitTypeHash() external view returns (bytes32);
        function precrime() external view returns (address);
        function supportsInterface(bytes4 interfaceId) external view returns (bool);
        function symbol() external view returns (string memory);
        function token() external view returns (address);
        function totalSupply() external view returns (uint256);
        function trustedRemoteLookup(uint16) external view returns (bytes memory);
        function useCustomAdapterParams() external view returns (bool);
        function vault() external view returns (address);
        function version() external view returns (string memory);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface IEmissionSchedule {
        event LockParametersSet(uint256 lockWeeks, uint256 lockDecayWeeks);
        event WeeklyPctScheduleSet(uint64[2][] schedule);
        function getReceiverWeeklyEmissions(
            uint256 id,
            uint256 week,
            uint256 totalWeeklyEmissions
        ) external returns (uint256);
        function getTotalWeeklyEmissions(
            uint256 week,
            uint256 unallocatedTotal
        ) external returns (uint256 amount, uint256 lock);
        function setLockParameters(uint64 _lockWeeks, uint64 _lockDecayWeeks) external returns (bool);
        function setWeeklyPctSchedule(uint64[2][] calldata _schedule) external returns (bool);
        function MAX_LOCK_WEEKS() external view returns (uint256);
        function PRISMA_CORE() external view returns (address);
        function getWeek() external view returns (uint256 week);
        function getWeeklyPctSchedule() external view returns (uint64[2][] memory);
        function guardian() external view returns (address);
        function lockDecayWeeks() external view returns (uint64);
        function lockWeeks() external view returns (uint64);
        function owner() external view returns (address);
        function vault() external view returns (address);
        function voter() external view returns (address);
        function weeklyPct() external view returns (uint64);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface IIncentiveVoting {
        struct Vote {
            uint256 id;
            uint256 points;
        }
        struct LockData {
            uint256 amount;
            uint256 weeksToUnlock;
        }
        event AccountWeightRegistered(
            address indexed account,
            uint256 indexed week,
            uint256 frozenBalance,
            LockData[] registeredLockData
        );
        event ClearedVotes(address indexed account, uint256 indexed week);
        event NewVotes(address indexed account, uint256 indexed week, Vote[] newVotes, uint256 totalPointsUsed);
        function clearRegisteredWeight(address account) external returns (bool);
        function clearVote(address account) external;
        function getReceiverVotePct(uint256 id, uint256 week) external returns (uint256);
        function getReceiverWeightWrite(uint256 idx) external returns (uint256);
        function getTotalWeightWrite() external returns (uint256);
        function registerAccountWeight(address account, uint256 minWeeks) external;
        function registerAccountWeightAndVote(address account, uint256 minWeeks, Vote[] calldata votes) external;
        function registerNewReceiver() external returns (uint256);
        function setDelegateApproval(address _delegate, bool _isApproved) external;
        function unfreeze(address account, bool keepVote) external returns (bool);
        function vote(address account, Vote[] calldata votes, bool clearPrevious) external;
        function MAX_LOCK_WEEKS() external view returns (uint256);
        function MAX_POINTS() external view returns (uint256);
        function getAccountCurrentVotes(address account) external view returns (Vote[] memory votes);
        function getAccountRegisteredLocks(
            address account
        ) external view returns (uint256 frozenWeight, LockData[] memory lockData);
        function getReceiverWeight(uint256 idx) external view returns (uint256);
        function getReceiverWeightAt(uint256 idx, uint256 week) external view returns (uint256);
        function getTotalWeight() external view returns (uint256);
        function getTotalWeightAt(uint256 week) external view returns (uint256);
        function getWeek() external view returns (uint256 week);
        function isApprovedDelegate(address owner, address caller) external view returns (bool isApproved);
        function receiverCount() external view returns (uint256);
        function receiverDecayRate(uint256) external view returns (uint32);
        function receiverUpdatedWeek(uint256) external view returns (uint16);
        function receiverWeeklyUnlocks(uint256, uint256) external view returns (uint32);
        function tokenLocker() external view returns (address);
        function totalDecayRate() external view returns (uint32);
        function totalUpdatedWeek() external view returns (uint16);
        function totalWeeklyUnlocks(uint256) external view returns (uint32);
        function vault() external view returns (address);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface ITokenLocker {
        struct LockData {
            uint256 amount;
            uint256 weeksToUnlock;
        }
        struct ExtendLockData {
            uint256 amount;
            uint256 currentWeeks;
            uint256 newWeeks;
        }
        event LockCreated(address indexed account, uint256 amount, uint256 _weeks);
        event LockExtended(address indexed account, uint256 amount, uint256 _weeks, uint256 newWeeks);
        event LocksCreated(address indexed account, LockData[] newLocks);
        event LocksExtended(address indexed account, ExtendLockData[] locks);
        event LocksFrozen(address indexed account, uint256 amount);
        event LocksUnfrozen(address indexed account, uint256 amount);
        event LocksWithdrawn(address indexed account, uint256 withdrawn, uint256 penalty);
        function extendLock(uint256 _amount, uint256 _weeks, uint256 _newWeeks) external returns (bool);
        function extendMany(ExtendLockData[] calldata newExtendLocks) external returns (bool);
        function freeze() external;
        function getAccountWeightWrite(address account) external returns (uint256);
        function getTotalWeightWrite() external returns (uint256);
        function lock(address _account, uint256 _amount, uint256 _weeks) external returns (bool);
        function lockMany(address _account, LockData[] calldata newLocks) external returns (bool);
        function setPenaltyWithdrawalsEnabled(bool _enabled) external returns (bool);
        function unfreeze(bool keepIncentivesVote) external;
        function withdrawExpiredLocks(uint256 _weeks) external returns (bool);
        function withdrawWithPenalty(uint256 amountToWithdraw) external returns (uint256);
        function MAX_LOCK_WEEKS() external view returns (uint256);
        function PRISMA_CORE() external view returns (address);
        function getAccountActiveLocks(
            address account,
            uint256 minWeeks
        ) external view returns (LockData[] memory lockData, uint256 frozenAmount);
        function getAccountBalances(address account) external view returns (uint256 locked, uint256 unlocked);
        function getAccountWeight(address account) external view returns (uint256);
        function getAccountWeightAt(address account, uint256 week) external view returns (uint256);
        function getTotalWeight() external view returns (uint256);
        function getTotalWeightAt(uint256 week) external view returns (uint256);
        function getWeek() external view returns (uint256 week);
        function getWithdrawWithPenaltyAmounts(
            address account,
            uint256 amountToWithdraw
        ) external view returns (uint256 amountWithdrawn, uint256 penaltyAmountPaid);
        function guardian() external view returns (address);
        function incentiveVoter() external view returns (address);
        function lockToTokenRatio() external view returns (uint256);
        function lockToken() external view returns (address);
        function owner() external view returns (address);
        function penaltyWithdrawalsEnabled() external view returns (bool);
        function prismaCore() external view returns (address);
        function totalDecayRate() external view returns (uint32);
        function totalUpdatedWeek() external view returns (uint16);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity 0.8.19;
    /**
        @title Prisma Boost Delegate Interface
        @notice When enabling boost delegation via `Vault.setBoostDelegationParams`,
                you may optionally set a `callback` contract. If set, it should adhere
                to the following interface.
     */
    interface IBoostDelegate {
        /**
            @notice Get the current fee percent charged to use this boost delegate
            @dev Optional. Only called if the feePct is set to `type(uint16).max` when
                 enabling delegation.
            @param claimant Address that will perform the claim
            @param amount Amount to be claimed (before applying boost or fee)
            @param previousAmount Previous amount claimed this week by this contract
            @param totalWeeklyEmissions Total weekly emissions released this week
            @return feePct Fee % charged for claims that use this contracts' delegated boost.
                          Given as a whole number out of 10000. If a claim would be rejected,
                          the preferred return value is `type(uint256).max`.
         */
        function getFeePct(
            address claimant,
            address receiver,
            uint amount,
            uint previousAmount,
            uint totalWeeklyEmissions
        ) external view returns (uint256 feePct);
        /**
            @notice Callback function for boost delegators
            @dev MUST BE INCLUDED. Called after each successful claim which used
                 this contract's delegated boost.
            @param claimant Address that performed the claim
            @param amount Amount that claimed (before applying boost or fee)
            @param adjustedAmount Actual amount received by `claimant`
            @param fee Fee amount paid by `claimant`
            @param previousAmount Previous amount claimed this week by this contract
            @param totalWeeklyEmissions Total weekly emissions released this week
         */
        function delegatedBoostCallback(
            address claimant,
            address receiver,
            uint amount,
            uint adjustedAmount,
            uint fee,
            uint previousAmount,
            uint totalWeeklyEmissions
        ) external returns (bool success);
    }
    // SPDX-License-Identifier: MIT
    pragma solidity ^0.8.0;
    interface IBoostCalculator {
        function getBoostedAmountWrite(
            address account,
            uint256 amount,
            uint256 previousAmount,
            uint256 totalWeeklyEmissions
        ) external returns (uint256 adjustedAmount);
        function MAX_BOOST_GRACE_WEEKS() external view returns (uint256);
        function getBoostedAmount(
            address account,
            uint256 amount,
            uint256 previousAmount,
            uint256 totalWeeklyEmissions
        ) external view returns (uint256 adjustedAmount);
        function getClaimableWithBoost(
            address claimant,
            uint256 previousAmount,
            uint256 totalWeeklyEmissions
        ) external view returns (uint256 maxBoosted, uint256 boosted);
        function getWeek() external view returns (uint256 week);
        function locker() external view returns (address);
    }