creation_sourcecode: // SPDX-License-Identifier: AGPL-3.0
  pragma solidity =0.8.23 >=0.8.18 ^0.8.20;
  
  // lib/openzeppelin-contracts/contracts/access/IAccessControl.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (access/IAccessControl.sol)
  
  /**
   * @dev External interface of AccessControl declared to support ERC165 detection.
   */
  interface IAccessControl {
      /**
       * @dev The `account` is missing a role.
       */
      error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
  
      /**
       * @dev The caller of a function is not the expected one.
       *
       * NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
       */
      error AccessControlBadConfirmation();
  
      /**
       * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
       *
       * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
       * {RoleAdminChanged} not being emitted signaling this.
       */
      event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
  
      /**
       * @dev Emitted when `account` is granted `role`.
       *
       * `sender` is the account that originated the contract call, an admin role
       * bearer except when using {AccessControl-_setupRole}.
       */
      event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
  
      /**
       * @dev Emitted when `account` is revoked `role`.
       *
       * `sender` is the account that originated the contract call:
       *   - if using `revokeRole`, it is the admin role bearer
       *   - if using `renounceRole`, it is the role bearer (i.e. `account`)
       */
      event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
  
      /**
       * @dev Returns `true` if `account` has been granted `role`.
       */
      function hasRole(bytes32 role, address account) external view returns (bool);
  
      /**
       * @dev Returns the admin role that controls `role`. See {grantRole} and
       * {revokeRole}.
       *
       * To change a role's admin, use {AccessControl-_setRoleAdmin}.
       */
      function getRoleAdmin(bytes32 role) external view returns (bytes32);
  
      /**
       * @dev Grants `role` to `account`.
       *
       * If `account` had not been already granted `role`, emits a {RoleGranted}
       * event.
       *
       * Requirements:
       *
       * - the caller must have ``role``'s admin role.
       */
      function grantRole(bytes32 role, address account) external;
  
      /**
       * @dev Revokes `role` from `account`.
       *
       * If `account` had been granted `role`, emits a {RoleRevoked} event.
       *
       * Requirements:
       *
       * - the caller must have ``role``'s admin role.
       */
      function revokeRole(bytes32 role, address account) external;
  
      /**
       * @dev Revokes `role` from the calling account.
       *
       * Roles are often managed via {grantRole} and {revokeRole}: this function's
       * purpose is to provide a mechanism for accounts to lose their privileges
       * if they are compromised (such as when a trusted device is misplaced).
       *
       * If the calling account had been granted `role`, emits a {RoleRevoked}
       * event.
       *
       * Requirements:
       *
       * - the caller must be `callerConfirmation`.
       */
      function renounceRole(bytes32 role, address callerConfirmation) external;
  }
  
  // lib/openzeppelin-contracts/contracts/interfaces/IERC5313.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5313.sol)
  
  /**
   * @dev Interface for the Light Contract Ownership Standard.
   *
   * A standardized minimal interface required to identify an account that controls a contract
   */
  interface IERC5313 {
      /**
       * @dev Gets the address of the owner.
       */
      function owner() external view returns (address);
  }
  
  // lib/openzeppelin-contracts/contracts/interfaces/draft-IERC1822.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC1822.sol)
  
  /**
   * @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
   * proxy whose upgrades are fully controlled by the current implementation.
   */
  interface IERC1822Proxiable {
      /**
       * @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
       * address.
       *
       * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
       * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
       * function revert if invoked through a proxy.
       */
      function proxiableUUID() external view returns (bytes32);
  }
  
  // lib/openzeppelin-contracts/contracts/proxy/beacon/IBeacon.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (proxy/beacon/IBeacon.sol)
  
  /**
   * @dev This is the interface that {BeaconProxy} expects of its beacon.
   */
  interface IBeacon {
      /**
       * @dev Must return an address that can be used as a delegate call target.
       *
       * {UpgradeableBeacon} will check that this address is a contract.
       */
      function implementation() external view returns (address);
  }
  
  // lib/openzeppelin-contracts/contracts/token/ERC20/IERC20.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
  
  /**
   * @dev Interface of the ERC20 standard as defined in the EIP.
   */
  interface IERC20 {
      /**
       * @dev Emitted when `value` tokens are moved from one account (`from`) to
       * another (`to`).
       *
       * Note that `value` may be zero.
       */
      event Transfer(address indexed from, address indexed to, uint256 value);
  
      /**
       * @dev Emitted when the allowance of a `spender` for an `owner` is set by
       * a call to {approve}. `value` is the new allowance.
       */
      event Approval(address indexed owner, address indexed spender, uint256 value);
  
      /**
       * @dev Returns the value of tokens in existence.
       */
      function totalSupply() external view returns (uint256);
  
      /**
       * @dev Returns the value of tokens owned by `account`.
       */
      function balanceOf(address account) external view returns (uint256);
  
      /**
       * @dev Moves a `value` amount of tokens from the caller's account to `to`.
       *
       * Returns a boolean value indicating whether the operation succeeded.
       *
       * Emits a {Transfer} event.
       */
      function transfer(address to, uint256 value) external returns (bool);
  
      /**
       * @dev Returns the remaining number of tokens that `spender` will be
       * allowed to spend on behalf of `owner` through {transferFrom}. This is
       * zero by default.
       *
       * This value changes when {approve} or {transferFrom} are called.
       */
      function allowance(address owner, address spender) external view returns (uint256);
  
      /**
       * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
       * caller's tokens.
       *
       * Returns a boolean value indicating whether the operation succeeded.
       *
       * IMPORTANT: Beware that changing an allowance with this method brings the risk
       * that someone may use both the old and the new allowance by unfortunate
       * transaction ordering. One possible solution to mitigate this race
       * condition is to first reduce the spender's allowance to 0 and set the
       * desired value afterwards:
       * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
       *
       * Emits an {Approval} event.
       */
      function approve(address spender, uint256 value) external returns (bool);
  
      /**
       * @dev Moves a `value` amount of tokens from `from` to `to` using the
       * allowance mechanism. `value` is then deducted from the caller's
       * allowance.
       *
       * Returns a boolean value indicating whether the operation succeeded.
       *
       * Emits a {Transfer} event.
       */
      function transferFrom(address from, address to, uint256 value) external returns (bool);
  }
  
  // lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Permit.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)
  
  /**
   * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
   * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
   *
   * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
   * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
   * need to send a transaction, and thus is not required to hold Ether at all.
   *
   * ==== Security Considerations
   *
   * There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
   * expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
   * considered as an intention to spend the allowance in any specific way. The second is that because permits have
   * built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
   * take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
   * generally recommended is:
   *
   * ```solidity
   * function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
   *     try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
   *     doThing(..., value);
   * }
   *
   * function doThing(..., uint256 value) public {
   *     token.safeTransferFrom(msg.sender, address(this), value);
   *     ...
   * }
   * ```
   *
   * Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
   * `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
   * {SafeERC20-safeTransferFrom}).
   *
   * Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
   * contracts should have entry points that don't rely on permit.
   */
  interface IERC20Permit {
      /**
       * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
       * given ``owner``'s signed approval.
       *
       * IMPORTANT: The same issues {IERC20-approve} has related to transaction
       * ordering also apply here.
       *
       * Emits an {Approval} event.
       *
       * Requirements:
       *
       * - `spender` cannot be the zero address.
       * - `deadline` must be a timestamp in the future.
       * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
       * over the EIP712-formatted function arguments.
       * - the signature must use ``owner``'s current nonce (see {nonces}).
       *
       * For more information on the signature format, see the
       * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
       * section].
       *
       * CAUTION: See Security Considerations above.
       */
      function permit(
          address owner,
          address spender,
          uint256 value,
          uint256 deadline,
          uint8 v,
          bytes32 r,
          bytes32 s
      ) external;
  
      /**
       * @dev Returns the current nonce for `owner`. This value must be
       * included whenever a signature is generated for {permit}.
       *
       * Every successful call to {permit} increases ``owner``'s nonce by one. This
       * prevents a signature from being used multiple times.
       */
      function nonces(address owner) external view returns (uint256);
  
      /**
       * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
       */
      // solhint-disable-next-line func-name-mixedcase
      function DOMAIN_SEPARATOR() external view returns (bytes32);
  }
  
  // lib/openzeppelin-contracts/contracts/utils/Address.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)
  
  /**
   * @dev Collection of functions related to the address type
   */
  library Address {
      /**
       * @dev The ETH balance of the account is not enough to perform the operation.
       */
      error AddressInsufficientBalance(address account);
  
      /**
       * @dev There's no code at `target` (it is not a contract).
       */
      error AddressEmptyCode(address target);
  
      /**
       * @dev A call to an address target failed. The target may have reverted.
       */
      error FailedInnerCall();
  
      /**
       * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
       * `recipient`, forwarding all available gas and reverting on errors.
       *
       * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
       * of certain opcodes, possibly making contracts go over the 2300 gas limit
       * imposed by `transfer`, making them unable to receive funds via
       * `transfer`. {sendValue} removes this limitation.
       *
       * https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
       *
       * IMPORTANT: because control is transferred to `recipient`, care must be
       * taken to not create reentrancy vulnerabilities. Consider using
       * {ReentrancyGuard} or the
       * https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
       */
      function sendValue(address payable recipient, uint256 amount) internal {
          if (address(this).balance < amount) {
              revert AddressInsufficientBalance(address(this));
          }
  
          (bool success, ) = recipient.call{value: amount}("");
          if (!success) {
              revert FailedInnerCall();
          }
      }
  
      /**
       * @dev Performs a Solidity function call using a low level `call`. A
       * plain `call` is an unsafe replacement for a function call: use this
       * function instead.
       *
       * If `target` reverts with a revert reason or custom error, it is bubbled
       * up by this function (like regular Solidity function calls). However, if
       * the call reverted with no returned reason, this function reverts with a
       * {FailedInnerCall} error.
       *
       * Returns the raw returned data. To convert to the expected return value,
       * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
       *
       * Requirements:
       *
       * - `target` must be a contract.
       * - calling `target` with `data` must not revert.
       */
      function functionCall(address target, bytes memory data) internal returns (bytes memory) {
          return functionCallWithValue(target, data, 0);
      }
  
      /**
       * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
       * but also transferring `value` wei to `target`.
       *
       * Requirements:
       *
       * - the calling contract must have an ETH balance of at least `value`.
       * - the called Solidity function must be `payable`.
       */
      function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
          if (address(this).balance < value) {
              revert AddressInsufficientBalance(address(this));
          }
          (bool success, bytes memory returndata) = target.call{value: value}(data);
          return verifyCallResultFromTarget(target, success, returndata);
      }
  
      /**
       * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
       * but performing a static call.
       */
      function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
          (bool success, bytes memory returndata) = target.staticcall(data);
          return verifyCallResultFromTarget(target, success, returndata);
      }
  
      /**
       * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
       * but performing a delegate call.
       */
      function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
          (bool success, bytes memory returndata) = target.delegatecall(data);
          return verifyCallResultFromTarget(target, success, returndata);
      }
  
      /**
       * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
       * was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an
       * unsuccessful call.
       */
      function verifyCallResultFromTarget(
          address target,
          bool success,
          bytes memory returndata
      ) internal view returns (bytes memory) {
          if (!success) {
              _revert(returndata);
          } else {
              // only check if target is a contract if the call was successful and the return data is empty
              // otherwise we already know that it was a contract
              if (returndata.length == 0 && target.code.length == 0) {
                  revert AddressEmptyCode(target);
              }
              return returndata;
          }
      }
  
      /**
       * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
       * revert reason or with a default {FailedInnerCall} error.
       */
      function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
          if (!success) {
              _revert(returndata);
          } else {
              return returndata;
          }
      }
  
      /**
       * @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
       */
      function _revert(bytes memory returndata) private pure {
          // Look for revert reason and bubble it up if present
          if (returndata.length > 0) {
              // The easiest way to bubble the revert reason is using memory via assembly
              /// @solidity memory-safe-assembly
              assembly {
                  let returndata_size := mload(returndata)
                  revert(add(32, returndata), returndata_size)
              }
          } else {
              revert FailedInnerCall();
          }
      }
  }
  
  // lib/openzeppelin-contracts/contracts/utils/StorageSlot.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/StorageSlot.sol)
  // This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
  
  /**
   * @dev Library for reading and writing primitive types to specific storage slots.
   *
   * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
   * This library helps with reading and writing to such slots without the need for inline assembly.
   *
   * The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
   *
   * Example usage to set ERC1967 implementation slot:
   * ```solidity
   * contract ERC1967 {
   *     bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
   *
   *     function _getImplementation() internal view returns (address) {
   *         return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
   *     }
   *
   *     function _setImplementation(address newImplementation) internal {
   *         require(newImplementation.code.length > 0);
   *         StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
   *     }
   * }
   * ```
   */
  library StorageSlot {
      struct AddressSlot {
          address value;
      }
  
      struct BooleanSlot {
          bool value;
      }
  
      struct Bytes32Slot {
          bytes32 value;
      }
  
      struct Uint256Slot {
          uint256 value;
      }
  
      struct StringSlot {
          string value;
      }
  
      struct BytesSlot {
          bytes value;
      }
  
      /**
       * @dev Returns an `AddressSlot` with member `value` located at `slot`.
       */
      function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `BooleanSlot` with member `value` located at `slot`.
       */
      function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
       */
      function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `Uint256Slot` with member `value` located at `slot`.
       */
      function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `StringSlot` with member `value` located at `slot`.
       */
      function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `StringSlot` representation of the string storage pointer `store`.
       */
      function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := store.slot
          }
      }
  
      /**
       * @dev Returns an `BytesSlot` with member `value` located at `slot`.
       */
      function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := slot
          }
      }
  
      /**
       * @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
       */
      function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
          /// @solidity memory-safe-assembly
          assembly {
              r.slot := store.slot
          }
      }
  }
  
  // lib/openzeppelin-contracts/contracts/utils/introspection/IERC165.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)
  
  /**
   * @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);
  }
  
  // lib/openzeppelin-contracts/contracts/utils/math/Math.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/math/Math.sol)
  
  /**
   * @dev Standard math utilities missing in the Solidity language.
   */
  library Math {
      /**
       * @dev Muldiv operation overflow.
       */
      error MathOverflowedMulDiv();
  
      enum Rounding {
          Floor, // Toward negative infinity
          Ceil, // Toward positive infinity
          Trunc, // Toward zero
          Expand // Away from zero
      }
  
      /**
       * @dev Returns the addition of two unsigned integers, with an overflow flag.
       */
      function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
          unchecked {
              uint256 c = a + b;
              if (c < a) return (false, 0);
              return (true, c);
          }
      }
  
      /**
       * @dev Returns the subtraction of two unsigned integers, with an overflow flag.
       */
      function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
          unchecked {
              if (b > a) return (false, 0);
              return (true, a - b);
          }
      }
  
      /**
       * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
       */
      function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
          unchecked {
              // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
              // benefit is lost if 'b' is also tested.
              // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
              if (a == 0) return (true, 0);
              uint256 c = a * b;
              if (c / a != b) return (false, 0);
              return (true, c);
          }
      }
  
      /**
       * @dev Returns the division of two unsigned integers, with a division by zero flag.
       */
      function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
          unchecked {
              if (b == 0) return (false, 0);
              return (true, a / b);
          }
      }
  
      /**
       * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
       */
      function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
          unchecked {
              if (b == 0) return (false, 0);
              return (true, a % b);
          }
      }
  
      /**
       * @dev Returns the largest of two numbers.
       */
      function max(uint256 a, uint256 b) internal pure returns (uint256) {
          return a > b ? a : b;
      }
  
      /**
       * @dev Returns the smallest of two numbers.
       */
      function min(uint256 a, uint256 b) internal pure returns (uint256) {
          return a < b ? a : b;
      }
  
      /**
       * @dev Returns the average of two numbers. The result is rounded towards
       * zero.
       */
      function average(uint256 a, uint256 b) internal pure returns (uint256) {
          // (a + b) / 2 can overflow.
          return (a & b) + (a ^ b) / 2;
      }
  
      /**
       * @dev Returns the ceiling of the division of two numbers.
       *
       * This differs from standard division with `/` in that it rounds towards infinity instead
       * of rounding towards zero.
       */
      function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
          if (b == 0) {
              // Guarantee the same behavior as in a regular Solidity division.
              return a / b;
          }
  
          // (a + b - 1) / b can overflow on addition, so we distribute.
          return a == 0 ? 0 : (a - 1) / b + 1;
      }
  
      /**
       * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
       * denominator == 0.
       * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
       * Uniswap Labs also under MIT license.
       */
      function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
          unchecked {
              // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
              // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
              // variables such that product = prod1 * 2^256 + prod0.
              uint256 prod0 = x * y; // Least significant 256 bits of the product
              uint256 prod1; // Most significant 256 bits of the product
              assembly {
                  let mm := mulmod(x, y, not(0))
                  prod1 := sub(sub(mm, prod0), lt(mm, prod0))
              }
  
              // Handle non-overflow cases, 256 by 256 division.
              if (prod1 == 0) {
                  // Solidity will revert if denominator == 0, unlike the div opcode on its own.
                  // The surrounding unchecked block does not change this fact.
                  // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
                  return prod0 / denominator;
              }
  
              // Make sure the result is less than 2^256. Also prevents denominator == 0.
              if (denominator <= prod1) {
                  revert MathOverflowedMulDiv();
              }
  
              ///////////////////////////////////////////////
              // 512 by 256 division.
              ///////////////////////////////////////////////
  
              // Make division exact by subtracting the remainder from [prod1 prod0].
              uint256 remainder;
              assembly {
                  // Compute remainder using mulmod.
                  remainder := mulmod(x, y, denominator)
  
                  // Subtract 256 bit number from 512 bit number.
                  prod1 := sub(prod1, gt(remainder, prod0))
                  prod0 := sub(prod0, remainder)
              }
  
              // Factor powers of two out of denominator and compute largest power of two divisor of denominator.
              // Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
  
              uint256 twos = denominator & (0 - denominator);
              assembly {
                  // Divide denominator by twos.
                  denominator := div(denominator, twos)
  
                  // Divide [prod1 prod0] by twos.
                  prod0 := div(prod0, twos)
  
                  // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
                  twos := add(div(sub(0, twos), twos), 1)
              }
  
              // Shift in bits from prod1 into prod0.
              prod0 |= prod1 * twos;
  
              // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
              // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
              // four bits. That is, denominator * inv = 1 mod 2^4.
              uint256 inverse = (3 * denominator) ^ 2;
  
              // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
              // works in modular arithmetic, doubling the correct bits in each step.
              inverse *= 2 - denominator * inverse; // inverse mod 2^8
              inverse *= 2 - denominator * inverse; // inverse mod 2^16
              inverse *= 2 - denominator * inverse; // inverse mod 2^32
              inverse *= 2 - denominator * inverse; // inverse mod 2^64
              inverse *= 2 - denominator * inverse; // inverse mod 2^128
              inverse *= 2 - denominator * inverse; // inverse mod 2^256
  
              // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
              // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
              // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
              // is no longer required.
              result = prod0 * inverse;
              return result;
          }
      }
  
      /**
       * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
       */
      function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
          uint256 result = mulDiv(x, y, denominator);
          if (unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0) {
              result += 1;
          }
          return result;
      }
  
      /**
       * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
       * towards zero.
       *
       * Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
       */
      function sqrt(uint256 a) internal pure returns (uint256) {
          if (a == 0) {
              return 0;
          }
  
          // For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
          //
          // We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
          // `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
          //
          // This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
          // → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
          // → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
          //
          // Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
          uint256 result = 1 << (log2(a) >> 1);
  
          // At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
          // since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
          // every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
          // into the expected uint128 result.
          unchecked {
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              result = (result + a / result) >> 1;
              return min(result, a / result);
          }
      }
  
      /**
       * @notice Calculates sqrt(a), following the selected rounding direction.
       */
      function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
          unchecked {
              uint256 result = sqrt(a);
              return result + (unsignedRoundsUp(rounding) && result * result < a ? 1 : 0);
          }
      }
  
      /**
       * @dev Return the log in base 2 of a positive value rounded towards zero.
       * Returns 0 if given 0.
       */
      function log2(uint256 value) internal pure returns (uint256) {
          uint256 result = 0;
          unchecked {
              if (value >> 128 > 0) {
                  value >>= 128;
                  result += 128;
              }
              if (value >> 64 > 0) {
                  value >>= 64;
                  result += 64;
              }
              if (value >> 32 > 0) {
                  value >>= 32;
                  result += 32;
              }
              if (value >> 16 > 0) {
                  value >>= 16;
                  result += 16;
              }
              if (value >> 8 > 0) {
                  value >>= 8;
                  result += 8;
              }
              if (value >> 4 > 0) {
                  value >>= 4;
                  result += 4;
              }
              if (value >> 2 > 0) {
                  value >>= 2;
                  result += 2;
              }
              if (value >> 1 > 0) {
                  result += 1;
              }
          }
          return result;
      }
  
      /**
       * @dev Return the log in base 2, following the selected rounding direction, of a positive value.
       * Returns 0 if given 0.
       */
      function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
          unchecked {
              uint256 result = log2(value);
              return result + (unsignedRoundsUp(rounding) && 1 << result < value ? 1 : 0);
          }
      }
  
      /**
       * @dev Return the log in base 10 of a positive value rounded towards zero.
       * Returns 0 if given 0.
       */
      function log10(uint256 value) internal pure returns (uint256) {
          uint256 result = 0;
          unchecked {
              if (value >= 10 ** 64) {
                  value /= 10 ** 64;
                  result += 64;
              }
              if (value >= 10 ** 32) {
                  value /= 10 ** 32;
                  result += 32;
              }
              if (value >= 10 ** 16) {
                  value /= 10 ** 16;
                  result += 16;
              }
              if (value >= 10 ** 8) {
                  value /= 10 ** 8;
                  result += 8;
              }
              if (value >= 10 ** 4) {
                  value /= 10 ** 4;
                  result += 4;
              }
              if (value >= 10 ** 2) {
                  value /= 10 ** 2;
                  result += 2;
              }
              if (value >= 10 ** 1) {
                  result += 1;
              }
          }
          return result;
      }
  
      /**
       * @dev Return the log in base 10, following the selected rounding direction, of a positive value.
       * Returns 0 if given 0.
       */
      function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
          unchecked {
              uint256 result = log10(value);
              return result + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
          }
      }
  
      /**
       * @dev Return the log in base 256 of a positive value rounded towards zero.
       * Returns 0 if given 0.
       *
       * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
       */
      function log256(uint256 value) internal pure returns (uint256) {
          uint256 result = 0;
          unchecked {
              if (value >> 128 > 0) {
                  value >>= 128;
                  result += 16;
              }
              if (value >> 64 > 0) {
                  value >>= 64;
                  result += 8;
              }
              if (value >> 32 > 0) {
                  value >>= 32;
                  result += 4;
              }
              if (value >> 16 > 0) {
                  value >>= 16;
                  result += 2;
              }
              if (value >> 8 > 0) {
                  result += 1;
              }
          }
          return result;
      }
  
      /**
       * @dev Return the log in base 256, following the selected rounding direction, of a positive value.
       * Returns 0 if given 0.
       */
      function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
          unchecked {
              uint256 result = log256(value);
              return result + (unsignedRoundsUp(rounding) && 1 << (result << 3) < value ? 1 : 0);
          }
      }
  
      /**
       * @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
       */
      function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
          return uint8(rounding) % 2 == 1;
      }
  }
  
  // lib/openzeppelin-contracts/contracts/utils/math/SafeCast.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/math/SafeCast.sol)
  // This file was procedurally generated from scripts/generate/templates/SafeCast.js.
  
  /**
   * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow
   * checks.
   *
   * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
   * easily result in undesired exploitation or bugs, since developers usually
   * assume that overflows raise errors. `SafeCast` restores this intuition by
   * reverting the transaction when such an operation overflows.
   *
   * Using this library instead of the unchecked operations eliminates an entire
   * class of bugs, so it's recommended to use it always.
   */
  library SafeCast {
      /**
       * @dev Value doesn't fit in an uint of `bits` size.
       */
      error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
  
      /**
       * @dev An int value doesn't fit in an uint of `bits` size.
       */
      error SafeCastOverflowedIntToUint(int256 value);
  
      /**
       * @dev Value doesn't fit in an int of `bits` size.
       */
      error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
  
      /**
       * @dev An uint value doesn't fit in an int of `bits` size.
       */
      error SafeCastOverflowedUintToInt(uint256 value);
  
      /**
       * @dev Returns the downcasted uint248 from uint256, reverting on
       * overflow (when the input is greater than largest uint248).
       *
       * Counterpart to Solidity's `uint248` operator.
       *
       * Requirements:
       *
       * - input must fit into 248 bits
       */
      function toUint248(uint256 value) internal pure returns (uint248) {
          if (value > type(uint248).max) {
              revert SafeCastOverflowedUintDowncast(248, value);
          }
          return uint248(value);
      }
  
      /**
       * @dev Returns the downcasted uint240 from uint256, reverting on
       * overflow (when the input is greater than largest uint240).
       *
       * Counterpart to Solidity's `uint240` operator.
       *
       * Requirements:
       *
       * - input must fit into 240 bits
       */
      function toUint240(uint256 value) internal pure returns (uint240) {
          if (value > type(uint240).max) {
              revert SafeCastOverflowedUintDowncast(240, value);
          }
          return uint240(value);
      }
  
      /**
       * @dev Returns the downcasted uint232 from uint256, reverting on
       * overflow (when the input is greater than largest uint232).
       *
       * Counterpart to Solidity's `uint232` operator.
       *
       * Requirements:
       *
       * - input must fit into 232 bits
       */
      function toUint232(uint256 value) internal pure returns (uint232) {
          if (value > type(uint232).max) {
              revert SafeCastOverflowedUintDowncast(232, value);
          }
          return uint232(value);
      }
  
      /**
       * @dev Returns the downcasted uint224 from uint256, reverting on
       * overflow (when the input is greater than largest uint224).
       *
       * Counterpart to Solidity's `uint224` operator.
       *
       * Requirements:
       *
       * - input must fit into 224 bits
       */
      function toUint224(uint256 value) internal pure returns (uint224) {
          if (value > type(uint224).max) {
              revert SafeCastOverflowedUintDowncast(224, value);
          }
          return uint224(value);
      }
  
      /**
       * @dev Returns the downcasted uint216 from uint256, reverting on
       * overflow (when the input is greater than largest uint216).
       *
       * Counterpart to Solidity's `uint216` operator.
       *
       * Requirements:
       *
       * - input must fit into 216 bits
       */
      function toUint216(uint256 value) internal pure returns (uint216) {
          if (value > type(uint216).max) {
              revert SafeCastOverflowedUintDowncast(216, value);
          }
          return uint216(value);
      }
  
      /**
       * @dev Returns the downcasted uint208 from uint256, reverting on
       * overflow (when the input is greater than largest uint208).
       *
       * Counterpart to Solidity's `uint208` operator.
       *
       * Requirements:
       *
       * - input must fit into 208 bits
       */
      function toUint208(uint256 value) internal pure returns (uint208) {
          if (value > type(uint208).max) {
              revert SafeCastOverflowedUintDowncast(208, value);
          }
          return uint208(value);
      }
  
      /**
       * @dev Returns the downcasted uint200 from uint256, reverting on
       * overflow (when the input is greater than largest uint200).
       *
       * Counterpart to Solidity's `uint200` operator.
       *
       * Requirements:
       *
       * - input must fit into 200 bits
       */
      function toUint200(uint256 value) internal pure returns (uint200) {
          if (value > type(uint200).max) {
              revert SafeCastOverflowedUintDowncast(200, value);
          }
          return uint200(value);
      }
  
      /**
       * @dev Returns the downcasted uint192 from uint256, reverting on
       * overflow (when the input is greater than largest uint192).
       *
       * Counterpart to Solidity's `uint192` operator.
       *
       * Requirements:
       *
       * - input must fit into 192 bits
       */
      function toUint192(uint256 value) internal pure returns (uint192) {
          if (value > type(uint192).max) {
              revert SafeCastOverflowedUintDowncast(192, value);
          }
          return uint192(value);
      }
  
      /**
       * @dev Returns the downcasted uint184 from uint256, reverting on
       * overflow (when the input is greater than largest uint184).
       *
       * Counterpart to Solidity's `uint184` operator.
       *
       * Requirements:
       *
       * - input must fit into 184 bits
       */
      function toUint184(uint256 value) internal pure returns (uint184) {
          if (value > type(uint184).max) {
              revert SafeCastOverflowedUintDowncast(184, value);
          }
          return uint184(value);
      }
  
      /**
       * @dev Returns the downcasted uint176 from uint256, reverting on
       * overflow (when the input is greater than largest uint176).
       *
       * Counterpart to Solidity's `uint176` operator.
       *
       * Requirements:
       *
       * - input must fit into 176 bits
       */
      function toUint176(uint256 value) internal pure returns (uint176) {
          if (value > type(uint176).max) {
              revert SafeCastOverflowedUintDowncast(176, value);
          }
          return uint176(value);
      }
  
      /**
       * @dev Returns the downcasted uint168 from uint256, reverting on
       * overflow (when the input is greater than largest uint168).
       *
       * Counterpart to Solidity's `uint168` operator.
       *
       * Requirements:
       *
       * - input must fit into 168 bits
       */
      function toUint168(uint256 value) internal pure returns (uint168) {
          if (value > type(uint168).max) {
              revert SafeCastOverflowedUintDowncast(168, value);
          }
          return uint168(value);
      }
  
      /**
       * @dev Returns the downcasted uint160 from uint256, reverting on
       * overflow (when the input is greater than largest uint160).
       *
       * Counterpart to Solidity's `uint160` operator.
       *
       * Requirements:
       *
       * - input must fit into 160 bits
       */
      function toUint160(uint256 value) internal pure returns (uint160) {
          if (value > type(uint160).max) {
              revert SafeCastOverflowedUintDowncast(160, value);
          }
          return uint160(value);
      }
  
      /**
       * @dev Returns the downcasted uint152 from uint256, reverting on
       * overflow (when the input is greater than largest uint152).
       *
       * Counterpart to Solidity's `uint152` operator.
       *
       * Requirements:
       *
       * - input must fit into 152 bits
       */
      function toUint152(uint256 value) internal pure returns (uint152) {
          if (value > type(uint152).max) {
              revert SafeCastOverflowedUintDowncast(152, value);
          }
          return uint152(value);
      }
  
      /**
       * @dev Returns the downcasted uint144 from uint256, reverting on
       * overflow (when the input is greater than largest uint144).
       *
       * Counterpart to Solidity's `uint144` operator.
       *
       * Requirements:
       *
       * - input must fit into 144 bits
       */
      function toUint144(uint256 value) internal pure returns (uint144) {
          if (value > type(uint144).max) {
              revert SafeCastOverflowedUintDowncast(144, value);
          }
          return uint144(value);
      }
  
      /**
       * @dev Returns the downcasted uint136 from uint256, reverting on
       * overflow (when the input is greater than largest uint136).
       *
       * Counterpart to Solidity's `uint136` operator.
       *
       * Requirements:
       *
       * - input must fit into 136 bits
       */
      function toUint136(uint256 value) internal pure returns (uint136) {
          if (value > type(uint136).max) {
              revert SafeCastOverflowedUintDowncast(136, value);
          }
          return uint136(value);
      }
  
      /**
       * @dev Returns the downcasted uint128 from uint256, reverting on
       * overflow (when the input is greater than largest uint128).
       *
       * Counterpart to Solidity's `uint128` operator.
       *
       * Requirements:
       *
       * - input must fit into 128 bits
       */
      function toUint128(uint256 value) internal pure returns (uint128) {
          if (value > type(uint128).max) {
              revert SafeCastOverflowedUintDowncast(128, value);
          }
          return uint128(value);
      }
  
      /**
       * @dev Returns the downcasted uint120 from uint256, reverting on
       * overflow (when the input is greater than largest uint120).
       *
       * Counterpart to Solidity's `uint120` operator.
       *
       * Requirements:
       *
       * - input must fit into 120 bits
       */
      function toUint120(uint256 value) internal pure returns (uint120) {
          if (value > type(uint120).max) {
              revert SafeCastOverflowedUintDowncast(120, value);
          }
          return uint120(value);
      }
  
      /**
       * @dev Returns the downcasted uint112 from uint256, reverting on
       * overflow (when the input is greater than largest uint112).
       *
       * Counterpart to Solidity's `uint112` operator.
       *
       * Requirements:
       *
       * - input must fit into 112 bits
       */
      function toUint112(uint256 value) internal pure returns (uint112) {
          if (value > type(uint112).max) {
              revert SafeCastOverflowedUintDowncast(112, value);
          }
          return uint112(value);
      }
  
      /**
       * @dev Returns the downcasted uint104 from uint256, reverting on
       * overflow (when the input is greater than largest uint104).
       *
       * Counterpart to Solidity's `uint104` operator.
       *
       * Requirements:
       *
       * - input must fit into 104 bits
       */
      function toUint104(uint256 value) internal pure returns (uint104) {
          if (value > type(uint104).max) {
              revert SafeCastOverflowedUintDowncast(104, value);
          }
          return uint104(value);
      }
  
      /**
       * @dev Returns the downcasted uint96 from uint256, reverting on
       * overflow (when the input is greater than largest uint96).
       *
       * Counterpart to Solidity's `uint96` operator.
       *
       * Requirements:
       *
       * - input must fit into 96 bits
       */
      function toUint96(uint256 value) internal pure returns (uint96) {
          if (value > type(uint96).max) {
              revert SafeCastOverflowedUintDowncast(96, value);
          }
          return uint96(value);
      }
  
      /**
       * @dev Returns the downcasted uint88 from uint256, reverting on
       * overflow (when the input is greater than largest uint88).
       *
       * Counterpart to Solidity's `uint88` operator.
       *
       * Requirements:
       *
       * - input must fit into 88 bits
       */
      function toUint88(uint256 value) internal pure returns (uint88) {
          if (value > type(uint88).max) {
              revert SafeCastOverflowedUintDowncast(88, value);
          }
          return uint88(value);
      }
  
      /**
       * @dev Returns the downcasted uint80 from uint256, reverting on
       * overflow (when the input is greater than largest uint80).
       *
       * Counterpart to Solidity's `uint80` operator.
       *
       * Requirements:
       *
       * - input must fit into 80 bits
       */
      function toUint80(uint256 value) internal pure returns (uint80) {
          if (value > type(uint80).max) {
              revert SafeCastOverflowedUintDowncast(80, value);
          }
          return uint80(value);
      }
  
      /**
       * @dev Returns the downcasted uint72 from uint256, reverting on
       * overflow (when the input is greater than largest uint72).
       *
       * Counterpart to Solidity's `uint72` operator.
       *
       * Requirements:
       *
       * - input must fit into 72 bits
       */
      function toUint72(uint256 value) internal pure returns (uint72) {
          if (value > type(uint72).max) {
              revert SafeCastOverflowedUintDowncast(72, value);
          }
          return uint72(value);
      }
  
      /**
       * @dev Returns the downcasted uint64 from uint256, reverting on
       * overflow (when the input is greater than largest uint64).
       *
       * Counterpart to Solidity's `uint64` operator.
       *
       * Requirements:
       *
       * - input must fit into 64 bits
       */
      function toUint64(uint256 value) internal pure returns (uint64) {
          if (value > type(uint64).max) {
              revert SafeCastOverflowedUintDowncast(64, value);
          }
          return uint64(value);
      }
  
      /**
       * @dev Returns the downcasted uint56 from uint256, reverting on
       * overflow (when the input is greater than largest uint56).
       *
       * Counterpart to Solidity's `uint56` operator.
       *
       * Requirements:
       *
       * - input must fit into 56 bits
       */
      function toUint56(uint256 value) internal pure returns (uint56) {
          if (value > type(uint56).max) {
              revert SafeCastOverflowedUintDowncast(56, value);
          }
          return uint56(value);
      }
  
      /**
       * @dev Returns the downcasted uint48 from uint256, reverting on
       * overflow (when the input is greater than largest uint48).
       *
       * Counterpart to Solidity's `uint48` operator.
       *
       * Requirements:
       *
       * - input must fit into 48 bits
       */
      function toUint48(uint256 value) internal pure returns (uint48) {
          if (value > type(uint48).max) {
              revert SafeCastOverflowedUintDowncast(48, value);
          }
          return uint48(value);
      }
  
      /**
       * @dev Returns the downcasted uint40 from uint256, reverting on
       * overflow (when the input is greater than largest uint40).
       *
       * Counterpart to Solidity's `uint40` operator.
       *
       * Requirements:
       *
       * - input must fit into 40 bits
       */
      function toUint40(uint256 value) internal pure returns (uint40) {
          if (value > type(uint40).max) {
              revert SafeCastOverflowedUintDowncast(40, value);
          }
          return uint40(value);
      }
  
      /**
       * @dev Returns the downcasted uint32 from uint256, reverting on
       * overflow (when the input is greater than largest uint32).
       *
       * Counterpart to Solidity's `uint32` operator.
       *
       * Requirements:
       *
       * - input must fit into 32 bits
       */
      function toUint32(uint256 value) internal pure returns (uint32) {
          if (value > type(uint32).max) {
              revert SafeCastOverflowedUintDowncast(32, value);
          }
          return uint32(value);
      }
  
      /**
       * @dev Returns the downcasted uint24 from uint256, reverting on
       * overflow (when the input is greater than largest uint24).
       *
       * Counterpart to Solidity's `uint24` operator.
       *
       * Requirements:
       *
       * - input must fit into 24 bits
       */
      function toUint24(uint256 value) internal pure returns (uint24) {
          if (value > type(uint24).max) {
              revert SafeCastOverflowedUintDowncast(24, value);
          }
          return uint24(value);
      }
  
      /**
       * @dev Returns the downcasted uint16 from uint256, reverting on
       * overflow (when the input is greater than largest uint16).
       *
       * Counterpart to Solidity's `uint16` operator.
       *
       * Requirements:
       *
       * - input must fit into 16 bits
       */
      function toUint16(uint256 value) internal pure returns (uint16) {
          if (value > type(uint16).max) {
              revert SafeCastOverflowedUintDowncast(16, value);
          }
          return uint16(value);
      }
  
      /**
       * @dev Returns the downcasted uint8 from uint256, reverting on
       * overflow (when the input is greater than largest uint8).
       *
       * Counterpart to Solidity's `uint8` operator.
       *
       * Requirements:
       *
       * - input must fit into 8 bits
       */
      function toUint8(uint256 value) internal pure returns (uint8) {
          if (value > type(uint8).max) {
              revert SafeCastOverflowedUintDowncast(8, value);
          }
          return uint8(value);
      }
  
      /**
       * @dev Converts a signed int256 into an unsigned uint256.
       *
       * Requirements:
       *
       * - input must be greater than or equal to 0.
       */
      function toUint256(int256 value) internal pure returns (uint256) {
          if (value < 0) {
              revert SafeCastOverflowedIntToUint(value);
          }
          return uint256(value);
      }
  
      /**
       * @dev Returns the downcasted int248 from int256, reverting on
       * overflow (when the input is less than smallest int248 or
       * greater than largest int248).
       *
       * Counterpart to Solidity's `int248` operator.
       *
       * Requirements:
       *
       * - input must fit into 248 bits
       */
      function toInt248(int256 value) internal pure returns (int248 downcasted) {
          downcasted = int248(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(248, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int240 from int256, reverting on
       * overflow (when the input is less than smallest int240 or
       * greater than largest int240).
       *
       * Counterpart to Solidity's `int240` operator.
       *
       * Requirements:
       *
       * - input must fit into 240 bits
       */
      function toInt240(int256 value) internal pure returns (int240 downcasted) {
          downcasted = int240(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(240, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int232 from int256, reverting on
       * overflow (when the input is less than smallest int232 or
       * greater than largest int232).
       *
       * Counterpart to Solidity's `int232` operator.
       *
       * Requirements:
       *
       * - input must fit into 232 bits
       */
      function toInt232(int256 value) internal pure returns (int232 downcasted) {
          downcasted = int232(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(232, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int224 from int256, reverting on
       * overflow (when the input is less than smallest int224 or
       * greater than largest int224).
       *
       * Counterpart to Solidity's `int224` operator.
       *
       * Requirements:
       *
       * - input must fit into 224 bits
       */
      function toInt224(int256 value) internal pure returns (int224 downcasted) {
          downcasted = int224(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(224, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int216 from int256, reverting on
       * overflow (when the input is less than smallest int216 or
       * greater than largest int216).
       *
       * Counterpart to Solidity's `int216` operator.
       *
       * Requirements:
       *
       * - input must fit into 216 bits
       */
      function toInt216(int256 value) internal pure returns (int216 downcasted) {
          downcasted = int216(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(216, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int208 from int256, reverting on
       * overflow (when the input is less than smallest int208 or
       * greater than largest int208).
       *
       * Counterpart to Solidity's `int208` operator.
       *
       * Requirements:
       *
       * - input must fit into 208 bits
       */
      function toInt208(int256 value) internal pure returns (int208 downcasted) {
          downcasted = int208(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(208, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int200 from int256, reverting on
       * overflow (when the input is less than smallest int200 or
       * greater than largest int200).
       *
       * Counterpart to Solidity's `int200` operator.
       *
       * Requirements:
       *
       * - input must fit into 200 bits
       */
      function toInt200(int256 value) internal pure returns (int200 downcasted) {
          downcasted = int200(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(200, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int192 from int256, reverting on
       * overflow (when the input is less than smallest int192 or
       * greater than largest int192).
       *
       * Counterpart to Solidity's `int192` operator.
       *
       * Requirements:
       *
       * - input must fit into 192 bits
       */
      function toInt192(int256 value) internal pure returns (int192 downcasted) {
          downcasted = int192(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(192, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int184 from int256, reverting on
       * overflow (when the input is less than smallest int184 or
       * greater than largest int184).
       *
       * Counterpart to Solidity's `int184` operator.
       *
       * Requirements:
       *
       * - input must fit into 184 bits
       */
      function toInt184(int256 value) internal pure returns (int184 downcasted) {
          downcasted = int184(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(184, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int176 from int256, reverting on
       * overflow (when the input is less than smallest int176 or
       * greater than largest int176).
       *
       * Counterpart to Solidity's `int176` operator.
       *
       * Requirements:
       *
       * - input must fit into 176 bits
       */
      function toInt176(int256 value) internal pure returns (int176 downcasted) {
          downcasted = int176(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(176, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int168 from int256, reverting on
       * overflow (when the input is less than smallest int168 or
       * greater than largest int168).
       *
       * Counterpart to Solidity's `int168` operator.
       *
       * Requirements:
       *
       * - input must fit into 168 bits
       */
      function toInt168(int256 value) internal pure returns (int168 downcasted) {
          downcasted = int168(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(168, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int160 from int256, reverting on
       * overflow (when the input is less than smallest int160 or
       * greater than largest int160).
       *
       * Counterpart to Solidity's `int160` operator.
       *
       * Requirements:
       *
       * - input must fit into 160 bits
       */
      function toInt160(int256 value) internal pure returns (int160 downcasted) {
          downcasted = int160(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(160, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int152 from int256, reverting on
       * overflow (when the input is less than smallest int152 or
       * greater than largest int152).
       *
       * Counterpart to Solidity's `int152` operator.
       *
       * Requirements:
       *
       * - input must fit into 152 bits
       */
      function toInt152(int256 value) internal pure returns (int152 downcasted) {
          downcasted = int152(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(152, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int144 from int256, reverting on
       * overflow (when the input is less than smallest int144 or
       * greater than largest int144).
       *
       * Counterpart to Solidity's `int144` operator.
       *
       * Requirements:
       *
       * - input must fit into 144 bits
       */
      function toInt144(int256 value) internal pure returns (int144 downcasted) {
          downcasted = int144(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(144, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int136 from int256, reverting on
       * overflow (when the input is less than smallest int136 or
       * greater than largest int136).
       *
       * Counterpart to Solidity's `int136` operator.
       *
       * Requirements:
       *
       * - input must fit into 136 bits
       */
      function toInt136(int256 value) internal pure returns (int136 downcasted) {
          downcasted = int136(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(136, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int128 from int256, reverting on
       * overflow (when the input is less than smallest int128 or
       * greater than largest int128).
       *
       * Counterpart to Solidity's `int128` operator.
       *
       * Requirements:
       *
       * - input must fit into 128 bits
       */
      function toInt128(int256 value) internal pure returns (int128 downcasted) {
          downcasted = int128(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(128, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int120 from int256, reverting on
       * overflow (when the input is less than smallest int120 or
       * greater than largest int120).
       *
       * Counterpart to Solidity's `int120` operator.
       *
       * Requirements:
       *
       * - input must fit into 120 bits
       */
      function toInt120(int256 value) internal pure returns (int120 downcasted) {
          downcasted = int120(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(120, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int112 from int256, reverting on
       * overflow (when the input is less than smallest int112 or
       * greater than largest int112).
       *
       * Counterpart to Solidity's `int112` operator.
       *
       * Requirements:
       *
       * - input must fit into 112 bits
       */
      function toInt112(int256 value) internal pure returns (int112 downcasted) {
          downcasted = int112(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(112, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int104 from int256, reverting on
       * overflow (when the input is less than smallest int104 or
       * greater than largest int104).
       *
       * Counterpart to Solidity's `int104` operator.
       *
       * Requirements:
       *
       * - input must fit into 104 bits
       */
      function toInt104(int256 value) internal pure returns (int104 downcasted) {
          downcasted = int104(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(104, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int96 from int256, reverting on
       * overflow (when the input is less than smallest int96 or
       * greater than largest int96).
       *
       * Counterpart to Solidity's `int96` operator.
       *
       * Requirements:
       *
       * - input must fit into 96 bits
       */
      function toInt96(int256 value) internal pure returns (int96 downcasted) {
          downcasted = int96(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(96, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int88 from int256, reverting on
       * overflow (when the input is less than smallest int88 or
       * greater than largest int88).
       *
       * Counterpart to Solidity's `int88` operator.
       *
       * Requirements:
       *
       * - input must fit into 88 bits
       */
      function toInt88(int256 value) internal pure returns (int88 downcasted) {
          downcasted = int88(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(88, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int80 from int256, reverting on
       * overflow (when the input is less than smallest int80 or
       * greater than largest int80).
       *
       * Counterpart to Solidity's `int80` operator.
       *
       * Requirements:
       *
       * - input must fit into 80 bits
       */
      function toInt80(int256 value) internal pure returns (int80 downcasted) {
          downcasted = int80(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(80, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int72 from int256, reverting on
       * overflow (when the input is less than smallest int72 or
       * greater than largest int72).
       *
       * Counterpart to Solidity's `int72` operator.
       *
       * Requirements:
       *
       * - input must fit into 72 bits
       */
      function toInt72(int256 value) internal pure returns (int72 downcasted) {
          downcasted = int72(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(72, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int64 from int256, reverting on
       * overflow (when the input is less than smallest int64 or
       * greater than largest int64).
       *
       * Counterpart to Solidity's `int64` operator.
       *
       * Requirements:
       *
       * - input must fit into 64 bits
       */
      function toInt64(int256 value) internal pure returns (int64 downcasted) {
          downcasted = int64(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(64, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int56 from int256, reverting on
       * overflow (when the input is less than smallest int56 or
       * greater than largest int56).
       *
       * Counterpart to Solidity's `int56` operator.
       *
       * Requirements:
       *
       * - input must fit into 56 bits
       */
      function toInt56(int256 value) internal pure returns (int56 downcasted) {
          downcasted = int56(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(56, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int48 from int256, reverting on
       * overflow (when the input is less than smallest int48 or
       * greater than largest int48).
       *
       * Counterpart to Solidity's `int48` operator.
       *
       * Requirements:
       *
       * - input must fit into 48 bits
       */
      function toInt48(int256 value) internal pure returns (int48 downcasted) {
          downcasted = int48(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(48, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int40 from int256, reverting on
       * overflow (when the input is less than smallest int40 or
       * greater than largest int40).
       *
       * Counterpart to Solidity's `int40` operator.
       *
       * Requirements:
       *
       * - input must fit into 40 bits
       */
      function toInt40(int256 value) internal pure returns (int40 downcasted) {
          downcasted = int40(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(40, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int32 from int256, reverting on
       * overflow (when the input is less than smallest int32 or
       * greater than largest int32).
       *
       * Counterpart to Solidity's `int32` operator.
       *
       * Requirements:
       *
       * - input must fit into 32 bits
       */
      function toInt32(int256 value) internal pure returns (int32 downcasted) {
          downcasted = int32(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(32, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int24 from int256, reverting on
       * overflow (when the input is less than smallest int24 or
       * greater than largest int24).
       *
       * Counterpart to Solidity's `int24` operator.
       *
       * Requirements:
       *
       * - input must fit into 24 bits
       */
      function toInt24(int256 value) internal pure returns (int24 downcasted) {
          downcasted = int24(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(24, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int16 from int256, reverting on
       * overflow (when the input is less than smallest int16 or
       * greater than largest int16).
       *
       * Counterpart to Solidity's `int16` operator.
       *
       * Requirements:
       *
       * - input must fit into 16 bits
       */
      function toInt16(int256 value) internal pure returns (int16 downcasted) {
          downcasted = int16(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(16, value);
          }
      }
  
      /**
       * @dev Returns the downcasted int8 from int256, reverting on
       * overflow (when the input is less than smallest int8 or
       * greater than largest int8).
       *
       * Counterpart to Solidity's `int8` operator.
       *
       * Requirements:
       *
       * - input must fit into 8 bits
       */
      function toInt8(int256 value) internal pure returns (int8 downcasted) {
          downcasted = int8(value);
          if (downcasted != value) {
              revert SafeCastOverflowedIntDowncast(8, value);
          }
      }
  
      /**
       * @dev Converts an unsigned uint256 into a signed int256.
       *
       * Requirements:
       *
       * - input must be less than or equal to maxInt256.
       */
      function toInt256(uint256 value) internal pure returns (int256) {
          // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
          if (value > uint256(type(int256).max)) {
              revert SafeCastOverflowedUintToInt(value);
          }
          return int256(value);
      }
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
  
  /**
   * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
   * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
   * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
   * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
   *
   * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
   * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
   * case an upgrade adds a module that needs to be initialized.
   *
   * For example:
   *
   * [.hljs-theme-light.nopadding]
   * ```solidity
   * contract MyToken is ERC20Upgradeable {
   *     function initialize() initializer public {
   *         __ERC20_init("MyToken", "MTK");
   *     }
   * }
   *
   * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
   *     function initializeV2() reinitializer(2) public {
   *         __ERC20Permit_init("MyToken");
   *     }
   * }
   * ```
   *
   * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
   * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
   *
   * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
   * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
   *
   * [CAUTION]
   * ====
   * Avoid leaving a contract uninitialized.
   *
   * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
   * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
   * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
   *
   * [.hljs-theme-light.nopadding]
   * ```
   * /// @custom:oz-upgrades-unsafe-allow constructor
   * constructor() {
   *     _disableInitializers();
   * }
   * ```
   * ====
   */
  abstract contract Initializable {
      /**
       * @dev Storage of the initializable contract.
       *
       * It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
       * when using with upgradeable contracts.
       *
       * @custom:storage-location erc7201:openzeppelin.storage.Initializable
       */
      struct InitializableStorage {
          /**
           * @dev Indicates that the contract has been initialized.
           */
          uint64 _initialized;
          /**
           * @dev Indicates that the contract is in the process of being initialized.
           */
          bool _initializing;
      }
  
      // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
  
      /**
       * @dev The contract is already initialized.
       */
      error InvalidInitialization();
  
      /**
       * @dev The contract is not initializing.
       */
      error NotInitializing();
  
      /**
       * @dev Triggered when the contract has been initialized or reinitialized.
       */
      event Initialized(uint64 version);
  
      /**
       * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
       * `onlyInitializing` functions can be used to initialize parent contracts.
       *
       * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
       * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
       * production.
       *
       * Emits an {Initialized} event.
       */
      modifier initializer() {
          // solhint-disable-next-line var-name-mixedcase
          InitializableStorage storage $ = _getInitializableStorage();
  
          // Cache values to avoid duplicated sloads
          bool isTopLevelCall = !$._initializing;
          uint64 initialized = $._initialized;
  
          // Allowed calls:
          // - initialSetup: the contract is not in the initializing state and no previous version was
          //                 initialized
          // - construction: the contract is initialized at version 1 (no reininitialization) and the
          //                 current contract is just being deployed
          bool initialSetup = initialized == 0 && isTopLevelCall;
          bool construction = initialized == 1 && address(this).code.length == 0;
  
          if (!initialSetup && !construction) {
              revert InvalidInitialization();
          }
          $._initialized = 1;
          if (isTopLevelCall) {
              $._initializing = true;
          }
          _;
          if (isTopLevelCall) {
              $._initializing = false;
              emit Initialized(1);
          }
      }
  
      /**
       * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
       * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
       * used to initialize parent contracts.
       *
       * A reinitializer may be used after the original initialization step. This is essential to configure modules that
       * are added through upgrades and that require initialization.
       *
       * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
       * cannot be nested. If one is invoked in the context of another, execution will revert.
       *
       * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
       * a contract, executing them in the right order is up to the developer or operator.
       *
       * WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
       *
       * Emits an {Initialized} event.
       */
      modifier reinitializer(uint64 version) {
          // solhint-disable-next-line var-name-mixedcase
          InitializableStorage storage $ = _getInitializableStorage();
  
          if ($._initializing || $._initialized >= version) {
              revert InvalidInitialization();
          }
          $._initialized = version;
          $._initializing = true;
          _;
          $._initializing = false;
          emit Initialized(version);
      }
  
      /**
       * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
       * {initializer} and {reinitializer} modifiers, directly or indirectly.
       */
      modifier onlyInitializing() {
          _checkInitializing();
          _;
      }
  
      /**
       * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
       */
      function _checkInitializing() internal view virtual {
          if (!_isInitializing()) {
              revert NotInitializing();
          }
      }
  
      /**
       * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
       * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
       * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
       * through proxies.
       *
       * Emits an {Initialized} event the first time it is successfully executed.
       */
      function _disableInitializers() internal virtual {
          // solhint-disable-next-line var-name-mixedcase
          InitializableStorage storage $ = _getInitializableStorage();
  
          if ($._initializing) {
              revert InvalidInitialization();
          }
          if ($._initialized != type(uint64).max) {
              $._initialized = type(uint64).max;
              emit Initialized(type(uint64).max);
          }
      }
  
      /**
       * @dev Returns the highest version that has been initialized. See {reinitializer}.
       */
      function _getInitializedVersion() internal view returns (uint64) {
          return _getInitializableStorage()._initialized;
      }
  
      /**
       * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
       */
      function _isInitializing() internal view returns (bool) {
          return _getInitializableStorage()._initializing;
      }
  
      /**
       * @dev Returns a pointer to the storage namespace.
       */
      // solhint-disable-next-line var-name-mixedcase
      function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
          assembly {
              $.slot := INITIALIZABLE_STORAGE
          }
      }
  }
  
  // lib/zkevm-stb/src/interfaces/IPolygonZkEVMBridge.sol
  
  interface IPolygonZkEVMBridge {
      /**
       * @dev Thrown when sender is not the PolygonZkEVM address
       */
      error OnlyPolygonZkEVM();
  
      /**
       * @dev Thrown when the destination network is invalid
       */
      error DestinationNetworkInvalid();
  
      /**
       * @dev Thrown when the amount does not match msg.value
       */
      error AmountDoesNotMatchMsgValue();
  
      /**
       * @dev Thrown when user is bridging tokens and is also sending a value
       */
      error MsgValueNotZero();
  
      /**
       * @dev Thrown when the Ether transfer on claimAsset fails
       */
      error EtherTransferFailed();
  
      /**
       * @dev Thrown when the message transaction on claimMessage fails
       */
      error MessageFailed();
  
      /**
       * @dev Thrown when the global exit root does not exist
       */
      error GlobalExitRootInvalid();
  
      /**
       * @dev Thrown when the smt proof does not match
       */
      error InvalidSmtProof();
  
      /**
       * @dev Thrown when an index is already claimed
       */
      error AlreadyClaimed();
  
      /**
       * @dev Thrown when the owner of permit does not match the sender
       */
      error NotValidOwner();
  
      /**
       * @dev Thrown when the spender of the permit does not match this contract address
       */
      error NotValidSpender();
  
      /**
       * @dev Thrown when the amount of the permit does not match
       */
      error NotValidAmount();
  
      /**
       * @dev Thrown when the permit data contains an invalid signature
       */
      error NotValidSignature();
  
      function bridgeAsset(uint32 destinationNetwork, address destinationAddress, uint256 amount, address token, bool forceUpdateGlobalExitRoot, bytes calldata permitData) external payable;
  
      function bridgeMessage(uint32 destinationNetwork, address destinationAddress, bool forceUpdateGlobalExitRoot, bytes calldata metadata) external payable;
  
      function claimAsset(
          bytes32[32] calldata smtProof,
          uint32 index,
          bytes32 mainnetExitRoot,
          bytes32 rollupExitRoot,
          uint32 originNetwork,
          address originTokenAddress,
          uint32 destinationNetwork,
          address destinationAddress,
          uint256 amount,
          bytes calldata metadata
      ) external;
  
      function claimMessage(
          bytes32[32] calldata smtProof,
          uint32 index,
          bytes32 mainnetExitRoot,
          bytes32 rollupExitRoot,
          uint32 originNetwork,
          address originAddress,
          uint32 destinationNetwork,
          address destinationAddress,
          uint256 amount,
          bytes calldata metadata
      ) external;
  
      function updateGlobalExitRoot() external;
  
      function activateEmergencyState() external;
  
      function deactivateEmergencyState() external;
  
      function networkID() external returns (uint32);
  }
  
  // lib/openzeppelin-contracts/contracts/access/extensions/IAccessControlDefaultAdminRules.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (access/extensions/IAccessControlDefaultAdminRules.sol)
  
  /**
   * @dev External interface of AccessControlDefaultAdminRules declared to support ERC165 detection.
   */
  interface IAccessControlDefaultAdminRules is IAccessControl {
      /**
       * @dev The new default admin is not a valid default admin.
       */
      error AccessControlInvalidDefaultAdmin(address defaultAdmin);
  
      /**
       * @dev At least one of the following rules was violated:
       *
       * - The `DEFAULT_ADMIN_ROLE` must only be managed by itself.
       * - The `DEFAULT_ADMIN_ROLE` must only be held by one account at the time.
       * - Any `DEFAULT_ADMIN_ROLE` transfer must be in two delayed steps.
       */
      error AccessControlEnforcedDefaultAdminRules();
  
      /**
       * @dev The delay for transferring the default admin delay is enforced and
       * the operation must wait until `schedule`.
       *
       * NOTE: `schedule` can be 0 indicating there's no transfer scheduled.
       */
      error AccessControlEnforcedDefaultAdminDelay(uint48 schedule);
  
      /**
       * @dev Emitted when a {defaultAdmin} transfer is started, setting `newAdmin` as the next
       * address to become the {defaultAdmin} by calling {acceptDefaultAdminTransfer} only after `acceptSchedule`
       * passes.
       */
      event DefaultAdminTransferScheduled(address indexed newAdmin, uint48 acceptSchedule);
  
      /**
       * @dev Emitted when a {pendingDefaultAdmin} is reset if it was never accepted, regardless of its schedule.
       */
      event DefaultAdminTransferCanceled();
  
      /**
       * @dev Emitted when a {defaultAdminDelay} change is started, setting `newDelay` as the next
       * delay to be applied between default admin transfer after `effectSchedule` has passed.
       */
      event DefaultAdminDelayChangeScheduled(uint48 newDelay, uint48 effectSchedule);
  
      /**
       * @dev Emitted when a {pendingDefaultAdminDelay} is reset if its schedule didn't pass.
       */
      event DefaultAdminDelayChangeCanceled();
  
      /**
       * @dev Returns the address of the current `DEFAULT_ADMIN_ROLE` holder.
       */
      function defaultAdmin() external view returns (address);
  
      /**
       * @dev Returns a tuple of a `newAdmin` and an accept schedule.
       *
       * After the `schedule` passes, the `newAdmin` will be able to accept the {defaultAdmin} role
       * by calling {acceptDefaultAdminTransfer}, completing the role transfer.
       *
       * A zero value only in `acceptSchedule` indicates no pending admin transfer.
       *
       * NOTE: A zero address `newAdmin` means that {defaultAdmin} is being renounced.
       */
      function pendingDefaultAdmin() external view returns (address newAdmin, uint48 acceptSchedule);
  
      /**
       * @dev Returns the delay required to schedule the acceptance of a {defaultAdmin} transfer started.
       *
       * This delay will be added to the current timestamp when calling {beginDefaultAdminTransfer} to set
       * the acceptance schedule.
       *
       * NOTE: If a delay change has been scheduled, it will take effect as soon as the schedule passes, making this
       * function returns the new delay. See {changeDefaultAdminDelay}.
       */
      function defaultAdminDelay() external view returns (uint48);
  
      /**
       * @dev Returns a tuple of `newDelay` and an effect schedule.
       *
       * After the `schedule` passes, the `newDelay` will get into effect immediately for every
       * new {defaultAdmin} transfer started with {beginDefaultAdminTransfer}.
       *
       * A zero value only in `effectSchedule` indicates no pending delay change.
       *
       * NOTE: A zero value only for `newDelay` means that the next {defaultAdminDelay}
       * will be zero after the effect schedule.
       */
      function pendingDefaultAdminDelay() external view returns (uint48 newDelay, uint48 effectSchedule);
  
      /**
       * @dev Starts a {defaultAdmin} transfer by setting a {pendingDefaultAdmin} scheduled for acceptance
       * after the current timestamp plus a {defaultAdminDelay}.
       *
       * Requirements:
       *
       * - Only can be called by the current {defaultAdmin}.
       *
       * Emits a DefaultAdminRoleChangeStarted event.
       */
      function beginDefaultAdminTransfer(address newAdmin) external;
  
      /**
       * @dev Cancels a {defaultAdmin} transfer previously started with {beginDefaultAdminTransfer}.
       *
       * A {pendingDefaultAdmin} not yet accepted can also be cancelled with this function.
       *
       * Requirements:
       *
       * - Only can be called by the current {defaultAdmin}.
       *
       * May emit a DefaultAdminTransferCanceled event.
       */
      function cancelDefaultAdminTransfer() external;
  
      /**
       * @dev Completes a {defaultAdmin} transfer previously started with {beginDefaultAdminTransfer}.
       *
       * After calling the function:
       *
       * - `DEFAULT_ADMIN_ROLE` should be granted to the caller.
       * - `DEFAULT_ADMIN_ROLE` should be revoked from the previous holder.
       * - {pendingDefaultAdmin} should be reset to zero values.
       *
       * Requirements:
       *
       * - Only can be called by the {pendingDefaultAdmin}'s `newAdmin`.
       * - The {pendingDefaultAdmin}'s `acceptSchedule` should've passed.
       */
      function acceptDefaultAdminTransfer() external;
  
      /**
       * @dev Initiates a {defaultAdminDelay} update by setting a {pendingDefaultAdminDelay} scheduled for getting
       * into effect after the current timestamp plus a {defaultAdminDelay}.
       *
       * This function guarantees that any call to {beginDefaultAdminTransfer} done between the timestamp this
       * method is called and the {pendingDefaultAdminDelay} effect schedule will use the current {defaultAdminDelay}
       * set before calling.
       *
       * The {pendingDefaultAdminDelay}'s effect schedule is defined in a way that waiting until the schedule and then
       * calling {beginDefaultAdminTransfer} with the new delay will take at least the same as another {defaultAdmin}
       * complete transfer (including acceptance).
       *
       * The schedule is designed for two scenarios:
       *
       * - When the delay is changed for a larger one the schedule is `block.timestamp + newDelay` capped by
       * {defaultAdminDelayIncreaseWait}.
       * - When the delay is changed for a shorter one, the schedule is `block.timestamp + (current delay - new delay)`.
       *
       * A {pendingDefaultAdminDelay} that never got into effect will be canceled in favor of a new scheduled change.
       *
       * Requirements:
       *
       * - Only can be called by the current {defaultAdmin}.
       *
       * Emits a DefaultAdminDelayChangeScheduled event and may emit a DefaultAdminDelayChangeCanceled event.
       */
      function changeDefaultAdminDelay(uint48 newDelay) external;
  
      /**
       * @dev Cancels a scheduled {defaultAdminDelay} change.
       *
       * Requirements:
       *
       * - Only can be called by the current {defaultAdmin}.
       *
       * May emit a DefaultAdminDelayChangeCanceled event.
       */
      function rollbackDefaultAdminDelay() external;
  
      /**
       * @dev Maximum time in seconds for an increase to {defaultAdminDelay} (that is scheduled using {changeDefaultAdminDelay})
       * to take effect. Default to 5 days.
       *
       * When the {defaultAdminDelay} is scheduled to be increased, it goes into effect after the new delay has passed with
       * the purpose of giving enough time for reverting any accidental change (i.e. using milliseconds instead of seconds)
       * that may lock the contract. However, to avoid excessive schedules, the wait is capped by this function and it can
       * be overrode for a custom {defaultAdminDelay} increase scheduling.
       *
       * IMPORTANT: Make sure to add a reasonable amount of time while overriding this value, otherwise,
       * there's a risk of setting a high new delay that goes into effect almost immediately without the
       * possibility of human intervention in the case of an input error (eg. set milliseconds instead of seconds).
       */
      function defaultAdminDelayIncreaseWait() external view returns (uint48);
  }
  
  // lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)
  
  /**
   * @dev Interface for the optional metadata functions from the ERC20 standard.
   */
  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);
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
  
  /**
   * @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 ContextUpgradeable is Initializable {
      function __Context_init() internal onlyInitializing {
      }
  
      function __Context_init_unchained() internal onlyInitializing {
      }
      function _msgSender() internal view virtual returns (address) {
          return msg.sender;
      }
  
      function _msgData() internal view virtual returns (bytes calldata) {
          return msg.data;
      }
  
      function _contextSuffixLength() internal view virtual returns (uint256) {
          return 0;
      }
  }
  
  // lib/openzeppelin-contracts/contracts/interfaces/IERC4626.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC4626.sol)
  
  /**
   * @dev Interface of the ERC4626 "Tokenized Vault Standard", as defined in
   * https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
   */
  interface IERC4626 is IERC20, IERC20Metadata {
      event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
  
      event Withdraw(
          address indexed sender,
          address indexed receiver,
          address indexed owner,
          uint256 assets,
          uint256 shares
      );
  
      /**
       * @dev Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
       *
       * - MUST be an ERC-20 token contract.
       * - MUST NOT revert.
       */
      function asset() external view returns (address assetTokenAddress);
  
      /**
       * @dev Returns the total amount of the underlying asset that is “managed” by Vault.
       *
       * - SHOULD include any compounding that occurs from yield.
       * - MUST be inclusive of any fees that are charged against assets in the Vault.
       * - MUST NOT revert.
       */
      function totalAssets() external view returns (uint256 totalManagedAssets);
  
      /**
       * @dev Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal
       * scenario where all the conditions are met.
       *
       * - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
       * - MUST NOT show any variations depending on the caller.
       * - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
       * - MUST NOT revert.
       *
       * NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
       * “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
       * from.
       */
      function convertToShares(uint256 assets) external view returns (uint256 shares);
  
      /**
       * @dev Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal
       * scenario where all the conditions are met.
       *
       * - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
       * - MUST NOT show any variations depending on the caller.
       * - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
       * - MUST NOT revert.
       *
       * NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
       * “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
       * from.
       */
      function convertToAssets(uint256 shares) external view returns (uint256 assets);
  
      /**
       * @dev Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver,
       * through a deposit call.
       *
       * - MUST return a limited value if receiver is subject to some deposit limit.
       * - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
       * - MUST NOT revert.
       */
      function maxDeposit(address receiver) external view returns (uint256 maxAssets);
  
      /**
       * @dev Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given
       * current on-chain conditions.
       *
       * - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit
       *   call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called
       *   in the same transaction.
       * - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the
       *   deposit would be accepted, regardless if the user has enough tokens approved, etc.
       * - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
       * - MUST NOT revert.
       *
       * NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in
       * share price or some other type of condition, meaning the depositor will lose assets by depositing.
       */
      function previewDeposit(uint256 assets) external view returns (uint256 shares);
  
      /**
       * @dev Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens.
       *
       * - MUST emit the Deposit event.
       * - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
       *   deposit execution, and are accounted for during deposit.
       * - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
       *   approving enough underlying tokens to the Vault contract, etc).
       *
       * NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
       */
      function deposit(uint256 assets, address receiver) external returns (uint256 shares);
  
      /**
       * @dev Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
       * - MUST return a limited value if receiver is subject to some mint limit.
       * - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
       * - MUST NOT revert.
       */
      function maxMint(address receiver) external view returns (uint256 maxShares);
  
      /**
       * @dev Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given
       * current on-chain conditions.
       *
       * - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call
       *   in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the
       *   same transaction.
       * - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint
       *   would be accepted, regardless if the user has enough tokens approved, etc.
       * - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
       * - MUST NOT revert.
       *
       * NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in
       * share price or some other type of condition, meaning the depositor will lose assets by minting.
       */
      function previewMint(uint256 shares) external view returns (uint256 assets);
  
      /**
       * @dev Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
       *
       * - MUST emit the Deposit event.
       * - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint
       *   execution, and are accounted for during mint.
       * - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
       *   approving enough underlying tokens to the Vault contract, etc).
       *
       * NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
       */
      function mint(uint256 shares, address receiver) external returns (uint256 assets);
  
      /**
       * @dev Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
       * Vault, through a withdraw call.
       *
       * - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
       * - MUST NOT revert.
       */
      function maxWithdraw(address owner) external view returns (uint256 maxAssets);
  
      /**
       * @dev Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block,
       * given current on-chain conditions.
       *
       * - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw
       *   call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if
       *   called
       *   in the same transaction.
       * - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though
       *   the withdrawal would be accepted, regardless if the user has enough shares, etc.
       * - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
       * - MUST NOT revert.
       *
       * NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in
       * share price or some other type of condition, meaning the depositor will lose assets by depositing.
       */
      function previewWithdraw(uint256 assets) external view returns (uint256 shares);
  
      /**
       * @dev Burns shares from owner and sends exactly assets of underlying tokens to receiver.
       *
       * - MUST emit the Withdraw event.
       * - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
       *   withdraw execution, and are accounted for during withdraw.
       * - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
       *   not having enough shares, etc).
       *
       * Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
       * Those methods should be performed separately.
       */
      function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
  
      /**
       * @dev Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault,
       * through a redeem call.
       *
       * - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
       * - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock.
       * - MUST NOT revert.
       */
      function maxRedeem(address owner) external view returns (uint256 maxShares);
  
      /**
       * @dev Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block,
       * given current on-chain conditions.
       *
       * - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
       *   in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the
       *   same transaction.
       * - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the
       *   redemption would be accepted, regardless if the user has enough shares, etc.
       * - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
       * - MUST NOT revert.
       *
       * NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in
       * share price or some other type of condition, meaning the depositor will lose assets by redeeming.
       */
      function previewRedeem(uint256 shares) external view returns (uint256 assets);
  
      /**
       * @dev Burns exactly shares from owner and sends assets of underlying tokens to receiver.
       *
       * - MUST emit the Withdraw event.
       * - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
       *   redeem execution, and are accounted for during redeem.
       * - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
       *   not having enough shares, etc).
       *
       * NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
       * Those methods should be performed separately.
       */
      function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/utils/PausableUpgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
  
  /**
   * @dev Contract module which allows children to implement an emergency stop
   * mechanism that can be triggered by an authorized account.
   *
   * This module is used through inheritance. It will make available the
   * modifiers `whenNotPaused` and `whenPaused`, which can be applied to
   * the functions of your contract. Note that they will not be pausable by
   * simply including this module, only once the modifiers are put in place.
   */
  abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
      /// @custom:storage-location erc7201:openzeppelin.storage.Pausable
      struct PausableStorage {
          bool _paused;
      }
  
      // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
  
      function _getPausableStorage() private pure returns (PausableStorage storage $) {
          assembly {
              $.slot := PausableStorageLocation
          }
      }
  
      /**
       * @dev Emitted when the pause is triggered by `account`.
       */
      event Paused(address account);
  
      /**
       * @dev Emitted when the pause is lifted by `account`.
       */
      event Unpaused(address account);
  
      /**
       * @dev The operation failed because the contract is paused.
       */
      error EnforcedPause();
  
      /**
       * @dev The operation failed because the contract is not paused.
       */
      error ExpectedPause();
  
      /**
       * @dev Initializes the contract in unpaused state.
       */
      function __Pausable_init() internal onlyInitializing {
          __Pausable_init_unchained();
      }
  
      function __Pausable_init_unchained() internal onlyInitializing {
          PausableStorage storage $ = _getPausableStorage();
          $._paused = false;
      }
  
      /**
       * @dev Modifier to make a function callable only when the contract is not paused.
       *
       * Requirements:
       *
       * - The contract must not be paused.
       */
      modifier whenNotPaused() {
          _requireNotPaused();
          _;
      }
  
      /**
       * @dev Modifier to make a function callable only when the contract is paused.
       *
       * Requirements:
       *
       * - The contract must be paused.
       */
      modifier whenPaused() {
          _requirePaused();
          _;
      }
  
      /**
       * @dev Returns true if the contract is paused, and false otherwise.
       */
      function paused() public view virtual returns (bool) {
          PausableStorage storage $ = _getPausableStorage();
          return $._paused;
      }
  
      /**
       * @dev Throws if the contract is paused.
       */
      function _requireNotPaused() internal view virtual {
          if (paused()) {
              revert EnforcedPause();
          }
      }
  
      /**
       * @dev Throws if the contract is not paused.
       */
      function _requirePaused() internal view virtual {
          if (!paused()) {
              revert ExpectedPause();
          }
      }
  
      /**
       * @dev Triggers stopped state.
       *
       * Requirements:
       *
       * - The contract must not be paused.
       */
      function _pause() internal virtual whenNotPaused {
          PausableStorage storage $ = _getPausableStorage();
          $._paused = true;
          emit Paused(_msgSender());
      }
  
      /**
       * @dev Returns to normal state.
       *
       * Requirements:
       *
       * - The contract must be paused.
       */
      function _unpause() internal virtual whenPaused {
          PausableStorage storage $ = _getPausableStorage();
          $._paused = false;
          emit Unpaused(_msgSender());
      }
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/ERC165.sol)
  
  /**
   * @dev Implementation of the {IERC165} interface.
   *
   * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
   * for the additional interface id that will be supported. For example:
   *
   * ```solidity
   * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
   *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
   * }
   * ```
   */
  abstract contract ERC165Upgradeable is Initializable, IERC165 {
      function __ERC165_init() internal onlyInitializing {
      }
  
      function __ERC165_init_unchained() internal onlyInitializing {
      }
      /**
       * @dev See {IERC165-supportsInterface}.
       */
      function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
          return interfaceId == type(IERC165).interfaceId;
      }
  }
  
  // lib/zkevm-stb/src/PolygonBridgeBaseUpgradeable.sol
  
  /**
   * @title PolygonBridgeBaseUpgradeable
   * @author sepyke.eth
   * @dev Upgradeable version of PolygonBridgeBase
   *
   * https://github.com/0xPolygonHermez/code-examples/blob/41d266590db4fcdabb56cd29f407c728f40210ec/customERC20-bridge-example/contracts/base/PolygonBridgeBase.sol
   */
  abstract contract PolygonBridgeBaseUpgradeable is Initializable {
      /// @custom:storage-location erc7201:polygon.storage.PolygonBridgeBase
      struct PolygonBridgeBaseStorage {
          IPolygonZkEVMBridge polygonZkEVMBridge;
          address counterpartContract;
          uint32 counterpartNetwork;
      }
  
      // keccak256(abi.encode(uint256(keccak256("polygon.storage.PolygonBridgeBase")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant PolygonBridgeBaseStorageLocation = 0xa2df0fe6db3ae7b9af51d186eeafd135102ceb6374bcad9534034e06f66daa00;
  
      function _getPolygonBridgeBaseStorage() private pure returns (PolygonBridgeBaseStorage storage $) {
          assembly {
              $.slot := PolygonBridgeBaseStorageLocation
          }
      }
  
      function polygonZkEVMBridge() public view returns (address) {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
          return address($.polygonZkEVMBridge);
      }
  
      function counterpartContract() public view returns (address) {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
          return $.counterpartContract;
      }
  
      function counterpartNetwork() public view returns (uint32) {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
          return $.counterpartNetwork;
      }
  
      /**
       * @param _polygonZkEVMBridge Polygon zkevm bridge address
       * @param _counterpartContract Couterpart contract
       * @param _counterpartNetwork Couterpart network
       */
      function __PolygonBridgeBase_init(address _polygonZkEVMBridge, address _counterpartContract, uint32 _counterpartNetwork) internal onlyInitializing {
          __PolygonBridgeBase_init_unchained(_polygonZkEVMBridge, _counterpartContract, _counterpartNetwork);
      }
  
      function __PolygonBridgeBase_init_unchained(address _polygonZkEVMBridge, address _counterpartContract, uint32 _counterpartNetwork) internal onlyInitializing {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
          $.polygonZkEVMBridge = IPolygonZkEVMBridge(_polygonZkEVMBridge);
          $.counterpartContract = _counterpartContract;
          $.counterpartNetwork = _counterpartNetwork;
      }
  
      /**
       * @notice Send a message to the bridge
       * @param messageData Message data
       * @param forceUpdateGlobalExitRoot Indicates if the global exit root is updated or not
       */
      function _bridgeMessage(bytes memory messageData, bool forceUpdateGlobalExitRoot) internal virtual {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
          $.polygonZkEVMBridge.bridgeMessage($.counterpartNetwork, $.counterpartContract, forceUpdateGlobalExitRoot, messageData);
      }
  
      /**
       * @notice Function triggered by the bridge once a message is received by the other network
       * @param originAddress Origin address that the message was sended
       * @param originNetwork Origin network that the message was sended ( not usefull for this contract)
       * @param data Abi encoded metadata
       */
      function onMessageReceived(address originAddress, uint32 originNetwork, bytes memory data) external payable {
          PolygonBridgeBaseStorage storage $ = _getPolygonBridgeBaseStorage();
  
          // Can only be called by the bridge
          require(msg.sender == address($.polygonZkEVMBridge), "TokenWrapped::PolygonBridgeBase: Not PolygonZkEVMBridge");
          require($.counterpartContract == originAddress, "TokenWrapped::PolygonBridgeBase: Not counterpart contract");
          require($.counterpartNetwork == originNetwork, "TokenWrapped::PolygonBridgeBase: Not counterpart network");
  
          _onMessageReceived(data);
      }
  
      /**
       * @dev Handle the data of the message received
       * Must be implemented in parent contracts
       */
      function _onMessageReceived(bytes memory data) internal virtual;
  }
  
  // lib/openzeppelin-contracts/contracts/proxy/ERC1967/ERC1967Utils.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (proxy/ERC1967/ERC1967Utils.sol)
  
  /**
   * @dev This abstract contract provides getters and event emitting update functions for
   * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
   */
  library ERC1967Utils {
      // We re-declare ERC-1967 events here because they can't be used directly from IERC1967.
      // This will be fixed in Solidity 0.8.21. At that point we should remove these events.
      /**
       * @dev Emitted when the implementation is upgraded.
       */
      event Upgraded(address indexed implementation);
  
      /**
       * @dev Emitted when the admin account has changed.
       */
      event AdminChanged(address previousAdmin, address newAdmin);
  
      /**
       * @dev Emitted when the beacon is changed.
       */
      event BeaconUpgraded(address indexed beacon);
  
      /**
       * @dev Storage slot with the address of the current implementation.
       * This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
       */
      // solhint-disable-next-line private-vars-leading-underscore
      bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
  
      /**
       * @dev The `implementation` of the proxy is invalid.
       */
      error ERC1967InvalidImplementation(address implementation);
  
      /**
       * @dev The `admin` of the proxy is invalid.
       */
      error ERC1967InvalidAdmin(address admin);
  
      /**
       * @dev The `beacon` of the proxy is invalid.
       */
      error ERC1967InvalidBeacon(address beacon);
  
      /**
       * @dev An upgrade function sees `msg.value > 0` that may be lost.
       */
      error ERC1967NonPayable();
  
      /**
       * @dev Returns the current implementation address.
       */
      function getImplementation() internal view returns (address) {
          return StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value;
      }
  
      /**
       * @dev Stores a new address in the EIP1967 implementation slot.
       */
      function _setImplementation(address newImplementation) private {
          if (newImplementation.code.length == 0) {
              revert ERC1967InvalidImplementation(newImplementation);
          }
          StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value = newImplementation;
      }
  
      /**
       * @dev Performs implementation upgrade with additional setup call if data is nonempty.
       * This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
       * to avoid stuck value in the contract.
       *
       * Emits an {IERC1967-Upgraded} event.
       */
      function upgradeToAndCall(address newImplementation, bytes memory data) internal {
          _setImplementation(newImplementation);
          emit Upgraded(newImplementation);
  
          if (data.length > 0) {
              Address.functionDelegateCall(newImplementation, data);
          } else {
              _checkNonPayable();
          }
      }
  
      /**
       * @dev Storage slot with the admin of the contract.
       * This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1.
       */
      // solhint-disable-next-line private-vars-leading-underscore
      bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
  
      /**
       * @dev Returns the current admin.
       *
       * TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using
       * the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
       * `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
       */
      function getAdmin() internal view returns (address) {
          return StorageSlot.getAddressSlot(ADMIN_SLOT).value;
      }
  
      /**
       * @dev Stores a new address in the EIP1967 admin slot.
       */
      function _setAdmin(address newAdmin) private {
          if (newAdmin == address(0)) {
              revert ERC1967InvalidAdmin(address(0));
          }
          StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
      }
  
      /**
       * @dev Changes the admin of the proxy.
       *
       * Emits an {IERC1967-AdminChanged} event.
       */
      function changeAdmin(address newAdmin) internal {
          emit AdminChanged(getAdmin(), newAdmin);
          _setAdmin(newAdmin);
      }
  
      /**
       * @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
       * This is the keccak-256 hash of "eip1967.proxy.beacon" subtracted by 1.
       */
      // solhint-disable-next-line private-vars-leading-underscore
      bytes32 internal constant BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
  
      /**
       * @dev Returns the current beacon.
       */
      function getBeacon() internal view returns (address) {
          return StorageSlot.getAddressSlot(BEACON_SLOT).value;
      }
  
      /**
       * @dev Stores a new beacon in the EIP1967 beacon slot.
       */
      function _setBeacon(address newBeacon) private {
          if (newBeacon.code.length == 0) {
              revert ERC1967InvalidBeacon(newBeacon);
          }
  
          StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;
  
          address beaconImplementation = IBeacon(newBeacon).implementation();
          if (beaconImplementation.code.length == 0) {
              revert ERC1967InvalidImplementation(beaconImplementation);
          }
      }
  
      /**
       * @dev Change the beacon and trigger a setup call if data is nonempty.
       * This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
       * to avoid stuck value in the contract.
       *
       * Emits an {IERC1967-BeaconUpgraded} event.
       *
       * CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since
       * it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for
       * efficiency.
       */
      function upgradeBeaconToAndCall(address newBeacon, bytes memory data) internal {
          _setBeacon(newBeacon);
          emit BeaconUpgraded(newBeacon);
  
          if (data.length > 0) {
              Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
          } else {
              _checkNonPayable();
          }
      }
  
      /**
       * @dev Reverts if `msg.value` is not zero. It can be used to avoid `msg.value` stuck in the contract
       * if an upgrade doesn't perform an initialization call.
       */
      function _checkNonPayable() private {
          if (msg.value > 0) {
              revert ERC1967NonPayable();
          }
      }
  }
  
  // lib/openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
  
  /**
   * @title SafeERC20
   * @dev Wrappers around ERC20 operations that throw on failure (when the token
   * contract returns false). Tokens that return no value (and instead revert or
   * throw on failure) are also supported, non-reverting calls are assumed to be
   * successful.
   * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
   * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
   */
  library SafeERC20 {
      using Address for address;
  
      /**
       * @dev An operation with an ERC20 token failed.
       */
      error SafeERC20FailedOperation(address token);
  
      /**
       * @dev Indicates a failed `decreaseAllowance` request.
       */
      error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
  
      /**
       * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
       * non-reverting calls are assumed to be successful.
       */
      function safeTransfer(IERC20 token, address to, uint256 value) internal {
          _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
      }
  
      /**
       * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
       * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
       */
      function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
          _callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
      }
  
      /**
       * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
       * non-reverting calls are assumed to be successful.
       */
      function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
          uint256 oldAllowance = token.allowance(address(this), spender);
          forceApprove(token, spender, oldAllowance + value);
      }
  
      /**
       * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
       * value, non-reverting calls are assumed to be successful.
       */
      function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
          unchecked {
              uint256 currentAllowance = token.allowance(address(this), spender);
              if (currentAllowance < requestedDecrease) {
                  revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
              }
              forceApprove(token, spender, currentAllowance - requestedDecrease);
          }
      }
  
      /**
       * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
       * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
       * to be set to zero before setting it to a non-zero value, such as USDT.
       */
      function forceApprove(IERC20 token, address spender, uint256 value) internal {
          bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
  
          if (!_callOptionalReturnBool(token, approvalCall)) {
              _callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
              _callOptionalReturn(token, approvalCall);
          }
      }
  
      /**
       * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
       * on the return value: the return value is optional (but if data is returned, it must not be false).
       * @param token The token targeted by the call.
       * @param data The call data (encoded using abi.encode or one of its variants).
       */
      function _callOptionalReturn(IERC20 token, bytes memory data) private {
          // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
          // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
          // the target address contains contract code and also asserts for success in the low-level call.
  
          bytes memory returndata = address(token).functionCall(data);
          if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
              revert SafeERC20FailedOperation(address(token));
          }
      }
  
      /**
       * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
       * on the return value: the return value is optional (but if data is returned, it must not be false).
       * @param token The token targeted by the call.
       * @param data The call data (encoded using abi.encode or one of its variants).
       *
       * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
       */
      function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
          // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
          // we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
          // and not revert is the subcall reverts.
  
          (bool success, bytes memory returndata) = address(token).call(data);
          return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
      }
  }
  
  // lib/yearn-vaults-v3/contracts/interfaces/IVault.sol
  
  interface IVault is IERC4626 {
      // STRATEGY EVENTS
      event StrategyChanged(address indexed strategy, uint256 change_type);
      event StrategyReported(
          address indexed strategy,
          uint256 gain,
          uint256 loss,
          uint256 current_debt,
          uint256 protocol_fees,
          uint256 total_fees,
          uint256 total_refunds
      );
      // DEBT MANAGEMENT EVENTS
      event DebtUpdated(
          address indexed strategy,
          uint256 current_debt,
          uint256 new_debt
      );
      // ROLE UPDATES
      event RoleSet(address indexed account, uint256 role);
      event UpdateRoleManager(address indexed role_manager);
  
      event UpdateAccountant(address indexed accountant);
      event UpdateDefaultQueue(address[] new_default_queue);
      event UpdateUseDefaultQueue(bool use_default_queue);
      event UpdatedMaxDebtForStrategy(
          address indexed sender,
          address indexed strategy,
          uint256 new_debt
      );
      event UpdateDepositLimit(uint256 deposit_limit);
      event UpdateMinimumTotalIdle(uint256 minimum_total_idle);
      event UpdateProfitMaxUnlockTime(uint256 profit_max_unlock_time);
      event DebtPurchased(address indexed strategy, uint256 amount);
      event Shutdown();
  
      struct StrategyParams {
          uint256 activation;
          uint256 last_report;
          uint256 current_debt;
          uint256 max_debt;
      }
  
      function FACTORY() external view returns (uint256);
  
      function strategies(address) external view returns (StrategyParams memory);
  
      function default_queue(uint256) external view returns (address);
  
      function use_default_queue() external view returns (bool);
  
      function minimum_total_idle() external view returns (uint256);
  
      function deposit_limit() external view returns (uint256);
  
      function deposit_limit_module() external view returns (address);
  
      function withdraw_limit_module() external view returns (address);
  
      function accountant() external view returns (address);
  
      function roles(address) external view returns (uint256);
  
      function role_manager() external view returns (address);
  
      function future_role_manager() external view returns (address);
  
      function isShutdown() external view returns (bool);
  
      function nonces(address) external view returns (uint256);
  
      function initialize(
          address,
          string memory,
          string memory,
          address,
          uint256
      ) external;
  
      function set_accountant(address new_accountant) external;
  
      function set_default_queue(address[] memory new_default_queue) external;
  
      function set_use_default_queue(bool) external;
  
      function set_deposit_limit(uint256 deposit_limit) external;
  
      function set_deposit_limit(
          uint256 deposit_limit,
          bool should_override
      ) external;
  
      function set_deposit_limit_module(
          address new_deposit_limit_module
      ) external;
  
      function set_deposit_limit_module(
          address new_deposit_limit_module,
          bool should_override
      ) external;
  
      function set_withdraw_limit_module(
          address new_withdraw_limit_module
      ) external;
  
      function set_minimum_total_idle(uint256 minimum_total_idle) external;
  
      function setProfitMaxUnlockTime(
          uint256 new_profit_max_unlock_time
      ) external;
  
      function set_role(address account, uint256 role) external;
  
      function add_role(address account, uint256 role) external;
  
      function remove_role(address account, uint256 role) external;
  
      function transfer_role_manager(address role_manager) external;
  
      function accept_role_manager() external;
  
      function unlockedShares() external view returns (uint256);
  
      function pricePerShare() external view returns (uint256);
  
      function get_default_queue() external view returns (address[] memory);
  
      function process_report(
          address strategy
      ) external returns (uint256, uint256);
  
      function buy_debt(address strategy, uint256 amount) external;
  
      function add_strategy(address new_strategy) external;
  
      function revoke_strategy(address strategy) external;
  
      function force_revoke_strategy(address strategy) external;
  
      function update_max_debt_for_strategy(
          address strategy,
          uint256 new_max_debt
      ) external;
  
      function update_debt(
          address strategy,
          uint256 target_debt
      ) external returns (uint256);
  
      function update_debt(
          address strategy,
          uint256 target_debt,
          uint256 max_loss
      ) external returns (uint256);
  
      function shutdown_vault() external;
  
      function totalIdle() external view returns (uint256);
  
      function totalDebt() external view returns (uint256);
  
      function apiVersion() external view returns (string memory);
  
      function assess_share_of_unrealised_losses(
          address strategy,
          uint256 assets_needed
      ) external view returns (uint256);
  
      function profitMaxUnlockTime() external view returns (uint256);
  
      function fullProfitUnlockDate() external view returns (uint256);
  
      function profitUnlockingRate() external view returns (uint256);
  
      function lastProfitUpdate() external view returns (uint256);
  
      //// NON-STANDARD ERC-4626 FUNCTIONS \\\\
  
      function withdraw(
          uint256 assets,
          address receiver,
          address owner,
          uint256 max_loss
      ) external returns (uint256);
  
      function withdraw(
          uint256 assets,
          address receiver,
          address owner,
          uint256 max_loss,
          address[] memory strategies
      ) external returns (uint256);
  
      function redeem(
          uint256 shares,
          address receiver,
          address owner,
          uint256 max_loss
      ) external returns (uint256);
  
      function redeem(
          uint256 shares,
          address receiver,
          address owner,
          uint256 max_loss,
          address[] memory strategies
      ) external returns (uint256);
  
      function maxWithdraw(
          address owner,
          uint256 max_loss
      ) external view returns (uint256);
  
      function maxWithdraw(
          address owner,
          uint256 max_loss,
          address[] memory strategies
      ) external view returns (uint256);
  
      function maxRedeem(
          address owner,
          uint256 max_loss
      ) external view returns (uint256);
  
      function maxRedeem(
          address owner,
          uint256 max_loss,
          address[] memory strategies
      ) external view returns (uint256);
  
      //// NON-STANDARD ERC-20 FUNCTIONS \\\\
  
      function DOMAIN_SEPARATOR() external view returns (bytes32);
  
      function permit(
          address owner,
          address spender,
          uint256 amount,
          uint256 deadline,
          uint8 v,
          bytes32 r,
          bytes32 s
      ) external returns (bool);
  }
  
  // lib/zkevm-stb/src/PolygonERC20BridgeBaseUpgradeable.sol
  
  /**
   * @title PolygonERC20BridgeBaseUpgradeable
   * @author sepyke.eth
   * @dev Upgradeable version of PolygonERC20BridgeBase
   *
   * https://github.com/0xPolygonHermez/code-examples/blob/41d266590db4fcdabb56cd29f407c728f40210ec/customERC20-bridge-example/contracts/base/PolygonERC20BridgeBase.sol
   */
  abstract contract PolygonERC20BridgeBaseUpgradeable is PolygonBridgeBaseUpgradeable {
      /**
       * @param _polygonZkEVMBridge Polygon zkevm bridge address
       * @param _counterpartContract Couterpart contract
       * @param _counterpartNetwork Couterpart network
       */
      function __PolygonERC20BridgeBase_init(address _polygonZkEVMBridge, address _counterpartContract, uint32 _counterpartNetwork) internal onlyInitializing {
          __PolygonERC20BridgeBase_init_unchained(_polygonZkEVMBridge, _counterpartContract, _counterpartNetwork);
      }
  
      function __PolygonERC20BridgeBase_init_unchained(address _polygonZkEVMBridge, address _counterpartContract, uint32 _counterpartNetwork) internal onlyInitializing {
          __PolygonBridgeBase_init_unchained(_polygonZkEVMBridge, _counterpartContract, _counterpartNetwork);
      }
  
      /**
       * @dev Emitted when bridge tokens to the counterpart network
       */
      event BridgeTokens(address destinationAddress, uint256 amount);
  
      /**
       * @dev Emitted when claim tokens from the counterpart network
       */
      event ClaimTokens(address destinationAddress, uint256 amount);
  
      /**
       * @notice Send a message to the bridge that contains the destination address and the token amount
       * The parent contract should implement the receive token protocol and afterwards call this function
       * @param destinationAddress Address destination that will receive the tokens on the other network
       * @param amount Token amount
       * @param forceUpdateGlobalExitRoot Indicates if the global exit root is updated or not
       */
      function bridgeToken(address destinationAddress, uint256 amount, bool forceUpdateGlobalExitRoot) external {
          require(destinationAddress != address(0), "TokenWrapped::PolygonBridgeERC20Base: Zero Address");
          _receiveTokens(amount);
  
          // Encode message data
          bytes memory messageData = abi.encode(destinationAddress, amount);
  
          // Send message data through the bridge
          _bridgeMessage(messageData, forceUpdateGlobalExitRoot);
  
          emit BridgeTokens(destinationAddress, amount);
      }
  
      /**
       * @notice Internal function triggered when receive a message
       * @param data message data containing the destination address and the token amount
       */
      function _onMessageReceived(bytes memory data) internal override {
          // Decode message data
          (address destinationAddress, uint256 amount) = abi.decode(data, (address, uint256));
  
          _transferTokens(destinationAddress, amount);
          emit ClaimTokens(destinationAddress, amount);
      }
  
      /**
       * @dev Handle the reception of the tokens
       * Must be implemented in parent contracts
       */
      function _receiveTokens(uint256 amount) internal virtual;
  
      /**
       * @dev Handle the transfer of the tokens
       * Must be implemented in parent contracts
       */
      function _transferTokens(address destinationAddress, uint256 amount) internal virtual;
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/access/AccessControlUpgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (access/AccessControl.sol)
  
  /**
   * @dev Contract module that allows children to implement role-based access
   * control mechanisms. This is a lightweight version that doesn't allow enumerating role
   * members except through off-chain means by accessing the contract event logs. Some
   * applications may benefit from on-chain enumerability, for those cases see
   * {AccessControlEnumerable}.
   *
   * Roles are referred to by their `bytes32` identifier. These should be exposed
   * in the external API and be unique. The best way to achieve this is by
   * using `public constant` hash digests:
   *
   * ```solidity
   * bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
   * ```
   *
   * Roles can be used to represent a set of permissions. To restrict access to a
   * function call, use {hasRole}:
   *
   * ```solidity
   * function foo() public {
   *     require(hasRole(MY_ROLE, msg.sender));
   *     ...
   * }
   * ```
   *
   * Roles can be granted and revoked dynamically via the {grantRole} and
   * {revokeRole} functions. Each role has an associated admin role, and only
   * accounts that have a role's admin role can call {grantRole} and {revokeRole}.
   *
   * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
   * that only accounts with this role will be able to grant or revoke other
   * roles. More complex role relationships can be created by using
   * {_setRoleAdmin}.
   *
   * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
   * grant and revoke this role. Extra precautions should be taken to secure
   * accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
   * to enforce additional security measures for this role.
   */
  abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControl, ERC165Upgradeable {
      struct RoleData {
          mapping(address account => bool) hasRole;
          bytes32 adminRole;
      }
  
      bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
  
      /// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
      struct AccessControlStorage {
          mapping(bytes32 role => RoleData) _roles;
      }
  
      // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800;
  
      function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
          assembly {
              $.slot := AccessControlStorageLocation
          }
      }
  
      /**
       * @dev Modifier that checks that an account has a specific role. Reverts
       * with an {AccessControlUnauthorizedAccount} error including the required role.
       */
      modifier onlyRole(bytes32 role) {
          _checkRole(role);
          _;
      }
  
      function __AccessControl_init() internal onlyInitializing {
      }
  
      function __AccessControl_init_unchained() internal onlyInitializing {
      }
      /**
       * @dev See {IERC165-supportsInterface}.
       */
      function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
          return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
      }
  
      /**
       * @dev Returns `true` if `account` has been granted `role`.
       */
      function hasRole(bytes32 role, address account) public view virtual returns (bool) {
          AccessControlStorage storage $ = _getAccessControlStorage();
          return $._roles[role].hasRole[account];
      }
  
      /**
       * @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
       * is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
       */
      function _checkRole(bytes32 role) internal view virtual {
          _checkRole(role, _msgSender());
      }
  
      /**
       * @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
       * is missing `role`.
       */
      function _checkRole(bytes32 role, address account) internal view virtual {
          if (!hasRole(role, account)) {
              revert AccessControlUnauthorizedAccount(account, role);
          }
      }
  
      /**
       * @dev Returns the admin role that controls `role`. See {grantRole} and
       * {revokeRole}.
       *
       * To change a role's admin, use {_setRoleAdmin}.
       */
      function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
          AccessControlStorage storage $ = _getAccessControlStorage();
          return $._roles[role].adminRole;
      }
  
      /**
       * @dev Grants `role` to `account`.
       *
       * If `account` had not been already granted `role`, emits a {RoleGranted}
       * event.
       *
       * Requirements:
       *
       * - the caller must have ``role``'s admin role.
       *
       * May emit a {RoleGranted} event.
       */
      function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
          _grantRole(role, account);
      }
  
      /**
       * @dev Revokes `role` from `account`.
       *
       * If `account` had been granted `role`, emits a {RoleRevoked} event.
       *
       * Requirements:
       *
       * - the caller must have ``role``'s admin role.
       *
       * May emit a {RoleRevoked} event.
       */
      function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
          _revokeRole(role, account);
      }
  
      /**
       * @dev Revokes `role` from the calling account.
       *
       * Roles are often managed via {grantRole} and {revokeRole}: this function's
       * purpose is to provide a mechanism for accounts to lose their privileges
       * if they are compromised (such as when a trusted device is misplaced).
       *
       * If the calling account had been revoked `role`, emits a {RoleRevoked}
       * event.
       *
       * Requirements:
       *
       * - the caller must be `callerConfirmation`.
       *
       * May emit a {RoleRevoked} event.
       */
      function renounceRole(bytes32 role, address callerConfirmation) public virtual {
          if (callerConfirmation != _msgSender()) {
              revert AccessControlBadConfirmation();
          }
  
          _revokeRole(role, callerConfirmation);
      }
  
      /**
       * @dev Sets `adminRole` as ``role``'s admin role.
       *
       * Emits a {RoleAdminChanged} event.
       */
      function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
          AccessControlStorage storage $ = _getAccessControlStorage();
          bytes32 previousAdminRole = getRoleAdmin(role);
          $._roles[role].adminRole = adminRole;
          emit RoleAdminChanged(role, previousAdminRole, adminRole);
      }
  
      /**
       * @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
       *
       * Internal function without access restriction.
       *
       * May emit a {RoleGranted} event.
       */
      function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
          AccessControlStorage storage $ = _getAccessControlStorage();
          if (!hasRole(role, account)) {
              $._roles[role].hasRole[account] = true;
              emit RoleGranted(role, account, _msgSender());
              return true;
          } else {
              return false;
          }
      }
  
      /**
       * @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
       *
       * Internal function without access restriction.
       *
       * May emit a {RoleRevoked} event.
       */
      function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
          AccessControlStorage storage $ = _getAccessControlStorage();
          if (hasRole(role, account)) {
              $._roles[role].hasRole[account] = false;
              emit RoleRevoked(role, account, _msgSender());
              return true;
          } else {
              return false;
          }
      }
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/UUPSUpgradeable.sol)
  
  /**
   * @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
   * {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
   *
   * A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
   * reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
   * `UUPSUpgradeable` with a custom implementation of upgrades.
   *
   * The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
   */
  abstract contract UUPSUpgradeable is Initializable, IERC1822Proxiable {
      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
      address private immutable __self = address(this);
  
      /**
       * @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgradeTo(address)`
       * and `upgradeToAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called,
       * while `upgradeToAndCall` will invoke the `receive` function if the second argument is the empty byte string.
       * If the getter returns `"5.0.0"`, only `upgradeToAndCall(address,bytes)` is present, and the second argument must
       * be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
       * during an upgrade.
       */
      string public constant UPGRADE_INTERFACE_VERSION = "5.0.0";
  
      /**
       * @dev The call is from an unauthorized context.
       */
      error UUPSUnauthorizedCallContext();
  
      /**
       * @dev The storage `slot` is unsupported as a UUID.
       */
      error UUPSUnsupportedProxiableUUID(bytes32 slot);
  
      /**
       * @dev Check that the execution is being performed through a delegatecall call and that the execution context is
       * a proxy contract with an implementation (as defined in ERC1967) pointing to self. This should only be the case
       * for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
       * function through ERC1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
       * fail.
       */
      modifier onlyProxy() {
          _checkProxy();
          _;
      }
  
      /**
       * @dev Check that the execution is not being performed through a delegate call. This allows a function to be
       * callable on the implementing contract but not through proxies.
       */
      modifier notDelegated() {
          _checkNotDelegated();
          _;
      }
  
      function __UUPSUpgradeable_init() internal onlyInitializing {
      }
  
      function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
      }
      /**
       * @dev Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the
       * implementation. It is used to validate the implementation's compatibility when performing an upgrade.
       *
       * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
       * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
       * function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.
       */
      function proxiableUUID() external view virtual notDelegated returns (bytes32) {
          return ERC1967Utils.IMPLEMENTATION_SLOT;
      }
  
      /**
       * @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
       * encoded in `data`.
       *
       * Calls {_authorizeUpgrade}.
       *
       * Emits an {Upgraded} event.
       *
       * @custom:oz-upgrades-unsafe-allow-reachable delegatecall
       */
      function upgradeToAndCall(address newImplementation, bytes memory data) public payable virtual onlyProxy {
          _authorizeUpgrade(newImplementation);
          _upgradeToAndCallUUPS(newImplementation, data);
      }
  
      /**
       * @dev Reverts if the execution is not performed via delegatecall or the execution
       * context is not of a proxy with an ERC1967-compliant implementation pointing to self.
       * See {_onlyProxy}.
       */
      function _checkProxy() internal view virtual {
          if (
              address(this) == __self || // Must be called through delegatecall
              ERC1967Utils.getImplementation() != __self // Must be called through an active proxy
          ) {
              revert UUPSUnauthorizedCallContext();
          }
      }
  
      /**
       * @dev Reverts if the execution is performed via delegatecall.
       * See {notDelegated}.
       */
      function _checkNotDelegated() internal view virtual {
          if (address(this) != __self) {
              // Must not be called through delegatecall
              revert UUPSUnauthorizedCallContext();
          }
      }
  
      /**
       * @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
       * {upgradeToAndCall}.
       *
       * Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
       *
       * ```solidity
       * function _authorizeUpgrade(address) internal onlyOwner {}
       * ```
       */
      function _authorizeUpgrade(address newImplementation) internal virtual;
  
      /**
       * @dev Performs an implementation upgrade with a security check for UUPS proxies, and additional setup call.
       *
       * As a security check, {proxiableUUID} is invoked in the new implementation, and the return value
       * is expected to be the implementation slot in ERC1967.
       *
       * Emits an {IERC1967-Upgraded} event.
       */
      function _upgradeToAndCallUUPS(address newImplementation, bytes memory data) private {
          try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) {
              if (slot != ERC1967Utils.IMPLEMENTATION_SLOT) {
                  revert UUPSUnsupportedProxiableUUID(slot);
              }
              ERC1967Utils.upgradeToAndCall(newImplementation, data);
          } catch {
              // The implementation is not UUPS
              revert ERC1967Utils.ERC1967InvalidImplementation(newImplementation);
          }
      }
  }
  
  // lib/zkevm-stb/lib/openzeppelin-contracts-upgradeable/contracts/access/extensions/AccessControlDefaultAdminRulesUpgradeable.sol
  
  // OpenZeppelin Contracts (last updated v5.0.0) (access/extensions/AccessControlDefaultAdminRules.sol)
  
  /**
   * @dev Extension of {AccessControl} that allows specifying special rules to manage
   * the `DEFAULT_ADMIN_ROLE` holder, which is a sensitive role with special permissions
   * over other roles that may potentially have privileged rights in the system.
   *
   * If a specific role doesn't have an admin role assigned, the holder of the
   * `DEFAULT_ADMIN_ROLE` will have the ability to grant it and revoke it.
   *
   * This contract implements the following risk mitigations on top of {AccessControl}:
   *
   * * Only one account holds the `DEFAULT_ADMIN_ROLE` since deployment until it's potentially renounced.
   * * Enforces a 2-step process to transfer the `DEFAULT_ADMIN_ROLE` to another account.
   * * Enforces a configurable delay between the two steps, with the ability to cancel before the transfer is accepted.
   * * The delay can be changed by scheduling, see {changeDefaultAdminDelay}.
   * * It is not possible to use another role to manage the `DEFAULT_ADMIN_ROLE`.
   *
   * Example usage:
   *
   * ```solidity
   * contract MyToken is AccessControlDefaultAdminRules {
   *   constructor() AccessControlDefaultAdminRules(
   *     3 days,
   *     msg.sender // Explicit initial `DEFAULT_ADMIN_ROLE` holder
   *    ) {}
   * }
   * ```
   */
  abstract contract AccessControlDefaultAdminRulesUpgradeable is Initializable, IAccessControlDefaultAdminRules, IERC5313, AccessControlUpgradeable {
      /// @custom:storage-location erc7201:openzeppelin.storage.AccessControlDefaultAdminRules
      struct AccessControlDefaultAdminRulesStorage {
          // pending admin pair read/written together frequently
          address _pendingDefaultAdmin;
          uint48 _pendingDefaultAdminSchedule; // 0 == unset
  
          uint48 _currentDelay;
          address _currentDefaultAdmin;
  
          // pending delay pair read/written together frequently
          uint48 _pendingDelay;
          uint48 _pendingDelaySchedule; // 0 == unset
      }
  
      // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControlDefaultAdminRules")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant AccessControlDefaultAdminRulesStorageLocation = 0xeef3dac4538c82c8ace4063ab0acd2d15cdb5883aa1dff7c2673abb3d8698400;
  
      function _getAccessControlDefaultAdminRulesStorage() private pure returns (AccessControlDefaultAdminRulesStorage storage $) {
          assembly {
              $.slot := AccessControlDefaultAdminRulesStorageLocation
          }
      }
  
      /**
       * @dev Sets the initial values for {defaultAdminDelay} and {defaultAdmin} address.
       */
      function __AccessControlDefaultAdminRules_init(uint48 initialDelay, address initialDefaultAdmin) internal onlyInitializing {
          __AccessControlDefaultAdminRules_init_unchained(initialDelay, initialDefaultAdmin);
      }
  
      function __AccessControlDefaultAdminRules_init_unchained(uint48 initialDelay, address initialDefaultAdmin) internal onlyInitializing {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          if (initialDefaultAdmin == address(0)) {
              revert AccessControlInvalidDefaultAdmin(address(0));
          }
          $._currentDelay = initialDelay;
          _grantRole(DEFAULT_ADMIN_ROLE, initialDefaultAdmin);
      }
  
      /**
       * @dev See {IERC165-supportsInterface}.
       */
      function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
          return interfaceId == type(IAccessControlDefaultAdminRules).interfaceId || super.supportsInterface(interfaceId);
      }
  
      /**
       * @dev See {IERC5313-owner}.
       */
      function owner() public view virtual returns (address) {
          return defaultAdmin();
      }
  
      ///
      /// Override AccessControl role management
      ///
  
      /**
       * @dev See {AccessControl-grantRole}. Reverts for `DEFAULT_ADMIN_ROLE`.
       */
      function grantRole(bytes32 role, address account) public virtual override(AccessControlUpgradeable, IAccessControl) {
          if (role == DEFAULT_ADMIN_ROLE) {
              revert AccessControlEnforcedDefaultAdminRules();
          }
          super.grantRole(role, account);
      }
  
      /**
       * @dev See {AccessControl-revokeRole}. Reverts for `DEFAULT_ADMIN_ROLE`.
       */
      function revokeRole(bytes32 role, address account) public virtual override(AccessControlUpgradeable, IAccessControl) {
          if (role == DEFAULT_ADMIN_ROLE) {
              revert AccessControlEnforcedDefaultAdminRules();
          }
          super.revokeRole(role, account);
      }
  
      /**
       * @dev See {AccessControl-renounceRole}.
       *
       * For the `DEFAULT_ADMIN_ROLE`, it only allows renouncing in two steps by first calling
       * {beginDefaultAdminTransfer} to the `address(0)`, so it's required that the {pendingDefaultAdmin} schedule
       * has also passed when calling this function.
       *
       * After its execution, it will not be possible to call `onlyRole(DEFAULT_ADMIN_ROLE)` functions.
       *
       * NOTE: Renouncing `DEFAULT_ADMIN_ROLE` will leave the contract without a {defaultAdmin},
       * thereby disabling any functionality that is only available for it, and the possibility of reassigning a
       * non-administrated role.
       */
      function renounceRole(bytes32 role, address account) public virtual override(AccessControlUpgradeable, IAccessControl) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          if (role == DEFAULT_ADMIN_ROLE && account == defaultAdmin()) {
              (address newDefaultAdmin, uint48 schedule) = pendingDefaultAdmin();
              if (newDefaultAdmin != address(0) || !_isScheduleSet(schedule) || !_hasSchedulePassed(schedule)) {
                  revert AccessControlEnforcedDefaultAdminDelay(schedule);
              }
              delete $._pendingDefaultAdminSchedule;
          }
          super.renounceRole(role, account);
      }
  
      /**
       * @dev See {AccessControl-_grantRole}.
       *
       * For `DEFAULT_ADMIN_ROLE`, it only allows granting if there isn't already a {defaultAdmin} or if the
       * role has been previously renounced.
       *
       * NOTE: Exposing this function through another mechanism may make the `DEFAULT_ADMIN_ROLE`
       * assignable again. Make sure to guarantee this is the expected behavior in your implementation.
       */
      function _grantRole(bytes32 role, address account) internal virtual override returns (bool) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          if (role == DEFAULT_ADMIN_ROLE) {
              if (defaultAdmin() != address(0)) {
                  revert AccessControlEnforcedDefaultAdminRules();
              }
              $._currentDefaultAdmin = account;
          }
          return super._grantRole(role, account);
      }
  
      /**
       * @dev See {AccessControl-_revokeRole}.
       */
      function _revokeRole(bytes32 role, address account) internal virtual override returns (bool) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          if (role == DEFAULT_ADMIN_ROLE && account == defaultAdmin()) {
              delete $._currentDefaultAdmin;
          }
          return super._revokeRole(role, account);
      }
  
      /**
       * @dev See {AccessControl-_setRoleAdmin}. Reverts for `DEFAULT_ADMIN_ROLE`.
       */
      function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual override {
          if (role == DEFAULT_ADMIN_ROLE) {
              revert AccessControlEnforcedDefaultAdminRules();
          }
          super._setRoleAdmin(role, adminRole);
      }
  
      ///
      /// AccessControlDefaultAdminRules accessors
      ///
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function defaultAdmin() public view virtual returns (address) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          return $._currentDefaultAdmin;
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function pendingDefaultAdmin() public view virtual returns (address newAdmin, uint48 schedule) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          return ($._pendingDefaultAdmin, $._pendingDefaultAdminSchedule);
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function defaultAdminDelay() public view virtual returns (uint48) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          uint48 schedule = $._pendingDelaySchedule;
          return (_isScheduleSet(schedule) && _hasSchedulePassed(schedule)) ? $._pendingDelay : $._currentDelay;
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function pendingDefaultAdminDelay() public view virtual returns (uint48 newDelay, uint48 schedule) {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          schedule = $._pendingDelaySchedule;
          return (_isScheduleSet(schedule) && !_hasSchedulePassed(schedule)) ? ($._pendingDelay, schedule) : (0, 0);
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function defaultAdminDelayIncreaseWait() public view virtual returns (uint48) {
          return 5 days;
      }
  
      ///
      /// AccessControlDefaultAdminRules public and internal setters for defaultAdmin/pendingDefaultAdmin
      ///
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function beginDefaultAdminTransfer(address newAdmin) public virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _beginDefaultAdminTransfer(newAdmin);
      }
  
      /**
       * @dev See {beginDefaultAdminTransfer}.
       *
       * Internal function without access restriction.
       */
      function _beginDefaultAdminTransfer(address newAdmin) internal virtual {
          uint48 newSchedule = SafeCast.toUint48(block.timestamp) + defaultAdminDelay();
          _setPendingDefaultAdmin(newAdmin, newSchedule);
          emit DefaultAdminTransferScheduled(newAdmin, newSchedule);
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function cancelDefaultAdminTransfer() public virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _cancelDefaultAdminTransfer();
      }
  
      /**
       * @dev See {cancelDefaultAdminTransfer}.
       *
       * Internal function without access restriction.
       */
      function _cancelDefaultAdminTransfer() internal virtual {
          _setPendingDefaultAdmin(address(0), 0);
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function acceptDefaultAdminTransfer() public virtual {
          (address newDefaultAdmin, ) = pendingDefaultAdmin();
          if (_msgSender() != newDefaultAdmin) {
              // Enforce newDefaultAdmin explicit acceptance.
              revert AccessControlInvalidDefaultAdmin(_msgSender());
          }
          _acceptDefaultAdminTransfer();
      }
  
      /**
       * @dev See {acceptDefaultAdminTransfer}.
       *
       * Internal function without access restriction.
       */
      function _acceptDefaultAdminTransfer() internal virtual {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          (address newAdmin, uint48 schedule) = pendingDefaultAdmin();
          if (!_isScheduleSet(schedule) || !_hasSchedulePassed(schedule)) {
              revert AccessControlEnforcedDefaultAdminDelay(schedule);
          }
          _revokeRole(DEFAULT_ADMIN_ROLE, defaultAdmin());
          _grantRole(DEFAULT_ADMIN_ROLE, newAdmin);
          delete $._pendingDefaultAdmin;
          delete $._pendingDefaultAdminSchedule;
      }
  
      ///
      /// AccessControlDefaultAdminRules public and internal setters for defaultAdminDelay/pendingDefaultAdminDelay
      ///
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function changeDefaultAdminDelay(uint48 newDelay) public virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _changeDefaultAdminDelay(newDelay);
      }
  
      /**
       * @dev See {changeDefaultAdminDelay}.
       *
       * Internal function without access restriction.
       */
      function _changeDefaultAdminDelay(uint48 newDelay) internal virtual {
          uint48 newSchedule = SafeCast.toUint48(block.timestamp) + _delayChangeWait(newDelay);
          _setPendingDelay(newDelay, newSchedule);
          emit DefaultAdminDelayChangeScheduled(newDelay, newSchedule);
      }
  
      /**
       * @inheritdoc IAccessControlDefaultAdminRules
       */
      function rollbackDefaultAdminDelay() public virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _rollbackDefaultAdminDelay();
      }
  
      /**
       * @dev See {rollbackDefaultAdminDelay}.
       *
       * Internal function without access restriction.
       */
      function _rollbackDefaultAdminDelay() internal virtual {
          _setPendingDelay(0, 0);
      }
  
      /**
       * @dev Returns the amount of seconds to wait after the `newDelay` will
       * become the new {defaultAdminDelay}.
       *
       * The value returned guarantees that if the delay is reduced, it will go into effect
       * after a wait that honors the previously set delay.
       *
       * See {defaultAdminDelayIncreaseWait}.
       */
      function _delayChangeWait(uint48 newDelay) internal view virtual returns (uint48) {
          uint48 currentDelay = defaultAdminDelay();
  
          // When increasing the delay, we schedule the delay change to occur after a period of "new delay" has passed, up
          // to a maximum given by defaultAdminDelayIncreaseWait, by default 5 days. For example, if increasing from 1 day
          // to 3 days, the new delay will come into effect after 3 days. If increasing from 1 day to 10 days, the new
          // delay will come into effect after 5 days. The 5 day wait period is intended to be able to fix an error like
          // using milliseconds instead of seconds.
          //
          // When decreasing the delay, we wait the difference between "current delay" and "new delay". This guarantees
          // that an admin transfer cannot be made faster than "current delay" at the time the delay change is scheduled.
          // For example, if decreasing from 10 days to 3 days, the new delay will come into effect after 7 days.
          return
              newDelay > currentDelay
                  ? uint48(Math.min(newDelay, defaultAdminDelayIncreaseWait())) // no need to safecast, both inputs are uint48
                  : currentDelay - newDelay;
      }
  
      ///
      /// Private setters
      ///
  
      /**
       * @dev Setter of the tuple for pending admin and its schedule.
       *
       * May emit a DefaultAdminTransferCanceled event.
       */
      function _setPendingDefaultAdmin(address newAdmin, uint48 newSchedule) private {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          (, uint48 oldSchedule) = pendingDefaultAdmin();
  
          $._pendingDefaultAdmin = newAdmin;
          $._pendingDefaultAdminSchedule = newSchedule;
  
          // An `oldSchedule` from `pendingDefaultAdmin()` is only set if it hasn't been accepted.
          if (_isScheduleSet(oldSchedule)) {
              // Emit for implicit cancellations when another default admin was scheduled.
              emit DefaultAdminTransferCanceled();
          }
      }
  
      /**
       * @dev Setter of the tuple for pending delay and its schedule.
       *
       * May emit a DefaultAdminDelayChangeCanceled event.
       */
      function _setPendingDelay(uint48 newDelay, uint48 newSchedule) private {
          AccessControlDefaultAdminRulesStorage storage $ = _getAccessControlDefaultAdminRulesStorage();
          uint48 oldSchedule = $._pendingDelaySchedule;
  
          if (_isScheduleSet(oldSchedule)) {
              if (_hasSchedulePassed(oldSchedule)) {
                  // Materialize a virtual delay
                  $._currentDelay = $._pendingDelay;
              } else {
                  // Emit for implicit cancellations when another delay was scheduled.
                  emit DefaultAdminDelayChangeCanceled();
              }
          }
  
          $._pendingDelay = newDelay;
          $._pendingDelaySchedule = newSchedule;
      }
  
      ///
      /// Private helpers
      ///
  
      /**
       * @dev Defines if an `schedule` is considered set. For consistency purposes.
       */
      function _isScheduleSet(uint48 schedule) private pure returns (bool) {
          return schedule != 0;
      }
  
      /**
       * @dev Defines if an `schedule` is considered passed. For consistency purposes.
       */
      function _hasSchedulePassed(uint48 schedule) private view returns (bool) {
          return schedule < block.timestamp;
      }
  }
  
  // lib/zkevm-stb/src/L1Escrow.sol
  
   // forgefmt: disable-line
  
  /**
   * @title L1Escrow
   * @author sepyke.eth
   * @dev This contract is what keeps the L2Token backed up on the origin chain
   */
  contract L1Escrow is AccessControlDefaultAdminRulesUpgradeable, UUPSUpgradeable, PausableUpgradeable, PolygonERC20BridgeBaseUpgradeable {
      // ****************************
      // *         Libraries        *
      // ****************************
  
      using SafeERC20 for IERC20;
  
      // ****************************
      // *           Roles          *
      // ****************************
  
      /// @notice Escrow manager role identifier
      bytes32 public constant ESCROW_MANAGER_ROLE = keccak256("ESCROW_MANAGER_ROLE");
  
      // ****************************
      // *      ERC-7201 Storage    *
      // ****************************
  
      /// @custom:storage-location erc7201:polygon.storage.L1Escrow
      struct L1EscrowStorage {
          IERC20 originTokenAddress;
          IERC20 wrappedTokenAddress;
      }
  
      // keccak256(abi.encode(uint256(keccak256("polygon.storage.L1Escrow")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant L1EscrowStorageLocation = 0x6a7c854119a1deca2e55f2076d027a850cad94d8bd53c3053ddd031623861700;
  
      function _getL1EscrowStorage() private pure returns (L1EscrowStorage storage $) {
          assembly {
              $.slot := L1EscrowStorageLocation
          }
      }
  
      function originTokenAddress() public view returns (IERC20) {
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          return $.originTokenAddress;
      }
  
      function wrappedTokenAddress() public view returns (IERC20) {
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          return $.wrappedTokenAddress;
      }
  
      // ****************************
      // *           Event          *
      // ****************************
  
      event Withdraw(address recipient, uint256 amount);
  
      // ****************************
      // *        Initializer       *
      // ****************************
  
      /// @notice Disable initializer on deploy
      constructor() {
          _disableInitializers();
      }
  
      /**
       * @notice L1Escrow initializer
       * @param _admin The admin address
       * @param _manager The escrow manager address
       * @param _polygonZkEVMBridge Polygon ZkEVM bridge address
       * @param _counterpartContract Couterpart contract
       * @param _counterpartNetwork Couterpart network
       * @param _originTokenAddress Token address
       * @param _wrappedTokenAddress L2Token address on Polygon ZkEVM
       */
      function initialize(
          address _admin,
          address _manager,
          address _polygonZkEVMBridge,
          address _counterpartContract,
          uint32 _counterpartNetwork,
          address _originTokenAddress,
          address _wrappedTokenAddress
      ) public virtual initializer {
          // Inits
          __AccessControlDefaultAdminRules_init(3 days, _admin);
          __UUPSUpgradeable_init();
          __Pausable_init();
          __PolygonERC20BridgeBase_init(_polygonZkEVMBridge, _counterpartContract, _counterpartNetwork);
          _grantRole(ESCROW_MANAGER_ROLE, _manager);
  
          // Set storage
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          $.originTokenAddress = IERC20(_originTokenAddress);
          $.wrappedTokenAddress = IERC20(_wrappedTokenAddress);
      }
  
      // ****************************
      // *          Upgrade         *
      // ****************************
  
      /**
       * @dev Only the owner can upgrade the L1Escrow
       * @param _newVersion The contract address of a new version
       */
      function _authorizeUpgrade(address _newVersion) internal override onlyRole(DEFAULT_ADMIN_ROLE) {}
  
      // ****************************
      // *          Pause           *
      // ****************************
  
      /**
       * @notice Pause the L1Escrow
       * @dev Only EMERGENCY_ROLE can pause the L1Escrow
       */
      function pause() external virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _pause();
      }
  
      /**
       * @notice Resume the L1Escrow
       * @dev Only EMERGENCY_ROLE can resume the L1Escrow
       */
      function unpause() external virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          _unpause();
      }
  
      // ****************************
      // *           Bridge         *
      // ****************************
  
      /**
       * @dev Handle the reception of the tokens
       * @param amount Token amount
       */
      function _receiveTokens(uint256 amount) internal virtual override whenNotPaused {
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          $.originTokenAddress.safeTransferFrom(msg.sender, address(this), amount);
      }
  
      /**
       * @dev Handle the transfer of the tokens
       * @param destinationAddress Address destination that will receive the tokens on the other network
       * @param amount Token amount
       */
      function _transferTokens(address destinationAddress, uint256 amount) internal virtual override whenNotPaused {
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          $.originTokenAddress.safeTransfer(destinationAddress, amount);
      }
  
      // ****************************
      // *          Manager         *
      // ****************************
  
      /**
       * @dev Escrow manager can withdraw the token backing
       * @param _recipient the recipient address
       * @param _amount The amount of token
       */
      function withdraw(address _recipient, uint256 _amount) external virtual onlyRole(ESCROW_MANAGER_ROLE) whenNotPaused {
          L1EscrowStorage storage $ = _getL1EscrowStorage();
          $.originTokenAddress.safeTransfer(_recipient, _amount);
          emit Withdraw(_recipient, _amount);
      }
  }
  
  // src/L1YearnEscrow.sol
  
  /**
   * @title L1YearnEscrow
   * @author yearn.fi
   * @dev L1 escrow that will deploy the assets to a Yearn vault to earn yield.
   */
  contract L1YearnEscrow is L1Escrow {
      // ****************************
      // *         Libraries        *
      // ****************************
  
      using SafeERC20 for IERC20;
  
      // ****************************
      // *         Events         *
      // **************************
  
      /**
       * @dev Emitted when the Vault is updated.
       */
      event UpdateVaultAddress(address indexed newVaultAddress);
  
      /**
       * @dev Emitted when the minimum buffer is updated.
       */
      event UpdateMinimumBuffer(uint256 newMinimumBuffer);
  
      // ****************************
      // *      ERC-7201 Storage    *
      // **************************
  
      /// @custom:storage-location erc7201:yearn.storage.vault
      struct VaultStorage {
          IVault vaultAddress;
          uint256 minimumBuffer;
      }
  
      // keccak256(abi.encode(uint256(keccak256("yearn.storage.vault")) - 1)) & ~bytes32(uint256(0xff))
      bytes32 private constant VaultStorageLocation =
          0xff1003c0fa1e6064b336121b432b179c1b66edc6a2d9068cade1ea1361605700;
  
      function _getVaultStorage() private pure returns (VaultStorage storage $) {
          assembly {
              $.slot := VaultStorageLocation
          }
      }
  
      function vaultAddress() public view returns (address) {
          VaultStorage storage $ = _getVaultStorage();
          return address($.vaultAddress);
      }
  
      function minimumBuffer() public view returns (uint256) {
          VaultStorage storage $ = _getVaultStorage();
          return $.minimumBuffer;
      }
  
      // ****************************
      // *        Initializer       *
      // ****************************
  
      /**
       * @notice L1YearnEscrow initializer
       * @param _admin The admin address
       * @param _manager The escrow manager address
       * @param _polygonZkEVMBridge Polygon ZkEVM bridge address
       * @param _counterpartContract Counterpart contract
       * @param _counterpartNetwork Counterpart network
       * @param _originTokenAddress Token address
       * @param _wrappedTokenAddress L2Token address on Polygon ZkEVM
       * @param _vaultAddress Address of the vault to use.
       */
      function initialize(
          address _admin,
          address _manager,
          address _polygonZkEVMBridge,
          address _counterpartContract,
          uint32 _counterpartNetwork,
          address _originTokenAddress,
          address _wrappedTokenAddress,
          address _vaultAddress
      ) public virtual initializer {
          // Initialize the default escrow.
          initialize(
              _admin,
              _manager,
              _polygonZkEVMBridge,
              _counterpartContract,
              _counterpartNetwork,
              _originTokenAddress,
              _wrappedTokenAddress
          );
  
          VaultStorage storage $ = _getVaultStorage();
          // Max approve the vault
          originTokenAddress().forceApprove(_vaultAddress, 2 ** 256 - 1);
          // Set the vault variable
          $.vaultAddress = IVault(_vaultAddress);
      }
  
      // ****************************
      // *           Bridge         *
      // ****************************
  
      /**
       * @dev Handle the reception of the tokens
       * @param amount Token amount
       */
      function _receiveTokens(
          uint256 amount
      ) internal virtual override whenNotPaused {
          originTokenAddress().safeTransferFrom(
              msg.sender,
              address(this),
              amount
          );
  
          VaultStorage storage $ = _getVaultStorage();
          uint256 _minimumBuffer = $.minimumBuffer;
          // Deposit to the vault if above buffer
          if (_minimumBuffer != 0) {
              uint256 underlyingBalance = originTokenAddress().balanceOf(
                  address(this)
              );
  
              if (underlyingBalance <= _minimumBuffer) return;
  
              unchecked {
                  amount = underlyingBalance - _minimumBuffer;
              }
          }
  
          IVault _vault = $.vaultAddress;
          uint256 maxDeposit = _vault.maxDeposit(address(this));
          if (maxDeposit < amount) {
              if (maxDeposit == 0) return;
              amount = maxDeposit;
          }
  
          _vault.deposit(amount, address(this));
      }
  
      /**
       * @dev Handle the transfer of the tokens. Will send shares instead of
       *      the underlying asset if the vault is illiquid.
       * @param destinationAddress Address destination that will receive the tokens on the other network
       * @param amount Token amount
       */
      function _transferTokens(
          address destinationAddress,
          uint256 amount
      ) internal virtual override whenNotPaused {
          IERC20 originToken = originTokenAddress();
  
          // Check if there is enough buffer.
          uint256 underlyingBalance = originToken.balanceOf(address(this));
          if (underlyingBalance >= amount) {
              // Only use buffer if it covers the full amount.
              originToken.safeTransfer(destinationAddress, amount);
              return;
          }
  
          // Check if the vault will allow for a full withdraw.
          IVault _vault = _getVaultStorage().vaultAddress;
          uint256 maxWithdraw = _vault.maxWithdraw(address(this));
          // If liquidity will not allow for a full withdraw.
          if (amount > maxWithdraw) {
              // First use any loose balance.
              if (underlyingBalance != 0) {
                  originToken.safeTransfer(destinationAddress, underlyingBalance);
                  unchecked {
                      amount = amount - underlyingBalance;
                  }
              }
  
              // Check again to account for if there was loose underlying
              if (amount > maxWithdraw) {
                  // Send an equivalent amount of shares for the difference.
                  uint256 shares = _vault.convertToShares(amount - maxWithdraw);
                  _vault.transfer(destinationAddress, shares);
                  if (maxWithdraw == 0) return;
                  amount = maxWithdraw;
              }
          }
  
          // Withdraw from vault to receiver.
          _vault.withdraw(amount, destinationAddress, address(this));
      }
  
      // ****************************
      // *          Manager         *
      // ****************************
  
      /**
       * @dev Escrow manager can withdraw the token backing
       * @param _recipient the recipient address
       * @param _amount The amount of token in underlying
       */
      function withdraw(
          address _recipient,
          uint256 _amount
      ) external virtual override onlyRole(ESCROW_MANAGER_ROLE) whenNotPaused {
          IVault _vault = _getVaultStorage().vaultAddress;
          // Transfer the equivalent amount of vault shares
          uint256 shares = _vault.convertToShares(_amount);
          _vault.transfer(_recipient, shares);
  
          emit Withdraw(_recipient, _amount);
      }
  
      // ****************************
      // *          Admin         *
      // ****************************
  
      /**
       * @dev Update the vault to deploy funds into.
       *      Will fully withdraw from the old vault.
       * @param _vaultAddress Address of the new vault to use.
       */
      function updateVault(
          address _vaultAddress
      ) external virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          VaultStorage storage $ = _getVaultStorage();
          IVault oldVault = $.vaultAddress;
          IERC20 originToken = originTokenAddress();
  
          // If re-initializing to a new vault address.
          if (address(oldVault) != address(0)) {
              // Lower allowance to 0
              originToken.forceApprove(address(oldVault), 0);
  
              uint256 balance = oldVault.balanceOf(address(this));
              // Withdraw the full balance of the current vault.
              if (balance != 0) {
                  oldVault.redeem(balance, address(this), address(this));
              }
          }
  
          // Migrate to new vault if applicable
          if (_vaultAddress != address(0)) {
              // Max approve the new vault
              originToken.forceApprove(_vaultAddress, 2 ** 256 - 1);
  
              // Deposit any loose funds over minimum buffer
              uint256 balance = originToken.balanceOf(address(this));
              uint256 _minimumBuffer = $.minimumBuffer;
              if (balance > _minimumBuffer)
                  IVault(_vaultAddress).deposit(
                      balance - _minimumBuffer,
                      address(this)
                  );
          }
  
          // Update Storage
          $.vaultAddress = IVault(_vaultAddress);
          emit UpdateVaultAddress(_vaultAddress);
      }
  
      /**
       * @dev Update the minimum buffer to keep in the escrow.
       * @param _minimumBuffer The new minimum buffer to enforce.
       */
      function updateMinimumBuffer(
          uint256 _minimumBuffer
      ) external virtual onlyRole(DEFAULT_ADMIN_ROLE) {
          VaultStorage storage $ = _getVaultStorage();
          $.minimumBuffer = _minimumBuffer;
  
          emit UpdateMinimumBuffer(_minimumBuffer);
      }
  
      /**
       * @notice Rebalance the funds to support the minimum buffer.
       * @dev Will revert if the difference is over the maxDeposit.
       */
      function rebalance() external virtual {
          VaultStorage storage $ = _getVaultStorage();
          uint256 _minimumBuffer = $.minimumBuffer;
          uint256 balance = originTokenAddress().balanceOf(address(this));
  
          if (balance > _minimumBuffer) {
              // Deposit the difference.
              $.vaultAddress.deposit(balance - _minimumBuffer, address(this));
          } else if (balance < _minimumBuffer) {
              // Withdraw the difference
              uint256 diff = _minimumBuffer - balance;
              uint256 available = $.vaultAddress.maxWithdraw(address(this));
  
              // Withdraw the min between the difference or what is available.
              diff = diff > available ? available : diff;
              $.vaultAddress.withdraw(diff, address(this), address(this));
          }
      }
  }