Sponsored
BC.GAME
No.1 Crypto Casino! WIN BIG with Leicester city! Play Now!
Support over 100 tokens! Free Lucky spin win up to 5 BTC & 760% deposit bonus!
Stake
200% Bonus, Instant Withdrawals, 100K Daily Giveaways, BEST VIP Club Claim Bonus!
20+ Cryptos, 3000+ Slots, Daily & Monthly Bonuses, Exclusive Sports Promos - Provably Fair!
Source Code
Overview
ETH Balance
0 ETHETH Value
$0.00View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Cross-Chain Transactions
Loading...
Loading
This contract may be a proxy contract. Click on More Options and select Is this a proxy? to confirm and enable the "Read as Proxy" & "Write as Proxy" tabs.
Contract Name:
EtherFiSafeFactory
Compiler Version
v0.8.28+commit.7893614a
Optimization Enabled:
Yes with 200 runs
Other Settings:
cancun EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { BeaconFactory, UpgradeableBeacon } from "../beacon-factory/BeaconFactory.sol";
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { EtherFiSafe } from "./EtherFiSafe.sol";
/**
* @title EtherFiSafeFactory
* @notice Factory contract for deploying EtherFiSafe instances using the beacon proxy pattern
* @dev Extends BeaconFactory to provide Beacon Proxy deployment functionality
* @author ether.fi
*/
contract EtherFiSafeFactory is BeaconFactory {
using EnumerableSetLib for EnumerableSetLib.AddressSet;
/// @custom:storage-location erc7201:etherfi.storage.EtherFiSafeFactory
struct EtherFiSafeFactoryStorage {
/// @notice Set containing addresses of all deployed EtherFiSafe instances
EnumerableSetLib.AddressSet deployedAddresses;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.EtherFiSafeFactory")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant EtherFiSafeFactoryStorageLocation = 0x7b68bad825be4cff21b93fb4c3affc217a6332ab2a96b5858e70f2a15d9f4300;
/// @notice The ADMIN role for the Safe factory
bytes32 public constant ETHERFI_SAFE_FACTORY_ADMIN_ROLE = keccak256("ETHERFI_SAFE_FACTORY_ADMIN_ROLE");
/// @notice Error thrown when a non-admin tries to deploy a EtherFiSafe contract
error OnlyAdmin();
/// @notice Error thrown when the start index is invalid
error InvalidStartIndex();
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/**
* @notice Initializes the EtherFiSafeFactory contract
* @dev Sets up the role registry, admin, and beacon implementation
* @param _roleRegistry Address of the role registry contract
* @param _etherFiSafeImpl Address of the EtherFiSafe implementation contract
*/
function initialize(address _roleRegistry, address _etherFiSafeImpl) external initializer {
__BeaconFactory_initialize(_roleRegistry, _etherFiSafeImpl);
}
/**
* @dev Returns the storage struct for EtherFiSafeFactory
* @return $ Reference to the EtherFiSafeFactoryStorage struct
*/
function _getEtherFiSafeFactoryStorage() internal pure returns (EtherFiSafeFactoryStorage storage $) {
assembly {
$.slot := EtherFiSafeFactoryStorageLocation
}
}
/**
* @notice Deploys a new EtherFiSafe instance
* @dev Only callable by addresses with ETHERFI_SAFE_FACTORY_ADMIN_ROLE
* @param salt The salt value used for deterministic deployment
* @param _owners Array of addresses that will be owners of the safe
* @param _modules Array of module addresses to be enabled on the safe
* @param _moduleSetupData Array of setup data corresponding to each module
* @param _threshold Number of required confirmations for safe transactions
* @custom:throws OnlyAdmin if caller doesn't have admin role
* @custom:throws ArrayLengthMismatch if modules and moduleSetupData arrays have different lengths
*/
function deployEtherFiSafe(bytes32 salt, address[] calldata _owners, address[] calldata _modules, bytes[] calldata _moduleSetupData, uint8 _threshold) external whenNotPaused {
if (!roleRegistry().hasRole(ETHERFI_SAFE_FACTORY_ADMIN_ROLE, msg.sender)) revert OnlyAdmin();
bytes memory initData = abi.encodeWithSelector(EtherFiSafe.initialize.selector, _owners, _modules, _moduleSetupData, _threshold);
address deterministicAddr = getDeterministicAddress(salt);
EtherFiSafeFactoryStorage storage $ = _getEtherFiSafeFactoryStorage();
$.deployedAddresses.add(deterministicAddr);
_deployBeacon(salt, initData);
}
/**
* @notice Gets deployed EtherFiSafe addresses
* @dev Returns an array of EtherFiSafe contracts deployed by this factory
* @param start Starting index in the deployedAddresses array
* @param n Number of EtherFiSafe contracts to get
* @return An array of deployed EtherFiSafe contract addresses
* @custom:throws InvalidStartIndex if start index is invalid
*/
function getDeployedAddresses(uint256 start, uint256 n) external view returns (address[] memory) {
EtherFiSafeFactoryStorage storage $ = _getEtherFiSafeFactoryStorage();
uint256 length = $.deployedAddresses.length();
if (start >= length) revert InvalidStartIndex();
if (start + n > length) n = length - start;
address[] memory addresses = new address[](n);
for (uint256 i = 0; i < n;) {
addresses[i] = $.deployedAddresses.at(start + i);
unchecked {
++i;
}
}
return addresses;
}
/**
* @notice Gets the number of contracts deployed
* @return Number of contracts deployed
*/
function numContractsDeployed() external view returns (uint256) {
return _getEtherFiSafeFactoryStorage().deployedAddresses.length();
}
/**
* @notice Checks if an address is a deployed EtherFiSafe contract
* @dev Returns whether the address is in the deployed addresses set
* @param safeAddr The address to check
* @return True if the address is a deployed EtherFiSafe contract, false otherwise
*/
function isEtherFiSafe(address safeAddr) external view returns (bool) {
EtherFiSafeFactoryStorage storage $ = _getEtherFiSafeFactoryStorage();
return $.deployedAddresses.contains(safeAddr);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { BeaconProxy } from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol";
import { UpgradeableBeacon } from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
import { CREATE3 } from "solady/utils/CREATE3.sol";
import { IRoleRegistry } from "../interfaces/IRoleRegistry.sol";
import { UpgradeableProxy } from "../utils/UpgradeableProxy.sol";
/**
* @title BeaconFactory
* @author ether.fi
* @notice Factory contract for deploying beacon proxies with deterministic addresses
* @dev This contract uses CREATE3 for deterministic deployments and implements UUPS upgradeability pattern
*/
contract BeaconFactory is UpgradeableProxy {
/// @custom:storage-location erc7201:etherfi.storage.BeaconFactory
struct BeaconFactoryStorage {
/// @notice The address of the beacon contract that stores the implementation
address beacon;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.BeaconFactory")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant BeaconFactoryStorageLocation = 0x644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae58200;
/// @notice Emitted when the implementation in the beacon address is updated
/// @param oldImpl The previous impl address
/// @param newImpl The new impl address
event BeaconImplemenationUpgraded(address oldImpl, address newImpl);
/// @notice Emitted when a new beacon proxy is deployed
/// @param salt The salt for deterministic deployment
/// @param deployed The address of the newly deployed proxy
event BeaconProxyDeployed(bytes32 salt, address indexed deployed);
/// @notice Thrown when the deployed address doesn't match the predicted address
error DeployedAddressDifferentFromExpected();
/// @notice Thrown when input is invalid
error InvalidInput();
/// @notice Thrown when initialize fails on the deployed contract
error InitializationFailed();
/**
* @dev Initializes the contract with required parameters
* @param _roleRegistry Address of the role registry contract
* @param _beaconImpl Address of the initial implementation contract
*/
function __BeaconFactory_initialize(address _roleRegistry, address _beaconImpl) internal onlyInitializing {
__UpgradeableProxy_init(_roleRegistry);
__Pausable_init();
BeaconFactoryStorage storage $ = _getBeaconFactoryStorage();
$.beacon = address(new UpgradeableBeacon(_beaconImpl, address(this)));
}
/**
* @dev Returns the storage struct from the specified storage slot
* @return $ Reference to the BeaconFactoryStorage struct
*/
function _getBeaconFactoryStorage() private pure returns (BeaconFactoryStorage storage $) {
assembly {
$.slot := BeaconFactoryStorageLocation
}
}
/**
* @dev Deploys a new beacon proxy with deterministic address
* @param salt The salt value used for deterministic deployment
* @param initData The initialization data for the proxy
* @return The address of the deployed proxy
* @custom:restriction Caller must have access control restrictions
*/
function _deployBeacon(bytes32 salt, bytes memory initData) internal returns (address) {
address expectedAddr = getDeterministicAddress(salt);
address deployedAddr = address(CREATE3.deployDeterministic(abi.encodePacked(type(BeaconProxy).creationCode, abi.encode(beacon(), "")), salt));
if (initData.length > 0) {
(bool success, ) = deployedAddr.call(initData);
if (!success) revert InitializationFailed();
}
if (expectedAddr != deployedAddr) revert DeployedAddressDifferentFromExpected();
emit BeaconProxyDeployed(salt, deployedAddr);
return deployedAddr;
}
/**
* @notice Returns the address of the beacon which stores the implementation
* @return beacon Address of the beacon contract
*/
function beacon() public view returns (address) {
BeaconFactoryStorage storage $ = _getBeaconFactoryStorage();
return $.beacon;
}
/**
* @notice Function to set the new implementation in the beacon contract
* @dev Only callable by owner of RoleRegistry
* @param _newImpl New implementation for the beacon contract
* @custom:throws OnlyRoleRegistryOwner when msg.sender is not the owner of the RoleRegistry contract
* @custom:throws InvalidInput when _beacon == address(0)
*/
function upgradeBeaconImplementation(address _newImpl) external onlyRoleRegistryOwner() {
if (_newImpl == address(0)) revert InvalidInput();
UpgradeableBeacon upgradeableBeacon = UpgradeableBeacon(_getBeaconFactoryStorage().beacon);
emit BeaconImplemenationUpgraded(upgradeableBeacon.implementation(), _newImpl);
upgradeableBeacon.upgradeTo(_newImpl);
}
/**
* @notice Predicts the deterministic address for a given salt
* @param salt The salt value used for address prediction
* @return The predicted deployment address
*/
function getDeterministicAddress(bytes32 salt) public view returns (address) {
return CREATE3.predictDeterministicAddress(salt);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
/// @notice Library for managing enumerable sets in storage.
/// @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/EnumerableSetLib.sol)
///
/// @dev Note:
/// In many applications, the number of elements in an enumerable set is small.
/// This enumerable set implementation avoids storing the length and indices
/// for up to 3 elements. Once the length exceeds 3 for the first time, the length
/// and indices will be initialized. The amortized cost of adding elements is O(1).
///
/// The AddressSet implementation packs the length with the 0th entry.
///
/// All enumerable sets except Uint8Set use a pop and swap mechanism to remove elements.
/// This means that the iteration order of elements can change between element removals.
library EnumerableSetLib {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CUSTOM ERRORS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev The index must be less than the length.
error IndexOutOfBounds();
/// @dev The value cannot be the zero sentinel.
error ValueIsZeroSentinel();
/// @dev Cannot accommodate a new unique value with the capacity.
error ExceedsCapacity();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CONSTANTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev A sentinel value to denote the zero value in storage.
/// No elements can be equal to this value.
/// `uint72(bytes9(keccak256(bytes("_ZERO_SENTINEL"))))`.
uint256 private constant _ZERO_SENTINEL = 0xfbb67fda52d4bfb8bf;
/// @dev The storage layout is given by:
/// ```
/// mstore(0x04, _ENUMERABLE_ADDRESS_SET_SLOT_SEED)
/// mstore(0x00, set.slot)
/// let rootSlot := keccak256(0x00, 0x24)
/// mstore(0x20, rootSlot)
/// mstore(0x00, shr(96, shl(96, value)))
/// let positionSlot := keccak256(0x00, 0x40)
/// let valueSlot := add(rootSlot, sload(positionSlot))
/// let valueInStorage := shr(96, sload(valueSlot))
/// let lazyLength := shr(160, shl(160, sload(rootSlot)))
/// ```
uint256 private constant _ENUMERABLE_ADDRESS_SET_SLOT_SEED = 0x978aab92;
/// @dev The storage layout is given by:
/// ```
/// mstore(0x04, _ENUMERABLE_WORD_SET_SLOT_SEED)
/// mstore(0x00, set.slot)
/// let rootSlot := keccak256(0x00, 0x24)
/// mstore(0x20, rootSlot)
/// mstore(0x00, value)
/// let positionSlot := keccak256(0x00, 0x40)
/// let valueSlot := add(rootSlot, sload(positionSlot))
/// let valueInStorage := sload(valueSlot)
/// let lazyLength := sload(not(rootSlot))
/// ```
uint256 private constant _ENUMERABLE_WORD_SET_SLOT_SEED = 0x18fb5864;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* STRUCTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev An enumerable address set in storage.
struct AddressSet {
uint256 _spacer;
}
/// @dev An enumerable bytes32 set in storage.
struct Bytes32Set {
uint256 _spacer;
}
/// @dev An enumerable uint256 set in storage.
struct Uint256Set {
uint256 _spacer;
}
/// @dev An enumerable int256 set in storage.
struct Int256Set {
uint256 _spacer;
}
/// @dev An enumerable uint8 set in storage. Useful for enums.
struct Uint8Set {
uint256 data;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* GETTERS / SETTERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Returns the number of elements in the set.
function length(AddressSet storage set) internal view returns (uint256 result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
let rootPacked := sload(rootSlot)
let n := shr(160, shl(160, rootPacked))
result := shr(1, n)
for {} iszero(or(iszero(shr(96, rootPacked)), n)) {} {
result := 1
if iszero(sload(add(rootSlot, result))) { break }
result := 2
if iszero(sload(add(rootSlot, result))) { break }
result := 3
break
}
}
}
/// @dev Returns the number of elements in the set.
function length(Bytes32Set storage set) internal view returns (uint256 result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
let n := sload(not(rootSlot))
result := shr(1, n)
for {} iszero(n) {} {
result := 0
if iszero(sload(add(rootSlot, result))) { break }
result := 1
if iszero(sload(add(rootSlot, result))) { break }
result := 2
if iszero(sload(add(rootSlot, result))) { break }
result := 3
break
}
}
}
/// @dev Returns the number of elements in the set.
function length(Uint256Set storage set) internal view returns (uint256 result) {
result = length(_toBytes32Set(set));
}
/// @dev Returns the number of elements in the set.
function length(Int256Set storage set) internal view returns (uint256 result) {
result = length(_toBytes32Set(set));
}
/// @dev Returns the number of elements in the set.
function length(Uint8Set storage set) internal view returns (uint256 result) {
/// @solidity memory-safe-assembly
assembly {
for { let packed := sload(set.slot) } packed { result := add(1, result) } {
packed := xor(packed, and(packed, add(1, not(packed))))
}
}
}
/// @dev Returns whether `value` is in the set.
function contains(AddressSet storage set, address value) internal view returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
value := shr(96, shl(96, value))
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
let rootPacked := sload(rootSlot)
for {} 1 {} {
if iszero(shr(160, shl(160, rootPacked))) {
result := 1
if eq(shr(96, rootPacked), value) { break }
if eq(shr(96, sload(add(rootSlot, 1))), value) { break }
if eq(shr(96, sload(add(rootSlot, 2))), value) { break }
result := 0
break
}
mstore(0x20, rootSlot)
mstore(0x00, value)
result := iszero(iszero(sload(keccak256(0x00, 0x40))))
break
}
}
}
/// @dev Returns whether `value` is in the set.
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
for {} 1 {} {
if iszero(sload(not(rootSlot))) {
result := 1
if eq(sload(rootSlot), value) { break }
if eq(sload(add(rootSlot, 1)), value) { break }
if eq(sload(add(rootSlot, 2)), value) { break }
result := 0
break
}
mstore(0x20, rootSlot)
mstore(0x00, value)
result := iszero(iszero(sload(keccak256(0x00, 0x40))))
break
}
}
}
/// @dev Returns whether `value` is in the set.
function contains(Uint256Set storage set, uint256 value) internal view returns (bool result) {
result = contains(_toBytes32Set(set), bytes32(value));
}
/// @dev Returns whether `value` is in the set.
function contains(Int256Set storage set, int256 value) internal view returns (bool result) {
result = contains(_toBytes32Set(set), bytes32(uint256(value)));
}
/// @dev Returns whether `value` is in the set.
function contains(Uint8Set storage set, uint8 value) internal view returns (bool result) {
/// @solidity memory-safe-assembly
assembly {
result := and(1, shr(and(0xff, value), sload(set.slot)))
}
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
function add(AddressSet storage set, address value) internal returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
value := shr(96, shl(96, value))
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
let rootPacked := sload(rootSlot)
for { let n := shr(160, shl(160, rootPacked)) } 1 {} {
mstore(0x20, rootSlot)
if iszero(n) {
let v0 := shr(96, rootPacked)
if iszero(v0) {
sstore(rootSlot, shl(96, value))
result := 1
break
}
if eq(v0, value) { break }
let v1 := shr(96, sload(add(rootSlot, 1)))
if iszero(v1) {
sstore(add(rootSlot, 1), shl(96, value))
result := 1
break
}
if eq(v1, value) { break }
let v2 := shr(96, sload(add(rootSlot, 2)))
if iszero(v2) {
sstore(add(rootSlot, 2), shl(96, value))
result := 1
break
}
if eq(v2, value) { break }
mstore(0x00, v0)
sstore(keccak256(0x00, 0x40), 1)
mstore(0x00, v1)
sstore(keccak256(0x00, 0x40), 2)
mstore(0x00, v2)
sstore(keccak256(0x00, 0x40), 3)
rootPacked := or(rootPacked, 7)
n := 7
}
mstore(0x00, value)
let p := keccak256(0x00, 0x40)
if iszero(sload(p)) {
n := shr(1, n)
result := 1
sstore(p, add(1, n))
if iszero(n) {
sstore(rootSlot, or(3, shl(96, value)))
break
}
sstore(add(rootSlot, n), shl(96, value))
sstore(rootSlot, add(2, rootPacked))
break
}
break
}
}
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
function add(Bytes32Set storage set, bytes32 value) internal returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
for { let n := sload(not(rootSlot)) } 1 {} {
mstore(0x20, rootSlot)
if iszero(n) {
let v0 := sload(rootSlot)
if iszero(v0) {
sstore(rootSlot, value)
result := 1
break
}
if eq(v0, value) { break }
let v1 := sload(add(rootSlot, 1))
if iszero(v1) {
sstore(add(rootSlot, 1), value)
result := 1
break
}
if eq(v1, value) { break }
let v2 := sload(add(rootSlot, 2))
if iszero(v2) {
sstore(add(rootSlot, 2), value)
result := 1
break
}
if eq(v2, value) { break }
mstore(0x00, v0)
sstore(keccak256(0x00, 0x40), 1)
mstore(0x00, v1)
sstore(keccak256(0x00, 0x40), 2)
mstore(0x00, v2)
sstore(keccak256(0x00, 0x40), 3)
n := 7
}
mstore(0x00, value)
let p := keccak256(0x00, 0x40)
if iszero(sload(p)) {
n := shr(1, n)
sstore(add(rootSlot, n), value)
sstore(p, add(1, n))
sstore(not(rootSlot), or(1, shl(1, add(1, n))))
result := 1
break
}
break
}
}
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
function add(Uint256Set storage set, uint256 value) internal returns (bool result) {
result = add(_toBytes32Set(set), bytes32(value));
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
function add(Int256Set storage set, int256 value) internal returns (bool result) {
result = add(_toBytes32Set(set), bytes32(uint256(value)));
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
function add(Uint8Set storage set, uint8 value) internal returns (bool result) {
/// @solidity memory-safe-assembly
assembly {
result := sload(set.slot)
let mask := shl(and(0xff, value), 1)
sstore(set.slot, or(result, mask))
result := iszero(and(result, mask))
}
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
/// Reverts if the set grows bigger than the custom on-the-fly capacity `cap`.
function add(AddressSet storage set, address value, uint256 cap)
internal
returns (bool result)
{
if (result = add(set, value)) if (length(set) > cap) revert ExceedsCapacity();
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
/// Reverts if the set grows bigger than the custom on-the-fly capacity `cap`.
function add(Bytes32Set storage set, bytes32 value, uint256 cap)
internal
returns (bool result)
{
if (result = add(set, value)) if (length(set) > cap) revert ExceedsCapacity();
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
/// Reverts if the set grows bigger than the custom on-the-fly capacity `cap`.
function add(Uint256Set storage set, uint256 value, uint256 cap)
internal
returns (bool result)
{
if (result = add(set, value)) if (length(set) > cap) revert ExceedsCapacity();
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
/// Reverts if the set grows bigger than the custom on-the-fly capacity `cap`.
function add(Int256Set storage set, int256 value, uint256 cap) internal returns (bool result) {
if (result = add(set, value)) if (length(set) > cap) revert ExceedsCapacity();
}
/// @dev Adds `value` to the set. Returns whether `value` was not in the set.
/// Reverts if the set grows bigger than the custom on-the-fly capacity `cap`.
function add(Uint8Set storage set, uint8 value, uint256 cap) internal returns (bool result) {
if (result = add(set, value)) if (length(set) > cap) revert ExceedsCapacity();
}
/// @dev Removes `value` from the set. Returns whether `value` was in the set.
function remove(AddressSet storage set, address value) internal returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
value := shr(96, shl(96, value))
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
let rootPacked := sload(rootSlot)
for { let n := shr(160, shl(160, rootPacked)) } 1 {} {
if iszero(n) {
result := 1
if eq(shr(96, rootPacked), value) {
sstore(rootSlot, sload(add(rootSlot, 1)))
sstore(add(rootSlot, 1), sload(add(rootSlot, 2)))
sstore(add(rootSlot, 2), 0)
break
}
if eq(shr(96, sload(add(rootSlot, 1))), value) {
sstore(add(rootSlot, 1), sload(add(rootSlot, 2)))
sstore(add(rootSlot, 2), 0)
break
}
if eq(shr(96, sload(add(rootSlot, 2))), value) {
sstore(add(rootSlot, 2), 0)
break
}
result := 0
break
}
mstore(0x20, rootSlot)
mstore(0x00, value)
let p := keccak256(0x00, 0x40)
let position := sload(p)
if iszero(position) { break }
n := sub(shr(1, n), 1)
if iszero(eq(sub(position, 1), n)) {
let lastValue := shr(96, sload(add(rootSlot, n)))
sstore(add(rootSlot, sub(position, 1)), shl(96, lastValue))
mstore(0x00, lastValue)
sstore(keccak256(0x00, 0x40), position)
}
sstore(rootSlot, or(shl(96, shr(96, sload(rootSlot))), or(shl(1, n), 1)))
sstore(p, 0)
result := 1
break
}
}
}
/// @dev Removes `value` from the set. Returns whether `value` was in the set.
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
if eq(value, _ZERO_SENTINEL) {
mstore(0x00, 0xf5a267f1) // `ValueIsZeroSentinel()`.
revert(0x1c, 0x04)
}
if iszero(value) { value := _ZERO_SENTINEL }
for { let n := sload(not(rootSlot)) } 1 {} {
if iszero(n) {
result := 1
if eq(sload(rootSlot), value) {
sstore(rootSlot, sload(add(rootSlot, 1)))
sstore(add(rootSlot, 1), sload(add(rootSlot, 2)))
sstore(add(rootSlot, 2), 0)
break
}
if eq(sload(add(rootSlot, 1)), value) {
sstore(add(rootSlot, 1), sload(add(rootSlot, 2)))
sstore(add(rootSlot, 2), 0)
break
}
if eq(sload(add(rootSlot, 2)), value) {
sstore(add(rootSlot, 2), 0)
break
}
result := 0
break
}
mstore(0x20, rootSlot)
mstore(0x00, value)
let p := keccak256(0x00, 0x40)
let position := sload(p)
if iszero(position) { break }
n := sub(shr(1, n), 1)
if iszero(eq(sub(position, 1), n)) {
let lastValue := sload(add(rootSlot, n))
sstore(add(rootSlot, sub(position, 1)), lastValue)
mstore(0x00, lastValue)
sstore(keccak256(0x00, 0x40), position)
}
sstore(not(rootSlot), or(shl(1, n), 1))
sstore(p, 0)
result := 1
break
}
}
}
/// @dev Removes `value` from the set. Returns whether `value` was in the set.
function remove(Uint256Set storage set, uint256 value) internal returns (bool result) {
result = remove(_toBytes32Set(set), bytes32(value));
}
/// @dev Removes `value` from the set. Returns whether `value` was in the set.
function remove(Int256Set storage set, int256 value) internal returns (bool result) {
result = remove(_toBytes32Set(set), bytes32(uint256(value)));
}
/// @dev Removes `value` from the set. Returns whether `value` was in the set.
function remove(Uint8Set storage set, uint8 value) internal returns (bool result) {
/// @solidity memory-safe-assembly
assembly {
result := sload(set.slot)
let mask := shl(and(0xff, value), 1)
sstore(set.slot, and(result, not(mask)))
result := iszero(iszero(and(result, mask)))
}
}
/// @dev Shorthand for `isAdd ? set.add(value, cap) : set.remove(value)`.
function update(AddressSet storage set, address value, bool isAdd, uint256 cap)
internal
returns (bool)
{
return isAdd ? add(set, value, cap) : remove(set, value);
}
/// @dev Shorthand for `isAdd ? set.add(value, cap) : set.remove(value)`.
function update(Bytes32Set storage set, bytes32 value, bool isAdd, uint256 cap)
internal
returns (bool)
{
return isAdd ? add(set, value, cap) : remove(set, value);
}
/// @dev Shorthand for `isAdd ? set.add(value, cap) : set.remove(value)`.
function update(Uint256Set storage set, uint256 value, bool isAdd, uint256 cap)
internal
returns (bool)
{
return isAdd ? add(set, value, cap) : remove(set, value);
}
/// @dev Shorthand for `isAdd ? set.add(value, cap) : set.remove(value)`.
function update(Int256Set storage set, int256 value, bool isAdd, uint256 cap)
internal
returns (bool)
{
return isAdd ? add(set, value, cap) : remove(set, value);
}
/// @dev Shorthand for `isAdd ? set.add(value, cap) : set.remove(value)`.
function update(Uint8Set storage set, uint8 value, bool isAdd, uint256 cap)
internal
returns (bool)
{
return isAdd ? add(set, value, cap) : remove(set, value);
}
/// @dev Returns all of the values in the set.
/// Note: This can consume more gas than the block gas limit for large sets.
function values(AddressSet storage set) internal view returns (address[] memory result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
let zs := _ZERO_SENTINEL
let rootPacked := sload(rootSlot)
let n := shr(160, shl(160, rootPacked))
result := mload(0x40)
let o := add(0x20, result)
let v := shr(96, rootPacked)
mstore(o, mul(v, iszero(eq(v, zs))))
for {} 1 {} {
if iszero(n) {
if v {
n := 1
v := shr(96, sload(add(rootSlot, n)))
if v {
n := 2
mstore(add(o, 0x20), mul(v, iszero(eq(v, zs))))
v := shr(96, sload(add(rootSlot, n)))
if v {
n := 3
mstore(add(o, 0x40), mul(v, iszero(eq(v, zs))))
}
}
}
break
}
n := shr(1, n)
for { let i := 1 } lt(i, n) { i := add(i, 1) } {
v := shr(96, sload(add(rootSlot, i)))
mstore(add(o, shl(5, i)), mul(v, iszero(eq(v, zs))))
}
break
}
mstore(result, n)
mstore(0x40, add(o, shl(5, n)))
}
}
/// @dev Returns all of the values in the set.
/// Note: This can consume more gas than the block gas limit for large sets.
function values(Bytes32Set storage set) internal view returns (bytes32[] memory result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
let zs := _ZERO_SENTINEL
let n := sload(not(rootSlot))
result := mload(0x40)
let o := add(0x20, result)
for {} 1 {} {
if iszero(n) {
let v := sload(rootSlot)
if v {
n := 1
mstore(o, mul(v, iszero(eq(v, zs))))
v := sload(add(rootSlot, n))
if v {
n := 2
mstore(add(o, 0x20), mul(v, iszero(eq(v, zs))))
v := sload(add(rootSlot, n))
if v {
n := 3
mstore(add(o, 0x40), mul(v, iszero(eq(v, zs))))
}
}
}
break
}
n := shr(1, n)
for { let i := 0 } lt(i, n) { i := add(i, 1) } {
let v := sload(add(rootSlot, i))
mstore(add(o, shl(5, i)), mul(v, iszero(eq(v, zs))))
}
break
}
mstore(result, n)
mstore(0x40, add(o, shl(5, n)))
}
}
/// @dev Returns all of the values in the set.
/// Note: This can consume more gas than the block gas limit for large sets.
function values(Uint256Set storage set) internal view returns (uint256[] memory result) {
result = _toUints(values(_toBytes32Set(set)));
}
/// @dev Returns all of the values in the set.
/// Note: This can consume more gas than the block gas limit for large sets.
function values(Int256Set storage set) internal view returns (int256[] memory result) {
result = _toInts(values(_toBytes32Set(set)));
}
/// @dev Returns all of the values in the set.
function values(Uint8Set storage set) internal view returns (uint8[] memory result) {
/// @solidity memory-safe-assembly
assembly {
result := mload(0x40)
let ptr := add(result, 0x20)
let o := 0
for { let packed := sload(set.slot) } packed {} {
if iszero(and(packed, 0xffff)) {
o := add(o, 16)
packed := shr(16, packed)
continue
}
mstore(ptr, o)
ptr := add(ptr, shl(5, and(packed, 1)))
o := add(o, 1)
packed := shr(1, packed)
}
mstore(result, shr(5, sub(ptr, add(result, 0x20))))
mstore(0x40, ptr)
}
}
/// @dev Returns the element at index `i` in the set. Reverts if `i` is out-of-bounds.
function at(AddressSet storage set, uint256 i) internal view returns (address result) {
bytes32 rootSlot = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
result := shr(96, sload(add(rootSlot, i)))
result := mul(result, iszero(eq(result, _ZERO_SENTINEL)))
}
if (i >= length(set)) revert IndexOutOfBounds();
}
/// @dev Returns the element at index `i` in the set. Reverts if `i` is out-of-bounds.
function at(Bytes32Set storage set, uint256 i) internal view returns (bytes32 result) {
result = _rootSlot(set);
/// @solidity memory-safe-assembly
assembly {
result := sload(add(result, i))
result := mul(result, iszero(eq(result, _ZERO_SENTINEL)))
}
if (i >= length(set)) revert IndexOutOfBounds();
}
/// @dev Returns the element at index `i` in the set. Reverts if `i` is out-of-bounds.
function at(Uint256Set storage set, uint256 i) internal view returns (uint256 result) {
result = uint256(at(_toBytes32Set(set), i));
}
/// @dev Returns the element at index `i` in the set. Reverts if `i` is out-of-bounds.
function at(Int256Set storage set, uint256 i) internal view returns (int256 result) {
result = int256(uint256(at(_toBytes32Set(set), i)));
}
/// @dev Returns the element at index `i` in the set. Reverts if `i` is out-of-bounds.
function at(Uint8Set storage set, uint256 i) internal view returns (uint8 result) {
/// @solidity memory-safe-assembly
assembly {
let packed := sload(set.slot)
for {} 1 {
mstore(0x00, 0x4e23d035) // `IndexOutOfBounds()`.
revert(0x1c, 0x04)
} {
if iszero(lt(i, 256)) { continue }
for { let j := 0 } iszero(eq(i, j)) {} {
packed := xor(packed, and(packed, add(1, not(packed))))
j := add(j, 1)
}
if iszero(packed) { continue }
break
}
// Find first set subroutine, optimized for smaller bytecode size.
let x := and(packed, add(1, not(packed)))
let r := shl(7, iszero(iszero(shr(128, x))))
r := or(r, shl(6, iszero(iszero(shr(64, shr(r, x))))))
r := or(r, shl(5, lt(0xffffffff, shr(r, x))))
// For the lower 5 bits of the result, use a De Bruijn lookup.
// forgefmt: disable-next-item
result := or(r, byte(and(div(0xd76453e0, shr(r, x)), 0x1f),
0x001f0d1e100c1d070f090b19131c1706010e11080a1a141802121b1503160405))
}
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* PRIVATE HELPERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Returns the root slot.
function _rootSlot(AddressSet storage s) private pure returns (bytes32 r) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x04, _ENUMERABLE_ADDRESS_SET_SLOT_SEED)
mstore(0x00, s.slot)
r := keccak256(0x00, 0x24)
}
}
/// @dev Returns the root slot.
function _rootSlot(Bytes32Set storage s) private pure returns (bytes32 r) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x04, _ENUMERABLE_WORD_SET_SLOT_SEED)
mstore(0x00, s.slot)
r := keccak256(0x00, 0x24)
}
}
/// @dev Casts to a Bytes32Set.
function _toBytes32Set(Uint256Set storage s) private pure returns (Bytes32Set storage c) {
/// @solidity memory-safe-assembly
assembly {
c.slot := s.slot
}
}
/// @dev Casts to a Bytes32Set.
function _toBytes32Set(Int256Set storage s) private pure returns (Bytes32Set storage c) {
/// @solidity memory-safe-assembly
assembly {
c.slot := s.slot
}
}
/// @dev Casts to a uint256 array.
function _toUints(bytes32[] memory a) private pure returns (uint256[] memory c) {
/// @solidity memory-safe-assembly
assembly {
c := a
}
}
/// @dev Casts to a int256 array.
function _toInts(bytes32[] memory a) private pure returns (int256[] memory c) {
/// @solidity memory-safe-assembly
assembly {
c := a
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { NoncesUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/NoncesUpgradeable.sol";
import { EIP712Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/cryptography/EIP712Upgradeable.sol";
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { IEtherFiDataProvider } from "../interfaces/IEtherFiDataProvider.sol";
import { IEtherFiHook } from "../interfaces/IEtherFiHook.sol";
import { IRoleRegistry } from "../interfaces/IRoleRegistry.sol";
import { ArrayDeDupLib } from "../libraries/ArrayDeDupLib.sol";
import { SignatureUtils } from "../libraries/SignatureUtils.sol";
import { EtherFiSafeErrors } from "./EtherFiSafeErrors.sol";
import { ModuleManager } from "./ModuleManager.sol";
import { MultiSig } from "./MultiSig.sol";
import { RecoveryManager } from "./RecoveryManager.sol";
import { EtherFiSafeBase } from "./EtherFiSafeBase.sol";
/**
* @title EtherFiSafe
* @notice Implementation of a multi-signature safe with module management capabilities
* @dev Combines ModuleManager and MultiSig functionality with EIP-712 signature verification
* @author ether.fi
*/
contract EtherFiSafe is EtherFiSafeBase, ModuleManager, RecoveryManager, MultiSig{
using SignatureUtils for bytes32;
using EnumerableSetLib for EnumerableSetLib.AddressSet;
using ArrayDeDupLib for address[];
/**
* @notice Contract constructor
* @dev Sets the immutable data provider reference
* @param _dataProvider Address of the EtherFiDataProvider contract
*/
constructor(address _dataProvider) payable EtherFiSafeBase(_dataProvider) {
_disableInitializers();
}
/**
* @notice Initializes the safe with owners, modules, and signature threshold
* @dev Sets up all components and can only be called once
* @param _owners Initial array of owner addresses
* @param _modules Initial array of module addresses
* @param _moduleSetupData Array of data for setting up individual modules for the safe
* @param _threshold Initial number of required signatures
* @custom:throws AlreadySetup If safe has already been initialized
* @custom:throws InvalidThreshold If threshold is 0 or greater than number of owners
* @custom:throws InvalidInput If owners array is empty
* @custom:throws InvalidOwnerAddress If any owner address is zero
*/
function initialize(address[] calldata _owners, address[] calldata _modules, bytes[] calldata _moduleSetupData, uint8 _threshold) external initializer {
__EIP712_init("EtherFiSafe", "1");
bool[] memory _shouldAdd = new bool[](_owners.length);
for (uint256 i = 0; i < _owners.length;) {
_shouldAdd[i] = true;
unchecked {
++i;
}
}
_setupMultiSig(_owners, _threshold);
_configureAdmin(_owners, _shouldAdd);
_setupRecovery();
if (_modules.length > 0) _setupModules(_modules, _moduleSetupData);
}
/**
* @notice Configures admin accounts with signature verification
* @dev Uses EIP-712 typed data signing for secure multi-signature authorization
* @param accounts Array of admin addresses to configure
* @param shouldAdd Array indicating whether to add or remove each admin
* @param signers Array of addresses that signed the transaction
* @param signatures Array of corresponding signatures
* @custom:throws InvalidSignatures If signature verification fails
*/
function configureAdmins(address[] calldata accounts, bool[] calldata shouldAdd, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(CONFIGURE_ADMIN_TYPEHASH, keccak256(abi.encodePacked(accounts)), keccak256(abi.encodePacked(shouldAdd)), _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
_configureAdmin(accounts, shouldAdd);
}
/**
* @notice Cancels the next nonce.
* @dev Uses EIP-712 typed data signing for secure multi-signature authorization
* @param signers Array of addresses that signed the transaction
* @param signatures Array of corresponding signatures
* @custom:throws InvalidSignatures If signature verification fails
*/
function cancelNonce(address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
uint256 cancelledNonce = _useNonce();
bytes32 structHash = keccak256(abi.encode(CANCEL_NONCE_TYPEHASH, cancelledNonce));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
emit NonceCancelled(cancelledNonce);
}
/**
* @notice Gets all admin addresses for this safe
* @dev Retrieves admin information from the role registry
* @return Array of admin addresses
*/
function getAdmins() external view returns (address[] memory) {
uint256 incomingOwnerStartTime = getIncomingOwnerStartTime();
if (incomingOwnerStartTime > 0 && block.timestamp > incomingOwnerStartTime) {
address[] memory admins = dataProvider.roleRegistry().getSafeAdmins(address(this));
uint256 len = admins.length;
address[] memory currentAdmins = new address[](len + 1);
uint256 counter = 0;
for (uint256 i = 0; i < len; ) {
if (!_isOwner(admins[i])) {
currentAdmins[counter] = admins[i];
unchecked {
++counter;
}
}
unchecked {
++i;
}
}
currentAdmins[counter] = getIncomingOwner();
unchecked {
++counter;
}
assembly ("memory-safe") {
mstore(currentAdmins, counter)
}
return currentAdmins;
}
return dataProvider.roleRegistry().getSafeAdmins(address(this));
}
/**
* @notice Returns if an account has safe admin privileges
* @param account Address of the account
* @return bool True if the account has the safe admin role, false otherwise
*/
function isAdmin(address account) external view returns (bool) {
uint256 incomingOwnerStartTime = getIncomingOwnerStartTime();
if (incomingOwnerStartTime > 0 && block.timestamp > incomingOwnerStartTime) {
if (account == getIncomingOwner()) return true;
if (_isOwner(account)) return false;
}
return dataProvider.roleRegistry().isSafeAdmin(address(this), account);
}
/**
* @notice Returns the EIP-712 domain separator
* @dev Used for signature verification
* @return bytes32 Current domain separator value
*/
function getDomainSeparator() external view returns (bytes32) {
return _domainSeparatorV4();
}
/**
* @notice Gets the current nonce value
* @dev Used for replay protection in signatures
* @return Current nonce value
*/
function nonce() public view returns (uint256) {
return _getEtherFiSafeStorage().nonce;
}
/**
* @notice Executes a transaction from an authorized module
* @dev Allows modules to execute arbitrary transactions on behalf of the safe
* @param to Array of target addresses for the calls
* @param values Array of ETH values to send with each call
* @param data Array of calldata for each call
* @custom:throws OnlyModules If the caller is not an enabled module
* @custom:throws CallFailed If any of the calls fail
*/
function execTransactionFromModule(address[] calldata to, uint256[] calldata values, bytes[] calldata data) external {
if (!isModuleEnabled(msg.sender)) revert OnlyModules();
IEtherFiHook hook = IEtherFiHook(dataProvider.getHookAddress());
if (address(hook) != address(0)) hook.preOpHook(msg.sender);
uint256 len = to.length;
for (uint256 i = 0; i < len;) {
(bool success,) = to[i].call{ value: values[i] }(data[i]);
if (!success) revert CallFailed(i);
unchecked {
++i;
}
}
if (address(hook) != address(0)) hook.postOpHook(msg.sender);
emit ExecTransactionFromModule(to, values, data);
}
/**
* @notice Returns all current owners of the safe
* @dev Implementation of the abstract function from ModuleManager
* @return address[] Array containing all owner addresses
*/
function getOwners() public view override returns (address[] memory) {
uint256 incomingOwnerStartTime = getIncomingOwnerStartTime();
if (incomingOwnerStartTime > 0 && block.timestamp > incomingOwnerStartTime) {
address[] memory owners = new address[](1);
owners[0] = getIncomingOwner();
return owners;
}
return _getMultiSigStorage().owners.values();
}
/**
* @notice Uses a nonce for operations in modules which require a quorum of owners
* @dev Can only be called by enabled modules
* @return uint256 The current nonce value before incrementing
* @custom:throws OnlyModules If the caller is not an enabled module
*/
function useNonce() external returns (uint256) {
if (!isModuleEnabled(msg.sender)) revert OnlyModules();
return _useNonce();
}
/**
* @dev Implementation of abstract function from ModuleManager
* @dev Checks if a module is whitelisted on the data provider
* @param module Address of the module to check
* @return bool True if the module is whitelisted on the data provider
*/
function _isWhitelistedOnDataProvider(address module) internal view override returns (bool) {
return dataProvider.isWhitelistedModule(module);
}
/**
* @dev Implementation of abstract function from ModuleManager
* @dev Checks if a module is the cash module
* @param module Address of the module to check
* @return bool True if the module is the Cash module
*/
function _isCashModule(address module) internal view override returns (bool) {
return dataProvider.getCashModule() == module;
}
receive() external payable {}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/beacon/BeaconProxy.sol)
pragma solidity ^0.8.22;
import {IBeacon} from "./IBeacon.sol";
import {Proxy} from "../Proxy.sol";
import {ERC1967Utils} from "../ERC1967/ERC1967Utils.sol";
/**
* @dev This contract implements a proxy that gets the implementation address for each call from an {UpgradeableBeacon}.
*
* The beacon address can only be set once during construction, and cannot be changed afterwards. It is stored in an
* immutable variable to avoid unnecessary storage reads, and also in the beacon storage slot specified by
* https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] so that it can be accessed externally.
*
* CAUTION: Since the beacon address can never be changed, you must ensure that you either control the beacon, or trust
* the beacon to not upgrade the implementation maliciously.
*
* IMPORTANT: Do not use the implementation logic to modify the beacon storage slot. Doing so would leave the proxy in
* an inconsistent state where the beacon storage slot does not match the beacon address.
*/
contract BeaconProxy is Proxy {
// An immutable address for the beacon to avoid unnecessary SLOADs before each delegate call.
address private immutable _beacon;
/**
* @dev Initializes the proxy with `beacon`.
*
* If `data` is nonempty, it's used as data in a delegate call to the implementation returned by the beacon. This
* will typically be an encoded function call, and allows initializing the storage of the proxy like a Solidity
* constructor.
*
* Requirements:
*
* - `beacon` must be a contract with the interface {IBeacon}.
* - If `data` is empty, `msg.value` must be zero.
*/
constructor(address beacon, bytes memory data) payable {
ERC1967Utils.upgradeBeaconToAndCall(beacon, data);
_beacon = beacon;
}
/**
* @dev Returns the current implementation address of the associated beacon.
*/
function _implementation() internal view virtual override returns (address) {
return IBeacon(_getBeacon()).implementation();
}
/**
* @dev Returns the beacon.
*/
function _getBeacon() internal view virtual returns (address) {
return _beacon;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/beacon/UpgradeableBeacon.sol)
pragma solidity ^0.8.20;
import {IBeacon} from "./IBeacon.sol";
import {Ownable} from "../../access/Ownable.sol";
/**
* @dev This contract is used in conjunction with one or more instances of {BeaconProxy} to determine their
* implementation contract, which is where they will delegate all function calls.
*
* An owner is able to change the implementation the beacon points to, thus upgrading the proxies that use this beacon.
*/
contract UpgradeableBeacon is IBeacon, Ownable {
address private _implementation;
/**
* @dev The `implementation` of the beacon is invalid.
*/
error BeaconInvalidImplementation(address implementation);
/**
* @dev Emitted when the implementation returned by the beacon is changed.
*/
event Upgraded(address indexed implementation);
/**
* @dev Sets the address of the initial implementation, and the initial owner who can upgrade the beacon.
*/
constructor(address implementation_, address initialOwner) Ownable(initialOwner) {
_setImplementation(implementation_);
}
/**
* @dev Returns the current implementation address.
*/
function implementation() public view virtual returns (address) {
return _implementation;
}
/**
* @dev Upgrades the beacon to a new implementation.
*
* Emits an {Upgraded} event.
*
* Requirements:
*
* - msg.sender must be the owner of the contract.
* - `newImplementation` must be a contract.
*/
function upgradeTo(address newImplementation) public virtual onlyOwner {
_setImplementation(newImplementation);
}
/**
* @dev Sets the implementation contract address for this beacon
*
* Requirements:
*
* - `newImplementation` must be a contract.
*/
function _setImplementation(address newImplementation) private {
if (newImplementation.code.length == 0) {
revert BeaconInvalidImplementation(newImplementation);
}
_implementation = newImplementation;
emit Upgraded(newImplementation);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
/// @notice Deterministic deployments agnostic to the initialization code.
/// @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/CREATE3.sol)
/// @author Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/CREATE3.sol)
/// @author Modified from 0xSequence (https://github.com/0xSequence/create3/blob/master/contracts/Create3.sol)
library CREATE3 {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CUSTOM ERRORS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Unable to deploy the contract.
error DeploymentFailed();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BYTECODE CONSTANTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* -------------------------------------------------------------------+
* Opcode | Mnemonic | Stack | Memory |
* -------------------------------------------------------------------|
* 36 | CALLDATASIZE | cds | |
* 3d | RETURNDATASIZE | 0 cds | |
* 3d | RETURNDATASIZE | 0 0 cds | |
* 37 | CALLDATACOPY | | [0..cds): calldata |
* 36 | CALLDATASIZE | cds | [0..cds): calldata |
* 3d | RETURNDATASIZE | 0 cds | [0..cds): calldata |
* 34 | CALLVALUE | value 0 cds | [0..cds): calldata |
* f0 | CREATE | newContract | [0..cds): calldata |
* -------------------------------------------------------------------|
* Opcode | Mnemonic | Stack | Memory |
* -------------------------------------------------------------------|
* 67 bytecode | PUSH8 bytecode | bytecode | |
* 3d | RETURNDATASIZE | 0 bytecode | |
* 52 | MSTORE | | [0..8): bytecode |
* 60 0x08 | PUSH1 0x08 | 0x08 | [0..8): bytecode |
* 60 0x18 | PUSH1 0x18 | 0x18 0x08 | [0..8): bytecode |
* f3 | RETURN | | [0..8): bytecode |
* -------------------------------------------------------------------+
*/
/// @dev The proxy initialization code.
uint256 private constant _PROXY_INITCODE = 0x67363d3d37363d34f03d5260086018f3;
/// @dev Hash of the `_PROXY_INITCODE`.
/// Equivalent to `keccak256(abi.encodePacked(hex"67363d3d37363d34f03d5260086018f3"))`.
bytes32 internal constant PROXY_INITCODE_HASH =
0x21c35dbe1b344a2488cf3321d6ce542f8e9f305544ff09e4993a62319a497c1f;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CREATE3 OPERATIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Deploys `initCode` deterministically with a `salt`.
/// Returns the deterministic address of the deployed contract,
/// which solely depends on `salt`.
function deployDeterministic(bytes memory initCode, bytes32 salt)
internal
returns (address deployed)
{
deployed = deployDeterministic(0, initCode, salt);
}
/// @dev Deploys `initCode` deterministically with a `salt`.
/// The deployed contract is funded with `value` (in wei) ETH.
/// Returns the deterministic address of the deployed contract,
/// which solely depends on `salt`.
function deployDeterministic(uint256 value, bytes memory initCode, bytes32 salt)
internal
returns (address deployed)
{
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, _PROXY_INITCODE) // Store the `_PROXY_INITCODE`.
let proxy := create2(0, 0x10, 0x10, salt)
if iszero(proxy) {
mstore(0x00, 0x30116425) // `DeploymentFailed()`.
revert(0x1c, 0x04)
}
mstore(0x14, proxy) // Store the proxy's address.
// 0xd6 = 0xc0 (short RLP prefix) + 0x16 (length of: 0x94 ++ proxy ++ 0x01).
// 0x94 = 0x80 + 0x14 (0x14 = the length of an address, 20 bytes, in hex).
mstore(0x00, 0xd694)
mstore8(0x34, 0x01) // Nonce of the proxy contract (1).
deployed := keccak256(0x1e, 0x17)
if iszero(
mul( // The arguments of `mul` are evaluated last to first.
extcodesize(deployed),
call(gas(), proxy, value, add(initCode, 0x20), mload(initCode), 0x00, 0x00)
)
) {
mstore(0x00, 0x30116425) // `DeploymentFailed()`.
revert(0x1c, 0x04)
}
}
}
/// @dev Returns the deterministic address for `salt`.
function predictDeterministicAddress(bytes32 salt) internal view returns (address deployed) {
deployed = predictDeterministicAddress(salt, address(this));
}
/// @dev Returns the deterministic address for `salt` with `deployer`.
function predictDeterministicAddress(bytes32 salt, address deployer)
internal
pure
returns (address deployed)
{
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40) // Cache the free memory pointer.
mstore(0x00, deployer) // Store `deployer`.
mstore8(0x0b, 0xff) // Store the prefix.
mstore(0x20, salt) // Store the salt.
mstore(0x40, PROXY_INITCODE_HASH) // Store the bytecode hash.
mstore(0x14, keccak256(0x0b, 0x55)) // Store the proxy's address.
mstore(0x40, m) // Restore the free memory pointer.
// 0xd6 = 0xc0 (short RLP prefix) + 0x16 (length of: 0x94 ++ proxy ++ 0x01).
// 0x94 = 0x80 + 0x14 (0x14 = the length of an address, 20 bytes, in hex).
mstore(0x00, 0xd694)
mstore8(0x34, 0x01) // Nonce of the proxy contract (1).
deployed := keccak256(0x1e, 0x17)
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title IRoleRegistry
* @notice Interface for role-based access control management
* @dev Provides functions for managing and querying role assignments
*/
interface IRoleRegistry {
/**
* @notice Verifies if an account has pauser privileges
* @param account The address to check for pauser role
* @custom:throws Reverts if account is not an authorized pauser
*/
function onlyPauser(address account) external view;
/**
* @notice Verifies if an account has unpauser privileges
* @param account The address to check for unpauser role
* @custom:throws Reverts if account is not an authorized unpauser
*/
function onlyUnpauser(address account) external view;
/**
* @notice Checks if an account has any of the specified roles
* @dev Reverts if the account doesn't have at least one of the roles
* @param account The address to check roles for
* @param encodedRoles ABI encoded roles using abi.encode(ROLE_1, ROLE_2, ...)
* @custom:throws Reverts if account has none of the specified roles
*/
function checkRoles(address account, bytes memory encodedRoles) external view;
/**
* @notice Checks if an account has a specific role
* @dev Direct query for a single role status
* @param role The role identifier to check
* @param account The address to check the role for
* @return True if the account has the role, false otherwise
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @notice Grants a role to an account
* @dev Only callable by the contract owner
* @param role The role identifier to grant
* @param account The address to grant the role to
* @custom:access Restricted to contract owner
*/
function grantRole(bytes32 role, address account) external;
/**
* @notice Revokes a role from an account
* @dev Only callable by the contract owner
* @param role The role identifier to revoke
* @param account The address to revoke the role from
* @custom:access Restricted to contract owner
*/
function revokeRole(bytes32 role, address account) external;
/**
* @notice Retrieves all addresses that have a specific role
* @dev Wrapper around EnumerableRoles roleHolders function
* @param role The role identifier to query
* @return Array of addresses that have the specified role
*/
function roleHolders(bytes32 role) external view returns (address[] memory);
/**
* @notice Verifies if an account has upgrader privileges
* @dev Used for upgrade authorization checks
* @param account The address to check for upgrader role
* @custom:throws Reverts if account is not an authorized upgrader
*/
function onlyUpgrader(address account) external view;
/**
* @notice Returns the owner of the contract
* @return result Owner of the contract
*/
function owner() external view returns (address result);
/**
* @notice Generates a unique role identifier for safe administrators
* @dev Creates a unique bytes32 identifier by hashing the safe address with a role type
* @param safe The address of the safe for which to generate the admin role
* @return bytes32 A unique role identifier for the specified safe's admins
* @custom:throws InvalidInput if safe is a zero address
*/
function getSafeAdminRole(address safe) external pure returns (bytes32);
/**
* @notice Configures admin roles for a specific safe
* @dev Grants/revokes admin privileges to specified addresses for a particular safe
* @param accounts Array of admin addresses to configure
* @param shouldAdd Array indicating whether to add or remove each admin
* @custom:throws OnlyEtherFiSafe if called by any address other than a registered EtherFiSafe
* @custom:throws InvalidInput if the admins array is empty or contains a zero address
* @custom:throws ArrayLengthMismatch if the array lengths mismatch
*/
function configureSafeAdmins(address[] calldata accounts, bool[] calldata shouldAdd) external;
/**
* @notice Verifies if an account has safe admin privileges
* @param safe The address of the safe
* @param account The address to check for safe admin role
* @custom:throws OnlySafeAdmin if the account does not have the SafeAdmin role
*/
function onlySafeAdmin(address safe, address account) external view;
/**
* @notice Returns if an account has safe admin privileges
* @param safe The address of the safe
* @param account The address to check for safe admin role
* @return bool suggesting if the account has the safe admin role
*/
function isSafeAdmin(address safe, address account) external view returns (bool);
/**
* @notice Retrieves all addresses that have the safe admin role for a particular safe
* @param safe The address of the safe
* @return Array of addresses that have the safe admin role
*/
function getSafeAdmins(address safe) external view returns (address[] memory);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import { PausableUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
import { ReentrancyGuardTransientUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardTransientUpgradeable.sol";
import { IRoleRegistry } from "../interfaces/IRoleRegistry.sol";
/**
* @title UpgradeableProxy
* @author ether.fi
* @notice An UpgradeableProxy contract which can be upgraded by RoleRegistry contract
*/
contract UpgradeableProxy is UUPSUpgradeable, PausableUpgradeable, ReentrancyGuardTransientUpgradeable {
/// @custom:storage-location erc7201:etherfi.storage.UpgradeableProxy
struct UpgradeableProxyStorage {
/// @notice Reference to the role registry contract for access control
IRoleRegistry roleRegistry;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.UpgradeableProxy")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant UpgradeableProxyStorageLocation = 0xa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f500;
/// @notice Error thrown when caller is unauthorized to perform an operation
error Unauthorized();
/// @notice Error thrown when caller is not the role registry owner
error OnlyRoleRegistryOwner();
/**
* @notice Returns the address of the Role Registry contract
* @return roleRegistry Reference to the role registry contract
*/
function roleRegistry() public view returns (IRoleRegistry) {
UpgradeableProxyStorage storage $ = _getUpgradeableProxyStorage();
return $.roleRegistry;
}
/**
* @dev Initializes the contract with Role Registry
* @param _roleRegistry Address of the role registry contract
*/
function __UpgradeableProxy_init(address _roleRegistry) internal onlyInitializing {
UpgradeableProxyStorage storage $ = _getUpgradeableProxyStorage();
$.roleRegistry = IRoleRegistry(_roleRegistry);
__ReentrancyGuardTransient_init();
__Pausable_init_unchained();
}
/**
* @dev Returns the storage struct from the specified storage slot
* @return $ Reference to the UpgradeableProxyStorage struct
*/
function _getUpgradeableProxyStorage() internal pure returns (UpgradeableProxyStorage storage $) {
assembly {
$.slot := UpgradeableProxyStorageLocation
}
}
/**
* @dev Updates the role registry contract address
* @param _roleRegistry The address of the new role registry contract
* @custom:security This is a critical function that updates access control
*/
function _setRoleRegistry(address _roleRegistry) internal {
UpgradeableProxyStorage storage $ = _getUpgradeableProxyStorage();
$.roleRegistry = IRoleRegistry(_roleRegistry);
}
/**
* @dev Ensures only authorized upgraders can upgrade the contract
* @param newImplementation Address of the new implementation contract
*/
function _authorizeUpgrade(address newImplementation) internal view override {
UpgradeableProxyStorage storage $ = _getUpgradeableProxyStorage();
$.roleRegistry.onlyUpgrader(msg.sender);
// Silence compiler warning on unused variables.
newImplementation = newImplementation;
}
/**
* @notice Pauses the contract
* @dev Only callable by accounts with the pauser role
*/
function pause() external {
roleRegistry().onlyPauser(msg.sender);
_pause();
}
/**
* @notice Unpauses the contract
* @dev Only callable by accounts with the unpauser role
*/
function unpause() external {
roleRegistry().onlyUnpauser(msg.sender);
_unpause();
}
/**
* @dev Modifier to restrict access to specific roles
* @param role Role identifier
*/
modifier onlyRole(bytes32 role) {
if (!roleRegistry().hasRole(role, msg.sender)) revert Unauthorized();
_;
}
/**
* @dev Modifier to restrict access to owner of the role registry
*/
modifier onlyRoleRegistryOwner() {
if (roleRegistry().owner() != msg.sender) revert OnlyRoleRegistryOwner();
_;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Nonces.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides tracking nonces for addresses. Nonces will only increment.
*/
abstract contract NoncesUpgradeable is Initializable {
/**
* @dev The nonce used for an `account` is not the expected current nonce.
*/
error InvalidAccountNonce(address account, uint256 currentNonce);
/// @custom:storage-location erc7201:openzeppelin.storage.Nonces
struct NoncesStorage {
mapping(address account => uint256) _nonces;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Nonces")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant NoncesStorageLocation = 0x5ab42ced628888259c08ac98db1eb0cf702fc1501344311d8b100cd1bfe4bb00;
function _getNoncesStorage() private pure returns (NoncesStorage storage $) {
assembly {
$.slot := NoncesStorageLocation
}
}
function __Nonces_init() internal onlyInitializing {
}
function __Nonces_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the next unused nonce for an address.
*/
function nonces(address owner) public view virtual returns (uint256) {
NoncesStorage storage $ = _getNoncesStorage();
return $._nonces[owner];
}
/**
* @dev Consumes a nonce.
*
* Returns the current value and increments nonce.
*/
function _useNonce(address owner) internal virtual returns (uint256) {
NoncesStorage storage $ = _getNoncesStorage();
// For each account, the nonce has an initial value of 0, can only be incremented by one, and cannot be
// decremented or reset. This guarantees that the nonce never overflows.
unchecked {
// It is important to do x++ and not ++x here.
return $._nonces[owner]++;
}
}
/**
* @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`.
*/
function _useCheckedNonce(address owner, uint256 nonce) internal virtual {
uint256 current = _useNonce(owner);
if (nonce != current) {
revert InvalidAccountNonce(owner, current);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import {IERC5267} from "@openzeppelin/contracts/interfaces/IERC5267.sol";
import {Initializable} from "../../proxy/utils/Initializable.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.
*/
abstract contract EIP712Upgradeable is Initializable, IERC5267 {
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
/// @custom:storage-location erc7201:openzeppelin.storage.EIP712
struct EIP712Storage {
/// @custom:oz-renamed-from _HASHED_NAME
bytes32 _hashedName;
/// @custom:oz-renamed-from _HASHED_VERSION
bytes32 _hashedVersion;
string _name;
string _version;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.EIP712")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant EIP712StorageLocation = 0xa16a46d94261c7517cc8ff89f61c0ce93598e3c849801011dee649a6a557d100;
function _getEIP712Storage() private pure returns (EIP712Storage storage $) {
assembly {
$.slot := EIP712StorageLocation
}
}
/**
* @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].
*/
function __EIP712_init(string memory name, string memory version) internal onlyInitializing {
__EIP712_init_unchained(name, version);
}
function __EIP712_init_unchained(string memory name, string memory version) internal onlyInitializing {
EIP712Storage storage $ = _getEIP712Storage();
$._name = name;
$._version = version;
// Reset prior values in storage if upgrading
$._hashedName = 0;
$._hashedVersion = 0;
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
return _buildDomainSeparator();
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash(), 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);
}
/**
* @dev See {IERC-5267}.
*/
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
EIP712Storage storage $ = _getEIP712Storage();
// If the hashed name and version in storage are non-zero, the contract hasn't been properly initialized
// and the EIP712 domain is not reliable, as it will be missing name and version.
require($._hashedName == 0 && $._hashedVersion == 0, "EIP712: Uninitialized");
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
* are a concern.
*/
function _EIP712Name() internal view virtual returns (string memory) {
EIP712Storage storage $ = _getEIP712Storage();
return $._name;
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
* are a concern.
*/
function _EIP712Version() internal view virtual returns (string memory) {
EIP712Storage storage $ = _getEIP712Storage();
return $._version;
}
/**
* @dev The hash of the name parameter for the EIP712 domain.
*
* NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Name` instead.
*/
function _EIP712NameHash() internal view returns (bytes32) {
EIP712Storage storage $ = _getEIP712Storage();
string memory name = _EIP712Name();
if (bytes(name).length > 0) {
return keccak256(bytes(name));
} else {
// If the name is empty, the contract may have been upgraded without initializing the new storage.
// We return the name hash in storage if non-zero, otherwise we assume the name is empty by design.
bytes32 hashedName = $._hashedName;
if (hashedName != 0) {
return hashedName;
} else {
return keccak256("");
}
}
}
/**
* @dev The hash of the version parameter for the EIP712 domain.
*
* NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Version` instead.
*/
function _EIP712VersionHash() internal view returns (bytes32) {
EIP712Storage storage $ = _getEIP712Storage();
string memory version = _EIP712Version();
if (bytes(version).length > 0) {
return keccak256(bytes(version));
} else {
// If the version is empty, the contract may have been upgraded without initializing the new storage.
// We return the version hash in storage if non-zero, otherwise we assume the version is empty by design.
bytes32 hashedVersion = $._hashedVersion;
if (hashedVersion != 0) {
return hashedVersion;
} else {
return keccak256("");
}
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { IRoleRegistry } from "./IRoleRegistry.sol";
/**
* @title IEtherFiDataProvider
* @author ether.fi
* @notice Interface for the EtherFiDataProvider contract that manages important data for ether.fi
*/
interface IEtherFiDataProvider {
/**
* @notice Configures multiple modules' whitelist status
* @dev Only callable by addresses with ADMIN_ROLE
* @param modules Array of module addresses to configure
* @param shouldWhitelist Array of boolean values indicating whether each module should be whitelisted
*/
function configureModules(address[] calldata modules, bool[] calldata shouldWhitelist) external;
/**
* @notice Updates the hook address
* @dev Only callable by addresses with ADMIN_ROLE
* @param hook New hook address to set
*/
function setHookAddress(address hook) external;
/**
* @notice Updates the address of the Cash Module
* @dev Only callable by addresses with ADMIN_ROLE
* @param cashModule New cash module address to set
*/
function setCashModule(address cashModule) external;
/**
* @notice Checks if a module address is whitelisted
* @param module Address to check
* @return bool True if the module is whitelisted, false otherwise
*/
function isWhitelistedModule(address module) external view returns (bool);
/**
* @notice Retrieves all whitelisted module addresses
* @return address[] Array of whitelisted module addresses
*/
function getWhitelistedModules() external view returns (address[] memory);
/**
* @notice Returns the address of the Cash Module
* @return Address of the cash module
*/
function getCashModule() external view returns (address);
/**
* @notice Returns the address of the EtherFi Recovery signer
* @return Address of the EtherFi Recovery Signer
*/
function getEtherFiRecoverySigner() external view returns (address);
/**
* @notice Returns the address of the Third Party Recovery signer
* @return Address of the Third Party Recovery Signer
*/
function getThirdPartyRecoverySigner() external view returns (address);
/**
* @notice Returns the Recovery delay period in seconds
* @return Recovery delay period in seconds
*/
function getRecoveryDelayPeriod() external view returns (uint256);
/**
* @notice Returns the address of the Cash Lens contract
* @return Address of the Cash Lens contract
*/
function getCashLens() external view returns (address);
/**
* @notice Returns the address of the Price provider contract
* @return Address of the Price provider contract
*/
function getPriceProvider() external view returns (address);
/**
* @notice Returns the current hook address
* @return address Current hook address
*/
function getHookAddress() external view returns (address);
function getEtherFiSafeFactory() external view returns (address);
/**
* @notice Function to check if an account is an EtherFiSafe
* @param account Address of the account to check
*/
function isEtherFiSafe(address account) external view returns (bool);
/**
* @notice Role identifier for administrative privileges
* @return bytes32 The keccak256 hash of "ADMIN_ROLE"
*/
function ADMIN_ROLE() external view returns (bytes32);
/**
* @notice Returns the address of the Role Registry contract
* @return roleRegistry Reference to the role registry contract
*/
function roleRegistry() external view returns (IRoleRegistry);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title IEtherFiHook
* @author ether.fi
* @notice Interface for the EtherFiHook contract that implements operation hooks
*/
interface IEtherFiHook {
/**
* @notice Hook called before module operations
* @dev Currently implemented as a view function with no effects
* @param module Address of the module being operated on
*/
function preOpHook(address module) external view;
/**
* @notice Hook called after module operations
* @dev Currently implemented as a view function with no effects
* @param module Address of the module being operated on
*/
function postOpHook(address module) external view;
/**
* @notice Returns the address of the EtherFiDataProvider contract
* @return Address of the EtherFiDataProvider contract
*/
function getEtherFiDataProvider() external view returns (address);
/**
* @notice Role identifier for administrative privileges
* @return bytes32 The keccak256 hash of "ADMIN_ROLE"
*/
function ADMIN_ROLE() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title ArrayDeDupLib
* @author ether.fi
* @notice Library for checking and handling duplicate elements in arrays
* @dev Provides utility functions to verify array uniqueness
*/
library ArrayDeDupLib {
/**
* @notice Thrown when a duplicate element is found in an array that requires unique elements
*/
error DuplicateElementFound();
/**
* @notice Checks if an array of addresses contains duplicate elements
* @dev Uses an O(n²) algorithm that's efficient for small arrays
* @param addresses Array of addresses to check for duplicates
* @custom:throws DuplicateElementFound If a duplicate address is found in the array
*/
function checkDuplicates(address[] memory addresses) internal pure {
uint256 length = addresses.length;
if (length <= 1) return;
address[] memory seen = new address[](length);
for (uint256 i = 0; i < length;) {
address current = addresses[i];
for (uint256 j = 0; j < i;) {
if (current == seen[j]) revert DuplicateElementFound();
unchecked {
++j;
}
}
seen[i] = current;
unchecked {
++i;
}
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { IERC1271 } from "@openzeppelin/contracts/interfaces/IERC1271.sol";
import { ECDSA } from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
/**
* @title Library of utilities for making EIP1271-compliant signature checks
* @author ether.fi
* @notice Provides functions to verify signatures from both EOAs and smart contracts implementing EIP-1271
* @dev Implements signature verification following EIP-1271 standard for smart contracts
* and standard ECDSA verification for EOAs
*/
library SignatureUtils {
// bytes4(keccak256("isValidSignature(bytes32,bytes)")
bytes4 internal constant EIP1271_MAGICVALUE = 0x1626ba7e;
/// @notice Thrown when an EOA signature is invalid
error InvalidSigner();
/// @notice Thrown when an ERC1271 contract signature verification fails
error InvalidERC1271Signer();
/**
* @notice Verifies if a signature is valid according to EIP-1271 standards
* @dev For EOAs, uses ECDSA recovery. For contracts, calls EIP-1271 isValidSignature
* @param digestHash The hash of the data that was signed
* @param signer The address that should have signed the data
* @param signature The signature bytes
* @custom:security Consider that contract signatures might have different gas costs
* @custom:warning The isContract check may return false positives during contract construction
* @custom:throws InvalidSigner If the EOA signature is invalid
* @custom:throws InvalidERC1271Signer If the contract signature verification fails
*/
function checkSignature(bytes32 digestHash, address signer, bytes memory signature) internal view {
if (isContract(signer)) {
if (IERC1271(signer).isValidSignature(digestHash, signature) != EIP1271_MAGICVALUE) revert InvalidERC1271Signer();
} else {
if (ECDSA.recover(digestHash, signature) != signer) revert InvalidSigner();
}
}
/**
* @notice Returns whether a signature is valid according to EIP-1271 standards
* @dev Similar to checkSignature_EIP1271 but returns boolean instead of reverting
* @param digestHash The hash of the data that was signed
* @param signer The address that should have signed the data
* @param signature The signature bytes
* @return bool True if the signature is valid, false otherwise
* @custom:warning The isContract check may return false positives during contract construction
*/
function isValidSignature(bytes32 digestHash, address signer, bytes memory signature) internal view returns (bool) {
if (isContract(signer)) {
return IERC1271(signer).isValidSignature(digestHash, signature) == EIP1271_MAGICVALUE;
} else {
return ECDSA.recover(digestHash, signature) == signer;
}
}
/**
* @notice Determines if an address is a contract
* @dev Uses assembly to check if the address has code
* @param account The address to check
* @return bool True if the address has code (is a contract), false otherwise
* @custom:warning This function returns false for contracts during their construction
*/
function isContract(address account) internal view returns (bool) {
uint256 size;
assembly ("memory-safe") {
size := extcodesize(account)
}
return size > 0;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
abstract contract EtherFiSafeErrors {
/// @notice Thrown when an empty modules array is provided
error InvalidInput();
/// @notice Thrown when modules and shouldWhitelist arrays have different lengths
error ArrayLengthMismatch();
/// @notice Thrown when a module address is zero
/// @param index Index of the invalid module in the array
error InvalidModule(uint256 index);
/// @notice Thrown when a signer at the given index is invalid
error InvalidSigner(uint256 index);
/// @notice Thrown when the signature verification fails
error InvalidSignatures();
/// @notice Thrown when there are not enough signers to meet the threshold
error InsufficientSigners();
/// @notice Thrown when no signers are provided
error EmptySigners();
/// @notice Thrown when adding address(0) as owner
error InvalidOwnerAddress(uint256 index);
/// @notice Thrown when removing all owners
error AllOwnersRemoved();
/// @notice Thrown when owners are less than threshold
error OwnersLessThanThreshold();
/// @notice Throws when threshold is either 0 or greater than length of owners
error InvalidThreshold();
/// @notice Throws when the multisig is already setup
error MultiSigAlreadySetup();
/// @notice Throws when trying to remove Cash Module
/// @param index Index of the cash module in the array
error CannotRemoveCashModule(uint256 index);
/// @notice Throws when trying to add an unsupported module to whitelist
/// @param index Index of the unsupported module in the array
error UnsupportedModule(uint256 index);
/// @notice Throws when trying to reinit modules
error ModulesAlreadySetup();
/// @notice Throws when the caller is not a module
error OnlyModules();
/// @notice Throws when a .call fails
error CallFailed(uint256 index);
/// @notice Throws when module setup fails while adding modules to safe
error ModuleSetupFailed(uint256 index);
/// @notice Throws when invalid overriding recovery signer addresses are passed
error InvalidOverridingRecoverySigners();
/// @notice Throws when Recovery Manager is already initialized
error RecoveryManagerAlreadyInitialized();
/// @notice Throws when trying to recover when the signer is index 0 and user recovery signer is address(0)
error InvalidUserRecoverySigner();
/// @notice Throws when recovery signature is invalid
error InvalidRecoverySignature();
/// @notice Throws when trying to recover but recovery is disabled
error RecoveryDisabled();
/// @notice Throws when recovery signers length is less than recovery threshold
error RecoverySignersLengthLessThanThreshold();
/// @notice Throws when recovery signatures are less than recovery threshold
error InsufficientRecoverySignatures();
/// @notice Throws when valid recovery signatures is less than recovery threshold
error InvalidRecoverySignatures();
/// @notice Thrown when a recovery signer at the given index is invalid
error InvalidRecoverySigner(uint256 index);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { IModule } from "../interfaces/IModule.sol";
import { ArrayDeDupLib } from "../libraries/ArrayDeDupLib.sol";
import { EtherFiSafeBase } from "./EtherFiSafeBase.sol";
/**
* @title ModuleManager
* @notice Manages the addition and removal of modules for the EtherFi Safe
* @author ether.fi
* @dev Abstract contract that handles module management functionality
*/
abstract contract ModuleManager is EtherFiSafeBase {
using EnumerableSetLib for EnumerableSetLib.AddressSet;
using ArrayDeDupLib for address[];
/// @custom:storage-location erc7201:etherfi.storage.ModuleManager
struct ModuleManagerStorage {
/// @notice Set containing addresses of all the attached modules
EnumerableSetLib.AddressSet modules;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.ModuleManager")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ModuleManagerStorageLocation = 0x6f297332685baf3d7ed2366c1e1996176ab52e89e9bd6ee3d882f5057ea1bd00;
/// @notice Emitted when modules are configured
/// @param modules Array of module addresses that were configured
/// @param shouldWhitelist Array indicating whether each module was added or removed
event ModulesConfigured(address[] modules, bool[] shouldWhitelist);
/// @notice Emitted when modules are setup initially
/// @param modules Array of module addresses that were setup
event ModulesSetup(address[] modules);
/**
* @dev Returns the storage struct for ModuleManager
* @return $ Reference to the ModuleManagerStorage struct
* @custom:storage-location Uses ERC-7201 namespace storage pattern
*/
function _getModuleManagerStorage() internal pure returns (ModuleManagerStorage storage $) {
assembly {
$.slot := ModuleManagerStorageLocation
}
}
/**
* @notice Sets up multiple modules initially
* @param _modules Array of module addresses to configure
* @param _moduleSetupData Array of data for setting up individual modules for the safe
* @custom:throws ModulesAlreadySetup If the module manager is already setup
* @custom:throws ArrayLengthMismatch If the arrays have a length mismatch
* @custom:throws DuplicateElementFound If the module addresses are repeated in the array
* @custom:throws InvalidInput If modules array is empty
* @custom:throws InvalidModule If any module address is zero
* @custom:throws UnsupportedModule If a module is not whitelisted on the data provider
*/
function _setupModules(address[] calldata _modules, bytes[] calldata _moduleSetupData) internal {
ModuleManagerStorage storage $ = _getModuleManagerStorage();
if ($.modules.length() != 0) revert ModulesAlreadySetup();
uint256 len = _modules.length;
if (len == 0) revert InvalidInput();
if (len != _moduleSetupData.length) revert ArrayLengthMismatch();
if (len > 1) _modules.checkDuplicates();
for (uint256 i = 0; i < len;) {
if (_modules[i] == address(0)) revert InvalidModule(i);
if (!_isCashModule(_modules[i]) && !_isWhitelistedOnDataProvider(_modules[i])) revert UnsupportedModule(i);
$.modules.add(_modules[i]);
IModule(_modules[i]).setupModule(_moduleSetupData[i]);
unchecked {
++i;
}
}
emit ModulesSetup(_modules);
}
/**
* @notice Configures module whitelist with signature verification
* @dev Uses EIP-712 typed data signing for secure multi-signature authorization
* @param modules Array of module addresses to configure
* @param shouldWhitelist Array of booleans indicating whether to add or remove each module
* @param moduleSetupData Array of data for setting up individual modules for the safe
* @param signers Array of addresses that signed the transaction
* @param signatures Array of corresponding signatures
* @custom:throws InvalidInput If modules array is empty
* @custom:throws ArrayLengthMismatch If modules and shouldWhitelist arrays have different lengths
* @custom:throws InvalidModule If any module address is zero
* @custom:throws InvalidSignatures If the signature verification fails
* @custom:throws DuplicateElementFound If the module addresses are repeated in the array
*/
function configureModules(address[] calldata modules, bool[] calldata shouldWhitelist, bytes[] calldata moduleSetupData, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
// Hash each bytes element in moduleSetupData individually
uint256 len = moduleSetupData.length;
bytes32[] memory dataHashes = new bytes32[](len);
for (uint256 i = 0; i < len; ) {
dataHashes[i] = keccak256(moduleSetupData[i]);
unchecked {
++i;
}
}
// Concatenate the hashes and hash again
bytes32 moduleSetupDataHash = keccak256(abi.encodePacked(dataHashes));
// Use the correct hash in the struct hash calculation
bytes32 structHash = keccak256(abi.encode(
CONFIGURE_MODULES_TYPEHASH,
keccak256(abi.encodePacked(modules)),
keccak256(abi.encodePacked(shouldWhitelist)),
moduleSetupDataHash,
_useNonce()
));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
_configureModules(modules, shouldWhitelist, moduleSetupData);
}
/**
* @notice Configures multiple modules at once
* @param _modules Array of module addresses to configure
* @param _shouldWhitelist Array of booleans indicating whether to add (true) or remove (false) each module
* @param _moduleSetupData Array of data for setting up individual modules for the safe
* @dev Efficiently handles multiple module operations in a single transaction
* @custom:throws InvalidInput If modules array is empty
* @custom:throws ArrayLengthMismatch If modules and shouldWhitelist arrays have different lengths
* @custom:throws InvalidModule If any module address is zero
* @custom:throws UnsupportedModule If a module is not whitelisted on the data provider
* @custom:throws CannotRemoveCashModule If attempting to remove a protected cash module
* @custom:throws DuplicateElementFound If the module addresses are repeated in the array
*/
function _configureModules(address[] calldata _modules, bool[] calldata _shouldWhitelist, bytes[] calldata _moduleSetupData) internal {
ModuleManagerStorage storage $ = _getModuleManagerStorage();
uint256 len = _modules.length;
if (len == 0) revert InvalidInput();
if (len != _shouldWhitelist.length || len != _moduleSetupData.length) revert ArrayLengthMismatch();
if (len > 1) _modules.checkDuplicates();
for (uint256 i = 0; i < len;) {
if (_modules[i] == address(0)) revert InvalidModule(i);
if (_shouldWhitelist[i] && !$.modules.contains(_modules[i])) {
if (!_isCashModule(_modules[i]) && !_isWhitelistedOnDataProvider(_modules[i])) revert UnsupportedModule(i);
$.modules.add(_modules[i]);
IModule(_modules[i]).setupModule(_moduleSetupData[i]);
}
if (!_shouldWhitelist[i] && $.modules.contains(_modules[i])) {
if (_isCashModule(_modules[i])) revert CannotRemoveCashModule(i);
$.modules.remove(_modules[i]);
}
unchecked {
++i;
}
}
emit ModulesConfigured(_modules, _shouldWhitelist);
}
/**
* @notice Checks if a module is whitelisted on the external data provider
* @param module Address of the module to check
* @return bool True if the module is whitelisted on the data provider
*/
function _isWhitelistedOnDataProvider(address module) internal view virtual returns (bool);
/**
* @notice Checks if a module is the cash module
* @param module Address of the module to check
* @return bool True if the module is the Cash module
*/
function _isCashModule(address module) internal view virtual returns (bool);
/**
* @notice Checks if an address is a valid whitelisted module
* @param module Address to check
* @return bool True if the address is a whitelisted module, false otherwise
* @dev A module is considered valid if:
* 1. It is the cash module (these are always valid), or
* 2. It is whitelisted on the data provider AND in the local modules set
*/
function isModuleEnabled(address module) public view returns (bool) {
if (_isCashModule(module)) return true;
bool isWhitelistedModuleOnDataProvider = _isWhitelistedOnDataProvider(module);
return isWhitelistedModuleOnDataProvider && _getModuleManagerStorage().modules.contains(module);
}
/**
* @notice Returns all locally whitelisted modules
* @return address[] Array containing all whitelisted module addresses
* Note: This may not include cash module if it's not explicitly added to storage
*/
function getModules() public view returns (address[] memory) {
return _getModuleManagerStorage().modules.values();
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { ArrayDeDupLib } from "../libraries/ArrayDeDupLib.sol";
import { EnumerableAddressWhitelistLib } from "../libraries/EnumerableAddressWhitelistLib.sol";
import { SignatureUtils } from "../libraries/SignatureUtils.sol";
import { EtherFiSafeBase } from "./EtherFiSafeBase.sol";
/**
* @title MultiSig
* @author ether.fi
* @notice Implements multi-sig functionality with configurable owners and threshold
*/
abstract contract MultiSig is EtherFiSafeBase {
using SignatureUtils for bytes32;
using EnumerableSetLib for EnumerableSetLib.AddressSet;
using ArrayDeDupLib for address[];
/// @custom:storage-location erc7201:etherfi.storage.MultiSig
struct MultiSigStorage {
/// @notice Set containing addresses of all the owners to the safe
EnumerableSetLib.AddressSet owners;
/// @notice Multisig threshold for the safe
uint8 threshold;
/// @notice Timelock for new owner after recovery
uint256 incomingOwnerStartTime;
/// @notice New owner after recovery
address incomingOwner;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.MultiSig")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant MultiSigStorageLocation = 0xa70a07defbd4aa681e6834c0c45f48279262d903d23e46456d62b7d6ef638000;
/// @notice Emitted when the threshold value is changed
/// @param oldThreshold Previous threshold value
/// @param newThreshold New threshold value
event ThresholdSet(uint8 oldThreshold, uint8 newThreshold);
/// @notice Emitted when owners are added or removed
/// @param owners Array of owner addresses that were configured
/// @param shouldAdd Array indicating whether each owner was added (true) or removed (false)
event OwnersConfigured(address[] owners, bool[] shouldAdd);
/// @notice Emitted when a new incoming owner is set after recovery
/// @param incomingOwner Address of the incoming owner
/// @param startTime Timestamp when the incoming owner can take effect
event IncomingOwnerSet(address incomingOwner, uint256 startTime);
/// @notice Emitted when an account is recovered after timelock period is complete
/// @param newOwner Address of the new owner
event AccountRecovered(address newOwner);
/**
* @dev Returns the storage struct for MultiSig
* @return $ Reference to the MultiSigStorage struct
* @custom:storage-location Uses ERC-7201 namespace storage pattern
*/
function _getMultiSigStorage() internal pure returns (MultiSigStorage storage $) {
assembly {
$.slot := MultiSigStorageLocation
}
}
/**
* @notice Sets up initial owners and threshold for the safe
* @param _owners Array of initial owner addresses
* @param _threshold Initial signature threshold
* @dev Can only be called once when owners set is empty
* @custom:throws MultiSigAlreadySetup If the safe has already been set up
* @custom:throws InvalidThreshold If threshold is 0 or greater than number of owners
* @custom:throws InvalidInput If owners array is empty
* @custom:throws InvalidOwnerAddress(index) If any owner address is zero
* @custom:throws DuplicateElementFound If owner addresses are repeated int the array
*/
function _setupMultiSig(address[] calldata _owners, uint8 _threshold) internal {
MultiSigStorage storage $ = _getMultiSigStorage();
if ($.owners.length() > 0) revert MultiSigAlreadySetup();
uint256 len = _owners.length;
if (_threshold == 0 || _threshold > len) revert InvalidThreshold();
emit ThresholdSet(0, _threshold);
$.threshold = _threshold;
if (len == 0) revert InvalidInput();
if (len > 1) _owners.checkDuplicates();
bool[] memory _shouldAdd = new bool[](len);
for (uint256 i = 0; i < len;) {
if (_owners[i] == address(0)) revert InvalidOwnerAddress(i);
$.owners.add(_owners[i]);
_shouldAdd[i] = true;
unchecked {
++i;
}
}
emit OwnersConfigured(_owners, _shouldAdd);
}
/**
* @notice Updates the signature threshold with owner signatures
* @dev Uses EIP-712 typed data signing for secure multi-signature authorization
* @param threshold New threshold value
* @param signers Array of addresses that signed the transaction
* @param signatures Array of corresponding signatures
* @custom:throws InvalidThreshold If threshold is 0 or greater than number of owners
* @custom:throws InvalidSignatures If signature verification fails
*/
function setThreshold(uint8 threshold, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(SET_THRESHOLD_TYPEHASH, threshold, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
_setThreshold(threshold);
}
/**
* @notice Configures safe owners with signature verification
* @dev Uses EIP-712 typed data signing for secure multi-signature authorization
* @param owners Array of owner addresses to configure
* @param shouldAdd Array indicating whether to add or remove each owner
* @param signers Array of addresses that signed the transaction
* @param signatures Array of corresponding signatures
* @custom:throws InvalidInput If owners array is empty
* @custom:throws ArrayLengthMismatch If arrays have different lengths
* @custom:throws InvalidAddress(index) If any owner address is zero
* @custom:throws DuplicateElementFound If owner addresses are repeated int the array
* @custom:throws AllOwnersRemoved If operation would remove all owners
* @custom:throws OwnersLessThanThreshold If owners would be less than threshold
* @custom:throws InvalidSignatures If signature verification fails
*/
function configureOwners(address[] calldata owners, bool[] calldata shouldAdd, uint8 threshold, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(CONFIGURE_OWNERS_TYPEHASH, keccak256(abi.encodePacked(owners)), keccak256(abi.encodePacked(shouldAdd)), threshold, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
_configureOwners(owners, shouldAdd, threshold);
_configureAdmin(owners, shouldAdd);
}
/**
* @notice Updates the signature threshold
* @param _threshold New threshold value
* @dev Threshold must be greater than 0 and not exceed the number of owners
* @custom:throws InvalidThreshold If threshold is 0 or greater than number of owners
*/
function _setThreshold(uint8 _threshold) internal {
MultiSigStorage storage $ = _getMultiSigStorage();
if (_threshold == 0 || _threshold > $.owners.length()) revert InvalidThreshold();
emit ThresholdSet($.threshold, _threshold);
$.threshold = _threshold;
}
/**
* @notice Configures safe owners by adding or removing them
* @param _owners Array of owner addresses to configure
* @param _shouldAdd Array indicating whether to add (true) or remove (false) each owner
* @param _threshold New threshold value
* @dev Cannot remove all owners or reduce owners below threshold
* @custom:throws InvalidInput If owners array is empty
* @custom:throws InvalidThreshold If threshold is 0 or greater than number of owners
* @custom:throws ArrayLengthMismatch If owners and shouldAdd arrays have different lengths
* @custom:throws InvalidAddress(index) If any owner address is zero
* @custom:throws DuplicateElementFound If owner addresses are repeated int the array
* @custom:throws AllOwnersRemoved If operation would remove all owners
* @custom:throws OwnersLessThanThreshold If operation would reduce owners below threshold
*/
function _configureOwners(address[] calldata _owners, bool[] calldata _shouldAdd, uint8 _threshold) internal {
MultiSigStorage storage $ = _getMultiSigStorage();
if (_threshold == 0) revert InvalidThreshold();
EnumerableAddressWhitelistLib.configure($.owners, _owners, _shouldAdd);
$.threshold = _threshold;
if ($.owners.length() == 0) revert AllOwnersRemoved();
if ($.owners.length() < $.threshold) revert OwnersLessThanThreshold();
emit OwnersConfigured(_owners, _shouldAdd);
}
/**
* @notice Sets a new incoming owner with associated timelock
* @param incomingOwner Address of the new incoming owner
* @param startTime Timestamp from which the new owner can take effect
* @dev This is part of the owner recovery mechanism
*/
function _setIncomingOwner(address incomingOwner, uint256 startTime) internal override {
MultiSigStorage storage $ = _getMultiSigStorage();
emit IncomingOwnerSet(incomingOwner, startTime);
$.incomingOwner = incomingOwner;
$.incomingOwnerStartTime = startTime;
}
/**
* @notice Removes the incoming owner and resets recovery timelock
* @dev Implementation of abstract function from EtherFiSafeBase
* @dev Called during recovery cancellation process
* @dev Sets the incoming owner to address(0) and timelock to 0, effectively canceling any pending recovery
*/
function _removeIncomingOwner() internal override {
_setIncomingOwner(address(0), 0);
}
/**
* @notice Verifies signatures against a digest hash until reaching the required threshold
* @param digestHash The hash of the data that was signed
* @param signers Array of addresses that supposedly signed the message
* @param signatures Array of signatures corresponding to the signers
* @return bool True if enough valid signatures are found to meet the threshold
* @dev Processes signatures until threshold is met. Invalid signatures are skipped.
* @custom:throws EmptySigners If the signers array is empty
* @custom:throws ArrayLengthMismatch If the lengths of signers and signatures arrays do not match
* @custom:throws InsufficientSigners If the length of signers array is less than the required threshold
* @custom:throws DuplicateElementFound If the signers array contains duplicate addresses
* @custom:throws InvalidSigner If a signer is the zero address or not an owner of the safe
*/
function checkSignatures(bytes32 digestHash, address[] calldata signers, bytes[] calldata signatures) public view override returns (bool) {
MultiSigStorage storage $ = _getMultiSigStorage();
uint256 len = signers.length;
if (len == 0) revert EmptySigners();
if (len != signatures.length) revert ArrayLengthMismatch();
if ($.incomingOwnerStartTime > 0 && block.timestamp > $.incomingOwnerStartTime) {
if (len > 1) revert InvalidInput();
if (signers[0] != $.incomingOwner) revert InvalidSigner(0);
return digestHash.isValidSignature(signers[0], signatures[0]);
}
if (len < $.threshold) revert InsufficientSigners();
if (len > 1) signers.checkDuplicates();
uint256 validSigs = 0;
for (uint256 i = 0; i < len;) {
if (signers[i] == address(0)) revert InvalidSigner(i);
if (!$.owners.contains(signers[i])) revert InvalidSigner(i);
if (digestHash.isValidSignature(signers[i], signatures[i])) {
unchecked {
++validSigs;
}
if (validSigs == $.threshold) break;
}
unchecked {
++i;
}
}
return validSigs == $.threshold;
}
/**
* @notice Returns the current incoming owner address
* @return Address of the incoming owner
* @dev Used during recovery process
*/
function getIncomingOwner() public override view returns (address) {
return _getMultiSigStorage().incomingOwner;
}
/**
* @notice Returns the start time for the incoming owner
* @return Timestamp when the incoming owner can take effect
* @dev Used to check if the recovery timelock has passed
*/
function getIncomingOwnerStartTime() public override view returns (uint256) {
return _getMultiSigStorage().incomingOwnerStartTime;
}
/**
* @notice Checks if an address is an owner of the safe
* @param account Address to check
* @return bool True if the address is an owner, false otherwise
*/
function isOwner(address account) public view returns (bool) {
uint256 incomingOwnerStartTime = getIncomingOwnerStartTime();
if (incomingOwnerStartTime > 0 && block.timestamp > incomingOwnerStartTime) {
return account == getIncomingOwner();
}
return _isOwner(account);
}
/**
* @notice Checks if an address is an owner of the safe
* @param account Address to check
*/
function _isOwner(address account) internal view returns (bool) {
return _getMultiSigStorage().owners.contains(account);
}
/**
* @notice Returns the current signature threshold
* @return uint8 Current threshold value
*/
function getThreshold() public view returns (uint8) {
uint256 incomingOwnerStartTime = getIncomingOwnerStartTime();
if (incomingOwnerStartTime > 0 && block.timestamp > incomingOwnerStartTime) return 1;
return _getMultiSigStorage().threshold;
}
/**
* @notice Handles owner transitions during recovery process
* @dev If the incoming owner timelock has passed, replaces all existing owners
* with the incoming owner and sets threshold to 1
*/
function _currentOwner() internal override {
MultiSigStorage storage $ = _getMultiSigStorage();
if ($.incomingOwnerStartTime > 0 && block.timestamp > $.incomingOwnerStartTime) {
address[] memory owners = $.owners.values();
uint256 len = owners.length;
address[] memory accounts = new address[](len + 1);
accounts[len] = $.incomingOwner;
bool[] memory shouldAdd = new bool[](len + 1);
shouldAdd[len] = true;
for (uint256 i = 0; i < len; ) {
$.owners.remove(owners[i]);
accounts[i] = owners[i];
shouldAdd[i] = false;
unchecked {
++i;
}
}
_configureAdmin(accounts, shouldAdd);
$.owners.add($.incomingOwner);
$.threshold = 1;
delete $.incomingOwnerStartTime;
delete $.incomingOwner;
emit AccountRecovered($.incomingOwner);
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { EnumerableAddressWhitelistLib } from "../libraries/EnumerableAddressWhitelistLib.sol";
import { EtherFiSafeBase } from "./EtherFiSafeBase.sol";
import { IEtherFiDataProvider } from "../interfaces/IEtherFiDataProvider.sol";
import { SignatureUtils } from "../libraries/SignatureUtils.sol";
import { ArrayDeDupLib } from "../libraries/ArrayDeDupLib.sol";
/**
* @title RecoveryManager
* @author ether.fi
* @notice Manages recovery functionality for EtherFi safe accounts
* @dev Implements a multi-signature recovery system with configurable recovery signers
*/
abstract contract RecoveryManager is EtherFiSafeBase {
using SignatureUtils for bytes32;
using EnumerableSetLib for EnumerableSetLib.AddressSet;
using ArrayDeDupLib for address[];
/// @custom:storage-location erc7201:etherfi.storage.RecoveryManager
struct RecoveryManagerStorage {
/// @notice Set of recovery signers added by the user
EnumerableSetLib.AddressSet userRecoverySigners;
/// @notice Number of signatures required to perform a recovery
uint8 recoveryThreshold;
/// @notice True if recovery is enabled, false if not
bool isRecoveryEnabled;
/// @notice Recovery signer address set by the user overriding the EtherFiRecoverySigner
address overridenEtherFiRecoverySigner;
/// @notice Recovery signer address set by the user overriding the ThirdPartyRecoverySigner
address overridenThirdPartyRecoverySigner;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.RecoveryManager")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant RecoveryManagerStorageLocation = 0x7252096011fe74e542f364eabd3c198d95310417daa86313d329374e00fb6e00;
/// @notice Emitted when recovery signers are added or removed
/// @param recoverySigners Array of recovery signer addresses that were configured
/// @param shouldAdd Array indicating whether each recovery signer was added (true) or removed (false)
event RecoverySignersConfigured(address[] recoverySigners, bool[] shouldAdd);
/// @notice Emitted when the recovery enabled flag is toggled
/// @param isEnabled The new state of the recovery feature
event RecoveryEnabledFlagUpdated(bool isEnabled);
/// @notice Emitted when the EtherFi recovery signer is overridden
/// @param signer The new overriding recovery signer address
event EtherFiRecoverySignerOverriden(address signer);
/// @notice Emitted when the third-party recovery signer is overridden
/// @param signer The new overriding third-party recovery signer address
event ThirdPartyRecoverySignerOverriden(address signer);
/// @notice Emitted when a recovery process is initiated
/// @param newOwner The address of the new owner after recovery
/// @param startTime The timestamp when the new owner can take control
event Recovery(address newOwner, uint256 startTime);
/// @notice Emitted when a recovery process is cancelled
event RecoveryCancelled();
/// @notice Emitted when the recovery threshold is updated
/// @param oldThreshold Previous threshold value
/// @param newThreshold New threshold value
event RecoveryThresholdSet(uint8 oldThreshold, uint8 newThreshold);
/**
* @dev Returns the storage struct for RecoveryManager
* @return $ Reference to the RecoveryManagerStorage struct
* @custom:storage-location Uses ERC-7201 namespace storage pattern
*/
function _getRecoveryManagerStorage() internal pure returns (RecoveryManagerStorage storage $) {
assembly {
$.slot := RecoveryManagerStorageLocation
}
}
/**
* @notice Sets up the recovery functionality
* @dev Can only be called once when recovery is not yet enabled
* @custom:throws RecoveryManagerAlreadyInitialized If recovery has already been initialized
*/
function _setupRecovery() internal {
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
if ($.isRecoveryEnabled == true && $.recoveryThreshold > 0) revert RecoveryManagerAlreadyInitialized();
$.isRecoveryEnabled = true;
$.recoveryThreshold = 2;
}
/**
* @notice Updates user recovery signers with secure signature verification
* @param recoverySigners Array of recovery signer addresses to modify
* @param shouldAdd Array indicating whether to add (true) or remove (false) each signer
* @param signers Array of owner addresses that signed this transaction
* @param signatures Array of corresponding signatures from the signers
* @dev Modifies the set of user recovery signers based on specified actions
* @custom:throws InvalidSignatures If the provided signatures are invalid
* @custom:throws RecoverySignersLengthLessThanThreshold If modifying signers would result in too few available signers for the current threshold
*/
function setUserRecoverySigners(address[] calldata recoverySigners, bool[] calldata shouldAdd, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(SET_USER_RECOVERY_SIGNERS_TYPEHASH, keccak256(abi.encodePacked(recoverySigners)), keccak256(abi.encodePacked(shouldAdd)), _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
EnumerableAddressWhitelistLib.configure($.userRecoverySigners, recoverySigners, shouldAdd);
emit RecoverySignersConfigured(recoverySigners, shouldAdd);
if ($.recoveryThreshold > 2 && $.recoveryThreshold - 2 > $.userRecoverySigners.length()) revert RecoverySignersLengthLessThanThreshold();
}
/**
* @notice Updates the number of signatures required for recovery
* @param threshold New threshold value
* @param signers Array of owner addresses that signed this transaction
* @param signatures Array of corresponding signatures from the signers
* @dev Sets a new recovery threshold with proper owner authorization
* @custom:throws InvalidSignatures If the provided signatures are invalid
* @custom:throws RecoverySignersLengthLessThanThreshold If the new threshold exceeds the number of available recovery signers
*/
function setRecoveryThreshold(uint8 threshold, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(SET_RECOVERY_THRESHOLD_TYPEHASH, threshold, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
if (threshold > 2 && threshold - 2 > $.userRecoverySigners.length()) revert RecoverySignersLengthLessThanThreshold();
emit RecoveryThresholdSet($.recoveryThreshold, threshold);
$.recoveryThreshold = threshold;
}
/**
* @notice Enables or disables the recovery functionality with signature verification
* @param shouldEnable True to enable recovery, false to disable
* @param signers Array of owner addresses that signed this transaction
* @param signatures Array of corresponding signatures from the signers
* @dev Toggles recovery functionality on or off with proper owner authorization
* @custom:throws InvalidSignatures If the provided signatures are invalid
* @custom:throws InvalidInput If attempting to set the state to its current value
*/
function toggleRecoveryEnabled(bool shouldEnable, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(TOGGLE_RECOVERY_ENABLED_TYPEHASH, shouldEnable, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
if (shouldEnable == $.isRecoveryEnabled) revert InvalidInput();
emit RecoveryEnabledFlagUpdated(shouldEnable);
$.isRecoveryEnabled = shouldEnable;
}
/**
* @notice Overrides the default recovery signers with custom addresses
* @param recoverySigners Array of two addresses [EtherFiRecoverySigner, ThirdPartyRecoverySigner]
* @param signers Array of owner addresses that signed this transaction
* @param signatures Array of corresponding signatures from the signers
* @dev Replaces the default protocol-level recovery signers with custom ones
* @custom:throws InvalidSignatures If the provided signatures are invalid
*/
function overrideRecoverySigners(address[2] calldata recoverySigners, address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(OVERRIDE_RECOVERY_SIGNERS_TYPEHASH, keccak256(abi.encodePacked(recoverySigners)), _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
if ($.overridenEtherFiRecoverySigner != recoverySigners[0]) {
emit EtherFiRecoverySignerOverriden(recoverySigners[0]);
$.overridenEtherFiRecoverySigner = recoverySigners[0];
}
if ($.overridenThirdPartyRecoverySigner != recoverySigners[1]) {
emit ThirdPartyRecoverySignerOverriden(recoverySigners[1]);
$.overridenThirdPartyRecoverySigner = recoverySigners[1];
}
}
/**
* @notice Initiates the recovery process to change ownership of the safe
* @param newOwner Address of the new owner
* @param recoverySigners Addresses of the recovery signers providing authorization
* @param signatures Signatures from the recovery signers
* @dev Starts a recovery process with proper validation and timelock
* @custom:throws RecoveryDisabled If recovery functionality is not enabled
* @custom:throws InvalidInput If the new owner is the zero address
* @custom:throws ArrayLengthMismatch If the signer and signature arrays have different lengths
* @custom:throws InsufficientRecoverySignatures If fewer signers than the threshold are provided
* @custom:throws InvalidRecoverySigner If any of the provided signers is not a valid recovery signer
* @custom:throws InvalidRecoverySignatures If not enough valid signatures are provided
*/
function recoverSafe(address newOwner, address[] calldata recoverySigners, bytes[] calldata signatures) external {
_currentOwner();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
if (!$.isRecoveryEnabled) revert RecoveryDisabled();
if (newOwner == address(0)) revert InvalidInput();
uint256 len = recoverySigners.length;
if (len != signatures.length) revert ArrayLengthMismatch();
if (len < $.recoveryThreshold) revert InsufficientRecoverySignatures();
recoverySigners.checkDuplicates();
bytes32 structHash = keccak256(abi.encode(RECOVER_SAFE_TYPEHASH, newOwner, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
uint256 validSignatures = 0;
for (uint256 i = 0; i < len; ) {
if (!isRecoverySigner(recoverySigners[i])) revert InvalidRecoverySigner(i);
if (digestHash.isValidSignature(recoverySigners[i], signatures[i])) validSignatures++;
if (validSignatures == $.recoveryThreshold) break;
unchecked {
++i;
}
}
if (validSignatures != $.recoveryThreshold) revert InvalidRecoverySignatures();
uint256 incomingOwnerStartTime = block.timestamp + dataProvider.getRecoveryDelayPeriod();
_setIncomingOwner(newOwner, incomingOwnerStartTime);
emit Recovery(newOwner, incomingOwnerStartTime);
}
/**
* @notice Checks if an address is a valid recovery signer
* @param signer Address to verify
* @return bool True if the address is a valid recovery signer
* @dev Validates against overridden signers, default signers from the data provider, and user-added signers
* @custom:throws InvalidInput If the provided signer is the zero address
*/
function isRecoverySigner(address signer) public view returns (bool) {
if (signer == address(0)) revert InvalidInput();
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
address recoverySigner1 = $.overridenEtherFiRecoverySigner;
address recoverySigner2 = $.overridenThirdPartyRecoverySigner;
if (recoverySigner1 == address(0)) recoverySigner1 = dataProvider.getEtherFiRecoverySigner();
if (recoverySigner2 == address(0)) recoverySigner2 = dataProvider.getThirdPartyRecoverySigner();
if ($.userRecoverySigners.contains(signer) || recoverySigner1 == signer || recoverySigner2 == signer) return true;
else return false;
}
/**
* @notice Cancels an ongoing recovery process with signature verification
* @param signers Array of owner addresses that signed this transaction
* @param signatures Array of corresponding signatures from the signers
* @dev Reverts an in-progress recovery with proper owner authorization
* @custom:throws InvalidSignatures If the provided signatures are invalid
*/
function cancelRecovery(address[] calldata signers, bytes[] calldata signatures) external {
_currentOwner();
bytes32 structHash = keccak256(abi.encode(CANCEL_RECOVERY_TYPEHASH, _useNonce()));
bytes32 digestHash = _hashTypedDataV4(structHash);
if (!checkSignatures(digestHash, signers, signatures)) revert InvalidSignatures();
_removeIncomingOwner();
emit RecoveryCancelled();
}
/**
* @notice Returns a list of all recovery signers for this safe
* @return Array of all recovery signer addresses, including default and user-added signers
* @dev Combines default signers (or their overrides) with user-added signers
*/
function getRecoverySigners() public view returns (address[] memory) {
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
address recoverySigner1 = $.overridenEtherFiRecoverySigner;
address recoverySigner2 = $.overridenThirdPartyRecoverySigner;
if (recoverySigner1 == address(0)) recoverySigner1 = dataProvider.getEtherFiRecoverySigner();
if (recoverySigner2 == address(0)) recoverySigner2 = dataProvider.getThirdPartyRecoverySigner();
uint256 len = $.userRecoverySigners.length();
address[] memory recoverySigners = new address[](len + 2);
recoverySigners[0] = recoverySigner1;
recoverySigners[1] = recoverySigner2;
for (uint256 i = 0; i < len; ) {
recoverySigners[i + 2] = $.userRecoverySigners.at(i);
unchecked {
++i;
}
}
return recoverySigners;
}
/**
* @notice Checks if the recovery functionality is enabled
* @return Boolean indicating whether recovery is enabled
*/
function isRecoveryEnabled() public view returns (bool) {
return _getRecoveryManagerStorage().isRecoveryEnabled;
}
/**
* @notice Returns the current recovery threshold
* @return The number of recovery signatures required to initiate recovery
* @dev This threshold determines how many valid recovery signer signatures are needed
*/
function getRecoveryThreshold() public view returns (uint8) {
return _getRecoveryManagerStorage().recoveryThreshold;
}
/**
* @notice Returns the current recovery status information
* @return isEnabled Whether recovery is currently enabled
* @return isPending Whether there is a pending recovery in progress
* @return incomingOwner The address of the new owner if recovery is pending
* @return timelockExpiration The timestamp when ownership transition will occur if recovery is pending
* @dev Provides comprehensive information about the current recovery state
*/
function getRecoveryStatus() public view returns (bool isEnabled, bool isPending, address incomingOwner, uint256 timelockExpiration) {
RecoveryManagerStorage storage $ = _getRecoveryManagerStorage();
address _incomingOwner = getIncomingOwner();
uint256 _timelockExpiration = getIncomingOwnerStartTime();
return ($.isRecoveryEnabled, _incomingOwner != address(0) && _timelockExpiration > 0, _incomingOwner, _timelockExpiration);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { EIP712Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/cryptography/EIP712Upgradeable.sol";
import { IEtherFiDataProvider } from "../interfaces/IEtherFiDataProvider.sol";
import { EtherFiSafeErrors } from "./EtherFiSafeErrors.sol";
/**
* @title EtherFiSafeBase
* @author ether.fi
* @notice Base contract for EtherFi safe implementations providing common functionality
* @dev Implements EIP-712 typed data signing and core safe functionality
*/
abstract contract EtherFiSafeBase is EtherFiSafeErrors, EIP712Upgradeable {
/**
* @notice Interface to the data provider contract
* @dev Used to access protocol configuration and validation services
*/
IEtherFiDataProvider public immutable dataProvider;
/**
* @dev Storage structure for EtherFiSafe using ERC-7201 namespaced storage pattern
* @custom:storage-location erc7201:etherfi.storage.EtherFiSafe
*/
struct EtherFiSafeStorage {
/// @notice Current nonce for replay protection
uint256 nonce;
}
// keccak256(abi.encode(uint256(keccak256("etherfi.storage.EtherFiSafe")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant EtherFiSafeStorageLocation = 0x44768873c7c67d9dae2df1ca334431d5cd98fd349ed85d549beecffe9f026500;
/**
* @notice TypeHash for module configuration with EIP-712 signatures
* @dev keccak256("ConfigureModules(address[] modules,bool[] shouldWhitelist,bytes[] moduleSetupData,uint256 nonce)")
*/
bytes32 public constant CONFIGURE_MODULES_TYPEHASH = 0x17e852b97b6d99745122cea2e2c782f5720a732d6f557a0a647b5090fc919667;
/**
* @notice TypeHash for threshold setting with EIP-712 signatures
* @dev keccak256("SetThreshold(uint8 threshold,uint256 nonce)")
*/
bytes32 public constant SET_THRESHOLD_TYPEHASH = 0x41b1bc57fb63493212c2d2f75145ff3130ce53c70f867177944887c5cb8e8626;
/**
* @notice TypeHash for owner configuration with EIP-712 signatures
* @dev keccak256("ConfigureOwners(address[] owners,bool[] shouldAdd,uint8 threshold,uint256 nonce)")
*/
bytes32 public constant CONFIGURE_OWNERS_TYPEHASH = 0x7ae209fa0e1cd2808f119c4a89c36952d3ac8521e0be463a9bdab5449b4ee419;
/**
* @notice TypeHash for admin configuration with EIP-712 signatures
* @dev keccak256("ConfigureAdmins(address[] accounts,bool[] shouldAdd,uint256 nonce)")
*/
bytes32 public constant CONFIGURE_ADMIN_TYPEHASH = 0x3dfd66efb2a5d3ec63eb6eb270a4a662d28b1e27ce51f3c835ba384215a0ac80;
/**
* @notice TypeHash for cancel nonce with EIP-712 signatures
* @dev keccak256("CancelNonce(uint256 nonce)")
*/
bytes32 public constant CANCEL_NONCE_TYPEHASH = 0x911689a040f9425c778a23077912d56c2402a1006cf81f5d629a2c8281b77563;
/**
* @notice TypeHash for setting user recovery signers with EIP-712 signatures
* @dev keccak256("SetUserRecoverySigners(address[] recoverySigners, bool[] shouldAdd, uint256 nonce)")
*/
bytes32 public constant SET_USER_RECOVERY_SIGNERS_TYPEHASH = 0x13a92003fda0d03ec95bfceee0b09375118fa2f6b07643738d22bb5ab1624892;
/**
* @notice TypeHash for toggling recovery enabled flag with EIP-712 signatures
* @dev keccak256("ToggleRecoveryEnabled(bool shouldEnable, uint256 nonce)")
*/
bytes32 public constant TOGGLE_RECOVERY_ENABLED_TYPEHASH = 0x5c10794d3a4aa2f8b255fb0edd6a1590ef803ef6938cd05b4b429373f6d7f23a;
/**
* @notice TypeHash for recovering the safe with EIP-712 signatures
* @dev keccak256("RecoverSafe(address newOwner, uint256 nonce)")
*/
bytes32 public constant RECOVER_SAFE_TYPEHASH = 0x2992e7b46f73f4592f11ad26ecd28369c2c2c21ff82538e3a580b30a75cf7475;
/**
* @notice TypeHash for overriding EtherFi and Third Party recovery signers with EIP-712 signatures
* @dev keccak256("OverrideRecoverySigners(address[2] recoverySigners, uint256 nonce)")
*/
bytes32 public constant OVERRIDE_RECOVERY_SIGNERS_TYPEHASH = 0x04bcf772e9794a9d599eb843d9bc5d71ec13708fac13593aefc4ff9cfc4ba9e7;
/**
* @notice TypeHash for cancelling recovery with EIP-712 signatures
* @dev keccak256("CancelRecovery(uint256 nonce)")
*/
bytes32 public constant CANCEL_RECOVERY_TYPEHASH = 0x74bf4a4220866f2d5407c382e8b086ccc8579acc38c68ccbcb96d46432578c8d;
/**
* @notice TypeHash for setting the recovery threshold with EIP-712 signatures
* @dev keccak256("SetRecoveryThreshold(uint8 threshold, uint256 nonce)")
*/
bytes32 public constant SET_RECOVERY_THRESHOLD_TYPEHASH = 0x55fbacc2ae7fb06b8e6207b13a0239f651c6c83bbee4bf809286d76d9ee9a8ac;
/**
* @notice Emitted when a transaction is executed through a module
* @param to Array of target addresses for the calls
* @param value Array of ETH values to send with each call
* @param data Array of calldata for each call
*/
event ExecTransactionFromModule(address[] to, uint256[] value, bytes[] data);
/**
* @notice Emitted when admin accounts are configured
* @param accounts Array of admin addresses that were configured
* @param shouldAdd Array indicating whether each admin was added (true) or removed (false)
*/
event AdminsConfigured(address[] accounts, bool[] shouldAdd);
/**
* @notice Emitted when a nonce is cancelled
* @param nonce The cancelled nonce
*/
event NonceCancelled(uint256 nonce);
/**
* @dev Returns the storage struct for EtherFiSafe
* @return $ Reference to the EtherFiSafeStorage struct
* @custom:storage-location Uses ERC-7201 namespace storage pattern
*/
function _getEtherFiSafeStorage() internal pure returns (EtherFiSafeStorage storage $) {
assembly {
$.slot := EtherFiSafeStorageLocation
}
}
/**
* @notice Contract constructor
* @dev Sets the immutable data provider reference
* @param _dataProvider Address of the EtherFiDataProvider contract
*/
constructor(address _dataProvider) payable {
dataProvider = IEtherFiDataProvider(_dataProvider);
}
/**
* @notice Verifies multiple signatures against a digest hash
* @param digestHash The hash of the data that was signed
* @param signers Array of addresses that supposedly signed the message
* @param signatures Array of signatures corresponding to the signers
* @return bool True if the signatures are valid and meet the threshold requirements
* @dev Implementation varies based on the inheriting contract
*/
function checkSignatures(bytes32 digestHash, address[] calldata signers, bytes[] calldata signatures) public view virtual returns (bool);
/**
* @dev Consumes a nonce for replay protection
* @return Current nonce value before incrementing
*/
function _useNonce() internal returns (uint256) {
EtherFiSafeStorage storage $ = _getEtherFiSafeStorage();
// The nonce has an initial value of 0, can only be incremented by one, and cannot be
// decremented or reset. This guarantees that the nonce never overflows.
unchecked {
// It is important to do x++ and not ++x here.
return $.nonce++;
}
}
/**
* @notice Verifies current ownership state and handles recovery transitions
* @dev Implementation depends on the specific ownership model in inheriting contracts
*/
function _currentOwner() internal virtual;
/**
* @notice Sets a new incoming owner with a timelock
* @param incomingOwner Address of the new incoming owner
* @param startTime Timestamp when the new owner can take effect
* @dev Used in the recovery process, implementation in inheriting contracts
*/
function _setIncomingOwner(address incomingOwner, uint256 startTime) internal virtual;
/**
* @notice Removes the currently set incoming owner
* @dev Used to cancel a recovery process, implementation in inheriting contracts
*/
function _removeIncomingOwner() internal virtual;
/**
* @notice Returns all current owners of the safe
* @return address[] Array containing all owner addresses
*/
function getOwners() public view virtual returns (address[] memory);
/**
* @notice Returns the current incoming owner address
* @return Address of the incoming owner
* @dev Used during recovery process
*/
function getIncomingOwner() public virtual view returns (address);
/**
* @notice Returns the start time for the incoming owner
* @return Timestamp when the incoming owner can take effect
* @dev Used to check if the recovery timelock has passed
*/
function getIncomingOwnerStartTime() public virtual view returns (uint256);
/**
* @dev Internal function to configure admin accounts
* @param accounts Array of admin addresses to configure
* @param shouldAdd Array indicating whether to add or remove each admin
*/
function _configureAdmin(address[] memory accounts, bool[] memory shouldAdd) internal {
dataProvider.roleRegistry().configureSafeAdmins(accounts, shouldAdd);
emit AdminsConfigured(accounts, shouldAdd);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/beacon/IBeacon.sol)
pragma solidity ^0.8.20;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeacon {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {UpgradeableBeacon} will check that this address is a contract.
*/
function implementation() external view returns (address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/Proxy.sol)
pragma solidity ^0.8.20;
/**
* @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM
* instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to
* be specified by overriding the virtual {_implementation} function.
*
* Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a
* different contract through the {_delegate} function.
*
* The success and return data of the delegated call will be returned back to the caller of the proxy.
*/
abstract contract Proxy {
/**
* @dev Delegates the current call to `implementation`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _delegate(address implementation) internal virtual {
assembly {
// Copy msg.data. We take full control of memory in this inline assembly
// block because it will not return to Solidity code. We overwrite the
// Solidity scratch pad at memory position 0.
calldatacopy(0, 0, calldatasize())
// Call the implementation.
// out and outsize are 0 because we don't know the size yet.
let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0)
// Copy the returned data.
returndatacopy(0, 0, returndatasize())
switch result
// delegatecall returns 0 on error.
case 0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
}
/**
* @dev This is a virtual function that should be overridden so it returns the address to which the fallback
* function and {_fallback} should delegate.
*/
function _implementation() internal view virtual returns (address);
/**
* @dev Delegates the current call to the address returned by `_implementation()`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _fallback() internal virtual {
_delegate(_implementation());
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other
* function in the contract matches the call data.
*/
fallback() external payable virtual {
_fallback();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/ERC1967/ERC1967Utils.sol)
pragma solidity ^0.8.22;
import {IBeacon} from "../beacon/IBeacon.sol";
import {IERC1967} from "../../interfaces/IERC1967.sol";
import {Address} from "../../utils/Address.sol";
import {StorageSlot} from "../../utils/StorageSlot.sol";
/**
* @dev This library provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] slots.
*/
library ERC1967Utils {
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev The `implementation` of the proxy is invalid.
*/
error ERC1967InvalidImplementation(address implementation);
/**
* @dev The `admin` of the proxy is invalid.
*/
error ERC1967InvalidAdmin(address admin);
/**
* @dev The `beacon` of the proxy is invalid.
*/
error ERC1967InvalidBeacon(address beacon);
/**
* @dev An upgrade function sees `msg.value > 0` that may be lost.
*/
error ERC1967NonPayable();
/**
* @dev Returns the current implementation address.
*/
function getImplementation() internal view returns (address) {
return StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
if (newImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(newImplementation);
}
StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Performs implementation upgrade with additional setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-Upgraded} event.
*/
function upgradeToAndCall(address newImplementation, bytes memory data) internal {
_setImplementation(newImplementation);
emit IERC1967.Upgraded(newImplementation);
if (data.length > 0) {
Address.functionDelegateCall(newImplementation, data);
} else {
_checkNonPayable();
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
* the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
*/
function getAdmin() internal view returns (address) {
return StorageSlot.getAddressSlot(ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
if (newAdmin == address(0)) {
revert ERC1967InvalidAdmin(address(0));
}
StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {IERC1967-AdminChanged} event.
*/
function changeAdmin(address newAdmin) internal {
emit IERC1967.AdminChanged(getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is the keccak-256 hash of "eip1967.proxy.beacon" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function getBeacon() internal view returns (address) {
return StorageSlot.getAddressSlot(BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the ERC-1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
if (newBeacon.code.length == 0) {
revert ERC1967InvalidBeacon(newBeacon);
}
StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;
address beaconImplementation = IBeacon(newBeacon).implementation();
if (beaconImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(beaconImplementation);
}
}
/**
* @dev Change the beacon and trigger a setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-BeaconUpgraded} event.
*
* CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since
* it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for
* efficiency.
*/
function upgradeBeaconToAndCall(address newBeacon, bytes memory data) internal {
_setBeacon(newBeacon);
emit IERC1967.BeaconUpgraded(newBeacon);
if (data.length > 0) {
Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
} else {
_checkNonPayable();
}
}
/**
* @dev Reverts if `msg.value` is not zero. It can be used to avoid `msg.value` stuck in the contract
* if an upgrade doesn't perform an initialization call.
*/
function _checkNonPayable() private {
if (msg.value > 0) {
revert ERC1967NonPayable();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/utils/UUPSUpgradeable.sol)
pragma solidity ^0.8.22;
import {IERC1822Proxiable} from "@openzeppelin/contracts/interfaces/draft-IERC1822.sol";
import {ERC1967Utils} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Utils.sol";
import {Initializable} from "./Initializable.sol";
/**
* @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
* {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
*
* A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
* reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
* `UUPSUpgradeable` with a custom implementation of upgrades.
*
* The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
*/
abstract contract UUPSUpgradeable is Initializable, IERC1822Proxiable {
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
address private immutable __self = address(this);
/**
* @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgradeTo(address)`
* and `upgradeToAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called,
* while `upgradeToAndCall` will invoke the `receive` function if the second argument is the empty byte string.
* If the getter returns `"5.0.0"`, only `upgradeToAndCall(address,bytes)` is present, and the second argument must
* be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
* during an upgrade.
*/
string public constant UPGRADE_INTERFACE_VERSION = "5.0.0";
/**
* @dev The call is from an unauthorized context.
*/
error UUPSUnauthorizedCallContext();
/**
* @dev The storage `slot` is unsupported as a UUID.
*/
error UUPSUnsupportedProxiableUUID(bytes32 slot);
/**
* @dev Check that the execution is being performed through a delegatecall call and that the execution context is
* a proxy contract with an implementation (as defined in ERC-1967) pointing to self. This should only be the case
* for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
* function through ERC-1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
* fail.
*/
modifier onlyProxy() {
_checkProxy();
_;
}
/**
* @dev Check that the execution is not being performed through a delegate call. This allows a function to be
* callable on the implementing contract but not through proxies.
*/
modifier notDelegated() {
_checkNotDelegated();
_;
}
function __UUPSUpgradeable_init() internal onlyInitializing {
}
function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
}
/**
* @dev Implementation of the ERC-1822 {proxiableUUID} function. This returns the storage slot used by the
* implementation. It is used to validate the implementation's compatibility when performing an upgrade.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.
*/
function proxiableUUID() external view virtual notDelegated returns (bytes32) {
return ERC1967Utils.IMPLEMENTATION_SLOT;
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
* encoded in `data`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*
* @custom:oz-upgrades-unsafe-allow-reachable delegatecall
*/
function upgradeToAndCall(address newImplementation, bytes memory data) public payable virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallUUPS(newImplementation, data);
}
/**
* @dev Reverts if the execution is not performed via delegatecall or the execution
* context is not of a proxy with an ERC-1967 compliant implementation pointing to self.
* See {_onlyProxy}.
*/
function _checkProxy() internal view virtual {
if (
address(this) == __self || // Must be called through delegatecall
ERC1967Utils.getImplementation() != __self // Must be called through an active proxy
) {
revert UUPSUnauthorizedCallContext();
}
}
/**
* @dev Reverts if the execution is performed via delegatecall.
* See {notDelegated}.
*/
function _checkNotDelegated() internal view virtual {
if (address(this) != __self) {
// Must not be called through delegatecall
revert UUPSUnauthorizedCallContext();
}
}
/**
* @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
* {upgradeToAndCall}.
*
* Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
*
* ```solidity
* function _authorizeUpgrade(address) internal onlyOwner {}
* ```
*/
function _authorizeUpgrade(address newImplementation) internal virtual;
/**
* @dev Performs an implementation upgrade with a security check for UUPS proxies, and additional setup call.
*
* As a security check, {proxiableUUID} is invoked in the new implementation, and the return value
* is expected to be the implementation slot in ERC-1967.
*
* Emits an {IERC1967-Upgraded} event.
*/
function _upgradeToAndCallUUPS(address newImplementation, bytes memory data) private {
try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) {
if (slot != ERC1967Utils.IMPLEMENTATION_SLOT) {
revert UUPSUnsupportedProxiableUUID(slot);
}
ERC1967Utils.upgradeToAndCall(newImplementation, data);
} catch {
// The implementation is not UUPS
revert ERC1967Utils.ERC1967InvalidImplementation(newImplementation);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
PausableStorage storage $ = _getPausableStorage();
return $._paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuardTransient.sol)
pragma solidity ^0.8.24;
import {TransientSlot} from "@openzeppelin/contracts/utils/TransientSlot.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Variant of {ReentrancyGuard} that uses transient storage.
*
* NOTE: This variant only works on networks where EIP-1153 is available.
*
* _Available since v5.1._
*/
abstract contract ReentrancyGuardTransientUpgradeable is Initializable {
using TransientSlot for *;
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant REENTRANCY_GUARD_STORAGE =
0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function __ReentrancyGuardTransient_init() internal onlyInitializing {
}
function __ReentrancyGuardTransient_init_unchained() internal onlyInitializing {
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
if (_reentrancyGuardEntered()) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
REENTRANCY_GUARD_STORAGE.asBoolean().tstore(true);
}
function _nonReentrantAfter() private {
REENTRANCY_GUARD_STORAGE.asBoolean().tstore(false);
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return REENTRANCY_GUARD_STORAGE.asBoolean().tload();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reininitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._initialized = 1;
if (isTopLevelCall) {
$._initializing = true;
}
_;
if (isTopLevelCall) {
$._initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._initialized = version;
$._initializing = true;
_;
$._initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
assembly {
$.slot := INITIALIZABLE_STORAGE
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.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://eth.wiki/json-rpc/API#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://eth.wiki/json-rpc/API#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 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)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5267.sol)
pragma solidity ^0.8.20;
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
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1271.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-1271 standard signature validation method for
* contracts as defined in https://eips.ethereum.org/EIPS/eip-1271[ERC-1271].
*/
interface IERC1271 {
/**
* @dev Should return whether the signature provided is valid for the provided data
* @param hash Hash of the data to be signed
* @param signature Signature byte array associated with _data
*/
function isValidSignature(bytes32 hash, bytes memory signature) external view returns (bytes4 magicValue);
}// 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);
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
interface IModule {
/**
* @notice Returns the current nonce for a Safe
* @param safe The Safe address to query
* @return Current nonce value
* @dev Nonces are used to prevent signature replay attacks
*/
function getNonce(address safe) external view returns (uint256);
/**
* @notice Sets up a new Safe's Module with initial configuration
* @dev Override this function to configure a module initially
* @param data The encoded initialization data
*/
function setupModule(bytes calldata data) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { EnumerableSetLib } from "solady/utils/EnumerableSetLib.sol";
import { ArrayDeDupLib } from "./ArrayDeDupLib.sol";
/**
* @title EnumerableAddressWhitelistLib
* @author ether.fi
* @notice Library for managing address whitelists with enumeration capabilities
* @dev Leverages Solady's EnumerableSetLib for storage efficiency and ArrayDeDupLib for input validation
*/
library EnumerableAddressWhitelistLib {
using EnumerableSetLib for EnumerableSetLib.AddressSet;
using ArrayDeDupLib for address[];
/**
* @notice Thrown when input parameters are invalid or empty
*/
error InvalidInput();
/**
* @notice Thrown when provided arrays have different lengths
*/
error ArrayLengthMismatch();
/**
* @notice Thrown when an invalid address is provided at a specific index
* @param index The position in the array where the invalid address was found
*/
error InvalidAddress(uint256 index);
/**
* @notice Configures a set of addresses by adding or removing them based on boolean flags
* @dev Checks for duplicate addresses and validates inputs before modifying the set
* @param set The EnumerableSetLib.AddressSet to modify
* @param addrs Array of addresses to add or remove
* @param shouldAdd Array of boolean flags indicating whether each address should be added (true) or removed (false)
* @custom:throws InvalidInput If the arrays are empty
* @custom:throws ArrayLengthMismatch If the arrays have different lengths
* @custom:throws InvalidAddress If any address is the zero address
* @custom:throws DuplicateElementFound If any address appears more than once in the addrs array
*/
function configure(EnumerableSetLib.AddressSet storage set, address[] calldata addrs, bool[] calldata shouldAdd) internal {
uint256 len = addrs.length;
if (len == 0) revert InvalidInput();
if (len != shouldAdd.length) revert ArrayLengthMismatch();
if (len > 1) addrs.checkDuplicates();
// Use unchecked for the entire loop to save gas on overflow checks
unchecked {
for (uint256 i; i < len; ++i) {
if (addrs[i] == address(0)) revert InvalidAddress(i);
// Direct condition checks instead of nested ifs for better gas optimization
bool contains = set.contains(addrs[i]);
if (shouldAdd[i]) {
if (!contains) set.add(addrs[i]);
} else {
if (contains) set.remove(addrs[i]);
}
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC1967.sol)
pragma solidity ^0.8.20;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*/
interface IERC1967 {
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Emitted when the beacon is changed.
*/
event BeaconUpgraded(address indexed beacon);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, bytes memory returndata) = recipient.call{value: amount}("");
if (!success) {
_revert(returndata);
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}// 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
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC1822.sol)
pragma solidity ^0.8.20;
/**
* @dev ERC-1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
* proxy whose upgrades are fully controlled by the current implementation.
*/
interface IERC1822Proxiable {
/**
* @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
* address.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy.
*/
function proxiableUUID() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/TransientSlot.sol)
// This file was procedurally generated from scripts/generate/templates/TransientSlot.js.
pragma solidity ^0.8.24;
/**
* @dev Library for reading and writing value-types to specific transient storage slots.
*
* Transient slots are often used to store temporary values that are removed after the current transaction.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* * Example reading and writing values using transient storage:
* ```solidity
* contract Lock {
* using TransientSlot for *;
*
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _LOCK_SLOT = 0xf4678858b2b588224636b8522b729e7722d32fc491da849ed75b3fdf3c84f542;
*
* modifier locked() {
* require(!_LOCK_SLOT.asBoolean().tload());
*
* _LOCK_SLOT.asBoolean().tstore(true);
* _;
* _LOCK_SLOT.asBoolean().tstore(false);
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library TransientSlot {
/**
* @dev UDVT that represent a slot holding a address.
*/
type AddressSlot is bytes32;
/**
* @dev Cast an arbitrary slot to a AddressSlot.
*/
function asAddress(bytes32 slot) internal pure returns (AddressSlot) {
return AddressSlot.wrap(slot);
}
/**
* @dev UDVT that represent a slot holding a bool.
*/
type BooleanSlot is bytes32;
/**
* @dev Cast an arbitrary slot to a BooleanSlot.
*/
function asBoolean(bytes32 slot) internal pure returns (BooleanSlot) {
return BooleanSlot.wrap(slot);
}
/**
* @dev UDVT that represent a slot holding a bytes32.
*/
type Bytes32Slot is bytes32;
/**
* @dev Cast an arbitrary slot to a Bytes32Slot.
*/
function asBytes32(bytes32 slot) internal pure returns (Bytes32Slot) {
return Bytes32Slot.wrap(slot);
}
/**
* @dev UDVT that represent a slot holding a uint256.
*/
type Uint256Slot is bytes32;
/**
* @dev Cast an arbitrary slot to a Uint256Slot.
*/
function asUint256(bytes32 slot) internal pure returns (Uint256Slot) {
return Uint256Slot.wrap(slot);
}
/**
* @dev UDVT that represent a slot holding a int256.
*/
type Int256Slot is bytes32;
/**
* @dev Cast an arbitrary slot to a Int256Slot.
*/
function asInt256(bytes32 slot) internal pure returns (Int256Slot) {
return Int256Slot.wrap(slot);
}
/**
* @dev Load the value held at location `slot` in transient storage.
*/
function tload(AddressSlot slot) internal view returns (address value) {
assembly ("memory-safe") {
value := tload(slot)
}
}
/**
* @dev Store `value` at location `slot` in transient storage.
*/
function tstore(AddressSlot slot, address value) internal {
assembly ("memory-safe") {
tstore(slot, value)
}
}
/**
* @dev Load the value held at location `slot` in transient storage.
*/
function tload(BooleanSlot slot) internal view returns (bool value) {
assembly ("memory-safe") {
value := tload(slot)
}
}
/**
* @dev Store `value` at location `slot` in transient storage.
*/
function tstore(BooleanSlot slot, bool value) internal {
assembly ("memory-safe") {
tstore(slot, value)
}
}
/**
* @dev Load the value held at location `slot` in transient storage.
*/
function tload(Bytes32Slot slot) internal view returns (bytes32 value) {
assembly ("memory-safe") {
value := tload(slot)
}
}
/**
* @dev Store `value` at location `slot` in transient storage.
*/
function tstore(Bytes32Slot slot, bytes32 value) internal {
assembly ("memory-safe") {
tstore(slot, value)
}
}
/**
* @dev Load the value held at location `slot` in transient storage.
*/
function tload(Uint256Slot slot) internal view returns (uint256 value) {
assembly ("memory-safe") {
value := tload(slot)
}
}
/**
* @dev Store `value` at location `slot` in transient storage.
*/
function tstore(Uint256Slot slot, uint256 value) internal {
assembly ("memory-safe") {
tstore(slot, value)
}
}
/**
* @dev Load the value held at location `slot` in transient storage.
*/
function tload(Int256Slot slot) internal view returns (int256 value) {
assembly ("memory-safe") {
value := tload(slot)
}
}
/**
* @dev Store `value` at location `slot` in transient storage.
*/
function tstore(Int256Slot slot, int256 value) internal {
assembly ("memory-safe") {
tstore(slot, value)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.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;
/**
* @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(buffer, add(32, 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} 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} 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} 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} 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} 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 guaratees 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} 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} 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} 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 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(buffer, add(0x20, offset)))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.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 Returns the addition of two unsigned integers, with an success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b == 0) return (false, 0);
return (true, 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 {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @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 {
// 512-bit multiply [prod1 prod0] = 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 = prod1 * 2²⁵⁶ + prod0.
uint256 prod0 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= prod1) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2²⁵⁶. 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 prod1
// is no longer required.
result = prod0 * 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 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 value) internal pure returns (uint256) {
uint256 result = 0;
uint256 exp;
unchecked {
exp = 128 * SafeCast.toUint(value > (1 << 128) - 1);
value >>= exp;
result += exp;
exp = 64 * SafeCast.toUint(value > (1 << 64) - 1);
value >>= exp;
result += exp;
exp = 32 * SafeCast.toUint(value > (1 << 32) - 1);
value >>= exp;
result += exp;
exp = 16 * SafeCast.toUint(value > (1 << 16) - 1);
value >>= exp;
result += exp;
exp = 8 * SafeCast.toUint(value > (1 << 8) - 1);
value >>= exp;
result += exp;
exp = 4 * SafeCast.toUint(value > (1 << 4) - 1);
value >>= exp;
result += exp;
exp = 2 * SafeCast.toUint(value > (1 << 2) - 1);
value >>= exp;
result += exp;
result += SafeCast.toUint(value > 1);
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + 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 value) internal pure returns (uint256) {
uint256 result = 0;
uint256 isGt;
unchecked {
isGt = SafeCast.toUint(value > (1 << 128) - 1);
value >>= isGt * 128;
result += isGt * 16;
isGt = SafeCast.toUint(value > (1 << 64) - 1);
value >>= isGt * 64;
result += isGt * 8;
isGt = SafeCast.toUint(value > (1 << 32) - 1);
value >>= isGt * 32;
result += isGt * 4;
isGt = SafeCast.toUint(value > (1 << 16) - 1);
value >>= isGt * 16;
result += isGt * 2;
result += SafeCast.toUint(value > (1 << 8) - 1);
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + 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;
}
}// 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))
}
}
}// 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);
}
}
}// 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)
}
}
}{
"remappings": [
"@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
"@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
"erc4626-tests/=lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/",
"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/",
"solady/=lib/solady/src/"
],
"optimizer": {
"enabled": true,
"runs": 200
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "none",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "cancun",
"viaIR": false,
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[],"name":"DeployedAddressDifferentFromExpected","type":"error"},{"inputs":[{"internalType":"address","name":"implementation","type":"address"}],"name":"ERC1967InvalidImplementation","type":"error"},{"inputs":[],"name":"ERC1967NonPayable","type":"error"},{"inputs":[],"name":"EnforcedPause","type":"error"},{"inputs":[],"name":"ExpectedPause","type":"error"},{"inputs":[],"name":"FailedCall","type":"error"},{"inputs":[],"name":"IndexOutOfBounds","type":"error"},{"inputs":[],"name":"InitializationFailed","type":"error"},{"inputs":[],"name":"InvalidInitialization","type":"error"},{"inputs":[],"name":"InvalidInput","type":"error"},{"inputs":[],"name":"InvalidStartIndex","type":"error"},{"inputs":[],"name":"NotInitializing","type":"error"},{"inputs":[],"name":"OnlyAdmin","type":"error"},{"inputs":[],"name":"OnlyRoleRegistryOwner","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[],"name":"UUPSUnauthorizedCallContext","type":"error"},{"inputs":[{"internalType":"bytes32","name":"slot","type":"bytes32"}],"name":"UUPSUnsupportedProxiableUUID","type":"error"},{"inputs":[],"name":"Unauthorized","type":"error"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"oldImpl","type":"address"},{"indexed":false,"internalType":"address","name":"newImpl","type":"address"}],"name":"BeaconImplemenationUpgraded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"bytes32","name":"salt","type":"bytes32"},{"indexed":true,"internalType":"address","name":"deployed","type":"address"}],"name":"BeaconProxyDeployed","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"version","type":"uint64"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Paused","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Unpaused","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"inputs":[],"name":"ETHERFI_SAFE_FACTORY_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UPGRADE_INTERFACE_VERSION","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"beacon","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"salt","type":"bytes32"},{"internalType":"address[]","name":"_owners","type":"address[]"},{"internalType":"address[]","name":"_modules","type":"address[]"},{"internalType":"bytes[]","name":"_moduleSetupData","type":"bytes[]"},{"internalType":"uint8","name":"_threshold","type":"uint8"}],"name":"deployEtherFiSafe","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"start","type":"uint256"},{"internalType":"uint256","name":"n","type":"uint256"}],"name":"getDeployedAddresses","outputs":[{"internalType":"address[]","name":"","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"salt","type":"bytes32"}],"name":"getDeterministicAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_roleRegistry","type":"address"},{"internalType":"address","name":"_etherFiSafeImpl","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"safeAddr","type":"address"}],"name":"isEtherFiSafe","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"numContractsDeployed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"paused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"roleRegistry","outputs":[{"internalType":"contract IRoleRegistry","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"unpause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_newImpl","type":"address"}],"name":"upgradeBeaconImplementation","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"upgradeToAndCall","outputs":[],"stateMutability":"payable","type":"function"}]Contract Creation Code
60a060405230608052348015610013575f5ffd5b5061001c610021565b6100d3565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805468010000000000000000900460ff16156100715760405163f92ee8a960e01b815260040160405180910390fd5b80546001600160401b03908116146100d05780546001600160401b0319166001600160401b0390811782556040519081527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b50565b6080516124736100f95f395f8181610afd01528181610b260152610cdc01526124735ff3fe6080604052600436106100ef575f3560e01c806360db287311610087578063ad3cb1cc11610057578063ad3cb1cc14610277578063b7ca418b146102b4578063de9d008d146102d3578063ff024c7b146102f2575f5ffd5b806360db2873146102045780638456cb5914610230578063886e89a514610244578063a58dcc9514610258575f5ffd5b80634f1ef286116100c25780634f1ef2861461019a57806352d1902d146101ad57806359659e90146101c15780635c975abb146101d5575f5ffd5b806308c73259146100f357806334c7a811146101245780633f4ba83a14610165578063485cc9551461017b575b5f5ffd5b3480156100fe575f5ffd5b50610107610311565b6040516001600160a01b0390911681526020015b60405180910390f35b34801561012f575f5ffd5b506101577f8c603b444804dd4af6553193ea6455233924f73fffc3d0c1edd0d5a43cde511081565b60405190815260200161011b565b348015610170575f5ffd5b50610179610345565b005b348015610186575f5ffd5b506101796101953660046115ae565b6103ac565b6101796101a83660046115f9565b6104bc565b3480156101b8575f5ffd5b506101576104db565b3480156101cc575f5ffd5b506101076104f6565b3480156101e0575f5ffd5b505f5160206124475f395f51905f525460ff165b604051901515815260200161011b565b34801561020f575f5ffd5b5061022361021e3660046116bf565b61051e565b60405161011b91906116df565b34801561023b575f5ffd5b5061017961061a565b34801561024f575f5ffd5b5061015761067f565b348015610263575f5ffd5b5061010761027236600461172a565b61069b565b348015610282575f5ffd5b506102a7604051806040016040528060058152602001640352e302e360dc1b81525081565b60405161011b9190611741565b3480156102bf575f5ffd5b506101f46102ce366004611776565b6106a5565b3480156102de575f5ffd5b506101796102ed366004611776565b6106c5565b3480156102fd575f5ffd5b5061017961030c3660046117d9565b6108a6565b5f807fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f5005b546001600160a01b031692915050565b61034d610311565b6040516317bf301f60e21b81523360048201526001600160a01b039190911690635efcc07c906024015f6040518083038186803b15801561038c575f5ffd5b505afa15801561039e573d5f5f3e3d5ffd5b505050506103aa6109f8565b565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a008054600160401b810460ff16159067ffffffffffffffff165f811580156103f15750825b90505f8267ffffffffffffffff16600114801561040d5750303b155b90508115801561041b575080155b156104395760405163f92ee8a960e01b815260040160405180910390fd5b845467ffffffffffffffff19166001178555831561046357845460ff60401b1916600160401b1785555b61046d8787610a57565b83156104b357845460ff60401b19168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b50505050505050565b6104c4610af2565b6104cd82610b96565b6104d78282610c0b565b5050565b5f6104e4610cd1565b505f5160206124275f395f51905f5290565b5f807f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae58200610335565b60605f5160206124075f395f51905f525f61053882610d1a565b905080851061055a576040516392c4425960e01b815260040160405180910390fd5b8061056585876118ad565b11156105785761057585826118c0565b93505b5f8467ffffffffffffffff811115610592576105926115e5565b6040519080825280602002602001820160405280156105bb578160200160208202803683370190505b5090505f5b8581101561060e576105dc6105d582896118ad565b8590610d6b565b8282815181106105ee576105ee6118d3565b6001600160a01b03909216602092830291909101909101526001016105c0565b50925050505b92915050565b610622610311565b604051632fd0067b60e21b81523360048201526001600160a01b03919091169063bf4019ec906024015f6040518083038186803b158015610661575f5ffd5b505afa158015610673573d5f5f3e3d5ffd5b505050506103aa610dc4565b5f6106965f5160206124075f395f51905f52610d1a565b905090565b5f61061482610e0c565b5f5f5160206124075f395f51905f526106be8184610e17565b9392505050565b336106ce610311565b6001600160a01b0316638da5cb5b6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610709573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061072d91906118e7565b6001600160a01b0316146107545760405163ab1899a760e01b815260040160405180910390fd5b6001600160a01b03811661077b5760405163b4fa3fb360e01b815260040160405180910390fd5b7f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae582005460408051635c60da1b60e01b815290516001600160a01b03909216917fd8518b5f9760cf035849134f93f54b517edb9f10ce176b56bf030f3f9440389a918391635c60da1b916004808201926020929091908290030181865afa158015610806573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061082a91906118e7565b604080516001600160a01b03928316815291851660208301520160405180910390a1604051631b2ce7f360e11b81526001600160a01b038381166004830152821690633659cfe6906024015f604051808303815f87803b15801561088c575f5ffd5b505af115801561089e573d5f5f3e3d5ffd5b505050505050565b6108ae610ec5565b6108b6610311565b604051632474521560e21b81527f8c603b444804dd4af6553193ea6455233924f73fffc3d0c1edd0d5a43cde511060048201523360248201526001600160a01b0391909116906391d1485490604401602060405180830381865afa158015610920573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906109449190611902565b61096157604051634755657960e01b815260040160405180910390fd5b5f63e77829ab60e01b888888888888886040516024016109879796959493929190611991565b60408051601f198184030181529190526020810180516001600160e01b03166001600160e01b03199093169290921790915290505f6109c58a61069b565b90505f5160206124075f395f51905f526109df8183610ef5565b506109ea8b84611056565b505050505050505050505050565b610a006111e8565b5f5160206124475f395f51905f52805460ff191681557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b6040516001600160a01b03909116815260200160405180910390a150565b610a5f611217565b610a6882611260565b610a706112b2565b5f7f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae5820090508130604051610aa290611580565b6001600160a01b03928316815291166020820152604001604051809103905ff080158015610ad2573d5f5f3e3d5ffd5b5081546001600160a01b0319166001600160a01b03919091161790555050565b306001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161480610b7857507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316610b6c5f5160206124275f395f51905f52546001600160a01b031690565b6001600160a01b031614155b156103aa5760405163703e46dd60e11b815260040160405180910390fd5b5f7fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f5008054604051634766d28760e01b81523360048201529192506001600160a01b031690634766d287906024015f6040518083038186803b158015610bf9575f5ffd5b505afa15801561089e573d5f5f3e3d5ffd5b816001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015610c65575060408051601f3d908101601f19168201909252610c6291810190611a6d565b60015b610c9257604051634c9c8ce360e01b81526001600160a01b03831660048201526024015b60405180910390fd5b5f5160206124275f395f51905f528114610cc257604051632a87526960e21b815260048101829052602401610c89565b610ccc83836112c2565b505050565b306001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016146103aa5760405163703e46dd60e11b815260040160405180910390fd5b63978aab926004525f8181526024812080548060a01b60a01c8060011c9350808260601c1517610d6357600193508383015415610d6357600293508383015415610d6357600393505b505050919050565b63978aab926004525f828152602481208281015460601c915068fbb67fda52d4bfb8bf82141582029150610d9e84610d1a565b8310610dbd57604051634e23d03560e01b815260040160405180910390fd5b5092915050565b610dcc610ec5565b5f5160206124475f395f51905f52805460ff191660011781557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25833610a39565b5f6106148230611317565b63978aab926004525f828152602481206001600160a01b03929092169168fbb67fda52d4bfb8be198301610e525763f5a267f15f526004601cfd5b82610e645768fbb67fda52d4bfb8bf92505b80546bffffffffffffffffffffffff8116610eac5760019250838160601c0315610ebd57600182015460601c8414610ebd57600282015460601c8414610ebd575f9250610ebd565b81602052835f5260405f2054151592505b505092915050565b5f5160206124475f395f51905f525460ff16156103aa5760405163d93c066560e01b815260040160405180910390fd5b63978aab926004525f828152602481206001600160a01b03929092169168fbb67fda52d4bfb8be198301610f305763f5a267f15f526004601cfd5b82610f425768fbb67fda52d4bfb8bf92505b80546bffffffffffffffffffffffff81168260205280611009578160601c80610f75578560601b8455600194505061104d565b858103610f82575061104d565b600184015460601c80610fa3578660601b600186015560019550505061104d565b868103610fb157505061104d565b600285015460601c80610fd3578760601b60028701556001965050505061104d565b878103610fe25750505061104d565b5f928352604080842060019055918352818320600290558252902060039055506007908117905b845f5260405f20805461104b57600191821c808301825591945081611037578560601b60031784555061104d565b8560601b828501558260020184555061104d565b505b50505092915050565b5f5f6110618461069b565b90505f6110e6604051806020016110779061158d565b601f1982820381018352601f909101166040526110926104f6565b604080516001600160a01b039092166020830152818101525f606082015260800160408051601f19818403018152908290526110d19291602001611a9b565b6040516020818303038152906040528661136e565b84519091501561116b575f816001600160a01b0316856040516111099190611ab7565b5f604051808303815f865af19150503d805f8114611142576040519150601f19603f3d011682016040523d82523d5f602084013e611147565b606091505b505090508061116957604051630337323560e31b815260040160405180910390fd5b505b806001600160a01b0316826001600160a01b03161461119d5760405163169c822160e01b815260040160405180910390fd5b806001600160a01b03167f5889f63567a2730b47d0d74082206509fb86668d46a900bd695e655d099d586e866040516111d891815260200190565b60405180910390a2949350505050565b5f5160206124475f395f51905f525460ff166103aa57604051638dfc202b60e01b815260040160405180910390fd5b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0054600160401b900460ff166103aa57604051631afcd79f60e31b815260040160405180910390fd5b611268611217565b7fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f50080546001600160a01b0319166001600160a01b0383161781556112aa61137a565b6104d7611382565b6112ba611217565b6103aa611382565b6112cb826113a2565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a280511561130f57610ccc8282611405565b6104d7611477565b5f604051825f5260ff600b53836020527f21c35dbe1b344a2488cf3321d6ce542f8e9f305544ff09e4993a62319a497c1f6040526055600b20601452806040525061d6945f52600160345350506017601e20919050565b5f6106be5f8484611496565b6103aa611217565b61138a611217565b5f5160206124475f395f51905f52805460ff19169055565b806001600160a01b03163b5f036113d757604051634c9c8ce360e01b81526001600160a01b0382166004820152602401610c89565b5f5160206124275f395f51905f5280546001600160a01b0319166001600160a01b0392909216919091179055565b60605f5f846001600160a01b0316846040516114219190611ab7565b5f60405180830381855af49150503d805f8114611459576040519150601f19603f3d011682016040523d82523d5f602084013e61145e565b606091505b509150915061146e8583836114ff565b95945050505050565b34156103aa5760405163b398979f60e01b815260040160405180910390fd5b5f6f67363d3d37363d34f03d5260086018f35f52816010805ff5806114c25763301164255f526004601cfd5b8060145261d6945f5260016034536017601e2091505f5f85516020870188855af1823b026114f75763301164255f526004601cfd5b509392505050565b6060826115145761150f82611554565b6106be565b815115801561152b57506001600160a01b0384163b155b15610dbd57604051639996b31560e01b81526001600160a01b0385166004820152602401610c89565b8051156115645780518082602001fd5b60405163d6bda27560e01b815260040160405180910390fd5b50565b6103f880611ac383390190565b61054c80611ebb83390190565b6001600160a01b038116811461157d575f5ffd5b5f5f604083850312156115bf575f5ffd5b82356115ca8161159a565b915060208301356115da8161159a565b809150509250929050565b634e487b7160e01b5f52604160045260245ffd5b5f5f6040838503121561160a575f5ffd5b82356116158161159a565b9150602083013567ffffffffffffffff811115611630575f5ffd5b8301601f81018513611640575f5ffd5b803567ffffffffffffffff81111561165a5761165a6115e5565b604051601f8201601f19908116603f0116810167ffffffffffffffff81118282101715611689576116896115e5565b6040528181528282016020018710156116a0575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f5f604083850312156116d0575f5ffd5b50508035926020909101359150565b602080825282518282018190525f918401906040840190835b8181101561171f5783516001600160a01b03168352602093840193909201916001016116f8565b509095945050505050565b5f6020828403121561173a575f5ffd5b5035919050565b602081525f82518060208401528060208501604085015e5f604082850101526040601f19601f83011684010191505092915050565b5f60208284031215611786575f5ffd5b81356106be8161159a565b5f5f83601f8401126117a1575f5ffd5b50813567ffffffffffffffff8111156117b8575f5ffd5b6020830191508360208260051b85010111156117d2575f5ffd5b9250929050565b5f5f5f5f5f5f5f5f60a0898b0312156117f0575f5ffd5b88359750602089013567ffffffffffffffff81111561180d575f5ffd5b6118198b828c01611791565b909850965050604089013567ffffffffffffffff811115611838575f5ffd5b6118448b828c01611791565b909650945050606089013567ffffffffffffffff811115611863575f5ffd5b61186f8b828c01611791565b909450925050608089013560ff81168114611888575f5ffd5b809150509295985092959890939650565b634e487b7160e01b5f52601160045260245ffd5b8082018082111561061457610614611899565b8181038181111561061457610614611899565b634e487b7160e01b5f52603260045260245ffd5b5f602082840312156118f7575f5ffd5b81516106be8161159a565b5f60208284031215611912575f5ffd5b815180151581146106be575f5ffd5b8183526020830192505f815f5b8481101561195f5781356119418161159a565b6001600160a01b03168652602095860195919091019060010161192e565b5093949350505050565b81835281816020850137505f828201602090810191909152601f909101601f19169091010190565b608081525f6119a460808301898b611921565b82810360208401526119b781888a611921565b83810360408501528581529050602080820190600587901b830101875f36829003601e19015b89821015611a4b57858403601f1901855282358181126119fb575f5ffd5b8b0160208101903567ffffffffffffffff811115611a17575f5ffd5b803603821315611a25575f5ffd5b611a30868284611969565b955050506020830192506020850194506001820191506119dd565b50505060ff861660608601529250611a61915050565b98975050505050505050565b5f60208284031215611a7d575f5ffd5b5051919050565b5f81518060208401855e5f93019283525090919050565b5f611aaf611aa98386611a84565b84611a84565b949350505050565b5f6106be8284611a8456fe608060405234801561000f575f5ffd5b506040516103f83803806103f883398101604081905261002e9161015f565b806001600160a01b03811661005d57604051631e4fbdf760e01b81525f60048201526024015b60405180910390fd5b61006681610077565b50610070826100c6565b5050610190565b5f80546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b806001600160a01b03163b5f036100fb5760405163211eb15960e21b81526001600160a01b0382166004820152602401610054565b600180546001600160a01b0319166001600160a01b0383169081179091556040517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a250565b80516001600160a01b038116811461015a575f5ffd5b919050565b5f5f60408385031215610170575f5ffd5b61017983610144565b915061018760208401610144565b90509250929050565b61025b8061019d5f395ff3fe608060405234801561000f575f5ffd5b5060043610610055575f3560e01c80633659cfe6146100595780635c60da1b1461006e578063715018a6146100975780638da5cb5b1461009f578063f2fde38b146100af575b5f5ffd5b61006c610067366004610221565b6100c2565b005b6001546001600160a01b03165b6040516001600160a01b03909116815260200160405180910390f35b61006c6100d6565b5f546001600160a01b031661007b565b61006c6100bd366004610221565b6100e9565b6100ca610128565b6100d381610154565b50565b6100de610128565b6100e75f6101d2565b565b6100f1610128565b6001600160a01b03811661011f57604051631e4fbdf760e01b81525f60048201526024015b60405180910390fd5b6100d3816101d2565b5f546001600160a01b031633146100e75760405163118cdaa760e01b8152336004820152602401610116565b806001600160a01b03163b5f036101895760405163211eb15960e21b81526001600160a01b0382166004820152602401610116565b600180546001600160a01b0319166001600160a01b0383169081179091556040517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a250565b5f80546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b5f60208284031215610231575f5ffd5b81356001600160a01b0381168114610247575f5ffd5b939250505056fea164736f6c634300081c000a60a060405260405161054c38038061054c83398101604081905261002291610354565b61002c828261003e565b506001600160a01b0316608052610445565b610047826100fb565b6040516001600160a01b038316907f1cf3b03a6cf19fa2baba4df148e9dcabedea7f8a5c07840e207e5c089be95d3e905f90a28051156100ef576100ea826001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156100c0573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906100e49190610416565b82610209565b505050565b6100f761027c565b5050565b806001600160a01b03163b5f0361013557604051631933b43b60e21b81526001600160a01b03821660048201526024015b60405180910390fd5b807fa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d5080546001600160a01b0319166001600160a01b0392831617905560408051635c60da1b60e01b815290515f92841691635c60da1b9160048083019260209291908290030181865afa1580156101ae573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906101d29190610416565b9050806001600160a01b03163b5f036100f757604051634c9c8ce360e01b81526001600160a01b038216600482015260240161012c565b60605f5f846001600160a01b031684604051610225919061042f565b5f60405180830381855af49150503d805f811461025d576040519150601f19603f3d011682016040523d82523d5f602084013e610262565b606091505b50909250905061027385838361029d565b95945050505050565b341561029b5760405163b398979f60e01b815260040160405180910390fd5b565b6060826102b2576102ad826102fc565b6102f5565b81511580156102c957506001600160a01b0384163b155b156102f257604051639996b31560e01b81526001600160a01b038516600482015260240161012c565b50805b9392505050565b80511561030c5780518082602001fd5b60405163d6bda27560e01b815260040160405180910390fd5b80516001600160a01b038116811461033b575f5ffd5b919050565b634e487b7160e01b5f52604160045260245ffd5b5f5f60408385031215610365575f5ffd5b61036e83610325565b60208401519092506001600160401b03811115610389575f5ffd5b8301601f81018513610399575f5ffd5b80516001600160401b038111156103b2576103b2610340565b604051601f8201601f19908116603f011681016001600160401b03811182821017156103e0576103e0610340565b6040528181528282016020018710156103f7575f5ffd5b8160208401602083015e5f602083830101528093505050509250929050565b5f60208284031215610426575f5ffd5b6102f582610325565b5f82518060208501845e5f920191825250919050565b60805160f261045a5f395f601d015260f25ff3fe6080604052600a600c565b005b60186014601a565b609d565b565b5f7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156076573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906098919060ba565b905090565b365f5f375f5f365f845af43d5f5f3e80801560b6573d5ff35b3d5ffd5b5f6020828403121560c9575f5ffd5b81516001600160a01b038116811460de575f5ffd5b939250505056fea164736f6c634300081c000a7b68bad825be4cff21b93fb4c3affc217a6332ab2a96b5858e70f2a15d9f4300360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbccd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300a164736f6c634300081c000a
Deployed Bytecode
0x6080604052600436106100ef575f3560e01c806360db287311610087578063ad3cb1cc11610057578063ad3cb1cc14610277578063b7ca418b146102b4578063de9d008d146102d3578063ff024c7b146102f2575f5ffd5b806360db2873146102045780638456cb5914610230578063886e89a514610244578063a58dcc9514610258575f5ffd5b80634f1ef286116100c25780634f1ef2861461019a57806352d1902d146101ad57806359659e90146101c15780635c975abb146101d5575f5ffd5b806308c73259146100f357806334c7a811146101245780633f4ba83a14610165578063485cc9551461017b575b5f5ffd5b3480156100fe575f5ffd5b50610107610311565b6040516001600160a01b0390911681526020015b60405180910390f35b34801561012f575f5ffd5b506101577f8c603b444804dd4af6553193ea6455233924f73fffc3d0c1edd0d5a43cde511081565b60405190815260200161011b565b348015610170575f5ffd5b50610179610345565b005b348015610186575f5ffd5b506101796101953660046115ae565b6103ac565b6101796101a83660046115f9565b6104bc565b3480156101b8575f5ffd5b506101576104db565b3480156101cc575f5ffd5b506101076104f6565b3480156101e0575f5ffd5b505f5160206124475f395f51905f525460ff165b604051901515815260200161011b565b34801561020f575f5ffd5b5061022361021e3660046116bf565b61051e565b60405161011b91906116df565b34801561023b575f5ffd5b5061017961061a565b34801561024f575f5ffd5b5061015761067f565b348015610263575f5ffd5b5061010761027236600461172a565b61069b565b348015610282575f5ffd5b506102a7604051806040016040528060058152602001640352e302e360dc1b81525081565b60405161011b9190611741565b3480156102bf575f5ffd5b506101f46102ce366004611776565b6106a5565b3480156102de575f5ffd5b506101796102ed366004611776565b6106c5565b3480156102fd575f5ffd5b5061017961030c3660046117d9565b6108a6565b5f807fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f5005b546001600160a01b031692915050565b61034d610311565b6040516317bf301f60e21b81523360048201526001600160a01b039190911690635efcc07c906024015f6040518083038186803b15801561038c575f5ffd5b505afa15801561039e573d5f5f3e3d5ffd5b505050506103aa6109f8565b565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a008054600160401b810460ff16159067ffffffffffffffff165f811580156103f15750825b90505f8267ffffffffffffffff16600114801561040d5750303b155b90508115801561041b575080155b156104395760405163f92ee8a960e01b815260040160405180910390fd5b845467ffffffffffffffff19166001178555831561046357845460ff60401b1916600160401b1785555b61046d8787610a57565b83156104b357845460ff60401b19168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b50505050505050565b6104c4610af2565b6104cd82610b96565b6104d78282610c0b565b5050565b5f6104e4610cd1565b505f5160206124275f395f51905f5290565b5f807f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae58200610335565b60605f5160206124075f395f51905f525f61053882610d1a565b905080851061055a576040516392c4425960e01b815260040160405180910390fd5b8061056585876118ad565b11156105785761057585826118c0565b93505b5f8467ffffffffffffffff811115610592576105926115e5565b6040519080825280602002602001820160405280156105bb578160200160208202803683370190505b5090505f5b8581101561060e576105dc6105d582896118ad565b8590610d6b565b8282815181106105ee576105ee6118d3565b6001600160a01b03909216602092830291909101909101526001016105c0565b50925050505b92915050565b610622610311565b604051632fd0067b60e21b81523360048201526001600160a01b03919091169063bf4019ec906024015f6040518083038186803b158015610661575f5ffd5b505afa158015610673573d5f5f3e3d5ffd5b505050506103aa610dc4565b5f6106965f5160206124075f395f51905f52610d1a565b905090565b5f61061482610e0c565b5f5f5160206124075f395f51905f526106be8184610e17565b9392505050565b336106ce610311565b6001600160a01b0316638da5cb5b6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610709573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061072d91906118e7565b6001600160a01b0316146107545760405163ab1899a760e01b815260040160405180910390fd5b6001600160a01b03811661077b5760405163b4fa3fb360e01b815260040160405180910390fd5b7f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae582005460408051635c60da1b60e01b815290516001600160a01b03909216917fd8518b5f9760cf035849134f93f54b517edb9f10ce176b56bf030f3f9440389a918391635c60da1b916004808201926020929091908290030181865afa158015610806573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061082a91906118e7565b604080516001600160a01b03928316815291851660208301520160405180910390a1604051631b2ce7f360e11b81526001600160a01b038381166004830152821690633659cfe6906024015f604051808303815f87803b15801561088c575f5ffd5b505af115801561089e573d5f5f3e3d5ffd5b505050505050565b6108ae610ec5565b6108b6610311565b604051632474521560e21b81527f8c603b444804dd4af6553193ea6455233924f73fffc3d0c1edd0d5a43cde511060048201523360248201526001600160a01b0391909116906391d1485490604401602060405180830381865afa158015610920573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906109449190611902565b61096157604051634755657960e01b815260040160405180910390fd5b5f63e77829ab60e01b888888888888886040516024016109879796959493929190611991565b60408051601f198184030181529190526020810180516001600160e01b03166001600160e01b03199093169290921790915290505f6109c58a61069b565b90505f5160206124075f395f51905f526109df8183610ef5565b506109ea8b84611056565b505050505050505050505050565b610a006111e8565b5f5160206124475f395f51905f52805460ff191681557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b6040516001600160a01b03909116815260200160405180910390a150565b610a5f611217565b610a6882611260565b610a706112b2565b5f7f644210a929ca6ee03d33c1a1fe361b36b5a9728941782cd06b1139e4cae5820090508130604051610aa290611580565b6001600160a01b03928316815291166020820152604001604051809103905ff080158015610ad2573d5f5f3e3d5ffd5b5081546001600160a01b0319166001600160a01b03919091161790555050565b306001600160a01b037f000000000000000000000000572e25fd70b6eb9a3cad1ce1d48e3cfb938767f1161480610b7857507f000000000000000000000000572e25fd70b6eb9a3cad1ce1d48e3cfb938767f16001600160a01b0316610b6c5f5160206124275f395f51905f52546001600160a01b031690565b6001600160a01b031614155b156103aa5760405163703e46dd60e11b815260040160405180910390fd5b5f7fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f5008054604051634766d28760e01b81523360048201529192506001600160a01b031690634766d287906024015f6040518083038186803b158015610bf9575f5ffd5b505afa15801561089e573d5f5f3e3d5ffd5b816001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015610c65575060408051601f3d908101601f19168201909252610c6291810190611a6d565b60015b610c9257604051634c9c8ce360e01b81526001600160a01b03831660048201526024015b60405180910390fd5b5f5160206124275f395f51905f528114610cc257604051632a87526960e21b815260048101829052602401610c89565b610ccc83836112c2565b505050565b306001600160a01b037f000000000000000000000000572e25fd70b6eb9a3cad1ce1d48e3cfb938767f116146103aa5760405163703e46dd60e11b815260040160405180910390fd5b63978aab926004525f8181526024812080548060a01b60a01c8060011c9350808260601c1517610d6357600193508383015415610d6357600293508383015415610d6357600393505b505050919050565b63978aab926004525f828152602481208281015460601c915068fbb67fda52d4bfb8bf82141582029150610d9e84610d1a565b8310610dbd57604051634e23d03560e01b815260040160405180910390fd5b5092915050565b610dcc610ec5565b5f5160206124475f395f51905f52805460ff191660011781557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25833610a39565b5f6106148230611317565b63978aab926004525f828152602481206001600160a01b03929092169168fbb67fda52d4bfb8be198301610e525763f5a267f15f526004601cfd5b82610e645768fbb67fda52d4bfb8bf92505b80546bffffffffffffffffffffffff8116610eac5760019250838160601c0315610ebd57600182015460601c8414610ebd57600282015460601c8414610ebd575f9250610ebd565b81602052835f5260405f2054151592505b505092915050565b5f5160206124475f395f51905f525460ff16156103aa5760405163d93c066560e01b815260040160405180910390fd5b63978aab926004525f828152602481206001600160a01b03929092169168fbb67fda52d4bfb8be198301610f305763f5a267f15f526004601cfd5b82610f425768fbb67fda52d4bfb8bf92505b80546bffffffffffffffffffffffff81168260205280611009578160601c80610f75578560601b8455600194505061104d565b858103610f82575061104d565b600184015460601c80610fa3578660601b600186015560019550505061104d565b868103610fb157505061104d565b600285015460601c80610fd3578760601b60028701556001965050505061104d565b878103610fe25750505061104d565b5f928352604080842060019055918352818320600290558252902060039055506007908117905b845f5260405f20805461104b57600191821c808301825591945081611037578560601b60031784555061104d565b8560601b828501558260020184555061104d565b505b50505092915050565b5f5f6110618461069b565b90505f6110e6604051806020016110779061158d565b601f1982820381018352601f909101166040526110926104f6565b604080516001600160a01b039092166020830152818101525f606082015260800160408051601f19818403018152908290526110d19291602001611a9b565b6040516020818303038152906040528661136e565b84519091501561116b575f816001600160a01b0316856040516111099190611ab7565b5f604051808303815f865af19150503d805f8114611142576040519150601f19603f3d011682016040523d82523d5f602084013e611147565b606091505b505090508061116957604051630337323560e31b815260040160405180910390fd5b505b806001600160a01b0316826001600160a01b03161461119d5760405163169c822160e01b815260040160405180910390fd5b806001600160a01b03167f5889f63567a2730b47d0d74082206509fb86668d46a900bd695e655d099d586e866040516111d891815260200190565b60405180910390a2949350505050565b5f5160206124475f395f51905f525460ff166103aa57604051638dfc202b60e01b815260040160405180910390fd5b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0054600160401b900460ff166103aa57604051631afcd79f60e31b815260040160405180910390fd5b611268611217565b7fa5586bb7fe6c4d1a576fc53fefe6d5915940638d338769f6905020734977f50080546001600160a01b0319166001600160a01b0383161781556112aa61137a565b6104d7611382565b6112ba611217565b6103aa611382565b6112cb826113a2565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a280511561130f57610ccc8282611405565b6104d7611477565b5f604051825f5260ff600b53836020527f21c35dbe1b344a2488cf3321d6ce542f8e9f305544ff09e4993a62319a497c1f6040526055600b20601452806040525061d6945f52600160345350506017601e20919050565b5f6106be5f8484611496565b6103aa611217565b61138a611217565b5f5160206124475f395f51905f52805460ff19169055565b806001600160a01b03163b5f036113d757604051634c9c8ce360e01b81526001600160a01b0382166004820152602401610c89565b5f5160206124275f395f51905f5280546001600160a01b0319166001600160a01b0392909216919091179055565b60605f5f846001600160a01b0316846040516114219190611ab7565b5f60405180830381855af49150503d805f8114611459576040519150601f19603f3d011682016040523d82523d5f602084013e61145e565b606091505b509150915061146e8583836114ff565b95945050505050565b34156103aa5760405163b398979f60e01b815260040160405180910390fd5b5f6f67363d3d37363d34f03d5260086018f35f52816010805ff5806114c25763301164255f526004601cfd5b8060145261d6945f5260016034536017601e2091505f5f85516020870188855af1823b026114f75763301164255f526004601cfd5b509392505050565b6060826115145761150f82611554565b6106be565b815115801561152b57506001600160a01b0384163b155b15610dbd57604051639996b31560e01b81526001600160a01b0385166004820152602401610c89565b8051156115645780518082602001fd5b60405163d6bda27560e01b815260040160405180910390fd5b50565b6103f880611ac383390190565b61054c80611ebb83390190565b6001600160a01b038116811461157d575f5ffd5b5f5f604083850312156115bf575f5ffd5b82356115ca8161159a565b915060208301356115da8161159a565b809150509250929050565b634e487b7160e01b5f52604160045260245ffd5b5f5f6040838503121561160a575f5ffd5b82356116158161159a565b9150602083013567ffffffffffffffff811115611630575f5ffd5b8301601f81018513611640575f5ffd5b803567ffffffffffffffff81111561165a5761165a6115e5565b604051601f8201601f19908116603f0116810167ffffffffffffffff81118282101715611689576116896115e5565b6040528181528282016020018710156116a0575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f5f604083850312156116d0575f5ffd5b50508035926020909101359150565b602080825282518282018190525f918401906040840190835b8181101561171f5783516001600160a01b03168352602093840193909201916001016116f8565b509095945050505050565b5f6020828403121561173a575f5ffd5b5035919050565b602081525f82518060208401528060208501604085015e5f604082850101526040601f19601f83011684010191505092915050565b5f60208284031215611786575f5ffd5b81356106be8161159a565b5f5f83601f8401126117a1575f5ffd5b50813567ffffffffffffffff8111156117b8575f5ffd5b6020830191508360208260051b85010111156117d2575f5ffd5b9250929050565b5f5f5f5f5f5f5f5f60a0898b0312156117f0575f5ffd5b88359750602089013567ffffffffffffffff81111561180d575f5ffd5b6118198b828c01611791565b909850965050604089013567ffffffffffffffff811115611838575f5ffd5b6118448b828c01611791565b909650945050606089013567ffffffffffffffff811115611863575f5ffd5b61186f8b828c01611791565b909450925050608089013560ff81168114611888575f5ffd5b809150509295985092959890939650565b634e487b7160e01b5f52601160045260245ffd5b8082018082111561061457610614611899565b8181038181111561061457610614611899565b634e487b7160e01b5f52603260045260245ffd5b5f602082840312156118f7575f5ffd5b81516106be8161159a565b5f60208284031215611912575f5ffd5b815180151581146106be575f5ffd5b8183526020830192505f815f5b8481101561195f5781356119418161159a565b6001600160a01b03168652602095860195919091019060010161192e565b5093949350505050565b81835281816020850137505f828201602090810191909152601f909101601f19169091010190565b608081525f6119a460808301898b611921565b82810360208401526119b781888a611921565b83810360408501528581529050602080820190600587901b830101875f36829003601e19015b89821015611a4b57858403601f1901855282358181126119fb575f5ffd5b8b0160208101903567ffffffffffffffff811115611a17575f5ffd5b803603821315611a25575f5ffd5b611a30868284611969565b955050506020830192506020850194506001820191506119dd565b50505060ff861660608601529250611a61915050565b98975050505050505050565b5f60208284031215611a7d575f5ffd5b5051919050565b5f81518060208401855e5f93019283525090919050565b5f611aaf611aa98386611a84565b84611a84565b949350505050565b5f6106be8284611a8456fe608060405234801561000f575f5ffd5b506040516103f83803806103f883398101604081905261002e9161015f565b806001600160a01b03811661005d57604051631e4fbdf760e01b81525f60048201526024015b60405180910390fd5b61006681610077565b50610070826100c6565b5050610190565b5f80546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b806001600160a01b03163b5f036100fb5760405163211eb15960e21b81526001600160a01b0382166004820152602401610054565b600180546001600160a01b0319166001600160a01b0383169081179091556040517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a250565b80516001600160a01b038116811461015a575f5ffd5b919050565b5f5f60408385031215610170575f5ffd5b61017983610144565b915061018760208401610144565b90509250929050565b61025b8061019d5f395ff3fe608060405234801561000f575f5ffd5b5060043610610055575f3560e01c80633659cfe6146100595780635c60da1b1461006e578063715018a6146100975780638da5cb5b1461009f578063f2fde38b146100af575b5f5ffd5b61006c610067366004610221565b6100c2565b005b6001546001600160a01b03165b6040516001600160a01b03909116815260200160405180910390f35b61006c6100d6565b5f546001600160a01b031661007b565b61006c6100bd366004610221565b6100e9565b6100ca610128565b6100d381610154565b50565b6100de610128565b6100e75f6101d2565b565b6100f1610128565b6001600160a01b03811661011f57604051631e4fbdf760e01b81525f60048201526024015b60405180910390fd5b6100d3816101d2565b5f546001600160a01b031633146100e75760405163118cdaa760e01b8152336004820152602401610116565b806001600160a01b03163b5f036101895760405163211eb15960e21b81526001600160a01b0382166004820152602401610116565b600180546001600160a01b0319166001600160a01b0383169081179091556040517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a250565b5f80546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b5f60208284031215610231575f5ffd5b81356001600160a01b0381168114610247575f5ffd5b939250505056fea164736f6c634300081c000a60a060405260405161054c38038061054c83398101604081905261002291610354565b61002c828261003e565b506001600160a01b0316608052610445565b610047826100fb565b6040516001600160a01b038316907f1cf3b03a6cf19fa2baba4df148e9dcabedea7f8a5c07840e207e5c089be95d3e905f90a28051156100ef576100ea826001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156100c0573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906100e49190610416565b82610209565b505050565b6100f761027c565b5050565b806001600160a01b03163b5f0361013557604051631933b43b60e21b81526001600160a01b03821660048201526024015b60405180910390fd5b807fa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d5080546001600160a01b0319166001600160a01b0392831617905560408051635c60da1b60e01b815290515f92841691635c60da1b9160048083019260209291908290030181865afa1580156101ae573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906101d29190610416565b9050806001600160a01b03163b5f036100f757604051634c9c8ce360e01b81526001600160a01b038216600482015260240161012c565b60605f5f846001600160a01b031684604051610225919061042f565b5f60405180830381855af49150503d805f811461025d576040519150601f19603f3d011682016040523d82523d5f602084013e610262565b606091505b50909250905061027385838361029d565b95945050505050565b341561029b5760405163b398979f60e01b815260040160405180910390fd5b565b6060826102b2576102ad826102fc565b6102f5565b81511580156102c957506001600160a01b0384163b155b156102f257604051639996b31560e01b81526001600160a01b038516600482015260240161012c565b50805b9392505050565b80511561030c5780518082602001fd5b60405163d6bda27560e01b815260040160405180910390fd5b80516001600160a01b038116811461033b575f5ffd5b919050565b634e487b7160e01b5f52604160045260245ffd5b5f5f60408385031215610365575f5ffd5b61036e83610325565b60208401519092506001600160401b03811115610389575f5ffd5b8301601f81018513610399575f5ffd5b80516001600160401b038111156103b2576103b2610340565b604051601f8201601f19908116603f011681016001600160401b03811182821017156103e0576103e0610340565b6040528181528282016020018710156103f7575f5ffd5b8160208401602083015e5f602083830101528093505050509250929050565b5f60208284031215610426575f5ffd5b6102f582610325565b5f82518060208501845e5f920191825250919050565b60805160f261045a5f395f601d015260f25ff3fe6080604052600a600c565b005b60186014601a565b609d565b565b5f7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156076573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906098919060ba565b905090565b365f5f375f5f365f845af43d5f5f3e80801560b6573d5ff35b3d5ffd5b5f6020828403121560c9575f5ffd5b81516001600160a01b038116811460de575f5ffd5b939250505056fea164736f6c634300081c000a7b68bad825be4cff21b93fb4c3affc217a6332ab2a96b5858e70f2a15d9f4300360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbccd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300a164736f6c634300081c000a
Loading...
Loading
Loading...
Loading
Loading...
Loading
0x572E25fD70b6eB9a3CaD1CE1D48E3CfB938767F1
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 35 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.