Created
February 28, 2026 17:09
-
-
Save BeadtMODE/22d65675036ccaa37c0e50b6ed3165af to your computer and use it in GitHub Desktop.
Created using remix-ide: Realtime Ethereum Contract Compiler and Runtime. Load this file by pasting this gists URL or ID at https://remix.ethereum.org/#version=soljson-v0.8.34+commit.80d5c536.js&optimize=undefined&runs=200&gist=
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (access/AccessControl.sol) | |
| pragma solidity ^0.8.20; | |
| import {IAccessControl} from "./IAccessControl.sol"; | |
| import {Context} from "../utils/Context.sol"; | |
| import {IERC165, ERC165} from "../utils/introspection/ERC165.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 AccessControl is Context, IAccessControl, ERC165 { | |
| struct RoleData { | |
| mapping(address account => bool) hasRole; | |
| bytes32 adminRole; | |
| } | |
| mapping(bytes32 role => RoleData) private _roles; | |
| bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; | |
| /** | |
| * @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); | |
| _; | |
| } | |
| /// @inheritdoc IERC165 | |
| 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) { | |
| 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) { | |
| 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 { | |
| 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) { | |
| if (!hasRole(role, account)) { | |
| _roles[role].hasRole[account] = true; | |
| emit RoleGranted(role, account, _msgSender()); | |
| return true; | |
| } else { | |
| return false; | |
| } | |
| } | |
| /** | |
| * @dev Attempts to revoke `role` from `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) { | |
| if (hasRole(role, account)) { | |
| _roles[role].hasRole[account] = false; | |
| emit RoleRevoked(role, account, _msgSender()); | |
| return true; | |
| } else { | |
| return false; | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (access/IAccessControl.sol) | |
| pragma solidity >=0.8.4; | |
| /** | |
| * @dev External interface of AccessControl declared to support ERC-165 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 to signal 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. This account bears the admin role (for the granted role). | |
| * Expected in cases where the role was granted using the internal {AccessControl-_grantRole}. | |
| */ | |
| 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; | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (access/manager/AccessManaged.sol) | |
| pragma solidity ^0.8.20; | |
| import {AuthorityUtils} from "./AuthorityUtils.sol"; | |
| import {IAccessManager} from "./IAccessManager.sol"; | |
| import {IAccessManaged} from "./IAccessManaged.sol"; | |
| import {Context} from "../../utils/Context.sol"; | |
| /** | |
| * @dev This contract module makes available a {restricted} modifier. Functions decorated with this modifier will be | |
| * permissioned according to an "authority": a contract like {AccessManager} that follows the {IAuthority} interface, | |
| * implementing a policy that allows certain callers to access certain functions. | |
| * | |
| * IMPORTANT: The `restricted` modifier should never be used on `internal` functions, judiciously used in `public` | |
| * functions, and ideally only used in `external` functions. See {restricted}. | |
| */ | |
| abstract contract AccessManaged is Context, IAccessManaged { | |
| address private _authority; | |
| bool private _consumingSchedule; | |
| /** | |
| * @dev Initializes the contract connected to an initial authority. | |
| */ | |
| constructor(address initialAuthority) { | |
| _setAuthority(initialAuthority); | |
| } | |
| /** | |
| * @dev Restricts access to a function as defined by the connected Authority for this contract and the | |
| * caller and selector of the function that entered the contract. | |
| * | |
| * [IMPORTANT] | |
| * ==== | |
| * In general, this modifier should only be used on `external` functions. It is okay to use it on `public` | |
| * functions that are used as external entry points and are not called internally. Unless you know what you're | |
| * doing, it should never be used on `internal` functions. Failure to follow these rules can have critical security | |
| * implications! This is because the permissions are determined by the function that entered the contract, i.e. the | |
| * function at the bottom of the call stack, and not the function where the modifier is visible in the source code. | |
| * ==== | |
| * | |
| * [WARNING] | |
| * ==== | |
| * Avoid adding this modifier to the https://docs.soliditylang.org/en/v0.8.20/contracts.html#receive-ether-function[`receive()`] | |
| * function or the https://docs.soliditylang.org/en/v0.8.20/contracts.html#fallback-function[`fallback()`]. These | |
| * functions are the only execution paths where a function selector cannot be unambiguously determined from the calldata | |
| * since the selector defaults to `0x00000000` in the `receive()` function and similarly in the `fallback()` function | |
| * if no calldata is provided. (See {_checkCanCall}). | |
| * | |
| * The `receive()` function will always panic whereas the `fallback()` may panic depending on the calldata length. | |
| * ==== | |
| */ | |
| modifier restricted() { | |
| _checkCanCall(_msgSender(), _msgData()); | |
| _; | |
| } | |
| /// @inheritdoc IAccessManaged | |
| function authority() public view virtual returns (address) { | |
| return _authority; | |
| } | |
| /// @inheritdoc IAccessManaged | |
| function setAuthority(address newAuthority) public virtual { | |
| address caller = _msgSender(); | |
| if (caller != authority()) { | |
| revert AccessManagedUnauthorized(caller); | |
| } | |
| if (newAuthority.code.length == 0) { | |
| revert AccessManagedInvalidAuthority(newAuthority); | |
| } | |
| _setAuthority(newAuthority); | |
| } | |
| /// @inheritdoc IAccessManaged | |
| function isConsumingScheduledOp() public view returns (bytes4) { | |
| return _consumingSchedule ? this.isConsumingScheduledOp.selector : bytes4(0); | |
| } | |
| /** | |
| * @dev Transfers control to a new authority. Internal function with no access restriction. Allows bypassing the | |
| * permissions set by the current authority. | |
| */ | |
| function _setAuthority(address newAuthority) internal virtual { | |
| _authority = newAuthority; | |
| emit AuthorityUpdated(newAuthority); | |
| } | |
| /** | |
| * @dev Reverts if the caller is not allowed to call the function identified by a selector. Panics if the calldata | |
| * is less than 4 bytes long. | |
| */ | |
| function _checkCanCall(address caller, bytes calldata data) internal virtual { | |
| (bool immediate, uint32 delay) = AuthorityUtils.canCallWithDelay( | |
| authority(), | |
| caller, | |
| address(this), | |
| bytes4(data[0:4]) | |
| ); | |
| if (!immediate) { | |
| if (delay > 0) { | |
| _consumingSchedule = true; | |
| IAccessManager(authority()).consumeScheduledOp(caller, data); | |
| _consumingSchedule = false; | |
| } else { | |
| revert AccessManagedUnauthorized(caller); | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (access/manager/IAccessManaged.sol) | |
| pragma solidity >=0.8.4; | |
| interface IAccessManaged { | |
| /** | |
| * @dev Authority that manages this contract was updated. | |
| */ | |
| event AuthorityUpdated(address authority); | |
| error AccessManagedUnauthorized(address caller); | |
| error AccessManagedRequiredDelay(address caller, uint32 delay); | |
| error AccessManagedInvalidAuthority(address authority); | |
| /** | |
| * @dev Returns the current authority. | |
| */ | |
| function authority() external view returns (address); | |
| /** | |
| * @dev Transfers control to a new authority. The caller must be the current authority. | |
| */ | |
| function setAuthority(address) external; | |
| /** | |
| * @dev Returns true only in the context of a delayed restricted call, at the moment that the scheduled operation is | |
| * being consumed. Prevents denial of service for delayed restricted calls in the case that the contract performs | |
| * attacker controlled calls. | |
| */ | |
| function isConsumingScheduledOp() external view returns (bytes4); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (access/manager/IAccessManager.sol) | |
| pragma solidity >=0.8.4; | |
| interface IAccessManager { | |
| /** | |
| * @dev A delayed operation was scheduled. | |
| */ | |
| event OperationScheduled( | |
| bytes32 indexed operationId, | |
| uint32 indexed nonce, | |
| uint48 schedule, | |
| address caller, | |
| address target, | |
| bytes data | |
| ); | |
| /** | |
| * @dev A scheduled operation was executed. | |
| */ | |
| event OperationExecuted(bytes32 indexed operationId, uint32 indexed nonce); | |
| /** | |
| * @dev A scheduled operation was canceled. | |
| */ | |
| event OperationCanceled(bytes32 indexed operationId, uint32 indexed nonce); | |
| /** | |
| * @dev Informational labelling for a roleId. | |
| */ | |
| event RoleLabel(uint64 indexed roleId, string label); | |
| /** | |
| * @dev Emitted when `account` is granted `roleId`. | |
| * | |
| * NOTE: The meaning of the `since` argument depends on the `newMember` argument. | |
| * If the role is granted to a new member, the `since` argument indicates when the account becomes a member of the role, | |
| * otherwise it indicates the execution delay for this account and roleId is updated. | |
| */ | |
| event RoleGranted(uint64 indexed roleId, address indexed account, uint32 delay, uint48 since, bool newMember); | |
| /** | |
| * @dev Emitted when `account` membership or `roleId` is revoked. Unlike granting, revoking is instantaneous. | |
| */ | |
| event RoleRevoked(uint64 indexed roleId, address indexed account); | |
| /** | |
| * @dev Role acting as admin over a given `roleId` is updated. | |
| */ | |
| event RoleAdminChanged(uint64 indexed roleId, uint64 indexed admin); | |
| /** | |
| * @dev Role acting as guardian over a given `roleId` is updated. | |
| */ | |
| event RoleGuardianChanged(uint64 indexed roleId, uint64 indexed guardian); | |
| /** | |
| * @dev Grant delay for a given `roleId` will be updated to `delay` when `since` is reached. | |
| */ | |
| event RoleGrantDelayChanged(uint64 indexed roleId, uint32 delay, uint48 since); | |
| /** | |
| * @dev Target mode is updated (true = closed, false = open). | |
| */ | |
| event TargetClosed(address indexed target, bool closed); | |
| /** | |
| * @dev Role required to invoke `selector` on `target` is updated to `roleId`. | |
| */ | |
| event TargetFunctionRoleUpdated(address indexed target, bytes4 selector, uint64 indexed roleId); | |
| /** | |
| * @dev Admin delay for a given `target` will be updated to `delay` when `since` is reached. | |
| */ | |
| event TargetAdminDelayUpdated(address indexed target, uint32 delay, uint48 since); | |
| error AccessManagerAlreadyScheduled(bytes32 operationId); | |
| error AccessManagerNotScheduled(bytes32 operationId); | |
| error AccessManagerNotReady(bytes32 operationId); | |
| error AccessManagerExpired(bytes32 operationId); | |
| error AccessManagerLockedRole(uint64 roleId); | |
| error AccessManagerBadConfirmation(); | |
| error AccessManagerUnauthorizedAccount(address msgsender, uint64 roleId); | |
| error AccessManagerUnauthorizedCall(address caller, address target, bytes4 selector); | |
| error AccessManagerUnauthorizedConsume(address target); | |
| error AccessManagerUnauthorizedCancel(address msgsender, address caller, address target, bytes4 selector); | |
| error AccessManagerInvalidInitialAdmin(address initialAdmin); | |
| /** | |
| * @dev Check if an address (`caller`) is authorised to call a given function on a given contract directly (with | |
| * no restriction). Additionally, it returns the delay needed to perform the call indirectly through the {schedule} | |
| * & {execute} workflow. | |
| * | |
| * This function is usually called by the targeted contract to control immediate execution of restricted functions. | |
| * Therefore we only return true if the call can be performed without any delay. If the call is subject to a | |
| * previously set delay (not zero), then the function should return false and the caller should schedule the operation | |
| * for future execution. | |
| * | |
| * If `allowed` is true, the delay can be disregarded and the operation can be immediately executed, otherwise | |
| * the operation can be executed if and only if delay is greater than 0. | |
| * | |
| * NOTE: The IAuthority interface does not include the `uint32` delay. This is an extension of that interface that | |
| * is backward compatible. Some contracts may thus ignore the second return argument. In that case they will fail | |
| * to identify the indirect workflow, and will consider calls that require a delay to be forbidden. | |
| * | |
| * NOTE: This function does not report the permissions of the admin functions in the manager itself. These are defined by the | |
| * {AccessManager} documentation. | |
| */ | |
| function canCall( | |
| address caller, | |
| address target, | |
| bytes4 selector | |
| ) external view returns (bool allowed, uint32 delay); | |
| /** | |
| * @dev Expiration delay for scheduled proposals. Defaults to 1 week. | |
| * | |
| * IMPORTANT: Avoid overriding the expiration with 0. Otherwise every contract proposal will be expired immediately, | |
| * disabling any scheduling usage. | |
| */ | |
| function expiration() external view returns (uint32); | |
| /** | |
| * @dev Minimum setback for all delay updates, with the exception of execution delays. It | |
| * can be increased without setback (and reset via {revokeRole} in the case event of an | |
| * accidental increase). Defaults to 5 days. | |
| */ | |
| function minSetback() external view returns (uint32); | |
| /** | |
| * @dev Get whether the contract is closed disabling any access. Otherwise role permissions are applied. | |
| * | |
| * NOTE: When the manager itself is closed, admin functions are still accessible to avoid locking the contract. | |
| */ | |
| function isTargetClosed(address target) external view returns (bool); | |
| /** | |
| * @dev Get the role required to call a function. | |
| */ | |
| function getTargetFunctionRole(address target, bytes4 selector) external view returns (uint64); | |
| /** | |
| * @dev Get the admin delay for a target contract. Changes to contract configuration are subject to this delay. | |
| */ | |
| function getTargetAdminDelay(address target) external view returns (uint32); | |
| /** | |
| * @dev Get the id of the role that acts as an admin for the given role. | |
| * | |
| * The admin permission is required to grant the role, revoke the role and update the execution delay to execute | |
| * an operation that is restricted to this role. | |
| */ | |
| function getRoleAdmin(uint64 roleId) external view returns (uint64); | |
| /** | |
| * @dev Get the role that acts as a guardian for a given role. | |
| * | |
| * The guardian permission allows canceling operations that have been scheduled under the role. | |
| */ | |
| function getRoleGuardian(uint64 roleId) external view returns (uint64); | |
| /** | |
| * @dev Get the role current grant delay. | |
| * | |
| * Its value may change at any point without an event emitted following a call to {setGrantDelay}. | |
| * Changes to this value, including effect timepoint are notified in advance by the {RoleGrantDelayChanged} event. | |
| */ | |
| function getRoleGrantDelay(uint64 roleId) external view returns (uint32); | |
| /** | |
| * @dev Get the access details for a given account for a given role. These details include the timepoint at which | |
| * membership becomes active, and the delay applied to all operation by this user that requires this permission | |
| * level. | |
| * | |
| * Returns: | |
| * [0] Timestamp at which the account membership becomes valid. 0 means role is not granted. | |
| * [1] Current execution delay for the account. | |
| * [2] Pending execution delay for the account. | |
| * [3] Timestamp at which the pending execution delay will become active. 0 means no delay update is scheduled. | |
| */ | |
| function getAccess( | |
| uint64 roleId, | |
| address account | |
| ) external view returns (uint48 since, uint32 currentDelay, uint32 pendingDelay, uint48 effect); | |
| /** | |
| * @dev Check if a given account currently has the permission level corresponding to a given role. Note that this | |
| * permission might be associated with an execution delay. {getAccess} can provide more details. | |
| */ | |
| function hasRole(uint64 roleId, address account) external view returns (bool isMember, uint32 executionDelay); | |
| /** | |
| * @dev Give a label to a role, for improved role discoverability by UIs. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {RoleLabel} event. | |
| */ | |
| function labelRole(uint64 roleId, string calldata label) external; | |
| /** | |
| * @dev Add `account` to `roleId`, or change its execution delay. | |
| * | |
| * This gives the account the authorization to call any function that is restricted to this role. An optional | |
| * execution delay (in seconds) can be set. If that delay is non 0, the user is required to schedule any operation | |
| * that is restricted to members of this role. The user will only be able to execute the operation after the delay has | |
| * passed, before it has expired. During this period, admin and guardians can cancel the operation (see {cancel}). | |
| * | |
| * If the account has already been granted this role, the execution delay will be updated. This update is not | |
| * immediate and follows the delay rules. For example, if a user currently has a delay of 3 hours, and this is | |
| * called to reduce that delay to 1 hour, the new delay will take some time to take effect, enforcing that any | |
| * operation executed in the 3 hours that follows this update was indeed scheduled before this update. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be an admin for the role (see {getRoleAdmin}) | |
| * - granted role must not be the `PUBLIC_ROLE` | |
| * | |
| * Emits a {RoleGranted} event. | |
| */ | |
| function grantRole(uint64 roleId, address account, uint32 executionDelay) external; | |
| /** | |
| * @dev Remove an account from a role, with immediate effect. If the account does not have the role, this call has | |
| * no effect. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be an admin for the role (see {getRoleAdmin}) | |
| * - revoked role must not be the `PUBLIC_ROLE` | |
| * | |
| * Emits a {RoleRevoked} event if the account had the role. | |
| */ | |
| function revokeRole(uint64 roleId, address account) external; | |
| /** | |
| * @dev Renounce role permissions for the calling account with immediate effect. If the sender is not in | |
| * the role this call has no effect. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be `callerConfirmation`. | |
| * | |
| * Emits a {RoleRevoked} event if the account had the role. | |
| */ | |
| function renounceRole(uint64 roleId, address callerConfirmation) external; | |
| /** | |
| * @dev Change admin role for a given role. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {RoleAdminChanged} event | |
| */ | |
| function setRoleAdmin(uint64 roleId, uint64 admin) external; | |
| /** | |
| * @dev Change guardian role for a given role. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {RoleGuardianChanged} event | |
| */ | |
| function setRoleGuardian(uint64 roleId, uint64 guardian) external; | |
| /** | |
| * @dev Update the delay for granting a `roleId`. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {RoleGrantDelayChanged} event. | |
| */ | |
| function setGrantDelay(uint64 roleId, uint32 newDelay) external; | |
| /** | |
| * @dev Set the role required to call functions identified by the `selectors` in the `target` contract. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {TargetFunctionRoleUpdated} event per selector. | |
| */ | |
| function setTargetFunctionRole(address target, bytes4[] calldata selectors, uint64 roleId) external; | |
| /** | |
| * @dev Set the delay for changing the configuration of a given target contract. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {TargetAdminDelayUpdated} event. | |
| */ | |
| function setTargetAdminDelay(address target, uint32 newDelay) external; | |
| /** | |
| * @dev Set the closed flag for a contract. | |
| * | |
| * Closing the manager itself won't disable access to admin methods to avoid locking the contract. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| * | |
| * Emits a {TargetClosed} event. | |
| */ | |
| function setTargetClosed(address target, bool closed) external; | |
| /** | |
| * @dev Return the timepoint at which a scheduled operation will be ready for execution. This returns 0 if the | |
| * operation is not yet scheduled, has expired, was executed, or was canceled. | |
| */ | |
| function getSchedule(bytes32 id) external view returns (uint48); | |
| /** | |
| * @dev Return the nonce for the latest scheduled operation with a given id. Returns 0 if the operation has never | |
| * been scheduled. | |
| */ | |
| function getNonce(bytes32 id) external view returns (uint32); | |
| /** | |
| * @dev Schedule a delayed operation for future execution, and return the operation identifier. It is possible to | |
| * choose the timestamp at which the operation becomes executable as long as it satisfies the execution delays | |
| * required for the caller. The special value zero will automatically set the earliest possible time. | |
| * | |
| * Returns the `operationId` that was scheduled. Since this value is a hash of the parameters, it can reoccur when | |
| * the same parameters are used; if this is relevant, the returned `nonce` can be used to uniquely identify this | |
| * scheduled operation from other occurrences of the same `operationId` in invocations of {execute} and {cancel}. | |
| * | |
| * Emits a {OperationScheduled} event. | |
| * | |
| * NOTE: It is not possible to concurrently schedule more than one operation with the same `target` and `data`. If | |
| * this is necessary, a random byte can be appended to `data` to act as a salt that will be ignored by the target | |
| * contract if it is using standard Solidity ABI encoding. | |
| */ | |
| function schedule( | |
| address target, | |
| bytes calldata data, | |
| uint48 when | |
| ) external returns (bytes32 operationId, uint32 nonce); | |
| /** | |
| * @dev Execute a function that is delay restricted, provided it was properly scheduled beforehand, or the | |
| * execution delay is 0. | |
| * | |
| * Returns the nonce that identifies the previously scheduled operation that is executed, or 0 if the | |
| * operation wasn't previously scheduled (if the caller doesn't have an execution delay). | |
| * | |
| * Emits an {OperationExecuted} event only if the call was scheduled and delayed. | |
| */ | |
| function execute(address target, bytes calldata data) external payable returns (uint32); | |
| /** | |
| * @dev Cancel a scheduled (delayed) operation. Returns the nonce that identifies the previously scheduled | |
| * operation that is cancelled. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be the proposer, a guardian of the targeted function, or a global admin | |
| * | |
| * Emits a {OperationCanceled} event. | |
| */ | |
| function cancel(address caller, address target, bytes calldata data) external returns (uint32); | |
| /** | |
| * @dev Consume a scheduled operation targeting the caller. If such an operation exists, mark it as consumed | |
| * (emit an {OperationExecuted} event and clean the state). Otherwise, throw an error. | |
| * | |
| * This is useful for contract that want to enforce that calls targeting them were scheduled on the manager, | |
| * with all the verifications that it implies. | |
| * | |
| * Emit a {OperationExecuted} event. | |
| */ | |
| function consumeScheduledOp(address caller, bytes calldata data) external; | |
| /** | |
| * @dev Hashing function for delayed operations. | |
| */ | |
| function hashOperation(address caller, address target, bytes calldata data) external view returns (bytes32); | |
| /** | |
| * @dev Changes the authority of a target managed by this manager instance. | |
| * | |
| * Requirements: | |
| * | |
| * - the caller must be a global admin | |
| */ | |
| function updateAuthority(address target, address newAuthority) external; | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol) | |
| pragma solidity ^0.8.20; | |
| import {Context} from "../utils/Context.sol"; | |
| /** | |
| * @dev Contract module which provides a basic access control mechanism, where | |
| * there is an account (an owner) that can be granted exclusive access to | |
| * specific functions. | |
| * | |
| * The initial owner is set to the address provided by the deployer. This can | |
| * later be changed with {transferOwnership}. | |
| * | |
| * This module is used through inheritance. It will make available the modifier | |
| * `onlyOwner`, which can be applied to your functions to restrict their use to | |
| * the owner. | |
| */ | |
| abstract contract Ownable is Context { | |
| address private _owner; | |
| /** | |
| * @dev The caller account is not authorized to perform an operation. | |
| */ | |
| error OwnableUnauthorizedAccount(address account); | |
| /** | |
| * @dev The owner is not a valid owner account. (eg. `address(0)`) | |
| */ | |
| error OwnableInvalidOwner(address owner); | |
| event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); | |
| /** | |
| * @dev Initializes the contract setting the address provided by the deployer as the initial owner. | |
| */ | |
| constructor(address initialOwner) { | |
| if (initialOwner == address(0)) { | |
| revert OwnableInvalidOwner(address(0)); | |
| } | |
| _transferOwnership(initialOwner); | |
| } | |
| /** | |
| * @dev Throws if called by any account other than the owner. | |
| */ | |
| modifier onlyOwner() { | |
| _checkOwner(); | |
| _; | |
| } | |
| /** | |
| * @dev Returns the address of the current owner. | |
| */ | |
| function owner() public view virtual returns (address) { | |
| return _owner; | |
| } | |
| /** | |
| * @dev Throws if the sender is not the owner. | |
| */ | |
| function _checkOwner() internal view virtual { | |
| if (owner() != _msgSender()) { | |
| revert OwnableUnauthorizedAccount(_msgSender()); | |
| } | |
| } | |
| /** | |
| * @dev Leaves the contract without owner. It will not be possible to call | |
| * `onlyOwner` functions. Can only be called by the current owner. | |
| * | |
| * NOTE: Renouncing ownership will leave the contract without an owner, | |
| * thereby disabling any functionality that is only available to the owner. | |
| */ | |
| function renounceOwnership() public virtual onlyOwner { | |
| _transferOwnership(address(0)); | |
| } | |
| /** | |
| * @dev Transfers ownership of the contract to a new account (`newOwner`). | |
| * Can only be called by the current owner. | |
| */ | |
| function transferOwnership(address newOwner) public virtual onlyOwner { | |
| if (newOwner == address(0)) { | |
| revert OwnableInvalidOwner(address(0)); | |
| } | |
| _transferOwnership(newOwner); | |
| } | |
| /** | |
| * @dev Transfers ownership of the contract to a new account (`newOwner`). | |
| * Internal function without access restriction. | |
| */ | |
| function _transferOwnership(address newOwner) internal virtual { | |
| address oldOwner = _owner; | |
| _owner = newOwner; | |
| emit OwnershipTransferred(oldOwner, newOwner); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (account/Account.sol) | |
| pragma solidity ^0.8.20; | |
| import {PackedUserOperation, IAccount, IEntryPoint} from "../interfaces/draft-IERC4337.sol"; | |
| import {ERC4337Utils} from "./utils/draft-ERC4337Utils.sol"; | |
| import {AbstractSigner} from "../utils/cryptography/signers/AbstractSigner.sol"; | |
| /** | |
| * @dev A simple ERC4337 account implementation. This base implementation only includes the minimal logic to process | |
| * user operations. | |
| * | |
| * Developers must implement the {AbstractSigner-_rawSignatureValidation} function to define the account's validation logic. | |
| * | |
| * NOTE: This core account doesn't include any mechanism for performing arbitrary external calls. This is an essential | |
| * feature that all Account should have. We leave it up to the developers to implement the mechanism of their choice. | |
| * Common choices include ERC-6900, ERC-7579 and ERC-7821 (among others). | |
| * | |
| * IMPORTANT: Implementing a mechanism to validate signatures is a security-sensitive operation as it may allow an | |
| * attacker to bypass the account's security measures. Check out {SignerECDSA}, {SignerP256}, or {SignerRSA} for | |
| * digital signature validation implementations. | |
| * | |
| * @custom:stateless | |
| */ | |
| abstract contract Account is AbstractSigner, IAccount { | |
| /** | |
| * @dev Unauthorized call to the account. | |
| */ | |
| error AccountUnauthorized(address sender); | |
| /** | |
| * @dev Revert if the caller is not the entry point or the account itself. | |
| */ | |
| modifier onlyEntryPointOrSelf() { | |
| _checkEntryPointOrSelf(); | |
| _; | |
| } | |
| /** | |
| * @dev Revert if the caller is not the entry point. | |
| */ | |
| modifier onlyEntryPoint() { | |
| _checkEntryPoint(); | |
| _; | |
| } | |
| /** | |
| * @dev Canonical entry point for the account that forwards and validates user operations. | |
| */ | |
| function entryPoint() public view virtual returns (IEntryPoint) { | |
| return ERC4337Utils.ENTRYPOINT_V08; | |
| } | |
| /** | |
| * @dev Return the account nonce for the canonical sequence. | |
| */ | |
| function getNonce() public view virtual returns (uint256) { | |
| return getNonce(0); | |
| } | |
| /** | |
| * @dev Return the account nonce for a given sequence (key). | |
| */ | |
| function getNonce(uint192 key) public view virtual returns (uint256) { | |
| return entryPoint().getNonce(address(this), key); | |
| } | |
| /** | |
| * @inheritdoc IAccount | |
| */ | |
| function validateUserOp( | |
| PackedUserOperation calldata userOp, | |
| bytes32 userOpHash, | |
| uint256 missingAccountFunds | |
| ) public virtual onlyEntryPoint returns (uint256) { | |
| uint256 validationData = _validateUserOp(userOp, userOpHash); | |
| _payPrefund(missingAccountFunds); | |
| return validationData; | |
| } | |
| /** | |
| * @dev Returns the validationData for a given user operation. By default, this checks the signature of the | |
| * signable hash (produced by {_signableUserOpHash}) using the abstract signer ({AbstractSigner-_rawSignatureValidation}). | |
| * | |
| * NOTE: The userOpHash is assumed to be correct. Calling this function with a userOpHash that does not match the | |
| * userOp will result in undefined behavior. | |
| */ | |
| function _validateUserOp( | |
| PackedUserOperation calldata userOp, | |
| bytes32 userOpHash | |
| ) internal virtual returns (uint256) { | |
| return | |
| _rawSignatureValidation(_signableUserOpHash(userOp, userOpHash), userOp.signature) | |
| ? ERC4337Utils.SIG_VALIDATION_SUCCESS | |
| : ERC4337Utils.SIG_VALIDATION_FAILED; | |
| } | |
| /** | |
| * @dev Virtual function that returns the signable hash for a user operations. Since v0.8.0 of the entrypoint, | |
| * `userOpHash` is an EIP-712 hash that can be signed directly. | |
| */ | |
| function _signableUserOpHash( | |
| PackedUserOperation calldata /*userOp*/, | |
| bytes32 userOpHash | |
| ) internal view virtual returns (bytes32) { | |
| return userOpHash; | |
| } | |
| /** | |
| * @dev Sends the missing funds for executing the user operation to the {entrypoint}. | |
| * The `missingAccountFunds` must be defined by the entrypoint when calling {validateUserOp}. | |
| */ | |
| function _payPrefund(uint256 missingAccountFunds) internal virtual { | |
| if (missingAccountFunds > 0) { | |
| (bool success, ) = payable(msg.sender).call{value: missingAccountFunds}(""); | |
| success; // Silence warning. The entrypoint should validate the result. | |
| } | |
| } | |
| /** | |
| * @dev Ensures the caller is the {entrypoint}. | |
| */ | |
| function _checkEntryPoint() internal view virtual { | |
| address sender = msg.sender; | |
| if (sender != address(entryPoint())) { | |
| revert AccountUnauthorized(sender); | |
| } | |
| } | |
| /** | |
| * @dev Ensures the caller is the {entrypoint} or the account itself. | |
| */ | |
| function _checkEntryPointOrSelf() internal view virtual { | |
| address sender = msg.sender; | |
| if (sender != address(this) && sender != address(entryPoint())) { | |
| revert AccountUnauthorized(sender); | |
| } | |
| } | |
| /** | |
| * @dev Receive Ether. | |
| */ | |
| receive() external payable virtual {} | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.3.0) (account/utils/draft-ERC4337Utils.sol) | |
| pragma solidity ^0.8.20; | |
| import {IEntryPoint, PackedUserOperation} from "../../interfaces/draft-IERC4337.sol"; | |
| import {Math} from "../../utils/math/Math.sol"; | |
| import {Calldata} from "../../utils/Calldata.sol"; | |
| import {Packing} from "../../utils/Packing.sol"; | |
| /// @dev This is available on all entrypoint since v0.4.0, but is not formally part of the ERC. | |
| interface IEntryPointExtra { | |
| function getUserOpHash(PackedUserOperation calldata userOp) external view returns (bytes32); | |
| } | |
| /** | |
| * @dev Library with common ERC-4337 utility functions. | |
| * | |
| * See https://eips.ethereum.org/EIPS/eip-4337[ERC-4337]. | |
| */ | |
| library ERC4337Utils { | |
| using Packing for *; | |
| /// @dev Address of the entrypoint v0.7.0 | |
| IEntryPoint internal constant ENTRYPOINT_V07 = IEntryPoint(0x0000000071727De22E5E9d8BAf0edAc6f37da032); | |
| /// @dev Address of the entrypoint v0.8.0 | |
| IEntryPoint internal constant ENTRYPOINT_V08 = IEntryPoint(0x4337084D9E255Ff0702461CF8895CE9E3b5Ff108); | |
| /// @dev For simulation purposes, validateUserOp (and validatePaymasterUserOp) return this value on success. | |
| uint256 internal constant SIG_VALIDATION_SUCCESS = 0; | |
| /// @dev For simulation purposes, validateUserOp (and validatePaymasterUserOp) must return this value in case of signature failure, instead of revert. | |
| uint256 internal constant SIG_VALIDATION_FAILED = 1; | |
| /// @dev Parses the validation data into its components. See {packValidationData}. | |
| function parseValidationData( | |
| uint256 validationData | |
| ) internal pure returns (address aggregator, uint48 validAfter, uint48 validUntil) { | |
| validAfter = uint48(bytes32(validationData).extract_32_6(0)); | |
| validUntil = uint48(bytes32(validationData).extract_32_6(6)); | |
| aggregator = address(bytes32(validationData).extract_32_20(12)); | |
| if (validUntil == 0) validUntil = type(uint48).max; | |
| } | |
| /// @dev Packs the validation data into a single uint256. See {parseValidationData}. | |
| function packValidationData( | |
| address aggregator, | |
| uint48 validAfter, | |
| uint48 validUntil | |
| ) internal pure returns (uint256) { | |
| return uint256(bytes6(validAfter).pack_6_6(bytes6(validUntil)).pack_12_20(bytes20(aggregator))); | |
| } | |
| /// @dev Same as {packValidationData}, but with a boolean signature success flag. | |
| function packValidationData(bool sigSuccess, uint48 validAfter, uint48 validUntil) internal pure returns (uint256) { | |
| return | |
| packValidationData( | |
| address(uint160(Math.ternary(sigSuccess, SIG_VALIDATION_SUCCESS, SIG_VALIDATION_FAILED))), | |
| validAfter, | |
| validUntil | |
| ); | |
| } | |
| /** | |
| * @dev Combines two validation data into a single one. | |
| * | |
| * The `aggregator` is set to {SIG_VALIDATION_SUCCESS} if both are successful, while | |
| * the `validAfter` is the maximum and the `validUntil` is the minimum of both. | |
| */ | |
| function combineValidationData(uint256 validationData1, uint256 validationData2) internal pure returns (uint256) { | |
| (address aggregator1, uint48 validAfter1, uint48 validUntil1) = parseValidationData(validationData1); | |
| (address aggregator2, uint48 validAfter2, uint48 validUntil2) = parseValidationData(validationData2); | |
| bool success = aggregator1 == address(uint160(SIG_VALIDATION_SUCCESS)) && | |
| aggregator2 == address(uint160(SIG_VALIDATION_SUCCESS)); | |
| uint48 validAfter = uint48(Math.max(validAfter1, validAfter2)); | |
| uint48 validUntil = uint48(Math.min(validUntil1, validUntil2)); | |
| return packValidationData(success, validAfter, validUntil); | |
| } | |
| /// @dev Returns the aggregator of the `validationData` and whether it is out of time range. | |
| function getValidationData(uint256 validationData) internal view returns (address aggregator, bool outOfTimeRange) { | |
| (address aggregator_, uint48 validAfter, uint48 validUntil) = parseValidationData(validationData); | |
| return (aggregator_, block.timestamp < validAfter || validUntil < block.timestamp); | |
| } | |
| /// @dev Get the hash of a user operation for a given entrypoint | |
| function hash(PackedUserOperation calldata self, address entrypoint) internal view returns (bytes32) { | |
| // NOTE: getUserOpHash is available since v0.4.0 | |
| // | |
| // Prior to v0.8.0, this was easy to replicate for any entrypoint and chainId. Since v0.8.0 of the | |
| // entrypoint, this depends on the Entrypoint's domain separator, which cannot be hardcoded and is complex | |
| // to recompute. Domain separator could be fetch using the `getDomainSeparatorV4` getter, or recomputed from | |
| // the ERC-5267 getter, but both operation would require doing a view call to the entrypoint. Overall it feels | |
| // simpler and less error prone to get that functionality from the entrypoint directly. | |
| return IEntryPointExtra(entrypoint).getUserOpHash(self); | |
| } | |
| /// @dev Returns `factory` from the {PackedUserOperation}, or address(0) if the initCode is empty or not properly formatted. | |
| function factory(PackedUserOperation calldata self) internal pure returns (address) { | |
| return self.initCode.length < 20 ? address(0) : address(bytes20(self.initCode[0:20])); | |
| } | |
| /// @dev Returns `factoryData` from the {PackedUserOperation}, or empty bytes if the initCode is empty or not properly formatted. | |
| function factoryData(PackedUserOperation calldata self) internal pure returns (bytes calldata) { | |
| return self.initCode.length < 20 ? Calldata.emptyBytes() : self.initCode[20:]; | |
| } | |
| /// @dev Returns `verificationGasLimit` from the {PackedUserOperation}. | |
| function verificationGasLimit(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return uint128(self.accountGasLimits.extract_32_16(0)); | |
| } | |
| /// @dev Returns `callGasLimit` from the {PackedUserOperation}. | |
| function callGasLimit(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return uint128(self.accountGasLimits.extract_32_16(16)); | |
| } | |
| /// @dev Returns the first section of `gasFees` from the {PackedUserOperation}. | |
| function maxPriorityFeePerGas(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return uint128(self.gasFees.extract_32_16(0)); | |
| } | |
| /// @dev Returns the second section of `gasFees` from the {PackedUserOperation}. | |
| function maxFeePerGas(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return uint128(self.gasFees.extract_32_16(16)); | |
| } | |
| /// @dev Returns the total gas price for the {PackedUserOperation} (ie. `maxFeePerGas` or `maxPriorityFeePerGas + basefee`). | |
| function gasPrice(PackedUserOperation calldata self) internal view returns (uint256) { | |
| unchecked { | |
| // Following values are "per gas" | |
| uint256 maxPriorityFee = maxPriorityFeePerGas(self); | |
| uint256 maxFee = maxFeePerGas(self); | |
| return Math.min(maxFee, maxPriorityFee + block.basefee); | |
| } | |
| } | |
| /// @dev Returns the first section of `paymasterAndData` from the {PackedUserOperation}. | |
| function paymaster(PackedUserOperation calldata self) internal pure returns (address) { | |
| return self.paymasterAndData.length < 52 ? address(0) : address(bytes20(self.paymasterAndData[0:20])); | |
| } | |
| /// @dev Returns the second section of `paymasterAndData` from the {PackedUserOperation}. | |
| function paymasterVerificationGasLimit(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return self.paymasterAndData.length < 52 ? 0 : uint128(bytes16(self.paymasterAndData[20:36])); | |
| } | |
| /// @dev Returns the third section of `paymasterAndData` from the {PackedUserOperation}. | |
| function paymasterPostOpGasLimit(PackedUserOperation calldata self) internal pure returns (uint256) { | |
| return self.paymasterAndData.length < 52 ? 0 : uint128(bytes16(self.paymasterAndData[36:52])); | |
| } | |
| /// @dev Returns the fourth section of `paymasterAndData` from the {PackedUserOperation}. | |
| function paymasterData(PackedUserOperation calldata self) internal pure returns (bytes calldata) { | |
| return self.paymasterAndData.length < 52 ? Calldata.emptyBytes() : self.paymasterAndData[52:]; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC4337.sol) | |
| pragma solidity >=0.8.4; | |
| /** | |
| * @dev A https://github.com/ethereum/ercs/blob/master/ERCS/erc-4337.md#useroperation[user operation] is composed of the following elements: | |
| * - `sender` (`address`): The account making the operation | |
| * - `nonce` (`uint256`): Anti-replay parameter (see “Semi-abstracted Nonce Support” ) | |
| * - `factory` (`address`): account factory, only for new accounts | |
| * - `factoryData` (`bytes`): data for account factory (only if account factory exists) | |
| * - `callData` (`bytes`): The data to pass to the sender during the main execution call | |
| * - `callGasLimit` (`uint256`): The amount of gas to allocate the main execution call | |
| * - `verificationGasLimit` (`uint256`): The amount of gas to allocate for the verification step | |
| * - `preVerificationGas` (`uint256`): Extra gas to pay the bundler | |
| * - `maxFeePerGas` (`uint256`): Maximum fee per gas (similar to EIP-1559 max_fee_per_gas) | |
| * - `maxPriorityFeePerGas` (`uint256`): Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas) | |
| * - `paymaster` (`address`): Address of paymaster contract, (or empty, if account pays for itself) | |
| * - `paymasterVerificationGasLimit` (`uint256`): The amount of gas to allocate for the paymaster validation code | |
| * - `paymasterPostOpGasLimit` (`uint256`): The amount of gas to allocate for the paymaster post-operation code | |
| * - `paymasterData` (`bytes`): Data for paymaster (only if paymaster exists) | |
| * - `signature` (`bytes`): Data passed into the account to verify authorization | |
| * | |
| * When passed to on-chain contracts, the following packed version is used. | |
| * - `sender` (`address`) | |
| * - `nonce` (`uint256`) | |
| * - `initCode` (`bytes`): concatenation of factory address and factoryData (or empty) | |
| * - `callData` (`bytes`) | |
| * - `accountGasLimits` (`bytes32`): concatenation of verificationGas (16 bytes) and callGas (16 bytes) | |
| * - `preVerificationGas` (`uint256`) | |
| * - `gasFees` (`bytes32`): concatenation of maxPriorityFeePerGas (16 bytes) and maxFeePerGas (16 bytes) | |
| * - `paymasterAndData` (`bytes`): concatenation of paymaster fields (or empty) | |
| * - `signature` (`bytes`) | |
| */ | |
| struct PackedUserOperation { | |
| address sender; | |
| uint256 nonce; | |
| bytes initCode; // `abi.encodePacked(factory, factoryData)` | |
| bytes callData; | |
| bytes32 accountGasLimits; // `abi.encodePacked(verificationGasLimit, callGasLimit)` 16 bytes each | |
| uint256 preVerificationGas; | |
| bytes32 gasFees; // `abi.encodePacked(maxPriorityFeePerGas, maxFeePerGas)` 16 bytes each | |
| bytes paymasterAndData; // `abi.encodePacked(paymaster, paymasterVerificationGasLimit, paymasterPostOpGasLimit, paymasterData)` (20 bytes, 16 bytes, 16 bytes, dynamic) | |
| bytes signature; | |
| } | |
| /** | |
| * @dev Aggregates and validates multiple signatures for a batch of user operations. | |
| * | |
| * A contract could implement this interface with custom validation schemes that allow signature aggregation, | |
| * enabling significant optimizations and gas savings for execution and transaction data cost. | |
| * | |
| * Bundlers and clients whitelist supported aggregators. | |
| * | |
| * See https://eips.ethereum.org/EIPS/eip-7766[ERC-7766] | |
| */ | |
| interface IAggregator { | |
| /** | |
| * @dev Validates the signature for a user operation. | |
| * Returns an alternative signature that should be used during bundling. | |
| */ | |
| function validateUserOpSignature( | |
| PackedUserOperation calldata userOp | |
| ) external view returns (bytes memory sigForUserOp); | |
| /** | |
| * @dev Returns an aggregated signature for a batch of user operation's signatures. | |
| */ | |
| function aggregateSignatures( | |
| PackedUserOperation[] calldata userOps | |
| ) external view returns (bytes memory aggregatesSignature); | |
| /** | |
| * @dev Validates that the aggregated signature is valid for the user operations. | |
| * | |
| * Requirements: | |
| * | |
| * - The aggregated signature MUST match the given list of operations. | |
| */ | |
| function validateSignatures(PackedUserOperation[] calldata userOps, bytes calldata signature) external view; | |
| } | |
| /** | |
| * @dev Handle nonce management for accounts. | |
| * | |
| * Nonces are used in accounts as a replay protection mechanism and to ensure the order of user operations. | |
| * To avoid limiting the number of operations an account can perform, the interface allows using parallel | |
| * nonces by using a `key` parameter. | |
| * | |
| * See https://eips.ethereum.org/EIPS/eip-4337#semi-abstracted-nonce-support[ERC-4337 semi-abstracted nonce support]. | |
| */ | |
| interface IEntryPointNonces { | |
| /** | |
| * @dev Returns the nonce for a `sender` account and a `key`. | |
| * | |
| * Nonces for a certain `key` are always increasing. | |
| */ | |
| function getNonce(address sender, uint192 key) external view returns (uint256 nonce); | |
| } | |
| /** | |
| * @dev Handle stake management for entities (i.e. accounts, paymasters, factories). | |
| * | |
| * The EntryPoint must implement the following API to let entities like paymasters have a stake, | |
| * and thus have more flexibility in their storage access | |
| * (see https://eips.ethereum.org/EIPS/eip-4337#reputation-scoring-and-throttlingbanning-for-global-entities[reputation, throttling and banning.]) | |
| */ | |
| interface IEntryPointStake { | |
| /** | |
| * @dev Returns the balance of the account. | |
| */ | |
| function balanceOf(address account) external view returns (uint256); | |
| /** | |
| * @dev Deposits `msg.value` to the account. | |
| */ | |
| function depositTo(address account) external payable; | |
| /** | |
| * @dev Withdraws `withdrawAmount` from the account to `withdrawAddress`. | |
| */ | |
| function withdrawTo(address payable withdrawAddress, uint256 withdrawAmount) external; | |
| /** | |
| * @dev Adds stake to the account with an unstake delay of `unstakeDelaySec`. | |
| */ | |
| function addStake(uint32 unstakeDelaySec) external payable; | |
| /** | |
| * @dev Unlocks the stake of the account. | |
| */ | |
| function unlockStake() external; | |
| /** | |
| * @dev Withdraws the stake of the account to `withdrawAddress`. | |
| */ | |
| function withdrawStake(address payable withdrawAddress) external; | |
| } | |
| /** | |
| * @dev Entry point for user operations. | |
| * | |
| * User operations are validated and executed by this contract. | |
| */ | |
| interface IEntryPoint is IEntryPointNonces, IEntryPointStake { | |
| /** | |
| * @dev A user operation at `opIndex` failed with `reason`. | |
| */ | |
| error FailedOp(uint256 opIndex, string reason); | |
| /** | |
| * @dev A user operation at `opIndex` failed with `reason` and `inner` returned data. | |
| */ | |
| error FailedOpWithRevert(uint256 opIndex, string reason, bytes inner); | |
| /** | |
| * @dev Batch of aggregated user operations per aggregator. | |
| */ | |
| struct UserOpsPerAggregator { | |
| PackedUserOperation[] userOps; | |
| IAggregator aggregator; | |
| bytes signature; | |
| } | |
| /** | |
| * @dev Executes a batch of user operations. | |
| * @param beneficiary Address to which gas is refunded upon completing the execution. | |
| */ | |
| function handleOps(PackedUserOperation[] calldata ops, address payable beneficiary) external; | |
| /** | |
| * @dev Executes a batch of aggregated user operations per aggregator. | |
| * @param beneficiary Address to which gas is refunded upon completing the execution. | |
| */ | |
| function handleAggregatedOps( | |
| UserOpsPerAggregator[] calldata opsPerAggregator, | |
| address payable beneficiary | |
| ) external; | |
| } | |
| /** | |
| * @dev Base interface for an ERC-4337 account. | |
| */ | |
| interface IAccount { | |
| /** | |
| * @dev Validates a user operation. | |
| * | |
| * * MUST validate the caller is a trusted EntryPoint | |
| * * MUST validate that the signature is a valid signature of the userOpHash, and SHOULD | |
| * return SIG_VALIDATION_FAILED (and not revert) on signature mismatch. Any other error MUST revert. | |
| * * MUST pay the entryPoint (caller) at least the “missingAccountFunds” (which might | |
| * be zero, in case the current account’s deposit is high enough) | |
| * | |
| * Returns an encoded packed validation data that is composed of the following elements: | |
| * | |
| * - `authorizer` (`address`): 0 for success, 1 for failure, otherwise the address of an authorizer contract | |
| * - `validUntil` (`uint48`): The UserOp is valid only up to this time. Zero for “infinite”. | |
| * - `validAfter` (`uint48`): The UserOp is valid only after this time. | |
| */ | |
| function validateUserOp( | |
| PackedUserOperation calldata userOp, | |
| bytes32 userOpHash, | |
| uint256 missingAccountFunds | |
| ) external returns (uint256 validationData); | |
| } | |
| /** | |
| * @dev Support for executing user operations by prepending the {executeUserOp} function selector | |
| * to the UserOperation's `callData`. | |
| */ | |
| interface IAccountExecute { | |
| /** | |
| * @dev Executes a user operation. | |
| */ | |
| function executeUserOp(PackedUserOperation calldata userOp, bytes32 userOpHash) external; | |
| } | |
| /** | |
| * @dev Interface for a paymaster contract that agrees to pay for the gas costs of a user operation. | |
| * | |
| * NOTE: A paymaster must hold a stake to cover the required entrypoint stake and also the gas for the transaction. | |
| */ | |
| interface IPaymaster { | |
| enum PostOpMode { | |
| opSucceeded, | |
| opReverted, | |
| postOpReverted | |
| } | |
| /** | |
| * @dev Validates whether the paymaster is willing to pay for the user operation. See | |
| * {IAccount-validateUserOp} for additional information on the return value. | |
| * | |
| * NOTE: Bundlers will reject this method if it modifies the state, unless it's whitelisted. | |
| */ | |
| function validatePaymasterUserOp( | |
| PackedUserOperation calldata userOp, | |
| bytes32 userOpHash, | |
| uint256 maxCost | |
| ) external returns (bytes memory context, uint256 validationData); | |
| /** | |
| * @dev Verifies the sender is the entrypoint. | |
| * @param actualGasCost the actual amount paid (by account or paymaster) for this UserOperation | |
| * @param actualUserOpFeePerGas total gas used by this UserOperation (including preVerification, creation, validation and execution) | |
| */ | |
| function postOp( | |
| PostOpMode mode, | |
| bytes calldata context, | |
| uint256 actualGasCost, | |
| uint256 actualUserOpFeePerGas | |
| ) external; | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC6093.sol) | |
| pragma solidity >=0.8.4; | |
| /** | |
| * @dev Standard ERC-20 Errors | |
| * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens. | |
| */ | |
| interface IERC20Errors { | |
| /** | |
| * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| * @param balance Current balance for the interacting account. | |
| * @param needed Minimum amount required to perform a transfer. | |
| */ | |
| error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed); | |
| /** | |
| * @dev Indicates a failure with the token `sender`. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| */ | |
| error ERC20InvalidSender(address sender); | |
| /** | |
| * @dev Indicates a failure with the token `receiver`. Used in transfers. | |
| * @param receiver Address to which tokens are being transferred. | |
| */ | |
| error ERC20InvalidReceiver(address receiver); | |
| /** | |
| * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers. | |
| * @param spender Address that may be allowed to operate on tokens without being their owner. | |
| * @param allowance Amount of tokens a `spender` is allowed to operate with. | |
| * @param needed Minimum amount required to perform a transfer. | |
| */ | |
| error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed); | |
| /** | |
| * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. | |
| * @param approver Address initiating an approval operation. | |
| */ | |
| error ERC20InvalidApprover(address approver); | |
| /** | |
| * @dev Indicates a failure with the `spender` to be approved. Used in approvals. | |
| * @param spender Address that may be allowed to operate on tokens without being their owner. | |
| */ | |
| error ERC20InvalidSpender(address spender); | |
| } | |
| /** | |
| * @dev Standard ERC-721 Errors | |
| * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens. | |
| */ | |
| interface IERC721Errors { | |
| /** | |
| * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20. | |
| * Used in balance queries. | |
| * @param owner Address of the current owner of a token. | |
| */ | |
| error ERC721InvalidOwner(address owner); | |
| /** | |
| * @dev Indicates a `tokenId` whose `owner` is the zero address. | |
| * @param tokenId Identifier number of a token. | |
| */ | |
| error ERC721NonexistentToken(uint256 tokenId); | |
| /** | |
| * @dev Indicates an error related to the ownership over a particular token. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| * @param tokenId Identifier number of a token. | |
| * @param owner Address of the current owner of a token. | |
| */ | |
| error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner); | |
| /** | |
| * @dev Indicates a failure with the token `sender`. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| */ | |
| error ERC721InvalidSender(address sender); | |
| /** | |
| * @dev Indicates a failure with the token `receiver`. Used in transfers. | |
| * @param receiver Address to which tokens are being transferred. | |
| */ | |
| error ERC721InvalidReceiver(address receiver); | |
| /** | |
| * @dev Indicates a failure with the `operator`’s approval. Used in transfers. | |
| * @param operator Address that may be allowed to operate on tokens without being their owner. | |
| * @param tokenId Identifier number of a token. | |
| */ | |
| error ERC721InsufficientApproval(address operator, uint256 tokenId); | |
| /** | |
| * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. | |
| * @param approver Address initiating an approval operation. | |
| */ | |
| error ERC721InvalidApprover(address approver); | |
| /** | |
| * @dev Indicates a failure with the `operator` to be approved. Used in approvals. | |
| * @param operator Address that may be allowed to operate on tokens without being their owner. | |
| */ | |
| error ERC721InvalidOperator(address operator); | |
| } | |
| /** | |
| * @dev Standard ERC-1155 Errors | |
| * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens. | |
| */ | |
| interface IERC1155Errors { | |
| /** | |
| * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| * @param balance Current balance for the interacting account. | |
| * @param needed Minimum amount required to perform a transfer. | |
| * @param tokenId Identifier number of a token. | |
| */ | |
| error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId); | |
| /** | |
| * @dev Indicates a failure with the token `sender`. Used in transfers. | |
| * @param sender Address whose tokens are being transferred. | |
| */ | |
| error ERC1155InvalidSender(address sender); | |
| /** | |
| * @dev Indicates a failure with the token `receiver`. Used in transfers. | |
| * @param receiver Address to which tokens are being transferred. | |
| */ | |
| error ERC1155InvalidReceiver(address receiver); | |
| /** | |
| * @dev Indicates a failure with the `operator`’s approval. Used in transfers. | |
| * @param operator Address that may be allowed to operate on tokens without being their owner. | |
| * @param owner Address of the current owner of a token. | |
| */ | |
| error ERC1155MissingApprovalForAll(address operator, address owner); | |
| /** | |
| * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. | |
| * @param approver Address initiating an approval operation. | |
| */ | |
| error ERC1155InvalidApprover(address approver); | |
| /** | |
| * @dev Indicates a failure with the `operator` to be approved. Used in approvals. | |
| * @param operator Address that may be allowed to operate on tokens without being their owner. | |
| */ | |
| error ERC1155InvalidOperator(address operator); | |
| /** | |
| * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation. | |
| * Used in batch transfers. | |
| * @param idsLength Length of the array of token identifiers | |
| * @param valuesLength Length of the array of token amounts | |
| */ | |
| error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1271.sol) | |
| pragma solidity >=0.5.0; | |
| /** | |
| * @dev Interface of the ERC-1271 standard signature validation method for | |
| * contracts as defined in https://eips.ethereum.org/EIPS/eip-1271[ERC-1271]. | |
| */ | |
| interface IERC1271 { | |
| /** | |
| * @dev Should return whether the signature provided is valid for the provided data | |
| * @param hash Hash of the data to be signed | |
| * @param signature Signature byte array associated with `hash` | |
| */ | |
| function isValidSignature(bytes32 hash, bytes calldata signature) external view returns (bytes4 magicValue); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC5267.sol) | |
| pragma solidity >=0.4.16; | |
| interface IERC5267 { | |
| /** | |
| * @dev MAY be emitted to signal that the domain could have changed. | |
| */ | |
| event EIP712DomainChanged(); | |
| /** | |
| * @dev returns the fields and values that describe the domain separator used by this contract for EIP-712 | |
| * signature. | |
| */ | |
| function eip712Domain() | |
| external | |
| view | |
| returns ( | |
| bytes1 fields, | |
| string memory name, | |
| string memory version, | |
| uint256 chainId, | |
| address verifyingContract, | |
| bytes32 salt, | |
| uint256[] memory extensions | |
| ); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC1155/IERC1155Receiver.sol) | |
| pragma solidity >=0.6.2; | |
| import {IERC165} from "../../utils/introspection/IERC165.sol"; | |
| /** | |
| * @dev Interface that must be implemented by smart contracts in order to receive | |
| * ERC-1155 token transfers. | |
| */ | |
| interface IERC1155Receiver is IERC165 { | |
| /** | |
| * @dev Handles the receipt of a single ERC-1155 token type. This function is | |
| * called at the end of a `safeTransferFrom` after the balance has been updated. | |
| * | |
| * NOTE: To accept the transfer, this must return | |
| * `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` | |
| * (i.e. 0xf23a6e61, or its own function selector). | |
| * | |
| * @param operator The address which initiated the transfer (i.e. msg.sender) | |
| * @param from The address which previously owned the token | |
| * @param id The ID of the token being transferred | |
| * @param value The amount of tokens being transferred | |
| * @param data Additional data with no specified format | |
| * @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed | |
| */ | |
| function onERC1155Received( | |
| address operator, | |
| address from, | |
| uint256 id, | |
| uint256 value, | |
| bytes calldata data | |
| ) external returns (bytes4); | |
| /** | |
| * @dev Handles the receipt of a multiple ERC-1155 token types. This function | |
| * is called at the end of a `safeBatchTransferFrom` after the balances have | |
| * been updated. | |
| * | |
| * NOTE: To accept the transfer(s), this must return | |
| * `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` | |
| * (i.e. 0xbc197c81, or its own function selector). | |
| * | |
| * @param operator The address which initiated the batch transfer (i.e. msg.sender) | |
| * @param from The address which previously owned the token | |
| * @param ids An array containing ids of each token being transferred (order and length must match values array) | |
| * @param values An array containing amounts of each token being transferred (order and length must match ids array) | |
| * @param data Additional data with no specified format | |
| * @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed | |
| */ | |
| function onERC1155BatchReceived( | |
| address operator, | |
| address from, | |
| uint256[] calldata ids, | |
| uint256[] calldata values, | |
| bytes calldata data | |
| ) external returns (bytes4); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC1155/utils/ERC1155Holder.sol) | |
| pragma solidity ^0.8.20; | |
| import {IERC165, ERC165} from "../../../utils/introspection/ERC165.sol"; | |
| import {IERC1155Receiver} from "../IERC1155Receiver.sol"; | |
| /** | |
| * @dev Simple implementation of `IERC1155Receiver` that will allow a contract to hold ERC-1155 tokens. | |
| * | |
| * IMPORTANT: When inheriting this contract, you must include a way to use the received tokens, otherwise they will be | |
| * stuck. | |
| */ | |
| abstract contract ERC1155Holder is ERC165, IERC1155Receiver { | |
| /// @inheritdoc IERC165 | |
| function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) { | |
| return interfaceId == type(IERC1155Receiver).interfaceId || super.supportsInterface(interfaceId); | |
| } | |
| function onERC1155Received( | |
| address, | |
| address, | |
| uint256, | |
| uint256, | |
| bytes memory | |
| ) public virtual override returns (bytes4) { | |
| return this.onERC1155Received.selector; | |
| } | |
| function onERC1155BatchReceived( | |
| address, | |
| address, | |
| uint256[] memory, | |
| uint256[] memory, | |
| bytes memory | |
| ) public virtual override returns (bytes4) { | |
| return this.onERC1155BatchReceived.selector; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/ERC20.sol) | |
| pragma solidity ^0.8.20; | |
| import {IERC20} from "./IERC20.sol"; | |
| import {IERC20Metadata} from "./extensions/IERC20Metadata.sol"; | |
| import {Context} from "../../utils/Context.sol"; | |
| import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol"; | |
| /** | |
| * @dev Implementation of the {IERC20} interface. | |
| * | |
| * This implementation is agnostic to the way tokens are created. This means | |
| * that a supply mechanism has to be added in a derived contract using {_mint}. | |
| * | |
| * TIP: For a detailed writeup see our guide | |
| * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How | |
| * to implement supply mechanisms]. | |
| * | |
| * The default value of {decimals} is 18. To change this, you should override | |
| * this function so it returns a different value. | |
| * | |
| * We have followed general OpenZeppelin Contracts guidelines: functions revert | |
| * instead returning `false` on failure. This behavior is nonetheless | |
| * conventional and does not conflict with the expectations of ERC-20 | |
| * applications. | |
| */ | |
| abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors { | |
| mapping(address account => uint256) private _balances; | |
| mapping(address account => mapping(address spender => uint256)) private _allowances; | |
| uint256 private _totalSupply; | |
| string private _name; | |
| string private _symbol; | |
| /** | |
| * @dev Sets the values for {name} and {symbol}. | |
| * | |
| * Both values are immutable: they can only be set once during construction. | |
| */ | |
| constructor(string memory name_, string memory symbol_) { | |
| _name = name_; | |
| _symbol = symbol_; | |
| } | |
| /** | |
| * @dev Returns the name of the token. | |
| */ | |
| function name() public view virtual returns (string memory) { | |
| return _name; | |
| } | |
| /** | |
| * @dev Returns the symbol of the token, usually a shorter version of the | |
| * name. | |
| */ | |
| function symbol() public view virtual returns (string memory) { | |
| return _symbol; | |
| } | |
| /** | |
| * @dev Returns the number of decimals used to get its user representation. | |
| * For example, if `decimals` equals `2`, a balance of `505` tokens should | |
| * be displayed to a user as `5.05` (`505 / 10 ** 2`). | |
| * | |
| * Tokens usually opt for a value of 18, imitating the relationship between | |
| * Ether and Wei. This is the default value returned by this function, unless | |
| * it's overridden. | |
| * | |
| * NOTE: This information is only used for _display_ purposes: it in | |
| * no way affects any of the arithmetic of the contract, including | |
| * {IERC20-balanceOf} and {IERC20-transfer}. | |
| */ | |
| function decimals() public view virtual returns (uint8) { | |
| return 18; | |
| } | |
| /// @inheritdoc IERC20 | |
| function totalSupply() public view virtual returns (uint256) { | |
| return _totalSupply; | |
| } | |
| /// @inheritdoc IERC20 | |
| function balanceOf(address account) public view virtual returns (uint256) { | |
| return _balances[account]; | |
| } | |
| /** | |
| * @dev See {IERC20-transfer}. | |
| * | |
| * Requirements: | |
| * | |
| * - `to` cannot be the zero address. | |
| * - the caller must have a balance of at least `value`. | |
| */ | |
| function transfer(address to, uint256 value) public virtual returns (bool) { | |
| address owner = _msgSender(); | |
| _transfer(owner, to, value); | |
| return true; | |
| } | |
| /// @inheritdoc IERC20 | |
| function allowance(address owner, address spender) public view virtual returns (uint256) { | |
| return _allowances[owner][spender]; | |
| } | |
| /** | |
| * @dev See {IERC20-approve}. | |
| * | |
| * NOTE: If `value` is the maximum `uint256`, the allowance is not updated on | |
| * `transferFrom`. This is semantically equivalent to an infinite approval. | |
| * | |
| * Requirements: | |
| * | |
| * - `spender` cannot be the zero address. | |
| */ | |
| function approve(address spender, uint256 value) public virtual returns (bool) { | |
| address owner = _msgSender(); | |
| _approve(owner, spender, value); | |
| return true; | |
| } | |
| /** | |
| * @dev See {IERC20-transferFrom}. | |
| * | |
| * Skips emitting an {Approval} event indicating an allowance update. This is not | |
| * required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve]. | |
| * | |
| * NOTE: Does not update the allowance if the current allowance | |
| * is the maximum `uint256`. | |
| * | |
| * Requirements: | |
| * | |
| * - `from` and `to` cannot be the zero address. | |
| * - `from` must have a balance of at least `value`. | |
| * - the caller must have allowance for ``from``'s tokens of at least | |
| * `value`. | |
| */ | |
| function transferFrom(address from, address to, uint256 value) public virtual returns (bool) { | |
| address spender = _msgSender(); | |
| _spendAllowance(from, spender, value); | |
| _transfer(from, to, value); | |
| return true; | |
| } | |
| /** | |
| * @dev Moves a `value` amount of tokens from `from` to `to`. | |
| * | |
| * This internal function is equivalent to {transfer}, and can be used to | |
| * e.g. implement automatic token fees, slashing mechanisms, etc. | |
| * | |
| * Emits a {Transfer} event. | |
| * | |
| * NOTE: This function is not virtual, {_update} should be overridden instead. | |
| */ | |
| function _transfer(address from, address to, uint256 value) internal { | |
| if (from == address(0)) { | |
| revert ERC20InvalidSender(address(0)); | |
| } | |
| if (to == address(0)) { | |
| revert ERC20InvalidReceiver(address(0)); | |
| } | |
| _update(from, to, value); | |
| } | |
| /** | |
| * @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from` | |
| * (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding | |
| * this function. | |
| * | |
| * Emits a {Transfer} event. | |
| */ | |
| function _update(address from, address to, uint256 value) internal virtual { | |
| if (from == address(0)) { | |
| // Overflow check required: The rest of the code assumes that totalSupply never overflows | |
| _totalSupply += value; | |
| } else { | |
| uint256 fromBalance = _balances[from]; | |
| if (fromBalance < value) { | |
| revert ERC20InsufficientBalance(from, fromBalance, value); | |
| } | |
| unchecked { | |
| // Overflow not possible: value <= fromBalance <= totalSupply. | |
| _balances[from] = fromBalance - value; | |
| } | |
| } | |
| if (to == address(0)) { | |
| unchecked { | |
| // Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply. | |
| _totalSupply -= value; | |
| } | |
| } else { | |
| unchecked { | |
| // Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256. | |
| _balances[to] += value; | |
| } | |
| } | |
| emit Transfer(from, to, value); | |
| } | |
| /** | |
| * @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0). | |
| * Relies on the `_update` mechanism | |
| * | |
| * Emits a {Transfer} event with `from` set to the zero address. | |
| * | |
| * NOTE: This function is not virtual, {_update} should be overridden instead. | |
| */ | |
| function _mint(address account, uint256 value) internal { | |
| if (account == address(0)) { | |
| revert ERC20InvalidReceiver(address(0)); | |
| } | |
| _update(address(0), account, value); | |
| } | |
| /** | |
| * @dev Destroys a `value` amount of tokens from `account`, lowering the total supply. | |
| * Relies on the `_update` mechanism. | |
| * | |
| * Emits a {Transfer} event with `to` set to the zero address. | |
| * | |
| * NOTE: This function is not virtual, {_update} should be overridden instead | |
| */ | |
| function _burn(address account, uint256 value) internal { | |
| if (account == address(0)) { | |
| revert ERC20InvalidSender(address(0)); | |
| } | |
| _update(account, address(0), value); | |
| } | |
| /** | |
| * @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens. | |
| * | |
| * This internal function is equivalent to `approve`, and can be used to | |
| * e.g. set automatic allowances for certain subsystems, etc. | |
| * | |
| * Emits an {Approval} event. | |
| * | |
| * Requirements: | |
| * | |
| * - `owner` cannot be the zero address. | |
| * - `spender` cannot be the zero address. | |
| * | |
| * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument. | |
| */ | |
| function _approve(address owner, address spender, uint256 value) internal { | |
| _approve(owner, spender, value, true); | |
| } | |
| /** | |
| * @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event. | |
| * | |
| * By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by | |
| * `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any | |
| * `Approval` event during `transferFrom` operations. | |
| * | |
| * Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to | |
| * true using the following override: | |
| * | |
| * ```solidity | |
| * function _approve(address owner, address spender, uint256 value, bool) internal virtual override { | |
| * super._approve(owner, spender, value, true); | |
| * } | |
| * ``` | |
| * | |
| * Requirements are the same as {_approve}. | |
| */ | |
| function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual { | |
| if (owner == address(0)) { | |
| revert ERC20InvalidApprover(address(0)); | |
| } | |
| if (spender == address(0)) { | |
| revert ERC20InvalidSpender(address(0)); | |
| } | |
| _allowances[owner][spender] = value; | |
| if (emitEvent) { | |
| emit Approval(owner, spender, value); | |
| } | |
| } | |
| /** | |
| * @dev Updates `owner`'s allowance for `spender` based on spent `value`. | |
| * | |
| * Does not update the allowance value in case of infinite allowance. | |
| * Revert if not enough allowance is available. | |
| * | |
| * Does not emit an {Approval} event. | |
| */ | |
| function _spendAllowance(address owner, address spender, uint256 value) internal virtual { | |
| uint256 currentAllowance = allowance(owner, spender); | |
| if (currentAllowance < type(uint256).max) { | |
| if (currentAllowance < value) { | |
| revert ERC20InsufficientAllowance(spender, currentAllowance, value); | |
| } | |
| unchecked { | |
| _approve(owner, spender, currentAllowance - value, false); | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/ERC20Permit.sol) | |
| pragma solidity ^0.8.20; | |
| import {IERC20Permit} from "./IERC20Permit.sol"; | |
| import {ERC20} from "../ERC20.sol"; | |
| import {ECDSA} from "../../../utils/cryptography/ECDSA.sol"; | |
| import {EIP712} from "../../../utils/cryptography/EIP712.sol"; | |
| import {Nonces} from "../../../utils/Nonces.sol"; | |
| /** | |
| * @dev Implementation of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in | |
| * https://eips.ethereum.org/EIPS/eip-2612[ERC-2612]. | |
| * | |
| * Adds the {permit} method, which can be used to change an account's ERC-20 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. | |
| */ | |
| abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712, Nonces { | |
| bytes32 private constant PERMIT_TYPEHASH = | |
| keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); | |
| /** | |
| * @dev Permit deadline has expired. | |
| */ | |
| error ERC2612ExpiredSignature(uint256 deadline); | |
| /** | |
| * @dev Mismatched signature. | |
| */ | |
| error ERC2612InvalidSigner(address signer, address owner); | |
| /** | |
| * @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`. | |
| * | |
| * It's a good idea to use the same `name` that is defined as the ERC-20 token name. | |
| */ | |
| constructor(string memory name) EIP712(name, "1") {} | |
| /// @inheritdoc IERC20Permit | |
| function permit( | |
| address owner, | |
| address spender, | |
| uint256 value, | |
| uint256 deadline, | |
| uint8 v, | |
| bytes32 r, | |
| bytes32 s | |
| ) public virtual { | |
| if (block.timestamp > deadline) { | |
| revert ERC2612ExpiredSignature(deadline); | |
| } | |
| bytes32 structHash = keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline)); | |
| bytes32 hash = _hashTypedDataV4(structHash); | |
| address signer = ECDSA.recover(hash, v, r, s); | |
| if (signer != owner) { | |
| revert ERC2612InvalidSigner(signer, owner); | |
| } | |
| _approve(owner, spender, value); | |
| } | |
| /// @inheritdoc IERC20Permit | |
| function nonces(address owner) public view virtual override(IERC20Permit, Nonces) returns (uint256) { | |
| return super.nonces(owner); | |
| } | |
| /// @inheritdoc IERC20Permit | |
| // solhint-disable-next-line func-name-mixedcase | |
| function DOMAIN_SEPARATOR() external view virtual returns (bytes32) { | |
| return _domainSeparatorV4(); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Metadata.sol) | |
| pragma solidity >=0.6.2; | |
| import {IERC20} from "../IERC20.sol"; | |
| /** | |
| * @dev Interface for the optional metadata functions from the ERC-20 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); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Permit.sol) | |
| pragma solidity >=0.4.16; | |
| /** | |
| * @dev Interface of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in | |
| * https://eips.ethereum.org/EIPS/eip-2612[ERC-2612]. | |
| * | |
| * Adds the {permit} method, which can be used to change an account's ERC-20 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); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol) | |
| pragma solidity >=0.4.16; | |
| /** | |
| * @dev Interface of the ERC-20 standard as defined in the ERC. | |
| */ | |
| 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); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721Receiver.sol) | |
| pragma solidity >=0.5.0; | |
| /** | |
| * @title ERC-721 token receiver interface | |
| * @dev Interface for any contract that wants to support safeTransfers | |
| * from ERC-721 asset contracts. | |
| */ | |
| interface IERC721Receiver { | |
| /** | |
| * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom} | |
| * by `operator` from `from`, this function is called. | |
| * | |
| * It must return its Solidity selector to confirm the token transfer. | |
| * If any other value is returned or the interface is not implemented by the recipient, the transfer will be | |
| * reverted. | |
| * | |
| * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`. | |
| */ | |
| function onERC721Received( | |
| address operator, | |
| address from, | |
| uint256 tokenId, | |
| bytes calldata data | |
| ) external returns (bytes4); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/utils/ERC721Holder.sol) | |
| pragma solidity ^0.8.20; | |
| import {IERC721Receiver} from "../IERC721Receiver.sol"; | |
| /** | |
| * @dev Implementation of the {IERC721Receiver} interface. | |
| * | |
| * Accepts all token transfers. | |
| * Make sure the contract is able to use its token with {IERC721-safeTransferFrom}, {IERC721-approve} or | |
| * {IERC721-setApprovalForAll}. | |
| */ | |
| abstract contract ERC721Holder is IERC721Receiver { | |
| /** | |
| * @dev See {IERC721Receiver-onERC721Received}. | |
| * | |
| * Always returns `IERC721Receiver.onERC721Received.selector`. | |
| */ | |
| function onERC721Received(address, address, uint256, bytes memory) public virtual returns (bytes4) { | |
| return this.onERC721Received.selector; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.3.0) (utils/Calldata.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Helper library for manipulating objects in calldata. | |
| */ | |
| library Calldata { | |
| // slither-disable-next-line write-after-write | |
| function emptyBytes() internal pure returns (bytes calldata result) { | |
| assembly ("memory-safe") { | |
| result.offset := 0 | |
| result.length := 0 | |
| } | |
| } | |
| // slither-disable-next-line write-after-write | |
| function emptyString() internal pure returns (string calldata result) { | |
| assembly ("memory-safe") { | |
| result.offset := 0 | |
| result.length := 0 | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Provides information about the current execution context, including the | |
| * sender of the transaction and its data. While these are generally available | |
| * via msg.sender and msg.data, they should not be accessed in such a direct | |
| * manner, since when dealing with meta-transactions the account sending and | |
| * paying for execution may not be the actual sender (as far as an application | |
| * is concerned). | |
| * | |
| * This contract is only required for intermediate, library-like contracts. | |
| */ | |
| abstract contract Context { | |
| function _msgSender() internal view virtual returns (address) { | |
| return msg.sender; | |
| } | |
| function _msgData() internal view virtual returns (bytes calldata) { | |
| return msg.data; | |
| } | |
| function _contextSuffixLength() internal view virtual returns (uint256) { | |
| return 0; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/draft-ERC7739Utils.sol) | |
| pragma solidity ^0.8.20; | |
| import {Calldata} from "../Calldata.sol"; | |
| /** | |
| * @dev Utilities to process https://ercs.ethereum.org/ERCS/erc-7739[ERC-7739] typed data signatures | |
| * that are specific to an EIP-712 domain. | |
| * | |
| * This library provides methods to wrap, unwrap and operate over typed data signatures with a defensive | |
| * rehashing mechanism that includes the app's xref:api:utils/cryptography#EIP712-_domainSeparatorV4[EIP-712] | |
| * and preserves readability of the signed content using an EIP-712 nested approach. | |
| * | |
| * A smart contract domain can validate a signature for a typed data structure in two ways: | |
| * | |
| * - As an application validating a typed data signature. See {typedDataSignStructHash}. | |
| * - As a smart contract validating a raw message signature. See {personalSignStructHash}. | |
| * | |
| * NOTE: A provider for a smart contract wallet would need to return this signature as the | |
| * result of a call to `personal_sign` or `eth_signTypedData`, and this may be unsupported by | |
| * API clients that expect a return value of 129 bytes, or specifically the `r,s,v` parameters | |
| * of an xref:api:utils/cryptography#ECDSA[ECDSA] signature, as is for example specified for | |
| * xref:api:utils/cryptography#EIP712[EIP-712]. | |
| */ | |
| library ERC7739Utils { | |
| /** | |
| * @dev An EIP-712 type to represent "personal" signatures | |
| * (i.e. mimic of `personal_sign` for smart contracts). | |
| */ | |
| bytes32 private constant PERSONAL_SIGN_TYPEHASH = keccak256("PersonalSign(bytes prefixed)"); | |
| /** | |
| * @dev Nest a signature for a given EIP-712 type into a nested signature for the domain of the app. | |
| * | |
| * Counterpart of {decodeTypedDataSig} to extract the original signature and the nested components. | |
| */ | |
| function encodeTypedDataSig( | |
| bytes memory signature, | |
| bytes32 appSeparator, | |
| bytes32 contentsHash, | |
| string memory contentsDescr | |
| ) internal pure returns (bytes memory) { | |
| return | |
| abi.encodePacked(signature, appSeparator, contentsHash, contentsDescr, uint16(bytes(contentsDescr).length)); | |
| } | |
| /** | |
| * @dev Parses a nested signature into its components. | |
| * | |
| * Constructed as follows: | |
| * | |
| * `signature ‖ APP_DOMAIN_SEPARATOR ‖ contentsHash ‖ contentsDescr ‖ uint16(contentsDescr.length)` | |
| * | |
| * - `signature` is the signature for the (ERC-7739) nested struct hash. This signature indirectly signs over the | |
| * original "contents" hash (from the app) and the account's domain separator. | |
| * - `APP_DOMAIN_SEPARATOR` is the EIP-712 {EIP712-_domainSeparatorV4} of the application smart contract that is | |
| * requesting the signature verification (though ERC-1271). | |
| * - `contentsHash` is the hash of the underlying data structure or message. | |
| * - `contentsDescr` is a descriptor of the "contents" part of the the EIP-712 type of the nested signature. | |
| * | |
| * NOTE: This function returns empty if the input format is invalid instead of reverting. | |
| * data instead. | |
| */ | |
| function decodeTypedDataSig( | |
| bytes calldata encodedSignature | |
| ) | |
| internal | |
| pure | |
| returns (bytes calldata signature, bytes32 appSeparator, bytes32 contentsHash, string calldata contentsDescr) | |
| { | |
| unchecked { | |
| uint256 sigLength = encodedSignature.length; | |
| // 66 bytes = contentsDescrLength (2 bytes) + contentsHash (32 bytes) + APP_DOMAIN_SEPARATOR (32 bytes). | |
| if (sigLength < 66) return (Calldata.emptyBytes(), 0, 0, Calldata.emptyString()); | |
| uint256 contentsDescrEnd = sigLength - 2; // Last 2 bytes | |
| uint256 contentsDescrLength = uint16(bytes2(encodedSignature[contentsDescrEnd:])); | |
| // Check for space for `contentsDescr` in addition to the 66 bytes documented above | |
| if (sigLength < 66 + contentsDescrLength) return (Calldata.emptyBytes(), 0, 0, Calldata.emptyString()); | |
| uint256 contentsHashEnd = contentsDescrEnd - contentsDescrLength; | |
| uint256 separatorEnd = contentsHashEnd - 32; | |
| uint256 signatureEnd = separatorEnd - 32; | |
| signature = encodedSignature[:signatureEnd]; | |
| appSeparator = bytes32(encodedSignature[signatureEnd:separatorEnd]); | |
| contentsHash = bytes32(encodedSignature[separatorEnd:contentsHashEnd]); | |
| contentsDescr = string(encodedSignature[contentsHashEnd:contentsDescrEnd]); | |
| } | |
| } | |
| /** | |
| * @dev Nests an `ERC-191` digest into a `PersonalSign` EIP-712 struct, and returns the corresponding struct hash. | |
| * This struct hash must be combined with a domain separator, using {MessageHashUtils-toTypedDataHash} before | |
| * being verified/recovered. | |
| * | |
| * This is used to simulates the `personal_sign` RPC method in the context of smart contracts. | |
| */ | |
| function personalSignStructHash(bytes32 contents) internal pure returns (bytes32) { | |
| return keccak256(abi.encode(PERSONAL_SIGN_TYPEHASH, contents)); | |
| } | |
| /** | |
| * @dev Nests an `EIP-712` hash (`contents`) into a `TypedDataSign` EIP-712 struct, and returns the corresponding | |
| * struct hash. This struct hash must be combined with a domain separator, using {MessageHashUtils-toTypedDataHash} | |
| * before being verified/recovered. | |
| */ | |
| function typedDataSignStructHash( | |
| string calldata contentsName, | |
| string calldata contentsType, | |
| bytes32 contentsHash, | |
| bytes memory domainBytes | |
| ) internal pure returns (bytes32 result) { | |
| return | |
| bytes(contentsName).length == 0 | |
| ? bytes32(0) | |
| : keccak256( | |
| abi.encodePacked(typedDataSignTypehash(contentsName, contentsType), contentsHash, domainBytes) | |
| ); | |
| } | |
| /** | |
| * @dev Variant of {typedDataSignStructHash-string-string-bytes32-bytes} that takes a content descriptor | |
| * and decodes the `contentsName` and `contentsType` out of it. | |
| */ | |
| function typedDataSignStructHash( | |
| string calldata contentsDescr, | |
| bytes32 contentsHash, | |
| bytes memory domainBytes | |
| ) internal pure returns (bytes32 result) { | |
| (string calldata contentsName, string calldata contentsType) = decodeContentsDescr(contentsDescr); | |
| return typedDataSignStructHash(contentsName, contentsType, contentsHash, domainBytes); | |
| } | |
| /** | |
| * @dev Compute the EIP-712 typehash of the `TypedDataSign` structure for a given type (and typename). | |
| */ | |
| function typedDataSignTypehash( | |
| string calldata contentsName, | |
| string calldata contentsType | |
| ) internal pure returns (bytes32) { | |
| return | |
| keccak256( | |
| abi.encodePacked( | |
| "TypedDataSign(", | |
| contentsName, | |
| " contents,string name,string version,uint256 chainId,address verifyingContract,bytes32 salt)", | |
| contentsType | |
| ) | |
| ); | |
| } | |
| /** | |
| * @dev Parse the type name out of the ERC-7739 contents type description. Supports both the implicit and explicit | |
| * modes. | |
| * | |
| * Following ERC-7739 specifications, a `contentsName` is considered invalid if it's empty or it contains | |
| * any of the following bytes , )\x00 | |
| * | |
| * If the `contentsType` is invalid, this returns an empty string. Otherwise, the return string has non-zero | |
| * length. | |
| */ | |
| function decodeContentsDescr( | |
| string calldata contentsDescr | |
| ) internal pure returns (string calldata contentsName, string calldata contentsType) { | |
| bytes calldata buffer = bytes(contentsDescr); | |
| if (buffer.length == 0) { | |
| // pass through (fail) | |
| } else if (buffer[buffer.length - 1] == bytes1(")")) { | |
| // Implicit mode: read contentsName from the beginning, and keep the complete descr | |
| for (uint256 i = 0; i < buffer.length; ++i) { | |
| bytes1 current = buffer[i]; | |
| if (current == bytes1("(")) { | |
| // if name is empty - passthrough (fail) | |
| if (i == 0) break; | |
| // we found the end of the contentsName | |
| return (string(buffer[:i]), contentsDescr); | |
| } else if (_isForbiddenChar(current)) { | |
| // we found an invalid character (forbidden) - passthrough (fail) | |
| break; | |
| } | |
| } | |
| } else { | |
| // Explicit mode: read contentsName from the end, and remove it from the descr | |
| for (uint256 i = buffer.length; i > 0; --i) { | |
| bytes1 current = buffer[i - 1]; | |
| if (current == bytes1(")")) { | |
| // we found the end of the contentsName | |
| return (string(buffer[i:]), string(buffer[:i])); | |
| } else if (_isForbiddenChar(current)) { | |
| // we found an invalid character (forbidden) - passthrough (fail) | |
| break; | |
| } | |
| } | |
| } | |
| return (Calldata.emptyString(), Calldata.emptyString()); | |
| } | |
| function _isForbiddenChar(bytes1 char) private pure returns (bool) { | |
| return char == 0x00 || char == bytes1(" ") || char == bytes1(",") || char == bytes1("(") || char == bytes1(")"); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/ECDSA.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations. | |
| * | |
| * These functions can be used to verify that a message was signed by the holder | |
| * of the private keys of a given address. | |
| */ | |
| library ECDSA { | |
| enum RecoverError { | |
| NoError, | |
| InvalidSignature, | |
| InvalidSignatureLength, | |
| InvalidSignatureS | |
| } | |
| /** | |
| * @dev The signature derives the `address(0)`. | |
| */ | |
| error ECDSAInvalidSignature(); | |
| /** | |
| * @dev The signature has an invalid length. | |
| */ | |
| error ECDSAInvalidSignatureLength(uint256 length); | |
| /** | |
| * @dev The signature has an S value that is in the upper half order. | |
| */ | |
| error ECDSAInvalidSignatureS(bytes32 s); | |
| /** | |
| * @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not | |
| * return address(0) without also returning an error description. Errors are documented using an enum (error type) | |
| * and a bytes32 providing additional information about the error. | |
| * | |
| * If no error is returned, then the address can be used for verification purposes. | |
| * | |
| * The `ecrecover` EVM precompile allows for malleable (non-unique) signatures: | |
| * this function rejects them by requiring the `s` value to be in the lower | |
| * half order, and the `v` value to be either 27 or 28. | |
| * | |
| * IMPORTANT: `hash` _must_ be the result of a hash operation for the | |
| * verification to be secure: it is possible to craft signatures that | |
| * recover to arbitrary addresses for non-hashed data. A safe way to ensure | |
| * this is by receiving a hash of the original message (which may otherwise | |
| * be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it. | |
| * | |
| * Documentation for signature generation: | |
| * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js] | |
| * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers] | |
| */ | |
| function tryRecover( | |
| bytes32 hash, | |
| bytes memory signature | |
| ) internal pure returns (address recovered, RecoverError err, bytes32 errArg) { | |
| if (signature.length == 65) { | |
| bytes32 r; | |
| bytes32 s; | |
| uint8 v; | |
| // ecrecover takes the signature parameters, and the only way to get them | |
| // currently is to use assembly. | |
| assembly ("memory-safe") { | |
| r := mload(add(signature, 0x20)) | |
| s := mload(add(signature, 0x40)) | |
| v := byte(0, mload(add(signature, 0x60))) | |
| } | |
| return tryRecover(hash, v, r, s); | |
| } else { | |
| return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length)); | |
| } | |
| } | |
| /** | |
| * @dev Returns the address that signed a hashed message (`hash`) with | |
| * `signature`. This address can then be used for verification purposes. | |
| * | |
| * The `ecrecover` EVM precompile allows for malleable (non-unique) signatures: | |
| * this function rejects them by requiring the `s` value to be in the lower | |
| * half order, and the `v` value to be either 27 or 28. | |
| * | |
| * IMPORTANT: `hash` _must_ be the result of a hash operation for the | |
| * verification to be secure: it is possible to craft signatures that | |
| * recover to arbitrary addresses for non-hashed data. A safe way to ensure | |
| * this is by receiving a hash of the original message (which may otherwise | |
| * be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it. | |
| */ | |
| function recover(bytes32 hash, bytes memory signature) internal pure returns (address) { | |
| (address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature); | |
| _throwError(error, errorArg); | |
| return recovered; | |
| } | |
| /** | |
| * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately. | |
| * | |
| * See https://eips.ethereum.org/EIPS/eip-2098[ERC-2098 short signatures] | |
| */ | |
| function tryRecover( | |
| bytes32 hash, | |
| bytes32 r, | |
| bytes32 vs | |
| ) internal pure returns (address recovered, RecoverError err, bytes32 errArg) { | |
| unchecked { | |
| bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff); | |
| // We do not check for an overflow here since the shift operation results in 0 or 1. | |
| uint8 v = uint8((uint256(vs) >> 255) + 27); | |
| return tryRecover(hash, v, r, s); | |
| } | |
| } | |
| /** | |
| * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately. | |
| */ | |
| function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) { | |
| (address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs); | |
| _throwError(error, errorArg); | |
| return recovered; | |
| } | |
| /** | |
| * @dev Overload of {ECDSA-tryRecover} that receives the `v`, | |
| * `r` and `s` signature fields separately. | |
| */ | |
| function tryRecover( | |
| bytes32 hash, | |
| uint8 v, | |
| bytes32 r, | |
| bytes32 s | |
| ) internal pure returns (address recovered, RecoverError err, bytes32 errArg) { | |
| // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature | |
| // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines | |
| // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most | |
| // signatures from current libraries generate a unique signature with an s-value in the lower half order. | |
| // | |
| // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value | |
| // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or | |
| // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept | |
| // these malleable signatures as well. | |
| if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) { | |
| return (address(0), RecoverError.InvalidSignatureS, s); | |
| } | |
| // If the signature is valid (and not malleable), return the signer address | |
| address signer = ecrecover(hash, v, r, s); | |
| if (signer == address(0)) { | |
| return (address(0), RecoverError.InvalidSignature, bytes32(0)); | |
| } | |
| return (signer, RecoverError.NoError, bytes32(0)); | |
| } | |
| /** | |
| * @dev Overload of {ECDSA-recover} that receives the `v`, | |
| * `r` and `s` signature fields separately. | |
| */ | |
| function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) { | |
| (address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s); | |
| _throwError(error, errorArg); | |
| return recovered; | |
| } | |
| /** | |
| * @dev Optionally reverts with the corresponding custom error according to the `error` argument provided. | |
| */ | |
| function _throwError(RecoverError error, bytes32 errorArg) private pure { | |
| if (error == RecoverError.NoError) { | |
| return; // no error: do nothing | |
| } else if (error == RecoverError.InvalidSignature) { | |
| revert ECDSAInvalidSignature(); | |
| } else if (error == RecoverError.InvalidSignatureLength) { | |
| revert ECDSAInvalidSignatureLength(uint256(errorArg)); | |
| } else if (error == RecoverError.InvalidSignatureS) { | |
| revert ECDSAInvalidSignatureS(errorArg); | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/EIP712.sol) | |
| pragma solidity ^0.8.20; | |
| import {MessageHashUtils} from "./MessageHashUtils.sol"; | |
| import {ShortStrings, ShortString} from "../ShortStrings.sol"; | |
| import {IERC5267} from "../../interfaces/IERC5267.sol"; | |
| /** | |
| * @dev https://eips.ethereum.org/EIPS/eip-712[EIP-712] is a standard for hashing and signing of typed structured data. | |
| * | |
| * The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose | |
| * encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract | |
| * does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to | |
| * produce the hash of their typed data using a combination of `abi.encode` and `keccak256`. | |
| * | |
| * This contract implements the EIP-712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding | |
| * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA | |
| * ({_hashTypedDataV4}). | |
| * | |
| * The implementation of the domain separator was designed to be as efficient as possible while still properly updating | |
| * the chain id to protect against replay attacks on an eventual fork of the chain. | |
| * | |
| * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method | |
| * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask]. | |
| * | |
| * NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain | |
| * separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the | |
| * separator from the immutable values, which is cheaper than accessing a cached version in cold storage. | |
| * | |
| * @custom:oz-upgrades-unsafe-allow state-variable-immutable | |
| */ | |
| abstract contract EIP712 is IERC5267 { | |
| using ShortStrings for *; | |
| bytes32 private constant TYPE_HASH = | |
| keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"); | |
| // Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to | |
| // invalidate the cached domain separator if the chain id changes. | |
| bytes32 private immutable _cachedDomainSeparator; | |
| uint256 private immutable _cachedChainId; | |
| address private immutable _cachedThis; | |
| bytes32 private immutable _hashedName; | |
| bytes32 private immutable _hashedVersion; | |
| ShortString private immutable _name; | |
| ShortString private immutable _version; | |
| // slither-disable-next-line constable-states | |
| string private _nameFallback; | |
| // slither-disable-next-line constable-states | |
| string private _versionFallback; | |
| /** | |
| * @dev Initializes the domain separator and parameter caches. | |
| * | |
| * The meaning of `name` and `version` is specified in | |
| * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP-712]: | |
| * | |
| * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol. | |
| * - `version`: the current major version of the signing domain. | |
| * | |
| * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart | |
| * contract upgrade]. | |
| */ | |
| constructor(string memory name, string memory version) { | |
| _name = name.toShortStringWithFallback(_nameFallback); | |
| _version = version.toShortStringWithFallback(_versionFallback); | |
| _hashedName = keccak256(bytes(name)); | |
| _hashedVersion = keccak256(bytes(version)); | |
| _cachedChainId = block.chainid; | |
| _cachedDomainSeparator = _buildDomainSeparator(); | |
| _cachedThis = address(this); | |
| } | |
| /** | |
| * @dev Returns the domain separator for the current chain. | |
| */ | |
| function _domainSeparatorV4() internal view returns (bytes32) { | |
| if (address(this) == _cachedThis && block.chainid == _cachedChainId) { | |
| return _cachedDomainSeparator; | |
| } else { | |
| return _buildDomainSeparator(); | |
| } | |
| } | |
| function _buildDomainSeparator() private view returns (bytes32) { | |
| return keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this))); | |
| } | |
| /** | |
| * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this | |
| * function returns the hash of the fully encoded EIP712 message for this domain. | |
| * | |
| * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example: | |
| * | |
| * ```solidity | |
| * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode( | |
| * keccak256("Mail(address to,string contents)"), | |
| * mailTo, | |
| * keccak256(bytes(mailContents)) | |
| * ))); | |
| * address signer = ECDSA.recover(digest, signature); | |
| * ``` | |
| */ | |
| function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) { | |
| return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash); | |
| } | |
| /// @inheritdoc IERC5267 | |
| function eip712Domain() | |
| public | |
| view | |
| virtual | |
| returns ( | |
| bytes1 fields, | |
| string memory name, | |
| string memory version, | |
| uint256 chainId, | |
| address verifyingContract, | |
| bytes32 salt, | |
| uint256[] memory extensions | |
| ) | |
| { | |
| return ( | |
| hex"0f", // 01111 | |
| _EIP712Name(), | |
| _EIP712Version(), | |
| block.chainid, | |
| address(this), | |
| bytes32(0), | |
| new uint256[](0) | |
| ); | |
| } | |
| /** | |
| * @dev The name parameter for the EIP712 domain. | |
| * | |
| * NOTE: By default this function reads _name which is an immutable value. | |
| * It only reads from storage if necessary (in case the value is too large to fit in a ShortString). | |
| */ | |
| // solhint-disable-next-line func-name-mixedcase | |
| function _EIP712Name() internal view returns (string memory) { | |
| return _name.toStringWithFallback(_nameFallback); | |
| } | |
| /** | |
| * @dev The version parameter for the EIP712 domain. | |
| * | |
| * NOTE: By default this function reads _version which is an immutable value. | |
| * It only reads from storage if necessary (in case the value is too large to fit in a ShortString). | |
| */ | |
| // solhint-disable-next-line func-name-mixedcase | |
| function _EIP712Version() internal view returns (string memory) { | |
| return _version.toStringWithFallback(_versionFallback); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.3.0) (utils/cryptography/MessageHashUtils.sol) | |
| pragma solidity ^0.8.20; | |
| import {Strings} from "../Strings.sol"; | |
| /** | |
| * @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing. | |
| * | |
| * The library provides methods for generating a hash of a message that conforms to the | |
| * https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712] | |
| * specifications. | |
| */ | |
| library MessageHashUtils { | |
| /** | |
| * @dev Returns the keccak256 digest of an ERC-191 signed data with version | |
| * `0x45` (`personal_sign` messages). | |
| * | |
| * The digest is calculated by prefixing a bytes32 `messageHash` with | |
| * `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the | |
| * hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method. | |
| * | |
| * NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with | |
| * keccak256, although any bytes32 value can be safely used because the final digest will | |
| * be re-hashed. | |
| * | |
| * See {ECDSA-recover}. | |
| */ | |
| function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) { | |
| assembly ("memory-safe") { | |
| mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash | |
| mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix | |
| digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20) | |
| } | |
| } | |
| /** | |
| * @dev Returns the keccak256 digest of an ERC-191 signed data with version | |
| * `0x45` (`personal_sign` messages). | |
| * | |
| * The digest is calculated by prefixing an arbitrary `message` with | |
| * `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the | |
| * hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method. | |
| * | |
| * See {ECDSA-recover}. | |
| */ | |
| function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) { | |
| return | |
| keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message)); | |
| } | |
| /** | |
| * @dev Returns the keccak256 digest of an ERC-191 signed data with version | |
| * `0x00` (data with intended validator). | |
| * | |
| * The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended | |
| * `validator` address. Then hashing the result. | |
| * | |
| * See {ECDSA-recover}. | |
| */ | |
| function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) { | |
| return keccak256(abi.encodePacked(hex"19_00", validator, data)); | |
| } | |
| /** | |
| * @dev Variant of {toDataWithIntendedValidatorHash-address-bytes} optimized for cases where `data` is a bytes32. | |
| */ | |
| function toDataWithIntendedValidatorHash( | |
| address validator, | |
| bytes32 messageHash | |
| ) internal pure returns (bytes32 digest) { | |
| assembly ("memory-safe") { | |
| mstore(0x00, hex"19_00") | |
| mstore(0x02, shl(96, validator)) | |
| mstore(0x16, messageHash) | |
| digest := keccak256(0x00, 0x36) | |
| } | |
| } | |
| /** | |
| * @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`). | |
| * | |
| * The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with | |
| * `\x19\x01` and hashing the result. It corresponds to the hash signed by the | |
| * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712. | |
| * | |
| * See {ECDSA-recover}. | |
| */ | |
| function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) { | |
| assembly ("memory-safe") { | |
| let ptr := mload(0x40) | |
| mstore(ptr, hex"19_01") | |
| mstore(add(ptr, 0x02), domainSeparator) | |
| mstore(add(ptr, 0x22), structHash) | |
| digest := keccak256(ptr, 0x42) | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/signers/AbstractSigner.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Abstract contract for signature validation. | |
| * | |
| * Developers must implement {_rawSignatureValidation} and use it as the lowest-level signature validation mechanism. | |
| * | |
| * @custom:stateless | |
| */ | |
| abstract contract AbstractSigner { | |
| /** | |
| * @dev Signature validation algorithm. | |
| * | |
| * WARNING: Implementing a signature validation algorithm is a security-sensitive operation as it involves | |
| * cryptographic verification. It is important to review and test thoroughly before deployment. Consider | |
| * using one of the signature verification libraries (xref:api:utils/cryptography#ECDSA[ECDSA], | |
| * xref:api:utils/cryptography#P256[P256] or xref:api:utils/cryptography#RSA[RSA]). | |
| */ | |
| function _rawSignatureValidation(bytes32 hash, bytes calldata signature) internal view virtual returns (bool); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/signers/draft-ERC7739.sol) | |
| pragma solidity ^0.8.20; | |
| import {AbstractSigner} from "./AbstractSigner.sol"; | |
| import {EIP712} from "../EIP712.sol"; | |
| import {ERC7739Utils} from "../draft-ERC7739Utils.sol"; | |
| import {IERC1271} from "../../../interfaces/IERC1271.sol"; | |
| import {MessageHashUtils} from "../MessageHashUtils.sol"; | |
| import {ShortStrings} from "../../ShortStrings.sol"; | |
| /** | |
| * @dev Validates signatures wrapping the message hash in a nested EIP712 type. See {ERC7739Utils}. | |
| * | |
| * Linking the signature to the EIP-712 domain separator is a security measure to prevent signature replay across different | |
| * EIP-712 domains (e.g. a single offchain owner of multiple contracts). | |
| * | |
| * This contract requires implementing the {_rawSignatureValidation} function, which passes the wrapped message hash, | |
| * which may be either an typed data or a personal sign nested type. | |
| * | |
| * NOTE: xref:api:utils/cryptography#EIP712[EIP-712] uses xref:api:utils/cryptography#ShortStrings[ShortStrings] to | |
| * optimize gas costs for short strings (up to 31 characters). Consider that strings longer than that will use storage, | |
| * which may limit the ability of the signer to be used within the ERC-4337 validation phase (due to | |
| * https://eips.ethereum.org/EIPS/eip-7562#storage-rules[ERC-7562 storage access rules]). | |
| */ | |
| abstract contract ERC7739 is AbstractSigner, EIP712, IERC1271 { | |
| using ERC7739Utils for *; | |
| using MessageHashUtils for bytes32; | |
| /** | |
| * @dev Attempts validating the signature in a nested EIP-712 type. | |
| * | |
| * A nested EIP-712 type might be presented in 2 different ways: | |
| * | |
| * - As a nested EIP-712 typed data | |
| * - As a _personal_ signature (an EIP-712 mimic of the `eth_personalSign` for a smart contract) | |
| */ | |
| function isValidSignature(bytes32 hash, bytes calldata signature) public view virtual returns (bytes4 result) { | |
| // For the hash `0x7739773977397739773977397739773977397739773977397739773977397739` and an empty signature, | |
| // we return the magic value `0x77390001` as it's assumed impossible to find a preimage for it that can be used | |
| // maliciously. Useful for simulation purposes and to validate whether the contract supports ERC-7739. | |
| return | |
| (_isValidNestedTypedDataSignature(hash, signature) || _isValidNestedPersonalSignSignature(hash, signature)) | |
| ? IERC1271.isValidSignature.selector | |
| : (hash == 0x7739773977397739773977397739773977397739773977397739773977397739 && signature.length == 0) | |
| ? bytes4(0x77390001) | |
| : bytes4(0xffffffff); | |
| } | |
| /** | |
| * @dev Nested personal signature verification. | |
| */ | |
| function _isValidNestedPersonalSignSignature(bytes32 hash, bytes calldata signature) private view returns (bool) { | |
| return _rawSignatureValidation(_domainSeparatorV4().toTypedDataHash(hash.personalSignStructHash()), signature); | |
| } | |
| /** | |
| * @dev Nested EIP-712 typed data verification. | |
| */ | |
| function _isValidNestedTypedDataSignature( | |
| bytes32 hash, | |
| bytes calldata encodedSignature | |
| ) private view returns (bool) { | |
| // decode signature | |
| ( | |
| bytes calldata signature, | |
| bytes32 appSeparator, | |
| bytes32 contentsHash, | |
| string calldata contentsDescr | |
| ) = encodedSignature.decodeTypedDataSig(); | |
| ( | |
| , | |
| string memory name, | |
| string memory version, | |
| uint256 chainId, | |
| address verifyingContract, | |
| bytes32 salt, | |
| ) = eip712Domain(); | |
| // Check that contentHash and separator are correct | |
| // Rebuild nested hash | |
| return | |
| hash == appSeparator.toTypedDataHash(contentsHash) && | |
| bytes(contentsDescr).length != 0 && | |
| _rawSignatureValidation( | |
| appSeparator.toTypedDataHash( | |
| ERC7739Utils.typedDataSignStructHash( | |
| contentsDescr, | |
| contentsHash, | |
| abi.encode(keccak256(bytes(name)), keccak256(bytes(version)), chainId, verifyingContract, salt) | |
| ) | |
| ), | |
| signature | |
| ); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/signers/SignerECDSA.sol) | |
| pragma solidity ^0.8.20; | |
| import {AbstractSigner} from "./AbstractSigner.sol"; | |
| import {ECDSA} from "../ECDSA.sol"; | |
| /** | |
| * @dev Implementation of {AbstractSigner} using xref:api:utils/cryptography#ECDSA[ECDSA] signatures. | |
| * | |
| * For {Account} usage, a {_setSigner} function is provided to set the {signer} address. | |
| * Doing so is easier for a factory, who is likely to use initializable clones of this contract. | |
| * | |
| * Example of usage: | |
| * | |
| * ```solidity | |
| * contract MyAccountECDSA is Account, SignerECDSA, Initializable { | |
| * function initialize(address signerAddr) public initializer { | |
| * _setSigner(signerAddr); | |
| * } | |
| * } | |
| * ``` | |
| * | |
| * IMPORTANT: Failing to call {_setSigner} either during construction (if used standalone) | |
| * or during initialization (if used as a clone) may leave the signer either front-runnable or unusable. | |
| */ | |
| abstract contract SignerECDSA is AbstractSigner { | |
| address private _signer; | |
| constructor(address signerAddr) { | |
| _setSigner(signerAddr); | |
| } | |
| /** | |
| * @dev Sets the signer with the address of the native signer. This function should be called during construction | |
| * or through an initializer. | |
| */ | |
| function _setSigner(address signerAddr) internal { | |
| _signer = signerAddr; | |
| } | |
| /// @dev Return the signer's address. | |
| function signer() public view virtual returns (address) { | |
| return _signer; | |
| } | |
| /// @inheritdoc AbstractSigner | |
| function _rawSignatureValidation( | |
| bytes32 hash, | |
| bytes calldata signature | |
| ) internal view virtual override returns (bool) { | |
| (address recovered, ECDSA.RecoverError err, ) = ECDSA.tryRecover(hash, signature); | |
| return signer() == recovered && err == ECDSA.RecoverError.NoError; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/ERC165.sol) | |
| pragma solidity ^0.8.20; | |
| import {IERC165} from "./IERC165.sol"; | |
| /** | |
| * @dev Implementation of the {IERC165} interface. | |
| * | |
| * Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check | |
| * for the additional interface id that will be supported. For example: | |
| * | |
| * ```solidity | |
| * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { | |
| * return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId); | |
| * } | |
| * ``` | |
| */ | |
| abstract contract ERC165 is IERC165 { | |
| /// @inheritdoc IERC165 | |
| function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) { | |
| return interfaceId == type(IERC165).interfaceId; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol) | |
| pragma solidity >=0.4.16; | |
| /** | |
| * @dev Interface of the ERC-165 standard, as defined in the | |
| * https://eips.ethereum.org/EIPS/eip-165[ERC]. | |
| * | |
| * 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[ERC 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); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.3.0) (utils/math/Math.sol) | |
| pragma solidity ^0.8.20; | |
| import {Panic} from "../Panic.sol"; | |
| import {SafeCast} from "./SafeCast.sol"; | |
| /** | |
| * @dev Standard math utilities missing in the Solidity language. | |
| */ | |
| library Math { | |
| enum Rounding { | |
| Floor, // Toward negative infinity | |
| Ceil, // Toward positive infinity | |
| Trunc, // Toward zero | |
| Expand // Away from zero | |
| } | |
| /** | |
| * @dev Return the 512-bit addition of two uint256. | |
| * | |
| * The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low. | |
| */ | |
| function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) { | |
| assembly ("memory-safe") { | |
| low := add(a, b) | |
| high := lt(low, a) | |
| } | |
| } | |
| /** | |
| * @dev Return the 512-bit multiplication of two uint256. | |
| * | |
| * The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low. | |
| */ | |
| function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) { | |
| // 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use | |
| // the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256 | |
| // variables such that product = high * 2²⁵⁶ + low. | |
| assembly ("memory-safe") { | |
| let mm := mulmod(a, b, not(0)) | |
| low := mul(a, b) | |
| high := sub(sub(mm, low), lt(mm, low)) | |
| } | |
| } | |
| /** | |
| * @dev Returns the addition of two unsigned integers, with a success flag (no overflow). | |
| */ | |
| function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) { | |
| unchecked { | |
| uint256 c = a + b; | |
| success = c >= a; | |
| result = c * SafeCast.toUint(success); | |
| } | |
| } | |
| /** | |
| * @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow). | |
| */ | |
| function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) { | |
| unchecked { | |
| uint256 c = a - b; | |
| success = c <= a; | |
| result = c * SafeCast.toUint(success); | |
| } | |
| } | |
| /** | |
| * @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow). | |
| */ | |
| function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) { | |
| unchecked { | |
| uint256 c = a * b; | |
| assembly ("memory-safe") { | |
| // Only true when the multiplication doesn't overflow | |
| // (c / a == b) || (a == 0) | |
| success := or(eq(div(c, a), b), iszero(a)) | |
| } | |
| // equivalent to: success ? c : 0 | |
| result = c * SafeCast.toUint(success); | |
| } | |
| } | |
| /** | |
| * @dev Returns the division of two unsigned integers, with a success flag (no division by zero). | |
| */ | |
| function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) { | |
| unchecked { | |
| success = b > 0; | |
| assembly ("memory-safe") { | |
| // The `DIV` opcode returns zero when the denominator is 0. | |
| result := div(a, b) | |
| } | |
| } | |
| } | |
| /** | |
| * @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero). | |
| */ | |
| function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) { | |
| unchecked { | |
| success = b > 0; | |
| assembly ("memory-safe") { | |
| // The `MOD` opcode returns zero when the denominator is 0. | |
| result := mod(a, b) | |
| } | |
| } | |
| } | |
| /** | |
| * @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing. | |
| */ | |
| function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) { | |
| (bool success, uint256 result) = tryAdd(a, b); | |
| return ternary(success, result, type(uint256).max); | |
| } | |
| /** | |
| * @dev Unsigned saturating subtraction, bounds to zero instead of overflowing. | |
| */ | |
| function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) { | |
| (, uint256 result) = trySub(a, b); | |
| return result; | |
| } | |
| /** | |
| * @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing. | |
| */ | |
| function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) { | |
| (bool success, uint256 result) = tryMul(a, b); | |
| return ternary(success, result, type(uint256).max); | |
| } | |
| /** | |
| * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant. | |
| * | |
| * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone. | |
| * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute | |
| * one branch when needed, making this function more expensive. | |
| */ | |
| function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) { | |
| unchecked { | |
| // branchless ternary works because: | |
| // b ^ (a ^ b) == a | |
| // b ^ 0 == b | |
| return b ^ ((a ^ b) * SafeCast.toUint(condition)); | |
| } | |
| } | |
| /** | |
| * @dev Returns the largest of two numbers. | |
| */ | |
| function max(uint256 a, uint256 b) internal pure returns (uint256) { | |
| return ternary(a > b, a, b); | |
| } | |
| /** | |
| * @dev Returns the smallest of two numbers. | |
| */ | |
| function min(uint256 a, uint256 b) internal pure returns (uint256) { | |
| return ternary(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. | |
| Panic.panic(Panic.DIVISION_BY_ZERO); | |
| } | |
| // The following calculation ensures accurate ceiling division without overflow. | |
| // Since a is non-zero, (a - 1) / b will not overflow. | |
| // The largest possible result occurs when (a - 1) / b is type(uint256).max, | |
| // but the largest value we can obtain is type(uint256).max - 1, which happens | |
| // when a = type(uint256).max and b = 1. | |
| unchecked { | |
| return SafeCast.toUint(a > 0) * ((a - 1) / b + 1); | |
| } | |
| } | |
| /** | |
| * @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or | |
| * denominator == 0. | |
| * | |
| * 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 { | |
| (uint256 high, uint256 low) = mul512(x, y); | |
| // Handle non-overflow cases, 256 by 256 division. | |
| if (high == 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 low / denominator; | |
| } | |
| // Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0. | |
| if (denominator <= high) { | |
| Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW)); | |
| } | |
| /////////////////////////////////////////////// | |
| // 512 by 256 division. | |
| /////////////////////////////////////////////// | |
| // Make division exact by subtracting the remainder from [high low]. | |
| uint256 remainder; | |
| assembly ("memory-safe") { | |
| // Compute remainder using mulmod. | |
| remainder := mulmod(x, y, denominator) | |
| // Subtract 256 bit number from 512 bit number. | |
| high := sub(high, gt(remainder, low)) | |
| low := sub(low, 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 ("memory-safe") { | |
| // Divide denominator by twos. | |
| denominator := div(denominator, twos) | |
| // Divide [high low] by twos. | |
| low := div(low, twos) | |
| // Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one. | |
| twos := add(div(sub(0, twos), twos), 1) | |
| } | |
| // Shift in bits from high into low. | |
| low |= high * twos; | |
| // Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such | |
| // that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for | |
| // four bits. That is, denominator * inv ≡ 1 mod 2⁴. | |
| 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⁸ | |
| inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶ | |
| inverse *= 2 - denominator * inverse; // inverse mod 2³² | |
| inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴ | |
| inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸ | |
| inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶ | |
| // 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²⁵⁶. Since the preconditions guarantee that the outcome is | |
| // less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high | |
| // is no longer required. | |
| result = low * inverse; | |
| return result; | |
| } | |
| } | |
| /** | |
| * @dev 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) { | |
| return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0); | |
| } | |
| /** | |
| * @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256. | |
| */ | |
| function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) { | |
| unchecked { | |
| (uint256 high, uint256 low) = mul512(x, y); | |
| if (high >= 1 << n) { | |
| Panic.panic(Panic.UNDER_OVERFLOW); | |
| } | |
| return (high << (256 - n)) | (low >> n); | |
| } | |
| } | |
| /** | |
| * @dev Calculates x * y >> n with full precision, following the selected rounding direction. | |
| */ | |
| function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) { | |
| return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0); | |
| } | |
| /** | |
| * @dev Calculate the modular multiplicative inverse of a number in Z/nZ. | |
| * | |
| * If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0. | |
| * If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible. | |
| * | |
| * If the input value is not inversible, 0 is returned. | |
| * | |
| * NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the | |
| * inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}. | |
| */ | |
| function invMod(uint256 a, uint256 n) internal pure returns (uint256) { | |
| unchecked { | |
| if (n == 0) return 0; | |
| // The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version) | |
| // Used to compute integers x and y such that: ax + ny = gcd(a, n). | |
| // When the gcd is 1, then the inverse of a modulo n exists and it's x. | |
| // ax + ny = 1 | |
| // ax = 1 + (-y)n | |
| // ax ≡ 1 (mod n) # x is the inverse of a modulo n | |
| // If the remainder is 0 the gcd is n right away. | |
| uint256 remainder = a % n; | |
| uint256 gcd = n; | |
| // Therefore the initial coefficients are: | |
| // ax + ny = gcd(a, n) = n | |
| // 0a + 1n = n | |
| int256 x = 0; | |
| int256 y = 1; | |
| while (remainder != 0) { | |
| uint256 quotient = gcd / remainder; | |
| (gcd, remainder) = ( | |
| // The old remainder is the next gcd to try. | |
| remainder, | |
| // Compute the next remainder. | |
| // Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd | |
| // where gcd is at most n (capped to type(uint256).max) | |
| gcd - remainder * quotient | |
| ); | |
| (x, y) = ( | |
| // Increment the coefficient of a. | |
| y, | |
| // Decrement the coefficient of n. | |
| // Can overflow, but the result is casted to uint256 so that the | |
| // next value of y is "wrapped around" to a value between 0 and n - 1. | |
| x - y * int256(quotient) | |
| ); | |
| } | |
| if (gcd != 1) return 0; // No inverse exists. | |
| return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative. | |
| } | |
| } | |
| /** | |
| * @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`. | |
| * | |
| * From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is | |
| * prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that | |
| * `a**(p-2)` is the modular multiplicative inverse of a in Fp. | |
| * | |
| * NOTE: this function does NOT check that `p` is a prime greater than `2`. | |
| */ | |
| function invModPrime(uint256 a, uint256 p) internal view returns (uint256) { | |
| unchecked { | |
| return Math.modExp(a, p - 2, p); | |
| } | |
| } | |
| /** | |
| * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m) | |
| * | |
| * Requirements: | |
| * - modulus can't be zero | |
| * - underlying staticcall to precompile must succeed | |
| * | |
| * IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make | |
| * sure the chain you're using it on supports the precompiled contract for modular exponentiation | |
| * at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, | |
| * the underlying function will succeed given the lack of a revert, but the result may be incorrectly | |
| * interpreted as 0. | |
| */ | |
| function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) { | |
| (bool success, uint256 result) = tryModExp(b, e, m); | |
| if (!success) { | |
| Panic.panic(Panic.DIVISION_BY_ZERO); | |
| } | |
| return result; | |
| } | |
| /** | |
| * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m). | |
| * It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying | |
| * to operate modulo 0 or if the underlying precompile reverted. | |
| * | |
| * IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain | |
| * you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in | |
| * https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack | |
| * of a revert, but the result may be incorrectly interpreted as 0. | |
| */ | |
| function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) { | |
| if (m == 0) return (false, 0); | |
| assembly ("memory-safe") { | |
| let ptr := mload(0x40) | |
| // | Offset | Content | Content (Hex) | | |
| // |-----------|------------|--------------------------------------------------------------------| | |
| // | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 | | |
| // | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 | | |
| // | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 | | |
| // | 0x60:0x7f | value of b | 0x<.............................................................b> | | |
| // | 0x80:0x9f | value of e | 0x<.............................................................e> | | |
| // | 0xa0:0xbf | value of m | 0x<.............................................................m> | | |
| mstore(ptr, 0x20) | |
| mstore(add(ptr, 0x20), 0x20) | |
| mstore(add(ptr, 0x40), 0x20) | |
| mstore(add(ptr, 0x60), b) | |
| mstore(add(ptr, 0x80), e) | |
| mstore(add(ptr, 0xa0), m) | |
| // Given the result < m, it's guaranteed to fit in 32 bytes, | |
| // so we can use the memory scratch space located at offset 0. | |
| success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20) | |
| result := mload(0x00) | |
| } | |
| } | |
| /** | |
| * @dev Variant of {modExp} that supports inputs of arbitrary length. | |
| */ | |
| function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) { | |
| (bool success, bytes memory result) = tryModExp(b, e, m); | |
| if (!success) { | |
| Panic.panic(Panic.DIVISION_BY_ZERO); | |
| } | |
| return result; | |
| } | |
| /** | |
| * @dev Variant of {tryModExp} that supports inputs of arbitrary length. | |
| */ | |
| function tryModExp( | |
| bytes memory b, | |
| bytes memory e, | |
| bytes memory m | |
| ) internal view returns (bool success, bytes memory result) { | |
| if (_zeroBytes(m)) return (false, new bytes(0)); | |
| uint256 mLen = m.length; | |
| // Encode call args in result and move the free memory pointer | |
| result = abi.encodePacked(b.length, e.length, mLen, b, e, m); | |
| assembly ("memory-safe") { | |
| let dataPtr := add(result, 0x20) | |
| // Write result on top of args to avoid allocating extra memory. | |
| success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen) | |
| // Overwrite the length. | |
| // result.length > returndatasize() is guaranteed because returndatasize() == m.length | |
| mstore(result, mLen) | |
| // Set the memory pointer after the returned data. | |
| mstore(0x40, add(dataPtr, mLen)) | |
| } | |
| } | |
| /** | |
| * @dev Returns whether the provided byte array is zero. | |
| */ | |
| function _zeroBytes(bytes memory byteArray) private pure returns (bool) { | |
| for (uint256 i = 0; i < byteArray.length; ++i) { | |
| if (byteArray[i] != 0) { | |
| return false; | |
| } | |
| } | |
| return true; | |
| } | |
| /** | |
| * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded | |
| * towards zero. | |
| * | |
| * This method is based on Newton's method for computing square roots; the algorithm is restricted to only | |
| * using integer operations. | |
| */ | |
| function sqrt(uint256 a) internal pure returns (uint256) { | |
| unchecked { | |
| // Take care of easy edge cases when a == 0 or a == 1 | |
| if (a <= 1) { | |
| return a; | |
| } | |
| // In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a | |
| // sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between | |
| // the current value as `ε_n = | x_n - sqrt(a) |`. | |
| // | |
| // For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root | |
| // of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is | |
| // bigger than any uint256. | |
| // | |
| // By noticing that | |
| // `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)` | |
| // we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar | |
| // to the msb function. | |
| uint256 aa = a; | |
| uint256 xn = 1; | |
| if (aa >= (1 << 128)) { | |
| aa >>= 128; | |
| xn <<= 64; | |
| } | |
| if (aa >= (1 << 64)) { | |
| aa >>= 64; | |
| xn <<= 32; | |
| } | |
| if (aa >= (1 << 32)) { | |
| aa >>= 32; | |
| xn <<= 16; | |
| } | |
| if (aa >= (1 << 16)) { | |
| aa >>= 16; | |
| xn <<= 8; | |
| } | |
| if (aa >= (1 << 8)) { | |
| aa >>= 8; | |
| xn <<= 4; | |
| } | |
| if (aa >= (1 << 4)) { | |
| aa >>= 4; | |
| xn <<= 2; | |
| } | |
| if (aa >= (1 << 2)) { | |
| xn <<= 1; | |
| } | |
| // We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1). | |
| // | |
| // We can refine our estimation by noticing that the middle of that interval minimizes the error. | |
| // If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2). | |
| // This is going to be our x_0 (and ε_0) | |
| xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2) | |
| // From here, Newton's method give us: | |
| // x_{n+1} = (x_n + a / x_n) / 2 | |
| // | |
| // One should note that: | |
| // x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a | |
| // = ((x_n² + a) / (2 * x_n))² - a | |
| // = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a | |
| // = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²) | |
| // = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²) | |
| // = (x_n² - a)² / (2 * x_n)² | |
| // = ((x_n² - a) / (2 * x_n))² | |
| // ≥ 0 | |
| // Which proves that for all n ≥ 1, sqrt(a) ≤ x_n | |
| // | |
| // This gives us the proof of quadratic convergence of the sequence: | |
| // ε_{n+1} = | x_{n+1} - sqrt(a) | | |
| // = | (x_n + a / x_n) / 2 - sqrt(a) | | |
| // = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) | | |
| // = | (x_n - sqrt(a))² / (2 * x_n) | | |
| // = | ε_n² / (2 * x_n) | | |
| // = ε_n² / | (2 * x_n) | | |
| // | |
| // For the first iteration, we have a special case where x_0 is known: | |
| // ε_1 = ε_0² / | (2 * x_0) | | |
| // ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2))) | |
| // ≤ 2**(2*e-4) / (3 * 2**(e-1)) | |
| // ≤ 2**(e-3) / 3 | |
| // ≤ 2**(e-3-log2(3)) | |
| // ≤ 2**(e-4.5) | |
| // | |
| // For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n: | |
| // ε_{n+1} = ε_n² / | (2 * x_n) | | |
| // ≤ (2**(e-k))² / (2 * 2**(e-1)) | |
| // ≤ 2**(2*e-2*k) / 2**e | |
| // ≤ 2**(e-2*k) | |
| xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above | |
| xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5 | |
| xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9 | |
| xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18 | |
| xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36 | |
| xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72 | |
| // Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision | |
| // ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either | |
| // sqrt(a) or sqrt(a) + 1. | |
| return xn - SafeCast.toUint(xn > a / xn); | |
| } | |
| } | |
| /** | |
| * @dev 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a); | |
| } | |
| } | |
| /** | |
| * @dev Return the log in base 2 of a positive value rounded towards zero. | |
| * Returns 0 if given 0. | |
| */ | |
| function log2(uint256 x) internal pure returns (uint256 r) { | |
| // If value has upper 128 bits set, log2 result is at least 128 | |
| r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7; | |
| // If upper 64 bits of 128-bit half set, add 64 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6; | |
| // If upper 32 bits of 64-bit half set, add 32 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5; | |
| // If upper 16 bits of 32-bit half set, add 16 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffff) << 4; | |
| // If upper 8 bits of 16-bit half set, add 8 to result | |
| r |= SafeCast.toUint((x >> r) > 0xff) << 3; | |
| // If upper 4 bits of 8-bit half set, add 4 to result | |
| r |= SafeCast.toUint((x >> r) > 0xf) << 2; | |
| // Shifts value right by the current result and use it as an index into this lookup table: | |
| // | |
| // | x (4 bits) | index | table[index] = MSB position | | |
| // |------------|---------|-----------------------------| | |
| // | 0000 | 0 | table[0] = 0 | | |
| // | 0001 | 1 | table[1] = 0 | | |
| // | 0010 | 2 | table[2] = 1 | | |
| // | 0011 | 3 | table[3] = 1 | | |
| // | 0100 | 4 | table[4] = 2 | | |
| // | 0101 | 5 | table[5] = 2 | | |
| // | 0110 | 6 | table[6] = 2 | | |
| // | 0111 | 7 | table[7] = 2 | | |
| // | 1000 | 8 | table[8] = 3 | | |
| // | 1001 | 9 | table[9] = 3 | | |
| // | 1010 | 10 | table[10] = 3 | | |
| // | 1011 | 11 | table[11] = 3 | | |
| // | 1100 | 12 | table[12] = 3 | | |
| // | 1101 | 13 | table[13] = 3 | | |
| // | 1110 | 14 | table[14] = 3 | | |
| // | 1111 | 15 | table[15] = 3 | | |
| // | |
| // The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes. | |
| assembly ("memory-safe") { | |
| r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000)) | |
| } | |
| } | |
| /** | |
| * @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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value); | |
| } | |
| } | |
| /** | |
| * @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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value); | |
| } | |
| } | |
| /** | |
| * @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 x) internal pure returns (uint256 r) { | |
| // If value has upper 128 bits set, log2 result is at least 128 | |
| r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7; | |
| // If upper 64 bits of 128-bit half set, add 64 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6; | |
| // If upper 32 bits of 64-bit half set, add 32 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5; | |
| // If upper 16 bits of 32-bit half set, add 16 to result | |
| r |= SafeCast.toUint((x >> r) > 0xffff) << 4; | |
| // Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8 | |
| return (r >> 3) | SafeCast.toUint((x >> r) > 0xff); | |
| } | |
| /** | |
| * @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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value); | |
| } | |
| } | |
| /** | |
| * @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; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol) | |
| // This file was procedurally generated from scripts/generate/templates/SafeCast.js. | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Wrappers over Solidity's uintXX/intXX/bool 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); | |
| } | |
| /** | |
| * @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump. | |
| */ | |
| function toUint(bool b) internal pure returns (uint256 u) { | |
| assembly ("memory-safe") { | |
| u := iszero(iszero(b)) | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SignedMath.sol) | |
| pragma solidity ^0.8.20; | |
| import {SafeCast} from "./SafeCast.sol"; | |
| /** | |
| * @dev Standard signed math utilities missing in the Solidity language. | |
| */ | |
| library SignedMath { | |
| /** | |
| * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant. | |
| * | |
| * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone. | |
| * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute | |
| * one branch when needed, making this function more expensive. | |
| */ | |
| function ternary(bool condition, int256 a, int256 b) internal pure returns (int256) { | |
| unchecked { | |
| // branchless ternary works because: | |
| // b ^ (a ^ b) == a | |
| // b ^ 0 == b | |
| return b ^ ((a ^ b) * int256(SafeCast.toUint(condition))); | |
| } | |
| } | |
| /** | |
| * @dev Returns the largest of two signed numbers. | |
| */ | |
| function max(int256 a, int256 b) internal pure returns (int256) { | |
| return ternary(a > b, a, b); | |
| } | |
| /** | |
| * @dev Returns the smallest of two signed numbers. | |
| */ | |
| function min(int256 a, int256 b) internal pure returns (int256) { | |
| return ternary(a < b, a, b); | |
| } | |
| /** | |
| * @dev Returns the average of two signed numbers without overflow. | |
| * The result is rounded towards zero. | |
| */ | |
| function average(int256 a, int256 b) internal pure returns (int256) { | |
| // Formula from the book "Hacker's Delight" | |
| int256 x = (a & b) + ((a ^ b) >> 1); | |
| return x + (int256(uint256(x) >> 255) & (a ^ b)); | |
| } | |
| /** | |
| * @dev Returns the absolute unsigned value of a signed value. | |
| */ | |
| function abs(int256 n) internal pure returns (uint256) { | |
| unchecked { | |
| // Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson. | |
| // Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift, | |
| // taking advantage of the most significant (or "sign" bit) in two's complement representation. | |
| // This opcode adds new most significant bits set to the value of the previous most significant bit. As a result, | |
| // the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative). | |
| int256 mask = n >> 255; | |
| // A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it. | |
| return uint256((n + mask) ^ mask); | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.0.0) (utils/Nonces.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Provides tracking nonces for addresses. Nonces will only increment. | |
| */ | |
| abstract contract Nonces { | |
| /** | |
| * @dev The nonce used for an `account` is not the expected current nonce. | |
| */ | |
| error InvalidAccountNonce(address account, uint256 currentNonce); | |
| mapping(address account => uint256) private _nonces; | |
| /** | |
| * @dev Returns the next unused nonce for an address. | |
| */ | |
| function nonces(address owner) public view virtual returns (uint256) { | |
| return _nonces[owner]; | |
| } | |
| /** | |
| * @dev Consumes a nonce. | |
| * | |
| * Returns the current value and increments nonce. | |
| */ | |
| function _useNonce(address owner) internal virtual returns (uint256) { | |
| // For each account, the nonce has an initial value of 0, can only be incremented by one, and cannot be | |
| // decremented or reset. This guarantees that the nonce never overflows. | |
| unchecked { | |
| // It is important to do x++ and not ++x here. | |
| return _nonces[owner]++; | |
| } | |
| } | |
| /** | |
| * @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`. | |
| */ | |
| function _useCheckedNonce(address owner, uint256 nonce) internal virtual { | |
| uint256 current = _useNonce(owner); | |
| if (nonce != current) { | |
| revert InvalidAccountNonce(owner, current); | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.2.0) (utils/Packing.sol) | |
| // This file was procedurally generated from scripts/generate/templates/Packing.js. | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Helper library packing and unpacking multiple values into bytesXX. | |
| * | |
| * Example usage: | |
| * | |
| * ```solidity | |
| * library MyPacker { | |
| * type MyType is bytes32; | |
| * | |
| * function _pack(address account, bytes4 selector, uint64 period) external pure returns (MyType) { | |
| * bytes12 subpack = Packing.pack_4_8(selector, bytes8(period)); | |
| * bytes32 pack = Packing.pack_20_12(bytes20(account), subpack); | |
| * return MyType.wrap(pack); | |
| * } | |
| * | |
| * function _unpack(MyType self) external pure returns (address, bytes4, uint64) { | |
| * bytes32 pack = MyType.unwrap(self); | |
| * return ( | |
| * address(Packing.extract_32_20(pack, 0)), | |
| * Packing.extract_32_4(pack, 20), | |
| * uint64(Packing.extract_32_8(pack, 24)) | |
| * ); | |
| * } | |
| * } | |
| * ``` | |
| * | |
| * _Available since v5.1._ | |
| */ | |
| // solhint-disable func-name-mixedcase | |
| library Packing { | |
| error OutOfRangeAccess(); | |
| function pack_1_1(bytes1 left, bytes1 right) internal pure returns (bytes2 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(248, not(0))) | |
| right := and(right, shl(248, not(0))) | |
| result := or(left, shr(8, right)) | |
| } | |
| } | |
| function pack_2_2(bytes2 left, bytes2 right) internal pure returns (bytes4 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_4(bytes2 left, bytes4 right) internal pure returns (bytes6 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_6(bytes2 left, bytes6 right) internal pure returns (bytes8 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_8(bytes2 left, bytes8 right) internal pure returns (bytes10 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_10(bytes2 left, bytes10 right) internal pure returns (bytes12 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(176, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_20(bytes2 left, bytes20 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(96, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_2_22(bytes2 left, bytes22 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(240, not(0))) | |
| right := and(right, shl(80, not(0))) | |
| result := or(left, shr(16, right)) | |
| } | |
| } | |
| function pack_4_2(bytes4 left, bytes2 right) internal pure returns (bytes6 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_4(bytes4 left, bytes4 right) internal pure returns (bytes8 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_6(bytes4 left, bytes6 right) internal pure returns (bytes10 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_8(bytes4 left, bytes8 right) internal pure returns (bytes12 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_12(bytes4 left, bytes12 right) internal pure returns (bytes16 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_16(bytes4 left, bytes16 right) internal pure returns (bytes20 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(128, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_20(bytes4 left, bytes20 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(96, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_24(bytes4 left, bytes24 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(64, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_4_28(bytes4 left, bytes28 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(224, not(0))) | |
| right := and(right, shl(32, not(0))) | |
| result := or(left, shr(32, right)) | |
| } | |
| } | |
| function pack_6_2(bytes6 left, bytes2 right) internal pure returns (bytes8 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_6_4(bytes6 left, bytes4 right) internal pure returns (bytes10 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_6_6(bytes6 left, bytes6 right) internal pure returns (bytes12 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_6_10(bytes6 left, bytes10 right) internal pure returns (bytes16 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(176, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_6_16(bytes6 left, bytes16 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(128, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_6_22(bytes6 left, bytes22 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(208, not(0))) | |
| right := and(right, shl(80, not(0))) | |
| result := or(left, shr(48, right)) | |
| } | |
| } | |
| function pack_8_2(bytes8 left, bytes2 right) internal pure returns (bytes10 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_4(bytes8 left, bytes4 right) internal pure returns (bytes12 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_8(bytes8 left, bytes8 right) internal pure returns (bytes16 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_12(bytes8 left, bytes12 right) internal pure returns (bytes20 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_16(bytes8 left, bytes16 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(128, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_20(bytes8 left, bytes20 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(96, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_8_24(bytes8 left, bytes24 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(192, not(0))) | |
| right := and(right, shl(64, not(0))) | |
| result := or(left, shr(64, right)) | |
| } | |
| } | |
| function pack_10_2(bytes10 left, bytes2 right) internal pure returns (bytes12 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(176, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(80, right)) | |
| } | |
| } | |
| function pack_10_6(bytes10 left, bytes6 right) internal pure returns (bytes16 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(176, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(80, right)) | |
| } | |
| } | |
| function pack_10_10(bytes10 left, bytes10 right) internal pure returns (bytes20 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(176, not(0))) | |
| right := and(right, shl(176, not(0))) | |
| result := or(left, shr(80, right)) | |
| } | |
| } | |
| function pack_10_12(bytes10 left, bytes12 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(176, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(80, right)) | |
| } | |
| } | |
| function pack_10_22(bytes10 left, bytes22 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(176, not(0))) | |
| right := and(right, shl(80, not(0))) | |
| result := or(left, shr(80, right)) | |
| } | |
| } | |
| function pack_12_4(bytes12 left, bytes4 right) internal pure returns (bytes16 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_12_8(bytes12 left, bytes8 right) internal pure returns (bytes20 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_12_10(bytes12 left, bytes10 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(176, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_12_12(bytes12 left, bytes12 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_12_16(bytes12 left, bytes16 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(128, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_12_20(bytes12 left, bytes20 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(160, not(0))) | |
| right := and(right, shl(96, not(0))) | |
| result := or(left, shr(96, right)) | |
| } | |
| } | |
| function pack_16_4(bytes16 left, bytes4 right) internal pure returns (bytes20 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(128, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(128, right)) | |
| } | |
| } | |
| function pack_16_6(bytes16 left, bytes6 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(128, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(128, right)) | |
| } | |
| } | |
| function pack_16_8(bytes16 left, bytes8 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(128, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(128, right)) | |
| } | |
| } | |
| function pack_16_12(bytes16 left, bytes12 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(128, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(128, right)) | |
| } | |
| } | |
| function pack_16_16(bytes16 left, bytes16 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(128, not(0))) | |
| right := and(right, shl(128, not(0))) | |
| result := or(left, shr(128, right)) | |
| } | |
| } | |
| function pack_20_2(bytes20 left, bytes2 right) internal pure returns (bytes22 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(96, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(160, right)) | |
| } | |
| } | |
| function pack_20_4(bytes20 left, bytes4 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(96, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(160, right)) | |
| } | |
| } | |
| function pack_20_8(bytes20 left, bytes8 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(96, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(160, right)) | |
| } | |
| } | |
| function pack_20_12(bytes20 left, bytes12 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(96, not(0))) | |
| right := and(right, shl(160, not(0))) | |
| result := or(left, shr(160, right)) | |
| } | |
| } | |
| function pack_22_2(bytes22 left, bytes2 right) internal pure returns (bytes24 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(80, not(0))) | |
| right := and(right, shl(240, not(0))) | |
| result := or(left, shr(176, right)) | |
| } | |
| } | |
| function pack_22_6(bytes22 left, bytes6 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(80, not(0))) | |
| right := and(right, shl(208, not(0))) | |
| result := or(left, shr(176, right)) | |
| } | |
| } | |
| function pack_22_10(bytes22 left, bytes10 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(80, not(0))) | |
| right := and(right, shl(176, not(0))) | |
| result := or(left, shr(176, right)) | |
| } | |
| } | |
| function pack_24_4(bytes24 left, bytes4 right) internal pure returns (bytes28 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(64, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(192, right)) | |
| } | |
| } | |
| function pack_24_8(bytes24 left, bytes8 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(64, not(0))) | |
| right := and(right, shl(192, not(0))) | |
| result := or(left, shr(192, right)) | |
| } | |
| } | |
| function pack_28_4(bytes28 left, bytes4 right) internal pure returns (bytes32 result) { | |
| assembly ("memory-safe") { | |
| left := and(left, shl(32, not(0))) | |
| right := and(right, shl(224, not(0))) | |
| result := or(left, shr(224, right)) | |
| } | |
| } | |
| function extract_2_1(bytes2 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 1) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_2_1(bytes2 self, bytes1 value, uint8 offset) internal pure returns (bytes2 result) { | |
| bytes1 oldValue = extract_2_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_4_1(bytes4 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 3) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_4_1(bytes4 self, bytes1 value, uint8 offset) internal pure returns (bytes4 result) { | |
| bytes1 oldValue = extract_4_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_4_2(bytes4 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_4_2(bytes4 self, bytes2 value, uint8 offset) internal pure returns (bytes4 result) { | |
| bytes2 oldValue = extract_4_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_6_1(bytes6 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 5) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_6_1(bytes6 self, bytes1 value, uint8 offset) internal pure returns (bytes6 result) { | |
| bytes1 oldValue = extract_6_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_6_2(bytes6 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_6_2(bytes6 self, bytes2 value, uint8 offset) internal pure returns (bytes6 result) { | |
| bytes2 oldValue = extract_6_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_6_4(bytes6 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_6_4(bytes6 self, bytes4 value, uint8 offset) internal pure returns (bytes6 result) { | |
| bytes4 oldValue = extract_6_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_8_1(bytes8 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 7) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_8_1(bytes8 self, bytes1 value, uint8 offset) internal pure returns (bytes8 result) { | |
| bytes1 oldValue = extract_8_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_8_2(bytes8 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_8_2(bytes8 self, bytes2 value, uint8 offset) internal pure returns (bytes8 result) { | |
| bytes2 oldValue = extract_8_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_8_4(bytes8 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_8_4(bytes8 self, bytes4 value, uint8 offset) internal pure returns (bytes8 result) { | |
| bytes4 oldValue = extract_8_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_8_6(bytes8 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_8_6(bytes8 self, bytes6 value, uint8 offset) internal pure returns (bytes8 result) { | |
| bytes6 oldValue = extract_8_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_10_1(bytes10 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 9) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_10_1(bytes10 self, bytes1 value, uint8 offset) internal pure returns (bytes10 result) { | |
| bytes1 oldValue = extract_10_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_10_2(bytes10 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_10_2(bytes10 self, bytes2 value, uint8 offset) internal pure returns (bytes10 result) { | |
| bytes2 oldValue = extract_10_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_10_4(bytes10 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_10_4(bytes10 self, bytes4 value, uint8 offset) internal pure returns (bytes10 result) { | |
| bytes4 oldValue = extract_10_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_10_6(bytes10 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_10_6(bytes10 self, bytes6 value, uint8 offset) internal pure returns (bytes10 result) { | |
| bytes6 oldValue = extract_10_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_10_8(bytes10 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_10_8(bytes10 self, bytes8 value, uint8 offset) internal pure returns (bytes10 result) { | |
| bytes8 oldValue = extract_10_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_1(bytes12 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 11) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_12_1(bytes12 self, bytes1 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes1 oldValue = extract_12_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_2(bytes12 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 10) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_12_2(bytes12 self, bytes2 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes2 oldValue = extract_12_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_4(bytes12 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_12_4(bytes12 self, bytes4 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes4 oldValue = extract_12_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_6(bytes12 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_12_6(bytes12 self, bytes6 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes6 oldValue = extract_12_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_8(bytes12 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_12_8(bytes12 self, bytes8 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes8 oldValue = extract_12_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_12_10(bytes12 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_12_10(bytes12 self, bytes10 value, uint8 offset) internal pure returns (bytes12 result) { | |
| bytes10 oldValue = extract_12_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_1(bytes16 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 15) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_16_1(bytes16 self, bytes1 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes1 oldValue = extract_16_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_2(bytes16 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 14) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_16_2(bytes16 self, bytes2 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes2 oldValue = extract_16_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_4(bytes16 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_16_4(bytes16 self, bytes4 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes4 oldValue = extract_16_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_6(bytes16 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 10) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_16_6(bytes16 self, bytes6 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes6 oldValue = extract_16_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_8(bytes16 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_16_8(bytes16 self, bytes8 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes8 oldValue = extract_16_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_10(bytes16 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_16_10(bytes16 self, bytes10 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes10 oldValue = extract_16_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_16_12(bytes16 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_16_12(bytes16 self, bytes12 value, uint8 offset) internal pure returns (bytes16 result) { | |
| bytes12 oldValue = extract_16_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_1(bytes20 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 19) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_20_1(bytes20 self, bytes1 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes1 oldValue = extract_20_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_2(bytes20 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 18) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_20_2(bytes20 self, bytes2 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes2 oldValue = extract_20_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_4(bytes20 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 16) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_20_4(bytes20 self, bytes4 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes4 oldValue = extract_20_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_6(bytes20 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 14) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_20_6(bytes20 self, bytes6 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes6 oldValue = extract_20_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_8(bytes20 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_20_8(bytes20 self, bytes8 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes8 oldValue = extract_20_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_10(bytes20 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 10) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_20_10(bytes20 self, bytes10 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes10 oldValue = extract_20_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_12(bytes20 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_20_12(bytes20 self, bytes12 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes12 oldValue = extract_20_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_20_16(bytes20 self, uint8 offset) internal pure returns (bytes16 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(128, not(0))) | |
| } | |
| } | |
| function replace_20_16(bytes20 self, bytes16 value, uint8 offset) internal pure returns (bytes20 result) { | |
| bytes16 oldValue = extract_20_16(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(128, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_1(bytes22 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 21) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_22_1(bytes22 self, bytes1 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes1 oldValue = extract_22_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_2(bytes22 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 20) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_22_2(bytes22 self, bytes2 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes2 oldValue = extract_22_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_4(bytes22 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 18) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_22_4(bytes22 self, bytes4 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes4 oldValue = extract_22_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_6(bytes22 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 16) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_22_6(bytes22 self, bytes6 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes6 oldValue = extract_22_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_8(bytes22 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 14) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_22_8(bytes22 self, bytes8 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes8 oldValue = extract_22_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_10(bytes22 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_22_10(bytes22 self, bytes10 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes10 oldValue = extract_22_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_12(bytes22 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 10) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_22_12(bytes22 self, bytes12 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes12 oldValue = extract_22_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_16(bytes22 self, uint8 offset) internal pure returns (bytes16 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(128, not(0))) | |
| } | |
| } | |
| function replace_22_16(bytes22 self, bytes16 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes16 oldValue = extract_22_16(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(128, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_22_20(bytes22 self, uint8 offset) internal pure returns (bytes20 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(96, not(0))) | |
| } | |
| } | |
| function replace_22_20(bytes22 self, bytes20 value, uint8 offset) internal pure returns (bytes22 result) { | |
| bytes20 oldValue = extract_22_20(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(96, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_1(bytes24 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 23) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_24_1(bytes24 self, bytes1 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes1 oldValue = extract_24_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_2(bytes24 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 22) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_24_2(bytes24 self, bytes2 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes2 oldValue = extract_24_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_4(bytes24 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 20) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_24_4(bytes24 self, bytes4 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes4 oldValue = extract_24_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_6(bytes24 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 18) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_24_6(bytes24 self, bytes6 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes6 oldValue = extract_24_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_8(bytes24 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 16) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_24_8(bytes24 self, bytes8 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes8 oldValue = extract_24_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_10(bytes24 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 14) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_24_10(bytes24 self, bytes10 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes10 oldValue = extract_24_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_12(bytes24 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_24_12(bytes24 self, bytes12 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes12 oldValue = extract_24_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_16(bytes24 self, uint8 offset) internal pure returns (bytes16 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(128, not(0))) | |
| } | |
| } | |
| function replace_24_16(bytes24 self, bytes16 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes16 oldValue = extract_24_16(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(128, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_20(bytes24 self, uint8 offset) internal pure returns (bytes20 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(96, not(0))) | |
| } | |
| } | |
| function replace_24_20(bytes24 self, bytes20 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes20 oldValue = extract_24_20(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(96, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_24_22(bytes24 self, uint8 offset) internal pure returns (bytes22 result) { | |
| if (offset > 2) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(80, not(0))) | |
| } | |
| } | |
| function replace_24_22(bytes24 self, bytes22 value, uint8 offset) internal pure returns (bytes24 result) { | |
| bytes22 oldValue = extract_24_22(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(80, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_1(bytes28 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 27) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_28_1(bytes28 self, bytes1 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes1 oldValue = extract_28_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_2(bytes28 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 26) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_28_2(bytes28 self, bytes2 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes2 oldValue = extract_28_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_4(bytes28 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 24) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_28_4(bytes28 self, bytes4 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes4 oldValue = extract_28_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_6(bytes28 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 22) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_28_6(bytes28 self, bytes6 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes6 oldValue = extract_28_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_8(bytes28 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 20) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_28_8(bytes28 self, bytes8 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes8 oldValue = extract_28_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_10(bytes28 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 18) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_28_10(bytes28 self, bytes10 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes10 oldValue = extract_28_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_12(bytes28 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 16) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_28_12(bytes28 self, bytes12 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes12 oldValue = extract_28_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_16(bytes28 self, uint8 offset) internal pure returns (bytes16 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(128, not(0))) | |
| } | |
| } | |
| function replace_28_16(bytes28 self, bytes16 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes16 oldValue = extract_28_16(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(128, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_20(bytes28 self, uint8 offset) internal pure returns (bytes20 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(96, not(0))) | |
| } | |
| } | |
| function replace_28_20(bytes28 self, bytes20 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes20 oldValue = extract_28_20(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(96, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_22(bytes28 self, uint8 offset) internal pure returns (bytes22 result) { | |
| if (offset > 6) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(80, not(0))) | |
| } | |
| } | |
| function replace_28_22(bytes28 self, bytes22 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes22 oldValue = extract_28_22(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(80, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_28_24(bytes28 self, uint8 offset) internal pure returns (bytes24 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(64, not(0))) | |
| } | |
| } | |
| function replace_28_24(bytes28 self, bytes24 value, uint8 offset) internal pure returns (bytes28 result) { | |
| bytes24 oldValue = extract_28_24(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(64, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_1(bytes32 self, uint8 offset) internal pure returns (bytes1 result) { | |
| if (offset > 31) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(248, not(0))) | |
| } | |
| } | |
| function replace_32_1(bytes32 self, bytes1 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes1 oldValue = extract_32_1(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(248, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_2(bytes32 self, uint8 offset) internal pure returns (bytes2 result) { | |
| if (offset > 30) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(240, not(0))) | |
| } | |
| } | |
| function replace_32_2(bytes32 self, bytes2 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes2 oldValue = extract_32_2(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(240, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_4(bytes32 self, uint8 offset) internal pure returns (bytes4 result) { | |
| if (offset > 28) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(224, not(0))) | |
| } | |
| } | |
| function replace_32_4(bytes32 self, bytes4 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes4 oldValue = extract_32_4(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(224, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_6(bytes32 self, uint8 offset) internal pure returns (bytes6 result) { | |
| if (offset > 26) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(208, not(0))) | |
| } | |
| } | |
| function replace_32_6(bytes32 self, bytes6 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes6 oldValue = extract_32_6(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(208, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_8(bytes32 self, uint8 offset) internal pure returns (bytes8 result) { | |
| if (offset > 24) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(192, not(0))) | |
| } | |
| } | |
| function replace_32_8(bytes32 self, bytes8 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes8 oldValue = extract_32_8(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(192, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_10(bytes32 self, uint8 offset) internal pure returns (bytes10 result) { | |
| if (offset > 22) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(176, not(0))) | |
| } | |
| } | |
| function replace_32_10(bytes32 self, bytes10 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes10 oldValue = extract_32_10(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(176, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_12(bytes32 self, uint8 offset) internal pure returns (bytes12 result) { | |
| if (offset > 20) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(160, not(0))) | |
| } | |
| } | |
| function replace_32_12(bytes32 self, bytes12 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes12 oldValue = extract_32_12(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(160, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_16(bytes32 self, uint8 offset) internal pure returns (bytes16 result) { | |
| if (offset > 16) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(128, not(0))) | |
| } | |
| } | |
| function replace_32_16(bytes32 self, bytes16 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes16 oldValue = extract_32_16(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(128, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_20(bytes32 self, uint8 offset) internal pure returns (bytes20 result) { | |
| if (offset > 12) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(96, not(0))) | |
| } | |
| } | |
| function replace_32_20(bytes32 self, bytes20 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes20 oldValue = extract_32_20(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(96, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_22(bytes32 self, uint8 offset) internal pure returns (bytes22 result) { | |
| if (offset > 10) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(80, not(0))) | |
| } | |
| } | |
| function replace_32_22(bytes32 self, bytes22 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes22 oldValue = extract_32_22(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(80, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_24(bytes32 self, uint8 offset) internal pure returns (bytes24 result) { | |
| if (offset > 8) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(64, not(0))) | |
| } | |
| } | |
| function replace_32_24(bytes32 self, bytes24 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes24 oldValue = extract_32_24(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(64, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| function extract_32_28(bytes32 self, uint8 offset) internal pure returns (bytes28 result) { | |
| if (offset > 4) revert OutOfRangeAccess(); | |
| assembly ("memory-safe") { | |
| result := and(shl(mul(8, offset), self), shl(32, not(0))) | |
| } | |
| } | |
| function replace_32_28(bytes32 self, bytes28 value, uint8 offset) internal pure returns (bytes32 result) { | |
| bytes28 oldValue = extract_32_28(self, offset); | |
| assembly ("memory-safe") { | |
| value := and(value, shl(32, not(0))) | |
| result := xor(self, shr(mul(8, offset), xor(oldValue, value))) | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol) | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @dev Helper library for emitting standardized panic codes. | |
| * | |
| * ```solidity | |
| * contract Example { | |
| * using Panic for uint256; | |
| * | |
| * // Use any of the declared internal constants | |
| * function foo() { Panic.GENERIC.panic(); } | |
| * | |
| * // Alternatively | |
| * function foo() { Panic.panic(Panic.GENERIC); } | |
| * } | |
| * ``` | |
| * | |
| * Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil]. | |
| * | |
| * _Available since v5.1._ | |
| */ | |
| // slither-disable-next-line unused-state | |
| library Panic { | |
| /// @dev generic / unspecified error | |
| uint256 internal constant GENERIC = 0x00; | |
| /// @dev used by the assert() builtin | |
| uint256 internal constant ASSERT = 0x01; | |
| /// @dev arithmetic underflow or overflow | |
| uint256 internal constant UNDER_OVERFLOW = 0x11; | |
| /// @dev division or modulo by zero | |
| uint256 internal constant DIVISION_BY_ZERO = 0x12; | |
| /// @dev enum conversion error | |
| uint256 internal constant ENUM_CONVERSION_ERROR = 0x21; | |
| /// @dev invalid encoding in storage | |
| uint256 internal constant STORAGE_ENCODING_ERROR = 0x22; | |
| /// @dev empty array pop | |
| uint256 internal constant EMPTY_ARRAY_POP = 0x31; | |
| /// @dev array out of bounds access | |
| uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32; | |
| /// @dev resource error (too large allocation or too large array) | |
| uint256 internal constant RESOURCE_ERROR = 0x41; | |
| /// @dev calling invalid internal function | |
| uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51; | |
| /// @dev Reverts with a panic code. Recommended to use with | |
| /// the internal constants with predefined codes. | |
| function panic(uint256 code) internal pure { | |
| assembly ("memory-safe") { | |
| mstore(0x00, 0x4e487b71) | |
| mstore(0x20, code) | |
| revert(0x1c, 0x24) | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.3.0) (utils/ShortStrings.sol) | |
| pragma solidity ^0.8.20; | |
| import {StorageSlot} from "./StorageSlot.sol"; | |
| // | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | | |
| // | length | 0x BB | | |
| type ShortString is bytes32; | |
| /** | |
| * @dev This library provides functions to convert short memory strings | |
| * into a `ShortString` type that can be used as an immutable variable. | |
| * | |
| * Strings of arbitrary length can be optimized using this library if | |
| * they are short enough (up to 31 bytes) by packing them with their | |
| * length (1 byte) in a single EVM word (32 bytes). Additionally, a | |
| * fallback mechanism can be used for every other case. | |
| * | |
| * Usage example: | |
| * | |
| * ```solidity | |
| * contract Named { | |
| * using ShortStrings for *; | |
| * | |
| * ShortString private immutable _name; | |
| * string private _nameFallback; | |
| * | |
| * constructor(string memory contractName) { | |
| * _name = contractName.toShortStringWithFallback(_nameFallback); | |
| * } | |
| * | |
| * function name() external view returns (string memory) { | |
| * return _name.toStringWithFallback(_nameFallback); | |
| * } | |
| * } | |
| * ``` | |
| */ | |
| library ShortStrings { | |
| // Used as an identifier for strings longer than 31 bytes. | |
| bytes32 private constant FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF; | |
| error StringTooLong(string str); | |
| error InvalidShortString(); | |
| /** | |
| * @dev Encode a string of at most 31 chars into a `ShortString`. | |
| * | |
| * This will trigger a `StringTooLong` error is the input string is too long. | |
| */ | |
| function toShortString(string memory str) internal pure returns (ShortString) { | |
| bytes memory bstr = bytes(str); | |
| if (bstr.length > 31) { | |
| revert StringTooLong(str); | |
| } | |
| return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length)); | |
| } | |
| /** | |
| * @dev Decode a `ShortString` back to a "normal" string. | |
| */ | |
| function toString(ShortString sstr) internal pure returns (string memory) { | |
| uint256 len = byteLength(sstr); | |
| // using `new string(len)` would work locally but is not memory safe. | |
| string memory str = new string(32); | |
| assembly ("memory-safe") { | |
| mstore(str, len) | |
| mstore(add(str, 0x20), sstr) | |
| } | |
| return str; | |
| } | |
| /** | |
| * @dev Return the length of a `ShortString`. | |
| */ | |
| function byteLength(ShortString sstr) internal pure returns (uint256) { | |
| uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF; | |
| if (result > 31) { | |
| revert InvalidShortString(); | |
| } | |
| return result; | |
| } | |
| /** | |
| * @dev Encode a string into a `ShortString`, or write it to storage if it is too long. | |
| */ | |
| function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) { | |
| if (bytes(value).length < 32) { | |
| return toShortString(value); | |
| } else { | |
| StorageSlot.getStringSlot(store).value = value; | |
| return ShortString.wrap(FALLBACK_SENTINEL); | |
| } | |
| } | |
| /** | |
| * @dev Decode a string that was encoded to `ShortString` or written to storage using {toShortStringWithFallback}. | |
| */ | |
| function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) { | |
| if (ShortString.unwrap(value) != FALLBACK_SENTINEL) { | |
| return toString(value); | |
| } else { | |
| return store; | |
| } | |
| } | |
| /** | |
| * @dev Return the length of a string that was encoded to `ShortString` or written to storage using | |
| * {toShortStringWithFallback}. | |
| * | |
| * WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of | |
| * actual characters as the UTF-8 encoding of a single character can span over multiple bytes. | |
| */ | |
| function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) { | |
| if (ShortString.unwrap(value) != FALLBACK_SENTINEL) { | |
| return byteLength(value); | |
| } else { | |
| return bytes(store).length; | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol) | |
| // This file was procedurally generated from scripts/generate/templates/StorageSlot.js. | |
| pragma solidity ^0.8.20; | |
| /** | |
| * @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 ERC-1967 implementation slot: | |
| * ```solidity | |
| * contract ERC1967 { | |
| * // Define the slot. Alternatively, use the SlotDerivation library to derive the slot. | |
| * 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; | |
| * } | |
| * } | |
| * ``` | |
| * | |
| * TIP: Consider using this library along with {SlotDerivation}. | |
| */ | |
| library StorageSlot { | |
| struct AddressSlot { | |
| address value; | |
| } | |
| struct BooleanSlot { | |
| bool value; | |
| } | |
| struct Bytes32Slot { | |
| bytes32 value; | |
| } | |
| struct Uint256Slot { | |
| uint256 value; | |
| } | |
| struct Int256Slot { | |
| int256 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) { | |
| assembly ("memory-safe") { | |
| r.slot := slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `BooleanSlot` with member `value` located at `slot`. | |
| */ | |
| function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) { | |
| assembly ("memory-safe") { | |
| r.slot := slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `Bytes32Slot` with member `value` located at `slot`. | |
| */ | |
| function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) { | |
| assembly ("memory-safe") { | |
| r.slot := slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `Uint256Slot` with member `value` located at `slot`. | |
| */ | |
| function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) { | |
| assembly ("memory-safe") { | |
| r.slot := slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `Int256Slot` with member `value` located at `slot`. | |
| */ | |
| function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) { | |
| assembly ("memory-safe") { | |
| r.slot := slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `StringSlot` with member `value` located at `slot`. | |
| */ | |
| function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) { | |
| assembly ("memory-safe") { | |
| 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) { | |
| assembly ("memory-safe") { | |
| r.slot := store.slot | |
| } | |
| } | |
| /** | |
| * @dev Returns a `BytesSlot` with member `value` located at `slot`. | |
| */ | |
| function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) { | |
| assembly ("memory-safe") { | |
| 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) { | |
| assembly ("memory-safe") { | |
| r.slot := store.slot | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: MIT | |
| // OpenZeppelin Contracts (last updated v5.4.0) (utils/Strings.sol) | |
| pragma solidity ^0.8.20; | |
| import {Math} from "./math/Math.sol"; | |
| import {SafeCast} from "./math/SafeCast.sol"; | |
| import {SignedMath} from "./math/SignedMath.sol"; | |
| /** | |
| * @dev String operations. | |
| */ | |
| library Strings { | |
| using SafeCast for *; | |
| bytes16 private constant HEX_DIGITS = "0123456789abcdef"; | |
| uint8 private constant ADDRESS_LENGTH = 20; | |
| uint256 private constant SPECIAL_CHARS_LOOKUP = | |
| (1 << 0x08) | // backspace | |
| (1 << 0x09) | // tab | |
| (1 << 0x0a) | // newline | |
| (1 << 0x0c) | // form feed | |
| (1 << 0x0d) | // carriage return | |
| (1 << 0x22) | // double quote | |
| (1 << 0x5c); // backslash | |
| /** | |
| * @dev The `value` string doesn't fit in the specified `length`. | |
| */ | |
| error StringsInsufficientHexLength(uint256 value, uint256 length); | |
| /** | |
| * @dev The string being parsed contains characters that are not in scope of the given base. | |
| */ | |
| error StringsInvalidChar(); | |
| /** | |
| * @dev The string being parsed is not a properly formatted address. | |
| */ | |
| error StringsInvalidAddressFormat(); | |
| /** | |
| * @dev Converts a `uint256` to its ASCII `string` decimal representation. | |
| */ | |
| function toString(uint256 value) internal pure returns (string memory) { | |
| unchecked { | |
| uint256 length = Math.log10(value) + 1; | |
| string memory buffer = new string(length); | |
| uint256 ptr; | |
| assembly ("memory-safe") { | |
| ptr := add(add(buffer, 0x20), length) | |
| } | |
| while (true) { | |
| ptr--; | |
| assembly ("memory-safe") { | |
| mstore8(ptr, byte(mod(value, 10), HEX_DIGITS)) | |
| } | |
| value /= 10; | |
| if (value == 0) break; | |
| } | |
| return buffer; | |
| } | |
| } | |
| /** | |
| * @dev Converts a `int256` to its ASCII `string` decimal representation. | |
| */ | |
| function toStringSigned(int256 value) internal pure returns (string memory) { | |
| return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value))); | |
| } | |
| /** | |
| * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation. | |
| */ | |
| function toHexString(uint256 value) internal pure returns (string memory) { | |
| unchecked { | |
| return toHexString(value, Math.log256(value) + 1); | |
| } | |
| } | |
| /** | |
| * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length. | |
| */ | |
| function toHexString(uint256 value, uint256 length) internal pure returns (string memory) { | |
| uint256 localValue = value; | |
| bytes memory buffer = new bytes(2 * length + 2); | |
| buffer[0] = "0"; | |
| buffer[1] = "x"; | |
| for (uint256 i = 2 * length + 1; i > 1; --i) { | |
| buffer[i] = HEX_DIGITS[localValue & 0xf]; | |
| localValue >>= 4; | |
| } | |
| if (localValue != 0) { | |
| revert StringsInsufficientHexLength(value, length); | |
| } | |
| return string(buffer); | |
| } | |
| /** | |
| * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal | |
| * representation. | |
| */ | |
| function toHexString(address addr) internal pure returns (string memory) { | |
| return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH); | |
| } | |
| /** | |
| * @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal | |
| * representation, according to EIP-55. | |
| */ | |
| function toChecksumHexString(address addr) internal pure returns (string memory) { | |
| bytes memory buffer = bytes(toHexString(addr)); | |
| // hash the hex part of buffer (skip length + 2 bytes, length 40) | |
| uint256 hashValue; | |
| assembly ("memory-safe") { | |
| hashValue := shr(96, keccak256(add(buffer, 0x22), 40)) | |
| } | |
| for (uint256 i = 41; i > 1; --i) { | |
| // possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f) | |
| if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) { | |
| // case shift by xoring with 0x20 | |
| buffer[i] ^= 0x20; | |
| } | |
| hashValue >>= 4; | |
| } | |
| return string(buffer); | |
| } | |
| /** | |
| * @dev Returns true if the two strings are equal. | |
| */ | |
| function equal(string memory a, string memory b) internal pure returns (bool) { | |
| return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b)); | |
| } | |
| /** | |
| * @dev Parse a decimal string and returns the value as a `uint256`. | |
| * | |
| * Requirements: | |
| * - The string must be formatted as `[0-9]*` | |
| * - The result must fit into an `uint256` type | |
| */ | |
| function parseUint(string memory input) internal pure returns (uint256) { | |
| return parseUint(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and | |
| * `end` (excluded). | |
| * | |
| * Requirements: | |
| * - The substring must be formatted as `[0-9]*` | |
| * - The result must fit into an `uint256` type | |
| */ | |
| function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) { | |
| (bool success, uint256 value) = tryParseUint(input, begin, end); | |
| if (!success) revert StringsInvalidChar(); | |
| return value; | |
| } | |
| /** | |
| * @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character. | |
| * | |
| * NOTE: This function will revert if the result does not fit in a `uint256`. | |
| */ | |
| function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) { | |
| return _tryParseUintUncheckedBounds(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid | |
| * character. | |
| * | |
| * NOTE: This function will revert if the result does not fit in a `uint256`. | |
| */ | |
| function tryParseUint( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) internal pure returns (bool success, uint256 value) { | |
| if (end > bytes(input).length || begin > end) return (false, 0); | |
| return _tryParseUintUncheckedBounds(input, begin, end); | |
| } | |
| /** | |
| * @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that | |
| * `begin <= end <= input.length`. Other inputs would result in undefined behavior. | |
| */ | |
| function _tryParseUintUncheckedBounds( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) private pure returns (bool success, uint256 value) { | |
| bytes memory buffer = bytes(input); | |
| uint256 result = 0; | |
| for (uint256 i = begin; i < end; ++i) { | |
| uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i))); | |
| if (chr > 9) return (false, 0); | |
| result *= 10; | |
| result += chr; | |
| } | |
| return (true, result); | |
| } | |
| /** | |
| * @dev Parse a decimal string and returns the value as a `int256`. | |
| * | |
| * Requirements: | |
| * - The string must be formatted as `[-+]?[0-9]*` | |
| * - The result must fit in an `int256` type. | |
| */ | |
| function parseInt(string memory input) internal pure returns (int256) { | |
| return parseInt(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and | |
| * `end` (excluded). | |
| * | |
| * Requirements: | |
| * - The substring must be formatted as `[-+]?[0-9]*` | |
| * - The result must fit in an `int256` type. | |
| */ | |
| function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) { | |
| (bool success, int256 value) = tryParseInt(input, begin, end); | |
| if (!success) revert StringsInvalidChar(); | |
| return value; | |
| } | |
| /** | |
| * @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if | |
| * the result does not fit in a `int256`. | |
| * | |
| * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`. | |
| */ | |
| function tryParseInt(string memory input) internal pure returns (bool success, int256 value) { | |
| return _tryParseIntUncheckedBounds(input, 0, bytes(input).length); | |
| } | |
| uint256 private constant ABS_MIN_INT256 = 2 ** 255; | |
| /** | |
| * @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid | |
| * character or if the result does not fit in a `int256`. | |
| * | |
| * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`. | |
| */ | |
| function tryParseInt( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) internal pure returns (bool success, int256 value) { | |
| if (end > bytes(input).length || begin > end) return (false, 0); | |
| return _tryParseIntUncheckedBounds(input, begin, end); | |
| } | |
| /** | |
| * @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that | |
| * `begin <= end <= input.length`. Other inputs would result in undefined behavior. | |
| */ | |
| function _tryParseIntUncheckedBounds( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) private pure returns (bool success, int256 value) { | |
| bytes memory buffer = bytes(input); | |
| // Check presence of a negative sign. | |
| bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty | |
| bool positiveSign = sign == bytes1("+"); | |
| bool negativeSign = sign == bytes1("-"); | |
| uint256 offset = (positiveSign || negativeSign).toUint(); | |
| (bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end); | |
| if (absSuccess && absValue < ABS_MIN_INT256) { | |
| return (true, negativeSign ? -int256(absValue) : int256(absValue)); | |
| } else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) { | |
| return (true, type(int256).min); | |
| } else return (false, 0); | |
| } | |
| /** | |
| * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`. | |
| * | |
| * Requirements: | |
| * - The string must be formatted as `(0x)?[0-9a-fA-F]*` | |
| * - The result must fit in an `uint256` type. | |
| */ | |
| function parseHexUint(string memory input) internal pure returns (uint256) { | |
| return parseHexUint(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and | |
| * `end` (excluded). | |
| * | |
| * Requirements: | |
| * - The substring must be formatted as `(0x)?[0-9a-fA-F]*` | |
| * - The result must fit in an `uint256` type. | |
| */ | |
| function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) { | |
| (bool success, uint256 value) = tryParseHexUint(input, begin, end); | |
| if (!success) revert StringsInvalidChar(); | |
| return value; | |
| } | |
| /** | |
| * @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character. | |
| * | |
| * NOTE: This function will revert if the result does not fit in a `uint256`. | |
| */ | |
| function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) { | |
| return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an | |
| * invalid character. | |
| * | |
| * NOTE: This function will revert if the result does not fit in a `uint256`. | |
| */ | |
| function tryParseHexUint( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) internal pure returns (bool success, uint256 value) { | |
| if (end > bytes(input).length || begin > end) return (false, 0); | |
| return _tryParseHexUintUncheckedBounds(input, begin, end); | |
| } | |
| /** | |
| * @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that | |
| * `begin <= end <= input.length`. Other inputs would result in undefined behavior. | |
| */ | |
| function _tryParseHexUintUncheckedBounds( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) private pure returns (bool success, uint256 value) { | |
| bytes memory buffer = bytes(input); | |
| // skip 0x prefix if present | |
| bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty | |
| uint256 offset = hasPrefix.toUint() * 2; | |
| uint256 result = 0; | |
| for (uint256 i = begin + offset; i < end; ++i) { | |
| uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i))); | |
| if (chr > 15) return (false, 0); | |
| result *= 16; | |
| unchecked { | |
| // Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check). | |
| // This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked. | |
| result += chr; | |
| } | |
| } | |
| return (true, result); | |
| } | |
| /** | |
| * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`. | |
| * | |
| * Requirements: | |
| * - The string must be formatted as `(0x)?[0-9a-fA-F]{40}` | |
| */ | |
| function parseAddress(string memory input) internal pure returns (address) { | |
| return parseAddress(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and | |
| * `end` (excluded). | |
| * | |
| * Requirements: | |
| * - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}` | |
| */ | |
| function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) { | |
| (bool success, address value) = tryParseAddress(input, begin, end); | |
| if (!success) revert StringsInvalidAddressFormat(); | |
| return value; | |
| } | |
| /** | |
| * @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly | |
| * formatted address. See {parseAddress-string} requirements. | |
| */ | |
| function tryParseAddress(string memory input) internal pure returns (bool success, address value) { | |
| return tryParseAddress(input, 0, bytes(input).length); | |
| } | |
| /** | |
| * @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly | |
| * formatted address. See {parseAddress-string-uint256-uint256} requirements. | |
| */ | |
| function tryParseAddress( | |
| string memory input, | |
| uint256 begin, | |
| uint256 end | |
| ) internal pure returns (bool success, address value) { | |
| if (end > bytes(input).length || begin > end) return (false, address(0)); | |
| bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty | |
| uint256 expectedLength = 40 + hasPrefix.toUint() * 2; | |
| // check that input is the correct length | |
| if (end - begin == expectedLength) { | |
| // length guarantees that this does not overflow, and value is at most type(uint160).max | |
| (bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end); | |
| return (s, address(uint160(v))); | |
| } else { | |
| return (false, address(0)); | |
| } | |
| } | |
| function _tryParseChr(bytes1 chr) private pure returns (uint8) { | |
| uint8 value = uint8(chr); | |
| // Try to parse `chr`: | |
| // - Case 1: [0-9] | |
| // - Case 2: [a-f] | |
| // - Case 3: [A-F] | |
| // - otherwise not supported | |
| unchecked { | |
| if (value > 47 && value < 58) value -= 48; | |
| else if (value > 96 && value < 103) value -= 87; | |
| else if (value > 64 && value < 71) value -= 55; | |
| else return type(uint8).max; | |
| } | |
| return value; | |
| } | |
| /** | |
| * @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata. | |
| * | |
| * WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped. | |
| * | |
| * NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of | |
| * RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode | |
| * characters that are not in this range, but other tooling may provide different results. | |
| */ | |
| function escapeJSON(string memory input) internal pure returns (string memory) { | |
| bytes memory buffer = bytes(input); | |
| bytes memory output = new bytes(2 * buffer.length); // worst case scenario | |
| uint256 outputLength = 0; | |
| for (uint256 i; i < buffer.length; ++i) { | |
| bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i)); | |
| if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) { | |
| output[outputLength++] = "\\"; | |
| if (char == 0x08) output[outputLength++] = "b"; | |
| else if (char == 0x09) output[outputLength++] = "t"; | |
| else if (char == 0x0a) output[outputLength++] = "n"; | |
| else if (char == 0x0c) output[outputLength++] = "f"; | |
| else if (char == 0x0d) output[outputLength++] = "r"; | |
| else if (char == 0x5c) output[outputLength++] = "\\"; | |
| else if (char == 0x22) { | |
| // solhint-disable-next-line quotes | |
| output[outputLength++] = '"'; | |
| } | |
| } else { | |
| output[outputLength++] = char; | |
| } | |
| } | |
| // write the actual length and deallocate unused memory | |
| assembly ("memory-safe") { | |
| mstore(output, outputLength) | |
| mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63))))) | |
| } | |
| return string(output); | |
| } | |
| /** | |
| * @dev Reads a bytes32 from a bytes array without bounds checking. | |
| * | |
| * NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the | |
| * assembly block as such would prevent some optimizations. | |
| */ | |
| function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) { | |
| // This is not memory safe in the general case, but all calls to this private function are within bounds. | |
| assembly ("memory-safe") { | |
| value := mload(add(add(buffer, 0x20), offset)) | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: GPL-3.0 | |
| pragma solidity >=0.4.22 <0.9.0; | |
| library TestsAccounts { | |
| function getAccount(uint index) pure public returns (address) { | |
| address[15] memory accounts; | |
| accounts[0] = 0x5B38Da6a701c568545dCfcB03FcB875f56beddC4; | |
| accounts[1] = 0xAb8483F64d9C6d1EcF9b849Ae677dD3315835cb2; | |
| accounts[2] = 0x4B20993Bc481177ec7E8f571ceCaE8A9e22C02db; | |
| accounts[3] = 0x78731D3Ca6b7E34aC0F824c42a7cC18A495cabaB; | |
| accounts[4] = 0x617F2E2fD72FD9D5503197092aC168c91465E7f2; | |
| accounts[5] = 0x17F6AD8Ef982297579C203069C1DbfFE4348c372; | |
| accounts[6] = 0x5c6B0f7Bf3E7ce046039Bd8FABdfD3f9F5021678; | |
| accounts[7] = 0x03C6FcED478cBbC9a4FAB34eF9f40767739D1Ff7; | |
| accounts[8] = 0x1aE0EA34a72D944a8C7603FfB3eC30a6669E454C; | |
| accounts[9] = 0x0A098Eda01Ce92ff4A4CCb7A4fFFb5A43EBC70DC; | |
| accounts[10] = 0xCA35b7d915458EF540aDe6068dFe2F44E8fa733c; | |
| accounts[11] = 0x14723A09ACff6D2A60DcdF7aA4AFf308FDDC160C; | |
| accounts[12] = 0x4B0897b0513fdC7C541B6d9D7E929C4e5364D2dB; | |
| accounts[13] = 0x583031D1113aD414F02576BD6afaBfb302140225; | |
| accounts[14] = 0xdD870fA1b7C4700F2BD7f44238821C26f7392148; | |
| return accounts[index]; | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // SPDX-License-Identifier: GPL-3.0 | |
| pragma solidity >=0.4.22 <0.9.0; | |
| library Assert { | |
| event AssertionEvent( | |
| bool passed, | |
| string message, | |
| string methodName | |
| ); | |
| event AssertionEventUint( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| uint256 returned, | |
| uint256 expected | |
| ); | |
| event AssertionEventInt( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| int256 returned, | |
| int256 expected | |
| ); | |
| event AssertionEventBool( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| bool returned, | |
| bool expected | |
| ); | |
| event AssertionEventAddress( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| address returned, | |
| address expected | |
| ); | |
| event AssertionEventBytes32( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| bytes32 returned, | |
| bytes32 expected | |
| ); | |
| event AssertionEventString( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| string returned, | |
| string expected | |
| ); | |
| event AssertionEventUintInt( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| uint256 returned, | |
| int256 expected | |
| ); | |
| event AssertionEventIntUint( | |
| bool passed, | |
| string message, | |
| string methodName, | |
| int256 returned, | |
| uint256 expected | |
| ); | |
| function ok(bool a, string memory message) public returns (bool result) { | |
| result = a; | |
| emit AssertionEvent(result, message, "ok"); | |
| } | |
| function equal(uint256 a, uint256 b, string memory message) public returns (bool result) { | |
| result = (a == b); | |
| emit AssertionEventUint(result, message, "equal", a, b); | |
| } | |
| function equal(int256 a, int256 b, string memory message) public returns (bool result) { | |
| result = (a == b); | |
| emit AssertionEventInt(result, message, "equal", a, b); | |
| } | |
| function equal(bool a, bool b, string memory message) public returns (bool result) { | |
| result = (a == b); | |
| emit AssertionEventBool(result, message, "equal", a, b); | |
| } | |
| // TODO: only for certain versions of solc | |
| //function equal(fixed a, fixed b, string message) public returns (bool result) { | |
| // result = (a == b); | |
| // emit AssertionEvent(result, message); | |
| //} | |
| // TODO: only for certain versions of solc | |
| //function equal(ufixed a, ufixed b, string message) public returns (bool result) { | |
| // result = (a == b); | |
| // emit AssertionEvent(result, message); | |
| //} | |
| function equal(address a, address b, string memory message) public returns (bool result) { | |
| result = (a == b); | |
| emit AssertionEventAddress(result, message, "equal", a, b); | |
| } | |
| function equal(bytes32 a, bytes32 b, string memory message) public returns (bool result) { | |
| result = (a == b); | |
| emit AssertionEventBytes32(result, message, "equal", a, b); | |
| } | |
| function equal(string memory a, string memory b, string memory message) public returns (bool result) { | |
| result = (keccak256(abi.encodePacked(a)) == keccak256(abi.encodePacked(b))); | |
| emit AssertionEventString(result, message, "equal", a, b); | |
| } | |
| function notEqual(uint256 a, uint256 b, string memory message) public returns (bool result) { | |
| result = (a != b); | |
| emit AssertionEventUint(result, message, "notEqual", a, b); | |
| } | |
| function notEqual(int256 a, int256 b, string memory message) public returns (bool result) { | |
| result = (a != b); | |
| emit AssertionEventInt(result, message, "notEqual", a, b); | |
| } | |
| function notEqual(bool a, bool b, string memory message) public returns (bool result) { | |
| result = (a != b); | |
| emit AssertionEventBool(result, message, "notEqual", a, b); | |
| } | |
| // TODO: only for certain versions of solc | |
| //function notEqual(fixed a, fixed b, string message) public returns (bool result) { | |
| // result = (a != b); | |
| // emit AssertionEvent(result, message); | |
| //} | |
| // TODO: only for certain versions of solc | |
| //function notEqual(ufixed a, ufixed b, string message) public returns (bool result) { | |
| // result = (a != b); | |
| // emit AssertionEvent(result, message); | |
| //} | |
| function notEqual(address a, address b, string memory message) public returns (bool result) { | |
| result = (a != b); | |
| emit AssertionEventAddress(result, message, "notEqual", a, b); | |
| } | |
| function notEqual(bytes32 a, bytes32 b, string memory message) public returns (bool result) { | |
| result = (a != b); | |
| emit AssertionEventBytes32(result, message, "notEqual", a, b); | |
| } | |
| function notEqual(string memory a, string memory b, string memory message) public returns (bool result) { | |
| result = (keccak256(abi.encodePacked(a)) != keccak256(abi.encodePacked(b))); | |
| emit AssertionEventString(result, message, "notEqual", a, b); | |
| } | |
| /*----------------- Greater than --------------------*/ | |
| function greaterThan(uint256 a, uint256 b, string memory message) public returns (bool result) { | |
| result = (a > b); | |
| emit AssertionEventUint(result, message, "greaterThan", a, b); | |
| } | |
| function greaterThan(int256 a, int256 b, string memory message) public returns (bool result) { | |
| result = (a > b); | |
| emit AssertionEventInt(result, message, "greaterThan", a, b); | |
| } | |
| // TODO: safely compare between uint and int | |
| function greaterThan(uint256 a, int256 b, string memory message) public returns (bool result) { | |
| if(b < int(0)) { | |
| // int is negative uint "a" always greater | |
| result = true; | |
| } else { | |
| result = (a > uint(b)); | |
| } | |
| emit AssertionEventUintInt(result, message, "greaterThan", a, b); | |
| } | |
| function greaterThan(int256 a, uint256 b, string memory message) public returns (bool result) { | |
| if(a < int(0)) { | |
| // int is negative uint "b" always greater | |
| result = false; | |
| } else { | |
| result = (uint(a) > b); | |
| } | |
| emit AssertionEventIntUint(result, message, "greaterThan", a, b); | |
| } | |
| /*----------------- Lesser than --------------------*/ | |
| function lesserThan(uint256 a, uint256 b, string memory message) public returns (bool result) { | |
| result = (a < b); | |
| emit AssertionEventUint(result, message, "lesserThan", a, b); | |
| } | |
| function lesserThan(int256 a, int256 b, string memory message) public returns (bool result) { | |
| result = (a < b); | |
| emit AssertionEventInt(result, message, "lesserThan", a, b); | |
| } | |
| // TODO: safely compare between uint and int | |
| function lesserThan(uint256 a, int256 b, string memory message) public returns (bool result) { | |
| if(b < int(0)) { | |
| // int is negative int "b" always lesser | |
| result = false; | |
| } else { | |
| result = (a < uint(b)); | |
| } | |
| emit AssertionEventUintInt(result, message, "lesserThan", a, b); | |
| } | |
| function lesserThan(int256 a, uint256 b, string memory message) public returns (bool result) { | |
| if(a < int(0)) { | |
| // int is negative int "a" always lesser | |
| result = true; | |
| } else { | |
| result = (uint(a) < b); | |
| } | |
| emit AssertionEventIntUint(result, message, "lesserThan", a, b); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| [core] | |
| repositoryformatversion = 0 | |
| filemode = false | |
| bare = false | |
| logallrefupdates = true | |
| symlinks = false | |
| ignorecase = true | |
| [remote "main"] | |
| fetch = +refs/heads/*:refs/remotes/main/* | |
| url = https://github.com/BeadtMODE/BeadtMODE |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ref: refs/heads/main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| DIRC oi�Tb!��i�Tb!�� �� t~� =��* Z���T�8 :.deps/npm/@openzeppelin/contracts/access/AccessControl.sol i�TcX; i�TcX; $ �� | |
| #�w | |
| R*���|2�r ;.deps/npm/@openzeppelin/contracts/access/IAccessControl.sol i�T�$ O i�T�$ O Q �� ���f���Ԕ�#�{�K�� 4.deps/npm/@openzeppelin/contracts/access/Ownable.sol i�T��i�T�� ( �� H8*0��������w��.�X: B.deps/npm/@openzeppelin/contracts/access/manager/AccessManaged.sol i�T�*�@i�T�*�@ + �� `�p����W���s�"Ss� C.deps/npm/@openzeppelin/contracts/access/manager/AuthorityUtils.sol i�T�$L�@i�T�$L�@ ) �� W�<qV��y_�_�H�H^%` C.deps/npm/@openzeppelin/contracts/access/manager/IAccessManaged.sol i�T�'� i�T�'� * �� ?��[�@�����>'�['���8 C.deps/npm/@openzeppelin/contracts/access/manager/IAccessManager.sol i�T�2�} i�T�2�} , �� �j��J}LO�H3�V9 ح�� ?.deps/npm/@openzeppelin/contracts/access/manager/IAuthority.sol i�T�7� �i�T�7� � : �� +�Mz`�'_�[�i�z��)=ȏ 5.deps/npm/@openzeppelin/contracts/account/Account.sol i�T�-�@i�T�-�@ E �� �m,�̨�^��c��o�3�Fҡ� F.deps/npm/@openzeppelin/contracts/account/utils/draft-ERC4337Utils.sol i�T� | |
| �� i�T� | |
| �� = �� �C�(j����TN?|Zބ5[ 9.deps/npm/@openzeppelin/contracts/interfaces/IERC1271.sol i�T�!Bg�i�T�!Bg� A �� ��2[�Z���E�Y�~*h�-�� 9.deps/npm/@openzeppelin/contracts/interfaces/IERC5267.sol i�T�1K�i�T�1K� F �� '�u.NC, ��z둞����) ?.deps/npm/@openzeppelin/contracts/interfaces/draft-IERC4337.sol i�Tb*�K i�Tb*�K �� ����j� ���m6��U� ?.deps/npm/@openzeppelin/contracts/interfaces/draft-IERC6093.sol i�T�)]��i�T�)]�� C �� | |
| '�{�v��c/�Yf�')��5N� D.deps/npm/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol i�T�-�D�i�T�-�D� 7 �� 'ז1�����=�9��TJ�94 G.deps/npm/@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol i�Tbq��i�Tbq�� �� *.�o��R���Ĕ�jT��b 7.deps/npm/@openzeppelin/contracts/token/ERC20/ERC20.sol i�Tc �]@i�Tc �]@ ! �� | |
| ݴ�t:���M�L����c��� 8.deps/npm/@openzeppelin/contracts/token/ERC20/IERC20.sol i�c�`�@i�c�`�@ n �� | |
| �~��֚�5-� :$G�Pn�n� H.deps/npm/@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol i�Tb6 v�i�Tb6 v� �� �����K�J��tU���{�8 K.deps/npm/@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol i�c� �T@i�c� �T@ p �� �eH��������1��N3��� I.deps/npm/@openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol i�T�%��i�T�%�� B �� �a���l%�-��V��ے�~ B.deps/npm/@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol i�T�(�� i�T�(�� 4 �� k�:�[y\����*�xP+��� E.deps/npm/@openzeppelin/contracts/token/ERC721/utils/ERC721Holder.sol i�T� �]@i�T� �]@ G �� �A�)�7��c���ߝ�*��5B 4.deps/npm/@openzeppelin/contracts/utils/Calldata.sol i�Tb0 | |
| ��i�Tb0 | |
| �� �� �NS_�<$?�Eh��C�]��G 3.deps/npm/@openzeppelin/contracts/utils/Context.sol i�c�+i�c�+ o �� �7E�:Y[�bo-X-�N=1͕� 2.deps/npm/@openzeppelin/contracts/utils/Nonces.sol i�T��� i�T��� J �� �h�����ɴ�"�����x��� 3.deps/npm/@openzeppelin/contracts/utils/Packing.sol i�T�.�_�i�T�.�_� N �� ��h�M4���3�4��O�H� 1.deps/npm/@openzeppelin/contracts/utils/Panic.sol i�T�u i�T�u ; �� �Ծ�E��?C� | |
| �Q/@ 8.deps/npm/@openzeppelin/contracts/utils/ShortStrings.sol i�T��M i�T��M I �� V��RJ,��xθ9N_<Z�� 7.deps/npm/@openzeppelin/contracts/utils/StorageSlot.sol i�T��q�i�T��q� H �� KP��4�B�H����0&���0� 3.deps/npm/@openzeppelin/contracts/utils/Strings.sol i�T��e i�T��e @ �� �d��c8�"�3El�9�e�Y�L >.deps/npm/@openzeppelin/contracts/utils/cryptography/ECDSA.sol i�T�3�@i�T�3�@ 8 �� 'd �ʝ $T��X�����u ?.deps/npm/@openzeppelin/contracts/utils/cryptography/EIP712.sol i�T�5@i�T�5@ < |