Warning! Contract bytecode has been changed and doesn't match the verified one. Therefore, interaction with this smart contract may be risky.
- Contract name:
- DirectAuthModuleV2
- Optimization enabled
- true
- Compiler version
- v0.8.24+commit.e11b9ed9
- Optimization runs
- 200
- EVM Version
- cancun
- Verified at
- 2025-09-17T12:37:28.025067Z
src/auth/DirectAuthModuleV2.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import "../interfaces/IAuthModule.sol";
import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
import "../libraries/errors/TrailblazerErrors.sol";
/**
* @title DirectAuthModuleV2
* @author taiko.xyz
* @notice Secure direct authentication module using ECDSA signatures (V2)
* @dev Enhanced security version that requires trusted signers for game results
*
* Security improvements in V2:
* - Requires trusted signers for all game results (no winner self-signing)
* - Requires signatures for all game actions (no unsigned actions)
* - Removes vulnerable fallback logic that allowed players to authorize themselves
*
* @custom:security-contact security@trailblazer.com
*/
contract DirectAuthModuleV2 is IAuthModule, EIP712, AccessControl {
using ECDSA for bytes32;
using MessageHashUtils for bytes32;
// ============================================
// Constants
// ============================================
/// @notice Module identifier constant
string private constant MODULE_ID = "DIRECT_AUTH_V2";
/// @notice Admin role for managing trusted signers and configuration
bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");
// EIP-712 Type Hashes
bytes32 private constant GAME_RESULT_TYPEHASH =
keccak256(
"GameResult(uint256 sessionId,address winner,bytes32 resultData,uint256 nonce,address gameContract)"
);
bytes32 private constant GAME_ACTION_TYPEHASH =
keccak256(
"GameAction(address player,uint256 sessionId,uint256 nonce,uint256 timestamp,bytes actionData)"
);
bytes32 private constant STAKE_VERIFICATION_TYPEHASH =
keccak256(
"StakeVerification(address game,address player,uint256 stakeValue,uint256 nonce,uint256 timestamp,uint256 chainId)"
);
bytes32 private constant SPONSORED_ACTION_TYPEHASH =
keccak256(
"SponsoredAction(address player,address game,string action,bytes data,uint256 nonce,uint256 deadline)"
);
// ============================================
// State Variables
// ============================================
/// @notice Mapping of game contracts to their trusted signer addresses
mapping(address => address) public gameTrustedSigners;
/// @notice Mapping of used signature hashes for replay protection
mapping(bytes32 => bool) public usedSignatures;
/// @notice Mapping of player nonces for signature protection
mapping(address => uint256) public playerNonces;
/// @notice Mapping of game contract nonces for result signatures
mapping(address => uint256) public gameNonces;
/// @notice Mapping of stake verification nonces per player per game
mapping(address => mapping(address => uint256)) public stakeNonces;
/// @notice Maximum allowed timestamp drift (5 minutes)
uint256 public constant MAX_TIMESTAMP_DRIFT = 300;
/// @notice Owner address for managing trusted signers
address public owner;
/// @notice Mapping of authorized callers who can increment nonces (GameHub routers)
mapping(address => bool) public authorizedCallers;
/// @notice Mapping of game contracts to their authorized backend addresses for sponsored actions
mapping(address => mapping(address => bool)) public gameAuthorizedBackends;
/// @notice Mapping to track authorized backend addresses globally (can sponsor for any game)
mapping(address => bool) public authorizedBackends;
/// @notice Mapping of player sponsored action nonces for replay protection
mapping(address => uint256) public sponsoredActionNonces;
// ============================================
// Events
// ============================================
event TrustedSignerUpdated(address indexed game, address indexed signer);
event SignatureUsed(bytes32 indexed signatureHash);
event PlayerNonceIncremented(address indexed player, uint256 newNonce);
event GameNonceIncremented(address indexed gameContract, uint256 newNonce);
event AuthenticationAttempt(
address indexed sender,
address indexed player,
bool success
);
event GameResultVerification(
uint256 indexed sessionId,
address indexed gameContract,
bool success
);
event GameActionVerification(
address indexed player,
uint256 indexed sessionId,
bool success
);
event StakeVerification(
address indexed game,
address indexed player,
uint256 stakeValue,
bool success
);
event StakeNonceIncremented(
address indexed game,
address indexed player,
uint256 newNonce
);
event GameBackendAuthorized(
address indexed game,
address indexed backend,
bool authorized
);
event BackendAuthorized(address indexed backend, bool authorized);
event SponsoredActionVerification(
address indexed player,
address indexed game,
address indexed backend,
bool success
);
// ============================================
// Modifiers
// ============================================
modifier onlyOwner() {
if (msg.sender != owner) revert TrailblazerErrors.NotOwner();
_;
}
// ============================================
// Constructor
// ============================================
constructor() EIP712("TrailblazerDirectAuthV2", "1") {
owner = msg.sender;
// Grant deployer both owner and admin roles
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(ADMIN_ROLE, msg.sender);
}
// ============================================
// Core Authentication Functions
// ============================================
/**
* @notice Verifies that a player action is authorized
* @dev For direct auth, verifies msg.sender matches expected player OR backend sponsorship
* @param sender The transaction sender (msg.sender)
* @param expectedPlayer The expected player address
* @param authProof Authentication proof containing game context for sponsored actions
* @return True if authentication succeeds
*/
function verifyAction(
address sender,
address expectedPlayer,
bytes calldata authProof
) external view override returns (bool) {
if (sender == expectedPlayer) {
return true;
}
if (authProof.length > 0) {
return _verifyBackendSponsorship(sender, expectedPlayer, authProof);
}
return false;
}
/**
* @notice Verifies backend-sponsored action with player signature verification
* @dev Validates that player signed authorization for backend to sponsor this action
* @param sender The backend address attempting to sponsor the action
* @param expectedPlayer The player for whom the action is being sponsored
* @param authProof Contains structured authorization data and player signature
* @return True if the backend is authorized and player signature is valid
*/
function _verifyBackendSponsorship(
address sender,
address expectedPlayer,
bytes calldata authProof
) internal view returns (bool) {
// Decode authProof: (game, action, data, nonce, deadline, signature)
if (authProof.length < 160) return false; // Minimum size check
(
address game,
string memory action,
bytes memory data,
uint256 nonce,
uint256 deadline,
bytes memory signature
) = abi.decode(
authProof,
(address, string, bytes, uint256, uint256, bytes)
);
// Check deadline
if (block.timestamp > deadline) return false;
// Check nonce (must match current nonce for replay protection)
if (nonce != sponsoredActionNonces[expectedPlayer]) return false;
// Check if sender is authorized for this specific game OR globally authorized
if (
!gameAuthorizedBackends[game][sender] && !authorizedBackends[sender]
) {
return false;
}
// Create EIP-712 structured hash for player signature verification
bytes32 structHash = keccak256(
abi.encode(
SPONSORED_ACTION_TYPEHASH,
expectedPlayer,
game,
keccak256(bytes(action)),
keccak256(data),
nonce,
deadline
)
);
bytes32 messageHash = _hashTypedDataV4(structHash);
// Recover signer from signature
address signer = messageHash.recover(signature);
// Verify signature is from the expected player
return signer == expectedPlayer;
}
/**
* @notice Verifies a game result signature - SECURE VERSION
* @dev SECURITY FIX: Always requires trusted signer, no fallback to winner self-signing
* @param sessionId The game session ID
* @param winner The claimed winner address
* @param signature The game result signature
* @param gameContract The game contract address that should have signed
* @return True if signature is valid
*/
function verifyGameResult(
uint256 sessionId,
address winner,
bytes32, // resultData - unused in current implementation
bytes calldata signature,
address gameContract
) external view returns (bool) {
if (signature.length == 0) return false;
if (gameContract == address(0)) return false;
// ALWAYS require trusted signer - no fallback
address trustedSigner = gameTrustedSigners[gameContract];
if (trustedSigner == address(0)) {
// No trusted signer configured - reject
return false;
}
// Create message hash
bytes32 messageHash = keccak256(
abi.encodePacked("GAME_RESULT", winner, sessionId, block.chainid)
).toEthSignedMessageHash();
// Recover and verify signer
address signer = messageHash.recover(signature);
return signer == trustedSigner;
}
/**
* @notice Verifies a game action signature - SECURE VERSION
* @dev SECURITY FIX: Always requires signature, no unsigned actions allowed
* @param player The player performing the action
* @param sessionId The game session ID
* @param actionData The encoded action data
* @param signature The action signature
* @return True if signature is valid
*/
function verifyGameAction(
address player,
uint256 sessionId,
bytes calldata actionData,
bytes calldata signature
) external view override returns (bool) {
// Require signatures for all actions (remove unsigned allowance)
if (signature.length == 0) return false;
// Create message hash
bytes32 messageHash = keccak256(
abi.encodePacked(
"GAME_ACTION",
player,
sessionId,
actionData,
block.chainid
)
).toEthSignedMessageHash();
// Recover signer
address signer = messageHash.recover(signature);
// Verify signer is the player
return signer == player;
}
/**
* @notice Verifies a stake value signature with enhanced security
* @dev Validates that a stake value is properly attested by a trusted signer
* @param game The game contract address
* @param player The player address
* @param stakeValue The claimed stake value (USD with 18 decimals)
* @param timestamp The signature timestamp (must be recent)
* @param signature The stake verification signature
* @return True if stake proof is valid
*/
function verifyStakeValue(
address game,
address player,
uint256 stakeValue,
uint256 timestamp,
bytes calldata signature
) external returns (bool) {
// Skip verification if no stake value
if (stakeValue == 0) {
emit StakeVerification(game, player, 0, true);
return true;
}
// Require signature for non-zero stakes
if (signature.length == 0) {
emit StakeVerification(game, player, stakeValue, false);
return false;
}
// Check timestamp validity (within 10 minutes)
if (block.timestamp > timestamp + MAX_TIMESTAMP_DRIFT * 2) {
emit StakeVerification(game, player, stakeValue, false);
return false;
}
// Get current nonce
uint256 currentNonce = stakeNonces[game][player];
// Create EIP-712 structured hash
bytes32 structHash = keccak256(
abi.encode(
STAKE_VERIFICATION_TYPEHASH,
game,
player,
stakeValue,
currentNonce,
timestamp,
block.chainid
)
);
bytes32 messageHash = _hashTypedDataV4(structHash);
// Recover signer
address signer = messageHash.recover(signature);
// Verify signer is the trusted signer for this game
address trustedSigner = gameTrustedSigners[game];
bool isValid = trustedSigner != address(0) && signer == trustedSigner;
if (isValid) {
// Increment nonce to prevent replay
stakeNonces[game][player] = currentNonce + 1;
emit StakeNonceIncremented(game, player, currentNonce + 1);
}
emit StakeVerification(game, player, stakeValue, isValid);
return isValid;
}
// ============================================
// Nonce Management Functions
// ============================================
/**
* @notice Increments a player's nonce after successful action verification
* @param player The player whose nonce to increment
*/
function incrementPlayerNonce(address player) external {
if (!authorizedCallers[msg.sender])
revert TrailblazerErrors.Unauthorized();
playerNonces[player]++;
emit PlayerNonceIncremented(player, playerNonces[player]);
}
/**
* @notice Gets the current nonce for a player
* @param player The player address
* @return Current nonce value
*/
function getPlayerNonce(address player) external view returns (uint256) {
return playerNonces[player];
}
/**
* @notice Increments a game contract's nonce after successful result verification
* @param gameContract The game contract whose nonce to increment
*/
function incrementGameNonce(address gameContract) external {
if (!authorizedCallers[msg.sender])
revert TrailblazerErrors.Unauthorized();
gameNonces[gameContract]++;
emit GameNonceIncremented(gameContract, gameNonces[gameContract]);
}
/**
* @notice Gets the current nonce for a game contract
* @param gameContract The game contract address
* @return Current nonce value
*/
function getGameNonce(
address gameContract
) external view returns (uint256) {
return gameNonces[gameContract];
}
/**
* @notice Gets the current stake nonce for a player in a specific game
* @param game The game contract address
* @param player The player address
* @return Current stake nonce value
*/
function getStakeNonce(
address game,
address player
) external view returns (uint256) {
return stakeNonces[game][player];
}
/**
* @notice Increments a player's sponsored action nonce after successful verification
* @param player The player whose nonce to increment
*/
function incrementSponsoredActionNonce(address player) external {
if (!authorizedCallers[msg.sender])
revert TrailblazerErrors.Unauthorized();
sponsoredActionNonces[player]++;
}
/**
* @notice Gets the current sponsored action nonce for a player
* @param player The player address
* @return Current sponsored action nonce value
*/
function getSponsoredActionNonce(
address player
) external view returns (uint256) {
return sponsoredActionNonces[player];
}
// ============================================
// Configuration Functions
// ============================================
/**
* @notice Sets the trusted signer for a specific game
* @param game The game contract address
* @param trustedSigner The trusted signer address for this game
*/
function setGameTrustedSigner(
address game,
address trustedSigner
) external onlyRole(ADMIN_ROLE) {
if (game == address(0)) revert TrailblazerErrors.ZeroAddress();
gameTrustedSigners[game] = trustedSigner;
emit TrustedSignerUpdated(game, trustedSigner);
}
/**
* @notice Authorizes a backend to sponsor actions for a specific game
* @param game The game contract address
* @param backend The backend address to authorize
* @param authorized True to authorize, false to revoke
*/
function setGameAuthorizedBackend(
address game,
address backend,
bool authorized
) external onlyRole(ADMIN_ROLE) {
if (game == address(0)) revert TrailblazerErrors.ZeroAddress();
if (backend == address(0)) revert TrailblazerErrors.ZeroAddress();
gameAuthorizedBackends[game][backend] = authorized;
emit GameBackendAuthorized(game, backend, authorized);
}
/**
* @notice Authorizes a backend globally (can sponsor for any game that allows it)
* @param backend The backend address to authorize
* @param authorized True to authorize, false to revoke
*/
function setAuthorizedBackend(
address backend,
bool authorized
) external onlyRole(ADMIN_ROLE) {
if (backend == address(0)) revert TrailblazerErrors.ZeroAddress();
authorizedBackends[backend] = authorized;
emit BackendAuthorized(backend, authorized);
}
/**
* @notice Updates the owner address
* @param newOwner The new owner address
*/
function transferOwnership(address newOwner) external onlyOwner {
if (newOwner == address(0)) revert TrailblazerErrors.ZeroAddress();
owner = newOwner;
}
/**
* @notice Authorizes a caller to increment nonces (typically GameHub routers)
* @param caller The address to authorize
*/
function authorizeCaller(address caller) external onlyOwner {
if (caller == address(0)) revert TrailblazerErrors.ZeroAddress();
authorizedCallers[caller] = true;
}
/**
* @notice Revokes authorization from a caller
* @param caller The address to revoke authorization from
*/
function revokeCaller(address caller) external onlyOwner {
authorizedCallers[caller] = false;
}
// ============================================
// Utility Functions
// ============================================
/**
* @notice Creates a signature hash for replay protection
* @param signature The signature bytes
* @return The hash of the signature
*/
function getSignatureHash(
bytes calldata signature
) external pure returns (bytes32) {
return keccak256(signature);
}
/**
* @notice Checks if a signature hash has been used
* @param signatureHash The signature hash to check
* @return True if the signature has been used
*/
function isSignatureUsed(
bytes32 signatureHash
) external view returns (bool) {
return usedSignatures[signatureHash];
}
/**
* @notice Marks a signature hash as used (internal)
* @param signatureHash The signature hash to mark
*/
function _markSignatureUsed(bytes32 signatureHash) internal {
usedSignatures[signatureHash] = true;
emit SignatureUsed(signatureHash);
}
// ============================================
// View Functions
// ============================================
/**
* @notice Gets the trusted signer for a game
* @param game The game contract address
* @return The trusted signer address
*/
function getTrustedSigner(address game) external view returns (address) {
return gameTrustedSigners[game];
}
/**
* @notice Checks if a backend is authorized for a specific game
* @param game The game contract address
* @param backend The backend address to check
* @return True if the backend is authorized to sponsor actions for this game
*/
function isBackendAuthorizedForGame(
address game,
address backend
) external view returns (bool) {
return
gameAuthorizedBackends[game][backend] ||
authorizedBackends[backend];
}
/**
* @notice Gets global authorization status for a backend
* @param backend The backend address to check
* @return True if the backend is globally authorized
*/
function getBackendAuthorization(
address backend
) external view returns (bool) {
return authorizedBackends[backend];
}
/**
* @notice Returns the module identifier
* @return The module ID string
*/
function moduleId() public pure override returns (string memory) {
return MODULE_ID;
}
/**
* @notice Gets module information
* @return moduleIdentifier The module ID string
* @return ownerAddress The current owner address
*/
function getModuleInfo()
external
view
returns (string memory moduleIdentifier, address ownerAddress)
{
return (MODULE_ID, owner);
}
/**
* @notice Checks if the module supports a specific feature
* @param feature The feature identifier
* @return True if the feature is supported
*/
function supportsFeature(
string calldata feature
) external pure returns (bool) {
bytes32 featureHash = keccak256(bytes(feature));
// Supported features
if (featureHash == keccak256("DIRECT_AUTH")) return true;
if (featureHash == keccak256("SIGNATURE_VERIFICATION")) return true;
if (featureHash == keccak256("TRUSTED_SIGNERS")) return true;
if (featureHash == keccak256("REPLAY_PROTECTION")) return true;
if (featureHash == keccak256("SPONSORED_ACTIONS")) return true;
return false;
}
/**
* @notice Exposes EIP-712 hash function for testing
* @param structHash The struct hash to process
* @return The EIP-712 typed data hash
*/
function hashTypedDataV4(
bytes32 structHash
) external view returns (bytes32) {
return _hashTypedDataV4(structHash);
}
}
lib/openzeppelin-contracts/contracts/access/AccessControl.sol
// 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;
}
}
}
lib/openzeppelin-contracts/contracts/access/IAccessControl.sol
// 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;
}
lib/openzeppelin-contracts/contracts/interfaces/IERC5267.sol
// 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
);
}
lib/openzeppelin-contracts/contracts/utils/Context.sol
// 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;
}
}
lib/openzeppelin-contracts/contracts/utils/Panic.sol
// 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)
}
}
}
lib/openzeppelin-contracts/contracts/utils/ShortStrings.sol
// 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;
}
}
}
lib/openzeppelin-contracts/contracts/utils/StorageSlot.sol
// 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
}
}
}
lib/openzeppelin-contracts/contracts/utils/Strings.sol
// 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))
}
}
}
lib/openzeppelin-contracts/contracts/utils/cryptography/ECDSA.sol
// 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);
}
}
}
lib/openzeppelin-contracts/contracts/utils/cryptography/EIP712.sol
// 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);
}
}
lib/openzeppelin-contracts/contracts/utils/cryptography/MessageHashUtils.sol
// 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)
}
}
}
lib/openzeppelin-contracts/contracts/utils/introspection/ERC165.sol
// 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;
}
}
lib/openzeppelin-contracts/contracts/utils/introspection/IERC165.sol
// 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);
}
lib/openzeppelin-contracts/contracts/utils/math/Math.sol
// 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;
}
}
lib/openzeppelin-contracts/contracts/utils/math/SafeCast.sol
// 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))
}
}
}
lib/openzeppelin-contracts/contracts/utils/math/SignedMath.sol
// 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);
}
}
}
src/interfaces/IAuthModule.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/**
* @title IAuthModule
* @author taiko.xyz
* @notice Interface for authentication modules
* @dev Pluggable authentication system for different auth methods
*/
interface IAuthModule {
/**
* @notice Gets the module identifier
* @return The module ID string
*/
function moduleId() external pure returns (string memory);
/**
* @notice Verifies that a user action is authorized
* @param sender The address initiating the action
* @param user The user address being acted upon
* @param proof Authentication proof (signature, etc.)
* @return True if the action is authorized
*/
function verifyAction(address sender, address user, bytes calldata proof) external view returns (bool);
/**
* @notice Verifies a game result signature
* @param sessionId The session ID
* @param winner The claimed winner address
* @param resultData The game result data
* @param signature The game result signature
* @param gameContract The game contract address that should have signed
* @return True if the signature is valid
*/
function verifyGameResult(
uint256 sessionId,
address winner,
bytes32 resultData,
bytes calldata signature,
address gameContract
) external returns (bool);
/**
* @notice Verifies a game action signature
* @param player The player address
* @param sessionId The session ID
* @param actionData The action data
* @param signature The action signature
* @return True if the signature is valid
*/
function verifyGameAction(address player, uint256 sessionId, bytes calldata actionData, bytes calldata signature)
external
returns (bool);
/**
* @notice Increments a player's nonce after successful action verification
* @param player The player whose nonce to increment
*/
function incrementPlayerNonce(address player) external;
/**
* @notice Increments a game contract's nonce after successful result verification
* @param gameContract The game contract whose nonce to increment
*/
function incrementGameNonce(address gameContract) external;
/**
* @notice Gets the current nonce for a player
* @param player The player address
* @return Current nonce value
*/
function getPlayerNonce(address player) external view returns (uint256);
/**
* @notice Gets the current nonce for a game contract
* @param gameContract The game contract address
* @return Current nonce value
*/
function getGameNonce(address gameContract) external view returns (uint256);
/**
* @notice Verifies a stake value attestation for gambling games
* @param game The game contract address
* @param player The player address
* @param stakeValue The claimed stake value (USD with 18 decimals)
* @param timestamp The signature timestamp
* @param signature The stake verification signature
* @return True if stake proof is valid
*/
function verifyStakeValue(
address game,
address player,
uint256 stakeValue,
uint256 timestamp,
bytes calldata signature
) external returns (bool);
}
src/libraries/errors/TrailblazerErrors.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/**
* @title TrailblazerErrors
* @author taiko.xyz
* @notice Standardized error messages for the Trailblazer gaming platform
* @dev Custom errors provide better debugging information
*/
library TrailblazerErrors {
// ============================================
// Access Control Errors
// ============================================
/// @dev Thrown when caller lacks required permissions
error Unauthorized();
/// @dev Thrown when caller is not the contract owner
error NotOwner();
/// @dev Thrown when caller is not a valid game hub
error NotGameHub();
/// @dev Thrown when caller is not the router
error NotRouter();
// ============================================
// Address Validation Errors
// ============================================
/// @dev Thrown when a required address is zero
error ZeroAddress();
/// @dev Thrown when an invalid game contract address is provided
error InvalidGame();
/// @dev Thrown when an invalid player address is provided
error InvalidPlayer();
// ============================================
// Session Management Errors
// ============================================
/// @dev Thrown when session ID is invalid or doesn't exist
error InvalidSession();
/// @dev Thrown when a session has already ended
error SessionEnded();
/// @dev Thrown when a session has expired
error SessionExpired();
/// @dev Thrown when a player is already in another game session
error PlayerAlreadyInGame();
/// @dev Thrown when trying to start a session with no players
error NoPlayersProvided();
/// @dev Thrown when too many players are provided for a session
error TooManyPlayers();
/// @dev Thrown when duplicate players are provided
error DuplicatePlayer();
/// @dev Thrown when TTL is invalid (too short or too long)
error InvalidTTL();
// ============================================
// Authentication Errors
// ============================================
/// @dev Thrown when authentication fails
error AuthenticationFailed();
/// @dev Thrown when a signature is invalid
error InvalidSignature();
/// @dev Thrown when a signature has already been used (replay attack)
error SignatureAlreadyUsed();
/// @dev Thrown when signature is too old (timestamp validation)
error SignatureExpired();
/// @dev Thrown when nonce is invalid (not sequential)
error InvalidNonce();
// ============================================
// Balance and Fee Errors
// ============================================
/// @dev Thrown when an amount is zero when it shouldn't be
error ZeroAmount();
/// @dev Thrown when there's insufficient balance for an operation
error InsufficientBalance();
/// @dev Thrown when trying to unlock more than is locked
error InsufficientLockedBalance();
/// @dev Thrown when a fee transfer fails
error FeeTransferFailed();
/// @dev Thrown when basis points don't sum to 10000
error InvalidBasisPoints();
// ============================================
// Contract State Errors
// ============================================
/// @dev Thrown when system is paused
error SystemPaused();
/// @dev Thrown when a specific game is paused
error GamePaused();
/// @dev Thrown when a contract is not properly initialized
error NotInitialized();
/// @dev Thrown when trying to initialize an already initialized contract
error AlreadyInitialized();
// ============================================
// Game-Specific Errors
// ============================================
/// @dev Thrown when a game is not whitelisted
error GameNotWhitelisted();
/// @dev Thrown when a game doesn't meet player count requirements
error InvalidPlayerCount();
/// @dev Thrown when game validation fails
error GameValidationFailed(string reason);
/// @dev Thrown when a player doesn't meet game requirements
error PlayerNotEligible();
// ============================================
// Batch Operation Errors
// ============================================
/// @dev Thrown when batch size is too large
error BatchSizeTooLarge();
/// @dev Thrown when batch operation fails
error BatchOperationFailed();
// ============================================
// Lock Mechanism Errors
// ============================================
/// @dev Thrown when trying to interact with an expired lock
error LockExpired();
/// @dev Thrown when trying to unlock when no lock exists
error NoActiveLock();
/// @dev Thrown when emergency unlock is not enabled
error EmergencyUnlockDisabled();
// ============================================
// Experience Processing Errors
// ============================================
/// @dev Thrown when experience manager is not configured
error ExperienceManagerNotConfigured();
/// @dev Thrown when experience processing fails for a player
error ExperienceProcessingFailed(address player, address game);
/// @dev Thrown when tournament experience processing fails
error TournamentExperienceProcessingFailed(bytes32 tournamentId, address player);
/// @dev Thrown when tournament manager is not configured
error TournamentManagerNotConfigured();
/// @dev Thrown when trying to award experience with invalid parameters
error InvalidExperienceParameters();
/// @dev Thrown when player is not registered for tournament
error PlayerNotRegisteredForTournament(bytes32 tournamentId, address player);
/// @dev Thrown when tournament is not active
error TournamentNotActive(bytes32 tournamentId);
// ============================================
// Configuration Errors
// ============================================
/// @dev Thrown when configuration is invalid
error InvalidConfiguration();
/// @dev Thrown when trying to set invalid fee configuration
error InvalidFeeConfiguration();
/// @dev Thrown when game mode is invalid
error InvalidGameMode();
// ============================================
// Stake-Related Errors
// ============================================
/// @dev Thrown when stake value is invalid (e.g., zero when required)
error InvalidStakeValue();
/// @dev Thrown when stake proof is invalid or verification fails
error InvalidStakeProof();
/// @dev Thrown when wrong number of players for staked games
error InvalidPlayers();
// ============================================
// Session Validation Errors
// ============================================
/// @dev Thrown when game is not active
error GameNotActive();
/// @dev Thrown when array lengths don't match in batch operations
error ArrayLengthMismatch();
/// @dev Thrown when a profile doesn't exist
error NoProfile();
/// @dev Thrown when player profile is inactive
error PlayerInactive();
/// @dev Thrown when player cannot play games
error PlayerCannotPlayGames();
/// @dev Thrown when auth module is not found
error AuthModuleNotFound();
/// @dev Thrown when profile manager is not found
error ProfileManagerNotFound();
/// @dev Thrown when session manager is not found
error SessionManagerNotFound();
/// @dev Thrown when not game owner
error NotGameOwner();
/// @dev Thrown when system is emergency paused
error EmergencyPaused();
/// @dev Thrown when caller is not the router
error OnlyRouter();
/// @dev Thrown when invalid address manager
error InvalidAddressManager();
/// @dev Thrown when invalid router address
error InvalidRouter();
// ============================================
// Experience Manager Errors
// ============================================
/// @dev Thrown when season duration is invalid
error InvalidSeasonDuration();
/// @dev Thrown when competition already exists
error CompetitionAlreadyExists();
/// @dev Thrown when multiplier is too high
error MultiplierTooHigh();
/// @dev Thrown when competition has ended
error CompetitionEnded();
/// @dev Thrown when player is already participating in competition
error AlreadyParticipating();
/// @dev Thrown when XP entry fee is insufficient
error InsufficientXPForEntry();
/// @dev Thrown when XP amount is invalid
error InvalidXPAmount();
/// @dev Thrown when reason is empty
error EmptyReason();
/// @dev Thrown when competition multiplier is too high
error CompetitionMultiplierTooHigh();
/// @dev Thrown when multiplier is invalid
error InvalidMultiplier();
/// @dev Thrown when duration is invalid
error InvalidDuration();
/// @dev Thrown when there are too many tiers
error TooManyTiers();
/// @dev Thrown when stakes are not in ascending order
error StakesNotAscending();
/// @dev Thrown when multipliers are not non-decreasing
error MultipliersNotNonDecreasing();
// ============================================
// Game Flag Management Errors
// ============================================
/// @dev Thrown when a flag already exists
error FlagAlreadySet();
/// @dev Thrown when a flag is not found
error FlagNotFound();
// ============================================
// Signature Verification Errors
// ============================================
/// @dev Thrown when a nonce has already been used
error NonceAlreadyUsed();
/// @dev Thrown when trusted signer is not set
error TrustedSignerNotSet();
/// @dev Thrown when setting the same trusted signer
error SameTrustedSigner();
}
Compiler Settings
{"viaIR":true,"remappings":["@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/","@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/","erc4626-tests/=lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/","evm/=lib/evm/contracts/","forge-std/=lib/forge-std/src/","halmos-cheatcodes/=lib/openzeppelin-contracts-upgradeable/lib/halmos-cheatcodes/src/","openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/","openzeppelin-contracts/=lib/openzeppelin-contracts/"],"outputSelection":{"*":{"*":["*"],"":["*"]}},"optimizer":{"runs":200,"enabled":true},"metadata":{"useLiteralContent":false,"bytecodeHash":"ipfs","appendCBOR":true},"libraries":{},"evmVersion":"cancun"}
Contract ABI
[{"type":"constructor","stateMutability":"nonpayable","inputs":[]},{"type":"error","name":"AccessControlBadConfirmation","inputs":[]},{"type":"error","name":"AccessControlUnauthorizedAccount","inputs":[{"type":"address","name":"account","internalType":"address"},{"type":"bytes32","name":"neededRole","internalType":"bytes32"}]},{"type":"error","name":"ECDSAInvalidSignature","inputs":[]},{"type":"error","name":"ECDSAInvalidSignatureLength","inputs":[{"type":"uint256","name":"length","internalType":"uint256"}]},{"type":"error","name":"ECDSAInvalidSignatureS","inputs":[{"type":"bytes32","name":"s","internalType":"bytes32"}]},{"type":"error","name":"InvalidShortString","inputs":[]},{"type":"error","name":"NotOwner","inputs":[]},{"type":"error","name":"StringTooLong","inputs":[{"type":"string","name":"str","internalType":"string"}]},{"type":"error","name":"Unauthorized","inputs":[]},{"type":"error","name":"ZeroAddress","inputs":[]},{"type":"event","name":"AuthenticationAttempt","inputs":[{"type":"address","name":"sender","internalType":"address","indexed":true},{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"bool","name":"success","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"BackendAuthorized","inputs":[{"type":"address","name":"backend","internalType":"address","indexed":true},{"type":"bool","name":"authorized","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"EIP712DomainChanged","inputs":[],"anonymous":false},{"type":"event","name":"GameActionVerification","inputs":[{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"uint256","name":"sessionId","internalType":"uint256","indexed":true},{"type":"bool","name":"success","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"GameBackendAuthorized","inputs":[{"type":"address","name":"game","internalType":"address","indexed":true},{"type":"address","name":"backend","internalType":"address","indexed":true},{"type":"bool","name":"authorized","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"GameNonceIncremented","inputs":[{"type":"address","name":"gameContract","internalType":"address","indexed":true},{"type":"uint256","name":"newNonce","internalType":"uint256","indexed":false}],"anonymous":false},{"type":"event","name":"GameResultVerification","inputs":[{"type":"uint256","name":"sessionId","internalType":"uint256","indexed":true},{"type":"address","name":"gameContract","internalType":"address","indexed":true},{"type":"bool","name":"success","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"PlayerNonceIncremented","inputs":[{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"uint256","name":"newNonce","internalType":"uint256","indexed":false}],"anonymous":false},{"type":"event","name":"RoleAdminChanged","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32","indexed":true},{"type":"bytes32","name":"previousAdminRole","internalType":"bytes32","indexed":true},{"type":"bytes32","name":"newAdminRole","internalType":"bytes32","indexed":true}],"anonymous":false},{"type":"event","name":"RoleGranted","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32","indexed":true},{"type":"address","name":"account","internalType":"address","indexed":true},{"type":"address","name":"sender","internalType":"address","indexed":true}],"anonymous":false},{"type":"event","name":"RoleRevoked","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32","indexed":true},{"type":"address","name":"account","internalType":"address","indexed":true},{"type":"address","name":"sender","internalType":"address","indexed":true}],"anonymous":false},{"type":"event","name":"SignatureUsed","inputs":[{"type":"bytes32","name":"signatureHash","internalType":"bytes32","indexed":true}],"anonymous":false},{"type":"event","name":"SponsoredActionVerification","inputs":[{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"address","name":"game","internalType":"address","indexed":true},{"type":"address","name":"backend","internalType":"address","indexed":true},{"type":"bool","name":"success","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"StakeNonceIncremented","inputs":[{"type":"address","name":"game","internalType":"address","indexed":true},{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"uint256","name":"newNonce","internalType":"uint256","indexed":false}],"anonymous":false},{"type":"event","name":"StakeVerification","inputs":[{"type":"address","name":"game","internalType":"address","indexed":true},{"type":"address","name":"player","internalType":"address","indexed":true},{"type":"uint256","name":"stakeValue","internalType":"uint256","indexed":false},{"type":"bool","name":"success","internalType":"bool","indexed":false}],"anonymous":false},{"type":"event","name":"TrustedSignerUpdated","inputs":[{"type":"address","name":"game","internalType":"address","indexed":true},{"type":"address","name":"signer","internalType":"address","indexed":true}],"anonymous":false},{"type":"function","stateMutability":"view","outputs":[{"type":"bytes32","name":"","internalType":"bytes32"}],"name":"ADMIN_ROLE","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"bytes32","name":"","internalType":"bytes32"}],"name":"DEFAULT_ADMIN_ROLE","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"MAX_TIMESTAMP_DRIFT","inputs":[]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"authorizeCaller","inputs":[{"type":"address","name":"caller","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"authorizedBackends","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"authorizedCallers","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bytes1","name":"fields","internalType":"bytes1"},{"type":"string","name":"name","internalType":"string"},{"type":"string","name":"version","internalType":"string"},{"type":"uint256","name":"chainId","internalType":"uint256"},{"type":"address","name":"verifyingContract","internalType":"address"},{"type":"bytes32","name":"salt","internalType":"bytes32"},{"type":"uint256[]","name":"extensions","internalType":"uint256[]"}],"name":"eip712Domain","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"gameAuthorizedBackends","inputs":[{"type":"address","name":"","internalType":"address"},{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"gameNonces","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"address","name":"","internalType":"address"}],"name":"gameTrustedSigners","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"getBackendAuthorization","inputs":[{"type":"address","name":"backend","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"getGameNonce","inputs":[{"type":"address","name":"gameContract","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"string","name":"moduleIdentifier","internalType":"string"},{"type":"address","name":"ownerAddress","internalType":"address"}],"name":"getModuleInfo","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"getPlayerNonce","inputs":[{"type":"address","name":"player","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bytes32","name":"","internalType":"bytes32"}],"name":"getRoleAdmin","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32"}]},{"type":"function","stateMutability":"pure","outputs":[{"type":"bytes32","name":"","internalType":"bytes32"}],"name":"getSignatureHash","inputs":[{"type":"bytes","name":"signature","internalType":"bytes"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"getSponsoredActionNonce","inputs":[{"type":"address","name":"player","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"getStakeNonce","inputs":[{"type":"address","name":"game","internalType":"address"},{"type":"address","name":"player","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"address","name":"","internalType":"address"}],"name":"getTrustedSigner","inputs":[{"type":"address","name":"game","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"grantRole","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32"},{"type":"address","name":"account","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"hasRole","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32"},{"type":"address","name":"account","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bytes32","name":"","internalType":"bytes32"}],"name":"hashTypedDataV4","inputs":[{"type":"bytes32","name":"structHash","internalType":"bytes32"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"incrementGameNonce","inputs":[{"type":"address","name":"gameContract","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"incrementPlayerNonce","inputs":[{"type":"address","name":"player","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"incrementSponsoredActionNonce","inputs":[{"type":"address","name":"player","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"isBackendAuthorizedForGame","inputs":[{"type":"address","name":"game","internalType":"address"},{"type":"address","name":"backend","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"isSignatureUsed","inputs":[{"type":"bytes32","name":"signatureHash","internalType":"bytes32"}]},{"type":"function","stateMutability":"pure","outputs":[{"type":"string","name":"","internalType":"string"}],"name":"moduleId","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"address","name":"","internalType":"address"}],"name":"owner","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"playerNonces","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"renounceRole","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32"},{"type":"address","name":"callerConfirmation","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"revokeCaller","inputs":[{"type":"address","name":"caller","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"revokeRole","inputs":[{"type":"bytes32","name":"role","internalType":"bytes32"},{"type":"address","name":"account","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"setAuthorizedBackend","inputs":[{"type":"address","name":"backend","internalType":"address"},{"type":"bool","name":"authorized","internalType":"bool"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"setGameAuthorizedBackend","inputs":[{"type":"address","name":"game","internalType":"address"},{"type":"address","name":"backend","internalType":"address"},{"type":"bool","name":"authorized","internalType":"bool"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"setGameTrustedSigner","inputs":[{"type":"address","name":"game","internalType":"address"},{"type":"address","name":"trustedSigner","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"sponsoredActionNonces","inputs":[{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"","internalType":"uint256"}],"name":"stakeNonces","inputs":[{"type":"address","name":"","internalType":"address"},{"type":"address","name":"","internalType":"address"}]},{"type":"function","stateMutability":"pure","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"supportsFeature","inputs":[{"type":"string","name":"feature","internalType":"string"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"supportsInterface","inputs":[{"type":"bytes4","name":"interfaceId","internalType":"bytes4"}]},{"type":"function","stateMutability":"nonpayable","outputs":[],"name":"transferOwnership","inputs":[{"type":"address","name":"newOwner","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"usedSignatures","inputs":[{"type":"bytes32","name":"","internalType":"bytes32"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"verifyAction","inputs":[{"type":"address","name":"sender","internalType":"address"},{"type":"address","name":"expectedPlayer","internalType":"address"},{"type":"bytes","name":"authProof","internalType":"bytes"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"verifyGameAction","inputs":[{"type":"address","name":"player","internalType":"address"},{"type":"uint256","name":"sessionId","internalType":"uint256"},{"type":"bytes","name":"actionData","internalType":"bytes"},{"type":"bytes","name":"signature","internalType":"bytes"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"verifyGameResult","inputs":[{"type":"uint256","name":"sessionId","internalType":"uint256"},{"type":"address","name":"winner","internalType":"address"},{"type":"bytes32","name":"","internalType":"bytes32"},{"type":"bytes","name":"signature","internalType":"bytes"},{"type":"address","name":"gameContract","internalType":"address"}]},{"type":"function","stateMutability":"nonpayable","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"verifyStakeValue","inputs":[{"type":"address","name":"game","internalType":"address"},{"type":"address","name":"player","internalType":"address"},{"type":"uint256","name":"stakeValue","internalType":"uint256"},{"type":"uint256","name":"timestamp","internalType":"uint256"},{"type":"bytes","name":"signature","internalType":"bytes"}]}]
Contract Creation Code
0x610160604090808252346200018c57620000198162000190565b6017815260208101907f547261696c626c617a65724469726563744175746856320000000000000000008252825192620000538462000190565b6001845260208401603160f81b81526200006d83620002bd565b936101209485526200007f8662000487565b93610140948552519020948560e05251902093610100948086524660a05282519060208201927f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f84528483015260608201524660808201523060a082015260a0815260c0810181811060018060401b03821117620001785783525190206080523060c052600880546001600160a01b031916339081179091556200012390620001ac565b506200012f336200021c565b505191611d2293846200062f85396080518461195c015260a05184611a27015260c05184611926015260e051846119ab015251836119d10152518261063f015251816106690152f35b634e487b7160e01b5f52604160045260245ffd5b5f80fd5b604081019081106001600160401b038211176200017857604052565b6001600160a01b03165f8181525f8051602062002371833981519152602052604090205460ff1662000217575f8181525f805160206200237183398151915260205260408120805460ff191660011790553391905f80516020620023518339815191528180a4600190565b505f90565b6001600160a01b03165f8181527fe5ebfa64fca8d502a8e50c1edffd2c31ef4dad5b396e65d9f397fb028f74abc560205260409020547fa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c21775919060ff16620002b757815f52600260205260405f20815f5260205260405f20600160ff1982541617905533915f80516020620023518339815191525f80a4600190565b50505f90565b805160209081811015620003575750601f825111620002f85780825192015190808310620002ea57501790565b825f19910360031b1b161790565b90604051809263305a27a960e01b82528060048301528251908160248401525f935b8285106200033d575050604492505f838284010152601f80199101168101030190fd5b84810182015186860160440152938101938593506200031a565b906001600160401b03821162000178575f54926001938481811c911680156200047c575b838210146200046857601f811162000432575b5081601f8411600114620003cc57509282939183925f94620003c0575b50501b915f199060031b1c1916175f5560ff90565b015192505f80620003ab565b919083601f1981165f8052845f20945f905b88838310620004175750505010620003fe575b505050811b015f5560ff90565b01515f1960f88460031b161c191690555f8080620003f1565b858701518855909601959485019487935090810190620003de565b5f805284601f845f20920160051c820191601f860160051c015b8281106200045c5750506200038e565b5f81550185906200044c565b634e487b7160e01b5f52602260045260245ffd5b90607f16906200037b565b805160209081811015620005135750601f825111620004b45780825192015190808310620002ea57501790565b90604051809263305a27a960e01b82528060048301528251908160248401525f935b828510620004f9575050604492505f838284010152601f80199101168101030190fd5b8481018201518686016044015293810193859350620004d6565b9192916001600160401b038111620001785760019182548381811c9116801562000623575b828210146200046857601f8111620005ed575b5080601f8311600114620005895750819293945f926200057d575b50505f19600383901b1c191690821b17905560ff90565b015190505f8062000566565b90601f19831695845f52825f20925f905b888210620005d55750508385969710620005bc575b505050811b01905560ff90565b01515f1960f88460031b161c191690555f8080620005af565b8087859682949686015181550195019301906200059a565b835f5283601f835f20920160051c820191601f850160051c015b828110620006175750506200054b565b5f815501849062000607565b90607f16906200053856fe6080604081815260049182361015610015575f80fd5b5f3560e01c9081622f13e114610ee45750806301ffc9a714610e905780630718867914610d1b5780630b40d57014610e4e5780630fde18b414610de857806319ead6fa146107cd5780631d0924c114610d8e578063248a9ca314610d645780632a00900714610d1b5780632b16aae014610c945780632c388d5d14610c345780632ccbbcb114610b7d5780632f2ff15d14610b55578063313b804914610a29578063341310b514610aed57806336568abe14610aa957806336938e0114610a605780633faf459e14610a29578063422f0494146109d2578063482f4b0d146109835780634980f2881461093e5780634d80efae146109135780634fb37f3c146108795780634fed66e814610804578063536fff6c1461083d57806356814b70146102af5780635ff007b01461080457806368efccbb146107cd57806375b238fc1461079357806377c79fe6146107455780637a662702146105f157806384b0196e1461062857806387a9b3e2146105f15780638da5cb5b146105c957806391d14854146105855780639b4c8ca0146104fe578063a1308f27146104ca578063a217fddf146104b0578063b77435301461045c578063ba9affd1146103cb578063bd09c18714610387578063d547741f1461034b578063ddb8cbd6146102eb578063e712a35d146102af578063f2fde38b146102465763f978fd6114610218575f80fd5b346102425760203660031901126102425781602092355f52825260ff815f20541690519015158152f35b5f80fd5b50903461024257602036600319011261024257610261610efe565b60085491906001600160a01b0390818416330361029f57169283156102925750506001600160a01b03191617600855005b5163d92e233d60e01b8152fd5b84516330cd747160e01b81528390fd5b5034610242576020366003190112610242576020906001600160a01b036102d4610efe565b165f52600b825260ff815f20541690519015158152f35b50903461024257602036600319011261024257610306610efe565b90335f52600960205260ff835f2054161561033e57506001600160a01b03165f908152600c60205220805461033a90611217565b9055005b82516282b42960e81b8152fd5b50346102425780600319360112610242576103859135610380600161036e610f14565b93835f5260026020525f2001546115b1565b611651565b005b5034610242576020366003190112610242578135916001600160401b038311610242576103bc6103c291602094369101610f68565b90611455565b90519015158152f35b5090346102425781600319360112610242576103e5610efe565b6103ed610f14565b926103f6611538565b6001600160a01b0391821692831561044e5750825f5260036020525f20921691826001600160601b0360a01b8254161790557f4a297cf5d32586f80d2b0708a39d2da1f46e6ae7722171e1c51dfd685b5b8aa85f80a3005b905163d92e233d60e01b8152fd5b50903461024257602036600319011261024257610477610efe565b6008546001600160a01b039290831633036104a25750165f908152600960205220805460ff19169055005b83516330cd747160e01b8152fd5b5034610242575f36600319011261024257602090515f8152f35b5034610242575f366003190112610242576104fa906104e7611001565b9051918291602083526020830190610f2a565b0390f35b50903461024257602036600319011261024257610519610efe565b90335f52600960205260ff835f2054161561033e575060207fe4e830adecc234de45c0056f4c717d92928326fbb6c62a3f0f27ca2e2ffcb7fd9160018060a01b031692835f5260058252805f206105708154611217565b9055835f5260058252805f20549051908152a2005b50346102425780600319360112610242576020916105a1610f14565b90355f5260028352815f209060018060a01b03165f52825260ff815f20541690519015158152f35b5034610242575f3660031901126102425760085490516001600160a01b039091168152602090f35b5034610242576020366003190112610242576020906001600160a01b03610616610efe565b165f52600c8252805f20549051908152f35b509034610242575f366003190112610242576106637f0000000000000000000000000000000000000000000000000000000000000000611a4d565b9161068d7f0000000000000000000000000000000000000000000000000000000000000000611b6e565b81519160209160208401948486106001600160401b0387111761073257506106e782602092876106da99989795525f85528151988998600f60f81b8a5260e0868b015260e08a0190610f2a565b9188830390890152610f2a565b914660608701523060808701525f60a087015285830360c087015251918281520192915f5b82811061071b57505050500390f35b83518552869550938101939281019260010161070c565b604190634e487b7160e01b5f525260245ffd5b5034610242578060031936011261024257602090610761610efe565b610769610f14565b9060018060a01b038091165f52600a8452825f2091165f52825260ff815f20541690519015158152f35b5034610242575f36600319011261024257602090517fa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c217758152f35b5034610242576020366003190112610242576020906001600160a01b036107f2610efe565b165f5260058252805f20549051908152f35b5034610242576020366003190112610242576020906001600160a01b038061082a610efe565b165f5260038352815f2054169051908152f35b5034610242576020366003190112610242576020906001600160a01b03610862610efe565b165f526009825260ff815f20541690519015158152f35b5034610242578060031936011261024257610892610efe565b9060243580151592838203610242576108a9611538565b6001600160a01b03169384156109055750916020916108fe7f2f4a3c35aa45534de90353ef4454152ac2a0bd1f78fab0aa8a6d2878a9c09c2594865f52600b8552825f209060ff801983541691151516179055565b51908152a2005b825163d92e233d60e01b8152fd5b50346102425760203660031901126102425781602092355f52825260ff815f20541690519015158152f35b50346102425760203660031901126102425761097c6020923561095f611923565b6042916040519161190160f01b8352600283015260228201522090565b9051908152f35b50346102425760603660031901126102425761099d610efe565b916109a6610f14565b604435936001600160401b038511610242576109ca6103c293602096369101610f68565b92909161141d565b50346102425760a0366003190112610242576109ec610efe565b916109f5610f14565b608435936001600160401b03851161024257610a196103c293602096369101610f68565b9290916064359160443591611239565b5034610242576020366003190112610242576020906001600160a01b03610a4e610efe565b165f5260068252805f20549051908152f35b5034610242576020366003190112610242578135916001600160401b03831161024257610a95610a9c91602094369101610f68565b369161102b565b8281519101209051908152f35b5034610242578060031936011261024257610ac2610f14565b90336001600160a01b03831603610ade57506103859135611651565b5163334bd91960e11b81529050fd5b5034610242578060031936011261024257602090610b09610efe565b610b11610f14565b9060018060a01b038091165f52600a8452825f2091165f52825260ff815f205416908115610b42575b519015158152f35b9050600b825260ff815f20541690610b3a565b50346102425780600319360112610242576103859135610b78600161036e610f14565b6115d3565b503461024257606036600319011261024257610b97610efe565b610b9f610f14565b916044358015159283820361024257610bb6611538565b6001600160a01b03908116948515610c245716948515610905575091602091610c1d7f1ed714392f4ef81e919173e3577e05a3f74e0f0f9d20737c2065d1e373a9cb2b94865f52600a8552825f20885f528552825f209060ff801983541691151516179055565b51908152a3005b835163d92e233d60e01b81528790fd5b50903461024257602036600319011261024257610c4f610efe565b6008546001600160a01b03919082163303610c84571690811561090557505f908152600960205220805460ff19166001179055005b83516330cd747160e01b81528390fd5b50903461024257602036600319011261024257610caf610efe565b90335f52600960205260ff835f2054161561033e575060207f48d1882bf77fef8559f7c28508a7993fa7d2aab60c5d02f7bf3c9811ca29062d9160018060a01b031692835f5260068252805f20610d068154611217565b9055835f5260068252805f20549051908152a2005b5034610242578060031936011261024257602090610d37610efe565b610d3f610f14565b9060018060a01b038091165f5260078452825f2091165f528252805f20549051908152f35b503461024257602036600319011261024257602091355f52600282526001815f2001549051908152f35b50346102425760a036600319011261024257610da8610f14565b916064356001600160401b03811161024257610dc79036908301610f68565b608435916001600160a01b0383168303610242576020956103c29435611139565b503461024257608036600319011261024257610e02610efe565b6001600160401b03929060443584811161024257610e239036908401610f68565b60649291923595861161024257610e426103c294602097369101610f68565b93909260243590611070565b5034610242575f36600319011261024257610e67611001565b9060018060a01b0360085416610e868251938385948552840190610f2a565b9060208301520390f35b509034610242576020366003190112610242573563ffffffff60e01b811680910361024257602091637965db0b60e01b8214918215610ed3575b50519015158152f35b6301ffc9a760e01b1491505f610eca565b34610242575f366003190112610242578061012c60209252f35b600435906001600160a01b038216820361024257565b602435906001600160a01b038216820361024257565b91908251928382525f5b848110610f54575050825f602080949584010152601f8019910116010190565b602081830181015184830182015201610f34565b9181601f84011215610242578235916001600160401b038311610242576020838186019501011161024257565b604081019081106001600160401b03821117610fb057604052565b634e487b7160e01b5f52604160045260245ffd5b61010081019081106001600160401b03821117610fb057604052565b90601f801991011681019081106001600160401b03821117610fb057604052565b6040519061100e82610f95565b600e82526d2224a922a1aa2fa0aaaa242fab1960911b6020830152565b9291926001600160401b038211610fb05760405191611054601f8201601f191660200184610fe0565b829481845281830111610242578281602093845f960137010152565b9193909294801561112f5761111961111f92611128976040516110e4607f8260208101946a23a0a6a2afa0a1aa24a7a760a91b86528060018060a01b039d8e9d8d6001600160601b03199060601b16602b860152603f850152605f840137810146605f82015203605f810184520182610fe0565b5190207f19457468657265756d205369676e6564204d6573736167653a0a3332000000005f52601c52603c5f2092369161102b565b90611866565b909591956118a0565b1691161490565b5050505050505f90565b90919392801561120e576001600160a01b03938416801561112f575f5260036020528360405f20541694851561112f576040519260208401946a11d0535157d49154d5531560aa1b86526001600160601b03199060601b16602b850152603f84015246605f840152605f835260808301908382106001600160401b03831117610fb0576112099461120094611119936040525190207f19457468657265756d205369676e6564204d6573736167653a0a3332000000005f52601c52603c5f2092369161102b565b909291926118a0565b161490565b50505050505f90565b5f1981146112255760010190565b634e487b7160e01b5f52601160045260245ffd5b92919493909385156113e95780156113b35761025883018084116112255742116113b357946113099560018060a01b0380951694855f526113006020926007845261111960409684885f209b169a8b5f5286526112f88a8c8a5f20549b8b51918a8301937fd79474f80e1aa06b85e28306d7563cff05fdeb2d2c8c78a60c7ef21b61d6fcf685528d84015260608301528a60808301528c60a083015260c08201524660e082015260e081526112ed81610fc4565b51902061095f611923565b92369161102b565b909991996118a0565b855f526003825280845f2054169081151598896113a7575b5050508661134a575b5f80516020611ccd8339815191529350825191825286151590820152a390565b600184018094116112255785857f4889b8a3edeea101f2f5a9d2a35f4e8d0533169e8e5a4b0d2921e32ec271eacc835f80516020611ccd83398151915297835f5260078252875f20855f52825280885f20558751908152a361132a565b161496505f8080611321565b5050604080519485525f60208601526001600160a01b039384169493909216925f80516020611ccd833981519152929150a35f90565b50505091505f80516020611ccd833981519152604060018060a01b03808251945f86526001602087015216941692a3600190565b9291906001600160a01b038085169082161461144c578261144057505050505f90565b611449936116e0565b90565b50505050600190565b61146091369161102b565b602081519101207fb4c875ecf7650b0027040ec2edbb038790a704b20889ea4d1cdbe7494754c7688114611532577f0d752899a62c45351badf84731c73a8734fa45bc659c97e24ffd03fcf90153838114611532577f2371e781f1523d52664bea3a97cff83e56f60bdc35f89a330641ceeb51687e7a8114611532577f353723ae92ddaf10395e1fb96fee932d3c6a7d33e4db5cd108b6f09f193db2e38114611532577f3b7bb960c68c1b09c338613b30d18f925543902abe7093a6b885238510a98f441461152d575f90565b600190565b50600190565b335f9081527fe5ebfa64fca8d502a8e50c1edffd2c31ef4dad5b396e65d9f397fb028f74abc560205260409020547fa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c217759060ff16156115935750565b6044906040519063e2517d3f60e01b82523360048301526024820152fd5b805f52600260205260405f20335f5260205260ff60405f205416156115935750565b90815f52600260205260405f209060018060a01b031690815f5260205260ff60405f205416155f1461164b57815f52600260205260405f20815f5260205260405f20600160ff1982541617905533917f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d5f80a4600190565b50505f90565b90815f52600260205260405f209060018060a01b031690815f5260205260ff60405f2054165f1461164b57815f52600260205260405f20815f5260205260405f2060ff19815416905533917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b5f80a4600190565b9080601f83011215610242578160206114499335910161102b565b9260a0811061185e5782019160c081840312610242576001600160a01b03928135848116939190849003610242576001600160401b039060208481013583811161024257850182601f82011215610242578281836117409335910161102b565b9260409283870135828111610242578161175b9189016116c5565b9660608101359160808201359360a08301359081116102425761177e92016116c5565b9582421161184f578916998a5f52600c8452845f2054820361184f57885f52600a845289855f2091165f52835260ff845f205416158061183d575b61182f576112099761120097868561182a985191012090858151910120918c8751968701977fc4032d35514277f015df68229cc9bb9ef505c7bf7754ee488b58932916d32a1289528701526060860152608085015260a084015260c083015260e082015260e081526112ed81610fc4565b611866565b505050505050505050505f90565b50600b835260ff845f205416156117b9565b50505050505050505050505f90565b505050505f90565b81519190604183036118965761188f9250602082015190606060408401519301515f1a90611c3f565b9192909190565b50505f9160029190565b600481101561190f57806118b2575050565b600181036118cc5760405163f645eedf60e01b8152600490fd5b600281036118ed5760405163fce698f760e01b815260048101839052602490fd5b6003146118f75750565b602490604051906335e2f38360e21b82526004820152fd5b634e487b7160e01b5f52602160045260245ffd5b307f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03161480611a24575b1561197e577f000000000000000000000000000000000000000000000000000000000000000090565b60405160208101907f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f82527f000000000000000000000000000000000000000000000000000000000000000060408201527f000000000000000000000000000000000000000000000000000000000000000060608201524660808201523060a082015260a0815260c081018181106001600160401b03821117610fb05760405251902090565b507f00000000000000000000000000000000000000000000000000000000000000004614611955565b60ff8114611a8b5760ff811690601f8211611a795760405191611a6f83610f95565b8252602082015290565b604051632cd44ac360e21b8152600490fd5b506040515f8054906001908260011c60018416928315611b64575b6020948583108514611b50578287528694908115611b305750600114611ad5575b505061144992500382610fe0565b5f8080527f290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e56395935091905b818310611b1857505061144993508201015f80611ac7565b85548784018501529485019486945091830191611b00565b91505061144994925060ff191682840152151560051b8201015f80611ac7565b634e487b7160e01b5f52602260045260245ffd5b90607f1690611aa6565b60ff8114611b905760ff811690601f8211611a795760405191611a6f83610f95565b506040515f60018054918260011c60018416928315611c35575b6020948583108514611b50578287528694908115611b305750600114611bd857505061144992500382610fe0565b9093915060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6935f915b818310611c1d57505061144993508201015f80611ac7565b85548784018501529485019486945091830191611c05565b90607f1690611baa565b91907f7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a08411611cc1579160209360809260ff5f9560405194855216868401526040830152606082015282805260015afa15611cb6575f516001600160a01b03811615611cac57905f905f90565b505f906001905f90565b6040513d5f823e3d90fd5b5050505f916003919056fe02874d0a1ddbe85103f4f54bc045af58b6f29c57816f49ed78fb4215eaa1bb97a26469706673582212200ff9a7a66625194b768e2ee468dec68b4d14683fc93a511bd790311af3f1f5af64736f6c634300081800332f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0dac33ff75c19e70fe83507db0d683fd3465c996598dc972688b7ace676c89077b
Deployed ByteCode
0x6080604081815260049182361015610015575f80fd5b5f3560e01c9081622f13e114610ee45750806301ffc9a714610e905780630718867914610d1b5780630b40d57014610e4e5780630fde18b414610de857806319ead6fa146107cd5780631d0924c114610d8e578063248a9ca314610d645780632a00900714610d1b5780632b16aae014610c945780632c388d5d14610c345780632ccbbcb114610b7d5780632f2ff15d14610b55578063313b804914610a29578063341310b514610aed57806336568abe14610aa957806336938e0114610a605780633faf459e14610a29578063422f0494146109d2578063482f4b0d146109835780634980f2881461093e5780634d80efae146109135780634fb37f3c146108795780634fed66e814610804578063536fff6c1461083d57806356814b70146102af5780635ff007b01461080457806368efccbb146107cd57806375b238fc1461079357806377c79fe6146107455780637a662702146105f157806384b0196e1461062857806387a9b3e2146105f15780638da5cb5b146105c957806391d14854146105855780639b4c8ca0146104fe578063a1308f27146104ca578063a217fddf146104b0578063b77435301461045c578063ba9affd1146103cb578063bd09c18714610387578063d547741f1461034b578063ddb8cbd6146102eb578063e712a35d146102af578063f2fde38b146102465763f978fd6114610218575f80fd5b346102425760203660031901126102425781602092355f52825260ff815f20541690519015158152f35b5f80fd5b50903461024257602036600319011261024257610261610efe565b60085491906001600160a01b0390818416330361029f57169283156102925750506001600160a01b03191617600855005b5163d92e233d60e01b8152fd5b84516330cd747160e01b81528390fd5b5034610242576020366003190112610242576020906001600160a01b036102d4610efe565b165f52600b825260ff815f20541690519015158152f35b50903461024257602036600319011261024257610306610efe565b90335f52600960205260ff835f2054161561033e57506001600160a01b03165f908152600c60205220805461033a90611217565b9055005b82516282b42960e81b8152fd5b50346102425780600319360112610242576103859135610380600161036e610f14565b93835f5260026020525f2001546115b1565b611651565b005b5034610242576020366003190112610242578135916001600160401b038311610242576103bc6103c291602094369101610f68565b90611455565b90519015158152f35b5090346102425781600319360112610242576103e5610efe565b6103ed610f14565b926103f6611538565b6001600160a01b0391821692831561044e5750825f5260036020525f20921691826001600160601b0360a01b8254161790557f4a297cf5d32586f80d2b0708a39d2da1f46e6ae7722171e1c51dfd685b5b8aa85f80a3005b905163d92e233d60e01b8152fd5b50903461024257602036600319011261024257610477610efe565b6008546001600160a01b039290831633036104a25750165f908152600960205220805460ff19169055005b83516330cd747160e01b8152fd5b5034610242575f36600319011261024257602090515f8152f35b5034610242575f366003190112610242576104fa906104e7611001565b9051918291602083526020830190610f2a565b0390f35b50903461024257602036600319011261024257610519610efe565b90335f52600960205260ff835f2054161561033e575060207fe4e830adecc234de45c0056f4c717d92928326fbb6c62a3f0f27ca2e2ffcb7fd9160018060a01b031692835f5260058252805f206105708154611217565b9055835f5260058252805f20549051908152a2005b50346102425780600319360112610242576020916105a1610f14565b90355f5260028352815f209060018060a01b03165f52825260ff815f20541690519015158152f35b5034610242575f3660031901126102425760085490516001600160a01b039091168152602090f35b5034610242576020366003190112610242576020906001600160a01b03610616610efe565b165f52600c8252805f20549051908152f35b509034610242575f366003190112610242576106637f547261696c626c617a6572446972656374417574685632000000000000000017611a4d565b9161068d7f3100000000000000000000000000000000000000000000000000000000000001611b6e565b81519160209160208401948486106001600160401b0387111761073257506106e782602092876106da99989795525f85528151988998600f60f81b8a5260e0868b015260e08a0190610f2a565b9188830390890152610f2a565b914660608701523060808701525f60a087015285830360c087015251918281520192915f5b82811061071b57505050500390f35b83518552869550938101939281019260010161070c565b604190634e487b7160e01b5f525260245ffd5b5034610242578060031936011261024257602090610761610efe565b610769610f14565b9060018060a01b038091165f52600a8452825f2091165f52825260ff815f20541690519015158152f35b5034610242575f36600319011261024257602090517fa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c217758152f35b5034610242576020366003190112610242576020906001600160a01b036107f2610efe565b165f5260058252805f20549051908152f35b5034610242576020366003190112610242576020906001600160a01b038061082a610efe565b165f5260038352815f2054169051908152f35b5034610242576020366003190112610242576020906001600160a01b03610862610efe565b165f526009825260ff815f20541690519015158152f35b5034610242578060031936011261024257610892610efe565b9060243580151592838203610242576108a9611538565b6001600160a01b03169384156109055750916020916108fe7f2f4a3c35aa45534de90353ef4454152ac2a0bd1f78fab0aa8a6d2878a9c09c2594865f52600b8552825f209060ff801983541691151516179055565b51908152a2005b825163d92e233d60e01b8152fd5b50346102425760203660031901126102425781602092355f52825260ff815f20541690519015158152f35b50346102425760203660031901126102425761097c6020923561095f611923565b6042916040519161190160f01b8352600283015260228201522090565b9051908152f35b50346102425760603660031901126102425761099d610efe565b916109a6610f14565b604435936001600160401b038511610242576109ca6103c293602096369101610f68565b92909161141d565b50346102425760a0366003190112610242576109ec610efe565b916109f5610f14565b608435936001600160401b03851161024257610a196103c293602096369101610f68565b9290916064359160443591611239565b5034610242576020366003190112610242576020906001600160a01b03610a4e610efe565b165f5260068252805f20549051908152f35b5034610242576020366003190112610242578135916001600160401b03831161024257610a95610a9c91602094369101610f68565b369161102b565b8281519101209051908152f35b5034610242578060031936011261024257610ac2610f14565b90336001600160a01b03831603610ade57506103859135611651565b5163334bd91960e11b81529050fd5b5034610242578060031936011261024257602090610b09610efe565b610b11610f14565b9060018060a01b038091165f52600a8452825f2091165f52825260ff815f205416908115610b42575b519015158152f35b9050600b825260ff815f20541690610b3a565b50346102425780600319360112610242576103859135610b78600161036e610f14565b6115d3565b503461024257606036600319011261024257610b97610efe565b610b9f610f14565b916044358015159283820361024257610bb6611538565b6001600160a01b03908116948515610c245716948515610905575091602091610c1d7f1ed714392f4ef81e919173e3577e05a3f74e0f0f9d20737c2065d1e373a9cb2b94865f52600a8552825f20885f528552825f209060ff801983541691151516179055565b51908152a3005b835163d92e233d60e01b81528790fd5b50903461024257602036600319011261024257610c4f610efe565b6008546001600160a01b03919082163303610c84571690811561090557505f908152600960205220805460ff19166001179055005b83516330cd747160e01b81528390fd5b50903461024257602036600319011261024257610caf610efe565b90335f52600960205260ff835f2054161561033e575060207f48d1882bf77fef8559f7c28508a7993fa7d2aab60c5d02f7bf3c9811ca29062d9160018060a01b031692835f5260068252805f20610d068154611217565b9055835f5260068252805f20549051908152a2005b5034610242578060031936011261024257602090610d37610efe565b610d3f610f14565b9060018060a01b038091165f5260078452825f2091165f528252805f20549051908152f35b503461024257602036600319011261024257602091355f52600282526001815f2001549051908152f35b50346102425760a036600319011261024257610da8610f14565b916064356001600160401b03811161024257610dc79036908301610f68565b608435916001600160a01b0383168303610242576020956103c29435611139565b503461024257608036600319011261024257610e02610efe565b6001600160401b03929060443584811161024257610e239036908401610f68565b60649291923595861161024257610e426103c294602097369101610f68565b93909260243590611070565b5034610242575f36600319011261024257610e67611001565b9060018060a01b0360085416610e868251938385948552840190610f2a565b9060208301520390f35b509034610242576020366003190112610242573563ffffffff60e01b811680910361024257602091637965db0b60e01b8214918215610ed3575b50519015158152f35b6301ffc9a760e01b1491505f610eca565b34610242575f366003190112610242578061012c60209252f35b600435906001600160a01b038216820361024257565b602435906001600160a01b038216820361024257565b91908251928382525f5b848110610f54575050825f602080949584010152601f8019910116010190565b602081830181015184830182015201610f34565b9181601f84011215610242578235916001600160401b038311610242576020838186019501011161024257565b604081019081106001600160401b03821117610fb057604052565b634e487b7160e01b5f52604160045260245ffd5b61010081019081106001600160401b03821117610fb057604052565b90601f801991011681019081106001600160401b03821117610fb057604052565b6040519061100e82610f95565b600e82526d2224a922a1aa2fa0aaaa242fab1960911b6020830152565b9291926001600160401b038211610fb05760405191611054601f8201601f191660200184610fe0565b829481845281830111610242578281602093845f960137010152565b9193909294801561112f5761111961111f92611128976040516110e4607f8260208101946a23a0a6a2afa0a1aa24a7a760a91b86528060018060a01b039d8e9d8d6001600160601b03199060601b16602b860152603f850152605f840137810146605f82015203605f810184520182610fe0565b5190207f19457468657265756d205369676e6564204d6573736167653a0a3332000000005f52601c52603c5f2092369161102b565b90611866565b909591956118a0565b1691161490565b5050505050505f90565b90919392801561120e576001600160a01b03938416801561112f575f5260036020528360405f20541694851561112f576040519260208401946a11d0535157d49154d5531560aa1b86526001600160601b03199060601b16602b850152603f84015246605f840152605f835260808301908382106001600160401b03831117610fb0576112099461120094611119936040525190207f19457468657265756d205369676e6564204d6573736167653a0a3332000000005f52601c52603c5f2092369161102b565b909291926118a0565b161490565b50505050505f90565b5f1981146112255760010190565b634e487b7160e01b5f52601160045260245ffd5b92919493909385156113e95780156113b35761025883018084116112255742116113b357946113099560018060a01b0380951694855f526113006020926007845261111960409684885f209b169a8b5f5286526112f88a8c8a5f20549b8b51918a8301937fd79474f80e1aa06b85e28306d7563cff05fdeb2d2c8c78a60c7ef21b61d6fcf685528d84015260608301528a60808301528c60a083015260c08201524660e082015260e081526112ed81610fc4565b51902061095f611923565b92369161102b565b909991996118a0565b855f526003825280845f2054169081151598896113a7575b5050508661134a575b5f80516020611ccd8339815191529350825191825286151590820152a390565b600184018094116112255785857f4889b8a3edeea101f2f5a9d2a35f4e8d0533169e8e5a4b0d2921e32ec271eacc835f80516020611ccd83398151915297835f5260078252875f20855f52825280885f20558751908152a361132a565b161496505f8080611321565b5050604080519485525f60208601526001600160a01b039384169493909216925f80516020611ccd833981519152929150a35f90565b50505091505f80516020611ccd833981519152604060018060a01b03808251945f86526001602087015216941692a3600190565b9291906001600160a01b038085169082161461144c578261144057505050505f90565b611449936116e0565b90565b50505050600190565b61146091369161102b565b602081519101207fb4c875ecf7650b0027040ec2edbb038790a704b20889ea4d1cdbe7494754c7688114611532577f0d752899a62c45351badf84731c73a8734fa45bc659c97e24ffd03fcf90153838114611532577f2371e781f1523d52664bea3a97cff83e56f60bdc35f89a330641ceeb51687e7a8114611532577f353723ae92ddaf10395e1fb96fee932d3c6a7d33e4db5cd108b6f09f193db2e38114611532577f3b7bb960c68c1b09c338613b30d18f925543902abe7093a6b885238510a98f441461152d575f90565b600190565b50600190565b335f9081527fe5ebfa64fca8d502a8e50c1edffd2c31ef4dad5b396e65d9f397fb028f74abc560205260409020547fa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c217759060ff16156115935750565b6044906040519063e2517d3f60e01b82523360048301526024820152fd5b805f52600260205260405f20335f5260205260ff60405f205416156115935750565b90815f52600260205260405f209060018060a01b031690815f5260205260ff60405f205416155f1461164b57815f52600260205260405f20815f5260205260405f20600160ff1982541617905533917f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d5f80a4600190565b50505f90565b90815f52600260205260405f209060018060a01b031690815f5260205260ff60405f2054165f1461164b57815f52600260205260405f20815f5260205260405f2060ff19815416905533917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b5f80a4600190565b9080601f83011215610242578160206114499335910161102b565b9260a0811061185e5782019160c081840312610242576001600160a01b03928135848116939190849003610242576001600160401b039060208481013583811161024257850182601f82011215610242578281836117409335910161102b565b9260409283870135828111610242578161175b9189016116c5565b9660608101359160808201359360a08301359081116102425761177e92016116c5565b9582421161184f578916998a5f52600c8452845f2054820361184f57885f52600a845289855f2091165f52835260ff845f205416158061183d575b61182f576112099761120097868561182a985191012090858151910120918c8751968701977fc4032d35514277f015df68229cc9bb9ef505c7bf7754ee488b58932916d32a1289528701526060860152608085015260a084015260c083015260e082015260e081526112ed81610fc4565b611866565b505050505050505050505f90565b50600b835260ff845f205416156117b9565b50505050505050505050505f90565b505050505f90565b81519190604183036118965761188f9250602082015190606060408401519301515f1a90611c3f565b9192909190565b50505f9160029190565b600481101561190f57806118b2575050565b600181036118cc5760405163f645eedf60e01b8152600490fd5b600281036118ed5760405163fce698f760e01b815260048101839052602490fd5b6003146118f75750565b602490604051906335e2f38360e21b82526004820152fd5b634e487b7160e01b5f52602160045260245ffd5b307f000000000000000000000000091d619782c5bce323adaa36cc52a31cff30647a6001600160a01b03161480611a24575b1561197e577f95e771167befe402c8decc335329659cdc1b1d21ea329559eb69cccab814a92e90565b60405160208101907f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f82527fabbfa3ce0df5a159376ecc8a5416de4fe12ff2037d940240a7af47cd67a8cc9560408201527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc660608201524660808201523060a082015260a0815260c081018181106001600160401b03821117610fb05760405251902090565b507f0000000000000000000000000000000000000000000000000000000000028c584614611955565b60ff8114611a8b5760ff811690601f8211611a795760405191611a6f83610f95565b8252602082015290565b604051632cd44ac360e21b8152600490fd5b506040515f8054906001908260011c60018416928315611b64575b6020948583108514611b50578287528694908115611b305750600114611ad5575b505061144992500382610fe0565b5f8080527f290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e56395935091905b818310611b1857505061144993508201015f80611ac7565b85548784018501529485019486945091830191611b00565b91505061144994925060ff191682840152151560051b8201015f80611ac7565b634e487b7160e01b5f52602260045260245ffd5b90607f1690611aa6565b60ff8114611b905760ff811690601f8211611a795760405191611a6f83610f95565b506040515f60018054918260011c60018416928315611c35575b6020948583108514611b50578287528694908115611b305750600114611bd857505061144992500382610fe0565b9093915060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6935f915b818310611c1d57505061144993508201015f80611ac7565b85548784018501529485019486945091830191611c05565b90607f1690611baa565b91907f7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a08411611cc1579160209360809260ff5f9560405194855216868401526040830152606082015282805260015afa15611cb6575f516001600160a01b03811615611cac57905f905f90565b505f906001905f90565b6040513d5f823e3d90fd5b5050505f916003919056fe02874d0a1ddbe85103f4f54bc045af58b6f29c57816f49ed78fb4215eaa1bb97a26469706673582212200ff9a7a66625194b768e2ee468dec68b4d14683fc93a511bd790311af3f1f5af64736f6c63430008180033